nypl_sierra_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8936adc2234429844a356e11687cb660933b0ad20f22acac447a09f9595af0d0
+  data.tar.gz: e14ab0690f2d3b8b9a340a1248a4746a9c9c418298c8028e9be096d380a204c5
+SHA512:
+  metadata.gz: a50a652ee9278599ca077c5fa3a197128163e0f91eb8d2bd57db3152a31bdea413004541abf49d060eb907fae2a3fd8edf0dfcf0fd0d60b893b1beb69a4600df
+  data.tar.gz: 7dd271f819f77d1f58cdb4aa0b12c61921cb41ec7cf29eeaf6d637444e251328a89136479f7a9f888f9d92b5758de77c8e63517db78db86671ce67371301edd1

data/lib/errors.rb

@@ -0,0 +1,13 @@
+class SierraApiClientError < StandardError
+end
+
+class SierraApiClientTokenError < SierraApiClientError
+end
+
+class SierraApiResponseError < StandardError
+  attr_reader :response
+  
+  def initialize(response)
+    @response = response
+  end
+end

data/lib/sierra_api_client.rb

@@ -0,0 +1,139 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'nypl_log_formatter'
+
+require_relative 'errors'
+require_relative 'sierra_api_response'
+
+class SierraApiClient
+  def initialize(config = {})
+    @config = {
+      base_url: ENV['SIERRA_API_BASE_URL'],
+      client_id: ENV['SIERRA_OAUTH_ID'],
+      client_secret: ENV['SIERRA_OAUTH_SECRET'],
+      oauth_url: ENV['SIERRA_OAUTH_URL'],
+      log_level: 'info'
+    }.merge config
+
+    raise SierraApiClientError.new 'Missing config: neither config.base_url nor ENV.SIERRA_API_BASE_URL are set' unless @config[:base_url]
+    raise SierraApiClientError.new 'Missing config: neither config.client_id nor ENV.SIERRA_OAUTH_ID are set' unless @config[:client_id]
+    raise SierraApiClientError.new 'Missing config: neither config.client_secret nor ENV.SIERRA_OAUTH_SECRET are set ' unless @config[:client_secret]
+    raise SierraApiClientError.new 'Missing config: neither config.oauth_url nor ENV.SIERRA_OAUTH_URL are set ' unless @config[:oauth_url]
+  end
+
+  def get (path, options = {})
+    options = parse_http_options options
+
+    do_request 'get', path, options
+  end
+
+  def post (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 'post', path, options do |request|
+      request.body = body
+      request.body = request.body.to_json unless options[:headers]['Content-Type'] != 'application/json'
+    end
+  end
+
+  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]
+
+    uri = URI.parse("#{@config[:base_url]}#{path}")
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.scheme === 'https'
+
+    # 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.path, request_headers)
+
+    # Add bearer token header
+    request['Authorization'] = "Bearer #{@access_token}" if options[:authenticated]
+
+    # 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 }
+
+    begin
+      # Execute request:
+      response = http.request(request)
+    rescue => e
+      raise SierraApiClientError.new(e), "Failed to #{method} to #{path}: #{e.message}"
+    end
+
+    logger.debug "SierraApiClient: Got Sierra api response", { code: response.code, body: response.body }
+
+    parse_response response
+  end
+
+  def parse_response (response)
+    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}")
+    end
+    
+    SierraApiResponse.new(response)
+  end
+
+  def parse_http_options (_options)
+    options = {
+      authenticated: true
+    }.merge _options
+
+    options[:headers] = {
+    }.merge(_options[:headers] || {})
+      .transform_keys(&:to_s)
+
+    options
+  end
+
+  # Authorizes the request.
+  def authenticate!
+    # NOOP if we've already authenticated
+    return nil if ! @access_token.nil?
+
+    logger.debug "SierraApiClient: Authenticating with client_id #{@config[:client_id]}"
+
+    uri = URI.parse("#{@config[:oauth_url]}")
+    request = Net::HTTP::Post.new(uri)
+    request.basic_auth(@config[:client_id], @config[:client_secret])
+    request.set_form_data(
+      "grant_type" => "client_credentials"
+    )
+
+    req_options = {
+      use_ssl: uri.scheme == "https",
+      request_timeout: 500
+    }
+
+    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+      http.request(request)
+    end
+
+    if response.code == '200'
+      @access_token = JSON.parse(response.body)["access_token"]
+    else
+      nil
+    end
+  end
+
+  def logger
+    @logger ||= NyplLogFormatter.new(STDOUT, level: @config[:log_level])
+  end
+end

data/lib/sierra_api_response.rb

@@ -0,0 +1,34 @@
+class SierraApiResponse
+  attr_accessor :response
+
+  def initialize(response)
+    @response = response
+  end
+
+  def code
+    @response.code.to_i
+  end
+
+  def error?
+    code >= 400
+  end
+
+  def success?
+    (200...300).include? code
+  end
+
+  def body
+    return @response.body if @response.code == '204' 
+
+    # If response Content-Type indicates body is json
+    if /^application\/json/ =~ @response['Content-Type'] 
+      begin
+        JSON.parse(@response.body)
+      rescue => e
+        raise SierraApiResponseError.new(response), "Error parsing response (#{response.code}): #{response.body}"
+      end
+    else
+      @response.body
+    end
+  end
+end

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: nypl_sierra_api_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- nonword
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-21 00:00:00.000000000 Z
+dependencies: []
+description: Client for querying Sierra API
+email: paulbeaudoin@nypl.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/errors.rb
+- lib/sierra_api_client.rb
+- lib/sierra_api_response.rb
+homepage: https://github.com/NYPL/ruby-sierra-api-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: NYPL Sierra API client
+test_files: []