plaid-kilt 0.6.0 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 891a73fab60023c939acd2d9874dbb87acbb6544
-  data.tar.gz: 08a92a44b16bd3c41fb82c1fe61648c5d78ae35a
+  metadata.gz: 5bfd994b225c152783ebb0e738f61b5dc062cb9e
+  data.tar.gz: c9a6c26a1c205cbce6a88deca3a5e1222a17134c
 SHA512:
-  metadata.gz: 77a1a2feba64f74555f8e5970f6ee9b52dab4625b1cfa1f27fb9fb346d445fde8342ad229d4afa4f9589dab35cc507824b27792d4e3e3239aadb4e1deb198087
-  data.tar.gz: 1efd3aff599f14c5e64e70d021561162e21039fcff386d984f1426d247d99e8acddc947e3d7892f2c7eaa7aeffd50a980dd592126c565922b073224ed68e4a01
+  metadata.gz: 483aa428fb7013786c91062df373ed07371aa07273bd9f7fa6deea5aff720daeb3588d8120fef4995d978aa800a70289a4c4ebbe2290ecc5aa61c2bf3111bea9
+  data.tar.gz: 5f0c49c18d6ebd8a4238fac819a04dcf15ac94f1c6bbf43a91e09cac087dcefb4e9543b21e3e4cc0d5654920fb6a1a9fab3ef98643c699f95ed934b8287390ef

data/README.rdoc

@@ -4,11 +4,11 @@ Accessing the Plaid API using Ruby.
 
 ===Notes
 
-Minimal undergarments. Tests coming.
+Minimal undergarments. Sporran not included. Tests coming.
 
 === Version
 
-Head is 0.5.2
+Head is 0.6.0
 
 === Install
 
@@ -37,7 +37,7 @@ Response objects are initialized when the client gets a valid response from plai
 
     r = client.connect
 
-* r.raw_response    <= the raw HTTPParty response from Plaid
+* r.raw_response    <= the raw HTTPParty-wrapped response from Plaid
 * r.accounts        <= Array of accounts associated with this institution for this user
 * r.transactions    <= Array of transactions associated with the accounts
 * r.is_mfa?         <= false for this request
@@ -49,7 +49,7 @@ Accounts and Transactions are objects that follow the JSON from Plaid. Thus you
     r.transactions[66].category_id              <= "52544965f71e87d007000119"
     r.transactions[66].name                     <= "Online Payment Processed"
     r.accounts[2].institution_type              <= "fake_institution"
-    r.accounts[2].balance["current"]            <= 8.98 (which ruby infers as a double)
+    r.accounts[2].balance["current"]            <= 8.98
 
 More explicitly
 
@@ -78,10 +78,7 @@ More explicitly
 
 === MFA
 
-MFA requires some management of user flow, which is why this gem tries to make the returns / errors from API calls
-explicit. If it seems heavyweight to you, it is because the MFA process is a heavyweight process. Plaid does a
-better job managing it than some others, but if you are going to use Plaid extensively,
-then you are going to have to cope with MFA. See the wiki for more information.
+MFA requires some management of user flow, which is why this gem tries to make the returns / errors from API calls explicit. If it seems heavyweight to you, it is because the MFA process is a heavyweight process. Plaid does a better job managing it than some others (no names!!), but if you are going to use Plaid extensively, then you are going to have to cope with MFA. See the wiki for more information.
 
 https://github.com/jkoisch/plaid/wiki/MFA
 
@@ -99,21 +96,27 @@ You can, if you would rather, ignore the PlaidResponse objects.
 
      #when you get your responses
      x = client.connect
-     x.raw_response                 <= the raw http response to the request. Have fun.
+     x.raw_response                 <= the raw http-party wrapped response to the request. Have fun.
 
 === Thin Client
 
-The Plaid gem also has a thin_client for some secure followup operations:
+The Plaid-kilt gem also has a thin_client for some secure followup operations:
 
-    thin_client = Plaid.thin_client "me@example.com", "chase", "access_token"
+    thin_client = Plaid.thin_client "me@example.com", "chase", "access_token_test"
 
