pipeline_deals_api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6682299969b7ad219bc42af20c95ad2eeaf2d1d2dfca1eeeb772b5304a390a34
-  data.tar.gz: c8440c05a8e48466407b52a312ace43b421937037832bd45d1f8b5304324091e
+  metadata.gz: 1a0369766e73baf651ae94addd30794c1a18a0742a24c20110d1036742eb3c57
+  data.tar.gz: e657b46c2e3a7ea0d1570b8111f1b3a22793762b6e1350967db7798ebfa4f0c1
 SHA512:
-  metadata.gz: 248a5ee91e95cad960fe2de83599deb561f60a03cac02fefa2e89a5f4f53a225119f67bb6c498b4a94dedf4790334b789ea75be4b1c71d0f0e501db09847ae03
-  data.tar.gz: 112ea1ccb2b790af8b4acb54f89b2e34bc3b908b857a319f79782979005063dfa4573412c2c5330ecd6203375c30f5ff7bef858491486c6975f5ad7ff7743e59
+  metadata.gz: bf26366c15922b70c75269d1c5d67b45b2fa8224824a174329891ea467f6b8303d6f826157375d71d1109db2d4b9d923e20eec4849d255f17ec65442fe80b051
+  data.tar.gz: c5abf799a2ef17262a4508eaae8bd4460f45c83261a60ae01f357ba114a665105b2f3befa93e721cd3532a57a21de7c832701f3902b82f88cb0fd7faf3b62155

data/lib/pipeline_deals_api/client.rb

@@ -0,0 +1,52 @@
+module PipelineDealsApi
+  # NOTE(asinner): The Client class is responsible for giving you an object
+  # for communicating with the API.
+  #
+  # To create a new client call the Client class constructor and pass your
+  # credentials using named parameters:
+  #
+  # ```
+  # client = PipelineDealsApi::Client.new(api_key: 'your-api-key')
+  # ```
+  # If you have an `app_key` token you may also pass that in addition to your
+  # `api_key`
+  #
+  # ```
+  # client = PipelineDealsApi::Client.new(
+  #   api_key: 'your-api-key',
+  #   app_key: 'your-app-key'
+  # )
+  # ```
+  class Client
+    attr_reader :credentials
+
+    def initialize(api_key:, app_key: nil)
+      @credentials = Credentials.new(
+        api_key: api_key,
+        app_key: app_key
+      )
+      init_config
+      init_clients
+    end
+
+    private
+
+    attr_reader :http_client, :deal_client
+
+    def init_clients
+      @deal_client = Cients::Deal.new(
+        http_client: http_client
+      )
+    end
+
+    def init_config
+      init_http_client
+    end
+
+    def init_http_client
+      @http_client ||= HttpClient.new(
+        credentials: @credentials
+      )
+    end
+  end
+end

data/lib/pipeline_deals_api/clients/deal.rb

@@ -0,0 +1,20 @@
+module PipelineDealsApi
+  module Clients
+    class Deal
+      include Helper
+
+      def initialize(http_client:,)
+        @http_client = http_client
+      end
+
+      def create_deal(body)
+        body = wrap_body(body)
+        http_client.post('/deals.json', body)
+      end
+
+      private
+
+      attr_reader :http_client
+    end
+  end
+end

data/lib/pipeline_deals_api/clients/helper.rb

@@ -0,0 +1,12 @@
+module PipelineDealsApi
+  module Clients
+    module Helper
+      def body_wrap(hash, key)
+        return hash if hash.key?(key)
+        wrapped_hash = {}
+        wrapped_hash[key] = body
+        wrapped_hash
+      end
+    end
+  end
+end

data/lib/pipeline_deals_api/configuration.rb

@@ -0,0 +1,6 @@
+module PipelineDealsApi
+  class Configuration
+    API_URL = 'https://api.pipelinedeals.com/api/v3'.freeze
+    FORMAT = 'json'.freeze
+  end
+end

data/lib/pipeline_deals_api/credentials.rb

@@ -0,0 +1,14 @@
+module PipelineDealsApi
+  class Credentials
+    attr_reader :api_key, :app_key
+
+    def initialize(api_key:, app_key: nil)
+      @api_key = api_key.freeze
+      @app_key = app_key.freeze
+    end
+
+    def valid?
+      api_key.present?
+    end
+  end
+end

data/lib/pipeline_deals_api/http_client.rb

