the_captain 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8892d789d45a648b93fdf9ba321ea2ac7c35b6075d884377e8186c78ece65b55
+  data.tar.gz: 143e22fb874f94790f77b05a518703ce889b2319eaaf8631d58adcd4db369efb
+SHA512:
+  metadata.gz: c6f4359e18b68ce119abf839978396cfb2b9c480bf3a69d28988bfc04b10ce07ad9117b3f1ba19d9061e6c7538aeebd34fc66d8449c4d1428d37c7f5e4ae3082
+  data.tar.gz: f6b9d44a64535eeb216986e24258d79efaca8b5d7172731acbc00f01ed04ad67d42bcc199be496edc29da3904f1d1579fb8800e7778dbb05bae2098a57a20890

data/README.md

@@ -0,0 +1,23 @@
+# The Captain Ruby Bindings
+[![Build Status](https://travis-ci.com/VianetManagement/the-captain-ruby.svg?token=HrNaBvyMMhTA1FpCeAJF&branch=master)](https://travis-ci.com/VianetManagement/the-captain-ruby)
+[![Code Climate](https://codeclimate.com/github/BeatnikBranding/the-captain-ruby/badges/gpa.svg)](https://codeclimate.com/github/BeatnikBranding/the-captain-ruby)
+
+## Installation
+
+```
+gem 'the_captain', :git => 'git@github.com:VianetManagement/the-captain-ruby.git', tag: "v1.0.0-RC6"
+```
+
+## Examples
+You can find more examples in `/examples` and at [our documentation site](https://captain.readme.io/docs)
+
+## Ruby support
+The Captain's tests are currently passing for 2.2.3
+
+## Links
+* [Source Code for The Captain](http://github.com/VianetManagement/the-captain)
+* [Documenation for The Captain](https://captain.readme.io/docs)
+* [Continuous Integration - Travis](https://travis-ci.com/VianetManagement/the-captain-ruby)
+
+## TODO
+* Write More Documentation

data/lib/the_captain.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "http"
+require "ostruct"
+require "oj"
+
+require "the_captain/version"
+
+# Exception Classes Container
+require "the_captain/error/exceptions"
+
+# Utility Helper classes
+require "the_captain/utility/helper"
+require "the_captain/utility/configuration"
+
+# Net and responses classes
+require "the_captain/response/captain_vessel"
+require "the_captain/response/captain_object"
+require "the_captain/captain_client"
+
+# Query Classes
+require "the_captain/api_resource"
+require "the_captain/collect"
+require "the_captain/user"
+require "the_captain/ip_address"
+require "the_captain/content"
+require "the_captain/credit_card"
+require "the_captain/email_address"
+
+module TheCaptain
+  @enabled         = true
+  @write_timeout   = 5
+  @read_timeout    = 5
+  @connect_timeout = 5
+
+  class << self
+    attr_accessor :enabled, :write_timeout, :read_timeout, :connect_timeout
+
+    def enabled?
+      @enabled
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def configuration
+      @configuration      ||= Utility::Configuration.new
+    end
+
+    def api_key
+      @api_key            ||= configuration.api_key.to_s.strip
+    end
+
+    def api_url
+      @api_url            ||= configuration.api_url.to_s.strip.chomp("/")
+    end
+
+    def retry_attempts
+      @retry_attempts     ||= configuration.retry_attempts.to_i
+    end
+
+    def raise_http_errors?
+      @raise_http_errors  ||= configuration.raise_http_errors
+    end
+  end
+end

data/lib/the_captain/api_resource.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class APIResource
+    def self.class_name
+      name.split("::")[-1]
+    end
+
+    def self.api_paths(**paths)
+      @api_paths ||= paths.tap { |hash| hash[:base] ||= "" }.freeze
+    end
+
+    def self.request(method, api_dest: :base, resource_id: nil, params: {})
+      return unless TheCaptain.enabled?
+
+      api_path = Utility::Helper.normalize_path(api_paths[api_dest], resource_id)
+      params   = Utility::Helper.normalize_params(params)
+
+      CaptainClient.active_client.request(method, api_path, params).decode_response
+    end
+
+    private_class_method :request
+
+    def self.define_get_path_methods!
+      api_paths.each_key do |path_key|
+        if path_key == :base
+          define_singleton_method(:receive) do |resource_id, **params|
+            request(:get, resource_id: resource_id, params: params)
+          end
+        else
+          define_singleton_method("related_#{path_key}".to_sym) do |resource_id, **params|
+            request(:get, resource_id: resource_id, api_dest: path_key, params: params)
+          end
+        end
+      end
+    end
+
+    private_class_method :define_get_path_methods!
+  end
+end

data/lib/the_captain/captain_client.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class CaptainClient
+    attr_accessor :conn
+    attr_reader   :response
+
+    REQUEST_METHODS = %i[get post].freeze
+
+    def self.active_client
+      Thread.current[:captain_client] || default_client
+    end
+
+    def self.default_client
+      Thread.current[:captain_default_client] ||= CaptainClient.new(default_conn)
+    end
+
+    def self.default_conn
+      Thread.current[:captain_default_conn] ||= begin
+        HTTP.headers("X-API-KEY" => TheCaptain.api_key)
+            .accept("application/json")
+            .timeout(
+              read:    TheCaptain.read_timeout,
+              write:   TheCaptain.write_timeout,
+              connect: TheCaptain.connect_timeout,
+            )
+      end
+    end
+
+    def initialize(conn = nil)
+      @conn        = conn || self.class.default_conn
+      @captain_url = TheCaptain.api_url
+    end
+
+    def request(verb_method, path, params = {})
+      verify_api_key_header!
+      verify_request_method!(verb_method)
+      capture_response! { send(verb_method.to_sym, destination_url(path), params) }
+      raise_status_error! unless @response.status.success?
+      self
+    end
+
+    def decode_response
+      raise Error::ClientError.missing_response_object unless @response
+      Response::CaptainVessel.new(@response)
+    end
+
+    protected
+
+    def capture_response!(retry_count = TheCaptain.retry_attempts)
+      @response = yield
+    rescue StandardError
+      retry_count ||= 0
+      (retry_count -= 1).positive? ? retry : raise
+    end
+
+    def get(url, params = {})
+      @conn.get(url, params: params)
+    end
+
+    def post(url, params = {})
+      @conn.post(url, json: params)
+    end
+
+    private
+
+    def raise_status_error!
+      return unless TheCaptain.raise_http_errors?
+
+      case @response.status.code
+      when 401
+        raise Error::APIAuthorizationError.new("Authorization Error", @response)
+      when 500..502
+        raise Error::APIConnectionError.new("Problem with server response", @response)
+      else
+        false
+      end
+    end
+
+    def verify_api_key_header!
+      api_key = @conn.default_options.headers["X-API-KEY"]
+      return unless api_key.nil? || api_key.empty?
+      raise Error::ClientAuthenticationError.no_key_provided
+    end
+
+    def verify_request_method!(verb_method)
+      raise Error::ClientInvalidRequestError unless REQUEST_METHODS.include?(verb_method.to_sym)
+    end
+
+    def destination_url(path)
+      path = path.start_with?("/") || path.empty? ? path : "/#{path}"
+      "#{@captain_url}#{path}"
+    end
+  end
+end

data/lib/the_captain/collect.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class Collect < APIResource
+    api_paths base: "collect"
+
+    def self.submit(**params)
+      request(:post, params: params)
+    end
+  end
+end

data/lib/the_captain/content.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class Content < APIResource
+    api_paths base:            "content/%<resource_id>s",
+              lists:           "content/%<resource_id>s/related/lists",
+              payments:        "content/%<resource_id>s/related/payments",
+              credit_cards:    "content/%<resource_id>s/related/credit_cards",
+              email_addresses: "content/%<resource_id>s/related/email_addresses",
+              ip_addresses:    "content/%<resource_id>s/related/ip_addresses"
+
+    define_get_path_methods!
+  end
+end

data/lib/the_captain/credit_card.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class CreditCard < APIResource
+    api_paths base:            "credit_cards/%<resource_id>s",
+              lists:           "credit_cards/%<resource_id>s/related/lists",
+              payments:        "credit_cards/%<resource_id>s/related/payments",
+              content:         "credit_cards/%<resource_id>s/related/content",
+              ip_addresses:    "credit_cards/%<resource_id>s/related/ip_addresses",
+              email_addresses: "credit_cards/%<resource_id>s/related/email_addresses"
+
+    define_get_path_methods!
+  end
+end

data/lib/the_captain/email_address.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class EmailAddress < APIResource
+    api_paths base:            "email_addresses/%<resource_id>s",
+              lists:           "email_addresses/%<resource_id>s/related/lists",
+              payments:        "email_addresses/%<resource_id>s/related/payments",
+              content:         "email_addresses/%<resource_id>s/related/content",
+              credit_cards:    "email_addresses/%<resource_id>s/related/credit_cards"
+
+    define_get_path_methods!
+  end
+end

data/lib/the_captain/error/exceptions.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "the_captain/error/standard_exception"
+
+module TheCaptain
+  module Error
+    class APIAuthorizationError < StandardException; end
+    class APIConnectionError < StandardException; end
+    class APIInvalidRequestError < StandardException; end
+
+    class ClientInvalidRequestError < StandardException; end
+    class ClientInvalidResourceError < StandardException; end
+
+    class ClientError < StandardException
+      def self.client_error(class_name, message)
+        new("It looks like our client raised an #{class_name} error with message:  #{message}")
+      end
+
+      def self.missing_response_object
+        new("No response was provided prior to decoding."\
+            "Ensure that you make a request before attempting to decode the returning messages.")
+      end
+    end
+
+    class ClientAuthenticationError < StandardException
+      def self.no_key_provided
+        new("No API key provided. " \
+	        'Set your API key using "TheCaptain.api_key = <API-KEY>". ' \
+	        "See https://thecaptain.elevatorup.com for details, or " \
+	        "email support@thecaptain.elevatorup.com if you have any questions.")
+      end
+    end
+  end
+end

data/lib/the_captain/error/standard_exception.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  module Error
+    class StandardException < StandardError
+      attr_reader :message, :http_status, :http_body, :http_headers
+
+      def initialize(message = "", http_response = nil)
+        @message = message
+
+        if http_response
+          @http_headers = http_response.headers
+          @http_status  = "#{http_response.status.code} => #{http_response.status.reason}"
+          @http_body    = http_response.to_s
+        end
+      end
+
+      def to_s
+        out_message = message
+        out_message += "\n(Status: #{http_status})"            unless http_status.nil?
+        out_message += "\nRaw request body: #{http_body}"      unless http_body.nil?
+        out_message += "\nResponse Headers: #{http_headers}\n" unless http_headers.nil?
+        out_message
+      end
+    end
+  end
+end

data/lib/the_captain/ip_address.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class IPAddress < APIResource
+    api_paths base:            "ip_addresses/%<resource_id>s",
+              lists:           "ip_addresses/%<resource_id>s/related/lists",
+              payments:        "ip_addresses/%<resource_id>s/related/payments",
+              content:         "ip_addresses/%<resource_id>s/related/content",
+              credit_cards:    "ip_addresses/%<resource_id>s/related/credit_cards",
+              email_addresses: "ip_addresses/%<resource_id>s/related/email_addresses"
+
+    define_get_path_methods!
+  end
+end

data/lib/the_captain/response/captain_object.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  module Response
+    class CaptainObject < ::OpenStruct
+      def method_missing(method_name, *args, &blk)
+        prefixed_method = method_name.to_s.chomp!("?")
+        prefixed_method ? @table.key?(prefixed_method.to_sym) : super
+      end
+
+      def respond_to_missing?(method_name, include_all)
+        method_name.to_s.end_with?("?") || super
+      end
+    end
+  end
+end

data/lib/the_captain/response/captain_vessel.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  module Response
+    class CaptainVessel
+      extend Forwardable
+      attr_reader :raw_response, :data, :status
+
+      def_delegators :@data, :dig, :method_missing
+
+      def initialize(captain_response)
+        raise Error::ClientInvalidResourceError unless captain_response.is_a?(HTTP::Response)
+        @raw_response = captain_response
+        @status       = @raw_response.status
+        @data         = Oj.sc_parse(CaptainObjectParser.new, @raw_response.to_s).freeze
+        freeze
+      end
+
+      def valid?
+        @status.success?
+      end
+
+      def invalid?
+        !valid?
+      end
+
+      def inspect
+        "#<#{self.class}:0x#{object_id.to_s(16)}> @status=#{@status.inspect} @data=#{@data.inspect}"
+      end
+      alias to_s inspect
+
+      class CaptainObjectParser < ::Oj::ScHandler
+        # OJ callback when a hash is initialized.
+        def hash_start
+          CaptainObject.new
+        end
+
+        # OJ callback when a Hash's key requires transformation.
+        def hash_key(key)
+          key.downcase
+        end
+
+        # OJ callback when a hash is setting a new key value.
+        def hash_set(hash, key, value)
+          hash[key] = value.freeze
+        end
+
+        # OJ callback when an Array is initialized.
+        def array_start
+          []
+        end
+
+        # OJ callback when an Array is being appended to.
+        def array_append(array, value)
+          array << value.freeze
+        end
+      end
+    end
+  end
+end

data/lib/the_captain/user.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  class User < APIResource
+    api_paths base:            "/users/%<resource_id>s",
+              payments:        "/users/%<resource_id>s/related/payments",
+              content:         "/users/%<resource_id>s/related/content",
+              ip_addresses:    "/users/%<resource_id>s/related/ip_addresses",
+              credit_cards:    "/users/%<resource_id>s/related/credit_cards",
+              email_addresses: "/users/%<resource_id>s/related/email_addresses"
+
+    define_get_path_methods!
+  end
+end

data/lib/the_captain/utility/configuration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  module Utility
+    class Configuration
+      attr_accessor :api_url, :api_key, :retry_attempts, :raise_http_errors
+
+      def initialize
+        @api_key           = ENV.fetch("CAPTAIN_API_KEY", "")
+        @api_url           = ENV.fetch("CAPTAIN_API_URL", "https://api.trustcaptain.com/v3")
+        @retry_attempts    = 0
+        @raise_http_errors = false
+      end
+
+      def to_h
+        {
+          api_key:           api_key,
+          api_url:           api_url,
+          api_version:       api_version,
+          retry_attempts:    retry_attempts,
+          raise_http_errors: raise_http_errors,
+        }.freeze
+      end
+    end
+  end
+end

data/lib/the_captain/utility/helper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "cgi/util"
+
+module TheCaptain
+  module Utility
+    module Helper
+      module_function
+
+      def normalize_params(params)
+        symbolize_names(params)
+      end
+
+      # Formats the destination path
+      # Ex: normalize_path("/foo/%<resource_id>s/bar", 101) #=> "/foo/101/bar"
+      #     normalize_path("/foo/%<resource_id>s/bar", "user@example.com") #=> "/foo/user%40example.com/bar"
+      def normalize_path(api_path, resource_id)
+        return api_path unless resource_id
+        format(api_path, resource_id: CGI.escape(resource_id))
+      end
+
+      # Recursively traverses a Hash table to ensure keys are symbolized.
+      # A necessary evil to ensure data is handled correctly throughout the library processing.
+      def symbolize_names(object)
+        case object
+        when Hash
+          {}.tap do |new_hash|
+            object.each do |key, value|
+              key = begin
+                key.to_sym
+              rescue StandardError
+                key
+              end
+              new_hash[key] = symbolize_names(value)
+            end
+          end
+        when Array
+          object.map { |value| symbolize_names(value) }
+        else
+          object
+        end.freeze
+      end
+    end
+  end
+end

data/lib/the_captain/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TheCaptain
+  VERSION = "3.0.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: the_captain
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- George J Protacio-Karaszi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: The Captain will tell, talk, and taddle on those pesky fraudulent scalliwags.
+email:
+- george@elevatorup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/the_captain.rb
+- lib/the_captain/api_resource.rb
+- lib/the_captain/captain_client.rb
+- lib/the_captain/collect.rb
+- lib/the_captain/content.rb
+- lib/the_captain/credit_card.rb
+- lib/the_captain/email_address.rb
+- lib/the_captain/error/exceptions.rb
+- lib/the_captain/error/standard_exception.rb
+- lib/the_captain/ip_address.rb
+- lib/the_captain/response/captain_object.rb
+- lib/the_captain/response/captain_vessel.rb
+- lib/the_captain/user.rb
+- lib/the_captain/utility/configuration.rb
+- lib/the_captain/utility/helper.rb
+- lib/the_captain/version.rb
+homepage: https://github.com/VianetManagement/the-captain-ruby
+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.7
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for the The Captain API
+test_files: []