dor-fetcher 0.0.2 → 1.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjM1ZThlZWJiOGM0MzVmZTAwZTRkYjU5MzIxMDZkNzhhMTQ0YjNkMA==
-  data.tar.gz: !binary |-
-    ZDAyYWRlOTUzZDYwNjQxNDI1MjgwMGIyMzhlYTRmNGU2YTEwMTk3Ng==
+SHA1:
+  metadata.gz: 5a1fe464fcac95b99e0136e9b2efed102927f6c3
+  data.tar.gz: 1ef59399da0edc8abfb759d0f385b7ef3fff0a56
 SHA512:
-  metadata.gz: !binary |-
-    MGE2NmNjZjIxMzk2YmUwODA3NWYwZWM2NzMyNzQ5MWY1YmFiYzY2OTExNzhj
-    YWJkNzRiYTQwODQ0ZDgyNWFhN2EzMTRkZmE3YmFkZWI4ZTY5OGRjZTFkMmUy
-    OTQ2NGJkOGM2ODQ1M2NjNzBiM2MyMzEwOGYzZjM2ZTJkODhkYTE=
-  data.tar.gz: !binary |-
-    MTUxOThlMTUzMjlmNzg1MDdmODAwZmY5ZjEwYmNmODc3ZTA2MmM0MjQwMmMy
-    NDRiODQwY2I1NjRhYTUyMzg2YWU1M2ZmYzc2ZTA5NWYzZTU3ZmU4MTk2ZGE4
-    NjAyOGU4NjBlYzYyMDYyYWUyZjliMjYzYjUyYjJjNjA2ZTRjMWY=
+  metadata.gz: 1ee6988a6c963de4f25c3fd11debfa586f7aa8d2b5467ea04f163e46c61f850f8efa12ebfde2fe0897cfb5e8a72a14ef690fc38bbfe10356750fe1fb223aa7d9
+  data.tar.gz: 0233b07bb7d84b5aba138aaf488d9339e289b26cea04be5492ec39058e7677828ae3290f584929819907133936d05cef175e4dea97c0ada13392fd1768fa7ce4

data/lib/dor-fetcher.rb

@@ -9,48 +9,87 @@ module DorFetcher
     @@count_only_param = "?rows=0"
     @@default_service_url = 'http://127.0.0.1:3000'
     
-    #Call me with {:service_url='http://SERVICEURL'}
+    #Create a new instance of DorFetcher::Client
+    #@param options [Hash] Currently supports only :service_url, the base 
+    #url for API queries.  Defaults to http://127.0.0.1:3000
+    #@example
+    #    df = DorFetcher::Client.new({:service_url='http://SERVICEURL'})
     def initialize options = {}
       #TODO: Check for a well formed URL and a 200 from the destination before just accepting this
       @service_url = options[:service_url] || @@default_service_url
     end
-    #options :count_only, :first_modified, :last_modified
+    
+    
+    #Get a hash of all members of a collection and the collection itself
+    #
+    #@param collection [String] we expect pid/druid
+    #@param params [Hash] we expect :count_only or any of @@supported_params
+    #@return [Hash] Hash of all objects in the collection including 
+    #pid/druid, title, date last modified, and count
     def get_collection(collection, params = {})
       return query_api('collection', collection, params)
     end
     
+    #Get the count of the number of items in a collection, including the 
+    #collection object itself
+    #@param collection [String] we expect pid/druid
+    #@param params [Hash] we expect :count_only or any of @@supported_params
+    #@return [Integer] Number found
     def get_count_for_collection(collection, params = {})
       return query_api('collection', collection, add_count_only_param(params))
     end
   
+    #Get a Hash of all the collections in the digital repository 
+    #@return [Hash] Hash of all collections including pid/druid, title,  
+    #date last modified, and count
     def list_all_collections
       return query_api('collection', '', {})
     end
     
+    #Get a Count of all the collections in the digital repository 
+    #@return [Integer] Number of all collections
     def total_collection_count
       return query_api('collection', '', {:count_only=>true})
     end
   
-    #options :count_only, :first_modified, :last_modified
+    #Get the APO and all objects governed by the APO
+    #@param apo [String] pid/druid of the APO
+    #@param params [Hash] we expect :count_only or any of @@supported_params
+    #@return [Hash] Hash of all objects governed by the APO including    
+    #pid/druid, title, date last modified, and count
     def get_apo(apo, params= {})
       return query_api('apo', apo, params)
     end
     
