hawkei 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 519333f18c5cd49c3f527ccdcd32aab016ed0cab420b34fd6beea68846894da0
+  data.tar.gz: 3ab8e90d94b056ea8c9e9193de8d43111263628e0c0435d4f12fb897af0e7831
+SHA512:
+  metadata.gz: da169662f01c97bfadb06c1058803e6f63e9036301c94b7bf90a6728a24cc2c7b29368b97f706b791989554b3b916822d404c169560cf64e3f30041d3ad8e9ea
+  data.tar.gz: ea4d6c964a1620361e7cfcbd5692a88d5f20cbb72494d13e637a08534d077822633517072c34240ea41da72d857fa9f5057030e525a4ed0643bae704306e647b

data/.gitignore

@@ -0,0 +1,4 @@
+doc
+*.gem
+Gemfile.lock
+todo.md

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,48 @@
+Metrics/AbcSize:
+  Max: 24
+Metrics/LineLength:
+  Max: 120
+Metrics/ClassLength:
+  CountComments: false
+  Max: 120
+Metrics/MethodLength:
+  CountComments: false
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 7
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MissingRespondToMissing:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+Style/TrailingCommaInArguments:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Bundler/DuplicatedGem:
+  Enabled: false
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - 'spec/**/*'
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+    - tmp/**/*
+    - spec/**/*

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.3

data/.travis.yml

