synapse_pay_rest 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf13c67916c9560ecd7993d03b00691ea15ca16e
-  data.tar.gz: 4df8ab520d132d23e4196c63a8ea2fdb9bc5cc46
+  metadata.gz: 4c6efa02c0a05bc9450793c2988d145d2b9d6179
+  data.tar.gz: b620267e190dfefb5d2cde8f0247ee7fd432d30b
 SHA512:
-  metadata.gz: eace5ad6f06ecb638f69eaffd0a505e903444d78f0e1324d1a4e19f06d2ef423b40719abbf4b8d23ddf60157a8066428e7abdbfd36f0ce907c4234f3ae98e353
-  data.tar.gz: 10fe666bec184de1cd0b72a5d1ae4ae09e4a1a4a238bddab316c93ea1fc5dcb8558f68b766aef529dc5cdcbd0b19f6d9e9b2fd4fb4766739f4c81ca76900c27b
+  metadata.gz: beb7d951f9faca9e76120ba2e4f2de687af5dbc82f5ec53d486d7003fe39562b8e1fec62eb97f3dddccb2972be38f5260d4b49eefd3179f957a3af0ce45e5fc1
+  data.tar.gz: b0ea2ebef0446b633cb84b290d3805922c8a91e3e145640a714bc4ff00aeaae3519abf7ead1a29ee0453adf6df1ec3e07c772bc9e03b787dec615ba2a01a1122

data/README.md

@@ -38,12 +38,12 @@ $ gem install synapse_pay_rest
 ## Documentation
 
 - [Samples demonstrating common operations](samples.md)