@@ -0,0 +1,145 @@
+module PipelineDealsApi
+  class HttpClient
+    def initialize(credentials:)
+      @credentials = credentials
+    end
+
+    def get(url, body = {}, headers = {})
+      http_request(:get, url, body, headers)
+    end
+
+    def put(url, body = {}, headers = {})
+      http_request(:put, url, body, headers)
+    end
+
+    def post(url, body = {}, headers = {})
+      http_request(:post, url, body, headers)
+    end
+
+    def delete(url, body = {}, headers = {})
+      http_request(:delete, url, body, headers)
+    end
+
+    private
+
+    attr_reader :http_client
+
+    def http_request(method, url = '', body = {}, headers = {})
+      body = with_default_body(body).to_json
+      headers = with_default_headers(headers)
+      resp = RestClient.send(method, url, body, headers)
+      handle_response(Response.new(resp))
+    rescue RestClient::ExceptionWithResponse => e
+      resp = Response.new(e.response)
+      handle_response(resp)
+    end
+
+    def handle_response(resp)
+      return resp.json if resp.code < 400
+      case resp.code
+      when 400
+        raise BadRequestError.new('400 - Bad Request', resp)
+      when 401
+        raise UnauthorizedError.new('401 - Unauthorized', resp)
+      when 402
+        raise PaymentRequiredError.new('402 - Payment Required', resp)
+      when 403
+      when 404
+        raise NotFoundError.new('404 - Not Found', resp)
+      when 405
+        raise MethodNotAllowed.new('405 - Method Not Allowed', resp)
+      when 408
+        raise RequestTimeoutError.new('408 - Request Timeout', resp)
+      when 409
+        raise ConflictError.new('409 - Conflict', resp)
+      when 414
+        raise RequestURITooLongError.new('414 - Request URI Too Long', resp)
+      when 422
+        raise UnprocessableEntityError.new('422 - Unprocessable Entity', resp)
+      when 429
+        raise TooManyRequestsError.new('429 - Too Many Requests', resp)
+      when 500
+        raise InternalServerError.new('500 - Internal Server', resp)
+      when 502
+        raise BadGatewayError.new('502 - Bad Gateway', resp)
+      when 503
+        raise BadGatewayError.new('503 - Service Unavailable', resp)
+      when 504
+        raise GatewayTimeoutError.new('504 - Gateway Timeout', resp)
+      else
+        raise ClientError.new("#{resp.code} - Client Error", resp) if resp.code >= 400 && resp.code < 500
+        raise ServerError.new("#{resp.code} - Server Error", resp) if resp.code >= 500 && resp.code < 600
+        raise UnknownError.new("#{resp.code} - Unhandled Response error", resp)
+      end
+    end
+
+    def with_default_headers(headers = {})
+      defaults = {
+        content_type: :json,
+        accept: :json
+      }
+
+      defaults.merge(headers)
+    end
+
+    def with_default_body(body = {})
+      defaults = {
+        api_key: credentials.api_key,
+        app_key: credentials.app_key
+      }
+
+      defaults.merge(body)
+    end
+
+    class Response
+      def initialize(response)
+        @response = response
+      end
+
+      def code
+        @response.code
+      end
+
+      def body
+        @response.body
+      end
+
+      def json
+        @json ||= JSON.parse(response.body)
+      end
+    end
+
+    class ResponseError < StandardError
+      attr_reader :response
+
+      def initialize(msg = '', response)
+        @response = response
+        super(msg)
+      end
+    end
+
+    # 4xx error codes
+    class BadRequestError < ResponseError; end
+    class UnauthorizedError < ResponseError; end
+    class PaymentRequiredError < ResponseError; end
+    class ForbiddenError < ResponseError; end
+    class NotFoundError < ResponseError; end
+    class MethodNotAllowed < ResponseError; end
+    class RequestTimeoutError < ResponseError; end
+    class ConflictError < ResponseError; end
+    class RequestURITooLongError < ResponseError; end
+    class UnprocessableEntityError < ResponseError; end
+    class TooManyRequestsError < ResponseError; end
+    class ClientError < ResponseError; end  # Catch-all
+
+    # 5xx error codes
+    class InternalServerError < ResponseError; end
+    class BadGatewayError < ResponseError; end
+    class ServiceUnavailableError < ResponseError; end
+    class GatewayTimeoutError < ResponseError; end
+    class ServerError < ResponseError; end # Catch-all
+
+    # Catch-all for catch-all
+    class UnknownError < ResponseError; end
+  end
+end

data/lib/pipeline_deals_api/version.rb

@@ -1,3 +1,3 @@
 module PipelineDealsApi
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/pipeline_deals_api.rb

@@ -1,5 +1,8 @@
-require "pipeline_deals_api/version"
+lib = File.dirname(__FILE__) + "./lib/**/*"
+
+Dir[lib].each do |file|
+  require file
+end
 
 module PipelineDealsApi
-  # Your code goes here...
 end

data/pipeline_deals_api.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "rest-client"
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pipeline_deals_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andrew Sinner
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2018-05-30 00:00:00.000000000 Z
 dependencies:
+- !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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,12 @@ files:
 - bin/console
 - bin/setup
 - lib/pipeline_deals_api.rb
+- lib/pipeline_deals_api/client.rb
+- lib/pipeline_deals_api/clients/deal.rb
+- lib/pipeline_deals_api/clients/helper.rb
+- lib/pipeline_deals_api/configuration.rb
+- lib/pipeline_deals_api/credentials.rb
+- lib/pipeline_deals_api/http_client.rb
 - lib/pipeline_deals_api/version.rb
 - pipeline_deals_api.gemspec
 homepage: