finicity 0.1.0

data/lib/finicity/configuration.rb

@@ -0,0 +1,13 @@
+module Finicity
+  class Configuration
+    attr_accessor :base_url,
+      :logger,
+      :partner_id,
+      :partner_secret,
+      :app_key
+
+    def initialize
+      @logger = ::Logger.new(STDOUT)
+    end
+  end
+end

data/lib/finicity/errors.rb

@@ -0,0 +1,62 @@
+module Finicity
+  class GenericError < ::StandardError
+    attr_reader :error_message, :http_status, :finicity_code
+
+    def initialize(error_message = nil, http_status = nil, finicity_code = nil)
+      @error_message = error_message
+      @http_status = http_status
+      @finicity_code = finicity_code
+    end
+
+    def to_s
+      status = http_status.nil? ? "" : "[Status #{http_status}] "
+      code = finicity_code.nil? ? "" : "[Finicity Code #{finicity_code}] "
+      "#{status}#{code}#{error_message}"
+    end
+  end
+
+  class AuthenticationError < ::Finicity::GenericError
+  end
+
+  class DuplicateCustomerError < ::StandardError
+    attr_reader :username
+
+    def initialize(username)
+      @username = username
+    end
+
+    def to_s
+      "Multiple customers found with username: #{username}"
+    end
+  end
+
+  class FinicityAggregationError < ::StandardError
+    ERROR_CODE_MAP = {
+      '0' => 'Success.',
+      '102' => 'Retry error. Website is down or there is a connectivity issue.',
+      '103' => 'Invalid Credentials. Credentials must be updated.',
+      '106' => 'Account Name/Number/Type mismatch.',
+      '108' => 'End user action required at the third party site.',
+      '109' => 'Password change required at the third party site.',
+      '185' => 'MFA answer(s) missing.',
+      '187' => 'Incorrect answer to MFA challenge question.'
+    }
+
+    attr_reader :aggregation_status_code
+
+    def initialize(aggregation_status_code)
+      @aggregation_status_code = aggregation_status_code
+    end
+
+    def error_message
+      ERROR_CODE_MAP[aggregation_status_code.to_s] || 'Unknown Error'
+    end
+
+    def to_s
+      "[Aggregation Status Code #{aggregation_status_code}] #{error_message}"
+    end
+  end
+
+  class InvalidCredentialsError < ::Finicity::FinicityAggregationError
+  end
+end

data/lib/finicity/logger.rb

@@ -0,0 +1,19 @@
+module Finicity
+  module Logger
+    def log_request
+      ::Finicity.logger.debug do
+        log = "REQUEST: #{self.class.name}"
+        log << "\n  URL: #{url}" if self.respond_to?(:url)
+        log << "\n  QUERY: #{query}" if self.respond_to?(:query)
+        log << "\n  BODY: #{mask_body(body)}" if self.respond_to?(:body)
+        log
+      end
+    end
+
+    def mask_body(body)
+      body = body.gsub(/<value>.*<\/value>/, "<value>[FILTERED]</value>")
+      body = body.gsub(/<answer>.*<\/answer>/, "<answer>[FILTERED]</answer>")
+      body
+    end
+  end
+end

data/lib/finicity/railtie.rb

@@ -0,0 +1,22 @@
+module Finicity
+  class Railtie < ::Rails::Railtie
+
+    config.finicity = ::Finicity.config
+
+    initializer "finicity_configuration" do |app|
+      if File.exists?(::Rails.root.join('config', 'finicity.yml'))
+
+        yaml_file = ::YAML.load_file(::Rails.root.join('config', 'finicity.yml'))
+
+        ::Finicity.configure do |config|
+          config.base_url = yaml_file['base_url']
+          config.partner_id = yaml_file['partner_id']
+          config.partner_secret = yaml_file['partner_secret']
+          config.app_key = yaml_file['app_key']
+        end
+      else
+        ::Rails.logger.warn("Failed to load finicity.yml")
+      end
+    end
+  end
+end

data/lib/finicity/v1.rb

