plaid 4.1.0 → 5.0.0

data/lib/plaid/products/accounts.rb

@@ -1,41 +1,33 @@
 module Plaid
   # Public: Class used to call the Balance product.
-  class Balance
-    def initialize(client)
-      @client = client
-    end
-
+  class Balance < BaseProduct
     # Public: Get information about all available balances.
     #
-    # Does a POST /accounts/balance/get call to get real-time balance information for all
-    # accounts associated with the access_token's item
+    # Does a POST /accounts/balance/get call to get real-time balance
+    # information for all accounts associated with the access_token's item.
     #
-    # access_token - access_token who's item to fetch balances for
-    # account_ids  - Specific account ids to fetch balances for (optional)
-    # options      - Additional options to be merged into API request
+    # access_token - The String access_token for the item to fetch balances
+    #                for.
+    # account_ids  - The Array with specific account IDs to fetch balances for
+    #                (optional).
+    # options      - Additional options to be merged into the request
+    #                (optional).
     #
-    # Returns a parsed JSON of balance response
+    # Returns the AccountsResponse object with accounts information.
     def get(access_token, account_ids: nil, options: nil)
-      options_payload = {}
-      options_payload[:account_ids] = account_ids unless account_ids.nil?
-      options_payload = options_payload.merge(options) unless options.nil?
-
-      payload = { access_token: access_token,
-                  options: options_payload }
-      @client.post_with_auth('accounts/balance/get', payload)
+      post_with_auth 'accounts/balance/get',
+                     AccountsResponse,
+                     build_payload(access_token,
+                                   account_ids: account_ids,
+                                   options: options)
     end
   end
 
   # Public: Class used to call the Accounts product.
-  class Accounts
-    # Public: Memoized class instance to make requests from Plaid::Balance
-    def balance
-      @balance ||= Plaid::Balance.new(@client)
-    end
-
-    def initialize(client)
-      @client = client
-    end
+  class Accounts < BaseProduct
+    ##
+    # Public: The Plaid::Balance product accessor.
+    subproduct :balance
 
     # Public: Get information about all available accounts.
     #
@@ -46,15 +38,26 @@ module Plaid
     # account_ids  - Specific account ids to fetch accounts for (optional)
     # options      - Additional options to be merged into API request
     #
-    # Returns a parsed JSON of account information
+    # Returns the AccountsResponse object with accounts information.
     def get(access_token, account_ids: nil, options: nil)
-      options_payload = {}
-      options_payload[:account_ids] = account_ids unless account_ids.nil?
-      options_payload = options_payload.merge(options) unless options.nil?
-
-      payload = { access_token: access_token,
-                  options: options_payload }
-      @client.post_with_auth('accounts/get', payload)
+      post_with_auth 'accounts/get',
+                     AccountsResponse,
+                     build_payload(access_token,
+                                   account_ids: account_ids,
+                                   options: options)
     end
   end
+
+  # Public: The response wrapper for /accounts/get and /accounts/balance/get.
+  class AccountsResponse < 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]
+  end
 end

data/lib/plaid/products/auth.rb

@@ -1,29 +1,42 @@
 module Plaid
   # Public: Class used to call the Auth product.
-  class Auth
-    def initialize(client)
-      @client = client
-    end
-
+  class Auth < BaseProduct
     # Public: Get information about account and routing numbers for checking
-    # and savings accounts
+    # and savings accounts.
     #
-    # Does a POST /auth/get call which returns high level account information along with
-    # account and routing numbers for checking and savings accounts
+    # Does a POST /auth/get call which returns high level account information
+    # along with account and routing numbers for checking and savings
+    # accounts.
     #
-    # access_token - access_token who's item to fetch Auth for
-    # account_ids  - Specific account ids to fetch numbers for (optional)
-    # options      - Additional options to merge into API request
+    # access_token - access_token who's item to fetch Auth for.
+    # account_ids  - Specific account ids to fetch numbers for (optional).
+    # options      - Additional options to merge into API request.
     #
