plaid-legacy 3.0.0

data/lib/plaid/version.rb

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

data/lib/plaid/webhook.rb

@@ -0,0 +1,153 @@
+module Plaid
+  # Public: Representation of a webhook.
+  class Webhook
+    # Public: The String human readable explanation of this webhook request.
+    # E.g. "Initial transaction pull finished".
+    attr_reader :message
+
+    # Public: The String access token for authenticated user.
+    attr_reader :access_token
+
+    # Public: The Integer number of transactions available in Plaid.
+    # E.g. 124
+    attr_reader :total_transactions
+
+    # Public: The Integer code denoting the type of webhook this is. E.g. 0
+    attr_reader :code
+
+    # Public: Initialize a Webhook instance.
+    #
+    # fields - The Hash with fields.
+    def initialize(fields)
+      @message = fields['message']
+      @access_token = fields['access_token']
+      @total_transactions = fields['total_transactions']
+      @code = fields['code']
+      # present only for Removed Transaction Webhook
+      @removed_transactions = fields['removed_transactions']
+      # present only for Error Response Webhook
+      @resolve = fields['resolve']
+    end
+
+    # Public: Share the type of Webhook this is from its code
+    #
+    # Returns String webhook type
+    def type
+      Webhook::CODEX[code] || 'ERROR_RESPONSE'
+    end
+
+    # Public: Detect if the webhook is Initial Transaction Webhook. Occurs
+    # once the initial transaction pull has finished.
+    #
+    # Returns true if it is.
+    def initial_transaction?
+      code == Webhook::INITIAL_TRANSACTION
+    end
+
+    # Public: Detect if the webhook is Historical Transaction Webhook. Occurs
+    # once the historical transaction pull has completed, shortly after the
+    # initial transaction pull.
+    #
+    # Returns true if it is.
+    def historical_transaction?
+      code == Webhook::HISTORICAL_TRANSACTION
+    end
+
+    # Public: Detect if the webhook is Normal Transaction Webhook. Occurs at
+    # set intervals throughout the day as data is updated from the financial
+    # institutions.
+    #
+    # Returns true if it is.
+    def normal_transaction?
+      code == Webhook::NORMAL_TRANSACTION
+    end
+
+    # Public: Detect if the webhook is Removed Transaction Webhook. Occurs when
+    # transactions have been removed from our system.
+    #
+    # Returns true if it is.
+    def removed_transaction?
+      code == Webhook::REMOVED_TRANSACTION
+    end
+
+    # Public: Detect if the webhook is User's Webhook Updated. Occurs when an
+    # user's webhook is updated via a PATCH request without credentials.
+    #
+    # Returns true if it is.
+    def user_webhook_updated?
+      code == Webhook::USER_WEBHOOK_UPDATED
+    end
+
+    # Public: Detect if the webhook is Income. Occurs when Income data is ready.
+    #
+    # Returns true if it is.
+    def income?
+      code == Webhook::INCOME
+    end
+
+    # Public: Detect if the webhook is Risk. Occurs when Risk data is ready.
+    #
+    # Returns true if it is.
+    def risk?
+      code == Webhook::RISK
+    end
+
+    # Public: Detect if the webhook is Error Response Webhook. Triggered when
+    # an error has occurred. Includes the relevant Plaid error code with
+    # details on both the error type and steps for error resolution.
+    #
+    # Returns true if it is.
+    def error_response?
+      Webhook::CODEX[code].nil?
+    end
+
+    # Public: Get transaction IDs that were removed.
+    #
+    # Returns Array[String] or nil
+    def removed_transactions_ids
+      @removed_transactions
+    end
+
+    # Public: Get a Plaid::Error instance if this is an Error Response Webhook
+    #
+    # Returns Plaid::Error or nil
+    def error
+      if error_response?
+        Plaid::PlaidError.new @code, @message, @resolve
+      end
+    end
+
+    # Public: Get a String representation of the transaction.
+    #
+    # Returns a String.
+    def inspect
+      "#<Plaid::Webhook type=#{type.inspect} code=#{code.inspect}, access_token=#{access_token.inspect}, " \
+      "total_transactions=#{total_transactions.inspect}, message=#{message.inspect}>"
+    end
+
+    # Public: Get a String representation of the transaction.
+    #
+    # Returns a String.
+    alias to_s inspect
+
+    private
+
+    ERROR_RESPONSE = -1
+
+    codex = {}
+    {
+      'initial transaction'    => 0,
+      'historical transaction' => 1,
+      'normal transaction'     => 2,
+      'removed transaction'    => 3,
+      'user webhook updated'   => 4,
+      'income'                 => 10,
+      'risk'                   => 20
+    }.each do |event, idx|
+      name = event.split.map(&:upcase).join('_')
+      codex[idx] = name
+      const_set name, idx
+    end
+    CODEX = codex.freeze
+  end
+end

data/plaid-legacy.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plaid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'plaid-legacy'
+  spec.version       = Plaid::VERSION
+  spec.authors       = ['Oleg Dashevskii']
+  spec.email         = ['olegdashevskii@gmail.com']
+
+  spec.summary       = 'Ruby bindings for Plaid\'s legacy API'
+  spec.description   = 'Ruby gem wrapper for the Plaid\'s legacy API. Read more at the ' \
+                       'homepage, the wiki, or in the Plaid documentation.'
+  spec.homepage      = 'https://github.com/plaid/plaid-ruby-legacy'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test/|\.gitignore|\.travis)})
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  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

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: plaid-legacy
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Oleg Dashevskii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-08 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  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: sdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: Ruby gem wrapper for the Plaid's legacy API. Read more at the homepage,
+  the wiki, or in the Plaid documentation.
+email:
+- olegdashevskii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- UPGRADING.md
+- bin/console
+- bin/setup
+- lib/plaid.rb
+- lib/plaid/account.rb
+- lib/plaid/category.rb
+- lib/plaid/client.rb
+- lib/plaid/connector.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/version.rb
+- lib/plaid/webhook.rb
+- plaid-legacy.gemspec
+homepage: https://github.com/plaid/plaid-ruby-legacy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby bindings for Plaid's legacy API
+test_files: []