synapse_pay_rest 3.2.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7577507829d62a972d335b9befde0467f91ce140
-  data.tar.gz: 1b89b98e58b40e5351042abd57c428911dcf2a79
+  metadata.gz: 2cc3f5c96ebd64735c90cee2bd7f0989bda4a731
+  data.tar.gz: baa7445a81cddba8cb95ab2b0cbad69a34fcc4b8
 SHA512:
-  metadata.gz: 31a63bd44d0ec751522fcb3cc1af25a542d5b4c1328dd26052b907517c2f670f9bb80d2c18d4024e44f056469852907bbd47d3006d20782ee7c65fa068d5b136
-  data.tar.gz: 5693e69860e72f275f868297a192de94a8cec2f43d5575bb993daac4c98e5e76e58aaa1fe21dbb1226997313e6dcc2ded82409ef23ff092fbe0928684b48ca6c
+  metadata.gz: 44ed5c4e073ad34f76b7e3ae71669790ccd119f6fe6c6653b5fd9130d7c6b594118f59ae14d0c6c4729fa311eb2ca4c0b03fb22a92fcfe73396509177958c50e
+  data.tar.gz: dce13e643e09c2844dc2dac338499aa11ae834e1f05be2d25f0e3f2df8407b974f92b9ba2edb20b64e6c0b76e2052d86cad27cb8e1fb0fd46a28f9bc94d900e1

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 SynapsePay LLC
+Copyright (c) 2017 Synapse Financial Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/lib/synapse_pay_rest/api/users.rb

@@ -7,7 +7,7 @@ module SynapsePayRest
   class Users
     # Valid optional args for #get
     # @todo Should refactor this to HTTPClient
-    VALID_QUERY_PARAMS = [:query, :page, :per_page].freeze
+    VALID_QUERY_PARAMS = [:query, :page, :per_page, :full_dehydrate].freeze
 
     # @!attribute [rw] client
     #   @return [SynapsePayRest::HTTPClient]
@@ -26,6 +26,7 @@ module SynapsePayRest
     #   users with matching name/email
     # @param page [String,Integer] (optional) response will default to 1
     # @param per_page [String,Integer] (optional) response will default to 20
+    # @param full_dehydrate [String, String] (optional) response will inclulde all KYC info on user
     # 
     # @raise [SynapsePayRest::Error] may return subclasses of error based on 
     # HTTP response from API
@@ -38,8 +39,6 @@ module SynapsePayRest
     def get(user_id: nil, **options)
       path = user_path(user_id: user_id)
 
-      return client.get(path) if user_id
-
       params = VALID_QUERY_PARAMS.map do |p|
         options[p] ? "#{p}=#{options[p]}" : nil
       end.compact

data/lib/synapse_pay_rest/models/node/ach_us_node.rb

@@ -16,7 +16,7 @@ module SynapsePayRest
       # 
       # @raise [SynapsePayRest::Error]
       # 
-      # @return [Array<SynapsePayRest::AchUsNode>] may contain multiple nodes (checking and/or savings)s
+      # @return [Array<SynapsePayRest::AchUsNode>] may contain multiple nodes (checking and/or savings)
       def create_via_bank_login(user:, bank_name:, username:, password:)
         raise ArgumentError, 'user must be a User object' unless user.is_a?(User)
         raise ArgumentError, 'bank_name must be a String' unless bank_name.is_a?(String)
@@ -32,6 +32,15 @@ module SynapsePayRest
           multiple_from_response(user, response['nodes'])
         end
       end
+
+      # Creates an ACH-US node via access token, belonging to user supplied.
+      # 
+      # @param user [SynapsePayRest::User] the user to whom the node belongs 
+      # @param access_token [String] user's access token 
+      # 
+      # @raise [SynapsePayRest::Error]
+      # 
+      # @return [Array<SynapsePayRest::AchUsNode>] may contain multiple nodes (checking and/or savings)
       
       def create_via_bank_login_mfa(user:, access_token:)
         raise ArgumentError, 'user must be a User object' unless user.is_a?(User)

data/lib/synapse_pay_rest/models/user/user.rb

@@ -64,15 +64,16 @@ module SynapsePayRest
       # 
       # @param client [SynapsePayRest::Client]
       # @param id [String] id of the user to find
+      # @param full_dehydrate [String] (optional) if 'yes', returns all KYC on user
       # 
       # @raise [SynapsePayRest::Error] if user not found or invalid client credentials
       # 
       # @return [SynapsePayRest::User]
-      def find(client:, id:)
+      def find(client:, id:, full_dehydrate:)
         raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 
-        response = client.users.get(user_id: id)
+        response = client.users.get(user_id: id, full_dehydrate: full_dehydrate)
         from_response(client, response)
       end
 

data/lib/synapse_pay_rest/version.rb

@@ -1,4 +1,4 @@
 module SynapsePayRest
   # Gem version
-  VERSION = '3.2.0'.freeze
+  VERSION = '3.2.1'.freeze
 end

data/samples.md

@@ -45,6 +45,8 @@ args = {
   per_page: 50,
   # (optional) filters by name/email match
   query:    nil,
+  # (optional) returns all KYC on user
+  full_dehydrate: yes
 }
 
 users = SynapsePayRest::User.all(args)
@@ -54,7 +56,7 @@ users = SynapsePayRest::User.all(args)
 #### Find a User by User ID
 
 ```ruby
-user = SynapsePayRest::User.find(client: client, id: '57e97ab786c2737f4ccd4dc1')
+user = SynapsePayRest::User.find(client: client, id: '57e97ab786c2737f4ccd4dc1', full_dehydrate: 'no')
 # => #<SynapsePayRest::User>
 ```
 
@@ -89,6 +91,7 @@ user_update_settings = {
   phone_number:         '415-555-5555',                # add a phone number
   legal_name:           'Big Bird',                    # add a legal name
   remove_phone_number:  '555-555-5555',                # remove a phone number
+  remove_legal_name:    'Big Bird',                    # remove a legal name
   remove_login:          nil                           # remove a login email
 }
 
@@ -348,6 +351,27 @@ nodes.mfa_verified
 # => true
 ```
 
+##### Verify Bank Login MFA without existing node object
+
+If you are unable to finish MFA in one session with `AchUsNode.create_via_bank_login`, you can create another unverified node with just the access token. Use `AchUsNode.create_via_bank_login_mfa` with the addition of an `access_token` argument.
+
+```ruby
+unverified_node = user.create_ach_us_nodes_via_bank_login_mfa(access_token:)
+```
+
+Then proceed to resolve the MFA question(s) as before:
+
+```ruby
+
+nodes = nodes.answer_mfa('test_answer')
+# => [#<SynapsePayRest::AchUsNode>, ...] if successful
+# => SynapsePayRest::UnverifiedNode if additional MFA question (check node.mfa_message)
+# => raises SynapsePayRest::Error if incorrect answer
+
+nodes.mfa_verified
+# => true
+```
+
 #### Create ACH-US Node via Account/Routing Number
 
 Can also use `AchUsNode.create` with the addition of a `user` argument.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-02 00:00:00.000000000 Z
+date: 2017-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -143,7 +143,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env.sample"
 - ".gitignore"
 - Gemfile
 - LICENSE

data/.env.sample

@@ -1,8 +0,0 @@
-# For development in a console
-CLIENT_ID=your_sandbox_client_id
-CLIENT_SECRET=your_sandbox_client_secret
-FINGERPRINT=your_sandbox_fingerprint
-
-# For running tests
-TEST_CLIENT_ID=your_sandbox_client_id
-TEST_CLIENT_SECRET=your_sandbox_client_secret