plaid 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b2355e11af0826a2ace7a6c8f01c439927d68d4
-  data.tar.gz: ec087e866397828a734a808fa75e2400789ea8fb
+  metadata.gz: 2df30fbdad26bdf216850618dadf355fd17e3cee
+  data.tar.gz: 2e70845646767b8174a1b77314933b2bb8a384fb
 SHA512:
-  metadata.gz: 29fe226dcbb38dc8987d02996c827a9c47d9854c1d782ae4b7de56020b491b2dafbbd5003da43682bf5d5f6d62896f0576e8b841109ffa2cf2a1369e3866ba8c
-  data.tar.gz: a8181aaf03e10ebc3029d4535c979a9a988381714f5558cda88909190e8388753715534659b64fef540b689a45681bf6d51d22355ef781aeec1c797ee8850945
+  metadata.gz: 2fba432e8eb41e8abd6603f00327aa8d07da2ed5be065cd63b73784f8205f4524e7e4b486ef497a9a666f4714570c34e432119802a454b12c588e7e0a621d062
+  data.tar.gz: 3a01497f2fe95e950924fb314d00cb1fbdeb01cc779e201a2c48f541d4c55ce6dcd6fe3726d0281afe972be9b121a4e00dda0696131368e7c4c6dbddf08d1203

data/README.md

@@ -4,11 +4,11 @@ Ruby bindings for the Plaid API
 
 ## Notes
 
-Latest stable version: **1.0.0**
+Latest stable version: **1.1.0**
 
-Last stable version: 0.1.6
+Last stable version: 1.0.1
 
-**Warning: If you have been using any version < 1 please switch to the correct branch (V0.1.6). Installing without specifying a version from RubyGems results in V1.0.0 build. **
+**Warning: If you have been using any version < 1 please switch to the correct branch (V0.1.6). Installing without specifying a version from RubyGems results in V1.1 build. **
 
 ## Installation
 
@@ -34,16 +34,16 @@ Configure the gem with your customer id, secret key, and the environment path yo
 
 ```ruby
 Plaid.config do |p|
-    p.customer_id = ['test_id']
-    p.secret = ['test_secret']
-    p.environment_location = ['https://tartan.plaid.com/']
+    p.customer_id = 'Plaid provided customer ID here'
+    p.secret = 'Plaid provided secret key here'
+    p.environment_location = 'URL for the development or production environment'
 end
 ```
 
 Authenticate a user to your desired level of api access (auth / connect).
 
 ```ruby
-user = Plaid.auth('auth','plaid_test','plaid_good','wells')
+user = Plaid.add_user('auth','plaid_test','plaid_good','wells')
 ```
 
 ## Learn More

data/lib/plaid.rb

@@ -2,7 +2,7 @@ require 'plaid/version'
 require 'plaid/config'
 require 'plaid/util'
 
-require 'plaid/auth'
+require 'plaid/add_user'
 require 'plaid/user/user'
 require 'plaid/institution/institution'
 require 'plaid/category/category'
@@ -16,7 +16,7 @@ module Plaid
     include Plaid::Util
 
     # Includes the method to authenticate the user. Defined in auth.rb
-    include Plaid::Auth
+    include Plaid::AddUser
 
     # Builds the user object and returns on successful authentication
     def user(res,api_level=nil)

data/lib/plaid/{auth.rb → add_user.rb}

@@ -1,8 +1,9 @@
 module Plaid
-  module Auth
-      def auth(api_level,username,password,type)
+  module AddUser
+      def add_user(api_level,username,password,type,pin=nil)
         begin
           options = {username:username,password:password,type:type}
+          options.merge!(pin:pin) if pin
           res = self.post(api_level,options)
           self.user(res,api_level)
         rescue => e

data/lib/plaid/util.rb

@@ -30,7 +30,7 @@ module Plaid
         when 'Institution not supported'
           raise 'Institution not supported'
         when 'Corrupted token'
-          raise 'It appears that the access_token has been corrupted'
+          raise 'It appears that the access token has been corrupted'
         else
           raise err
       end
@@ -68,5 +68,6 @@ module Plaid
           error_handler('Server Error',res)
       end
     end
+
   end
 end

data/lib/plaid/version.rb

@@ -1,3 +1,3 @@
 module Plaid
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/plaid_spec.rb

@@ -10,7 +10,7 @@ describe Plaid do
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      res = Plaid.auth('connect','plaid_test','plaid_good','wells')
+      res = Plaid.add_user('connect','plaid_test','plaid_good','wells')
       it { expect(res).to be_instance_of Plaid::User }
     end
 
@@ -20,7 +20,7 @@ describe Plaid do
         p.secret = 'test_secret'
         p.environment_location = 'https://api.plaid.com/'
       end
-      res = Plaid.auth('connect','plaid_test','plaid_good','wells')
+      res = Plaid.add_user('connect','plaid_test','plaid_good','wells')
       it { expect(res).to be_instance_of Plaid::User }
     end
 
@@ -30,7 +30,7 @@ describe Plaid do
         p.secret = 'test_bad'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      it { expect{Plaid.auth('connect','plaid_bad','plaid_bad','wells')}.to raise_error }
+      it { expect{Plaid.add_user('connect','plaid_bad','plaid_bad','wells')}.to raise_error }
     end
 
     context 'has invalid production keys' do
@@ -39,68 +39,87 @@ describe Plaid do
         p.secret = 'test_bad'
         p.environment_location = 'https://api.plaid.com/'
       end
-      it { expect{Plaid.auth('connect','plaid_bad','plaid_bad','wells')}.to raise_error }
+      it { expect{Plaid.add_user('connect','plaid_bad','plaid_bad','wells')}.to raise_error }
     end
   end
 
   # Authentication flow specs - returns Plaid::User
   # TODO: Abstract the config from each section with the result in passing tests
-  describe '.auth' do
+  describe '.add_user' do
 
-    context 'has correct credentials for single factor auth, authenticates to the connect path' do
+    context 'has correct credentials for single factor auth, authenticates to the connect level of api access' do
       Plaid.config do |p|
         p.customer_id = 'test_id'
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      user = Plaid.auth('connect','plaid_test','plaid_good','wells')
+      user = Plaid.add_user('connect','plaid_test','plaid_good','wells')
       it { expect(user.accounts.empty?).to be_falsey }
     end
 
-    context 'has correct credentials for single factor auth, authenticates to the auth path' do
+    context 'has correct credentials for single factor auth, authenticates to the auth level of api access' do
       Plaid.config do |p|
         p.customer_id = 'test_id'
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      user = Plaid.auth('auth','plaid_test','plaid_good','wells')
+      user = Plaid.add_user('auth','plaid_test','plaid_good','wells')
       it { expect(user.accounts[0].numbers.nil?).to be_falsey }
     end
 
-    context 'has correct username, but incorrect password for single factor auth under auth path' do
+    context 'has correct username, but incorrect password for single factor auth under auth level of api access' do
       Plaid.config do |p|
         p.customer_id = 'test_id'
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      it { expect{Plaid.auth('auth','plaid_test','plaid_bad','wells')}.to raise_error }
+      it { expect{Plaid.add_user('auth','plaid_test','plaid_bad','wells')}.to raise_error }
     end
 
-    context 'has incorrect username under auth path' do
+    context 'has incorrect username under auth level of api access' do
       Plaid.config do |p|
         p.customer_id = 'test_id'
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      it { expect{Plaid.auth('auth','plaid_bad','plaid_bad','wells')}.to raise_error }
+      it { expect{Plaid.add_user('auth','plaid_bad','plaid_bad','wells')}.to raise_error }
     end
 
-    context 'has correct username, but incorrect password for single factor auth under connect path' do
+    context 'has correct username, but incorrect password for single factor auth under connect level of api access' do
       Plaid.config do |p|
         p.customer_id = 'test_id'
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      it { expect{Plaid.auth('connect','plaid_test','plaid_bad','wells')}.to raise_error }
+      it { expect{Plaid.add_user('connect','plaid_test','plaid_bad','wells')}.to raise_error }
     end
 
-    context 'has incorrect username under connect path' do
+    context 'has incorrect username under connect level of api access' do
       Plaid.config do |p|
         p.customer_id = 'test_id'
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      it { expect{Plaid.auth('connect','plaid_bad','plaid_bad','wells')}.to raise_error }
+      it { expect{Plaid.add_user('connect','plaid_bad','plaid_bad','wells')}.to raise_error }
+    end
+
+    context 'enters pin for extra parameter authentication required by certain institutions' do
+      Plaid.config do |p|
+        p.customer_id = 'test_id'
+        p.secret = 'test_secret'
+        p.environment_location = 'https://tartan.plaid.com/'
+      end
+      user = Plaid.add_user('connect','plaid_test','plaid_good','usaa','1234')
+      it { expect(user.api_res).to eq 'Requires further authentication' }
+    end
+
+    context 'enters incorrect pin for extra parameter authentication required by certain institutions' do
+      Plaid.config do |p|
+        p.customer_id = 'test_id'
+        p.secret = 'test_secret'
+        p.environment_location = 'https://tartan.plaid.com/'
+      end
+      it { expect{Plaid.add_user('connect','plaid_test','plaid_good','usaa','0000')}.to raise_error }
     end
 
     context 'has to enter MFA credentials' do