-This client can be used where user credentials are NOT needed, but you still want to access scecure information on
-the Plaid side of things (for example, after you have retrieved an access_token):
+This client can be used only after you have retrieved an access_token, but supports followup methods allowed for by Plaid:
 
     thin_client.followup                                <= GET operation to get account and transaction information
     thin_client.get_balance                             <= GET operation to receive account balances
     thin_client.get_entity("unique_plaid_entity")       <= Entity context information
 
+== Scaffolding
+
+Some Plaid methods are accessible via a GET with no additional credentials:
+
+    Plaid.scaffold.institutions    <= all of the institutions that Plaid supports
+    Plaid.scaffold.category(id)    <= detailed information about the plaid category
+
 == Configuration
 
 You need to configure access through your own initializers using the values you receive from Plaid.
@@ -126,17 +129,15 @@ You need to configure access through your own initializers using the values you
       config.endpoint             = 'https://tartan.plaid.com/'
       config.certpath             = 'ca-bundle.crt'
       config.headers              = {'Content-Type'=>'application/x-www-form-urlencoded'}
-      config.webhook_address      = 'http://If.You.Need.To.You.Can.Use/plaid_webhook/antennas'
+      config.webhook_address      = 'https://You.will.need.a/plaid_webhook/'
       config.save_full_response   = false
     end
 
 == Additional Client Methods
 
-The Plaid Client is not-quite-skinny so that it can handle various parts of the returns from the Plaid API. This is to
-support alternate user flows or user handling in implementation.
+The Plaid Client is not-quite-skinny so that it can handle various parts of the returns from the Plaid API. This is to support alternate user flows (MFA, etc) or user handling in implementation.
 
-The Plaid Client supports the following attr_readers, with the attribute settings handled through normal client
-management.
+The Plaid Client supports the following attr_readers
 
     client.settings
     client.username

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.3

data/lib/plaid/client/body.rb

@@ -25,6 +25,27 @@ module Plaid
         ret.merge(body)
       end
 
+      # Structure to proxy credentials to Plaid for access to the financial institution
+      def credentials
+        {
+            "username" => self.username,
+            "password" => self.password
+        }
+      end
+
+      def body_update_credentials
+        ret = Hash.new
+        ret[:access_token] = self.access_token
+        ret[:credentials] = credentials
+        ret.merge(body)
+      end
+
+      def body_delete_user
+        ret = Hash.new
+        ret[:access_token] = self.access_token
+        ret.merge(body)
+      end
+
       # the fundamental body object used in most calls to Plaid.
       # * client_id
       # * secret
@@ -35,10 +56,7 @@ module Plaid
       def body_original
         ret = Hash.new
         ret[:type] = self.institution
-        ret[:credentials] = {
-            "username" => self.username,
-            "password" => self.password
-        }
+        ret[:credentials] = credentials
         ret[:email] = 'me@example.com'
         ret[:options] = {"list" => true}
         ret.merge(body)

data/lib/plaid/client/client.rb

@@ -22,11 +22,12 @@ module Plaid
       ssl_version :SSLv3
       debug_output $stdout
 
-      def initialize(user, e_mail, pass_word, institution)
+      def initialize(user, e_mail, pass_word, institution, access_token=nil)
         self.username = user
         self.email = e_mail
         self.password = pass_word
         self.institution = institution
+        self.access_token = access_token unless access_token.blank?
         self.mfa_response ||= []
       end
 

data/lib/plaid/client/connect.rb

@@ -59,6 +59,26 @@ module Plaid
 input your code.") }
       end
 
+      def connect_update_credentials
+        if self.access_token.present?
+          body = body_update_credentials
+          response = self.class.patch('/connect', :query => body)
+          handle(response) { PlaidResponse.new(response, "Successfully updated credentials")}
+        else
+          PlaidError.new(nil, "Need to initialize the client with an access token")
+        end
+      end
+
+      def connect_delete_user
+        if self.access_token.present?
+          body = body_delete_user
+          response = self.class.delete('/connect', :query => body)
+          handle(response) { PlaidResponse.new(response, "Deleted user")}
+        else
+          PlaidError.new(nil, "Need to initialize the client with an access token so user can be deleted")
+        end
+      end
+
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plaid-kilt
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.3
 platform: ruby
 authors:
 - John Koisch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty