plaid 3.0.0 → 4.0.0

data/lib/plaid/info.rb

@@ -1,65 +0,0 @@
-module Plaid
-  # Public: Representation of user information.
-  class Info
-    # Public: The Array of String user names.
-    #
-    # E.g. ["Frodo Baggins", "Samwise Gamgee"].
-    attr_reader :names
-
-    # Public: The Array of Hash user emails information.
-    #
-    # E.g. [{data: "frodo.baggins@plaid.com", type: :primary}, ...]
-    attr_reader :emails
-
-    # Public: The Array of Hash user phone number information.
-    #
-    # E.g. [{data: "111-222-3456", type: :work, primary: false},
-    #       {data: "123-456-7891", type: :mobile, primary: true}]
-    attr_reader :phone_numbers
-
-    # Public: The Array of Hash user address information.
-    #
-    # E.g. [{ primary: true, data: {
-    #                          "street" => "1 Hobbit Way",
-    #                          "city" => "The Shire",
-    #                          "state" => "CA",
-    #                          "zip" => "94108"}}]
-    attr_reader :addresses
-
-    # Internal: Construct the Info object.
-    def initialize(fields)
-      @names = fields['names']
-      @emails = fields['emails'].map do |h|
-        symbolize_values Plaid.symbolize_hash(h), :type
-      end
-
-      @phone_numbers = fields['phone_numbers'].map do |h|
-        symbolize_values Plaid.symbolize_hash(h), :type
-      end
-
-      @addresses = fields['addresses'].map do |h|
-        Plaid.symbolize_hash(h)
-      end
-    end
-
-    # Public: Get a String representation of Info object.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Info names=#{names.inspect}, ...>"
-    end
-
-    # Public: Get a String representation of Info object.
-    #
-    # Returns a String.
-    alias to_s inspect
-
-    private
-
-    def symbolize_values(hash, *keys)
-      hash.each do |k, v|
-        hash[k] = v.to_sym if keys.include?(k)
-      end
-    end
-  end
-end

data/lib/plaid/institution.rb

