plaid 4.1.0 → 5.0.0

data/lib/plaid/products/processor.rb

@@ -1,48 +1,118 @@
 module Plaid
-  # Public: Class used to call the BankAccountToken sub-product.
-  class BankAccountToken
-    def initialize(client)
-      @client = client
-    end
+  # Public: Class used to call the Stripe sub-product.
+  class Stripe < BaseProduct
+    # Public: Class used to call the BankAccountToken sub-product.
+    class BankAccountToken < BaseProduct
+      # 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 CreateResponse object containing a Stripe bank account token.
+      def create(access_token, account_id)
+        post_with_auth 'processor/stripe/bank_account_token/create',
+                       CreateResponse,
+                       access_token: access_token, account_id: account_id
+      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)
+      # Public: A response for /processor/stripe/bank_account_token/create.
+      class CreateResponse < Models::BaseResponse
+        ##
+        # :attr_reader:
+        # Public: The String stripe token.
+        property :stripe_bank_account_token
+      end
     end
+
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Stripe::BankAccountToken product accessor.
+    subproduct :bank_account_token, BankAccountToken
   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)
+  # Public: A response for /processor/.../processor_token/create.
+  class ProcessorTokenResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The String processor token.
+    property :processor_token
+  end
+
+  # Public: Class used to call the Dwolla sub-product.
+  class Dwolla < BaseProduct
+    # Public: Class used to call the dwolla.processor_token subproduct
+    class ProcessorToken < BaseProduct
+      # Public: Creates a Dwolla processor token from an access_token.
+      #
+      # Does a POST /processor/dwolla/processor_token/create call which can be
+      # used to generate a Dwolla processor 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 processor token for.
+      #
+      # Returns a ProcessorTokenResponse object containing a Dwolla processor
+      # token.
+      def create(access_token, account_id)
+        post_with_auth 'processor/dwolla/processor_token/create',
+                       ProcessorTokenResponse,
+                       access_token: access_token,
+                       account_id: account_id
+      end
     end
 
-    def initialize(client)
-      @client = client
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Dwolla::ProcessorToken product accessor.
+    subproduct :processor_token, ProcessorToken
+  end
+
+  # Public: Class used to call the Apex sub-product.
+  class Apex < BaseProduct
+    # Public: Class used to call the apex.processor_token subproduct
+    class ProcessorToken < BaseProduct
+      # Public: Creates an Apex processor token from an access_token.
+      #
+      # Does a POST /processor/apex/processor_token/create call which can be
+      # used to generate an Apex processor 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 processor token for.
+      #
+      # Returns a ProcessorTokenResponse object containing an Apex processor
+      # token.
+      def create(access_token, account_id)
+        post_with_auth 'processor/apex/processor_token/create',
+                       ProcessorTokenResponse,
+                       access_token: access_token,
+                       account_id: account_id
+      end
     end
+
+    ##
+    # :attr_reader:
+    # Public: The Plaid::ApexProcessorToken product accessor.
+    subproduct :processor_token, ProcessorToken
   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
+  class Processor < BaseProduct
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Stripe product accessor.
+    subproduct :stripe
 
-    def initialize(client)
-      @client = client
-    end
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Dwolla product accessor.
+    subproduct :dwolla
+
+    ##
+    # :attr_reader:
+    # Public: The Plaid::Apex product accessor.
+    subproduct :apex
   end
 end

data/lib/plaid/products/sandbox.rb

@@ -1,32 +1,33 @@
 module Plaid
   # Public: Class used to call the SandboxItem sub-product.
-  class SandboxItem
-    def initialize(client)
-      @client = client
-    end
-
-    # Public: Resets sandbox item login
+  class SandboxItem < BaseProduct
+    # Public: Resets sandbox item login.
     #
-    # Does a POST /sandbox/item/reset_login call
+    # Does a POST /sandbox/item/reset_login call.
     #
-    # access_token - access_token who's item to reset login for
+    # access_token - access_token which item to reset login for.
     #
-    # Returns a parsed JSON of response
+    # Returns a ResetLoginResponse object.
     def reset_login(access_token)
