nypl_platform_api_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1df8231c019f86e347ab7fa83b1f13db8aa1f02ef3488c1aa5eb055cbaacc63e
+  data.tar.gz: ecd9488ca99d6790e4e35362840861636f5b34a34aaf68a42f4cc963db090ef2
+SHA512:
+  metadata.gz: 42b3a9a06976b667c9ac2dd80742d421adc0af0d65c133798bd19ebd602d728e742285e3c2c8e3f13bfce4cc76e1389f4c517a29aacb60384fa4b29362e08aff
+  data.tar.gz: f9c3acf9e5a9e2ff9bc8520049f83a027c5b6271668d60697f09eb4fb66af651ba0be0d481ce9495e59d81bba1196415bc73e18fe3eac2c14d45c33e7e408657

data/lib/errors.rb

@@ -0,0 +1,5 @@
+class NyplPlatformApiClientError < StandardError
+end
+
+class NyplPlatformApiClientTokenError < NyplPlatformApiClientError
+end

data/lib/nypl_platform_api_client.rb

@@ -0,0 +1,148 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+
+require_relative 'errors'
+
+class NyplPlatformApiClient
+  def initialize(config = {})
+    @config = {
+      base_url: ENV['PLATFORM_API_BASE_URL'],
+      client_id: ENV['NYPL_OAUTH_ID'],
+      client_secret: ENV['NYPL_OAUTH_SECRET'],
+      oauth_url: ENV['NYPL_OAUTH_URL'],
+      log_level: 'info'
+    }.merge config
+
+    raise NyplPlatformApiClientError.new 'Missing config: neither config.base_url nor ENV.PLATFORM_API_BASE_URL are set' unless @config[:base_url]
+    raise NyplPlatformApiClientError.new 'Missing config: neither config.client_id nor ENV.NYPL_OAUTH_ID are set' unless @config[:client_id]
+    raise NyplPlatformApiClientError.new 'Missing config: neither config.client_secret nor ENV.NYPL_OAUTH_SECRET are set ' unless @config[:client_secret]
+    raise NyplPlatformApiClientError.new 'Missing config: neither config.oauth_url nor ENV.NYPL_OAUTH_URL are set ' unless @config[:oauth_url]
+  end
+
+  def get (path, options = {})
+    options = parse_http_options options
+
+    authenticate! if options[:authenticated]
+
+    uri = URI.parse("#{@config[:base_url]}#{path}")
+
+    logger.debug "NyplPlatformApiClient: Getting from platform api", { uri: uri }
+
+    begin
+      request = Net::HTTP::Get.new(uri)
+
+      # Add bearer token header
+      request["Authorization"] = "Bearer #{@access_token}" if options[:authenticated]
+
+      # Execute request:
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme === 'https') do |http|
+        http.request(request)
+      end
+    rescue Exception => e
+      raise NyplPlatformApiClientError.new(e), "Failed to GET #{path}: #{e.message}"
+    end
+
+    logger.debug "NyplPlatformApiClient: Got platform api response", { code: response.code, body: response.body }
+
+    parse_json_response response
+  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']
+
+    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'
+
+    begin
+      request = Net::HTTP::Post.new(uri.path, 'Content-Type' => options[:headers]['Content-Type'])
+      request.body = body.to_json
+
+      logger.debug "NyplPlatformApiClient: Posting to platform api", { uri: uri, body: body }
+
+      # Add bearer token header
+      request['Authorization'] = "Bearer #{@access_token}" if options[:authenticated]
+
+      # Execute request:
+      response = http.request(request)
+    rescue Exception => e
+      raise NyplPlatformApiClientError.new(e), "Failed to POST to #{path}: #{e.message}"
+    end
+
+    logger.debug "NyplPlatformApiClient: Got platform api response", { code: response.code, body: response.body }
+
+    parse_json_response response
+  end
+
+  private
+
+  def parse_http_options (_options)
+    options = {
+      authenticated: true
+    }.merge _options
+
+    options[:headers] = {
+    }.merge(_options[:headers] || {})
+      .transform_keys(&:to_s)
+
+    options
+  end
+
+  def parse_json_response (response)
+    # Among NYPL services, these are the only non-error statuses with useful JSON payloads:
+    if ['200', '404'].include? response.code
+      begin
+        JSON.parse(response.body)
+      rescue => e
+        raise NyplPlatformApiClientError, "Error parsing response (#{response.code}): #{response.body}"
+      end
+    elsif response.code == "401"
+      # Likely an expired access-token; Wipe it for next run
+      @access_token = nil
+      raise NyplPlatformApiClientTokenError.new("Got a 401: #{response.body}")
+    else
+      raise NyplPlatformApiClientError, "Error interpretting response (#{response.code}): #{response.body}"
+    end
+  end
+
+  # Authorizes the request.
+  def authenticate!
+    # NOOP if we've already authenticated
+    return nil if ! @access_token.nil?
+
+    logger.debug "NyplPlatformApiClient: Authenticating with client_id #{@config[:client_id]}"
+
+    uri = URI.parse("#{@config[:oauth_url]}oauth/token")
+    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

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: nypl_platform_api_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- nonword
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-23 00:00:00.000000000 Z
+dependencies: []
+description: Client for querying NYPL's internal Platform API
+email: paulbeaudoin@nypl.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/errors.rb
+- lib/nypl_platform_api_client.rb
+homepage: https://github.com/NYPL/ruby_nypl_platform_nypl_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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: NYPL Platform API client
+test_files: []