dor-fetcher 1.1.7 → 1.3.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTJmYWI5ZDJlYjJjNjI4Y2RiNDk4OTVmZDRmYWNmMmU4OTIxNWU5Yw==
-  data.tar.gz: !binary |-
-    ZDFiMDgzZmVjOGJjNmE4MjIzZGQyMzE0ZmM0YjRmMTcxYzA5YjQwNA==
+SHA256:
+  metadata.gz: 6727b5b0868d3d588ed20a80df170a3e62eedf5d88dd0aee1b9fcd6104cf4a39
+  data.tar.gz: 6d042f0c65981a841c1950e28b4fd472928a378d78b613ca103a233cc883cf8d
 SHA512:
-  metadata.gz: !binary |-
-    YTZmZWViYWFjNDcwMjMzMGM4YjE0ZGEyYzU5NDEyNmRiNWNhYzgwZDA1NDA0
-    ZGViOTdlYjAzMDMyMzAyMWZhODBkNTNmNTZjOGUwNDM1MmMxMDFjNjg2ZjJi
-    YmEzOWE2YWVlNjBhZDhmM2VlMmE2MDQ3OTZlNTVjNmU2NTI5ZTA=
-  data.tar.gz: !binary |-
-    OGEwZDE2ZGJhNWNjYzA0ODgwOWMzN2RhN2FhNGJlMjIzZjNjZmNmZDJkNTk0
-    NmM1NWJlYzZkY2JhODc0MWFhZWE3ODFhZjRlNTU2NDFlMDY1OTYyMTJhOTM5
-    NzRiMjdiOWYyYzM2NzI5ZWVkMTRlY2U5MjBjMzk2ZDJjMzM4ZGE=
+  metadata.gz: d293c213247d7649ffa0b85605c98ff1240ed2a25e3b847cf2134ceddabaf6b5a0b250936cead592cab1408021b7254216a8b55c24bf58763f68edf08d6bb67d
+  data.tar.gz: 1371ec72bf0c36de3ecfd406333c6861d75b0ebda3da045f0b34cd06f5c2e7f95808870e16f6f4cab248065b2fe256a337a49970825d22658f1d9edb3f7294cb

data/lib/dor-fetcher.rb

@@ -3,196 +3,168 @@ require 'json'
 require 'addressable/uri'
 
 module DorFetcher
-  
   class Client
-    
     @@supported_params = [:first_modified, :last_modified, :count_only, :status]
-    @@count_only_param = "rows=0"
+    @@count_only_param = 'rows=0'
     @@default_service_url = 'http://127.0.0.1:3000'
     @@counts_key = 'counts'
-    
-    #Create a new instance of DorFetcher::Client
-    #@param options [Hash] Currently supports :service_url and :skip_heartbeat.
-    #@param :service_url is the base url for API queries.  Defaults to http://127.0.0.1:3000
-    #@param :skip_heartbeat will tell the init to skip querying the :service_url and seeing if the API is responsive
-    #@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
+
+    attr_reader :service_url # Base URL this instance will run RESTful API calls against
+
+    # Create a new instance of DorFetcher::Client
+    # @param options [Hash]
+    # @option options [String] :service_url base url for API queries.  Default: http://127.0.0.1:3000
+    # @option options [Boolean] :skip_heartbeat skip querying :service_url to confirm API is responsive.  Default: false
+    # @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
       @site = RestClient::Resource.new(@service_url)
-
-      if not options[:skip_heartbeat]
-        raise "DorFetcher::Client Error! No response from #{@service_url}" if not self.is_alive?
-      end
+      raise "DorFetcher::Client Error! No response from #{@service_url}" unless options[:skip_heartbeat] || is_alive?
     end
-    
+
     # Return service info (rails env, version deployed, last restart and last deploy)
-    #@return [hash] Hash containing service info
+    # @return [hash] Hash containing service info
     def service_info
       resp = @site['about/version.json'].get
-      return JSON[resp]
+      JSON[resp]
     end
-    
-    #Check to see if the dor-fetcher-service is responding to requests, this is a basic heart beat checker
-    #@return [Boolean] True for a service that responds, False for a service that does not.
+
+    # Check to see if the dor-fetcher-service is responding to requests, this is a basic heartbeat checker
+    # @return [Boolean] True for a service that responds, False for a service that does not.
     def is_alive?
       resp = @site.get
-      return 200.eql?(resp.code) && "ok".eql?(resp) 
+      200.eql?(resp.code) && /PASSED/.match?(resp.body)
     end
-    
-    
-    #Get a hash of all members of a collection and the collection itself
+
+    # 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
+    # @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('collections', 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
+      query_api('collections', 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] any of @@supported_params
+    # @return [Integer] Number found
     def get_count_for_collection(collection, params = {})
-      return query_api('collections', collection, add_count_only_param(params))
+      query_api('collections', collection, params.merge!(:count_only => true))
     end
-  
-    #Get a Hash of all the collections in the digital repository that are accessioned
-    #@return [Hash] Hash of all collections including pid/druid, title,  
-    #date last modified, and count
+
+    # Get a Hash of all the collections in the digital repository that are accessioned
+    # @return [Hash] All collections including: pid/druid, title, date last modified, and count
     def list_all_collections
-      return query_api('collections', '', {})
+      query_api('collections', '', {})
     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
+
+    # Get a Hash of all the collections in the digital repository
+    # @return [Hash] All registered collections including: pid/druid, title, date last modified, and count
     def list_registered_collections
-      return query_api('collections', '', {:status=>'registered'})
+      query_api('collections', '', :status => 'registered')
     end
-       
-    #Get a Count of all the collections in the digital repository 
-    #@return [Integer] Number of all collections
+
+    # Get a Count of all the collections in the digital repository
+    # @return [Integer] Number of all collections
     def total_collection_count
-      return query_api('collections', '', {:count_only=>true})
-    end
-  
-    #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('apos', 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('apos', apo, add_count_only_param(params))
-    end
-  
-    #Get a Hash of all the APOs in the digital repository that are accessioned 
-    #@return [Hash] Hash of all APOs including pid/druid, title,  
-    #date last modified, and count
+      query_api('collections', '', :count_only => true)
+    end
+
+    # 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] All objects governed by the APO including: pid/druid, title, date last modified, and count
+    def get_apo(apo, params = {})
+      query_api('apos', 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 = {})
+      query_api('apos', apo, params.merge!(:count_only => true))
+    end
+
+    # Get a Hash of all the APOs in the digital repository that are accessioned
+    # @return [Hash] All APOs including: pid/druid, title, date last modified, and count
     def list_all_apos
-      return query_api('apos', '', {})
+      query_api('apos', '', {})
     end
 
-    #Get a Hash of all the APOs in the digital repository that are registered
-    #@return [Hash] Hash of all APOs including pid/druid, title,  
-    #date last modified, and count
+    # Get a Hash of all the APOs in the digital repository that are registered
+    # @return [Hash] All registered APOs including: pid/druid, title, date last modified, and count
     def list_registered_apos
-      return query_api('apos', '', {:status=>'registereed'})
+      query_api('apos', '', :status => 'registered')
     end
-        
-    #Get a Count of all the APOs in the digital repository 
-    #@return [Integer] Number of all APOs
+
+    # Get a Count of all the APOs in the digital repository
+    # @return [Integer] Number of all APOs
     def total_apo_count
