plaid 2.0.0.alpha → 2.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c62ea201045ddda027e83f884439932f0082e16
-  data.tar.gz: ec7d5dc05c5e46d3354e4ba22bdda8991eef288a
+  metadata.gz: 97bd694d424964634d8df55cf301f6a8ab743eb4
+  data.tar.gz: 3be0c9816df8e2c5917795cb40c3f70179dc60fa
 SHA512:
-  metadata.gz: cd341de88925e995b587a8aefcc6f5a02b0943497d2f26cfe54332a733c4c75e71a82eee39afa5b17403bad198d67fb1da67e4a241c5a7ecd0443c547a0e8659
-  data.tar.gz: b5b9e8c56523456773b27f579ddbab5def4a49d551a7d28399f75cf8eb2a3d3ae2ac43c881e425ca72cf459cde18d9676a3d56e5aa4da926930227957cb1816b
+  metadata.gz: bb45ff4e878c9eaba205aabc4cfbc94f066baa62fb67f7a091427826ff58c1e7b788c8d286f0f8d762c87f5d4938cb040b941917d393699e903600f9cd4556e7
+  data.tar.gz: 22a4587c8c0677660641892f0d68a2e746a665bdd8b9e5e595afb67cb702c7e964809c01bb26168ab6e2cdb36f012b1725c74589969a3adc8232d4ff7950cb5c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.0.0.alpha.2. 14-May-2016
+
+* Use `:production` instead of `:api` to signify production environment
+  in `Plaid::Client#env=`.
+* `User#mfa_step` allows to specify options now (thanks @gcweeks).
+* Implemented `User#update_webhook`.
+
 # 2.0.0.alpha. 06-May-2016
 
 * Rewrite everything.

data/README.md

@@ -44,19 +44,19 @@ end
 user = Plaid::User.create(:connect, 'wells', 'plaid_test', 'plaid_good')
 ```
 
-This call will do a `POST /connect`. The response will contain account information and transactions 
+This call will do a `POST /connect`. The response will contain account information and transactions
 for last 30 days, which you can find in `user.accounts` and `user.initial_transactions`, accordingly.
 
 If the authentication requires a pin, you can pass it as a named parameter:
 
 ```ruby
-user = Plaid::User.create(:income, 'usaa', 'plaid_test', 'plaid_good', 'wells', pin: '1234')
+user = Plaid::User.create(:income, 'usaa', 'plaid_test', 'plaid_good', pin: '1234')
 ```
 
 To add options such as `login_only` or `webhook`, use `options` argument:
 
 ```ruby
