synapse_pay_rest 0.0.11 → 0.0.13

data/lib/synapse_pay_rest/http_client.rb

@@ -1,101 +1,112 @@
 require 'rest-client'
+require 'json'
 
 module SynapsePayRest
-	class HTTPClient
-
-		attr_accessor :base_url
-		attr_accessor :options
-		attr_accessor :headers
-		attr_accessor :user_id
-
-		def initialize(options, base_url, user_id: nil)
-			@options = options
-			user = '|%s' %options['fingerprint']
-			if options.has_key?('oauth_key')
-				user = '%s|%s' % [options['oauth_key'], options['fingerprint']]
-			end
-			gateway = '%s|%s' % [options['client_id'], options['client_secret']]
-			@headers = {
-				:content_type => :json,
-				:accept => :json,
-				'X-SP-GATEWAY' => gateway,
-				'X-SP-USER' => user,
-				'X-SP-USER-IP' => options['ip_address']
-			}
-			@base_url = base_url
-			# RestClient.log = 'stdout'
-			@user_id = user_id
-		end
-
-		def update_headers(user_id: nil, oauth_key: nil, fingerprint: nil, client_id: nil, client_secret: nil, ip_address: nil)
-			if user_id
-				@user_id = user_id
-			end
-			if oauth_key and !fingerprint
-				@headers['X-SP-USER'] = '%s|%s' % [oauth_key, @options['fingerprint']]
-			elsif oauth_key and fingerprint
-				@headers['X-SP-USER'] = '%s|%s' % [oauth_key, fingerprint]
-			end
-
-			if client_id and !client_secret
-				@headers['X-SP-GATEWAY'] = '%s|%s' % [client_id, @options['client_secret']]
-			elsif client_id and client_secret
-				@headers['X-SP-GATEWAY'] = '%s|%s' % [client_id, client_secret]
-			elsif !client_id and client_secret
-				@headers['X-SP-GATEWAY'] = '%s|%s' % [@options['client_id'], client_secret]
-			end
-
-			if ip_address
-				@headers['X-SP-USER-IP'] = ip_address
-			end
-		end
-				
-
-		def post(path, payload)
-			url = base_url + path
-			response = begin
-				RestClient.post(url,
-					payload.to_json,
-					@headers)
-			rescue Exception => e
-				return JSON.parse(e.response)
-			end
-			return JSON.parse(response)
-		end
-
-		def patch(path, payload)
-			url = base_url + path
-			response = begin
-				RestClient.patch(url,
-					payload.to_json,
-					@headers)
-			rescue Exception => e
-				puts url
-				return JSON.parse(e.response)
-			end
-			return JSON.parse(response)
-		end
-
-		def get(path)
-			url = base_url + path
-			response = begin
-				RestClient.get(url,
-					@headers)
-			rescue Exception => e
-				return JSON.parse(e.response)
-			end
-			return JSON.parse(response)
-		end
-
-		def delete(path)
-			url = base_url + path
-			response = begin
-				RestClient.delete(url,
-					@headers)
-			rescue Exception => e
-				return JSON.parse(e.response)
-			end
-			return JSON.parse(response)
-		end
-	end
-end
+  class HTTPClient
+
+    attr_accessor :base_url, :config, :headers, :user_id
+
+    def initialize(config, base_url, user_id: nil)
+      @config = config
+      @base_url = base_url
+      # RestClient.log = 'stdout'
+      @user_id = user_id
+    end
+
+    def get_headers
+      user    = "#{config['oauth_key']}|#{config['fingerprint']}"
+      gateway = "#{config['client_id']}|#{config['client_secret']}"
+      headers = {
+        :content_type => :json,
+        :accept => :json,
+        'X-SP-GATEWAY' => gateway,
+        'X-SP-USER' => user,
+        'X-SP-USER-IP' => config['ip_address'] 
+      }
+    end
+
+    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
+      config['fingerprint']   = fingerprint if fingerprint
+      config['oauth_key']     = oauth_key if oauth_key
+      config['client_id']     = client_id if client_id
+      config['client_secret'] = client_secret if client_secret
+      config['ip_address']    = ip_address if ip_address
+    end
+
+
+    def post(path, payload)
+      response = with_error_handling { RestClient.post(full_url(path), payload.to_json, get_headers) }
+      JSON.parse(response)
+    end
+
+    def patch(path, payload)
+      response = with_error_handling { RestClient.patch(full_url(path), payload.to_json, get_headers) }
+      JSON.parse(response)
+    end
+
+    def get(path)
+      response = with_error_handling { RestClient.get(full_url(path), get_headers) }
+      JSON.parse(response)
+    end
+
+    def delete(path)
+      response = with_error_handling { RestClient.delete(full_url(path), get_headers) }
+      JSON.parse(response)
+    end
+
+    private
+
+    def full_url(path)
+      "#{base_url}#{path}"
+    end
+
+    def with_error_handling
+      yield
+    rescue => e
+      # By the way, this is a really bad idea.
+      # See: https://www.relishapp.com/womply/ruby-style-guide/docs/exceptions
+      # The exceptions should be enumerated. Not all exceptions are going
+      # to be parsable by JSON. The only one that should be captured are the
+      # are the HTTP Client responses.
+      case e.response.code
+      when 400
+        return e.response
+      when 401
+        return e.response
+      when 409
+        return e.response
+      when 500
+        return e.response
+      when 405
+        return handle_method_not_allowed
+      when 502
+        #Raise a gateway error
+        return handle_gateway_error
+      when 504
+        #Raise a timeout error
+        return handle_timeout_error
+      else
+        #Raise a generic error
+        return handle_unknown_error
+      end
+    end
+
+    def handle_method_not_allowed
+      return {'success' => false, 'reason' => 'The method is not allowed. Check your id parameters.'}.to_json
+    end
+
+    def handle_gateway_error
+      return {'success' => false, 'reason' => 'The gateway appears to be down.  Check synapsepay.com or try again later.'}.to_json
+    end
+
+    def handle_timeout_error
+      return {'success' => false, 'reason' => 'A timeout has occurred.'}.to_json
+    end
+
+
+    def handle_unknown_error
+      return {'success' => false, 'reason' => 'Unknown error in library. Contact synapsepay.'}.to_json
+    end
+  end
+end

