plaid 3.0.0 → 4.0.0

data/lib/plaid/products/processor.rb

@@ -0,0 +1,48 @@
+module Plaid
+  # Public: Class used to call the BankAccountToken sub-product.
+  class BankAccountToken
+    def initialize(client)
+      @client = client
+    end
+
+    # Public: Creates a Stripe bank account token from an access_token.
+    #
+    # Does a POST /processor/stripe/bank_account_token/create call which can
+    # be used to generate a Stripe bank account token for a given account ID.
+    #
+    # access_token - access_token to create a public token for
+    # account_id - ID of the account to create a bank account token for
+    #
+    # Returns a parsed JSON containing a Stripe bank account token
+    def create(access_token, account_id)
+      payload = { access_token: access_token,
+                  account_id: account_id }
+      @client.post_with_auth('processor/stripe/bank_account_token/create',
+                             payload)
+    end
+  end
+
+  # Public: Class used to call the Stripe sub-product.
+  class Stripe
+    # Public: Memoized class instance to make requests from Plaid::BankAccountToken
+    def bank_account_token
+      @bank_account_token ||= Plaid::BankAccountToken.new(@client)
+    end
+
+    def initialize(client)
+      @client = client
+    end
+  end
+
+  # Public: Class used to call the Processor product.
+  class Processor
+    # Public: Memoized class instance to make requests from Plaid::Stripe
+    def stripe
+      @stripe ||= Plaid::Stripe.new(@client)
+    end
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/plaid/products/sandbox.rb

@@ -0,0 +1,32 @@
+module Plaid
+  # Public: Class used to call the SandboxItem sub-product.
+  class SandboxItem
+    def initialize(client)
+      @client = client
+    end
+
+    # Public: Resets sandbox item login
+    #
+    # Does a POST /sandbox/item/reset_login call
+    #
+    # access_token - access_token who's item to reset login for
+    #
+    # Returns a parsed JSON of response
+    def reset_login(access_token)
+      payload = { access_token: access_token }
+      @client.post_with_auth('sandbox/item/reset_login', payload)
+    end
+  end
+
+  # Public: Class used to call the Sandbox product.
+  class Sandbox
+    # Public: Memoized class instance to make requests from Plaid::SandboxItem
+    def sandbox_item
+      @sandbox_item ||= Plaid::SandboxItem.new(@client)
+    end
+
+    def initialize(client)
+      @client = client
+    end
+  end
+end

data/lib/plaid/products/transactions.rb

@@ -0,0 +1,74 @@
+require 'date'
+
+module Plaid
+  # Internal: Converts date objects to strings if needed
+  #
+  # Takes in a string or a Date object and performs necessary operations to return a
+  # string representation of the Date
+  #
+  # date - Date in Date object form or string form (YYYY-MM-DD)
+  #
+  # Returns a string representing a date needed for transaction start and end dates
+  def self.convert_to_date_string(date)
+    case date
+    when String
+      date
+    else
+      date.to_date.strftime('%Y-%m-%d')
+    end
+  end
+
+  # Public: Class used to call the Transactions product.
+  class Transactions
+    def initialize(client)
+      @client = client
+    end
+
+    # Public: Get information about transactions
+    #
+    # Does a POST /transactions/get call which gives you high level account data along
+    # with transactions from all accounts contained in the access_token's item
+    #
+    # access_token - access_token who's item to fetch transactions for
+    # start_date   - Start of query for transactions
+    # end_date     - End of query for transactions
+    # account_ids  - Specific account ids to fetch balances for (optional)
+    # count        - Amount of transactions to pull (optional)
+    # offset       - Offset to start pulling transactions (optional)
+    # options      - Additional options to merge into API request
+    #
+    # Returns a parsed JSON listing information on transactions
+    def get(access_token,
+            start_date,
+            end_date,
+            account_ids: nil,
+            count: nil,
+            offset: nil,
+            options: nil)
+      options_payload = {}
+      options_payload[:account_ids] = account_ids unless account_ids.nil?
+      options_payload[:count] = count unless count.nil?
+      options_payload[:offset] = offset unless offset.nil?
+      options_payload = options_payload.merge(options) unless options.nil?
+
+      payload = { access_token: access_token,
+                  start_date: Plaid.convert_to_date_string(start_date),
+                  end_date: Plaid.convert_to_date_string(end_date),
+                  options: options_payload }
+      @client.post_with_auth('transactions/get', payload)
+    end
+
+    # Public: Deactivate transactions for given access_token.
+    #
+    # Does a POST /transactions/deactivate call which deactivates the transaction product
+    # for a given access_token
+    #
+    # access_token - access_token to deactivate transactions for
+    #
+    # Returns a parsed JSON containing a message describing deactivation success.
+    def deactivate(access_token)
+      payload = { access_token: access_token }
+      @client.post_with_auth('transactions/deactivate', payload)
+    end
+  end
+end

