finapps 1.0.8 → 2.0.2

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finapps
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 2.0.2
 platform: ruby
 authors:
 - Erich Quintero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,7 +59,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,7 +69,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: rash
   requirement: !ruby/object:Gem::Requirement
@@ -116,100 +116,100 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.1.2
+        version: 11.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 11.1.2
+        version: 11.2.2
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '2.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.24.2
+        version: 1.4.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '1.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.24.2
+        version: 1.4.7
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 0.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.11'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.7
+        version: 0.11.2
 description: A simple library for communicating with the FinApps REST API.
 email:
 - erich@financialapps.com
@@ -221,6 +221,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -230,42 +231,34 @@ files:
 - Rakefile
 - finapps.gemspec
 - lib/finapps.rb
-- lib/finapps/middleware/api_token.rb
-- lib/finapps/middleware/raise_http_exceptions.rb
-- lib/finapps/middleware/response_logger.rb
-- lib/finapps/rest/alert.rb
-- lib/finapps/rest/alert_definition.rb
-- lib/finapps/rest/alert_preferences.rb
-- lib/finapps/rest/alert_settings.rb
-- lib/finapps/rest/budget_calculation.rb
-- lib/finapps/rest/budget_models.rb
-- lib/finapps/rest/budgets.rb
-- lib/finapps/rest/cashflows.rb
-- lib/finapps/rest/categories.rb
+- lib/finapps/core_extensions/hash/compact.rb
+- lib/finapps/core_extensions/integerable.rb
+- lib/finapps/core_extensions/object/blank.rb
+- lib/finapps/error.rb
+- lib/finapps/hash_constructable.rb
+- lib/finapps/middleware/raise_error.rb
+- lib/finapps/middleware/tenant_authentication.rb
+- lib/finapps/rest/base_client.rb
 - lib/finapps/rest/client.rb
+- lib/finapps/rest/configuration.rb
 - lib/finapps/rest/connection.rb
 - lib/finapps/rest/defaults.rb
-- lib/finapps/rest/errors.rb
-- lib/finapps/rest/institutions.rb
-- lib/finapps/rest/relevance/rulesets.rb
 - lib/finapps/rest/resource.rb
 - lib/finapps/rest/resources.rb
-- lib/finapps/rest/transactions.rb
-- lib/finapps/rest/user_institutions.rb
 - lib/finapps/rest/users.rb
-- lib/finapps/utils/logging.rb
-- lib/finapps/utils/utils.rb
+- lib/finapps/utils/loggeable.rb
 - lib/finapps/version.rb
 - lib/tasks/releaser.rake
-- spec/middleware/api_token_spec.rb
+- spec/middleware/tenant_authentication_spec.rb
+- spec/rest/base_client_spec.rb
 - spec/rest/client_spec.rb
-- spec/rest/connection_spec.rb
-- spec/rest/users_spec.rb
+- spec/rest/configuration_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_api.rb
+- spec/support/fixtures/error.json
+- spec/support/fixtures/relevance_ruleset_names.json
 - spec/support/fixtures/user.json
-- spec/utils/logging_spec.rb
-homepage: http://github.com/finapps/finapps-ruby
+homepage: https://github.com/finapps/ruby-client
 licenses:
 - MIT
 metadata: {}
@@ -291,15 +284,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: FinApps REST API ruby client.
 test_files:
 - spec/spec_helper.rb
 - spec/support/fake_api.rb
-- spec/utils/logging_spec.rb
-- spec/middleware/api_token_spec.rb
-- spec/rest/connection_spec.rb
+- spec/middleware/tenant_authentication_spec.rb
 - spec/rest/client_spec.rb
-- spec/rest/users_spec.rb
+- spec/rest/base_client_spec.rb
+- spec/rest/configuration_spec.rb

data/lib/finapps/middleware/api_token.rb

@@ -1,26 +0,0 @@
-module FinApps
-  module Middleware
-
-    class ApiToken < Faraday::Middleware
-      include FinApps::Logging
-
-      def initialize(app, options={})
-        @app = app
-        @options = options
-      end
-
-      def call(env)
-        company_identifier = @options[:company_identifier].trim
-        raise FinApps::REST::MissingArgumentsError.new 'Missing argument: company_identifier.' if company_identifier.blank?
-
-        company_token = @options[:company_token].trim
-        raise FinApps::REST::MissingArgumentsError.new 'Missing argument: company_token.' if company_token.blank?
-
-        env[:request_headers]['X-FinApps-Token'] = "#{company_identifier}=#{company_token}"
-        @app.call(env)
-      end
-
-    end
-
-  end
-end

data/lib/finapps/middleware/raise_http_exceptions.rb

@@ -1,92 +0,0 @@
-module FinApps
-  module Middleware
-
-    class RaiseHttpExceptions < Faraday::Response::Middleware
-      include FinApps::Logging
-
-      CLIENT_ERROR_STATUSES = 400...600
-
-      def on_complete(env)
-
-        case env[:status]
-          when 400
-            raise FinApps::REST::BadRequest, response_values(env, 'The request could not be understood by the server due to malformed syntax.')
-          when 401
-            raise FinApps::REST::Unauthorized, response_values(env, 'The request requires user authentication.')
-          when 403
-            raise FinApps::REST::Forbidden, response_values(env, 'Forbidden.')
-          when 404
-            raise FinApps::REST::NotFound, response_values(env, 'Page not found.')
-          when 405
-            raise FinApps::REST::MethodNotAllowed, response_values(env, 'The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.')
-          when 406
-            raise FinApps::REST::NotAcceptable, response_values(env, 'The resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request')
-          when 407
-            raise Faraday::Error::ConnectionFailed, response_values(env, 'Proxy Authentication Required.')
-          when 409
-            raise FinApps::REST::Conflict, response_values(env, 'The request could not be completed due to a conflict with the current state of the resource.')
-
-          when 500
-            raise FinApps::REST::InternalServerError, response_values(env, 'Unexpected technical condition was encountered.')
-          when 502
-            raise FinApps::REST::BadGateway, response_values(env, 'The server returned an invalid or incomplete response.')
-          when 503
-            raise FinApps::REST::ServiceUnavailable, response_values(env, 'The server is currently unavailable.')
-          when 504
-            raise FinApps::REST::GatewayTimeout, response_values(env, 'Gateway Time-out')
-          when 505
-            raise FinApps::REST::VersionNotSupported, response_values(env, 'The Web server does not support the specified HTTP protocol version.')
-
-          when CLIENT_ERROR_STATUSES
-            raise FinApps::REST::Error, response_values(env, 'Unexpected error.')
-
-          else
-              # 200..206 Success codes
-              # all good!
-              logger.debug "##{__method__} => Status code: [#{env[:status]}]."
-        end
-
-      end
-
-      private
-
-      def error_messages(body)
-        error_array = Array.new
-
-        if body.present? && body.kind_of?(String)
-          begin
-            parsed = ::JSON.parse(body)
-            if parsed
-              parsed.each do |key, value|
-                value.each do |message|
-                  logger.debug "#{key} => #{message}"
-                  error_array.push message.to_s
-                end
-              end
-              logger.info "##{__method__} => Extracted errors: #{error_array.inspect}."
-            else
-              logger.info "##{__method__} => Cannot extract errors: unexpected error while parsing response."
-            end
-          rescue ::JSON::ParserError => e
-            logger.error "##{__method__} => Unable to parse JSON response."
-            logger.error e
-          end
-        end
-
-        error_array
-      end
-
-      def response_values(env, status_message = nil)
-        {
-            :status => env.status,
-            :status_message => status_message,
-            :headers => env.response_headers,
-            :body => env.body,
-            :error_messages => error_messages(env.body)
-        }
-      end
-
-    end
-
-  end
-end