-      return query_api('apos', '', {:count_only=>true})
+      query_api('apos', '', :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
-    #@param no_prefix [boolean] if true (default), remove the druid: prefix on all druids, if false, leave alone
-    #@return [Array] the array listing all druids in the supplied Hash
-    def druid_array(response,params={})
+
+    # Parses full Hash into an array containing only the druids
+    # @param response [Hash] Hash as returned by query_api
+    # @param params [Hash{Symbol=>Boolean}] options
+    # @option params [Boolean] :no_prefix if true (default), remove the 'druid:' prefix on all druids
+    # @return [Array{String}] all druids in the supplied Hash
+    def druid_array(response, params = {})
       return_list = []
-      j = response
-      j.keys.each do |key|
-        if key != @@counts_key
-          j[key].each do |item|
-            if item['druid'] != nil
-              druid=item['druid'].downcase
-              druid.gsub!('druid:','') if params[:no_prefix]
-              return_list << druid
-            end
-          end
+      response.each do |key, items|
+        next if key == @@counts_key
+        items.each do |item|
+          next if item['druid'].nil?
+          druid = item['druid'].downcase
+          return_list << (params[:no_prefix] ? druid.gsub('druid:', '') : druid)
         end
       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)
+      return_list
+    end
+
+    # Synthesize URL from base, druid and params
+    # @see #query_api for args
+    # @return [String] URL
+    def query_url(base, druid, params)
       url = "#{@site}/#{base}"
-      url +="/#{druid}" unless druid.nil? || druid.empty?
-      url +="#{add_params(params)}" unless params.nil? || params.empty?
+      url += "/#{druid}" unless druid.nil? || druid.empty?
+      url += add_params(params).to_s unless params.nil? || params.empty?
+      url
+    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
+    # @option params [Hash] :count_only
+    # @return [Hash,Integer] All objects governed by the APO including pid/druid, title, date last modified, and count -- or just the count if :count_only
+    def query_api(base, druid, params)
+      url = query_url(base, druid, params)
       begin
-        #We need to use this method here for the longer timeout option
-        resp = RestClient::Request.execute(:method=> :get, :url=>url, :timeout=>90000000, :open_timeout=>90000000)
-      rescue
-        raise "Connection Error with url #{url}"
+        # We use RestClient::Request.execute here for the longer timeout option
+        resp = RestClient::Request.execute(:method => :get, :url => url, :timeout => 180)
+      rescue RestClient::Exception => e
+        warn "Connection Error with url #{url}: #{e.message}"
+        raise e
       end
-      
-      #RestClient monkey patches its response so it looks like a string, but really isn't.
-      #If you just dd resp.to_i, you'll get the HTML Code, normally 200, not the actually body text you want
-      return resp[0..resp.size].to_i if params[:count_only] == true 
-      
-      return JSON[resp] #Convert the response JSON to a Ruby Hash
-    end
-    
-  #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)  
-     input_params.delete_if {|key,value| !@@supported_params.include?(key)}
-     uri = Addressable::URI.new
-     uri.query_values=input_params
-     qs=uri.query.gsub("count_only=true",@@count_only_param)
-     return "?#{qs}"   
-   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
-    
+
+      # RestClient monkey patches its response so it looks like a string, but really isn't.
+      # If you just dd resp.to_i, you'll get the HTML Code, normally 200, not the actually body text you want
+      return resp[0..resp.size].to_i if params[:count_only] == true
+      JSON[resp] # Convert the response JSON to a Ruby Hash
+    end
+
+    # Transform a parameter hash into a RESTful API parameter format
+    # @param input_params [Hash{Symbol=>Object}] 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)
+      uri = Addressable::URI.new
+      uri.query_values = input_params.select { |key, _val| @@supported_params.include?(key) }
+      '?' + uri.query.gsub('count_only=true', @@count_only_param)
+    end
   end
-    
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-fetcher
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 1.3.0
 platform: ruby
 authors:
 - Carrick Rogers
@@ -12,102 +12,130 @@ bindir: bin
 cert_chain: []
 date: 2014-12-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rubocop
+  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: 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'
 - !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'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Wrapper for the Dor Fetcher Services RESTful API.
@@ -120,7 +148,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/dor-fetcher.rb
-homepage: http://www.stanford.edu
+homepage: https://github.com/sul-dlss/dor-fetcher
 licenses:
 - Apache-2.0
 metadata: {}
@@ -130,19 +158,18 @@ 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.4.2
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: DorFetcher Gem
 test_files: []
-has_rdoc: