plaid 3.0.0 → 4.0.0

data/lib/plaid/account.rb

@@ -1,144 +0,0 @@
-require 'plaid/risk'
-
-module Plaid
-  # Public: Representation of user account data.
-  class Account
-    # Public: The String unique ID of the account. E.g.
-    # "QPO8Jo8vdDHMepg41PBwckXm4KdK1yUdmXOwK".
-    attr_reader :id
-
-    # Public: The String account ID unique to the accounts of a particular
-    # access token. E.g. "KdDjmojBERUKx3JkDd9RuxA5EvejA4SENO4AA".
-    attr_reader :item_id
-
-    # Public: The Float value of the current balance for the account.
-    attr_reader :current_balance
-
-    # Public: The Float value of the available balance for the account.
-    #
-    # The Available Balance is the Current Balance less any outstanding holds
-    # or debits that have not yet posted to the account. Note that not all
-    # institutions calculate the Available Balance. In the case that Available
-    # Balance is unavailable from the institution, Plaid will either return an
-    # Available Balance value of null or only return a Current Balance.
-    attr_reader :available_balance
-
-    # Public: The Symbol institution type, e.g. :wells.
-    attr_reader :institution
-
-    # Public: The Hash with additional information pertaining to the account
-    # such as the limit, name, or last few digits of the account number. E.g.
-    # {"name": "Plaid Savings", "number": "9606" }.
-    attr_reader :meta
-
-    # Public: The Symbol account type. One of :depository, :credit, :loan,
-    # :mortgage, :brokerage, and :other.
-    attr_reader :type
-
-    # Public: The String account subtype. E.g. "savings".
-    #
-    # Read more about subtypes in the Plaid API docs.
-    attr_reader :subtype
-
-    # Public: The Hash with account and routing numbers for the account.
-    #
-    # This attribute would be nil unless you used Auth product for the user.
-    #
-    # The Hash contains Symbol keys and String values. E.g.
-    # {routing: "021000021", account: "9900009606", wireRouting: "021000021"}.
-    attr_reader :numbers
-
-    # Public: The Risk information associated with the account.
-    #
-    # This attribute would be nil unless you used Risk product for the user.
-    attr_reader :risk
-
-    def initialize(hash)
-      @id          = hash['_id']
-      @item_id     = hash['_item']
-      @meta        = hash['meta']
-      @type        = hash['type'].to_sym
-      @subtype     = hash['subtype']
-      @institution = hash['institution_type'].to_sym
-
-      unless (bal = hash['balance']).nil?
-        @available_balance = bal['available']
-        @current_balance   = bal['current']
-      end
-
-      if (risk = hash['risk'])
-        @risk = Plaid::Risk.new(risk)
-      end
-
-      @numbers = Plaid.symbolize_hash(hash['numbers'])
-    end
-
-    # Public: Get a String representation of the account.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Account id=#{id.inspect}, type=#{type.inspect}, " \
-      "name=#{name.inspect}, institution=#{institution.inspect}>"
-    end
-
-    # Public: Get a String representation of the account.
-    #
-    # Returns a String.
-    alias to_s inspect
-
-    # Public: Get the account name.
-    #
-    # The name is obtained from #meta Hash.
-    #
-    # Returns the String name.
-    def name
-      meta && meta['name']
-    end
-
-    # Internal: Merge account information.
-    #
-    # accounts     - The Array of Account instances.
-    # new_accounts - The Array of Account instances.
-    #
-    # Returns accounts.
-    def self.merge(accounts, new_accounts)
-      # Index accounts by their ID.
-      #
-      # Same as index = accounts.index_by(&:id) in ActiveSupport.
-      index = Hash[accounts.map { |a| [a.id, a] }]
-
-      new_accounts.each do |acc|
-        if (old_acc = index[acc.id])
-          old_acc.update_from(acc)
-        else
-          accounts << acc
-        end
-      end
-
-      accounts
-    end
-
-    # Internal: Update account information.
-    #
-    # All fields which are not nil in another are copied to self.
-    #
-    # another - The Account instance with new information.
-    #
-    # Returns self.
-    def update_from(another)
-      # A sanity check. Nobody would want to update information from totally
-      # different account!
-      if id != another.id
-        raise ArgumentError, 'Plaid::Account#update_from: id != another.id!'
-      end
-
-      %i(item_id meta name type subtype institution available_balance
-         current_balance numbers risk).each do |field|
-        value = another.send(field)
-        instance_variable_set("@#{field}", value) unless value.nil?
-      end
-
-      self
-    end
-  end
-end

data/lib/plaid/category.rb

@@ -1,62 +0,0 @@
-module Plaid
-  # Public: A class which encapsulates information about a Plaid category.
-  class Category
-    # Public: The String category ID, e.g. "21010006".
-    attr_reader :id
-
-    # Public: The Symbol category type. One of :special, :place, :digital.
-    attr_reader :type
-
-    # Public: The Array of String hierarchy. E.g.
-    # ["Food and Drink", "Nightlife"].
-    attr_reader :hierarchy
-
-    # Internal: Initialize a Category with given fields.
-    def initialize(fields)
-      @type = fields['type'].to_sym
-      @hierarchy = fields['hierarchy']
-      @id = fields['id']
-    end
-
-    # Public: Get a String representation of Category.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Category id=#{id.inspect}, type=#{type.inspect}, " \
-      "hierarchy=#{hierarchy.inspect}>"
-    end
-
-    # Public: Get a String representation of Category.
-    #
-    # Returns a String.
-    alias to_s inspect
-
-    # Public: Get information about all available categories.
-    #
-    # Does a GET /categories call.
-    #
-    # client - The Plaid::Client instance used to connect
-    #          (default: Plaid.client).
-    #
-    # Returns an Array of Category instances.
-    def self.all(client: nil)
-      Connector.new(:categories, client: client).get.map do |category_data|
-        new(category_data)
-      end
-    end
-
-    # Public: Get information about a given category.
-    #
-    # Does a GET /categories/:id call.
-    #
-    # id     - the String category ID (e.g. "17001013").
-    # client - The Plaid::Client instance used to connect
-    #          (default: Plaid.client).
-    #
-    # Returns a Category instance or raises Plaid::NotFoundError if category
-    # with given id is not found.
-    def self.get(id, client: nil)
-      new Connector.new(:categories, id, client: client).get
-    end
-  end
-end

data/lib/plaid/connector.rb

