synapse_pay_rest 2.0.2 → 2.1.0

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

@@ -1,7 +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.
-  class SynapseUsNode < SynapseNode
+  class SynapseUsNode < BaseNode
     class << self
       private
 
@@ -10,13 +10,7 @@ module SynapsePayRest
           type: 'SYNAPSE-US',
           nickname: nickname
         }.merge(options)
-        payload = super(args)
-        # optional payload fields
-        extra = {}
-        extra['supp_id']            = options[:supp_id] if options[:supp_id]
-        extra['gateway_restricted'] = options[:gateway_restricted] if options[:gateway_restricted]
-        payload['extra'] = extra if extra.any?
-        payload
+        super(args)
       end
     end
   end

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

@@ -0,0 +1,17 @@
+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.
+  class TriumphSubaccountUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, **options)
+        args = {
+          type: 'TRIUMPH-SUBACCOUNT-US',
+          nickname: nickname
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

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

@@ -53,7 +53,7 @@ module SynapsePayRest
       if response['error_code'] == '0'
         # correct answer
         @mfa_verified = true
-        AchUsNode.create_multiple_from_response(user, response['nodes'])
+        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 = {

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

@@ -1,6 +1,6 @@
 module SynapsePayRest
   # Represents a non-US account for wire payments.
-  class WireIntNode < WireNode
+  class WireIntNode < BaseNode
     class << self
       private 
 
@@ -11,12 +11,11 @@ module SynapsePayRest
           nickname: nickname,
           bank_name: bank_name,
           account_number: account_number,
+          swift: swift,
           name_on_account: name_on_account,
           address: address
         }.merge(options)
-        payload = super(args)
-        payload['info']['swift'] = swift
-        payload
+        super(args)
       end
     end
   end

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

@@ -1,6 +1,6 @@
 module SynapsePayRest
   # Represents a US bank account for processing wire payments.
-  class WireUsNode < WireNode
+  class WireUsNode < BaseNode
     class << self
       private
 
@@ -15,7 +15,6 @@ module SynapsePayRest
           name_on_account: name_on_account,
           address: address
         }.merge(options)
-        
         super(args)
       end
     end

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

@@ -54,7 +54,7 @@ module SynapsePayRest
           amount: amount, currency: currency, ip: ip, **options)
         node.user.authenticate
         response = node.user.client.trans.create(node_id: node.id, payload: payload)
-        create_from_response(node, response)
+        from_response(node, response)
       end
 
       # Queries the API for a transaction belonging to the supplied node by transaction id
@@ -72,7 +72,7 @@ module SynapsePayRest
 
         node.user.authenticate
         response = node.user.client.trans.get(node_id: node.id, trans_id: id)
-        create_from_response(node, response)
+        from_response(node, response)
       end
 
       # Queries the API for all transactions belonging to the supplied node and returns
@@ -95,7 +95,7 @@ module SynapsePayRest
 
         node.user.authenticate
         response = node.user.client.trans.get(node_id: node.id, page: page, per_page: per_page)
-        create_multiple_from_response(node, response['trans'])
+        multiple_from_response(node, response['trans'])
       end
 
       # Creates a Transaction from a response hash.
@@ -104,7 +104,7 @@ module SynapsePayRest
       # 
       # @todo convert the nodes and users in response into User/Node objects
       # @todo rework to handle multiple fees
-      def create_from_response(node, response)
+      def from_response(node, response)
         args = {
           node:          node,
           id:            response['_id'],
@@ -156,7 +156,7 @@ module SynapsePayRest
         payload['extra']['process_on'] = options[:process_in] if options[:process_in]
         other = {}
         other['attachments'] = options[:attachments] if options[:attachments]
-        payload['other'] = other if other.any?
+        payload['extra']['other'] = other if other.any?
         fees = []
         fee = {}
         fee['fee']  = options[:fee_amount] if options[:fee_amount]
@@ -169,9 +169,9 @@ module SynapsePayRest
         payload
       end
 
-      def create_multiple_from_response(node, response)
+      def multiple_from_response(node, response)
         return [] if response.empty?
-        response.map { |trans_data| create_from_response(node, trans_data) }
+        response.map { |trans_data| from_response(node, trans_data) }
       end
     end
 
@@ -191,7 +191,7 @@ module SynapsePayRest
     def add_comment(comment)
       payload = {'comment': comment}
       response = node.user.client.trans.update(node_id: node.id, trans_id: id, payload: payload)
-      self.class.create_from_response(node, response['trans'])
+      self.class.from_response(node, response['trans'])
     end
 
     # Cancels this transaction if it has not already settled.
@@ -201,7 +201,7 @@ module SynapsePayRest
     # @return [Array<SynapsePayRest::Transaction>] (self)
     def cancel
       response = node.user.client.trans.delete(node_id: node.id, trans_id: id)
-      self.class.create_from_response(node, response)
+      self.class.from_response(node, response)
     end
 
     # Checks if two Transaction instances have same id (different instances of same record).

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

@@ -93,21 +93,21 @@ module SynapsePayRest
 
       # Parses multiple base_documents from response
       # @note Do not call directly (it's automatic).
-      def create_from_response(user, response)
+      def from_response(user, response)
         base_documents_data = response['documents']
         base_documents_data.map do |base_document_data|
           physical_docs = base_document_data['physical_docs'].map do |data|
-            doc = PhysicalDocument.create_from_response(data)
+            doc = PhysicalDocument.from_response(data)
             doc.base_document = self
             doc
           end
           social_docs = base_document_data['social_docs'].map do |data|
-            doc = SocialDocument.create_from_response(data)
+            doc = SocialDocument.from_response(data)
             doc.base_document = self
             doc
           end
           virtual_docs = base_document_data['virtual_docs'].map do |data|
-            doc = VirtualDocument.create_from_response(data)
+            doc = VirtualDocument.from_response(data)
             doc.base_document = self
             doc
           end
@@ -166,14 +166,13 @@ module SynapsePayRest
     def submit
       user.authenticate
       response = user.client.users.update(payload: payload_for_submit)
-      @user    = User.create_from_response(user.client, response)
+      @user    = User.from_response(user.client, response)
 
       if id
         # return updated version of self
         user.base_documents.find { |doc| doc.id == id }
       else
         # first time submission, assume last doc is updated version of self
-        require 'pry'; 
         user.base_documents.last
       end
     end
@@ -214,7 +213,7 @@ module SynapsePayRest
       user.authenticate
       payload  = payload_for_update(changes)
       response = user.client.users.update(payload: payload)
-      @user    = User.create_from_response(user.client, response)
+      @user    = User.from_response(user.client, response)
 
       if id
         # return updated version of self
@@ -228,13 +227,12 @@ module SynapsePayRest
     # Adds one or more physical documents to the base document and submits
     # them to the API using KYC 2.0 endpoints.
     # 
-    # @param documents [Array<SynapsePayRest::PhysicalDocument>]
+    # @param documents [Array<SynapsePayRest::PhysicalDocument>] (one or more documents)
     # 
     # @raise [SynapsePayRest::Error]
     # 
     # @return [SynapsePayRest::BaseDocument] new instance with updated info
-    def add_physical_documents(documents)
-      raise ArgumentError, 'must be an Array' unless documents.is_a?(Array)
+    def add_physical_documents(*documents)
       unless documents.first.is_a?(PhysicalDocument)
         raise ArgumentError, 'must contain a PhysicalDocument'
       end
@@ -245,13 +243,12 @@ module SynapsePayRest
     # Adds one or more social documents to the base document and submits
     # them to the API using KYC 2.0 endpoints.
     # 
-    # @param documents [Array<SynapsePayRest::SocialDocument>]
+    # @param documents [Array<SynapsePayRest::SocialDocument>] (one or more documents)
     # 
     # @raise [SynapsePayRest::Error]
     # 
     # @return [SynapsePayRest::BaseDocument] new instance with updated info
-    def add_social_documents(documents)
-      raise ArgumentError, 'must be an Array' unless documents.is_a?(Array)
+    def add_social_documents(*documents)
       unless documents.first.is_a?(SocialDocument)
         raise ArgumentError, 'must contain a SocialDocument'
       end
@@ -262,13 +259,12 @@ module SynapsePayRest
     # Adds one or more virtual documents to the base document and submits
     # them to the API using KYC 2.0 endpoints.
     # 
-    # @param documents [Array<SynapsePayRest::VirtualDocument>]
+    # @param documents [Array<SynapsePayRest::VirtualDocument>] (one or more documents)
     # 
     # @raise [SynapsePayRest::Error]
     # 
     # @return [SynapsePayRest::BaseDocument] new instance with updated info
-    def add_virtual_documents(documents)
-      raise ArgumentError, 'must be an Array' unless documents.is_a?(Array)
+    def add_virtual_documents(*documents)
       unless documents.first.is_a?(VirtualDocument)
         raise ArgumentError, 'must contain a VirtualDocument'
       end

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

@@ -11,7 +11,7 @@ module SynapsePayRest
     attr_accessor :base_document, :status, :id, :type, :value, :last_updated
 
     class << self
-      # Creates a document instances but does not submit it to the API. Use
+      # 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.
       # 
@@ -34,7 +34,7 @@ module SynapsePayRest
       end
 
       # @note Do not call this method. It is used by child classes only.
-      def create_from_response(data)
+      def from_response(data)
         self.new(
           type:         data['document_type'],
           id:           data['id'],

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

@@ -1,29 +1,70 @@
+require 'open-uri'
+
 module SynapsePayRest
   # Represents physical documents that can be added to a base document.
   #
   # @see https://docs.synapsepay.com/docs/user-resources#section-physical-document-types
   #   physical document types
   class PhysicalDocument < Document
-    # Converts the document into hash format for use in request JSON.
-    # @note You shouldn't need to call this directly.
-    #
-    # @return [Hash]
-    def to_hash
-      {'document_value' => to_base64(value), 'document_type' => type}
-    end
 
-    private
+    class << self
+      # 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 
+      #   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
+      def create(type:, **options)
+        if options[:file_path]
+          value = self.file_to_base64(options[:file_path])
+        elsif options[:url]
+          value = self.url_to_base64(options[:url])
+        elsif options[:byte_stream]
+          value = self.byte_stream_to_base64(options[:byte_stream], options[:mime_type])
+        elsif options[:value]
+          value = options[:value]
+        end
+          
+        super(type: type, value: value)
+      end
+
+      # Converts the supplied image url to padded base64
+      def url_to_base64(url)
+        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
+        rescue
+          mime_type = nil
+        end
+        byte_stream_to_base64(byte_stream, mime_type)
+      end
 
-    # Converts the supplied file to base64 encoding so it can be uploaded to API.
-    def to_base64(file_path)
-      raise ArgumentError, 'file_path must be a String' unless file_path.is_a?(String)
+      # Converts the supplied image file to padded base64
+      def file_to_base64(file_path)
+        raise ArgumentError, 'file_path must be a String' unless file_path.is_a?(String)
+        url_to_base64(file_path)
+      end
 
-      content_types = MIME::Types.type_for(file_path)
-      file_type = content_types.first.content_type if content_types.any?
-      file_contents = open(file_path) { |f| f.read }
-      encoded = Base64.encode64(file_contents)
-      mime_padding = "data:#{file_type};base64,"
-      mime_padding + encoded
+      # 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
+      end
     end
   end
 end

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

@@ -58,7 +58,7 @@ module SynapsePayRest
 
         payload = payload_for_create(logins: logins, phone_numbers: phone_numbers, legal_names: legal_names, **options)
         response = client.users.create(payload: payload)
-        create_from_response(client, response)
+        from_response(client, response)
       end
 
       # Queries the API for a user by id and returns a User instances if found.
@@ -74,7 +74,7 @@ module SynapsePayRest
         raise ArgumentError, 'id must be a String' unless id.is_a?(String)
 
         response = client.users.get(user_id: id)
-        create_from_response(client, response)
+        from_response(client, response)
       end
 
       # Queries the API for all users (with optional filters) and returns them
@@ -101,7 +101,7 @@ module SynapsePayRest
         end
 
         response = client.users.get(page: page, per_page: per_page, query: query)
-        create_multiple_from_response(client, response['users'])
+        multiple_from_response(client, response['users'])
       end
 
       # Queries the API for all users with name/email matching the given query
@@ -141,7 +141,7 @@ module SynapsePayRest
 
       # Constructs a user instance from a user response.
       # @note Do not call directly.
-      def create_from_response(client, response)
+      def from_response(client, response)
         user = self.new(
           client:            client,
           id:                response['_id'],
@@ -157,16 +157,16 @@ module SynapsePayRest
         )
 
         unless response['documents'].empty?
-          base_documents = BaseDocument.create_from_response(user, response)
+          base_documents = BaseDocument.from_response(user, response)
           user.base_documents = base_documents
         end
         user
       end
 
-      # Calls create_from_response on each member of a response collection.
-      def create_multiple_from_response(client, response)
+      # Calls from_response on each member of a response collection.
+      def multiple_from_response(client, response)
         return [] if response.empty?
-        response.map { |user_data| create_from_response(client, user_data)}
+        response.map { |user_data| from_response(client, user_data)}
       end
     end
 
@@ -202,10 +202,10 @@ 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(payload: payload_for_update(options))
       # return an updated user instance
-      self.class.create_from_response(client, response)
+      self.class.from_response(client, response)
     end
 
     # Creates a new base document for the user. To update an existing base
@@ -435,6 +435,8 @@ module SynapsePayRest
     # @raise [SynapsePayRest::Error]
     # 
     # @return [SynapsePayRest::EftIndNode]
+    # 
+    # @deprecated
     def create_eft_ind_node(**options)
       EftIndNode.create(user: self, **options)
     end
@@ -490,6 +492,8 @@ module SynapsePayRest
     # @raise [SynapsePayRest::Error]
     # 
     # @return [SynapsePayRest::SynapseIndNode]
+    # 
+    # @deprecated
     def create_synapse_ind_node(**options)
       SynapseIndNode.create(user: self, **options)
     end
@@ -520,6 +524,19 @@ module SynapsePayRest
       SynapseUsNode.create(user: self, **options)
     end
 
+    # Creates a TRIUMPH-SUBACCOUNT-US node.
+    # 
+    # @param nickname [String] nickname for the node
+    # @param supp_id [String] (optional)
+    # @param gateway_restricted [Boolean] (optional)
+    # 
+    # @raise [SynapsePayRest::Error]
+    # 
+    # @return [SynapsePayRest::TriumphSubaccountUsNode]
+    def create_triumph_subaccount_us_node(**options)
+      TriumphSubaccountUsNode.create(user: self, **options)
+    end
+
     # Creates a WIRE-INT node.
     # 
     # @param nickname [String] nickname for the node