-    # Returns a parsed JSON of Auth information
+    # Returns AuthResponse.
     def get(access_token, account_ids: nil, options: nil)
-      options_payload = {}
-      options_payload[:account_ids] = account_ids unless account_ids.nil?
-      options_payload = options_payload.merge(options) unless options.nil?
-
-      payload = { access_token: access_token,
-                  options: options_payload }
-      @client.post_with_auth('auth/get', payload)
+      post_with_auth 'auth/get',
+                     AuthResponse,
+                     build_payload(access_token,
+                                   account_ids: account_ids,
+                                   options: options)
     end
   end
+
+  # Public: Response wrapper for /accounts/get and /accounts/balance/get
+  class AuthResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The list of accounts: Array of Plaid::Models::Account.
+    property :accounts, coerce: Array[Models::Account]
+
+    ##
+    # :attr_reader:
+    # Public: The list of account numbers: Array of Plaid::Models::Number.
+    property :numbers, coerce: Array[Models::Number]
+
+    ##
+    # :attr_reader:
+    # Public: The item: Plaid::Models::Item.
+    property :item, coerce: Models::Item
+  end
 end

data/lib/plaid/products/base_product.rb

@@ -0,0 +1,69 @@
+module Plaid
+  # Internal: Support for subproduct metaprogramming
+  #
+  # Allows to write
+  #
+  #   class SomeProduct
+  #     subproduct :cool, Plaid::Cool
+  #   end
+  #
+  # You may even skip the class part:
+  #
+  #   class SomeProduct
+  #     subproduct :foo_bar
+  #   end
+  #
+  # will use Plaid::FooBar.
+  module SubproductMixin
+    def subproduct(name, klass = nil)
+      unless klass
+        class_name = name.to_s.split('_').map(&:capitalize).join
+        klass = Plaid.const_get(class_name)
+      end
+
+      define_method(name) do
+        ivar = "@#{name}"
+
+        if instance_variable_defined?(ivar)
+          instance_variable_get(ivar)
+        else
+          instance_variable_set(ivar, klass.new(client))
+        end
+      end
+    end
+  end
+
+  # Internal: The base class for all client products
+  class BaseProduct
+    def initialize(client)
+      @client = client
+    end
+
+    attr_reader :client
+
+    extend SubproductMixin
+
+    protected
+
+    # Internal: Build a simple payload with access_token, options, and
+    # account_ids.
+    def build_payload(access_token, account_ids: nil, options: nil)
+      options_payload = {}
+      options_payload[:account_ids] = account_ids unless account_ids.nil?
+      options_payload.merge!(options) unless options.nil?
+
+      { access_token: access_token,
+        options: options_payload }
+    end
+
+    # Internal: Do a POST to API and capture it into a response object.
+    def post_with_auth(path, response_class, payload)
+      response_class.new(client.post_with_auth(path, payload))
+    end
+
+    # Internal: Do a POST to API and capture it into a response object.
+    def post_with_public_key(path, response_class, payload)
+      response_class.new(client.post_with_public_key(path, payload))
+    end
+  end
+end

data/lib/plaid/products/categories.rb

@@ -1,18 +1,21 @@
 module Plaid
   # Public: Class used to call the Categories product.
-  class Categories
-    def initialize(client)
-      @client = client
-    end
-
+  class Categories < BaseProduct
     # Public: Get information about all Plaid categories
     #
     # Does a POST /categories/get call to retrieve a list of all categories.
     #
-    # Returns a parsed JSON of a list of categories
+    # Returns the CategoriesResponse object with a list of categories.
     def get
-      payload = {}
-      @client.post('categories/get', payload)
+      CategoriesResponse.new(client.post('categories/get', {}))
     end
   end
+
+  # Public: Response wrapper for /categories/get.
+  class CategoriesResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: Categories: Array of Plaid::Models::Category.
+    property :categories, coerce: Array[Models::Category]
+  end
 end

data/lib/plaid/products/credit_details.rb

@@ -1,28 +1,40 @@
 module Plaid
   # Public: Class used to call the CreditDetails product.