@@ -1,172 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'multi_json'
-
-module Plaid
-  # Internal: A class encapsulating HTTP requests to the Plaid API servers
-  class Connector
-    attr_reader :uri, :http, :request, :response, :body
-
-    # Internal: Default read timeout for HTTP calls.
-    DEFAULT_TIMEOUT = 120
-
-    # Internal: Prepare to run request.
-    #
-    # path    - The String path without leading slash. E.g. 'connect'
-    # subpath - The String subpath. E.g. 'get'
-    # auth    - The Boolean flag indicating that client_id and secret should be
-    #           included into the request payload.
-    # client  - The Plaid::Client instance used to connect
-    #           (default: Plaid.client).
-    def initialize(path, subpath = nil, auth: false, client: nil)
-      @auth = auth
-      @client = client || Plaid.client
-      verify_configuration
-
-      path = File.join(@client.env, path.to_s)
-      path = File.join(path, subpath.to_s) if subpath
-
-      @uri = URI.parse(path)
-
-      @http = Net::HTTP.new(@uri.host, @uri.port)
-      @http.use_ssl = true
-
-      @http.read_timeout = Plaid.read_timeout || DEFAULT_TIMEOUT
-    end
-
-    # Internal: Run GET request.
-    #
-    # Returns the parsed JSON response body.
-    def get(payload = {})
-      payload = with_credentials(payload)
-
-      @uri.query = URI.encode_www_form(payload) unless payload.empty?
-
-      run Net::HTTP::Get.new(@uri)
-    end
-
-    # Internal: Run POST request.
-    #
-    # Adds client_id and secret to the payload if @auth is true.
-    #
-    # payload - The Hash with data.
-    #
-    # Returns the parsed JSON response body.
-    def post(payload)
-      post_like payload, Net::HTTP::Post.new(@uri.path)
-    end
-
-    # Internal: Run PATCH request.
-    #
-    # Adds client_id and secret to the payload if @auth is true.
-    #
-    # payload - The Hash with data.
-    #
-    # Returns the parsed JSON response body.
-    def patch(payload)
-      post_like payload, Net::HTTP::Patch.new(@uri.path)
-    end
-
-    # Internal: Run DELETE request.
-    #
-    # Adds client_id and secret to the payload if @auth is true.
-    #
-    # payload - The Hash with data.
-    #
-    # Returns the parsed JSON response body.
-    def delete(payload)
-      post_like payload, Net::HTTP::Delete.new(@uri.path)
-    end
-
-    # Internal: Check if MFA response received.
-    #
-    # Returns true if response has code 201.
-    def mfa?
-      @response.is_a?(Net::HTTPCreated)
-    end
-
-    private
-
-    # Internal: Run the request and process the response.
-    #
-    # Returns the parsed JSON body or raises an appropriate exception (a
-    # descendant of Plaid::PlaidError).
-    def run(request)
-      @request = request
-      @response = http.request(@request)
-
-      if @response.body.nil? || @response.body.empty?
-        raise Plaid::ServerError.new(0, 'Server error', 'Try to connect later')
-      end
-
-      # All responses are expected to have a JSON body, so we always parse,
-      # not looking at the status code.
-      @body = MultiJson.load(@response.body)
-
-      case @response
-      when Net::HTTPSuccess, Net::HTTPCreated
-        @body
-      else
-        raise_error
-      end
-    end
-
-    # Internal: Run POST-like request.
-    #
-    # payload - The Hash with posted data.
-    # request - The Net::HTTPGenericRequest descendant instance.
-    def post_like(payload, request)
-      request.set_form_data(with_credentials(payload))
-
-      run request
-    end
-
-    # Internal: Raise an error with the class depending on @response.
-    #
-    # Returns an Array with arguments.
-    def raise_error
-      klass = case @response
-              when Net::HTTPBadRequest then Plaid::BadRequestError
-              when Net::HTTPUnauthorized then Plaid::UnauthorizedError
-              when Net::HTTPPaymentRequired then Plaid::RequestFailedError
-              when Net::HTTPNotFound then Plaid::NotFoundError
-              else
-                Plaid::ServerError
-              end
-
-      raise klass.new(body['code'], body['message'], body['resolve'])
-    end
-
-    # Internal: Verify that Plaid environment is properly configured.
-    #
-    # Raises NotConfiguredError if anything is wrong.
-    def verify_configuration
-      raise_not_configured(:env, auth: false) unless @client.env
-      return unless @auth
-
-      !@client.client_id_configured? && raise_not_configured(:client_id)
-      !@client.secret_configured? && raise_not_configured(:secret)
-    end
-
-    # Internal: Raise a NotConfiguredError exception with proper message.
-    def raise_not_configured(field, auth: true)
-      message = "You must set Plaid::Client.#{field} before using any methods"
-      message << ' which require authentication' if auth
-      message << "! It's current value is #{@client.send(field).inspect}. " \
-                 'E.g. add a Plaid.config do .. end block somewhere in the ' \
-                 'initialization code of your program.'
-
-      raise NotConfiguredError, message
-    end
-
-    # Internal: Merge credentials to the payload if needed.
-    def with_credentials(payload)
-      if @auth
-        payload.merge(client_id: @client.client_id,
-                      secret: @client.secret)
-      else
-        payload
-      end
-    end
-  end
-end

data/lib/plaid/income.rb

@@ -1,106 +0,0 @@
-module Plaid
-  # Public: Representation of Income data.
-  class Income
-    # Public: The class encapsulating an income stream.
-    class Stream
-      # Public: The Float monthly income associated with the income stream.
-      # E.g. 5700.
-      attr_reader :monthly_income
-
-      # Public: The Float representation of Plaid's confidence in the income
-      # data associated with this particular income stream, with 0 being
-      # the lowest confidence and 1 being the highest. E.g. 0.9.
-      attr_reader :confidence
-
-      # Public: The Integer extent of data found for this income stream.
-      # E.g. 314.
-      attr_reader :days
-
-      # Public: The String name of the entity associated with this income
-      # stream. E.g. "APPLE INC".
-      attr_reader :name
-
-      # Internal: Initialize a Stream.
-      #
-      # fields - The Hash with fields (keys are Strings).
-      def initialize(fields)
-        @monthly_income = fields['monthly_income']
-        @confidence = fields['confidence']
-        @days = fields['days']
-        @name = fields['name']
-      end
-
-      # Public: Get a String representation of the Stream.
-      #
-      # Returns a String.
-      def inspect
-        "#<Plaid::Income::Stream name=#{name.inspect}, " \
-          "monthly_income=#{monthly_income.inspect}, " \
-          "confidence=#{confidence.inspect}, " \
-          "days=#{days.inspect}>"
-      end
-
-      # Public: Get a String representation of the Stream.
-      #
-      # Returns a String.
-      alias to_s inspect
-    end
-
-    # Public: The Array of Stream.
-    attr_reader :income_streams
-
-    # Public: The Numeric sum of user's income over the past 365 days. If Plaid
-    # has less than 365 days of data this will be less than a full year income.
-    # E.g. 67000.
-    attr_reader :last_year_income
-
-    # Public: The last_year_income interpolated to value before taxes. This is
-    # the minimum pre-tax salary that assumes a filing status of single with
-    # zero dependents. E.g. 73700.
-    attr_reader :last_year_income_before_tax
-
-    # Public: The Numeric user's income extrapolated over a year based on
-    # current, active income streams. Income streams become inactive if they
-    # have not recurred for more than two cycles. For example, if a weekly
-    # paycheck hasn't been seen for the past two weeks, it is no longer active.
-    # E.g. 69800.
-    attr_reader :projected_yearly_income
-
-    # Public: The projected_yearly_income interpolated to value before taxes.
-    # This is the minimum pre-tax salary that assumes a filing status of single
-    # with zero dependents. E.g. 75600.
-    attr_reader :projected_yearly_income_before_tax
-
-    # Public: The Integer max number of income streams present at the same time
-    # over the past 365 days. E.g. 314.
-    attr_reader :max_number_of_overlapping_income_streams
-
-    # Public: The Integer total number of distinct income streams received over
-    # the past 365 days. E.g. 2.
-    attr_reader :number_of_income_streams
-
-    def initialize(fields)
-      @income_streams = fields['income_streams'].map { |is| Stream.new(is) }
-
-      %w(last_year_income last_year_income_before_tax projected_yearly_income
-         projected_yearly_income_before_tax number_of_income_streams
-         max_number_of_overlapping_income_streams).each do |field|
-        instance_variable_set "@#{field}", fields[field]
-      end
-    end
-
-    # Public: Get a String representation of Income.
-    #
-    # Returns a String.
-    def inspect
-      "#<Plaid::Income last_year_income=#{last_year_income.inspect}, " \
-        "projected_yearly_income=#{projected_yearly_income.inspect}, " \
-        "number_of_income_streams=#{number_of_income_streams.inspect}, ...>"
-    end
-
-    # Public: Get a String representation of Income.
-    #
-    # Returns a String.
-    alias to_s inspect
-  end
-end