@@ -109,7 +128,7 @@ describe Plaid do
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      user = Plaid.auth('connect','plaid_selections', 'plaid_good','bofa')
+      user = Plaid.add_user('connect','plaid_selections', 'plaid_good','bofa')
       it { expect(user.api_res).to eq 'Requires further authentication' }
     end
 
@@ -119,7 +138,7 @@ describe Plaid do
         p.secret = 'test_secret'
         p.environment_location = 'https://tartan.plaid.com/'
       end
-      user = Plaid.auth('connect','plaid_selections', 'plaid_locked','wells')
+      user = Plaid.add_user('connect','plaid_selections', 'plaid_locked','wells')
       it { expect(user.api_res).to eq 'User account is locked' }
     end
   end
@@ -205,7 +224,7 @@ describe Plaid do
           p.secret = 'test_secret'
           p.environment_location = 'https://tartan.plaid.com/'
         end
-        new_mfa_user = Plaid.auth('connect','plaid_selections', 'plaid_good','bofa')
+        new_mfa_user = Plaid.add_user('connect','plaid_selections', 'plaid_good','bofa')
         new_mfa_user.mfa_authentication('tomato','bofa')
         it { expect(new_mfa_user.accounts).to be_truthy }
       end
@@ -216,7 +235,7 @@ describe Plaid do
           p.secret = 'test_secret'
           p.environment_location = 'https://tartan.plaid.com/'
         end
-        mfa_again = Plaid.auth('connect','plaid_selections', 'plaid_good','bofa')
+        mfa_again = Plaid.add_user('connect','plaid_selections', 'plaid_good','bofa')
         mfa_again.mfa_authentication('again','bofa')
         it { expect(mfa_again.api_res).to eq 'Requires further authentication' }
       end
@@ -227,17 +246,17 @@ describe Plaid do
           p.secret = 'test_secret'
           p.environment_location = 'https://tartan.plaid.com/'
         end
-        mfa_user = Plaid.auth('connect','plaid_selections', 'plaid_good','bofa')
+        mfa_user = Plaid.add_user('connect','plaid_selections', 'plaid_good','bofa')
         mfa_user.mfa_authentication('tomato','bofa')
-        mfa_user = Plaid.auth('connect','plaid_selections', 'plaid_good','bofa')
+        mfa_user = Plaid.add_user('connect','plaid_selections', 'plaid_good','bofa')
         it { expect { mfa_user.mfa_authentication('bad','bofa') }.to raise_error }
       end
     end
 
     # Auth specs
     describe '#get_auth' do
-      auth_user = Plaid.auth('auth','plaid_test','plaid_good','wells')
-      connect_user = Plaid.auth('connect','plaid_test','plaid_good','wells')
+      auth_user = Plaid.add_user('auth','plaid_test','plaid_good','wells')
+      connect_user = Plaid.add_user('connect','plaid_test','plaid_good','wells')
 
       context 'has access and returns accounts' do
         it { expect(auth_user.permissions[0]).to eq('auth') }
@@ -250,8 +269,8 @@ describe Plaid do
 
     # Connect specs
     describe '#get_connect' do
-      auth_user = Plaid.auth('auth','plaid_test','plaid_good','wells')
-      connect_user = Plaid.auth('connect','plaid_test','plaid_good','wells')
+      auth_user = Plaid.add_user('auth','plaid_test','plaid_good','wells')
+      connect_user = Plaid.add_user('connect','plaid_test','plaid_good','wells')
 
       context 'has access and returns accounts' do
         it { expect(connect_user.permissions[0]).to eq('connect') }
@@ -265,8 +284,8 @@ describe Plaid do
     # Upgrade specs - either pass or fails
 =begin TODO: Write upgrade methods to pass without paying
     describe '#upgrade' do
-      auth_user = Plaid.auth('auth','plaid_test','plaid_good','wells')
-      connect_user = Plaid.auth('connect','plaid_test','plaid_good','wells')
+      auth_user = Plaid.add_user('auth','plaid_test','plaid_good','wells')
+      connect_user = Plaid.add_user('connect','plaid_test','plaid_good','wells')
 
       context 'auth upgrade is successful' do
         connect_user.upgrade

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Crites
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,7 +67,7 @@ files:
 - README.md
 - Rakefile
 - lib/plaid.rb
-- lib/plaid/auth.rb
+- lib/plaid/add_user.rb
 - lib/plaid/category/category.rb
 - lib/plaid/config.rb
 - lib/plaid/institution/institution.rb