-user = Plaid::User.create(:connect, 'wells', 'plaid_test', 'plaid_good', 
+user = Plaid::User.create(:connect, 'wells', 'plaid_test', 'plaid_good',
                           options: { login_only: true, webhook: 'https://example.org/callbacks/plaid')
 ```
 
@@ -126,7 +126,7 @@ If MFA is requested by the financial institution, the `User.create` call would b
 a bit differently:
 
 ```ruby
-user = Plaid::User.create(:auth, 'wells', 'plaid_test', 'plaid_good') 
+user = Plaid::User.create(:auth, 'wells', 'plaid_test', 'plaid_good')
 
 user.accounts   #=> nil
 user.mfa?       #=> true
@@ -145,16 +145,16 @@ user.mfa        #=> nil
 user.accounts   #=> [<Plaid::Account ...>, ...]
 ```
 
-The code-based MFA workflow is similar. Basically you need to call `user.mfa_step(...)` 
+The code-based MFA workflow is similar. Basically you need to call `user.mfa_step(...)`
 until `user.mfa?` becomes false.
 
 ### Obtaining user-related data
 
-If you have a live `User` instance, you can use following methods 
+If you have a live `User` instance, you can use following methods
 (independent of instance's current product):
 
 * `user.transactions(...)`. Makes a `/connect/get` request.
-* `user.auth(sync: false)`. Makes an `/auth/get` request. 
+* `user.auth(sync: false)`. Makes an `/auth/get` request.
 * `user.info(sync: false)`. Makes an `/info/get` request.
 * `user.income(sync: false)`. Makes an `/income/get` request.
 * `user.risk(sync: false)`. Makes an `/risk/get` request.
@@ -176,7 +176,7 @@ loaded. Otherwise cached information will be returned:
 
 ```ruby
 user = User.load(:auth, 'access_token')   # Just set the token
-user.auth                                 # POST /auth/get 
+user.auth                                 # POST /auth/get
 user.auth                                 # No POST, return cached info
 user.auth(sync: true)                     # POST /auth/get again
 ```
@@ -207,11 +207,11 @@ res  = Plaid::LongTailInstitution.search(query: 'c')         # Lookup by name
 
 ### Custom clients
 
-It's possible to use several Plaid environments and/or credentials in one app by 
+It's possible to use several Plaid environments and/or credentials in one app by
 explicit instantiation of `Plaid::Client`:
 
 ```ruby
-# Configuring the global client (Plaid.client) which is used by default 
+# Configuring the global client (Plaid.client) which is used by default
 Plaid.config do |p|
   p.client_id = 'client_id_1'
   p.secret = 'secret_1'

data/lib/plaid/client.rb

@@ -14,12 +14,14 @@ module Plaid
 
     # Public: Set Plaid environment to use.
     #
-    # env - The Symbol (:tartan, :api), or a full String URL like
+    # env - The Symbol (:tartan, :production), or a full String URL like
     #       'https://tartan.plaid.com'.
     def env=(env)
       case env
-      when :tartan, :api
-        @env = "https://#{env}.plaid.com/"
+      when :tartan
+        @env = 'https://tartan.plaid.com/'
+      when :production
+        @env = 'https://api.plaid.com/'
       when String
         begin
           URI.parse(env)
@@ -27,20 +29,20 @@ module Plaid
         rescue
           raise ArgumentError, 'Invalid URL in Plaid::Client.env' \
                                " (#{env.inspect}). " \
-                               'Specify either Symbol (:tartan, :api), or a ' \
-                               "full URL, like 'https://tartan.plaid.com'"
+                               'Specify either Symbol (:tartan, :production),' \
+                               " or a full URL, like 'https://tartan.plaid.com'"
         end
       else
         raise ArgumentError, 'Invalid value for Plaid::Client.env' \
                              " (#{env.inspect}): " \
-                             'must be :tartan, :api, or a full URL, ' \
+                             'must be :tartan, :production, or a full URL, ' \
                              "e.g. 'https://tartan.plaid.com'"
       end
     end
 
     # Public: Construct a Client instance.
     #
-    # env       - The Symbol (:tartan, :api), or a full String URL like
+    # env       - The Symbol (:tartan, :production), or a full String URL like
     #             'https://tartan.plaid.com'.
     # client_id - The String Plaid account client ID to authenticate requests.
     # secret    - The String Plaid account secret to authenticate requests.

data/lib/plaid/user.rb

@@ -163,13 +163,34 @@ module Plaid
     # send_method - The Hash with code send method information.
     #               E.g. { type: 'phone' } or { mask: '123-...-4321' }.
     #               Default is first available email.
+    # options     - the Hash options (default: {}):
+    #               :list       - The Boolean flag which would request the
+    #                             available send methods if the institution
+    #                             requires code-based MFA credential (default:
+    #                             false).
+    #               :webhook    - The String webhook URL. Used with :connect,
+    #                             :income, and :risk products (default: nil).
+    #               :pending    - The Boolean flag requesting to return
+    #                             pending transactions. Used with :connect
+    #                             product (default: false).
+    #               :login_only - The Boolean option valid for initial
+    #                             authentication only. If set to false, the
+    #                             initial request will return transaction data
+    #                             based on the start_date and end_date.
+    #               :start_date - The start Date from which to return
+    #                             transactions (default: 30 days ago).
+    #               :end_date   - The end Date to which transactions
+    #                             will be collected (default: today).
     #
     # Returns true if whole MFA process is completed, false otherwise.
-    def mfa_step(info = nil, send_method: nil)
+    def mfa_step(info = nil, send_method: nil, options: nil)
       payload = { access_token: access_token }
       payload[:mfa] = info if info
-      payload[:send_method] = MultiJson.dump(send_method) if send_method
-
+      if options || send_method
+        options = {} unless options
+        options[:send_method] = send_method if send_method
+        payload[:options] = MultiJson.dump(options)
+      end
       conn = Connector.new(product, :step, auth: true)
       response = conn.post(payload)
 
@@ -231,6 +252,27 @@ module Plaid
       self
     end
 
+    # Public: Create or update the webhook for Connect.
+    #
+    # Does a PATCH /connect request.
+    #
+    # webhook - The String with webhook URL.
+    #
+    # Returns self.
+    def update_webhook(webhook)
+      raise ArgumentError, 'User#update_webhook only supported by Connect!' \
+        unless product == :connect
+
+      payload = {
+        access_token: access_token,
+        options: MultiJson.dump(webhook: webhook)
+      }
+
+      parse_response(Connector.new(:connect, auth: true, client: client)
+                              .patch(payload))
+      self
+    end
+
     # Public: Delete the user.
     #
     # Makes a delete request and freezes self to prevent further modifications

data/lib/plaid/version.rb

@@ -1,3 +1,3 @@
 module Plaid
-  VERSION = '2.0.0.alpha'.freeze
+  VERSION = '2.0.0.alpha.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha
+  version: 2.0.0.alpha.2
 platform: ruby
 authors:
 - Oleg Dashevskii
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json