finicity-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff94ad68c52843464a17802b5f6322d226a0d5e9
+  data.tar.gz: 98254830bb29dcab441aecd9d0365fdcd05ac7c3
+SHA512:
+  metadata.gz: 4adbb085e03e3479435deab13a49986590cfdd609fac99f99e7e41ce18642db812d14cc240618c90b24ccdd9c595e3367990261c68fc1111298307440ff49cd8
+  data.tar.gz: 5537f9ebbec5479ed4de430b76e33e01fc83bcdbdd4eca29dffe1481f34225e8d4d7a137b1f005c1d40b2605608ec37716b7f195a10af5f5530a6135d13ba1e1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - "bin/**/*"
+    - "db/**/*"
+    - "*.gemspec"
+  DisplayCopNames: true
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Metrics/LineLength:
+  Max: 120
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+finicity-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at just.azzurri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem "codecov", require: false, group: :test
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Azzurrio
+
+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,177 @@
+# Finicity::Ruby
+[![Build Status](https://travis-ci.org/Fundthrough/finicity-ruby.svg?branch=master)](https://travis-ci.org/Fundthrough/finicity-ruby)
+[![Code Climate](https://codeclimate.com/github/Fundthrough/finicity-ruby/badges/gpa.svg)](https://codeclimate.com/github/Fundthrough/finicity-ruby)
+[![codecov](https://codecov.io/gh/Fundthrough/finicity-ruby/branch/master/graph/badge.svg)](https://codecov.io/gh/Fundthrough/finicity-ruby)
+[![License](http://img.shields.io/:license-MIT-blue.svg?style=flat)](LICENSE)
+
+
+Welcome to `finicity-ruby` gem. This gem is built to communicate easily with Finicity's Aggregation API. It only uses the `JSON` representation of the API. Pull requests are welcome to help improving the gem.
+
+- [Installation](#installation)
+- [Setup](#setup)
+- [Usage](#usage)
+    - [Institutions](#1-institutions)
+        - [List](#list)
+        - [Get specific Institution (with login Credentials)](#get-specific-institution-with-login-credentials)
+    - [Customers](#2-customers)
+        - [Add new customer](#add-new-customer)
+        - [List all customers](#list-all-customers)
+        - [Delete customer](#delete-customer)
+    - [Accounts](#3-accounts)
+        - [Discover and add all accounts](#discover-and-add-all-accounts)
+        - [Discover and add all accounts (with MFA)](#discover-and-add-all-accounts-with-mfa)
+        - [List accounts](#list-accounts)
+        - [Get specific account](#get-specific-account)
+        - [Delete specific account](#delete-specific-account)
+        - [Refresh accounts](#refresh-accounts)
+        - [Refresh accounts (with MFA)](#refresh-accounts-with-mfa)
+        - [Activate accounts](#activate-accounts)
+        - [Update account credentials](#update-account-credentials)
+    - [Transactions](#4-transactions)
+        - [List all transactions](#list-all-transactions)
+        - [List all transactions for specific account](#list-all-transactions-for-specific-account)
+        - [Load historic transactions](#load-historic-transactions)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+The gem is available through `Rubygems` and can be installed via:
+
+    $ gem install finicity-ruby
+
+or add it to your Gemfile like this:
+
+```ruby
+gem "finicity-ruby"
+```
+
+## Setup
+Then, in your `config/initializers/` add `finicity.rb` file with corresponding values. Right now we are using redis to store the temp app token which used with each request. In the future, we are going to support multiple options to store token like memory, file & redis. Meanwhile just set the `redis_url` config into your redis host url.
+
+    Finicity.configure do |config|
+      config.redis_url      = "redis://127.0.0.1:6379"
+      config.app_key        = "xxxxxxxxxxxxxxxx"
+      config.partner_id     = "xxxxxxxxxxxxxxxx"
+      config.partner_secret = "xxxxxxxxxxxxxxxx"
+      config.app_type       = "testing" # or "active" for production apps.
+      config.verbose        = false
+      config.max_retries    = 1 # How many times do you want to retry the request in case timeout failures.
+    end
+
+## Usage
+### 1. Institutions
+#### List
+
+To get all institutions
+
+    response = Finicity::Client.institution.list
+    response.status_code # 200
+    response.success? # true
+    response.body.institutions # returns all institutions [{name: "Royal Bank of Canada", id: "1411", ...]
+
+To search for specific institution
+
+    Finicity::Client.institution.list(search: "Royal Bank of Canada")
+
+#### Get specific Institution (with login Credentials)
+Using the `id` you just got from the list above, you can find any specific institution
+
+    response = Finicity::Client.institution.get("107132")
+    response.body.institution.login_credentials # [{id: 1231, name: "username", description: "Please enter your username", ...]
+
+### 2. Customers
+#### Add new customer
+Finicity requires `username` to add a new customer. The response will contain the customer ID to be used for subsequent calls.
+
+    response = Finicity::Client.customer.add("YetAnotherBatman")
+    customer_id = response.body.customer.id
+
+#### List all customers
+To list all created customers from Finicity.
+
+    Finicity::Client.customer.list
+
+#### Delete customer
+Using the `customer_id` you just got after you add the customer.
+
+    Finicity::Client.scope(customer_id).delete
+    
+### 3. Accounts
+#### Discover and add all accounts
+To discover & add the accounts into your customer, you've to authenticate it using the `institution#login_credentials`.
+
+    institution_id = 101732
+    credentials = [{id: 101732001, name: "Banking Userid", value: "Azzurrio"}, { id: "101732002", name: "Banking Password", value: "LetMePass"]
+    Finicity::Client.scope(customer_id).account.add_all(institution_id, credentials)
+    
+#### Discover and add all accounts (with MFA)
+In case you get a MFA required. You can submit the answer into `add_all_mfa`. The `mfa_session` will be provided in `add_all` response headers.
+
+    response = Finicity::Client.scope(customer_id).account.add_all(institution_id, credentials)
+    response.status_code # 203
+    mfa_session = response.headers["MFA-session"] # e86jnv923nsas4
+    response.body.questions # [{ text: "What's your super hero?" }]
+    answers = [{ text: "What's your super hero?", answer: "Batman" }]
+    Finicity::Client.scope(customer_id).account.add_all_mfa(institution_id, mfa_sessiom, answers)
+    
+#### List accounts
+ 
+    Finicity::Client.scope(customer_id).account.list
+    
+#### Get specific account
+ 
+    Finicity::Client.scope(customer_id).account.get("236534") # using account id
+
+#### Delete specific account
+ 
+    Finicity::Client.scope(customer_id).account.delete(account_id)
+ 
+#### Refresh accounts
+After adding the accounts you have to refresh them so you can have access into their transactions.
+
+    Finicity::Client.scope(customer_id).account.refresh(institution_login_id)
+ 
+#### Refresh accounts (with MFA)
+In case you get MFA, just like `as add_all_mfa`
+
+    Finicity::Client.scope(customer_id).account.refresh(institution_login_id, mfa_session, answers)
+ 
+#### Activate accounts
+Sometimes you get accounts with type `unknown`, so you need to activate those accounts with the correct types.
+    
+    accounts = [{id: 12412, type: "savings"}, {id: 15434, type: "creditCard"}]
+    Finicity::Client.scope(customer_id).account.activate(institution_id, accounts)
+    
+#### Update account credentials
+In case account credentials have been changed, you can you get credentials and update them after populating the values correct credentials.
+    
+    Finicity::Client.scope(customer_id).account.credentials(account_id) # To be used for updating credentials
+    Finicity::Client.scope(customer_id).account.update_credentials(account_id, credentials)
+
+### 4. Transactions
+#### List all transactions
+This one will get all transactions for the given customer. You have to specify the date range using `from:` and `to:` named parameters.
+
+    Finicity::Client.scope(customer_id).transaction.list(from: 6.months.ago, to: Date.today)
+
+#### List all transactions for specific account
+In case you only need transactions for specific account. You have to provide the `account_id` as extra parameter.
+
+    Finicity::Client.scope(customer_id).transaction.list_for_account(account_id, from: 6.months.ago, to: Date.today)
+    
+#### Load historic transactions
+This's a feature in Finicity API which gives you the ability to access +6 months transactions. This could be only used per account and it's an interactive request, which means MFA challenge could be appeared.
+
+    Finicity::Client.scope(customer_id).transaction.load_historic(account_id)
+    Finicity::Client.scope(customer_id).transaction.load_historic_mfa(account_id, mfa_session, answers)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Fundthrough/finicity-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "finicity/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/finicity-ruby.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "finicity/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "finicity-ruby"
+  spec.version       = Finicity::VERSION
+  spec.authors       = ["Azzurrio"]
+  spec.email         = ["just.azzurri@gmail.com"]
+
+  spec.summary       = "Ruby Client for Finicity Aggregation API"
+  spec.description   = "Ruby Client for Finicity Aggregation API"
+  spec.homepage      = "https://github.com/Fundthrough/finicity-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version     = ">= 2.3.0"
+  spec.required_rubygems_version = ">= 2.0.0"
+
+  spec.add_runtime_dependency "hashie", "~> 3.4.4"
+  spec.add_runtime_dependency "httparty", "~> 0.14.0"
+  spec.add_runtime_dependency "redis", "~> 3.3.1"
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+end

data/lib/finicity/client.rb

@@ -0,0 +1,41 @@
+require "finicity/resources/base"
+require "finicity/resources/institution"
+require "finicity/resources/customer"
+require "finicity/resources/account"
+require "finicity/resources/transaction"
+
+module Finicity
+  class Client
+    attr_reader :customer_id
+
+    def self.scope(customer_id)
+      new(customer_id)
+    end
+
+    def self.customer
+      Finicity::Resources::Customer
+    end
+
+    def self.institution
+      Finicity::Resources::Institution
+    end
+
+    def customer
+      @customer ||= Finicity::Resources::Customer.new(customer_id)
+    end
+
+    def account
+      @account ||= Finicity::Resources::Account.new(customer_id)
+    end
+
+    def transaction
+      @transaction ||= Finicity::Resources::Transaction.new(customer_id)
+    end
+
+    protected
+
+    def initialize(customer_id)
+      @customer_id = customer_id
+    end
+  end
+end

data/lib/finicity/configurable.rb

@@ -0,0 +1,22 @@
+require "hashie"
+
+module Finicity
+  module Configurable
+    KEYS = [:redis_url, :app_key, :partner_id, :partner_secret, :max_retries, :app_type, :verbose].freeze
+
+    attr_writer(*KEYS)
+
+    def configure
+      yield self
+      self
+    end
+
+    def configs
+      @configs ||= begin
+        hash = {}
+        KEYS.each { |key| hash[key] = instance_variable_get(:"@#{key}") }
+        Hashie::Mash.new(hash)
+      end
+    end
+  end
+end

data/lib/finicity/fetchers/api.rb

@@ -0,0 +1,32 @@
+require "finicity/fetchers/token"
+
+module Finicity
+  module Fetchers
+    class API < Base
+      class << self
+        def request(*args)
+          response = super(*args)
+
+          return response unless invalid_app_token?(response)
+
+          app_token.refresh
+          request(*args)
+        end
+
+        protected
+
+        def invalid_app_token?(response)
+          response.status_code == 401 && INVALID_APP_TOKEN_CODES.include?(response.body&.code)
+        end
+
+        def default_headers
+          { "Finicity-App-Token" => app_token.get }
+        end
+
+        def app_token
+          ::Finicity::Fetchers::Token
+        end
+      end
+    end
+  end
+end

data/lib/finicity/fetchers/base.rb

@@ -0,0 +1,81 @@
+require "httparty"
+
+module Finicity
+  module Fetchers
+    class Base
+      include HTTParty
+
+      base_uri "https://api.finicity.com/aggregation"
+      headers "Content-Type" => "application/json"
+      headers "Accept" => "application/json"
+      headers "Finicity-App-Key" => Finicity.configs.app_key
+      debug_output $stdout if Finicity.configs.verbose
+
+      class << self
+        def request(method, endpoint, opts = {})
+          tries = 0
+          loop do
+            begin
+              break fetch(method, endpoint, opts)
+            rescue Net::ReadTimeout, Errno::ECONNREFUSED, Net::OpenTimeout => e
+              raise e if (tries += 1) > Finicity.configs.max_retries.to_i
+            end
+          end
+        end
+
+        protected
+
+        def fetch(method, endpoint, opts)
+          request_opts = normalize_request_options(opts)
+
+          response = send(method, endpoint, request_opts)
+
+          raise Finicity::ApiServerError, response.body if server_error?(response)
+
+          Hashie::Mash.new(
+            success?:    response.success?,
+            status_code: response.code,
+            body:        parse_json(response.body),
+            headers:     response.headers
+          )
+        end
+
+        def normalize_request_options(opts)
+          opts.clone.tap do |o|
+            o[:headers] = default_headers.merge(o[:headers].to_h)
+            o[:body]    = jsonify(o[:body]) if o[:body].present?
+            o[:query]   = camelcase_keys(o[:query]) if o[:query].present?
+          end
+        end
+
+        def parse_json(body)
+          result = JSON.parse(body.to_s).deep_transform_keys!(&:underscore)
+          Hashie::Mash.new(result)
+        rescue JSON::ParserError
+          body
+        end
+
+        def jsonify(body)
+          camelcase_keys(body).to_json
+        end
+
+        def camelcase_keys(hash)
+          hash.deep_transform_keys! { |k| k.to_s.camelcase(:lower) }
+        end
+
+        def server_error?(response)
+          other_content_type?(response)
+        end
+
+        def other_content_type?(response)
+          content_type = response.headers["Content-Type"]&.downcase
+          content_type.present? && content_type != "application/json"
+        end
+
+        def default_headers
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/finicity/fetchers/token.rb

@@ -0,0 +1,50 @@
+require "redis"
+
+module Finicity
+  module Fetchers
+    class Token < Base
+      class << self
+        def get
+          refresh if token_expired?
+          token
+        end
+
+        def refresh
+          response = fetch_new_one
+
+          raise Finicity::TokenRefreshError, response.body unless response.success?
+
+          redis["finicity-token-expires-at"] = 90.minutes.from_now.to_s
+          redis["finicity-token"] = response.body.token
+        end
+
+        protected
+
+        def fetch_new_one
+          endpoint = "/v2/partners/authentication"
+          body = {
+            partner_id: Finicity.configs.partner_id,
+            partner_secret: Finicity.configs.partner_secret
+          }
+          request(:post, endpoint, body: body)
+        end
+
+        def token_expired?
+          !(token_expired_at.present? && Time.parse(token_expired_at).future?)
+        end
+
+        def token
+          redis["finicity-token"]
+        end
+
+        def token_expired_at
+          redis["finicity-token-expires-at"]
+        end
+
+        def redis
+          Redis.new(url: Finicity.configs.redis_url)
+        end
+      end
+    end
+  end
+end

data/lib/finicity/fetchers.rb

@@ -0,0 +1,7 @@
+module Finicity
+  module Fetchers
+    autoload :Base, "finicity/fetchers/base"
+    autoload :Token, "finicity/fetchers/token"
+    autoload :API, "finicity/fetchers/api"
+  end
+end

data/lib/finicity/resources/account.rb

@@ -0,0 +1,72 @@
+module Finicity
+  module Resources
+    class Account < Base
+      def add_all(institution_id, credentials)
+        endpoint = "/v1/customers/#{customer_id}/institutions/#{institution_id}/accounts/addall"
+        body = { credentials: credentials }
+
+        request(:post, endpoint, body: body)
+      end
+
+      def add_all_mfa(institution_id, mfa_session, questions)
+        endpoint = "/v1/customers/#{customer_id}/institutions/#{institution_id}/accounts/addall/mfa"
+        body = { mfa_challenges: { questions: questions } }
+        headers = { "MFA-Session" => mfa_session }
+
+        request(:post, endpoint, body: body, headers: headers)
+      end
+
+      def list
+        endpoint = "/v1/customers/#{customer_id}/accounts"
+
+        request(:get, endpoint)
+      end
+
+      def activate(institution_id, accounts)
+        endpoint = "/v2/customers/#{customer_id}/institutions/#{institution_id}/accounts"
+
+        request(:put, endpoint, body: { accounts: accounts })
+      end
+
+      def refresh(institution_login_id)
+        endpoint = "/v1/customers/#{customer_id}/institutionLogins/#{institution_login_id}/accounts"
+
+        request(:post, endpoint)
+      end
+
+      def refresh_mfa(institution_login_id, mfa_session, questions)
+        endpoint = "/v1/customers/#{customer_id}/institutionLogins/#{institution_login_id}/accounts/mfa"
+
+        body =  { questions: questions }
+        headers = { "MFA-Session" => mfa_session }
+
+        request(:post, endpoint, body: body, headers: headers)
+      end
+
+      def get(account_id)
+        endpoint = "/v1/customers/#{customer_id}/accounts/#{account_id}"
+
+        request(:get, endpoint)
+      end
+
+      def delete(account_id)
+        endpoint = "/v1/customers/#{customer_id}/accounts/#{account_id}"
+
+        request(:delete, endpoint)
+      end
+
+      def credentials(account_id)
+        endpoint = "/v1/customers/#{customer_id}/accounts/#{account_id}/loginForm"
+
+        request(:get, endpoint)
+      end
+
+      def update_credentials(account_id, credentials)
+        endpoint = "/v1/customers/#{customer_id}/accounts/#{account_id}/loginForm"
+        body = { login_form: credentials }
+
+        request(:put, endpoint, body: body)
+      end
+    end
+  end
+end

data/lib/finicity/resources/base.rb

@@ -0,0 +1,23 @@
+require "finicity/fetchers"
+
+module Finicity
+  module Resources
+    class Base
+      attr_reader :customer_id
+
+      def initialize(customer_id)
+        @customer_id = customer_id
+      end
+
+      def self.request(*args)
+        ::Finicity::Fetchers::API.request(*args)
+      end
+
+      protected
+
+      def request(*args)
+        self.class.request(*args)
+      end
+    end
+  end
+end

data/lib/finicity/resources/customer.rb

@@ -0,0 +1,25 @@
+module Finicity
+  module Resources
+    class Customer < Base
+      def self.add(username)
+        endpoint = "/v1/customers/#{Finicity.configs.app_type}"
+        body = { username: username }
+
+        request(:post, endpoint, body: body)
+      end
+
+      def self.list(query = {})
+        endpoint = "/v1/customers"
+        query = { query: query } if query.present?
+
+        request(:get, endpoint, query)
+      end
+
+      def delete
+        endpoint = "/v1/customers/#{customer_id}"
+
+        request(:delete, endpoint)
+      end
+    end
+  end
+end

data/lib/finicity/resources/institution.rb

@@ -0,0 +1,18 @@
+module Finicity
+  module Resources
+    class Institution < Base
+      def self.list(query = {})
+        endpoint = "/v1/institutions"
+        query = { query: query } if query.present?
+
+        request(:get, endpoint, query)
+      end
+
+      def self.get(institution_id)
+        endpoint = "/v1/institutions/#{institution_id}/details"
+
+        request(:get, endpoint)
+      end
+    end
+  end
+end

data/lib/finicity/resources/transaction.rb

@@ -0,0 +1,33 @@
+module Finicity
+  module Resources
+    class Transaction < Base
+      def list(from:, to:, params: {})
+        endpoint = "/v2/customers/#{customer_id}/transactions"
+        query = { from_date: from.to_time.to_i, to_date: to.to_time.to_i }.merge(params)
+
+        request(:get, endpoint, query: query)
+      end
+
+      def list_for_account(account_id, from:, to:, params: {})
+        endpoint = "/v2/customers/#{customer_id}/accounts/#{account_id}/transactions"
+        query = { from_date: from.to_time.to_i, to_date: to.to_time.to_i }.merge(params)
+
+        request(:get, endpoint, query: query)
+      end
+
+      def load_historic(account_id)
+        endpoint = "/v1/customers/#{customer_id}/accounts/#{account_id}/transactions/historic"
+
+        request(:post, endpoint)
+      end
+
+      def load_historic_mfa(account_id, mfa_session, questions)
+        endpoint = "/v1/customers/#{customer_id}/accounts/#{account_id}/transactions/historic/mfa"
+        headers = { "MFA-Session" => mfa_session }
+        body = { questions: questions }
+
+        request(:post, endpoint, body: body, headers: headers)
+      end
+    end
+  end
+end

data/lib/finicity/version.rb

@@ -0,0 +1,3 @@
+module Finicity
+  VERSION = "1.0.0".freeze
+end

data/lib/finicity-ruby.rb

@@ -0,0 +1,41 @@
+require "finicity/configurable"
+require "finicity/version"
+require "finicity/client"
+require "active_support/all"
+
+module Finicity
+  extend Finicity::Configurable
+
+  class ApiServerError < StandardError; end
+  class TokenRefreshError < StandardError; end
+  class LoadHistoricTxnError < StandardError; end
+
+  # Description: Expired Finicity app token
+  # Required Action: Renew app token
+  INVALID_APP_TOKEN_CODES = [10_022, 10_023].freeze
+
+  # Description: Retry Error or Problem Connecting to the Institution
+  # Required Action: Nothing. Just try again later.
+  CONNECTION_PROBLEM_CODES = [102, 320, 580].freeze
+
+  # Description: Invalid Credentials
+  # Required Action: Prompt the customer for the correct credentials.
+  INVALID_CREDENTIALS_CODES = [103].freeze
+
+  # Description: User Action Required
+  # Required Action: Prompt the user to login to their account directly at the institution's website
+  # and follow the instructions there
+  USER_ACTION_REQUIRED_CODES = [108, 109].freeze
+
+  # Description: Missing or Incorrect MFA Answer
+  # Required Action: Refresh Customer Account and follow the MFA sequence to prompt the user for the missing information
+  INCORRECT_MFA_ANSWERS_CODES = [185, 187].freeze
+
+  # Description: The account is currently being aggregated.
+  # Required Action: Nothing. This is only an informational message. Try again later.
+  ACCOUNT_BEING_AGG_CODES = [325, 5006].freeze
+
+  # Description: Missing Parameter
+  # Required Action: A required field was left blank, Submit the request again, with valid text
+  MISSING_PARAMS_CODES = [10_005].freeze
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: finicity-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Azzurrio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.4
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Client for Finicity Aggregation API
+email:
+- just.azzurri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- finicity-ruby.gemspec
+- lib/finicity-ruby.rb
+- lib/finicity/client.rb
+- lib/finicity/configurable.rb
+- lib/finicity/fetchers.rb
+- lib/finicity/fetchers/api.rb
+- lib/finicity/fetchers/base.rb
+- lib/finicity/fetchers/token.rb
+- lib/finicity/resources/account.rb
+- lib/finicity/resources/base.rb
+- lib/finicity/resources/customer.rb
+- lib/finicity/resources/institution.rb
+- lib/finicity/resources/transaction.rb
+- lib/finicity/version.rb
+homepage: https://github.com/Fundthrough/finicity-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby Client for Finicity Aggregation API
+test_files: []