-      payload = { access_token: access_token }
-      @client.post_with_auth('sandbox/item/reset_login', payload)
+      post_with_auth 'sandbox/item/reset_login',
+                     ResetLoginResponse,
+                     access_token: access_token
     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)
+    # Public: Response for /sandbox/item/reset_login.
+    class ResetLoginResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The Boolean reset success flag.
+      property :reset_login
     end
+  end
 
-    def initialize(client)
-      @client = client
-    end
+  # Public: Class used to call the Sandbox product.
+  class Sandbox < BaseProduct
+    ##
+    # :attr_reader:
+    # Public: The Plaid::SandboxItem product accessor.
+    subproduct :sandbox_item
   end
 end

data/lib/plaid/products/transactions.rb

@@ -1,61 +1,66 @@
 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
-
+  class Transactions < BaseProduct
     # 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
+    # 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
+    # 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)
+    # Returns GetResponse.
+    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?
+      options_payload.merge!(options) unless options.nil?
+
+      post_with_auth 'transactions/get',
+                     GetResponse,
+                     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
+    end
+
+    # Public: Response for /transactions/get.
+    class GetResponse < Models::BaseResponse
+      ##
+      # :attr_reader:
+      # Public: The item: Plaid::Models::Item.
+      property :item, coerce: Models::Item
+
+      ##
+      # :attr_reader:
+      # Public: The list of accounts: Array of Plaid::Models::Account.
+      property :accounts, coerce: Array[Models::Account]
+
+      ##
+      # :attr_reader:
+      # Public: The list of transactions: Array of Plaid::Models::Transaction.
+      property :transactions, coerce: Array[Models::Transaction]
+
+      ##
+      # :attr_reader:
+      # Public: The String last updated time (if available).
+      property :last_updated
 
-      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)
+      ##
+      # :attr_reader:
+      # Public: The Numeric total transactions count.
+      property :total_transactions
     end
   end
 end

data/lib/plaid/version.rb

@@ -1,3 +1,3 @@
 module Plaid
-  VERSION = '4.1.0'.freeze
+  VERSION = '5.0.0'.freeze
 end

data/plaid.gemspec

@@ -1,9 +1,8 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'plaid/version'
 
-Gem::Specification.new do |spec|
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.name          = 'plaid'
   spec.version       = Plaid::VERSION
   spec.authors       = ['Edmund Loo']
@@ -15,8 +14,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://plaid.com/'
   spec.license       = 'MIT'
 
-  # 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.
+  # 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
@@ -36,12 +36,14 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'hashie', '>= 3.4.3'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'rake', '>= 10.0'
-  spec.add_development_dependency 'sdoc', '~> 0.4.1'
   spec.add_development_dependency 'minitest', '~> 5.10'
   spec.add_development_dependency 'minitest-around', '~> 0.4.0'
-  spec.add_development_dependency 'vcr', '~> 3.0.3'
+  spec.add_development_dependency 'rake', '>= 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.53.0'
+  spec.add_development_dependency 'sdoc', '~> 1.0.0'
+  spec.add_development_dependency 'vcr', '~> 4.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Edmund Loo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -67,75 +81,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.10'
 - !ruby/object:Gem::Dependency
-  name: sdoc
+  name: minitest-around
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
-  name: minitest-around
+  name: sdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.3
+        version: 4.0.0
 description: Ruby gem wrapper for the Plaid API. Read more at the homepage, the wiki,
   or in the Plaid documentation.
 email:
@@ -144,10 +172,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".env.sample"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - PUBLISHING.md
 - README.md
@@ -155,13 +186,14 @@ files:
 - UPGRADING.md
 - bin/console
 - bin/setup
-- circle.yml
 - lib/plaid.rb
 - lib/plaid/client.rb
 - lib/plaid/errors.rb
 - lib/plaid/middleware.rb
+- lib/plaid/models.rb
 - lib/plaid/products/accounts.rb
 - lib/plaid/products/auth.rb
+- lib/plaid/products/base_product.rb
 - lib/plaid/products/categories.rb
 - lib/plaid/products/credit_details.rb
 - lib/plaid/products/identity.rb