Merge pull request #71 from code4lib/more_docs

Assorted doc improvements, mostly to ActiveRecordWrapper

Author: jrochkind

lib/oai/provider.rb

@@ -58,7 +58,9 @@
 #    repository_url 'http://localhost/provider'
 #    record_prefix 'oai:localhost'
 #    admin_email 'root@localhost'
-#    sample_identifier 'oai:pubmedcentral.gov:13900'
+#    # record_prefix will be automatically prepended to sample_id, so in this
+#    # case it becomes: oai:localhost:13900
+#    sample_id '13900'
 #    source_model MyModel.new
 #  end
 # ```
@@ -107,7 +109,7 @@
 #     record_prefix 'oai:blog'
 #     admin_email 'root@localhost'
 #     source_model OAI::Provider::ActiveRecordWrapper.new(Post)
-#     sample_identifier 'oai:pubmedcentral.gov:13900'
+#     sample_id '13900' # record prefix used, so becomes oai:blog:13900
 #   end
 # ```
 #
@@ -116,15 +118,25 @@
 # ```ruby
 #   class OaiController < ApplicationController
 #     def index
-#       # Remove controller and action from the options.  Rails adds them automatically.
-#       options = params.delete_if { |k,v| %w{controller action}.include?(k) }
 #       provider = BlogProvider.new
-#       response =  provider.process_request(options)
-#       render :text => response, :content_type => 'text/xml'
+#       response =  provider.process_request(oai_params.to_h)
+#       render :body => response, :content_type => 'text/xml'
+#     end
+#
+#     private
+#
+#     def oai_params
+#       params.permit(:verb, :identifier, :metadataPrefix, :set, :from, :until, :resumptionToken)
 #     end
 #   end
 # ```
 #
+# And route to it in your `config/routes.rb` file:
+#
+# ```ruby
+#    match 'oai', to: "oai#index", via: [:get, :post]
+# ```
+#
 # Special thanks to Jose Hales-Garcia for this solution.
 #
 # ## Supporting custom metadata formats