nypl_sierra_api_client 1.0.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 227304609f16f96cf643ec758501e7ba23952da2c77cc513d6b08781622da9a8
-  data.tar.gz: a723fc2eb6e3fc3e33937c513eaddaa05d7a194b9f11fc8eb12f9d2cfd7da594
+  metadata.gz: 7216ca46bebde733ae89eca1d88081d1d5cf2db7543dcdf801e433a4400ee4c4
+  data.tar.gz: bc2076e537315b8324bd4f54748090d68aa1d23c761aa9b44d948e95347864e8
 SHA512:
-  metadata.gz: 213eed76eb255b12e38b00d7460dfb91bc8fac2afa2c92e025fb62019bee8a35d3c664b4713988865ed6b57327b736f3301858a40ae3a8019fad24e50342eb0e
-  data.tar.gz: 97b00de6b5114deb32da9e72b3490e03e26077c9e23db72f015adc584c5a56a6b912798156fd59021c3d9a43840755b96c4e2b92a113c0a6216cde9edbb53cd5
+  metadata.gz: ee64dd2daae74d47757acba0df00a61c0e8b00d6f52a35a3c2c1fc53f43a8542436dac51463cd723c66333f122c70b07abe6db1e2ef7d78899f084206f14d29b
+  data.tar.gz: 7c09588f8be4a03f56519523008b116443930ef0b39880d14860305aa64278cbfec5a0ba1b9216ab1dced91b757013ed820abea4f0c96496488ec216ae023c86

data/lib/nypl_sierra_api_client.rb

@@ -27,6 +27,25 @@ class SierraApiClient
     config_defaults[:env].each do |key, value|
       raise SierraApiClientError.new "Missing config: neither config.#{key} nor ENV.#{value} are set" unless @config[key]
     end
+
+    @retries = 0
+  end
+
+  def put (path, body, options = {})
+  options = parse_http_options options
+    # Default to POSTing JSON unless explicitly stated otherwise
+    options[:headers]['Content-Type'] = 'application/json' unless options[:headers]['Content-Type']
+
+    do_request 'put', path, options do |request|
+      request.body = body
+      request.body = request.body.to_json unless options[:headers]['Content-Type'] != 'application/json'
+    end
+  end
+
+  def delete (path, options = {})
+  options = parse_http_options options
+
+  do_request 'delete', path, options
   end
 
   def get (path, options = {})
@@ -50,22 +69,19 @@ class SierraApiClient
   private
 
   def do_request (method, path, options = {})
-    # For now, these are the methods we support:
-    raise SierraApiClientError, "Unsupported method: #{method}" unless ['get', 'post'].include? method.downcase
 
-    authenticate! if options[:authenticated]
+  raise SierraApiClientError, "Unsupported method: #{method}" unless ['get', 'post', 'put', 'delete'].include? method.downcase
 
-    uri = URI.parse("#{@config[:base_url]}#{path}")
+    authenticate! if options[:authenticated]
 
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = uri.scheme === 'https'
+    @uri = URI.parse("#{@config[:base_url]}#{path}")
 
     # Build request headers:
     request_headers = {}
     request_headers['Content-Type'] = options[:headers]['Content-Type'] unless options.dig(:headers, 'Content-Type').nil?
 
     # Create HTTP::Get or HTTP::Post
-    request =  Net::HTTP.const_get(method.capitalize).new(uri, request_headers)
+    request =  Net::HTTP.const_get(method.capitalize).new(@uri, request_headers)
 
     # Add bearer token header
     request['Authorization'] = "Bearer #{@access_token}" if options[:authenticated]
@@ -73,31 +89,76 @@ class SierraApiClient
     # Allow caller to modify the request before we send it off:
     yield request if block_given?
 
-    logger.debug "SierraApiClient: #{method} to Sierra api", { uri: uri, body: request.body }
+    logger.debug "SierraApiClient: #{method} to Sierra api", { uri: @uri, body: request.body }
+
+    execute request, options
+  end
+
+  def execute (request, options)
+    http = Net::HTTP.new(@uri.host, @uri.port)
+    http.use_ssl = @uri.scheme === 'https'
 
     begin
-      # Execute request:
       response = http.request(request)
+      logger.debug "SierraApiClient: Got Sierra api response", { code: response.code, body: response.body }
     rescue => e
-      raise SierraApiClientError.new(e), "Failed to #{method} to #{path}: #{e.message}"
+      raise SierraApiClientError.new "Failed to #{request.method} to #{request.path}: #{e.message}"
     end
 
-    logger.debug "SierraApiClient: Got Sierra api response", { code: response.code, body: response.body }
-
-    parse_response response
+    handle_response response, request, options
   end
 
-  def parse_response (response)
+  def handle_response (response, request, options)
     if response.code == "401"
       # Likely an expired access-token; Wipe it for next run
-      # TODO: Implement token refresh
       @access_token = nil
-      raise SierraApiClientTokenError.new("Got a 401: #{response.body}")
+      if @retries < 3
+        if options[:authenticated]
+          logger.debug "SierraApiClient: Refreshing oauth token for 401", { code: 401, body: response.body, retry: @retries }
+
+          return reauthenticate_and_reattempt request, options
+        end
+      else
+        retries_exceeded = true
+      end
+
+      reset_retries
+      message = "Got a 401: #{retries_exceeded ? "Maximum retries exceeded, " : ''}#{response.body}"
+      raise SierraApiClientTokenError.new(message)
     end
 
+    if response.body == '' && response.code.to_i < 300 && response.code.to_i >= 200
+        reattempt_request request, options
+    end
+
+    reset_retries if @retries > 0
     SierraApiResponse.new(response)
   end
 
+
+  def reattempt_request request, options 
+    if @retries < 3
+      logger.warn "#{request.method} request retry ##{@retries} due to empty response from Sierra API"
+      sleep 2 ** (@retries - 1)
+      @retries += 1
+      execute request, options
+    else 
+      reset_retries
+      raise SierraApiResponseError.new "Sierra API Client: Request failed after 3 empty responses received from Sierra API"
+    end 
+  end
+
+
+  def reauthenticate_and_reattempt request, options
+    @retries += 1
+    sleep 2 ** (@retries - 1)
+    authenticate!
+    # Reset bearer token header
+    request['Authorization'] = "Bearer #{@access_token}"
+
+    execute request, options
+  end
+
   def parse_http_options (_options)
     options = {
       authenticated: true
@@ -143,4 +204,8 @@ class SierraApiClient
   def logger
     @logger ||= NyplLogFormatter.new(STDOUT, level: @config[:log_level])
   end
+
+  def reset_retries
+    @retries = 0
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nypl_sierra_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.0
 platform: ruby
 authors:
 - nonword