plaider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 784fe8b77ed4336121bfe0ca3627f7f1f10a64ca
+  data.tar.gz: 1e0ed9af526c2ac579e5524cc50f1280d0e5b2c6
+SHA512:
+  metadata.gz: e8bd65c4519c147fa830b6f2aaa20f55e698f50d0875ff299dadec7eee5d13c76124e4216b4163fbf26ddc3ab49ad748e6902678538c83f0338afdb04f9b62b9
+  data.tar.gz: b6253345ea5d2ec1b3604ed65bcc5a27d250d6749ce114735ee78c69671f7a9a58b763976586e0fda3f9c02f42e524e263f7633edcc8c40ba0724eec52f82e68

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle
+/log/*.log
+/tmp
+/.idea
+public/assets
+.DS_Store
+*/.DS_Store
+/coverage
+/pkg

data/.ruby-gemset

@@ -0,0 +1 @@
+plaid

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+bundler_args: "--without development"
+before_install:
+  - gem install bundler
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+script:
+  - gem build plaider.gemspec
+  - gem install plaider-*

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'test-unit'
+  gem 'simplecov', require: false
+  gem 'coveralls', require: false
+  gem 'webmock'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    plaider (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    json (1.8.1)
+    mime-types (2.4.3)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    netrc (0.8.0)
+    power_assert (0.1.4)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    safe_yaml (1.0.4)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    test-unit (3.0.3)
+      power_assert
+    thor (0.19.1)
+    tins (1.3.3)
+    webmock (1.20.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  coveralls
+  json (~> 1.8)
+  minitest
+  plaider!
+  rake
+  simplecov
+  test-unit
+  webmock

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gene Drabkin
+
+MIT License
+
+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,91 @@
+# Plaider
+[![Build Status](https://travis-ci.org/cloocher/plaider.png)](https://travis-ci.org/cloocher/plaider)
+[![Coverage Status](https://coveralls.io/repos/cloocher/plaider/badge.png?branch=master)](https://coveralls.io/r/cloocher/plaider)
+[![Gem Version](https://badge.fury.io/rb/plaider.png)](http://badge.fury.io/rb/plaider)
+
+  Plaid API client
+
+## Installation
+
+Plaider is available through [Rubygems](http://rubygems.org/gems/plaider) and can be installed via:
+
+```
+$ gem install plaider
+```
+
+or add it to your Gemfile like this:
+
+```
+gem 'plaider'
+```
+
+## Start Guide
+
+Register for [Plaid](https://plaid.com/account/signup).
+
+## Usage
+
+```ruby
+require 'plaider'
+
+# Plaider global configuration
+Plaider.configure do |config|
+  config.client_id = 'client id'
+  config.secret = 'secret'
+end
+
+# alternatively, specify configuration options when instantiating an Aggcat::Client
+client = Plaider::Client.new(
+  client_id: 'client id',
+  secret: 'secret',
+  access_token: 'scope for all requests'
+)
+
+# create an scoped client by customer_id
+client = Aggcat.scope(customer_id)
+
+# get all supported financial institutions
+client.institutions
+
+# get details for Chase
+client.institution('5301a99504977c52b60000d0')
+
+# add new financial account to aggregate from Chase
+response = client.add_user('chase', username, password, email)
+
+# in case MFA is required
+questions = response[:mfa]
+answer = 'answer'
+client.user_confirmation(answer)
+
+# get already aggregated financial accounts and transactions
+client.transactions
+
+# get all aggregated account balances
+client.balance
+
+# get account transactions
+start_date = Date.today - 30
+end_date = Date.today # optional
+pending = true # include pending transactions
+client.transactions(account_id, start_date, end_date, pending)
+
+# update user credentials
+client.update_user(new_username, new_password)
+
+# you can set scope inline for any request
+Aggcat.scope(access_request).transactions
+
+# delete user
+client.delete_user
+```
+
+## Requirements
+
+* Ruby 1.9.3 or higher
+
+## Copyright
+Copyright (c) 2014 Gene Drabkin.
+See [LICENSE][] for details.
+
+[license]: LICENSE.md

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/*/*_test.rb'
+  t.verbose = true
+end
+
+task default: :test

data/lib/plaider.rb

@@ -0,0 +1,29 @@
+require 'plaider/version'
+require 'plaider/configurable'
+require 'plaider/client'
+
+module Plaider
+  class << self
+    include Plaider::Configurable
+
+    def scope(access_token = nil)
+      if !defined?(@access_token) || @access_token != access_token
+        @access_token = access_token
+        @client = Plaider::Client.new(options.merge({access_token: access_token}))
+      end
+      @client
+    end
+
+    def client
+      @client ||= Plaider::Client.new(options)
+    end
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      return super unless client.respond_to?(method_name)
+      client.send(method_name, *args, &block)
+    end
+
+  end
+end

data/lib/plaider/client.rb

@@ -0,0 +1,146 @@
+require 'net/https'
+require 'json'
+
+module Plaider
+  class Client
+
+    BASE_URL = 'https://tartan.plaid.com'
+
+    DATE_FORMAT = '%Y-%m-%d'
+
+    OPEN_TIMEOUT = 15
+    READ_TIMEOUT = 120
+
+    def initialize(options={})
+      options[:open_timeout] ||= OPEN_TIMEOUT
+      options[:read_timeout] ||= READ_TIMEOUT
+      options[:verbose] ||= false
+      Plaider::Configurable::KEYS.each do |key|
+        instance_variable_set(:"@#{key}", !options[key].nil? ? options[key] : Plaider.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    def institutions
+      get('/institutions')
+    end
+
+    def institution(institution_id)
+      validate(institution_id: institution_id)
+      get("/institutions/#{institution_id}")
+    end
+
+    def categories
+      get('/categories')
+    end
+
+    def category(category_id)
+      validate(category_id: category_id)
+      get("/categories/#{category_id}")
+    end
+
+    def entity(entity_id)
+      validate(entity_id: entity_id)
+      get("/entities/#{entity_id}")
+    end
+
+    def balance
+      post('/balance')
+    end
+
+    def add_user(institution_type, username, password, email)
+      validate(institution_type: institution_type, username: username, password: password, email: email)
+      response = post('/connect', {type: institution_type, username: username, password: password, email: email})
+      status_code = response[:status_code].to_i
+      @access_token = response[:result][:access_token] if [200, 201].include?(status_code)
+      response
+    end
+
+    def user_confirmation(mfa)
+      validate(mfa: mfa)
+      post('/connect/step', {mfa: mfa})
+    end
+
+    def transactions(account_id = nil, start_date = nil, end_date = nil, pending = false)
+      params = {}
+      params[:account_id] = account_id if account_id
+      params[:gte] = format_date(start_date)
+      params[:lte] = format_date(end_date)
+      params[:pending] = account_id if pending
+      post('/connect/get', params)
+    end
+
+    def update_user(username, password)
+      validate(username: username, password: password)
+      patch('/connect', {username: username, password: password})
+    end
+
+    def delete_user
+      response = delete('/connect')
+      @access_token = nil
+      response
+    end
+
+    protected
+
+    def get(path)
+      process(Net::HTTP::Get.new(path))
+    end
+
+    def post(path, params = {})
+      request = Net::HTTP::Post.new(path)
+      params.merge!(credentials)
+      params.merge!(access_token: @access_token)
+      request.set_form_data(params)
+      process(request)
+    end
+
+    def patch(path, params = {})
+      request = Net::HTTP::Patch.new(path)
+      params.merge!(credentials)
+      params.merge!(access_token: @access_token)
+      request.set_form_data(params)
+      process(request)
+    end
+
+    def delete(path)
+      request = Net::HTTP::Delete.new(path)
+      request.set_form_data(credentials.merge(access_token: @access_token))
+      puts request.inspect
+      process(request)
+    end
+
+    private
+
+    def validate(args)
+      args.each do |name, value|
+        if value.nil? || value.to_s.empty?
+          raise ArgumentError.new("#{name} is required")
+        end
+      end
+    end
+
+    def credentials
+      @credentials ||= {client_id: @client_id, secret: @secret}
+    end
+
+    def http
+      unless defined?(@http)
+        uri = URI.parse(BASE_URL)
+        @http = Net::HTTP.new(uri.host, uri.port)
+        @http.use_ssl = true
+        @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      @http
+    end
+
+    def process(request)
+      response = http.request(request)
+      {status_code: response.code, result: JSON.parse(response.body, {symbolize_names: true})}
+    end
+
+    def format_date(date)
+      !!date ? date.strftime(DATE_FORMAT) : date
+    end
+  end
+
+end

data/lib/plaider/configurable.rb

@@ -0,0 +1,20 @@
+module Plaider
+  module Configurable
+
+    KEYS = [:client_id, :secret, :access_token, :open_timeout, :read_timeout]
+
+    attr_writer *KEYS
+
+    def configure
+      yield self
+      self
+    end
+
+    private
+
+    def options
+      Plaider::Configurable::KEYS.inject({}) { |hash, key| hash[key] = instance_variable_get(:"@#{key}"); hash }
+    end
+
+  end
+end

data/lib/plaider/version.rb

@@ -0,0 +1,3 @@
+module Plaider
+  VERSION = '0.1.0'
+end

data/plaider.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plaider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'plaider'
+  spec.version       = Plaider::VERSION
+  spec.authors       = ['Gene Drabkin']
+  spec.email         = ['gene.drabkin@gmail.com']
+  spec.description   = %q{Wraps Plaid API in a simple client}
+  spec.summary       = %q{Ruby client for Plaid API}
+  spec.homepage      = 'https://github.com/cloocher/plaider'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'json', '~> 1.8'
+end