synapse_pay_rest 2.2.3 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6838fb99b9172f2110365b17cbe0958bd35d83f
-  data.tar.gz: c1af1430a94a956fbe9391e37d32a8a6adf81e7f
+  metadata.gz: 3d201dae4eb740319963ab42443361cd8fad2d5a
+  data.tar.gz: 40d4b70997bebff7e71f30fbc25ddc076c728cc6
 SHA512:
-  metadata.gz: 08b62065ca6fc61717a65ac965e1278069bd23065f86feb5a5a4138b88474a63301c12ca54caaf7c984235f31446f602f0918a3f1b732091f61133a0f5a39eee
-  data.tar.gz: 132d1b8370e090f87c7041f52744f4164801656fb105131962ca8c9705bd14ef1c238419f48f6ddc61c4b55509587e9ad60e6d11ba775b1473a2c9ab5fb7d140
+  metadata.gz: accdfae93f38d4d0ca80d50e63afc6a7d30f511f34569c709facd33e954baf6dea7378628dfcca88661d3b1955aefda1cf7fe73e8f49dad754b058cedd8f580b
+  data.tar.gz: a283391d0a7d766425d1ad52c670d5630fa535ad1d03b0eb36198b8ccc20f11d2162f05403c6e8af8d9b58c96c785d8aa1658d24eecc3b091642d9260132b833

data/.env.sample

@@ -0,0 +1,8 @@
+# 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

data/.gitignore

@@ -30,7 +30,7 @@ build/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 
@@ -42,4 +42,4 @@ build/
 ## ENV variables and other secrets
 .env
 test.txt
-*.yml
+*.yml

data/README.md

@@ -2,19 +2,8 @@
 
 Native API library for SynapsePay REST v3.x
 
-Originally developed as a simple wrapper to handle the headers and endpoint URLs for each API request, as of v2.0.0 it now handles creation of User, Node, Transaction and related objects to remove the necessity of dealing with raw payload and response JSON.
-
 Not all API endpoints are supported.
 
-**Pre-2.0.0 users**
-
-There are significant changes but backwards compatibility has been mostly maintained by building on top of the base API wrapper. You can still use the previous classes but note the following changes:
-
-- `ArgumentError` will be raised for missing payloads or other required arguments, where `RuntimeError` was raised previously. 
-- `development_mode` now defaults to true (gem previously defaulted to production).
-- KYC 1.0 methods for uploading documents have been deprecated. Please contact SynapsePay if you need to update to KYC 2.0.
-- API errors will now raise `SynapsePayRest::Error`s instead returning a JSON hash (and sometimes obfuscating the API error message).
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -43,16 +32,11 @@ $ gem install synapse_pay_rest
 
 ## Contributing
 
-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.
+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
 