@@ -0,0 +1,11 @@
+cache: bundler
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+script:
+  - make test
+  - make lint

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+if RUBY_VERSION > '2.1.0' && RUBY_VERSION < '2.2.2'
+  gem 'sidekiq', '>= 2.13.0', '< 5.0'
+else
+  gem 'sidekiq', '>= 2.13.0'
+end
+
+gem 'rack'
+gem 'rails'
+
+gemspec

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019- hawkei-io Pty Ltd. (https://hawkei.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Makefile

@@ -0,0 +1,9 @@
+export FORCE_COLOR = true
+
+.PHONY: lint test
+
+test:
+	@bundle exec rspec spec/
+
+lint:
+	@bundle exec rubocop .

data/README.md

@@ -0,0 +1,17 @@
+# Hawkei
+
+[Hawkei](https://hawkei.io) Ruby library
+
+Interact easily with our API using our Ruby library.
+
+[![Build Status](https://travis-ci.org/hawkei-io/hawkei-ruby.svg?branch=master)](https://travis-ci.org/hawkei-io/hawkei-ruby)
+
+## Setup
+
+- [Start by creating an account](https://app.hawkei.io/registration)
+- Follow the [Quick Start Guide](https://hawkei.atlassian.net/wiki/spaces/HAW/pages/4915206/Getting+started+in+4+steps) to get set up
+- Use our [Ruby Library](https://hawkei.atlassian.net/wiki/spaces/HAW/pages/7110690/Ruby) to install and configure Hawkei for your platform.
+
+## Documentation & Usage
+
+Documentation is available at [hawkei.atlassian.net/wiki/spaces/HAW/pages/7110690/Ruby](https://hawkei.atlassian.net/wiki/spaces/HAW/pages/7110690/Ruby)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/hawkei.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hawkei/version'
+require 'hawkei/library_name'
+
+Gem::Specification.new do |s|
+  s.name          = Hawkei::LIBRARY_NAME
+  s.version       = Hawkei::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Hawkei']
+  s.email         = ['support@hawkei.io']
+  s.homepage      = 'https://github.com/hawkei-io/hawkei-ruby'
+  s.summary       = 'Hawkei ruby integration'
+  s.description   = 'Hawkei ruby integration'
+
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+
+  s.add_dependency 'concurrent-ruby', '~> 1.1.3'
+
+  s.add_development_dependency 'faker', '~> 1.9.1'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '>= 0.9.0'
+  s.add_development_dependency 'rspec', '~> 3.8'
+  s.add_development_dependency 'rubocop', '= 0.61.1'
+end

data/lib/hawkei/api_operation/delete.rb

@@ -0,0 +1,38 @@
+module Hawkei
+  class APIOperation
+    ##
+    # == Delete a resource for the API
+    #
+    module Delete
+      module ClassMethods
+        ##
+        # Delete an API Resource
+        #
+        # @param [String] id for the request
+        # @param [Hash] Additional options for the request
+        #
+        # @return [Hawkei::Object] response from the API
+        def delete(id, options = {})
+          response = request(:delete, "#{resource_path}/#{id}", options)
+          initialize_from(response)
+        end
+      end
+
+      ##
+      # Delete an API Resources
+      #
+      # @param [Hash] Additional options for the request
+      #
+      # @return [Hawkei::Object] response from the API
+      def destroy(options = {})
+        response = request(:delete, "#{resource_path}/#{id}", {}, options)
+        update_from(response)
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/hawkei/api_operation/save.rb

@@ -0,0 +1,57 @@
+module Hawkei
+  class APIOperation
+    ##
+    # == Save (create or update) a resource for the API
+    #
+    module Save
+      module ClassMethods
+        ##
+        # Create an API Resource and validate the params for the API.
+        #
+        # @param [Hash] params for the request
+        # @param [Hash] Additional options for the request
+        #
+        # @return [Hawkei::Object] response from the API
+        def create(params = {}, options = {})
+          response = request(:post, resource_path, params, options)
+          initialize_from(response)
+        end
+
+        ##
+        # Update an API Resource and validate params for the API
+        #
+        # @param [String] id for the request
+        # @param [Hash] params for the request
+        # @param [Hash] Additional options for the request
+        #
+        # @return [Hawkei::Object] response from the API
+        def update(id, params = {}, options = {})
+          response = request(:put, "#{resource_path}/#{id}", params, options)
+          initialize_from(response)
+        end
+
+      end
+
+      ##
+      # Create or Update an API Resource
+      #
+      # @param [Hash] params for the request
+      # @param [Hash] Additional options for the request
+      #
+      # @return [Hawkei::Object] response from the API
+      def save(params = {}, options = {})
+        path   = singleton_methods.include?(:id) ? "#{resource_path}/#{id}" : resource_path
+        method = singleton_methods.include?(:id) ? :put : :post
+
+        response = request(method, path, to_hash.merge(params), options)
+        update_from(response)
+      end
+      alias update save
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+    end
+  end
+end

data/lib/hawkei/api_resource.rb

@@ -0,0 +1,130 @@
+module Hawkei
+  ##
+  # == Hawkei \API \Resource
+  #
+  # Define the API requests methods
+  class APIResource < HawkeiObject
+    ##
+    # @return [String] resource name
+    def resource_name
+      self.class.resource_name
+    end
+
+    ##
+    # @return [String] resource path
+    def resource_path(path = nil)
+      self.class.resource_path(path)
+    end
+
+    ##
+    # Send a request to the API
+    #
+    # @param [Symbol] method for the request
+    # @param [String] endpoint for the request
+    # @param [Hash] options
+    # @param [Hash] Payload
+    #
+    # @return [Hash] response
+    # @raise [Hawkei::RequestError] if the request is invalid
+    def request(method, resource_path, payload = {}, options = {})
+      self.class.request(method, resource_path, payload, options)
+    end
+
+    class << self
+
+      ##
+      # @return [String] resource path
+      def resource_path(path = nil)
+        "/api/#{configurations.api_version}/#{path || @resource_name || CGI.escape(resource_name)}"
+      end
+
+      ##
+      # @return [String] resource name
+      def resource_name
+        Util.underscore("#{class_name}s")
+      end
+
+      ##
+      # @return [String] the class name
+      def class_name
+        name.split('::')[-1]
+      end
+
+      ##
+      # Send a request to the API
+      #
+      # @param [Symbol] method for the request
+      # @param [String] endpoint for the request
+      # @param [Hash] options
+      # @param [Hash] Payload
+      #
+      # @return [Hash] response
+      # @raise [Hawkei::RequestError] if the request is invalid
+      # rubocop:disable Metrics/AbcSize
+      def request(method, path, payload = {}, options = {})
+        payload[:sent_at] = Time.now.utc.iso8601(3)
+        payload    = Util.deep_obfuscate_value(payload, configurations.obfuscated_fields)
+        url_params = Util.encode_parameters(payload) if method == :get
+        uri        = build_endpoint_url(path, url_params)
+
+        request_options = Util.compact(
+          method: method,
+          url: uri.to_s,
+          payload: payload.to_json,
+          proxy: configurations.proxy_url,
+          use_ssl: configurations.http_secure
+        ).merge(headers(options)).merge(options)
+
+        Request.execute(request_options).body
+      rescue Hawkei::RequestError => error
+        return error.http_body if error.http_status == 422
+
+        raise
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def build_endpoint_url(path, params = nil)
+        host, port = configurations.api_host.split(':')
+        port       = port.to_i if port
+
+        url_params = Util.compact(
+          host: host,
+          path: path,
+          port: port,
+          query: params
+        )
+
+        return URI::HTTPS.build(url_params) if configurations.http_secure
+
+        URI::HTTP.build(url_params)
+      end
+
+      def ssl_options
+        return {} unless configurations.http_secure
+
+        {
+          verify_mode: OpenSSL::SSL::VERIFY_PEER,
+        }
+      end
+
+      def headers(options)
+        {
+          headers: {
+            accept: 'application/json',
+            content_type: 'application/json',
+            x_api_key: options.delete(:api_key) || configurations.api_key,
+            x_space_name: options.delete(:space_name) || configurations.space_name,
+            x_environment_name: options.delete(:environment_name) || configurations.environment_name,
+          },
+        }
+      end
+
+      def configurations
+        Hawkei.configurations
+      end
+
+    end
+  end
+end

data/lib/hawkei/batch.rb

@@ -0,0 +1,18 @@
+module Hawkei
+  ##
+  # == Hawkei \Batch
+  #
+  # Accepted Methods:
+  #
+  # * create
+  #
+  # @example: Usage
+  #
+  #   request = Hawkei::Batch.create(...) #=> #<Hawkei::Response...>
+  #
+  class Batch < APIResource
+    @resource_name = 'batches'
+
+    include Hawkei::APIOperation::Save
+  end
+end

data/lib/hawkei/config.rb

@@ -0,0 +1,123 @@
+module Hawkei
+  ##
+  # == Hawkei \Config
+  #
+  # Represent the Hawkei configuration for the API
+  class Config
+
+    DEFAULT_OBFUSCATED_FIELDS = %w[
+      password
+      password_confirmation
+      secret
+      secret_token
+      authenticity_token
+      token
+      api_key
+      access_token
+      credit_card_number
+      cvv
+      ccv
+    ].freeze
+
+    ##
+    # @return [String] API account token
+    attr_accessor :api_key
+
+    ##
+    # @return [String] API space name
+    attr_accessor :space_name
+
+    ##
+    # @return [String] API environment name
+    attr_accessor :environment_name
+
+    ##
+    # @return [String] API host
+    attr_accessor :api_host
+
+    ##
+    # @return [String] API version
+    attr_accessor :api_version
+
+    ##
+    # @return [String] proxy url
+    attr_accessor :proxy_url
+
+    ##
+    # @return [Boolean] http secure
+    attr_accessor :http_secure
+
+    ##
+    # @return [Boolean] service is enable
+    attr_accessor :enabled
+
+    ##
+    # @return [Array[String]] fields to obfuscate
+    attr_accessor :obfuscated_fields
+
+    ##
+    # @return [Hash] metadata to be attach to the payload
+    attr_accessor :metadata
+
+    ##
+    # @return [Boolean] enable the logger
+    attr_accessor :log
+
+    ##
+    # @return [Logger] logger
+    attr_accessor :logger
+
+    ##
+    # @return [String] domain
+    attr_accessor :domain
+
+    ##
+    # @param [Hash{Symbol=>Object}]
+    # Initialize and validate the configuration
+    def initialize(options = {})
+      self.api_key = options[:api_key]
+      self.space_name = options[:space_name]
+      self.environment_name = options[:environment_name]
+      self.api_host = options[:api_host] || 'api.hawkei.io'
+      self.api_version = options[:api_version] || 'v1'
+      self.proxy_url = options[:proxy_url]
+      self.http_secure = options[:http_secure] || true
+      self.enabled = options[:enabled] || true
+      self.obfuscated_fields = options[:obfuscated_fields] || []
+      self.metadata = options[:metadata]
+      self.log = options[:log] || true
+      self.logger = FormatedLogger.build(options[:logger])
+      self.domain = options[:domain]
+    end
+
+    ##
+    # validate the configuration
+    # Raise when configuration are not valid
+    # @return [Boolean] true
+    def valid!
+      format!
+
+      %i[api_key space_name environment_name api_host api_version].each do |field|
+        validate_presence(field)
+      end
+
+      true
+    end
+
+    private
+
+    ##
+    # Format configuration fields
+    #
+    # * Set obfuscated_fields to string
+    #
+    def format!
+      self.obfuscated_fields = (obfuscated_fields.map(&:to_s) + DEFAULT_OBFUSCATED_FIELDS).uniq
+    end
+
+    def validate_presence(field)
+      raise Hawkei::ConfigurationError, "#{field} can't be blank" if send(field).nil? || send(field).empty?
+    end
+
+  end
+end

data/lib/hawkei/errors.rb

@@ -0,0 +1,41 @@
+module Hawkei
+
+  ##
+  # Configuration Error
+  class ConfigurationError < StandardError; end
+
+  ##
+  # Missing Implementation Error
+  class MissingImplementation < StandardError; end
+
+  ##
+  # Request to API Error
+  class RequestError < StandardError; end
+
+  ##
+  # Method unknown for the request
+  class UnknownRequestMethod < StandardError; end
+
+  ##
+  # Request to API Error
+  class RequestError < StandardError
+
+    attr_reader :http_body
+    attr_reader :http_status
+    attr_reader :http_status_type
+    attr_reader :http_message
+
+    def initialize(response, message: nil)
+      @http_status      = response.code.to_i
+      @http_status_type = response.code_type
+      @http_body        = response.body
+      @http_message     = message || response.message
+    end
+
+    def to_s
+      "Status #{http_status}: #{http_message}"
+    end
+
+  end
+
+end

data/lib/hawkei/formated_logger.rb

@@ -0,0 +1,45 @@
+module Hawkei
+  ##
+  # Display formated log
+  class FormatedLogger
+
+    class << self
+
+      def build(logger)
+        return new(logger) if logger
+        return new(Rails.logger) if defined?(Rails)
+
+        new(::Logger.new(STDOUT))
+      end
+
+    end
+
+    attr_reader :logger
+
+    PREFIX = '[Hawkei]'.freeze
+    METHODS = %i[debug info warn error].freeze
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    METHODS.each do |method|
+      define_method(method) do |message|
+        log(method, message)
+      end
+    end
+
+    private
+
+    def log(type, message)
+      return unless configurations.log
+
+      logger.send(type, "#{PREFIX} #{message}")
+    end
+
+    def configurations
+      Hawkei.configurations
+    end
+
+  end
+end