apia-client 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7855cdda856e2e80063bfb19c3c41280e3979e06de43b120e90d122768cb1144
+  data.tar.gz: 1ff0272215aa64ca9005f3749bcd88d681ee138ea1fb46170ed363140e8b9f27
+SHA512:
+  metadata.gz: 60c2e8821cf3e0f96e0792d5be28b1d6feb1db85fa566094cfb587f48b16ebc0df336a72d728685c61705271ea2eb4fc9f61794b6479231f493292516067ce5f
+  data.tar.gz: ef94dd2485dd2a0fe28a12bd15ea915332ff544d266165677801a4ec21cda980e02f4594108680d86f62dfdffe8b97fdda4fc03b824b9f97f801efc844df9a74

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/lib/apia-client.rb

@@ -0,0 +1,6 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+require 'apia_client'
+
+# rubocop:enable Naming/FileName

data/lib/apia_client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'apia_client/request_types/delete'
+require 'apia_client/request_types/get'
+require 'apia_client/request_types/patch'
+require 'apia_client/request_types/post'
+require 'apia_client/request_types/put'
+
+require 'apia_client/api'
+
+module ApiaClient
+
+  class << self
+
+    def load(*args, **options)
+      API.load(*args, **options)
+    end
+
+  end
+
+end

data/lib/apia_client/api.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'apia_schema_parser'
+require 'apia_client/errors/request_error'
+require 'apia_client/errors/connection_error'
+require 'apia_client/errors/schema_not_loaded_error'
+require 'apia_client/errors/timeout_error'
+require 'apia_client/response'
+require 'apia_client/request_proxy'
+
+module ApiaClient
+  class API
+
+    attr_reader :host
+    attr_reader :headers
+    attr_reader :schema
+
+    def initialize(host, **options)
+      @host = host
+      @headers = options[:headers] || {}
+      @options = options
+    end
+
+    def ssl?
+      @options[:ssl].nil? || @options[:ssl] == true
+    end
+
+    def port
+      @options[:port] || (ssl? ? 443 : 80)
+    end
+
+    def namespace
+      (@options[:namespace] || '').sub(/\A\/*/, '').sub(/\/*\z/, '')
+    end
+
+    def schema?
+      !!@schema
+    end
+
+    def load_schema
+      response = request(Get.new('schema'))
+      @schema = ApiaSchemaParser::Schema.new(response.hash)
+      true
+    end
+
+    def request(request)
+      status, headers, body = make_http_request(request) do |req|
+        request.add_arguments_to_request(req)
+      end
+      Response.new(self, request, body, headers, status)
+    end
+
+    def perform(*args)
+      request = create_request(*args)
+      return if request.nil?
+
+      yield request if block_given?
+      request.perform
+    end
+
+    def create_request(method, path)
+      unless schema?
+        raise SchemaNotLoadedError, 'No schema has been loaded for this API instance'
+      end
+
+      route = schema.api.route_set.routes.find do |r|
+        r.request_method == method.to_s.upcase &&
+          r.path == path
+      end
+
+      return if route.nil?
+
+      RequestProxy.new(self, route)
+    end
+
+    private
+
+    def create_http(**options)
+      http = Net::HTTP.new(host, port)
+      http.use_ssl = ssl?
+      http.read_timeout = options[:http_read_timeout] || @options[:http_read_timeout] || 60
+      http.open_timeout = options[:http_open_timeout] || @options[:http_open_timeout] || 10
+      http
+    end
+
+    def make_http_request(request)
+      http_request = request.class.method.new("/#{namespace}/#{request.path_for_net_http}")
+      @headers.each do |key, value|
+        http_request[key] = value
+      end
+      yield http_request if block_given?
+      response = make_request_with_error_handling(http_request, request)
+      handle_response(response)
+    end
+
+    def make_request_with_error_handling(http_request, request)
+      http = create_http(
+        http_read_timeout: request.http_read_timeout,
+        http_open_timeout: request.http_open_timeout
+      )
+      http.request(http_request)
+    rescue Timeout::Error => e
+      raise ApiaClient::TimeoutError, e.message
+    rescue StandardError => e
+      raise ConnectionError, e.message
+    end
+
+    def handle_response(response)
+      if response['content-type'] =~ /application\/json/
+        body = JSON.parse(response.body)
+      else
+        body = response.body
+      end
+
+      status_code = response.code.to_i
+      if status_code >= 200 && status_code < 300
+        return [status_code, response.to_hash, body]
+      end
+
+      raise RequestError.new(self, status_code, body)
+    end
+
+    class << self
+
+      def load(*args, **options)
+        api = new(*args, **options)
+        api.load_schema
+        api
+      end
+
+    end
+
+  end
+end

data/lib/apia_client/errors/connection_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApiaClient
+  class ConnectionError < StandardError
+  end
+end

data/lib/apia_client/errors/request_error.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ApiaClient
+  class RequestError < StandardError
+
+    attr_reader :status
+    attr_reader :body
+
+    # rubocop:disable Lint/MissingSuper
+    def initialize(client, status, body)
+      @client = client
+      @status = status
+      @body = body
+
+      @error = @body['error']
+    end
+    # rubocop:enable Lint/MissingSuper
+
+    def to_s
+      string = ["[#{@status}]"]
+      if code && description
+        string << "#{code}: #{description}"
+      elsif code
+        string << code
+      else
+        string << @body
+      end
+      string.join(' ')
+    end
+
+    def code
+      return if @error.nil?
+
+      @error['code']
+    end
+
+    def description
+      return if @error.nil?
+
+      @error['description']
+    end
+
+    def detail
+      return if @error.nil?
+
+      @error['detail'] || {}
+    end
+
+  end
+end

data/lib/apia_client/errors/schema_not_loaded_error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ApiaClient
+  class SchemaNotLoadedError < StandardError
+  end
+end

data/lib/apia_client/errors/timeout_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'apia_client/errors/connection_error'
+
+module ApiaClient
+  class TimeoutError < ConnectionError
+  end
+end

data/lib/apia_client/request.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module ApiaClient
+  class Request
+
+    class << self
+
+      attr_accessor :method
+
+    end
+
+    attr_reader :path
+    attr_reader :arguments
+    attr_accessor :http_read_timeout
+    attr_accessor :http_open_timeout
+
+    def initialize(path)
+      @path = path
+      @arguments = {}
+    end
+
+    def path_for_net_http
+      path
+    end
+
+    def add_arguments_to_request(request)
+      request['Content-Type'] = 'application/json'
+      request.body = arguments.to_json
+    end
+
+  end
+end

data/lib/apia_client/request_proxy.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ApiaClient
+  class RequestProxy
+
+    METHOD_MAP = {
+      get: ApiaClient::Get,
+      post: ApiaClient::Post,
+      patch: ApiaClient::Patch,
+      put: ApiaClient::Put,
+      delete: ApiaClient::Delete
+    }.freeze
+
+    attr_reader :route
+    attr_reader :request
+
+    def initialize(client, route)
+      @client = client
+      @route = route
+
+      request_class = METHOD_MAP[@route.request_method.downcase.to_sym]
+      @request = request_class.new(@route.path)
+    end
+
+    def perform
+      @client.request(@request)
+    end
+
+    def arguments
+      @request.arguments
+    end
+
+    def endpoint
+      @route.endpoint
+    end
+
+  end
+end

data/lib/apia_client/request_types/delete.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'apia_client/request'
+
+module ApiaClient
+  class Delete < Request
+
+    self.method = Net::HTTP::Delete
+
+  end
+end

data/lib/apia_client/request_types/get.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'apia_client/request'
+require 'json'
+require 'uri'
+
+module ApiaClient
+  class Get < Request
+
+    self.method = Net::HTTP::Get
+
+    def path_for_net_http
+      querystring = URI.encode_www_form(_arguments: @arguments.to_json)
+      "#{path}?#{querystring}"
+    end
+
+    def add_arguments_to_request(request)
+      # Don't need to do anything for GET requests...
+    end
+
+  end
+end

data/lib/apia_client/request_types/patch.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'apia_client/request'
+
+module ApiaClient
+  class Patch < Request
+
+    self.method = Net::HTTP::Patch
+
+  end
+end

data/lib/apia_client/request_types/post.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'apia_client/request'
+
+module ApiaClient
+  class Post < Request
+
+    self.method = Net::HTTP::Post
+
+  end
+end

data/lib/apia_client/request_types/put.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'apia_client/request'
+
+module ApiaClient
+  class Put < Request
+
+    self.method = Net::HTTP::Put
+
+  end
+end

data/lib/apia_client/response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ApiaClient
+  class Response
+
+    def initialize(client, request, hash, headers, status)
+      @client = client
+      @request = request
+      @hash = hash
+      @headers = headers
+      @status = status
+    end
+
+    attr_reader :request
+    attr_reader :hash
+    attr_reader :headers
+    attr_reader :status
+
+  end
+end

data/lib/apia_client/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ApiaClient
+
+  VERSION_FILE_ROOT = File.expand_path('../../VERSION', __dir__)
+  if File.file?(VERSION_FILE_ROOT)
+    VERSION = File.read(VERSION_FILE_ROOT).strip.sub(/\Av/, '')
+  else
+    VERSION = '0.0.0.dev'
+  end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: apia-client
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: apia-schema-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: json
+  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: A client library for talking to any Apia API.
+email:
+- adam@k.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/apia-client.rb
+- lib/apia_client.rb
+- lib/apia_client/api.rb
+- lib/apia_client/errors/connection_error.rb
+- lib/apia_client/errors/request_error.rb
+- lib/apia_client/errors/schema_not_loaded_error.rb
+- lib/apia_client/errors/timeout_error.rb
+- lib/apia_client/request.rb
+- lib/apia_client/request_proxy.rb
+- lib/apia_client/request_types/delete.rb
+- lib/apia_client/request_types/get.rb
+- lib/apia_client/request_types/patch.rb
+- lib/apia_client/request_types/post.rb
+- lib/apia_client/request_types/put.rb
+- lib/apia_client/response.rb
+- lib/apia_client/version.rb
+homepage: https://github.com/krystal/apia-ruby-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: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A client library for talking to any Apia API.
+test_files: []