data/lib/finapps/middleware/response_logger.rb

@@ -1,37 +0,0 @@
-module FinApps
-  module Middleware
-
-    class ResponseLogger < Faraday::Response::Middleware
-      include FinApps::Logging
-
-      def call(env)
-        logger.info "##{__method__} => ##{env.method} #{env.url.to_s}"
-        logger.debug "##{__method__} => Request Headers: #{dump_headers env.request_headers}"
-
-        super
-      end
-
-      def on_complete(env)
-        logger.info "##{__method__} => ##{env.method} #{env.url.to_s}"
-        logger.debug "##{__method__} => Response Headers: #{dump_headers env.response_headers}"
-        logger.info "##{__method__} => Response Body: #{env.body}" if env.body
-      end
-
-      private
-      def dump_headers(headers)
-        headers.map { |k, v| "  #{k}: #{filter_sensitive_header_values(k,v)}" }.to_s
-      end
-
-      def filter_sensitive_header_values(key, value)
-        case key
-          when 'X-FinApps-Token', 'Authorization'
-            '[REDACTED]'
-          else
-            value.inspect
-        end
-      end
-
-    end
-
-  end
-end

data/lib/finapps/rest/alert.rb

@@ -1,62 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class Alert < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # @return [Hash, Array<String>]
-      def list(page = 1, requested=100, sort='date', asc=false, read='all')
-
-        end_point = Defaults::END_POINTS[:alert_list]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':page', ERB::Util.url_encode(page)
-        path = path.sub ':requested', ERB::Util.url_encode(requested)
-        path = path.sub ':sort', ERB::Util.url_encode(sort)
-        path = path.sub ':asc', ERB::Util.url_encode(asc)
-        path = path.sub ':read', ERB::Util.url_encode(read)
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        return result, error_messages
-      end
-
-      # @return [Hash, Array<String>]
-      def update(alert_id, read=true)
-        raise MissingArgumentsError.new 'Missing argument: alert_id.' if alert_id.blank?
-        logger.debug "##{__method__} => alert_id: #{alert_id.inspect}"
-
-        raise MissingArgumentsError.new 'Missing argument: read.' if read.blank?
-        logger.debug "##{__method__} => read: #{read.inspect}"
-
-        end_point = Defaults::END_POINTS[:alert_update]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':alert_id', ERB::Util.url_encode(alert_id)
-        path = path.sub ':read', ERB::Util.url_encode(read)
-        logger.debug "##{__method__} => path: #{path}"
-
-        _, error_messages = client.send_request(path, :put)
-        error_messages
-      end
-
-      # @return [Hash, Array<String>]
-      def delete(alert_id)
-        raise MissingArgumentsError.new 'Missing argument: alert_id.' if alert_id.blank?
-        logger.debug "##{__method__} => alert_id: #{alert_id.inspect}"
-
-        end_point = Defaults::END_POINTS[:alert_delete]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':alert_id', ERB::Util.url_encode(alert_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        _, error_messages = client.send_request(path, :delete)
-        error_messages
-      end
-
-    end
-  end
-end

data/lib/finapps/rest/alert_definition.rb

@@ -1,40 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class AlertDefinition < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Returns a list of alert definitions for current tenant.
-      # @return [Hash, Array<String>]
-      def list
-        end_point = Defaults::END_POINTS[:alert_definition_list]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        return result, error_messages
-      end
-
-      # Shows a single alert definition matching the given alert name.
-      # @return [Hash, Array<String>]
-      def show(alert_name)
-        raise MissingArgumentsError.new 'Missing argument: alert_name.' if alert_name.blank?
-        logger.debug "##{__method__} => alert_name: #{alert_name}"
-
-        end_point = Defaults::END_POINTS[:alert_definition_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':alert_name', ERB::Util.url_encode(alert_name)
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        return result, error_messages
-      end
-
-    end
-  end
-end

data/lib/finapps/rest/alert_preferences.rb

@@ -1,40 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class AlertPreferences < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Shows alert preferences for a given user
-      # @return [Hash, Array<String>]
-      def show
-        end_point = Defaults::END_POINTS[:alert_preferences_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        return result, error_messages
-      end
-
-      # Updates alert preferences for a given user
-      # @return [Hash, Array<String>]
-      def update(params)
-        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
-        logger.debug "##{__method__} => params: #{params.inspect}"
-
-        end_point = Defaults::END_POINTS[:alert_preferences_update]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        _, error_messages = client.send_request(path, :put, params.compact)
-        error_messages
-      end
-
-    end
-  end
-end

data/lib/finapps/rest/alert_settings.rb

@@ -1,40 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class AlertSettings < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Shows alert settings for a given user.
-      # @return [Hash, Array<String>]
-      def show
-        end_point = Defaults::END_POINTS[:alert_settings_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        return result, error_messages
-      end
-
-      # Updates alert settings for a given user.
-      # @return [Hash, Array<String>]
-      def update(params)
-        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
-        logger.debug "##{__method__} => params: #{params.inspect}"
-
-        end_point = Defaults::END_POINTS[:alert_settings_update]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        _, error_messages = client.send_request(path, :put, params.compact)
-        error_messages
-      end
-
-    end
-  end
-end

data/lib/finapps/rest/budget_calculation.rb

@@ -1,45 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class BudgetCalculation < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Creates a new Budget Calculation for the given user, using a budget template
-      # matching budget_model_id and teh given income amount.
-      # @param [String] budget_model_id
-      # @param [Number] income
-      # @return [Array<Hash>, Array<String>]
-      def create(budget_model_id, income)
-        raise MissingArgumentsError.new 'Missing argument: budget_model_id.' if budget_model_id.blank?
-        logger.debug "##{__method__} => budget_model: #{budget_model_id}"
-        raise MissingArgumentsError.new 'Missing argument: income.' if income.blank?
-        logger.debug "##{__method__} => income: #{income}"
-
-        end_point = Defaults::END_POINTS[:budget_calculation_create]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub(':budget_model_id', ERB::Util.url_encode(budget_model_id)).sub(':income', ERB::Util.url_encode(income))
-        logger.debug "##{__method__} => path: #{path}"
-
-        budget_calculation, error_messages = client.send_request(path, :get)
-        return budget_calculation, error_messages
-      end
-
-      # Shows the Budget Calculation for the given user.
-      # @return [Array<Hash>, Array<String>]
-      def show
-        end_point = Defaults::END_POINTS[:budget_calculation_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        budget_calculation, error_messages = client.send_request(path, :get)
-        return budget_calculation, error_messages
-      end
-
-    end
-  end
-end

data/lib/finapps/rest/budget_models.rb

@@ -1,42 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class BudgetModels < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Lists all budget models.
-      # @return [Array<Hash>, Array<String>]
-      def list
-        path = Defaults::END_POINTS[:budget_models_list]
-        logger.debug "##{__method__} => path: #{path}"
-
-        budget_models, error_messages = client.send_request(path, :get)
-        return budget_models, error_messages
-      end
-
-      # Shows a budget model matching a given budget_model_id
-      # @param [Integer] budget_model_id
-      def show(budget_model_id)
-        raise MissingArgumentsError.new 'Missing argument: budget_model_id.' if budget_model_id.blank?
-        logger.debug "##{__method__} => budget_model_id: #{budget_model_id}"
-
-        end_point = Defaults::END_POINTS[:budget_models_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':budget_model_id', ERB::Util.url_encode(budget_model_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        budget_model, error_messages = client.send_request(path, :get) { |r| BudgetModel.new(r.body) }
-        return budget_model, error_messages
-      end
-
-    end
-
-    class BudgetModel < FinApps::REST::Resource
-      attr_accessor :_id, :name, :desc
-    end
-
-  end
-end