data/lib/plaid/version.rb

@@ -1,3 +1,3 @@
 module Plaid
-  VERSION = '3.0.0'.freeze
+  VERSION = '4.0.0'.freeze
 end

data/plaid.gemspec

@@ -6,16 +6,25 @@ require 'plaid/version'
 Gem::Specification.new do |spec|
   spec.name          = 'plaid'
   spec.version       = Plaid::VERSION
-  spec.authors       = ['Oleg Dashevskii']
-  spec.email         = ['olegdashevskii@gmail.com']
+  spec.authors       = ['Edmund Loo']
+  spec.email         = ['eloo@plaid.com']
 
   spec.summary       = 'Ruby bindings for Plaid'
   spec.description   = 'Ruby gem wrapper for the Plaid API. Read more at the ' \
                        'homepage, the wiki, or in the Plaid documentation.'
-  spec.homepage      = 'https://github.com/plaid/plaid-ruby'
+  spec.homepage      = 'https://plaid.com/'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test/|\.gitignore|\.travis)})
   end
 
@@ -25,12 +34,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency 'multi_json', '~> 1.0'
-
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'sdoc', '~> 0.4.1'
-  spec.add_development_dependency 'pry', '~> 0.10.3'
-  spec.add_development_dependency 'webmock', '~> 2.0.0'
   spec.add_development_dependency 'minitest', '~> 5.8'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
-- Oleg Dashevskii
+- Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.10.3
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -111,39 +69,41 @@ dependencies:
 description: Ruby gem wrapper for the Plaid API. Read more at the homepage, the wiki,
   or in the Plaid documentation.
 email:
-- olegdashevskii@gmail.com
+- eloo@plaid.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
-- LICENSE
+- LICENSE.txt
 - README.md
 - Rakefile
-- UPGRADING.md
 - bin/console
 - bin/setup
+- circle.yml
 - lib/plaid.rb
-- lib/plaid/account.rb
-- lib/plaid/category.rb
 - lib/plaid/client.rb
-- lib/plaid/connector.rb
+- lib/plaid/connect.rb
 - lib/plaid/errors.rb
-- lib/plaid/income.rb
-- lib/plaid/info.rb
-- lib/plaid/institution.rb
-- lib/plaid/risk.rb
-- lib/plaid/transaction.rb
-- lib/plaid/user.rb
+- lib/plaid/products/accounts.rb
+- lib/plaid/products/auth.rb
+- lib/plaid/products/categories.rb
+- lib/plaid/products/credit_details.rb
+- lib/plaid/products/identity.rb
+- lib/plaid/products/income.rb
+- lib/plaid/products/institutions.rb
+- lib/plaid/products/item.rb
+- lib/plaid/products/processor.rb
+- lib/plaid/products/sandbox.rb
+- lib/plaid/products/transactions.rb
 - lib/plaid/version.rb
-- lib/plaid/webhook.rb
 - plaid.gemspec
-homepage: https://github.com/plaid/plaid-ruby
+homepage: https://plaid.com/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:

data/CHANGELOG.md