data/lib/synapse_pay_rest/version.rb

@@ -0,0 +1,3 @@
+module SynapsePayRest
+  VERSION = '0.0.13'
+end

data/samples.md

@@ -0,0 +1,276 @@
+
+## Initialization
+
+```ruby
+require 'synapse_pay_rest'
+
+options = {
+	'oauth_key' => USER_OAUTH KEY, # Optional
+	'fingerprint' => USER_FINGERPRINT,
+	'client_id' =>  YOUR_CLIENT_ID,
+	'client_secret' =>  YOUR_CLIENT_SECRET,
+	'ip_address' =>  USER_IP_ADDRESS,
+	'development_mode' =>  true #true will ping sandbox.synapsepay.com while false will ping synapsepay.com
+}
+
+USER_ID = ID_OF_USER # Optional
+
+client = SynapsePayRest::Client.new options: options, user_id: USER_ID
+
+```
+
+## User API Calls
+
+```ruby
+
+
+# Get All Users
+
+users_response = client.users.get
+
+
+# Create User
+
+create_payload = {
+	"logins" =>  [
+		{
+			"email" =>  "rubyTest@synapsepay.com",
+			"password" =>  "test1234",
+			"read_only" => false
+		}
+	],
+	"phone_numbers" =>  [
+		"901.111.1111"
+	],
+	"legal_names" =>  [
+		"RUBY TEST USER"
+	],
+	"extra" =>  {
+		"note" =>  "Interesting user",
+		"supp_id" =>  "122eddfgbeafrfvbbb",
+		"is_business" =>  false
+	}
+}
+
+create_response = client.users.create(payload: create_payload)
+
+
+# Get User
+
+user_response = client.users.get(user_id: USER_ID)
+
+
+# Update a User
+
+update_payload = {
+	"refresh_token" => "REFRESH_TOKEN",
+	"update":{
+		"login" => {
+			"email" => "test2ruby@email.com",
+			"password" => "test1234",
+			"read_only" => true
+		},
+		"phone_number" => "9019411111",
+		"legal_name" => "Some new name"
+	}
+}
+
+client.users.update(payload: update_payload)
+
+
+# Add Document
+
+ssn_payload = {
+		"doc" => {
+		"birth_day" => 4,
+		"birth_month" => 2,
+		"birth_year" => 1940,
+		"name_first" => "John",
+		"name_last" => "doe",
+		"address_street1" => "1 Infinite Loop",
+		"address_postal_code" => "95014",
+		"address_country_code" => "US",
+		"document_value" => "3333",
+		"document_type" => "SSN"
+	}
+}
+
+ssn_response = client.users.add_doc(payload: ssn_payload)
+
+
+# Answer KBA Questions
+
+kba_payload = {
+	"doc" => {
+		"question_set_id" => "557520ad343463000300005a",
+		"answers" => [
+			{ "question_id" =>  1, "answer_id" =>  1 },
+			{ "question_id" =>  2, "answer_id" =>  1 },
+			{ "question_id" =>  3, "answer_id" =>  1 },
+			{ "question_id" =>  4, "answer_id" =>  1 },
+			{ "question_id" =>  5, "answer_id" =>  1 }
+		]
+	}
+}
+
+kba_response = client.users.answer_kba(payload: kba_payload)
+
+
+# Attach a file
+
+file_response = client.users.attach_file(file_path: 'PATH_TO_FILE')
+
+
+# Refresh User
+
+oauth_payload = {
+	"refresh_token" =>  USER_REFRESH_TOKEN
+}
+
+oauth_response = client.users.refresh(payload: oauth_payload)
+
+```
+
+
+## Node API Calls
+
+```ruby
+
+
+# Get All Nodes
+
+nodes_response = client.nodes.get
+
+
+# Add SYNAPSE-US Node
+
+synapse_node_payload = {
+	"type" => "SYNAPSE-US",
+	"info" => {
+		"nickname" => "My Synapse Wallet"
+	},
+	"extra" => {
+		"supp_id" => "123sa"
+	}
+}
+
+synapse_node_response = client.nodes.add(payload: synapse_node_payload)
+
+
+# Add ACH-US node through account login
+
+login_payload = {
+	"type" => "ACH-US",
+	"info" => {
+		"bank_id" => "synapse_good",
+		"bank_pw" => "test1234",
+		"bank_name" => "fake"
+	}
+}
+
+login_response = client.nodes.add(payload: login_payload)
+
+
+# Verify ACH-US Node via MFA
+
+mfa_payload = {
+	"access_token" => ACCESS_TOKEN_IN_LOGIN_RESPONSE,
+	"mfa_answer" => "test_answer"
+}
+
+mfa_response = client.nodes.verify(payload: mfa_payload)
+
+
+# Add ACH-US Node through Account and Routing Number Details
+
+acct_rout_payload = {
+	"type" => "ACH-US",
+	"info" => {
+		"nickname" => "Ruby Library Savings Account",
+		"name_on_account" => "Ruby Library",
+		"account_num" => "72347235423",
+		"routing_num" => "051000017",
+		"type" => "PERSONAL",
+		"class" => "CHECKING"
+	},
+	"extra" => {
+		"supp_id" => "123sa"
+	}
+}
+
+acct_rout_response = client.nodes.add(payload: acct_rout_payload)
+
+
+# Verify ACH-US Node via Micro-Deposits
+
+micro_payload = {
+	"micro" => [0.1,0.1]
+}
+
+micro_response = client.nodes.verify(node_id: NODE_ID, payload: micro_payload)
+
+# Delete a Node
+
+delete_response = client.nodes.delete(node_id: NODE_ID)
+
+```
+
+## Transaction API Calls
+
+```ruby
+
+
+# Get All Transactions
+
+transactions_response = client.trans.get(node_id: NODE_ID)
+
+
+#Create a Transaction
+
+trans_payload = {
+	"to" => {
+		"type" => "SYNAPSE-US",
+		"id" => "560adb4e86c27331bb5ac86e"
+	},
+	"amount" => {
+		"amount" => 1.10,
+		"currency" => "USD"
+	},
+	"extra" => {
+		"supp_id" => "1283764wqwsdd34wd13212",
+		"note" => "Deposit to bank account",
+		"webhook" => "http => //requestb.in/q94kxtq9",
+		"process_on" => 1,
+		"ip" => "192.168.0.1"
+	},
+	"fees" => [{
+		"fee" => 1.00,
+		"note" => "Facilitator Fee",
+		"to" => {
+			"id" => "55d9287486c27365fe3776fb"
+		}
+	}]
+}
+
+create_response = client.trans.create(node_id: NODE_ID, payload: trans_payload)
+
+
+# Get a Transaction
+
+transaction_response = client.trans.get(node_id: NODE_ID, trans_id: TRANS_ID)
+
+
+# Update Transaction
+
+update_payload = {
+	"comment" =>  "hi"
+}
+
+update_response = client.trans.update(node_id: NODE_ID, trans_id: TRANS_ID, payload: update_payload)
+
+
+# Delete Transaction
+
+delete_trans_response = client.trans.delete(node_id: NODE_ID, trans_id: TRANS_ID)
+
+```