+    #Get the count of the number of objects in an APO, including the 
+    #APO object itself
+    #@param apo [String] we expect pid/druid
+    #@param params [Hash] we expect :count_only or any of @@supported_params
+    #@return [Integer] Number found
     def get_count_for_apo(apo, params={})
       return query_api('apo', apo, add_count_only_param(params))
     end
   
+    #Get a Hash of all the APOs in the digital repository 
+    #@return [Hash] Hash of all APOs including pid/druid, title,  
+    #date last modified, and count
     def list_all_apos
       return query_api('apo', '', {})
     end
     
+    #Get a Count of all the APOs in the digital repository 
+    #@return [Integer] Number of all APOs
     def total_apo_count
       return query_api('apo', '', {:count_only=>true})
     end
     
+    #Method to parse full Hash into an array containing only the druids
+    #
+    #@param response [Hash] Hash as returned by query_api
+    #@return [Array] the array listing all druids in the supplied Hash
     def druid_array(response)
       return_list = []
-      j = JSON.parse(response)
+      j = response
       j.keys.each do |key|
         j[key].each do |item|
           return_list << item['druid'] if item['druid'] != nil
@@ -58,9 +97,17 @@ module DorFetcher
       end
       return return_list
     end
-    
+    #Query a RESTful API and return the JSON result as a Hash
+    #@param base [String] The name of controller of the Rails App you wish to
+    #route to
+    #@param druid [String] The druid/pid of the object you wish to query,
+    #or empty string for no specific druid
+    #@param params [Hash] we expect :count_only or any of @@supported_params
+    #@return [Hash] Hash of all objects governed by the APO including    
+    #pid/druid, title, date last modified, and count
     def query_api(base, druid, params)
       url = "#{@service_url}/#{base}/#{druid}#{add_params(params)}"
+      
       begin
         resp = Net::HTTP.get_response(URI.parse(url))
       rescue
@@ -68,26 +115,48 @@ module DorFetcher
       end
       
       return resp.body.to_i if params[:count_only] == true
-      return resp.body
-      
+      return JSON[resp.body] #Convert the response JSON to a Ruby Hash
     end
     
-    def add_params(params)
+    #Transform a parameter hash into a RESTful API parameter format
+    #
+    #@param input_params [Hash] {The existing parameters, eg time and tag}
+    #@return [String] parameters in the Hash now formatted into a RESTful parameter string
+    def add_params(input_params)
       args_string = ""
       
       #Handle Count Only
-      args_string << @@count_only_param if params[:count_only] == true
+      args_string << @@count_only_param if input_params[:count_only] == true
       
+      #If we did not add in a rows=0 param, args_string will have a size of 
+      #zero
+      #If we did add in a rows=0 param, this will set count to greater than 
+      #zero
+      count = args_string.size
       @@supported_params.each do |p|
-        args_string << "#?{p.to_s}=#{params[p]}" if params[p] != nil
+        operator = "?"
+        operator = "&" if count > 0
+        args_string << "#{operator}#{p.to_s}=#{input_params[p]}" if input_params[p] != nil
+        count += 1
       end
       return args_string
     end
     
+    #Add the parameter so query_api knows only to get a count of the documents in solr
+    #
+    #@param params [Hash] {The existing parameters, eg time and tag}
+    #@return [Hash] the params Hash plus the key/value set :count_only=>true
     def add_count_only_param(params)
       params.store(:count_only, true)
       return params
     end
+    
+    #Get the Base URL this instance will run RESTful API calls against
+    #@return [String] the url
+    def service_url
+      return @service_url
+    end
+    
   end
     
 end

metadata

@@ -1,38 +1,100 @@
 --- !ruby/object:Gem::Specification
 name: dor-fetcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Carrick Rogers
+- Laney McGlohon
+- Bess Sadler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Wrapped for the Dor Fetcher Services restful api.
-email: carrickr@stanford.edu
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for the Dor Fetcher Services RESTful API.
+email:
+- carrickr@stanford.edu
+- laneymcg@stanford.edu
+- bess@stanford.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/dor-fetcher.rb
 homepage: http://www.stanford.edu
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -40,17 +102,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: DorFetcher Gem