@@ -1,34 +0,0 @@
-# 3.0.0. 17-Jan-2017
-
-* Add `/institutions/all` and `/institutions/all/search` endpoints, see [UPGRADING.md](UPGRADING.md#upgrading-from-2xx-to-300)
-
-# 2.2.0. 03-Nov-2016
-
-* Add `Transaction#reference_number` (@ericbirdsall).
-* Fix webhook codes and add risk and income webhooks.
-
-# 2.1.0. 19-Oct-2016
-
-* Documentation fixes (@ishmael).
-* Fix `Transaction#to_s` behavior (@michel-tricot).
-* PATCH `/:product/step` flow.
-* Use the same client in `User#upgrade` (@betesh).
-* Webhook object (@zshannon).
-* `processor_token` access in `User.exchange_token` (@gylaz).
-* Raise `ServerError` in case server returned an empty response body.
-
-# 2.0.0. 24-May-2016
-
-* Use `~> 1.0` spec for multi_json dependency.
-* Support `stripe_bank_account_token` in `User.exchange_token`.
-
-# 2.0.0.alpha.2. 14-May-2016
-
-* Use `:production` instead of `:api` to signify production environment
-  in `Plaid::Client#env=`.
-* `User#mfa_step` allows to specify options now (thanks @gcweeks).
-* Implemented `User#update_webhook`.
-
-# 2.0.0.alpha. 06-May-2016
-
-* Rewrite everything.

data/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Plaid Technologies, Inc.
-
-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/UPGRADING.md

@@ -1,60 +0,0 @@
-## Upgrading from 2.x.x to 3.0.0
-
-Version 3.0.0 makes `Plaid::Institution` use new `institutions/all` endpoint
-of Plaid API which unites "native" and "long tail" institutions.
-`Plaid::LongTailInstitution` class is removed, its functionality is
-concentrated in `Plaid::Institution`.
-
-Use `Plaid::Institution.all` instead of `Plaid::LongTailInstitution.all` (the
-semantics is the same, with added products param).
-
-Use `Plaid::Institution.search` instead of `Plaid::LongTailInstitution.search`.
-
-Use `Plaid::Institution.search_by_id` instead of `Plaid::LongTailInstitution.get`.
-
-
-## Upgrading from 1.x to 2.0.0
-
-Make sure you use Ruby 2.0 or higher.
-
-Update the `Plaid.config` block:
-
-```ruby
-Plaid.config do |p|
-  p.client_id = '<<< Plaid provided client ID >>>'  # WAS: customer_id
-  p.secret = '<<< Plaid provided secret key >>>'    # No change
-  p.env = :tartan  # or :api for production         # WAS: environment_location
-end
-```
-
-Use `Plaid::User.create` instead of `Plaid.add_user` (**NOTE**: parameter order has changed!)
-
-Use `Plaid::User.load` instead of `Plaid.set_user` (**NOTE**: parameter order has changed!)
-
-Use `Plaid::User.exchange_token` instead of `Plaid.exchange_token` (**NOTE**: parameter list has changed!)
-
-Use `Plaid::User.create` or (`.load`) and `Plaid::User#transactions` instead of `Plaid.transactions`.
-
-Use `Plaid::Institution.all` and `Plaid::Institution.get` instead of `Plaid.institution`.
-
-Use `Plaid::Category.all` and `Plaid::Category.get` instead of `Plaid.category`.
-
-`Plaid::Account#institution_type` was renamed to `Plaid::Account#institution`.
-
-`Plaid::Transaction#account` was renamed to `Plaid::Transaction#account_id`.
-
-`Plaid::Transaction#date` is a Date, not a String object now.
-
-`Plaid::Transaction#cat` was removed. Use `Plaid::Transaction#category_hierarchy` and `Plaid::Transaction#category_id` directly.
-
-`Plaid::Transaction#category` was renamed to `Plaid::Transaction#category_hierarchy`.
-
-`Plaid::Transaction#pending_transaction` was renamed to `Plaid::Transaction#pending_transaction_id`.
-
-Use `Plaid::User#mfa_step` instead of `Plaid::User#select_mfa_method` and `Plaid::User#mfa_authentication`.
-
-`Plaid::User#permit?` was removed. You don't need this.
-
-`Plaid::User.delete_user` was renamed to `Plaid::User.delete`.
-
-**NOTE** that Symbols are now consistently used instead of Strings as product names, keys in hashes, etc. Look at the docs, they have all the examples.