finapps_core 2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Financial Apps
+
+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/README.md

@@ -0,0 +1,21 @@
+
+FinApps Ruby-Client
+===================
+
+[![Build Status](https://travis-ci.org/finapps/ruby-client-core.svg?branch=master)](https://travis-ci.org/finapps/ruby-client-core)
+[![Code Climate](https://codeclimate.com/github/finapps/ruby-client-core/badges/gpa.svg)](https://codeclimate.com/github/finapps/ruby-client-core)
+[![Test Coverage](https://codeclimate.com/github/finapps/ruby-client-core/badges/coverage.svg)](https://codeclimate.com/github/finapps/ruby-client-core/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/finapps/ruby-client-core.svg)](https://gemnasium.com/github.com/finapps/ruby-client-core)
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://finapps.mit-license.org)
+
+Common library for Ruby clients.
+
+See Financial Apps API [Ruby Client][ruby-client].
+
+
+-------------------
+
+[FinancialApps.com][financialapps]
+
+[ruby-client]: https://github.com/finapps/ruby-client
+[financialapps]: https://financialapps.com

data/Rakefile

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+import './lib/tasks/releaser.rake'

data/finapps_core.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'finapps_core/version'
+Gem::Specification.new do |spec|
+  spec.name = 'finapps_core'
+  spec.version = FinAppsCore::VERSION
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ['Erich Quintero']
+  spec.email = ['erich@financialapps.com']
+
+  spec.summary = 'FinApps REST API ruby client - Core.'
+  spec.description = 'A simple library for communicating with the FinApps REST API. Core functionality.'
+  spec.homepage = 'https://github.com/finapps/ruby-client-core'
+  spec.licenses = ['MIT']
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
+  spec.test_files = Dir['spec/**/*.rb']
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday', '~> 0.9', '>= 0.9.2'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 0.10', '>= 0.10.0'
+  spec.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.2'
+  spec.add_runtime_dependency 'rash', '~> 0.4', '>= 0.4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11', '>= 1.11.2'
+  spec.add_development_dependency 'rake', '~> 11.2', '>= 11.2.2'
+  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
+  spec.add_development_dependency 'webmock', '~> 2.1', '>= 2.1.0'
+  spec.add_development_dependency 'sinatra', '~> 1.4', '>= 1.4.7'
+  spec.add_development_dependency 'simplecov', '~> 0.11', '>= 0.11.2'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6.0'
+  spec.add_development_dependency 'rubocop', '0.45.0'
+
+  spec.extra_rdoc_files = %w(README.md LICENSE)
+  spec.rdoc_options = %w(--line-numbers --inline-source --title finapps-ruby-core --main README.md)
+end

data/lib/core_extensions/object/blank.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+module ObjectExtensions
+  refine Object do
+    # An object is blank if it's false, empty, or a whitespace string.
+    # For example, +false+, '', '   ', +nil+, [], and {} are all blank.
+    #
+    # This simplifies
+    #
+    #   !address || address.empty?
+    #
+    # to
+    #
+    #   address.blank?
+    #
+    # @return [true, false]
+    def blank?
+      respond_to?(:empty?) ? !!empty? : !self
+    end
+
+    # An object is present if it's not blank.
+    #
+    # @return [true, false]
+    def present?
+      !blank?
+    end
+
+    # Returns the receiver if it's present otherwise returns +nil+.
+    # <tt>object.presence</tt> is equivalent to
+    #
+    #    object.present? ? object : nil
+    #
+    # For example, something like
+    #
+    #   state   = params[:state]   if params[:state].present?
+    #   country = params[:country] if params[:country].present?
+    #   region  = state || country || 'US'
+    #
+    # becomes
+    #
+    #   region = params[:state].presence || params[:country].presence || 'US'
+    #
+    # @return [Object]
+    def presence
+      self if present?
+    end
+  end
+end
+
+module StringExtensions
+  refine String do
+    BLANK_RE = /\A[[:space:]]*\z/
+
+    # A string is blank if it's empty or contains whitespaces only:
+    #
+    #   ''.blank?       # => true
+    #   '   '.blank?    # => true
+    #   "\t\n\r".blank? # => true
+    #   ' blah '.blank? # => false
+    #
+    # Unicode whitespace is supported:
+    #
+    #   "\u00a0".blank? # => true
+    #
+    # @return [true, false]
+    def blank?
+      match BLANK_RE
+    end
+  end
+end

data/lib/core_extensions/object/is_integer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module ObjectExtensions
+  refine Object do
+    def integer?
+      Integer(self)
+    rescue
+      false
+    end
+  end
+end

data/lib/core_extensions/string/json_to_hash.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module StringExtensions
+  refine String do
+    def json_to_hash
+      ::JSON.parse(self)
+    rescue ::JSON::ParserError
+      # logger.error "##{__method__} => Unable to parse JSON response."
+    end
+  end
+end

data/lib/finapps_core.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'finapps_core/version' unless defined?(FinAppsCore::VERSION)
+
+require 'faraday'
+require 'faraday_middleware'
+require 'typhoeus'
+require 'typhoeus/adapters/faraday'
+
+require 'core_extensions/object/blank'
+require 'core_extensions/object/is_integer'
+require 'core_extensions/string/json_to_hash'
+
+require 'finapps_core/utils/loggeable'
+require 'finapps_core/utils/parameter_filter'
+require 'finapps_core/error'
+
+require 'finapps_core/middleware/request/tenant_authentication'
+require 'finapps_core/middleware/request/no_encoding_basic_authentication'
+require 'finapps_core/middleware/request/accept_json'
+require 'finapps_core/middleware/request/user_agent'
+require 'finapps_core/middleware/response/raise_error'
+require 'finapps_core/middleware/middleware'
+
+require 'finapps_core/rest/defaults'
+require 'finapps_core/rest/resources'
+
+require 'finapps_core/rest/configuration'
+require 'finapps_core/rest/credentials'
+require 'finapps_core/rest/connection'
+require 'finapps_core/rest/base_client'

data/lib/finapps_core/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# Defines some errors to identify Exceptions within this gem
+module FinAppsCore # :nodoc:
+  # Base error class.
+  class Error < StandardError; end
+  # Raised for existing but invalid arguments.
+  class InvalidArgumentsError < Error; end
+  # Raised whenever a required argument is missing.
+  class MissingArgumentsError < Error; end
+
+  # Raised whenever there is a session timeout at the API.
+  class ApiSessionTimeoutError < Error; end
+
+  %i(InvalidArgumentsError MissingArgumentsError ApiSessionTimeoutError).each do |const|
+    Error.const_set(const, FinAppsCore.const_get(const))
+  end
+end

data/lib/finapps_core/middleware/middleware.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'faraday' unless defined? Faraday
+
+module FinAppsCore
+  module Middleware
+    autoload :AcceptJson, 'finapps_core/middleware/request/accept_json'
+    autoload :UserAgent, 'finapps_core/middleware/request/user_agent'
+    autoload :NoEncodingBasicAuthentication, 'finapps_core/middleware/request/no_encoding_basic_authentication'
+    autoload :TenantAuthentication, 'finapps_core/middleware/request/tenant_authentication'
+    autoload :CustomLogger, 'finapps_core/middleware/response/custom_logger'
+
+    if Faraday::Middleware.respond_to? :register_middleware
+      Faraday::Request.register_middleware \
+        accept_json: -> { AcceptJson },
+        user_agent: -> { UserAgent },
+        no_encoding_basic_authentication: -> { NoEncodingBasicAuthentication },
+        tenant_authentication: -> { TenantAuthentication }
+      Faraday::Response.register_middleware \
+        custom_logger: -> { CustomLogger }
+    end
+  end
+end

data/lib/finapps_core/middleware/request/accept_json.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module Middleware
+    # This middleware sets the Accept request-header field to specify JSON as acceptable media type for the response.
+    class AcceptJson < Faraday::Middleware
+      KEY = 'Accept' unless defined? KEY
+
+      def call(env)
+        env[:request_headers][KEY] = 'application/json'
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps_core/middleware/request/no_encoding_basic_authentication.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module Middleware
+    # Adds a custom header for basic authorization.
+    # If the value for this header already exists, it is not overriden.
+    class NoEncodingBasicAuthentication < Faraday::Middleware
+      KEY = 'Authorization' unless defined? KEY
+
+      def initialize(app, token)
+        super(app)
+        sanitized = token.to_s.strip.delete("\n")
+        @header_value = "Basic #{sanitized}"
+      end
+
+      def call(env)
+        env[:request_headers][KEY] ||= @header_value
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps_core/middleware/request/tenant_authentication.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module Middleware
+    # Adds a custom header for tenant level authorization.
+    # If the value for this header already exists, it is not overriden.
+    class TenantAuthentication < Faraday::Middleware
+      KEY = 'X-FinApps-Token' unless defined? KEY
+
+      def initialize(app, identifier, token)
+        super(app)
+        @header_value = "#{identifier.to_s.strip}=#{token.to_s.strip}"
+      end
+
+      def call(env)
+        env[:request_headers][KEY] ||= @header_value
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps_core/middleware/request/user_agent.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module Middleware
+    # This middleware sets the User-Agent request-header field to identify thei client.
+    class UserAgent < Faraday::Middleware
+      KEY = 'User-Agent' unless defined? KEY
+      RUBY = "#{RUBY_ENGINE}/#{RUBY_PLATFORM} #{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+
+      def call(env)
+        env[:request_headers][KEY] = "finapps-ruby/#{FinAppsCore::VERSION} (#{RUBY})"
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/finapps_core/middleware/response/custom_logger.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module Middleware
+    class CustomLogger < Faraday::Response::Middleware
+      extend Forwardable
+      include FinAppsCore::Utils::ParameterFilter
+
+      DEFAULT_OPTIONS = {bodies: false}.freeze
+
+      def initialize(app, logger=nil, options={})
+        super(app)
+        @logger = logger || begin
+          require 'logger'
+          ::Logger.new(STDOUT)
+        end
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+      def call(env)
+        debug "#{self.class.name}##{__method__} => URL: #{env.method.upcase} #{env.url}"
+        debug "#{self.class.name}##{__method__} => Request Headers: #{dump env.request_headers}"
+        super
+      end
+
+      def on_complete(env)
+        debug "#{self.class.name}##{__method__} => Response Headers: #{dump env.response_headers}"
+        debug "#{self.class.name}##{__method__} => Response Body: #{dump env.body}" if env.body
+      end
+
+      private
+
+      def dump(value)
+        skip_sensitive_data(value.is_a?(Array) ? value.to_h : value).to_json
+      end
+    end
+  end
+end

data/lib/finapps_core/middleware/response/raise_error.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module Middleware
+    class RaiseError < Faraday::Response::Middleware # :nodoc:
+      using ObjectExtensions
+      using StringExtensions
+
+      SUCCESS_STATUSES = 200..299
+      CONNECTION_FAILED_STATUS = 407
+      API_SESSION_TIMEOUT = 419
+
+      def on_complete(env)
+        return if SUCCESS_STATUSES.include?(env[:status])
+
+        if env[:status] == API_SESSION_TIMEOUT
+          raise(FinAppsCore::Error::ApiSessionTimeoutError, 'Api Session Timed out')
+        elsif env[:status] == CONNECTION_FAILED_STATUS
+          raise(Faraday::Error::ConnectionFailed, '407 "Proxy Authentication Required"')
+        else
+          raise(Faraday::Error::ClientError, response_values(env))
+        end
+      end
+
+      def response_values(env)
+        {
+          status:         env.status,
+          headers:        env.response_headers,
+          body:           env.body,
+          error_messages: error_messages(env.body)
+        }
+      end
+
+      private
+
+      def error_messages(body)
+        return nil if body.blank?
+        body = body.json_to_hash if body.is_a?(String)
+        has_message_key?(body) ? body['messages'] : nil
+      end
+
+      def has_message_key?(body)
+        body.respond_to?(:key?) && body.key?('messages')
+      end
+    end
+  end
+end

data/lib/finapps_core/rest/base_client.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+module FinAppsCore
+  module REST
+    # base client functionality
+    class BaseClient
+      include ::FinAppsCore::Utils::Loggeable
+      include ::FinAppsCore::REST::Connection
+      using ObjectExtensions
+      using StringExtensions
+
+      attr_reader :config
+
+      def initialize(options, logger=nil)
+        @config = FinAppsCore::REST::Configuration.new options
+        @logger = logger
+      end
+
+      # Returns an initialized Faraday connection object.
+      #
+      # @return Faraday::Connection.
+      def connection
+        @connection ||= faraday(config, logger)
+      end
+
+      # Performs HTTP GET, POST, UPDATE and DELETE requests.
+      # You shouldn't need to use this method directly, but it can be useful for debugging.
+      # Returns a hash obtained from parsing the JSON object in the response body.
+      #
+      # @param [String] path
+      # @param [String] method
+      # @param [Hash] params
+      # @return [Hash,Array<String>]
+      def send_request(path, method, params={})
+        raise FinAppsCore::MissingArgumentsError.new 'Missing argument: path.' if path.blank?
+        raise FinAppsCore::MissingArgumentsError.new 'Missing argument: method.' if method.blank?
+
+        response, error_messages = execute_request(path, method, params)
+        result = if empty?(response)
+                   nil
+                 else
+                   block_given? ? yield(response) : response.body
+                 end
+
+        [result, error_messages]
+      end
+
+      # Defines methods to perform HTTP GET, POST, PUT and DELETE requests.
+      # Returns a hash obtained from parsing the JSON object in the response body.
+      #
+      def method_missing(method_id, *arguments, &block)
+        if %i(get post put delete).include? method_id
+          connection.send(method_id) do |req|
+            req.url arguments.first
+            req.body = arguments[1] unless method_id == :get
+          end
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_sym, include_private=false)
+        [:get, :post, :put, :delete].include?(method_sym) ? true : super
+      end
+
+      private
+
+      def empty?(response)
+        response.blank? || (response.respond_to?(:body) && response.body.blank?)
+      end
+
+      def execute_request(path, method, params)
+        errors = []
+
+        begin
+          response = execute_method path, method, params
+
+        rescue FinAppsCore::ApiSessionTimeoutError => error
+          handle_error(error)
+        rescue FinAppsCore::InvalidArgumentsError => error
+          handle_error error
+        rescue FinAppsCore::MissingArgumentsError => error
+          handle_error error
+        rescue Faraday::Error::ConnectionFailed => error
+          handle_error error
+        rescue Faraday::Error::ClientError => error
+          errors = handle_client_error(error)
+        end
+
+        [response, errors]
+      end
+
+      def handle_error(error)
+        logger.fatal "#{self.class}##{__method__} => #{error}"
+        raise error
+      end
+
+      def handle_client_error(error)
+        logger.warn "#{self.class}##{__method__} => #{error.class.name}, #{error}"
+        error.response.present? && error.response[:error_messages] ? error.response[:error_messages] : [error.message]
+      end
+
+      def execute_method(path, method, params)
+        case method
+        when :get
+          get(path)
+        when :post
+          post(path, params)
+        when :put
+          put(path, params)
+        when :delete
+          delete(path, params)
+        else
+          raise FinAppsCore::InvalidArgumentsError.new "Method not supported: #{method}."
+        end
+      end
+    end
+  end
+end