@@ -0,0 +1,29 @@
+require 'finicity/v1/request/activate_accounts'
+require 'finicity/v1/request/activate_accounts_with_mfa'
+require 'finicity/v1/request/add_customer'
+require 'finicity/v1/request/delete_customer'
+require 'finicity/v1/request/discover_accounts'
+require 'finicity/v1/request/discover_accounts_with_mfa'
+require 'finicity/v1/request/get_accounts'
+require 'finicity/v1/request/get_customers_by_username'
+require 'finicity/v1/request/get_customers'
+require 'finicity/v1/request/get_institution'
+require 'finicity/v1/request/get_institutions'
+require 'finicity/v1/request/get_login_form'
+require 'finicity/v1/request/get_transactions'
+require 'finicity/v1/request/interactive_refresh_account'
+require 'finicity/v1/request/interactive_refresh_account_with_mfa'
+require 'finicity/v1/request/refresh_accounts'
+
+require 'finicity/v1/response/accounts'
+require 'finicity/v1/response/customers'
+require 'finicity/v1/response/error'
+require 'finicity/v1/response/institutions'
+require 'finicity/v1/response/login_form'
+require 'finicity/v1/response/mfa'
+require 'finicity/v1/response/transactions'
+
+module Finicity
+  module V1
+  end
+end

data/lib/finicity/v1/request/activate_accounts.rb

@@ -0,0 +1,73 @@
+module Finicity::V1
+  module Request
+    class ActivateAccounts
+      include ::Finicity::Logger
+      extend ::HTTPClient::IncludeClient
+      include_http_client do |client|
+        client.cookie_manager = nil
+      end
+
+      ##
+      # Attributes
+      #
+      attr_accessor :accounts,
+        :customer_id,
+        :institution_id,
+        :token
+
+      ##
+      # Instance Methods
+      #
+      def initialize(token, customer_id, institution_id, accounts)
+        @accounts = accounts
+        @customer_id = customer_id
+        @institution_id = institution_id
+        @token = token
+      end
+
+      # The accounts parameter is the finicity representation of accounts
+      def activate_accounts
+        http_client.put(url, body, headers)
+      end
+
+      # The accounts parameter is the finicity representation of accounts
+      def body
+        builder = ::Nokogiri::XML::Builder.new do |xml|
+          xml.accounts {
+            accounts.each do |account|
+              xml.account {
+                xml.id(account.id)
+                xml.number(account.number)
+                xml.name(account.name)
+                xml.type(account.type)
+              }
+            end
+          }
+        end
+
+        builder.to_xml
+      end
+
+      def headers
+        {
+          'Finicity-App-Key' => ::Finicity.config.app_key,
+          'Finicity-App-Token' => token,
+          'Content-Type' => 'application/xml'
+        }
+      end
+
+      def url
+        ::URI.join(
+          ::Finicity.config.base_url,
+          'v1/',
+          'customers/',
+          "#{customer_id}/",
+          'institutions/',
+          "#{institution_id}/",
+          'accounts'
+        )
+      end
+
+    end
+  end
+end

data/lib/finicity/v1/request/activate_accounts_with_mfa.rb

@@ -0,0 +1,88 @@
+module Finicity::V1
+  module Request
+    class ActivateAccountsWithMfa
+      include ::Finicity::Logger
+      extend ::HTTPClient::IncludeClient
+      include_http_client do |client|
+        client.cookie_manager = nil
+      end
+
+      ##
+      # Attributes
+      #
+      attr_accessor :accounts,
+        :customer_id,
+        :institution_id,
+        :mfa_credentials,
+        :mfa_session,
+        :token
+
+      ##
+      # Instance Methods
+      #
+      def initialize(token, mfa_session, customer_id, institution_id, accounts, mfa_credentials)
+        @accounts = accounts
+        @customer_id = customer_id
+        @institution_id = institution_id
+        @mfa_credentials = mfa_credentials
+        @mfa_session = mfa_session
+        @token = token
+      end
+
+      def activate_accounts_with_mfa
+        http_client.put(url, body, headers)
+      end
+
+      # The accounts parameter is the finicity representation of accounts
+      def body
+        builder = ::Nokogiri::XML::Builder.new do |xml|
+          xml.accounts {
+            accounts.each do |account|
+              xml.account {
+                xml.id(account.id)
+                xml.number(account.number)
+                xml.name(account.name)
+                xml.type(account.type)
+              }
+            end
+            xml.mfaChallenges {
+              xml.questions {
+                mfa_credentials.each do |mfa_credential|
+                  xml.question {
+                    xml.text_(mfa_credential[:text])
+                    xml.answer(mfa_credential[:answer])
+                  }
+                end
+              }
+            }
+          }
+        end
+
+        builder.to_xml
+      end
+
+      def headers
+        {
+          'Finicity-App-Key' => ::Finicity.config.app_key,
+          'Finicity-App-Token' => token,
+          'Content-Type' => 'application/xml',
+          'MFA-Session' => mfa_session,
+        }
+      end
+
+      def url
+        ::URI.join(
+          ::Finicity.config.base_url,
+          'v1/',
+          'customers/',
+          "#{customer_id}/",
+          'institutions/',
+          "#{institution_id}/",
+          'accounts/',
+          'mfa'
+        )
+      end
+
+    end
+  end
+end

data/lib/finicity/v1/request/add_customer.rb

@@ -0,0 +1,54 @@
+module Finicity::V1
+  module Request
+    class AddCustomer
+      include ::Finicity::Logger
+      extend ::HTTPClient::IncludeClient
+      include_http_client do |client|
+        client.cookie_manager = nil
+      end
+
+      ##
+      # Attributes
+      #
+      attr_accessor :token,
+        :user_guid
+
+      ##
+      # Instance Methods
+      #
+      def initialize(token, user_guid)
+        @token = token
+        @user_guid = user_guid
+      end
+
+      def add_customer
+        http_client.post(url, body, headers)
+      end
+
+      def body
+        {
+          'username' => user_guid,
+          'email' => "#{user_guid}@mx.com",
+          'firstName' => user_guid,
+          'lastName' => user_guid
+        }.to_xml(:root => 'customer')
+      end
+
+      def headers
+        {
+          'Finicity-App-Key' => ::Finicity.config.app_key,
+          'Finicity-App-Token' => token,
+          'Content-Type' => 'application/xml'
+        }
+      end
+
+      def url
+        ::URI.join(
+          ::Finicity.config.base_url,
+          'v1/',
+          'customers'
+        )
+      end
+    end
+  end
+end

data/lib/finicity/v1/request/delete_customer.rb

@@ -0,0 +1,45 @@
+module Finicity::V1
+  module Request
+    class DeleteCustomer
+      include ::Finicity::Logger
+      extend ::HTTPClient::IncludeClient
+      include_http_client do |client|
+        client.cookie_manager = nil
+      end
+
+      ##
+      # Attributes
+      #
+      attr_accessor :token,
+        :customer_id
+
+      ##
+      # Instance Methods
+      #
+      def initialize(token, customer_id)
+        @customer_id = customer_id
+        @token = token
+      end
+
+      def delete_customer
+        http_client.delete(url, nil, headers)
+      end
+
+      def headers
+        {
+          'Finicity-App-Key' => ::Finicity.config.app_key,
+          'Finicity-App-Token' => token
+        }
+      end
+
+      def url
+        ::URI.join(
+          ::Finicity.config.base_url,
+          'v1/',
+          'customers/',
+          customer_id.to_s
+        )
+      end
+    end
+  end
+end

data/lib/finicity/v1/request/discover_accounts.rb

@@ -0,0 +1,71 @@
+module Finicity::V1
+  module Request
+    class DiscoverAccounts
+      include ::Finicity::Logger
+      extend ::HTTPClient::IncludeClient
+      include_http_client do |client|
+        client.cookie_manager = nil
+      end
+
+      ##
+      # Attributes
+      #
+      attr_accessor :customer_id,
+        :institution_id,
+        :login_credentials,
+        :token
+
+      ##
+      # Instance Methods
+      #
+      def initialize(token, customer_id, institution_id, login_credentials)
+        @customer_id = customer_id
+        @institution_id = institution_id
+        @login_credentials = login_credentials
+        @token = token
+      end
+
+      def discover_accounts
+        http_client.post(url, body, headers)
+      end
+
+      def body
+        builder = ::Nokogiri::XML::Builder.new do |xml|
+          xml.accounts {
+            xml.credentials {
+              login_credentials.each do |login_credential|
+                xml.loginField {
+                  xml.id(login_credential[:id])
+                  xml.name(login_credential[:name])
+                  xml.value(login_credential[:value])
+                }
+              end
+            }
+          }
+        end
+
+        builder.to_xml
+      end
+
+      def headers
+        {
+          'Finicity-App-Key' => ::Finicity.config.app_key,
+          'Finicity-App-Token' => token,
+          'Content-Type' => 'application/xml'
+        }
+      end
+
+      def url
+        ::URI.join(
+          ::Finicity.config.base_url,
+          'v1/',
+          'customers/',
+          "#{customer_id}/",
+          'institutions/',
+          "#{institution_id}/",
+          'accounts'
+        )
+      end
+    end
+  end
+end