@@ -1,253 +0,0 @@
-module Plaid
-  # Public: A class encapsulating information about a Financial Institution
-  # supported by Plaid.
-  class Institution
-    # Public: The String institution ID. E.g. "5301a93ac140de84910000e0".
-    attr_reader :id
-
-    # Public: The String institution name. E.g. "Bank of America".
-    attr_reader :name
-
-    # Public: The String institution shortname, or "type" per Plaid API docs.
-    # E.g. "bofa".
-    attr_reader :type
-
-    # Public: The Boolean flag telling if the institution requires MFA.
-    attr_reader :has_mfa
-
-    # Public: Returns true if the institution requires MFA.
-    alias has_mfa? has_mfa
-
-    # Public: The Hash with MFA options available. E.g. ["code", "list",
-    # "questions(3)"]. In this case you are allowed to request a list of
-    # possible MFA options, use code-based MFA and questions MFA (there are 3
-    # questions).
-    attr_reader :mfa
-
-    # Public: The Hash with credential labels, how they are exactly named by
-    # the institution. E.g. {"username": "Online ID", "password": "Password"}.
-    attr_reader :credentials
-
-    # Public: An Array with Symbol product names supported by the institution.
-    # E.g. [:connect, :auth, :balance, :info, :income, :risk]. See
-    # Plaid::PRODUCTS.
-    attr_reader :products
-
-    # Internal: Initialize an Institution with given fields.
-    def initialize(fields)
-      @id = fields['id']
-      @name = fields['name']
-      @type = fields['type']
-      @has_mfa = fields['has_mfa']
-      @mfa = fields['mfa']
-      @credentials = fields['credentials']
-      @products = fields['products'].map(&:to_sym)
-    end
-
-    # Public: Get a String representation of the institution.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Institution id=#{id.inspect}, type=#{type.inspect}, " \
-      "name=#{name.inspect}>"
-    end
-
-    # Public: Get a String representation of the institution.
-    #
-    # Returns a String.
-    alias to_s inspect
-
-    # Public: Get information about the Financial Institutions currently
-    # supported by Plaid.
-    #
-    # Does a POST /institutions/all call. The result is paginated (count,
-    # offset params) and filtered by products. If the products param is
-    # specified, only institutions which support all of the products mentioned
-    # will be returned.
-    #
-    # count    - The Integer number of results to retrieve (default: 50).
-    # offset   - The Integer number of results to skip forward from the
-    #            beginning of the list (default: 0).
-    # products - The Array of product Symbols (see Plaid::PRODUCTS) or nil.
-    #            E.g. [:connect, :auth]. Default: nil.
-    # client   - The Plaid::Client instance used to connect
-    #            (default: Plaid.client).
-    #
-    # Returns an Array of Institution instances.
-    def self.all(count: 50, offset: 0, products: nil, client: nil)
-      conn = Connector.new(:institutions, :all, auth: true, client: client)
-      payload = {
-        count: count,
-        offset: offset
-      }
-
-      if products
-        payload[:products] = MultiJson.encode(Array(products))
-      end
-
-      resp = conn.post(payload)
-
-      Page.new(resp['total_count'],
-               resp['results'].map { |item| new(item) })
-    end
-
-    # Public: Get information about a given Financial Institution.
-    #
-    # Does a GET /institutions/all/:id call.
-    #
-    # id     - the String institution ID (e.g. "5301a93ac140de84910000e0", or
-    #          "ins_109263").
-    # client - The Plaid::Client instance used to connect
-    #          (default: Plaid.client).
-    #
-    # Returns an Institution instance or raises Plaid::NotFoundError if
-    # institution with given id is not found.
-    def self.get(id, client: nil)
-      new Connector.new('institutions/all', id, client: client).get
-    end
-
-    # Public: Search Financial Institutions.
-    #
-    # query   - The String search query to match against the full list of
-    #           institutions. Partial matches are returned making this useful
-    #           for autocompletion purposes.
-    # product - The Symbol product name to filter by, one of Plaid::PRODUCTS
-    #           (e.g. :info, :connect, etc.). Only valid when query is
-    #           specified. If nil, results are not filtered by product
-    #           (default: nil).
-    # client  - The Plaid::Client instance used to connect
-    #           (default: Plaid.client).
-    #
-    # Returns an Array of SearchResultInstitution.
-    def self.search(query: nil, product: nil, client: nil)
-      raise ArgumentError, 'query must be specified' \
-        unless query.is_a?(String) && !query.empty?
-
-      payload = { q: query }
-      payload[:p] = product.to_s if product
-
-      resp = Connector.new('institutions/all', :search, client: client).get(payload)
-      resp.map { |inst| SearchResultInstitution.new(inst) }
-    end
-
-    # Public: Lookup a Financial Institution by ID.
-    #
-    # Does a GET /institutions/all/search call with id param.
-    #
-    # id - the String institution ID (e.g. 'bofa').
-    # client - The Plaid::Client instance used to connect
-    #          (default: Plaid.client).
-    #
-    # Returns an SearchResultInstitution instance or nil if institution with
-    # given id is not found.
-    def self.search_by_id(id, client: nil)
-      client ||= Plaid.client
-
-      # If client_id is set, use it, no authentication otherwise
-      auth = client && !client.client_id.nil?
-      conn = Connector.new('institutions/all', :search, auth: auth, client: client)
-      resp = conn.get(id: id)
-
-      case resp
-      when Hash
-        SearchResultInstitution.new resp
-      when Array
-        raise 'Non-empty array returned by /institutions/all/search with id' \
-          unless resp.empty?
-
-        nil
-      else
-        raise 'Unexpected result returned by /institutions/all/search with id: ' \
-          "#{resp.inspect}"
-      end
-    end
-  end
-
-  # Public: A page of results.
-  class Page < Array
-    # Public: The total number of institutions in all pages
-    attr_reader :total_count
-
-    def initialize(total_count, records)
-      @total_count = total_count
-      super records
-    end
-  end
-
-  # Public: A class encapsulating information about a Financial Institution
-  # supported by Plaid.
-  class SearchResultInstitution
-    # Public: The String ID of the institution. Same as type. E.g. "bofa".
-    attr_reader :id
-
-    # Public: The String short name ("type") of the institution. E.g. "bofa".
-    attr_reader :type
-
-    # Public: The String institution name. E.g. "Bank of America".
-    attr_reader :name
-
-    # Public: The Hash with supported products as keys and booleans as values.
-    #
-    # E.g. { auth: true, balance: true, connect: true, info: true }.
-    attr_reader :products
-
-    # Public: The String "forgotten password" URL.
-    attr_reader :forgotten_password_url
-
-    # Public: The String "account locked" URL.
-    attr_reader :account_locked_url
-
-    # Public: The String "account setup" URL.
-    attr_reader :account_setup_url
-
-    # Public: The String video (???).
-    attr_reader :video
-
-    # Public: The Array of Hashes with login fields information.
-    #
-    # E.g. [{ name: 'username', label: 'Online ID', type: 'text' },
-    #       { name: 'password', label: 'Password', type: 'password' }].
-    attr_reader :fields
-
-    # Public: The Hash with color information for the institution.
-    #
-    # E.g. { primary: 'rgba(220,20,48,1)',
-    #        darker: 'rgba(180,11,35,1)',
-    #        gradient: ['rgba(250,20,51,1)', 'rgba(227,24,55,1)'] }.
-    attr_reader :colors
-
-    # Public: The String with base64 encoded logo.
-    attr_reader :logo
-
-    # Public: ???.
-    attr_reader :name_break
-
-    # Internal: Initialize the SearchResultInstitution instance.
-    def initialize(hash)
-      %w(id type name video logo).each do |f|
-        instance_variable_set "@#{f}", hash[f]
-      end
-
-      @products = Plaid.symbolize_hash(hash['products'])
-      @forgotten_password_url = hash['forgottenPassword']
-      @account_locked_url = hash['accountLocked']
-      @account_setup_url = hash['accountSetup']
-      @fields = hash['fields'].map { |fld| Plaid.symbolize_hash(fld) }
-      @colors = Plaid.symbolize_hash(hash['colors'])
-      @name_break = hash['nameBreak']
-    end
-
-    # Public: Get a String representation of the institution.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::SearchResultInstitution id=#{id.inspect}, name=#{name.inspect}, " \
-        '...>'
-    end
-
-    # Public: Get a String representation of the institution.
-    #
-    # Returns a String.
-    alias to_s inspect
-  end
-end

data/lib/plaid/risk.rb

@@ -1,34 +0,0 @@
-module Plaid
-  # Public: Representation of risk data (per account).
-  class Risk
-    # Public: The Float comprehensive risk score associated with the account,
-    # where 0 is the lowest risk and 1 is the highest. E.g. 0.5.
-    attr_reader :score
-
-    # Public: The Hash with Symbol reasons and associated Float subscores
-    # contributing to the overall risk score.
-    #
-    # E.g. { transaction_amounts: 0.78, foreign_fees: 0.96, ... }.
-    attr_reader :reason
-
-    # Internal: Construct a Risk object.
-    #
-    # fields - The Hash with fields.
-    def initialize(fields)
-      @score = fields['score']
-      @reason = Plaid.symbolize_hash(fields['reason'])
-    end
-
-    # Public: Get a String representation of Risk.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Risk score=#{score.inspect}, ..."
-    end
-
-    # Public: Get a String representation of Risk.
-    #
-    # Returns a String.
-    alias to_s inspect
-  end
-end

data/lib/plaid/transaction.rb

@@ -1,128 +0,0 @@
-# coding: utf-8
-require 'date'
-
-module Plaid
-  # Public: Representation of a transaction.
-  class Transaction
-    # Public: The String unique ID of the transaction. E.g.
-    # "0AZ0De04KqsreDgVwM1RSRYjyd8yXxSDQ8Zxn".
-    attr_reader :id
-
-    # Public: The String ID of the account in which this transaction occurred.
-    # E.g. "XARE85EJqKsjxLp6XR8ocg8VakrkXpTXmRdOo".
-    attr_reader :account_id
-
-    # Public: The Date that the transaction took place.
-    # E.g. #<Date: 2016-04-28 ...>
-    attr_reader :date
-
-    # Public: The settled dollar value as Float. Positive values when
-    # money moves out of the account; negative values when money moves
-    # in. E.g. 0.10 (10 cents).
-    attr_reader :amount
-
-    # Public: The String descriptive name of the transaction. E.g.
-    # "Golden Crepes".
-    attr_reader :name
-
-    # Public: The Hash with additional information regarding the
-    # transaction. The keys are Symbols. E.g.
-    # { location: { "city": "San Francisco", "state": "CA" } }
-    attr_reader :meta
-
-    # Public: The Hash with location information obtained from the
-    # meta field. The keys are Strings.
-    #
-    # E.g. {"address" => "262 W 15th St",
-    #       "city" => "New York",
-    #       "state" => "NY",
-    #       "zip" => "10011",
-    #       "coordinates" => {
-    #         "lat" => 40.740352,
-    #         "lon" => -74.001761
-    #       }}
-    attr_reader :location
-
-    # Public: The Boolean flag which identifies the transaction as
-    # pending or unsettled.
-    attr_reader :pending
-
-    # Public: The Hash with numeric representation of Plaid confidence
-    # in the meta data attached to the transaction. In the case of a
-    # score <.9 Plaid will default to guaranteed and known
-    # information. E.g.
-    #
-    # {location: {
-    #    "address" => 1,
-    #    "city" => 1,
-    #    "state" => 1
-    #  }, name: 0.9}.
-    attr_reader :score
-
-    # Public: The Hash transaction type.
-    #
-    # E.g. {:primary => :place}.
-    attr_reader :type
-
-    # Public: The Array of String category hierarchy.
-    #
-    # E.g. ["Food and Drink", "Restaurants"].
-    attr_reader :category_hierarchy
-
-    # Public: The String Category ID.
-    #
-    # E.g. "13005000".
-    attr_reader :category_id
-
-    # Public: A String attribute that is used by the bank/payment
-    # processor to identify transactions — where applicable.
-    attr_reader :reference_number
-
-    # Public: The String ID of a posted transaction's associated
-    # pending transaction - where applicable.
-    attr_reader :pending_transaction_id
-
-    # Public: Initialize a Transaction instance.
-    #
-    # fields - The Hash with fields.
-    def initialize(fields)
-      @id = fields['_id']
-      @account_id = fields['_account']
-
-      @date = fields['date'] && Date.parse(fields['date'])
-      @amount = fields['amount']
-      @name = fields['name']
-      @meta = Plaid.symbolize_hash(fields['meta'])
-      @location = (@meta && @meta[:location]) || {}
-      @pending = fields['pending']
-      @reference_number = fields['_reference_number']
-      @pending_transaction_id = fields['_pendingTransaction']
-      @score = Plaid.symbolize_hash(fields['score'])
-
-      @type = Plaid.symbolize_hash(fields['type'], values: true)
-      @category_hierarchy = fields['category']
-      @category_id = fields['category_id']
-    end
-
-    # Public: Detect if the transaction is pending or unsettled.
-    #
-    # Returns true if it is.
-    def pending?
-      pending
-    end
-
-    # Public: Get a String representation of the transaction.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Transaction id=#{id.inspect}, account_id=#{account_id.inspect}, " \
-      "date=#{date}, amount=#{amount.inspect}, name=#{name.inspect}, " \
-      "pending=#{pending.inspect}>"
-    end
-
-    # Public: Get a String representation of the transaction.
-    #
-    # Returns a String.
-    alias to_s inspect
-  end
-end