finapps 1.0.8 → 2.0.2

data/lib/finapps/rest/budgets.rb

@@ -1,103 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class Budgets < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Shows budget results for a given date range.
-      # @param [Date] start_date
-      # @param [Date] end_date
-      # @return [Hash, Array<String>]
-      def show(start_date, end_date)
-        raise MissingArgumentsError.new 'Missing argument: start_date.' if start_date.blank?
-        logger.debug "##{__method__} => start_date: #{start_date}"
-        raise MissingArgumentsError.new 'Missing argument: end_date.' if end_date.blank?
-        logger.debug "##{__method__} => end_date: #{end_date}"
-
-        budget = Budget.new({:start_date => start_date, :end_date => end_date, :details => []})
-
-        end_point = Defaults::END_POINTS[:budget_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub(':start_date', ERB::Util.url_encode(start_date)).sub(':end_date', ERB::Util.url_encode(end_date))
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        if result.present? && error_messages.blank?
-          categories = result_categories(result)
-          raise 'Category results-set for budget is not an array.' unless categories.respond_to?(:each)
-
-          transactions = result_transactions(result)
-          categories.each { |category| budget.details << result_category_to_budget_detail(category, transactions) }
-        end
-
-        return budget, error_messages
-      end
-
-      # Updates the budget parameters.
-      # @param [Hash] params
-      # @return [Array<Hash>, Array<String>]
-      def update(params={})
-        raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
-
-        end_point = Defaults::END_POINTS[:budget_update]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        budget, error_messages = client.send_request(end_point, :put, params)
-        return budget, error_messages
-      end
-
-      private
-
-      def result_categories(result)
-        extract_array(result, 'cats')
-      end
-
-      def result_category_to_budget_detail(category, transactions)
-        raise 'Unable to locate category id for current category record.' unless category.key?('cat_id')
-        category_id = category['cat_id']
-
-        raise 'Unable to locate category name for current category record.' unless category.key?('name')
-        category_name = category['name']
-
-        raise 'Unable to locate budget_amount for current category record.' unless category.key?('budget_amount')
-        budget_amount = category['budget_amount']
-
-        BudgetDetail.new({:category_id => category_id,
-                          :category_name => category_name,
-                          :budget_amount => budget_amount,
-                          :expense_amount => expense_amount(category_id, transactions)})
-      end
-
-      def result_transactions(result)
-        extract_array(result, 'trans')
-      end
-
-      def extract_array(result, array_identifier)
-        array_container = result.find { |r| r.has_key?(array_identifier) }
-        array_container.present? ? array_container[array_identifier] : nil
-      end
-
-      def expense_amount(category_id, transactions = [])
-        amount = 0
-        if category_id.present? && transactions.respond_to?(:find)
-          transaction = transactions.find { |t| t['category_id'] == category_id }
-          amount = transaction['expense_amount'].to_f if transaction.present? && transaction.key?('expense_amount')
-        end
-        amount
-      end
-
-    end
-
-    class Budget < FinApps::REST::Resource
-      attr_accessor :start_date, :end_date, :details
-    end
-
-    class BudgetDetail < FinApps::REST::Resource
-      attr_accessor :category_id, :category_name, :budget_amount, :expense_amount
-    end
-
-  end
-end

data/lib/finapps/rest/cashflows.rb

@@ -1,87 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class Cashflows < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # @param [Date] start_date
-      # @param [Date] end_date
-      # @return [Hash, Array<String>]
-      def show(start_date, end_date)
-        raise MissingArgumentsError.new 'Missing argument: start_date.' if start_date.blank?
-        logger.debug "##{__method__} => start_date: #{start_date}"
-        raise MissingArgumentsError.new 'Missing argument: end_date.' if end_date.blank?
-        logger.debug "##{__method__} => end_date: #{end_date}"
-
-        cashflow = Cashflow.new({:start_date => start_date,
-                                 :end_date => end_date,
-                                 :total_income_amount => 0,
-                                 :total_expenses_amount => 0,
-                                 :total_leftover_amount => 0,
-                                 :details => []})
-
-        end_point = Defaults::END_POINTS[:cashflow_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub(':start_date', ERB::Util.url_encode(start_date)).sub(':end_date', ERB::Util.url_encode(end_date))
-        logger.debug "##{__method__} => path: #{path}"
-
-        result, error_messages = client.send_request(path, :get)
-        if result.present? && error_messages.blank?
-
-          summary = extract_value(result, 'summary')
-          raise 'Summary result-set for cashflow is not present.' if summary.nil?
-          raise 'Summary result-set for cashflow is not a hash.' unless summary.respond_to?(:key?)
-
-          raise 'Total income (inflow) value for cashflow is not present.' unless summary.key?('inflow')
-          cashflow.total_income_amount = summary['inflow']
-
-          raise 'Total expenses (outflow) value for cashflow is not present.' unless summary.key?('outflow')
-          cashflow.total_expenses_amount = summary['outflow']
-
-          raise 'Total left-over (diff) value for cashflow is not present.' unless summary.key?('diff')
-          cashflow.total_leftover_amount = summary['diff']
-
-          categories = extract_value(result, 'details')
-          raise 'Category results-set for cashflow is not an array.' unless categories.respond_to?(:each)
-
-          categories.each { |category| cashflow.details << result_category_to_cashflow_detail(category) }
-        end
-
-        return cashflow, error_messages
-      end
-
-      private
-
-      def extract_value(result, array_identifier)
-        array_container = result.find { |r| r.has_key?(array_identifier) }
-        array_container.present? ? array_container[array_identifier] : nil
-      end
-
-      def result_category_to_cashflow_detail(category)
-        raise 'Unable to locate category id for current category record.' unless category.key?('cat')
-        raise 'Unable to locate credits amount for current category record.' unless category.key?('inflow')
-        raise 'Unable to locate debits amount for current category record.' unless category.key?('outflow')
-        raise 'Unable to locate balance amount for current category record.' unless category.key?('diff')
-
-        CashflowDetail.new({:category_id => category['cat'],
-                            :credits => category['inflow'],
-                            :debits => category['outflow'],
-                            :balance => category['diff']})
-      end
-
-    end
-
-    class Cashflow < FinApps::REST::Resource
-      attr_accessor :start_date, :end_date,
-                    :total_income_amount, :total_expenses_amount, :total_leftover_amount, :details
-    end
-
-    class CashflowDetail < FinApps::REST::Resource
-      attr_accessor :category_id, :credits, :debits, :balance
-    end
-
-  end
-end

data/lib/finapps/rest/categories.rb

@@ -1,21 +0,0 @@
-module FinApps
-  module REST
-    class Categories < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # Lists all categories.
-      # @return [Array<Hash>, Array<String>]
-      def list
-        end_point = Defaults::END_POINTS[:categories_list]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        categories, error_messages = client.send_request(path, :get)
-        return categories, error_messages
-      end
-
-    end
-  end
-end

data/lib/finapps/rest/errors.rb

@@ -1,155 +0,0 @@
-module FinApps
-  module REST
-
-    # Custom error class for rescuing from all FinApps errors
-    class Error < StandardError;
-      attr_reader :response
-
-      def initialize(ex, response = nil)
-        @wrapped_exception = nil
-        @response = response
-
-        if ex.respond_to?(:backtrace)
-          super(ex.message)
-          @wrapped_exception = ex
-        elsif ex.respond_to?(:each_key)
-          super("the server responded with status #{ex[:status]}")
-          @response = ex
-        else
-          super(ex.to_s)
-        end
-      end
-
-      def backtrace
-        if @wrapped_exception
-          @wrapped_exception.backtrace
-        else
-          super
-        end
-      end
-
-      def inspect
-        %(#<#{self.class}>)
-      end
-
-      # @return [Array<String>]
-      def error_messages
-        message_array = []
-        body = response_body
-
-        if body.present? && body.kind_of?(String)
-          begin
-            parsed = ::JSON.parse(body)
-            if parsed
-              body = parsed
-            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
-
-        if body.present? && body.is_a?(Hash)
-
-          if body.key?(:error_messages)
-            message_array = body[:error_messages]
-          else
-            if body.key?('error_messages')
-              message_array = body['error_messages']
-            else
-              if body.key?(:messages)
-                message_array = body[:messages]
-              else
-                message_array = body['messages'] if body.key?('messages')
-              end
-            end
-          end
-
-        end
-
-        message_array
-      end
-
-      private
-      def response_body
-        body = nil
-        if @response.present?
-          @response.key?(:body) ? body = @response[:body] : body = @response
-        end
-
-        body
-      end
-
-    end
-
-    # Raised when required arguments are missing
-    class MissingArgumentsError < Error
-      def initialize(message)
-        super(message)
-      end
-    end
-
-    # Raised when invalid arguments are detected
-    class InvalidArgumentsError < Error
-      def initialize(message)
-        super(message)
-      end
-    end
-
-
-    # Client Error 4xx
-    # The 4xx class of status code is intended for cases in which the client seems to have erred.
-    class ClientError < Error
-    end
-
-    class BadRequest < ClientError
-    end
-
-    class Unauthorized < ClientError
-    end
-
-    class Forbidden < ClientError
-    end
-
-    class NotFound < ClientError
-    end
-
-    class MethodNotAllowed < ClientError
-    end
-
-    class NotAcceptable < ClientError
-    end
-
-    class ConnectionFailed < ClientError
-    end
-
-    class Conflict < ClientError
-    end
-
-
-    # Server Error 5xx
-    #
-    # Response status codes beginning with the digit "5" indicate cases in which the server is aware
-    # that it has erred or is incapable of performing the request.
-    class ServerError < Error
-    end
-
-    class InternalServerError < ServerError
-    end
-
-    class BadGateway < ServerError
-    end
-
-    class ServiceUnavailable < ServerError
-    end
-
-    class GatewayTimeout < ServerError
-    end
-
-    class VersionNotSupported < ServerError
-    end
-
-  end
-end

data/lib/finapps/rest/institutions.rb

@@ -1,47 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class Institutions < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # @param [String] term
-      # @return [Array<FinApps::REST::Institution>, Array<String>]
-      def search(term)
-        raise MissingArgumentsError.new 'Missing argument: term.' if term.blank?
-        logger.debug "##{__method__} => term: #{term}"
-
-        end_point = Defaults::END_POINTS[:institutions_list]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':search_term', ERB::Util.url_encode(term)
-        logger.debug "##{__method__} => path: #{path}"
-
-        institutions, error_messages = client.send_request(path, :get)
-        return institutions, error_messages
-      end
-
-      # @param [Integer] site_id
-      def form(site_id)
-        raise MissingArgumentsError.new 'Missing argument: site_id.' if site_id.blank?
-        logger.debug "##{__method__} => site_id: #{site_id}"
-
-        end_point = Defaults::END_POINTS[:institutions_form]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':site_id', ERB::Util.url_encode(site_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        institution, error_messages = client.send_request(path, :get) { |r| Institution.new(r.body) }
-        return institution, error_messages
-      end
-
-    end
-
-    class Institution < FinApps::REST::Resource
-      attr_accessor :login_form_html
-    end
-
-  end
-end

data/lib/finapps/rest/relevance/rulesets.rb

@@ -1,64 +0,0 @@
-module FinApps
-  module REST
-    module Relevance
-
-      require 'erb'
-
-      class Rulesets < FinApps::REST::Resources
-
-        def list
-
-
-          end_point = Defaults::END_POINTS[:relevance_rulesets_list]
-          logger.debug "##{__method__} => end_point: #{end_point}"
-
-          path = end_point
-          logger.debug "##{__method__} => path: #{path}"
-
-          results, error_messages = @client.send_request(path, :get)
-
-
-          return results, error_messages
-        end
-
-        def show(ruleset_name)
-
-
-          raise MissingArgumentsError.new 'Missing argument: ruleset_name.' if ruleset_name.blank?
-          logger.debug "##{__method__} => ruleset_name: #{ruleset_name}"
-
-          end_point = Defaults::END_POINTS[:relevance_rulesets_show]
-          logger.debug "##{__method__} => end_point: #{end_point}"
-
-          path = end_point.sub ':ruleset_name', ERB::Util.url_encode(ruleset_name)
-          logger.debug "##{__method__} => path: #{path}"
-
-          results, error_messages = @client.send_request(path, :get)
-
-
-          return results, error_messages
-        end
-
-        def run(params = {})
-
-
-          raise MissingArgumentsError.new 'Missing argument: params.' if params.blank?
-          logger.debug "##{__method__} => params: #{params.inspect}"
-
-          end_point = Defaults::END_POINTS[:relevance_rulesets_run]
-          logger.debug "##{__method__} => end_point: #{end_point}"
-
-          path = end_point
-          logger.debug "##{__method__} => path: #{path}"
-
-          results, error_messages = @client.send_request(path, :post, params)
-
-
-          return results, error_messages
-        end
-
-      end
-    end
-
-  end
-end

data/lib/finapps/rest/transactions.rb

@@ -1,45 +0,0 @@
-module FinApps
-  module REST
-
-    class Transactions < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      # @transaction_id [String]
-      # # @return [Hash, Array<String>]
-      def show(transaction_id)
-        end_point = Defaults::END_POINTS[:transactions_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':transaction_id', ERB::Util.url_encode(transaction_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        transaction, error_messages = client.send_request(path, :get)
-        return transaction, error_messages
-      end
-
-      # @param [Hash] params
-      # @return [Array<Hash>, Array<String>]
-      def search(params={})
-        end_point = Defaults::END_POINTS[:transactions_list]
-
-        path = end_point
-        logger.debug "##{__method__} => path: #{path}"
-
-        transactions, error_messages = client.send_request(path, :post, params.compact)
-        return transactions, error_messages
-      end
-
-      # @param [Hash] params
-      # @return [Array<Hash>, Array<String>]
-      def update(params={})
-        path = Defaults::END_POINTS[:transactions_update]
-        logger.debug "##{__method__} => path: #{path}"
-
-        _, error_messages = client.send_request(path, :put, params.compact)
-        error_messages
-      end
-
-    end
-
-  end
-end

data/lib/finapps/rest/user_institutions.rb

@@ -1,138 +0,0 @@
-module FinApps
-  module REST
-
-    require 'erb'
-
-    class UserInstitutions < FinApps::REST::Resources
-      include FinApps::REST::Defaults
-
-      def list
-        path = Defaults::END_POINTS[:user_institutions_list]
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institutions, error_messages = client.send_request(path, :get)
-        return user_institutions, error_messages
-      end
-
-      def add(site_id, parameters)
-
-        raise MissingArgumentsError.new 'Missing argument: site_id.' if site_id.blank?
-        logger.debug "##{__method__} => site_id: #{site_id}"
-
-        raise MissingArgumentsError.new 'Missing argument: parameters.' if parameters.blank?
-        logger.debug "##{__method__} => parameters: #{skip_sensitive_data parameters}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_add]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':site_id', ERB::Util.url_encode(site_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institution, error_messages = client.send_request(path, :post, :parameters => parameters)
-        return user_institution, error_messages
-      end
-
-      def show(user_institution_id)
-
-        raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
-        logger.debug "##{__method__} => user_institution_id: #{user_institution_id}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_show]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institution, error_messages = client.send_request(path, :get)
-        return user_institution, error_messages
-      end
-
-      def form(user_institution_id)
-        raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
-        logger.debug "##{__method__} => user_institution_id: #{user_institution_id}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_form]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institution, error_messages = client.send_request(path, :get)
-        return user_institution, error_messages
-      end
-
-      def status(user_institution_id)
-        raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
-        logger.debug "##{__method__} => user_institution_id: #{user_institution_id}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_status]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institution, error_messages = client.send_request(path, :get)
-        return user_institution, error_messages
-      end
-
-      def mfa(user_institution_id, parameters)
-        raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
-        logger.debug "##{__method__} => user_institution_id: #{user_institution_id}"
-
-        raise MissingArgumentsError.new 'Missing argument: parameters.' if parameters.blank?
-        logger.debug "##{__method__} => parameters: #{skip_sensitive_data parameters}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_mfa]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institution, error_messages = client.send_request(path, :put, :parameters => parameters)
-        return user_institution, error_messages
-      end
-
-      def update(user_institution_id, parameters)
-        raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
-        logger.debug "##{__method__} => user_institution_id: #{user_institution_id}"
-
-        raise MissingArgumentsError.new 'Missing argument: parameters.' if parameters.blank?
-        logger.debug "##{__method__} => parameters: #{skip_sensitive_data parameters}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_update]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institution, error_messages = client.send_request(path, :put, :parameters => parameters)
-        return user_institution, error_messages
-      end
-
-      def refresh
-        path = Defaults::END_POINTS[:user_institutions_refresh]
-        logger.debug "##{__method__} => path: #{path}"
-
-        user_institutions, error_messages = client.send_request(path, :get)
-        return user_institutions, error_messages
-      end
-
-      # @return [Hash, Array<String>]
-      def delete(user_institution_id)
-        raise MissingArgumentsError.new 'Missing argument: user_institution_id.' if user_institution_id.blank?
-        logger.debug "##{__method__} => user_institution_id: #{user_institution_id.inspect}"
-
-        end_point = Defaults::END_POINTS[:user_institutions_delete]
-        logger.debug "##{__method__} => end_point: #{end_point}"
-
-        path = end_point.sub ':user_institution_id', ERB::Util.url_encode(user_institution_id)
-        logger.debug "##{__method__} => path: #{path}"
-
-        _, error_messages = client.send_request(path, :delete)
-        error_messages
-      end
-
-    end
-
-  end
-end