-Make sure these values are set as enviroment variables (using [dotenv](https://github.com/bkeepers/dotenv) for example):
-
-```
-CLIENT_ID=your_sandbox_client_id
-CLIENT_SECRET=your_sandbox_client_secret
-```
+If you haven't already, run `cp .env.sample .env` and set the `TEST_CLIENT_ID` and `TEST_CLIENT_SECRET` environment variables.
 
 To run all tests, execute:
 
@@ -60,7 +44,7 @@ To run all tests, execute:
 rake
 ```
 
-To run a specific file or test, install the [m](https://github.com/qrush/m) gem and execute:
+To run a specific file or test run:
 
 ```bash
 m path/to/file:line_number

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'synapse_pay_rest'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'dotenv'
+Dotenv.load
+
+require 'irb'
+IRB.start

data/lib/synapse_pay_rest/api/transactions.rb

@@ -57,9 +57,9 @@ module SynapsePayRest
     # HTTP response from API
     # 
     # @return [Hash] API response
-    def create(user_id:, node_id:, payload:)
+    def create(user_id:, node_id:, payload:, idempotency_key: nil)
       path = create_transaction_path(user_id: user_id, node_id: node_id)
-      client.post(path, payload)
+      client.post(path, payload, idempotency_key: idempotency_key)
     end
 
     # Sends a PATCH request to /trans endpoint to update a transaction. 

data/lib/synapse_pay_rest/client.rb

@@ -28,7 +28,7 @@ module SynapsePayRest
     def initialize(client_id:, client_secret:, ip_address:, fingerprint: nil,
                    development_mode: true, **options)
       base_url = if development_mode
-                   'https://sandbox.synapsepay.com/api/3'
+                   'https://uat-api.synapsefi.com/v3.1'
                  else
                    'https://synapsepay.com/api/3'
                  end

data/lib/synapse_pay_rest/error.rb

@@ -54,20 +54,20 @@ module SynapsePayRest
     # @todo need to add an error message for various 202 cases (fingerprint, mfa, etc)
     # @todo doesn't do well when there's an html response from nginx for bad gateway/timeout
     ERRORS = {
-      400 => SynapsePayRest::Error::BadRequest,
-      401 => SynapsePayRest::Error::Unauthorized,
-      402 => SynapsePayRest::Error::RequestDeclined,
-      403 => SynapsePayRest::Error::Forbidden,
-      404 => SynapsePayRest::Error::NotFound,
-      406 => SynapsePayRest::Error::NotAcceptable,
-      409 => SynapsePayRest::Error::Conflict,
-      415 => SynapsePayRest::Error::UnsupportedMediaType,
-      422 => SynapsePayRest::Error::UnprocessableEntity,
-      429 => SynapsePayRest::Error::TooManyRequests,
-      500 => SynapsePayRest::Error::InternalServerError,
-      502 => SynapsePayRest::Error::BadGateway,
-      503 => SynapsePayRest::Error::ServiceUnavailable,
-      504 => SynapsePayRest::Error::GatewayTimeout
+      '400' => SynapsePayRest::Error::BadRequest,
+      '401' => SynapsePayRest::Error::Unauthorized,
+      '402' => SynapsePayRest::Error::RequestDeclined,
+      '403' => SynapsePayRest::Error::Forbidden,
+      '404' => SynapsePayRest::Error::NotFound,
+      '406' => SynapsePayRest::Error::NotAcceptable,
+      '409' => SynapsePayRest::Error::Conflict,
+      '415' => SynapsePayRest::Error::UnsupportedMediaType,
+      '422' => SynapsePayRest::Error::UnprocessableEntity,
+      '429' => SynapsePayRest::Error::TooManyRequests,
+      '500' => SynapsePayRest::Error::InternalServerError,
+      '502' => SynapsePayRest::Error::BadGateway,
+      '503' => SynapsePayRest::Error::ServiceUnavailable,
+      '504' => SynapsePayRest::Error::GatewayTimeout
     }.freeze
 
     # The SynapsePay API Error Code
@@ -86,10 +86,10 @@ module SynapsePayRest
       # @param body [String]
       # @param code [Integer]
       # @return [SynapsePayRest::Error]
-      def error_from_response(body, code)
+      def from_response(body)
         # require 'pry'; binding.pry
-        klass = ERRORS[code.to_i] || SynapsePayRest::Error
-        message, error_code = parse_error(body)
+        message, error_code, http_code = parse_error(body)
+        klass = ERRORS[http_code] || SynapsePayRest::Error
         klass.new(message: message, code: error_code, response: body)
       end
 
@@ -97,9 +97,9 @@ module SynapsePayRest
 
       def parse_error(body)
         if body.nil? || body.empty?
-          ['', nil]
+          ['', nil, nil]
         elsif body.is_a?(Hash) && body['error'].is_a?(Hash)
-          [body['error']['en'], body['error_code']]
+          [body['error']['en'], body['error_code'], body['http_code']]
         end
       end
     end
@@ -112,7 +112,7 @@ module SynapsePayRest
     # @return [SynapsePayRest::Error]
     def initialize(message: '', code: nil, response: {})
       super(message)
-      @code = code
+      @code     = code
       @response = response
     end
   end

data/lib/synapse_pay_rest/http_client.rb

@@ -21,7 +21,7 @@ module SynapsePayRest
                    client_secret:, **options)
       log_to         = options[:log_to] || 'stdout'
       RestClient.log = log_to if options[:logging]
-      @logging = options[:logging]
+      @logging       = options[:logging]
 
       @config = {
         client_id:     client_id,
@@ -73,11 +73,17 @@ module SynapsePayRest
     # 
     # @param path [String]
     # @param payload [Hash]
-    # 
+    # @param idempotency_key [String] (optional) avoid accidentally performing the same operation twice
+    #
     # @raise [SynapsePayRest::Error] subclass depends on HTTP response
     # 
     # @return [Hash] API response
-    def post(path, payload)
+    def post(path, payload, **options)
+      headers = get_headers
+      if options[:idempotency_key]
+        headers = headers.merge({'X-SP-IDEMPOTENCY-KEY' => options[:idempotency_key]})
+      end
+
       response = with_error_handling { RestClient.post(full_url(path), payload.to_json, headers) }
       p 'RESPONSE:', JSON.parse(response) if @logging
       JSON.parse(response)
@@ -133,7 +139,7 @@ module SynapsePayRest
       yield
     rescue RestClient::Exception => e
       body = JSON.parse(e.response.body)
-      raise Error.error_from_response(body, body['error_code'])
+      raise Error.from_response(body)
     end
   end
 end

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

@@ -24,7 +24,6 @@ module SynapsePayRest
         raise ArgumentError, 'password must be a String' unless password.is_a?(String)
 
         payload = payload_for_create_via_bank_login(bank_name: bank_name, username: username, password: password)
-        user.authenticate
         response = user.client.nodes.add(user_id: user.id, payload: payload)
         # MFA questions
         if response['mfa']

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

@@ -38,7 +38,6 @@ module SynapsePayRest
         raise ArgumentError, 'nickname must be a String' unless nickname.is_a?(String)
 
         payload = payload_for_create(nickname: nickname, **options)
-        user.authenticate
         response = user.client.nodes.add(user_id: user.id, payload: payload)
         from_response(user, response['nodes'].first)
       end
@@ -64,7 +63,6 @@ module SynapsePayRest
           raise ArgumentError, "type must be nil or in #{NODE_TYPES_TO_CLASSES.keys}"
         end
         
-        user.authenticate
         response = user.client.nodes.get(
           user_id: user.id,
           page: page,
@@ -221,7 +219,8 @@ module SynapsePayRest
     # @param fee_note [String] (optional)
     # @param fee_to_id [String] (optional) node id to which to send the fee
     # @param supp_id [String] (optional)
-    # 
+    # @param idempotency_key [String] (optional) avoid accidentally performing the same operation twice
+    #
     # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
     # 
     # @return [SynapsePayRest::Transaction]
@@ -262,14 +261,19 @@ module SynapsePayRest
     # 
     # @return [:success]
     def deactivate
-      user.authenticate
-      user.client.nodes.delete(user_id: user.id, node_id: id)
-      :success
+      response = user.client.nodes.delete(user_id: user.id, node_id: id)
+      if response['_id']
+        # api v3.1.1
+        self.class.from_response(user, response)
+      else
+        # api v3.1
+        nil
+      end
     end
 
     # Checks if two BaseNode instances have same id (different instances of same record).
     def ==(other)
-      other.instance_of?(self.class) && !id.nil? &&  id == other.id 
+      other.instance_of?(self.class) && !id.nil? && id == other.id
     end
   end
 end

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

@@ -33,7 +33,6 @@ module SynapsePayRest
         raise ArgumentError, 'user must be a User object' unless user.is_a?(User)
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 
-        user.authenticate
         response = user.client.nodes.get(user_id: user.id, node_id: id)
         from_response(user, response)
       end
@@ -61,7 +60,6 @@ module SynapsePayRest
           raise ArgumentError, "type must be nil or in #{NODE_TYPES_TO_CLASSES.keys}"
         end
 
-        user.authenticate
         response = user.client.nodes.get(
           user_id: user.id,
           page: page,

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

@@ -54,16 +54,8 @@ module SynapsePayRest
         # correct answer
         @mfa_verified = true
         AchUsNode.multiple_from_response(user, response['nodes'])
-      elsif response['error_code'] == '10' && response['mfa']['message'] == mfa_message
-        # wrong answer (mfa message the same), retry if allowed
-        args = {
-          message: 'incorrect bank login mfa answer',
-          code: response['http_code'], 
-          response: response
-        }
-        raise SynapsePayRest::Error, args
       elsif response['error_code'] == '10'
-        # new additional MFA question. need to call #answer_mfa with new answer
+        # wrong answer or new additional MFA question
         @mfa_access_token = response['mfa']['access_token']
         @mfa_message      = response['mfa']['message']
         self

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

@@ -4,16 +4,14 @@ module SynapsePayRest
     class << self
       private
 
-      def payload_for_create(nickname:, bank_name:, account_number:, routing_number:,
-        name_on_account:, address:, **options)
+      def payload_for_create(nickname:, account_number:, routing_number:,
+        name_on_account:, **options)
         args = {
           type: 'WIRE-US',
           nickname: nickname,
-          bank_name: bank_name,
           account_number: account_number,
           routing_number: routing_number,
-          name_on_account: name_on_account,
-          address: address
+          name_on_account: name_on_account
         }.merge(options)
         super(args)
       end

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

@@ -4,8 +4,7 @@ module SynapsePayRest
   # is intended to make it easier to use the API without knowing payload formats
   # or knowledge of REST.
   # 
-  # @todo use mixins to remove duplication between Node and BaseNode. May be 
-  #   better to refactor this into a mixin altogether since this shouldn't be instantiated. 
+  # @todo use mixins to remove duplication between Node and BaseNode.
   # @todo reduce duplicated logic between User/BaseNode/Transaction
   class Transaction
     # @!attribute [rw] node
@@ -28,11 +27,13 @@ module SynapsePayRest
       # @param ip [String]
       # @param note [String] (optional)
       # @param process_in [Integer] (optional) days until processed (default/minimum 1)
-      # @param fee_amount [Float] (optional) fee amount to add to the transaction
-      # @param fee_to_id [String] (optional) node id to which to send the fee (must be SYNAPSE-US)
-      # @param fee_note [String] (optional)
+      # @param fees [Array] (optional) fee amounts to add to the transaction. Example: [{fee: 1.0, note: 'Test Fee', to: {id: 'fee_node_id'}}]
+      # @param fee_amount [Float] (deprecated) fee amount to add to the transaction
+      # @param fee_to_id [String] (deprecated) node id to which to send the fee (must be SYNAPSE-US)
+      # @param fee_note [String] (deprecated)
       # @param supp_id [String] (optional)
-      # 
+      # @param idempotency_key [String] (optional)
+      #
       # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
       # 
       # @return [SynapsePayRest::Transaction]
@@ -46,16 +47,18 @@ module SynapsePayRest
         raise ArgumentError, 'node must be a type of BaseNode object' unless node.is_a?(BaseNode)
         raise ArgumentError, 'amount must be a Numeric (Integer or Float)' unless amount.is_a?(Numeric)
         [to_type, to_id, currency, ip].each do |arg|
-          raise ArgumentError, "#{arg} must be a String" unless arg.is_a?(String)
+          if options[arg] && !options[arg].is_a?(String)
+            raise ArgumentError, "#{arg} must be a String"
+          end
         end
 
         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(
           user_id: node.user.id,
           node_id: node.id,
-          payload: payload
+          payload: payload,
+          idempotency_key: options[:idempotency_key],
         )
         from_response(node, response)
       end
@@ -73,7 +76,6 @@ module SynapsePayRest
         raise ArgumentError, 'node must be a type of BaseNode object' unless node.is_a?(BaseNode)
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 
-        node.user.authenticate
         response = node.user.client.trans.get(
           user_id: node.user.id,
           node_id: node.id,
@@ -100,7 +102,6 @@ module SynapsePayRest
           end
         end
 
-        node.user.authenticate
         response = node.user.client.trans.get(
           user_id: node.user.id,
           node_id: node.id,
@@ -137,11 +138,13 @@ module SynapsePayRest
           from:          response['from'],
           to:            response['to'],
           to_type:       response['to']['type'],
-          to_id:         response['to']['id'],
-          fee_amount:    response['fees'].last['fee'],
-          fee_note:      response['fees'].last['note'],
-          fee_to_id:     response['fees'].last['to']['id'],
+          to_id:         response['to']['id']
         }
+        if response['fees'].any?
+          args[:fee_amount] = response['fees'].first['fee']
+          args[:fee_note]   = response['fees'].first['note']
+          args[:fee_to_id]  = response['fees'].first['to']['id']
+        end
         self.new(args)
       end
 
@@ -170,6 +173,7 @@ module SynapsePayRest
         other['attachments'] = options[:attachments] if options[:attachments]
         payload['extra']['other'] = other if other.any?
         fees = []
+        # deprecated fee flow
         fee = {}
         fee['fee']  = options[:fee_amount] if options[:fee_amount]
         fee['note'] = options[:fee_note] if options[:fee_note]
@@ -177,6 +181,8 @@ module SynapsePayRest
         fee_to['id'] = options[:fee_to_id] if options[:fee_to_id]
         fee['to'] = fee_to if fee_to.any?
         fees << fee if fee.any?
+        # new fee flow
+        fees = options[:fees] if options[:fees]
         payload['fees'] = fees if fees.any?
         payload
       end
@@ -208,7 +214,13 @@ module SynapsePayRest
         trans_id: id,
         payload: payload
       )
-      self.class.from_response(node, response['trans'])
+      if response['trans']
+        # api v3.1
+        self.class.from_response(node, response['trans'])
+      else
+        # api v3.1.1
+        self.class.from_response(node, response)
+      end
     end
 
     # Cancels this transaction if it has not already settled.
@@ -227,7 +239,7 @@ module SynapsePayRest
 
     # Checks if two Transaction instances have same id (different instances of same record).
     def ==(other)
-      other.instance_of?(self.class) && !id.nil? &&  id == other.id 
+      other.instance_of?(self.class) && !id.nil? && id == other.id
     end
   end
 end

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

@@ -164,7 +164,6 @@ 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(user_id: user.id, payload: payload_for_submit)
       @user    = User.from_response(user.client, response)
 
@@ -210,7 +209,6 @@ module SynapsePayRest
       if changes.empty?
         raise ArgumentError, 'must provide some key-value pairs to update'
       end
-      user.authenticate
       payload  = payload_for_update(changes)
       response = user.client.users.update(user_id: user.id, payload: payload)
       @user    = User.from_response(user.client, response)

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

@@ -11,19 +11,19 @@ module SynapsePayRest
       # Creates a document instance but does not submit it to the API. Use
       # BaseDocument#create/#update/#add_physical_documents or related methods
       # to submit the document to the API.
-      # 
-      # @note This should only be called on subclasses of Document, not on 
+      #
+      # @note This should only be called on subclasses of Document, not on
       #   Document itself.
-      # 
+      #
       # @param type [String]
       # @param value [String] (optional) padded base64-encoded image ("data:#{mime_type};base64,#{base64}")
       # @param file_path [String] (optional) path to image file
       # @param url [String] (optional) image file url
       # @param byte_stream [String] (optional) byte representation of image
       # @param mime_type [String] (optional) mime type of byte_stream (e.g. 'image/png')
-      # 
+      #
       # @return [SynapsePayRest::Document]
-      # 
+      #
       # @see https://docs.synapsepay.com/docs/user-resources#section-physical-document-types physical document types
       # @see https://docs.synapsepay.com/docs/user-resources#section-social-document-types social document types
       # @see https://docs.synapsepay.com/docs/user-resources#section-virtual-document-types virtual document types
@@ -37,7 +37,7 @@ module SynapsePayRest
         elsif options[:value]
           value = options[:value]
         end
-          
+
         super(type: type, value: value)
       end
 
@@ -46,7 +46,8 @@ module SynapsePayRest
         raise ArgumentError, 'url must be a String' unless url.is_a?(String)
         byte_stream = open(url).read
         begin
-          mime_type = MIME::Types.type_for(url).first.content_type
+          # remove any query params to get the mime type
+          mime_type = MIME::Types.type_for(url.gsub(/\?.*$/, '')).first.content_type
         rescue
           mime_type = nil
         end
@@ -62,8 +63,7 @@ module SynapsePayRest
       # Converts the supplied image byte stream to padded base64
       def byte_stream_to_base64(byte_stream, mime_type)
         base64 = Base64.encode64(byte_stream)
-        padding = "data:#{mime_type};base64,#{base64}"
-        padding + base64
+        "data:#{mime_type};base64,#{base64}"
       end
     end
   end

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

@@ -1,6 +1,8 @@
 module SynapsePayRest
   # Represents a question that is triggered when a document is returned with
   # status MFA|PENDING.
+  # 
+  # @deprecated
   class Question
     # @!attribute [r] question
     #   @return [String] the text of the question

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

@@ -4,8 +4,7 @@ module SynapsePayRest
   # is intended to make it easier to use the API without knowing payload formats
   # or knowledge of REST.
   # 
-  # @todo use mixins to remove duplication between Node and BaseNode. May be 
-  #   better to refactor this into a mixin altogether since this shouldn't be instantiated. 
+  # @todo use mixins to remove duplication between Node and BaseNode.
   # @todo reduce duplicated logic between User/BaseNode/Transaction
   class User
     # @!attribute [rw] base_documents
@@ -89,6 +88,8 @@ module SynapsePayRest
       # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
       # 
       # @return [Array<SynapsePayRest::User>]
+      # 
+      # @note users created this way are not automatically OAuthed
       def all(client:, page: nil, per_page: nil, query: nil)
         raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
         [page, per_page].each do |arg|
@@ -116,6 +117,8 @@ module SynapsePayRest
       # @raise [SynapsePayRest::Error] if HTTP error or invalid argument format
       # 
       # @return [Array<SynapsePayRest::User>]
+      # 
+      # @note users created this way are not automatically OAuthed
       def search(client:, query:, page: nil, per_page: nil)
         all(client: client, query: query, page: page, per_page: per_page)
       end
@@ -141,7 +144,7 @@ module SynapsePayRest
 
       # Constructs a user instance from a user response.
       # @note Do not call directly.
-      def from_response(client, response)
+      def from_response(client, response, oauth: true)
         user = self.new(
           client:            client,
           id:                response['_id'],
@@ -160,13 +163,14 @@ module SynapsePayRest
           base_documents = BaseDocument.from_response(user, response)
           user.base_documents = base_documents
         end
-        user
+        oauth ? user.authenticate : user
       end
 
       # Calls from_response on each member of a response collection.
+      # @note users created this way are not automatically OAuthed
       def multiple_from_response(client, response)
         return [] if response.empty?
-        response.map { |user_data| from_response(client, user_data)}
+        response.map { |user_data| from_response(client.dup, user_data, oauth: false)}
       end
     end
 
@@ -177,6 +181,16 @@ module SynapsePayRest
       @base_documents  ||= []
     end
 
+    # Updates the oauth token.
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::User] (self)
+    def authenticate
+      client.users.refresh(user_id: id, payload: payload_for_refresh)
+      self
+    end
+
     # Updates the given key value pairs.
     # 
     # @param login [Hash]
@@ -201,7 +215,6 @@ module SynapsePayRest
         raise ArgumentError, 'must provide a key-value pair to update. keys: login,
           read_only, phone_number, legal_name, remove_phone_number, remove_login'
       end
-      authenticate
       response = client.users.update(user_id: id, payload: payload_for_update(options))
       # return an updated user instance
       self.class.from_response(client, response)
@@ -301,16 +314,6 @@ module SynapsePayRest
       update(remove_phone_number: phone_number)
     end
 
-    # Updates the user's oauth token.
-    # 
-    # @raise [SynapsePayRest::Error]
-    # 
-    # @return [SynapsePayRest::User] (self)
-    def authenticate
-      client.users.refresh(user_id: id, payload: payload_for_refresh)
-      self
-    end
-
     # Step 1 of fingerprint registration. Requests a new fingerprint be
     # registered to the user.
     # 
@@ -582,7 +585,7 @@ module SynapsePayRest
 
     # Checks if two User instances have same id (different instances of same record).
     def ==(other)
-      other.instance_of?(self.class) && !id.nil? &&  id == other.id 
+      other.instance_of?(self.class) && !id.nil? && id == other.id
     end
 
     private

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

@@ -27,10 +27,9 @@ module SynapsePayRest
     #
     # @return [SynapsePayRest::VirtualDocument] (self)
     #
-    # @todo should raise error if any questions aren't answered yet.
+    # @deprecated
     def submit_kba
       user = base_document.user
-      user.authenticate()
       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 }
@@ -38,6 +37,8 @@ module SynapsePayRest
     end
 
     # Maps question set from response to Question objects.
+    # 
+    # @deprecated
     def add_question_set(question_set_data)
       questions = question_set_data['questions'].map do |question_info|
         # re-map question/answer hash structure
@@ -58,6 +59,7 @@ module SynapsePayRest
 
     private
 
+    # @deprecated
     def payload_for_kba
       {
         'documents' => [{

data/lib/synapse_pay_rest/version.rb

@@ -1,4 +1,4 @@
 module SynapsePayRest
-  # gem version:
-  VERSION = '2.2.3'.freeze
+  # Gem version
+  VERSION = '3.0.1'.freeze
 end

data/samples.md

@@ -1,8 +1,16 @@
+# Setup
+
+First, run `cp .env.sample .env` if you haven't already and make sure `CLIENT_ID`, `CLIENT_SECRET`, and `FINGERPRINT` are set.
+
+Start a console that will load this gem and your settings from `.env` automatically.
+
+```
+$ ./bin/console
+```
+
 ## Initialization
 
 ```ruby
-require 'synapse_pay_rest'
-
 args = {
   # synapse client_id
   client_id:        ENV.fetch('CLIENT_ID'),
@@ -272,7 +280,7 @@ base_doc = virtual_doc.base_document
 
 ## Node Methods
 
-#### All Nodes for a User 
+#### All Nodes for a User
 
 ##### a) User#nodes
 
@@ -310,7 +318,7 @@ Returns a collection of `AchUsNode`s associated with the account unless bank req
 
 ```ruby
 login_info = {
-  bank_name: 'bofa',
+  bank_name: 'fake',
   username:  'synapse_good',
   password:  'test1234'
 }

data/synapse_pay_rest.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.required_ruby_version = '>= 2.1.0'
+
   s.add_dependency 'rest-client', '~> 2.0'
 
   s.add_development_dependency 'bundler', '~> 1.10'
@@ -26,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'dotenv', '~> 2.1.1'
   s.add_development_dependency 'faker', '~> 1.6.6'
   s.add_development_dependency 'simplecov', '~> 0.12.0'
+  s.add_development_dependency 'm', '~> 1.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 3.0.1
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-21 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -123,18 +123,33 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: 
 email: help@synapsepay.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
 - ".gitignore"
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- bin/console
 - lib/synapse_pay_rest.rb
 - lib/synapse_pay_rest/api/nodes.rb
 - lib/synapse_pay_rest/api/transactions.rb
@@ -179,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -187,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: SynapsePay v3 Rest Native API Library

data/Gemfile.lock

@@ -1,61 +0,0 @@
-PATH
-  remote: .
-  specs:
-    synapse_pay_rest (2.0.0)
-      rest-client (~> 2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ansi (1.5.0)
-    builder (3.2.2)
-    docile (1.1.5)
-    domain_name (0.5.20160826)
-      unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.1.1)
-    faker (1.6.6)
-      i18n (~> 0.5)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    mime-types (3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    minitest (5.8.2)
-    minitest-reporters (1.1.5)
-      ansi
-      builder
-      minitest (>= 5.0)
-      ruby-progressbar
-    netrc (0.11.0)
-    rake (10.4.2)
-    rest-client (2.0.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    ruby-progressbar (1.7.5)
-    simplecov (0.12.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.10)
-  dotenv (~> 2.1.1)
-  faker (~> 1.6.6)
-  minitest (~> 5.8.2)
-  minitest-reporters (~> 1.1.5)
-  rake (~> 10.0)
-  simplecov (~> 0.12.0)
-  synapse_pay_rest!
-
-BUNDLED WITH
-   1.13.0