-  class CreditDetails
-    def initialize(client)
-      @client = client
-    end
-
-    # Public: Get information about all available credit_details
+  class CreditDetails < BaseProduct
+    # Public: Get information about all available credit_details.
     #
-    # Does a POST /credit_details/get call which fetches credit details associated with
-    # and access_token's item
+    # Does a POST /credit_details/get call which fetches credit details
+    # associated with an access_token's item.
     #
-    # access_token - access_token who's item to fetch credit_details for
-    # account_ids  - Specific account ids to fetch credit_details for (optional)
+    # access_token - access_token of an item to fetch credit details for.
+    # account_ids  - Specific account ids to fetch credit details for
+    #                (optional).
     #
-    # Returns a parsed JSON of credit_details information
+    # Returns the CreditDetailsResponse object with credit details info.
     def get(access_token, account_ids: nil)
-      options_payload = {}
-      options_payload[:account_ids] = account_ids unless account_ids.nil?
-      payload = {
-        access_token: access_token,
-        options: options_payload
-      }
-
-      @client.post_with_auth('credit_details/get', payload)
+      post_with_auth 'credit_details/get',
+                     CreditDetailsResponse,
+                     build_payload(access_token,
+                                   account_ids: account_ids)
     end
   end
+
+  # Public: Response wrapper for /credit_details/get.
+  class CreditDetailsResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The list of accounts: Array of Plaid::Models::Account.
+    property :accounts, coerce: Array[Models::Account]
+
+    ##
+    # :attr_reader:
+    # Public: The list of credit details: Array of
+    # Plaid::Models::CreditDetails.
+    property :credit_details, coerce: Array[Models::CreditDetails]
+
+    ##
+    # :attr_reader:
+    # Public: The item: Plaid::Models::Item.
+    property :item, coerce: Models::Item
+  end
 end

data/lib/plaid/products/identity.rb

@@ -1,20 +1,36 @@
 module Plaid
   # Public: Class used to call the Identity product.
-  class Identity
-    def initialize(client)
-      @client = client
-    end
-
-    # Public: Get Identity information
+  class Identity < BaseProduct
+    # Public: Get Identity information.
     #
-    # Does a POST /identity/get call to retrieve all info for a given access_token's item
+    # Does a POST /identity/get call to retrieve all info for a given
+    # access_token's item.
     #
-    # access_token - access_token who's item to fetch Identity data for
+    # access_token - access_token who's item to fetch Identity data for.
     #
-    # Returns a parsed JSON of Identity information
+    # Returns the IdentityResponse object with Identity info.
     def get(access_token)
-      payload = { access_token: access_token }
-      @client.post_with_auth('identity/get', payload)
+      post_with_auth 'identity/get',
+                     IdentityResponse,
+                     access_token: access_token
     end
   end
+
+  # Public: Response for /identity/get.
+  class IdentityResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The list of accounts: Array of Plaid::Models::Account.
+    property :accounts, coerce: Array[Models::Account]
+
+    ##
+    # :attr_reader:
+    # Public: Identity information: Plaid::Models::Identity.
+    property :identity, coerce: Models::Identity
+
+    ##
+    # :attr_reader:
+    # Public: The item: Plaid::Models::Item.
+    property :item, coerce: Models::Item
+  end
 end

data/lib/plaid/products/income.rb

@@ -1,20 +1,31 @@
 module Plaid
   # Public: Class used to call the Income product.
-  class Income
-    def initialize(client)
-      @client = client
-    end
-
-    # Public: Get information about user incomes
+  class Income < BaseProduct
+    # Public: Get information about user incomes.
     #
-    # Does a POST /income/get call which returns income info for an access_tokeni's item
+    # Does a POST /income/get call which returns income info for an
+    # access_token's item.
     #
-    # access_token - access_token who's item to fetch income for
+    # access_token - access_token whose item to fetch income for.
     #
-    # Returns a parsed JSON of income information
+    # Returns the IncomeResponse object with Income info.
     def get(access_token)
-      payload = { access_token: access_token }
-      @client.post_with_auth('income/get', payload)
+      post_with_auth 'income/get',
+                     IncomeResponse,
+                     access_token: access_token
     end
   end
+
+  # Public: Income product response.
+  class IncomeResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: The item: Plaid::Models::Item.
+    property :item, coerce: Models::Item
+
+    ##
+    # :attr_reader:
+    # Public: Income information: Plaid::Models::Income.
+    property :income, coerce: Models::Income
+  end
 end

data/lib/plaid/products/institutions.rb

@@ -1,54 +1,76 @@
 module Plaid
   # Public: Class used to call the Institutions product.
-  class Institutions
-    def initialize(client)
-      @client = client
-    end
-
-    # Public: Get information about Plaid institutions
+  class Institutions < BaseProduct
+    # Public: Get information about Plaid institutions.
     #
-    # Does a POST /institutions/get call pulls a list of supported Plaid institutions
-    # with the information for each institution
+    # Does a POST /institutions/get call pulls a list of supported Plaid
+    # institutions with the information for each institution.
     #
-    # count   - Amount of institutions to pull
-    # offset  - Offset to start pulling institutions
-    # options - Options for filtering institutions
+    # count   - Amount of institutions to pull.
+    # offset  - Offset to start pulling institutions.
+    # options - Options for filtering institutions.
     #
-    # Returns a parsed JSON of listed institution information
+    # Returns a MultipleInstitutionsResponse instance.
     def get(count:, offset:, options: nil)
       payload = { count: count,
                   offset: offset }
       payload[:options] = options unless options.nil?
 
-      @client.post_with_auth('institutions/get', payload)
+      post_with_auth 'institutions/get',
+                     MultipleInstitutionsResponse,
+                     payload
     end
 
-    # Public: Get information about a Plaid institution by ID
+    # Public: Get information about a Plaid institution by ID.
     #
     # Does a POST /institutions/get_by_id call which allows you to pull
-    # information for an institution by ID
+    # information for an institution by ID.
     #
-    # institution_id - Specific institution id to fetch information for
+    # institution_id - Specific institution id to fetch information for.
     #
-    # Returns a parsed JSON of institution info for your institution id
+    # Returns a SingleInstitutionResponse instance.
     def get_by_id(institution_id)
-      payload = { institution_id: institution_id }
-      @client.post_with_public_key('institutions/get_by_id', payload)
+      post_with_public_key 'institutions/get_by_id',
+                           SingleInstitutionResponse,
+                           institution_id: institution_id
     end
 
-    # Public: Get information about all available institutions matching your query
+    # Public: Get information about all available institutions matching your
+    # query.
     #
-    # Does a POST /institutions/search call which allows you to pull a list of institutions
-    # using a query parameter
+    # Does a POST /institutions/search call which allows you to pull a list of
+    # institutions using a query parameter.
     #
-    # query   - Search query to attempt to match institutions to
-    # producs - Product supported filter (optional)
+    # query    - Search query to attempt to match institutions to.
+    # products - Product supported filter (optional).
     #
-    # Returns a parsed JSON listing institution information
+    # Returns a MultipleInstitutionsResponse instance.
     def search(query, products = nil)
-      payload = { query: query,
-                  products: products }
-      @client.post_with_public_key('institutions/search', payload)
+      post_with_public_key 'institutions/search',
+                           MultipleInstitutionsResponse,
+                           query: query,
+                           products: products
     end
   end
+
+  # Public: Response for institutions search returning a single institution.
+  class SingleInstitutionResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: Institution info: Plaid::Models::Institution.
+    property :institution, coerce: Models::Institution
+  end
+
+  # Public: Response for institutions search returning multiple institutions.
+  class MultipleInstitutionsResponse < Models::BaseResponse
+    ##
+    # :attr_reader:
+    # Public: Institutions info: Array of Plaid::Models::Institution.
+    property :institutions, coerce: Array[Models::Institution]
+
+    ##
+    # :attr_reader:
+    # Public: The total number of search results.
+    property :total
+  end
 end