-- [Gem docs](http://www.rubydoc.info/gems/synapse_pay_rest)
+- [synapse_pay_rest gem docs](http://www.rubydoc.info/github/synapsepay/SynapsePayRest-Ruby)
 - [API docs](http://docs.synapsepay.com/v3.1)
 
 ## Contributing
 
-Just open a pull request. Please document and test any public constants/methods. Open an issue or email steven@synapsepay.com if you have any questions.
+For minor issues, just open a pull request. For larger changes or features, please email steven@synapsepay.com.Please document and test any public constants/methods. Open an issue or email steven@synapsepay.com if you have any questions.
 
 ## Running the Test Suite
 
@@ -66,27 +66,6 @@ To run a specific file or test, install the [m](https://github.com/qrush/m) gem
 m path/to/file:line_number
 ```
 
-## Todos
-
-- Smartly update the existing instances with response data instead of re-instantiating for every response. I started with this approach but it gets pretty complicated with the interconnected models of User/BaseDocument/Document. Also, certain values are only known if the user created an object, but not when the object is built from API response data. This is solveable but requires more dev time and testing.
-- Various factory helper methods should be private but are public. Would be good to refactor in a way that they can be private.
-- `User`/`Node`/`Transaction` have similar REST methods that could probably be factored into a superclass or module.
-- Use mixins instead of inheritance for the shared behavior of `Node`s and `Document`s. The parent classes are never instantiated anyways.
-- Refactor the redundant code in each `Node` type's version of `#payload_for_create`.
-- Better way to handle bank MFA nodes? Virtual doc KBA?
-- Add an option for logging responses in addition to requests.
-- Organize tests better.
-- Use mocked responses whenever possible in tests.
-- More examples.
-- More Error types (bad MFA answer, for example).
-- Add some methods to BaseDocument to return doc by type (e.g. `base_document.ssn_doc`).
-
-Specific todos are marked throughout in this format:
-
-```ruby
-# @todo Description of todo.
-```
-
 ## License
 
-[MIT License](LICENSE)
+[MIT License](LICENSE)

data/lib/synapse_pay_rest/api/nodes.rb

@@ -17,7 +17,8 @@ module SynapsePayRest
     # Sends a GET request to /nodes endpoint. Queries a specific node_id if
     # node_id supplied, else queries all nodes. Returns the response.
     # 
-    # @param node_id [String] id of the node
+    # @param user_id [String]
+    # @param node_id [String,void]
     # @param page [String,Integer] (optional) response will default to 1
     # @param per_page [String,Integer] (optional) response will default to 20
     # @param type [String] (optional)
@@ -31,12 +32,12 @@ module SynapsePayRest
     # @todo should use CGI or RestClient's param builder instead of
     #   rolling our own, probably error-prone and untested
     #   https://github.com/rest-client/rest-client#usage-raw-url
-    def get(node_id: nil, **options)
+    def get(user_id:, node_id: nil, **options)
       params = VALID_QUERY_PARAMS.map do |p|
         options[p] ? "#{p}=#{options[p]}" : nil
       end.compact
 
-      path = create_node_path(node_id: node_id)
+      path = node_path(user_id: user_id, node_id: node_id)
       path += '?' + params.join('&') if params.any?
       client.get(path)
     end
@@ -44,6 +45,7 @@ module SynapsePayRest
     # Sends a POST request to /nodes endpoint, to create a new node for the
     # current user, and returns the response.
     # 
+    # @param user_id [String]
     # @param payload [Hash] format depends on node type 
     # @see https://docs.synapsepay.com/docs/node-resources payload structure
     # 
@@ -51,18 +53,18 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def post(payload:)
-      path = create_node_path
+    def post(user_id:, payload:)
+      path = node_path(user_id: user_id)
       client.post(path, payload)
     end
-
     # Alias for #post (legacy name)
     alias_method :add, :post
 
     # Sends a PATCH request to /nodes endpoint to update a node, and returns the
     # response. Only used to verify microdeposits for ACH-US nodes currently.
     # 
-    # @param node_id [String] id of the node
+    # @param user_id [String]
+    # @param node_id [String]
     # @param payload [Hash]
     # @see https://docs.synapsepay.com/docs/verify-micro-deposit payload structure
     # 
@@ -70,50 +72,52 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def patch(node_id:, payload:)
-      path = create_node_path(node_id: node_id)
-      @client.patch(path, payload)
+    def patch(user_id:, node_id:, payload:)
+      path = node_path(user_id: user_id, node_id: node_id)
+      client.patch(path, payload)
     end
 
     # Sends a DELETE request to /node endpoint to remove a node, and returns the response.
     # 
-    # @param node_id [String] id of the node
+    # @param user_id [String]
+    # @param node_id [String]
     # 
     # @raise [SynapsePayRest::Error] may return subclasses of error based on 
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def delete(node_id:)
-      path = create_node_path(node_id: node_id)
+    def delete(user_id:, node_id:)
+      path = node_path(user_id: user_id, node_id: node_id)
       client.delete(path)
     end
 
     # Verifies microdeposits (via #patch) for a node if a node_id supplied, else
     # submits answers to bank login MFA questions (via #post).
     # 
-    # @param node_id [String] id of the node
+    # @param user_id [String]
+    # @param node_id [String,void]
     # @param payload [Hash] see #patch and #post for payload format
     # @deprecated Use #update for microdeposit verification or #post for MFA answers.
-    def verify(node_id: nil, payload:)
+    def verify(user_id:, node_id: nil, payload:)
       if node_id
         warn caller.first + " DEPRECATION WARNING: #{self.class}##{__method__} is deprecated. Use #patch instead."
 
         # verify microdeposits
-        patch(node_id: node_id, payload: payload)
+        patch(user_id: user_id, node_id: node_id, payload: payload)
       else
         warn caller.first + " DEPRECATION WARNING: #{self.class}##{__method__} is deprecated. Use #post instead."
 
         # verify MFA questions
-        post(payload: payload)
+        post(user_id: user_id, payload: payload)
       end
     end
 
     private
 
-    def create_node_path(node_id: nil)
-      path = ['/users', client.user_id, 'nodes' ]
-      path << node_id if node_id
-      path.join('/')
+    def node_path(user_id:, node_id: nil)
+      path = "/users/#{user_id}/nodes"
+      path += "/#{node_id}" if node_id
+      path
     end
   end
 end

data/lib/synapse_pay_rest/api/transactions.rb

@@ -20,6 +20,7 @@ module SynapsePayRest
     # Sends a GET request to /trans endpoint. Queries a specific transaction_id
     # if trans_id supplied, else queries all transactions. Returns the response.
     # 
+    # @param user_id [String]
     # @param node_id [String] id of the from node
     # @param trans_id [String,void] (optional) id of a transaction to look up
     # @param page [String,Integer] (optional) response will default to 1
@@ -33,8 +34,8 @@ module SynapsePayRest
     # @todo Probably should use CGI or RestClient's param builder instead of
     # rolling our own, probably error-prone and untested version
     # https://github.com/rest-client/rest-client#usage-raw-url
-    def get(node_id:, trans_id: nil, **options)
-      path = create_transaction_path(node_id: node_id, trans_id: trans_id)
+    def get(user_id:, node_id:, trans_id: nil, **options)
+      path = create_transaction_path(user_id: user_id, node_id: node_id, trans_id: trans_id)
 
       params = VALID_QUERY_PARAMS.map do |p|
         options[p] ? "#{p}=#{options[p]}" : nil
@@ -47,6 +48,7 @@ module SynapsePayRest
     # Sends a POST request to /trans endpoint to create a new transaction.
     # Returns the response.
     # 
+    # @param user_id [String]
     # @param node_id [String] id of the from node
     # @param payload [Hash]
     # @see https://docs.synapsepay.com/docs/create-transaction payload structure
@@ -55,14 +57,15 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def create(node_id:, payload:)
-      path = create_transaction_path(node_id: node_id)
+    def create(user_id:, node_id:, payload:)
+      path = create_transaction_path(user_id: user_id, node_id: node_id)
       client.post(path, payload)
     end
 
     # Sends a PATCH request to /trans endpoint to update a transaction. 
     # Returns the response.
     # 
+    # @param user_id [String]
     # @param node_id [String] id of the from node
     # @param trans_id [String] id of a transaction to update
     # @param payload [Hash]
@@ -72,14 +75,15 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def update(node_id:, trans_id:, payload:)
-      path = create_transaction_path(node_id: node_id, trans_id: trans_id)
+    def update(user_id:, node_id:, trans_id:, payload:)
+      path = create_transaction_path(user_id: user_id, node_id: node_id, trans_id: trans_id)
       client.patch(path, payload)
     end
 
     # Sends a DELETE request to /trans endpoint to cancel a transaction.
     # Returns the response.
     # 
+    # @param user_id [String]
     # @param node_id [String] id of the from node
     # @param trans_id [String] id of a transaction to delete
     # 
@@ -87,17 +91,17 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def delete(node_id:, trans_id:)
-      path = create_transaction_path(node_id: node_id, trans_id: trans_id)
+    def delete(user_id:, node_id:, trans_id:)
+      path = create_transaction_path(user_id: user_id, node_id: node_id, trans_id: trans_id)
       client.delete(path)
     end
 
     private
 
-    def create_transaction_path(node_id:, trans_id: nil)
-      path = ['/users', client.user_id, 'nodes', node_id, 'trans' ]
-      path << trans_id if trans_id
-      return path.join('/')
+    def create_transaction_path(user_id:, node_id:, trans_id: nil)
+      path = "/users/#{user_id}/nodes/#{node_id}/trans"
+      path += "/#{trans_id}" if trans_id
+      path
     end
   end
 end

data/lib/synapse_pay_rest/api/users.rb

@@ -36,13 +36,9 @@ module SynapsePayRest
     # rolling our own, probably error-prone and untested version
     # https://github.com/rest-client/rest-client#usage-raw-url
     def get(user_id: nil, **options)
-      path = create_user_path(user_id: user_id)
+      path = user_path(user_id: user_id)
 
-      if user_id
-        response = client.get(path)
-        client.update_headers(user_id: response['_id']) if response['_id']
-        return response
-      end
+      return client.get(path) if user_id
 
       params = VALID_QUERY_PARAMS.map do |p|
         options[p] ? "#{p}=#{options[p]}" : nil
@@ -63,15 +59,13 @@ module SynapsePayRest
     # 
     # @return [Hash] API response
     def create(payload:)
-      path = create_user_path
-      response = client.post(path, payload)
-      client.update_headers(user_id: response['_id']) if response['_id']
-      response
+      client.post(user_path, payload)
     end
 
     # Sends a POST request to /oauth/:user_id endpoint to obtain a new oauth key
     # and update the client's headers, and returns the response
     # 
+    # @param user_id [String]
     # @param payload [Hash]
     # @see https://docs.synapsepay.com/docs/get-oauth_key-refresh-token payload structure
     # 
@@ -79,9 +73,9 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def refresh(payload:)
-      path = "/oauth/#{@client.user_id}"
-      response = @client.post(path, payload)
+    def refresh(user_id:, payload:)
+      path = "/oauth/#{user_id}"
+      response = client.post(path, payload)
       client.update_headers(oauth_key: response['oauth_key']) if response['oauth_key']
       response
     end
@@ -101,11 +95,9 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def update(payload:)
-      path = create_user_path(user_id: client.user_id)
-      response = client.patch(path, payload)
-      client.update_headers(user_id: response['_id']) if response['_id']
-      response
+    def update(user_id:, payload:)
+      path = user_path(user_id: user_id)
+      client.patch(path, payload)
     end
     # Alias for #update (legacy name)
     alias_method :answer_kba, :update
@@ -142,16 +134,16 @@ module SynapsePayRest
     # 
     # @param file_path [String]
     # @deprecated Use #update with KYC 2.0 payload instead.
-    def attach_file(file_path:)
+    def attach_file(user_id:, file_path:)
       warn caller.first + " DEPRECATION WARNING: #{self.class}##{__method__} is deprecated. Use #update with encode_attachment instead."
 
       file_contents = open(file_path) { |f| f.read }
       content_types = MIME::Types.type_for(file_path)
       file_type = content_types.first.content_type if content_types.any?
       if file_type.nil?
-        raise('File type not found. Use attach_file_with_file_type(file_path: <file_path>, file_type: <file_type>)')
+        raise('File type not found. Use attach_file_with_file_type(user_id: <user_id>, file_path: <file_path>, file_type: <file_type>)')
       else
-        attach_file_with_file_type(file_path: file_path, file_type: file_type)
+        attach_file_with_file_type(user_id: user_id, file_path: file_path, file_type: file_type)
       end
     end
 
@@ -161,10 +153,10 @@ module SynapsePayRest
     # @param file_path [String]
     # @param file_type [String] MIME type
     # @deprecated Use #update with KYC 2.0 payload instead.
-    def attach_file_with_file_type(file_path:, file_type:)
+    def attach_file_with_file_type(user_id:, file_path:, file_type:)
       warn caller.first + " DEPRECATION WARNING: #{self.class}##{__method__} is deprecated. Use #update with encode_attachment instead."
 
-      path = create_user_path(user_id: @client.user_id)
+      path = user_path(user_id: user_id)
       file_contents = open(file_path) { |f| f.read }
       encoded = Base64.encode64(file_contents)
       mime_padding = "data:#{file_type};base64,"
@@ -180,10 +172,10 @@ module SynapsePayRest
 
     private
 
-    def create_user_path(user_id: nil)
-      path = ['/users']
-      path << user_id if user_id
-      path.join('/')
+    def user_path(user_id: nil)
+      path = "/users"
+      path += "/#{user_id}" if user_id
+      path
     end
   end
 end

data/lib/synapse_pay_rest/client.rb

@@ -22,12 +22,11 @@ module SynapsePayRest
     # @param client_secret [String] should be stored in environment variable
     # @param ip_address [String] user's IP address
     # @param fingerprint [String] a hashed value, either unique to user or static
-    # @param user_id [String] (optional)
     # @param development_mode [String] default true
     # @param logging [Boolean] (optional) logs to stdout when true
     # @param log_to [String] (optional) file path to log to file (logging must be true)
     def initialize(client_id:, client_secret:, ip_address:, fingerprint: nil,
-                   user_id: nil, development_mode: true, **options)
+                   development_mode: true, **options)
       base_url = if development_mode
                    'https://sandbox.synapsepay.com/api/3'
                  else
@@ -37,7 +36,6 @@ module SynapsePayRest
       @http_client  = HTTPClient.new(base_url: base_url,
                                      client_id: client_id,
                                      client_secret: client_secret,
-                                     user_id: user_id,
                                      fingerprint: fingerprint,
                                      ip_address: ip_address,
                                      **options)

data/lib/synapse_pay_rest/http_client.rb

@@ -8,31 +8,29 @@ module SynapsePayRest
     #   @return [String] the base url of the API (production or sandbox)
     # @!attribute [rw] config
     #   @return [Hash] various settings related to request headers
-    # @!attribute [rw] user_id
-    #   @return [String] the user_id which is stored upon a call to Users#get or Users#create
-    attr_accessor :base_url, :config, :user_id
+    attr_accessor :base_url, :config
 
     # @param base_url [String] the base url of the API (production or sandbox)
     # @param client_id [String]
     # @param client_secret [String]
     # @param fingerprint [String]
     # @param ip_address [String]
-    # @param user_id [String] (optional) automatically stored on call to Users#get or Users#create
     # @param logging [Boolean] (optional) logs to stdout when true
     # @param log_to [String] (optional) file path to log to file (logging must be true)
-    def initialize(base_url:, client_id:, fingerprint:, ip_address:, client_secret:,
-                   user_id: nil, **options)
-
+    def initialize(base_url:, client_id:, fingerprint:, ip_address:,
+                   client_secret:, **options)
       log_to         = options[:log_to] || 'stdout'
       RestClient.log = log_to if options[:logging]
+      @logging = options[:logging]
 
       @config = {
-        fingerprint:   fingerprint,
         client_id:     client_id,
-        client_secret: client_secret
+        client_secret: client_secret,
+        fingerprint:   fingerprint,
+        ip_address:    ip_address,
+        oauth_key:     '',
       }
       @base_url = base_url
-      @user_id  = user_id
     end
 
     # Returns headers for HTTP requests.
@@ -52,9 +50,8 @@ module SynapsePayRest
     # Alias for #headers (legacy name)
     alias_method :get_headers, :headers
 
-    # Updates headers and/or user_id.
+    # Updates headers.
     # 
-    # @param user_id [String,void]
     # @param oauth_key [String,void]
     # @param fingerprint [String,void]
     # @param client_id [String,void]
@@ -62,11 +59,8 @@ module SynapsePayRest
     # @param ip_address [String,void]
     # 
     # @return [void]
-    # 
-    # @todo logic to update user_id doesn't belong here
-    def update_headers(user_id: nil, oauth_key: nil, fingerprint: nil,
-                       client_id: nil, client_secret: nil, ip_address: nil)
-      self.user_id           = user_id if user_id
+    def update_headers(oauth_key: nil, fingerprint: nil, client_id: nil,
+                       client_secret: nil, ip_address: nil, **options)
       config[:fingerprint]   = fingerprint if fingerprint
       config[:oauth_key]     = oauth_key if oauth_key
       config[:client_id]     = client_id if client_id
@@ -85,6 +79,7 @@ module SynapsePayRest
     # @return [Hash] API response
     def post(path, payload)
       response = with_error_handling { RestClient.post(full_url(path), payload.to_json, headers) }
+      p 'RESPONSE:', JSON.parse(response) if @logging
       JSON.parse(response)
     end
 
@@ -98,6 +93,7 @@ module SynapsePayRest
     # @return [Hash] API response
     def patch(path, payload)
       response = with_error_handling { RestClient.patch(full_url(path), payload.to_json, headers) }
+      p 'RESPONSE:', JSON.parse(response) if @logging
       JSON.parse(response)
     end
 
@@ -110,6 +106,7 @@ module SynapsePayRest
     # @return [Hash] API response
     def get(path)
       response = with_error_handling { RestClient.get(full_url(path), headers) }
+      p 'RESPONSE:', JSON.parse(response) if @logging
       JSON.parse(response)
     end
 
@@ -122,6 +119,7 @@ module SynapsePayRest
     # @return [Hash] API response
     def delete(path)
       response = with_error_handling { RestClient.delete(full_url(path), headers) }
+      p 'RESPONSE:', JSON.parse(response) if @logging
       JSON.parse(response)
     end
 

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

@@ -25,7 +25,7 @@ module SynapsePayRest
 
         payload = payload_for_create_via_bank_login(bank_name: bank_name, username: username, password: password)
         user.authenticate
-        response = user.client.nodes.add(payload: payload)
+        response = user.client.nodes.add(user_id: user.id, payload: payload)
         # MFA questions
         if response['mfa']
           create_unverified_node(user, response)
@@ -89,7 +89,7 @@ module SynapsePayRest
       end
 
       payload = verify_microdeposits_payload(amount1: amount1, amount2: amount2)
-      response = user.client.nodes.patch(node_id: id, payload: payload)
+      response = user.client.nodes.patch(user_id: user.id, node_id: id, payload: payload)
       self.class.from_response(user, response)
     end
 

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

@@ -39,7 +39,7 @@ module SynapsePayRest
 
         payload = payload_for_create(nickname: nickname, **options)
         user.authenticate
-        response = user.client.nodes.add(payload: payload)
+        response = user.client.nodes.add(user_id: user.id, payload: payload)
         from_response(user, response['nodes'].first)
       end
 
@@ -65,7 +65,12 @@ module SynapsePayRest
         end
         
         user.authenticate
-        response = user.client.nodes.get(page: page, per_page: per_page, type: self.type)
+        response = user.client.nodes.get(
+          user_id: user.id,
+          page: page,
+          per_page: per_page,
+          type: self.type
+        )
         multiple_from_response(user, response['nodes'])
       end
 
@@ -258,7 +263,7 @@ module SynapsePayRest
     # @return [:success]
     def deactivate
       user.authenticate
-      user.client.nodes.delete(node_id: id)
+      user.client.nodes.delete(user_id: user.id, node_id: id)
       :success
     end
 

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

@@ -62,7 +62,12 @@ module SynapsePayRest
         end
 
         user.authenticate
-        response = user.client.nodes.get(page: page, per_page: per_page, type: type)
+        response = user.client.nodes.get(
+          user_id: user.id,
+          page: page,
+          per_page: per_page,
+          type: type
+        )
         multiple_from_response(user, response['nodes'])
       end
 

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

@@ -1,5 +1,7 @@
 module SynapsePayRest
   # Represents a Synapse node allowing any user to hold Nepali Rupees.
+  # 
+  # @deprecated
   class SynapseNpNode < BaseNode
     class << self
       private

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

@@ -1,6 +1,7 @@
 module SynapsePayRest
-  # Represents a Synapse node allowing any user to hold funds. You can use this
-  # node as a wallet, an escrow account or something else along those lines.
+  # Represents a subaccount inside a FBO account at Triumph Bank.
+  # 
+  # @deprecated
   class TriumphSubaccountUsNode < BaseNode
     class << self
       private

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

@@ -31,7 +31,7 @@ module SynapsePayRest
     # @todo make a new Error subclass for incorrect MFA
     def answer_mfa(answer)
       payload  = payload_for_answer_mfa(answer: answer)
-      response = user.client.nodes.post(payload: payload)
+      response = user.client.nodes.post(user_id: user.id, payload: payload)
       
       handle_answer_mfa_response(response)
     end

data/lib/synapse_pay_rest/models/transaction/transaction.rb

@@ -8,7 +8,6 @@ module SynapsePayRest
   #   better to refactor this into a mixin altogether since this shouldn't be instantiated. 
   # @todo reduce duplicated logic between User/BaseNode/Transaction
   class Transaction
-
     # @!attribute [rw] node
     #   @return [SynapsePayRest::Node] the node to which the transaction belongs
     attr_reader :node, :id, :amount, :currency, :client_id, :client_name, :created_on,
@@ -53,7 +52,11 @@ module SynapsePayRest
         payload = payload_for_create(node: node, to_type: to_type, to_id: to_id,
           amount: amount, currency: currency, ip: ip, **options)
         node.user.authenticate
-        response = node.user.client.trans.create(node_id: node.id, payload: payload)
+        response = node.user.client.trans.create(
+          user_id: node.user.id,
+          node_id: node.id,
+          payload: payload
+        )
         from_response(node, response)
       end
 
@@ -71,7 +74,11 @@ module SynapsePayRest
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 
         node.user.authenticate
-        response = node.user.client.trans.get(node_id: node.id, trans_id: id)
+        response = node.user.client.trans.get(
+          user_id: node.user.id,
+          node_id: node.id,
+          trans_id: id
+        )
         from_response(node, response)
       end
 
@@ -94,7 +101,12 @@ module SynapsePayRest
         end
 
         node.user.authenticate
-        response = node.user.client.trans.get(node_id: node.id, page: page, per_page: per_page)
+        response = node.user.client.trans.get(
+          user_id: node.user.id,
+          node_id: node.id,
+          page: page,
+          per_page: per_page
+        )
         multiple_from_response(node, response['trans'])
       end
 
@@ -190,7 +202,12 @@ module SynapsePayRest
     # @return [Array<SynapsePayRest::Transaction>] (self)
     def add_comment(comment)
       payload = {'comment': comment}
-      response = node.user.client.trans.update(node_id: node.id, trans_id: id, payload: payload)
+      response = node.user.client.trans.update(
+        user_id: node.user.id,
+        node_id: node.id,
+        trans_id: id,
+        payload: payload
+      )
       self.class.from_response(node, response['trans'])
     end
 
@@ -200,7 +217,11 @@ module SynapsePayRest
     # 
     # @return [Array<SynapsePayRest::Transaction>] (self)
     def cancel
-      response = node.user.client.trans.delete(node_id: node.id, trans_id: id)
+      response = node.user.client.trans.delete(
+        user_id: node.user.id,
+        node_id: node.id,
+        trans_id: id
+      )
       self.class.from_response(node, response)
     end
 

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

@@ -165,7 +165,7 @@ module SynapsePayRest
     # @return [SynapsePayRest::BaseDocument] new instance with updated info (id will be different if email or phone changed)
     def submit
       user.authenticate
-      response = user.client.users.update(payload: payload_for_submit)
+      response = user.client.users.update(user_id: user.id, payload: payload_for_submit)
       @user    = User.from_response(user.client, response)
 
       if id
@@ -212,7 +212,7 @@ module SynapsePayRest
       end
       user.authenticate
       payload  = payload_for_update(changes)
-      response = user.client.users.update(payload: payload)
+      response = user.client.users.update(user_id: user.id, payload: payload)
       @user    = User.from_response(user.client, response)
 
       if id

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

@@ -174,7 +174,6 @@ module SynapsePayRest
     #   to instantiate via API action.
     def initialize(**options)
       options.each { |key, value| instance_variable_set("@#{key}", value) }
-      @client.http_client.user_id = id
       @base_documents  ||= []
     end
 
@@ -203,7 +202,7 @@ module SynapsePayRest
           read_only, phone_number, legal_name, remove_phone_number, remove_login'
       end
       authenticate
-      response = client.users.update(payload: payload_for_update(options))
+      response = client.users.update(user_id: id, payload: payload_for_update(options))
       # return an updated user instance
       self.class.from_response(client, response)
     end
@@ -308,7 +307,7 @@ module SynapsePayRest
     # 
     # @return [SynapsePayRest::User] (self)
     def authenticate
-      client.users.refresh(payload: payload_for_refresh)
+      client.users.refresh(user_id: id, payload: payload_for_refresh)
       self
     end
 
@@ -342,7 +341,7 @@ module SynapsePayRest
 
       payload = payload_for_refresh
       payload['phone_number'] = device
-      client.users.refresh(payload: payload)
+      client.users.refresh(user_id: id, payload: payload)
       :success
     end
 
@@ -362,7 +361,7 @@ module SynapsePayRest
       payload = payload_for_refresh
       payload['phone_number']   = device
       payload['validation_pin'] = pin
-      client.users.refresh(payload: payload)
+      client.users.refresh(user_id: id, payload: payload)
       :success
     end
 

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

@@ -30,7 +30,7 @@ module SynapsePayRest
     # @todo should raise error if any questions aren't answered yet.
     def submit_kba
       user     = base_document.user
-      response = user.client.users.update(payload: payload_for_kba)
+      response = user.client.users.update(user_id: user.id, payload: payload_for_kba)
       user     = User.from_response(user.client, response)
       base_doc = user.base_documents.find { |doc| doc.id == base_document.id }
       ssn_doc  = base_doc.virtual_documents.find { |doc| doc.id == id }

data/lib/synapse_pay_rest/version.rb

@@ -1,4 +1,4 @@
 module SynapsePayRest
-  # gem version
-  VERSION = '2.1.0'.freeze
+  # gem version:
+  VERSION = '2.2.0'.freeze
 end

data/samples.md

@@ -221,7 +221,7 @@ social_doc = SynapsePayRest::SocialDocument.create(
 )
 
 # reassign base_doc to the output because it returns a new instance
-base_doc = base_doc.add_social_documents([social_doc])
+base_doc = base_doc.add_social_documents(social_doc)
 # => #<SynapsePayRest::BaseDocument>
 ```
 
@@ -234,7 +234,7 @@ virtual_doc = SynapsePayRest::VirtualDocument.create(
 )
 
 # reassign base_doc to the output because it returns a new instance
-base_doc = base_doc.add_virtual_documents([virtual_doc])
+base_doc = base_doc.add_virtual_documents(virtual_doc)
 # => #<SynapsePayRest::BaseDocument>
 ```
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2016-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client