synapse_fi 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db4628f944245e8f114018422dd581ab76696dc1
-  data.tar.gz: 2012839aaa6f312aefe8c189d10decd073d35903
+  metadata.gz: 8cc51024fe0828282d58774469281168581763a1
+  data.tar.gz: d22606acecf1fad82d2fa6dc0cf4ab4a09ca277a
 SHA512:
-  metadata.gz: b29bb8ee533e012e3be5e7667f338223d192501a6ad54bf891fb55f4c1ee4d50d16f66e08fda977ab6c619a1721bc475f42e6e7797d2c184d5e90d891d7c7b99
-  data.tar.gz: 3a9474f1cae6af2b4c33a3968d0c59c210ac13305cb21408c5f12b691699d328ad22412c4a3042251276579927e5839498fb9a9a5175d506c3fa81f273a58210
+  metadata.gz: 1306539458898b0f9431f245a6c4dc78c69e9870c9c3a43e476cef037114145ccad809b99a965d4213e7543df88c1298ba5d39e931ccefd5b704c730ccc7a0a4
+  data.tar.gz: '08f46888c70fa12e9025171c8553770979d20e48f693849c4081004042fbe324dbe42049f68c34cb765fae657537fb2f5db0a5615a25be434ad9ce878b09cfdc'

data/.gitignore

@@ -1,3 +1,3 @@
 .env
-test
+.DS_Store
 

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in your *.gemspec file
 gemspec
+

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    synapse_fi (0.0.3)
+      rest-client (~> 2.0)
+
 GEM
   remote: https://rubygems.org/
   specs:
@@ -5,26 +11,25 @@ GEM
     builder (3.2.3)
     domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.5.0)
+    dotenv (2.1.2)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     mime-types (3.2.2)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2018.0812)
-    minitest (5.11.3)
-    minitest-reporters (1.3.5)
+    minitest (5.8.5)
+    minitest-reporters (1.1.19)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
     netrc (0.11.0)
+    rake (10.5.0)
     rest-client (2.0.2)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     ruby-progressbar (1.10.0)
-    synapse_pay_rest (3.4.3)
-      rest-client (~> 2.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
@@ -34,10 +39,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
-  dotenv
-  minitest
-  minitest-reporters
-  synapse_pay_rest
+  dotenv (~> 2.1.1)
+  minitest (~> 5.8.2)
+  minitest-reporters (~> 1.1.5)
+  rake (~> 10.0)
+  synapse_fi!
 
 BUNDLED WITH
    1.17.1

data/README.md

@@ -1,6 +1,6 @@
 # SynapseFI-Ruby-v2
 
-Native API library for SynapsePay REST v3.x
+Native API library for SynapseFI REST v3.x
 
 Not all API endpoints are supported.
 
@@ -32,6 +32,17 @@ $ gem install synapse_fi
 
 For minor issues, please open a pull request. For larger changes or features, please email hello@synapsepay.com. Please document and test any public constants/methods.
 
+## Running the Test Suite
+
+If you haven't already, set the `TEST_CLIENT_ID` and `TEST_CLIENT_SECRET` environment variables in `.env` file .
+Please read and update test files with your user own test id's
+
+To run all tests, execute:
+
+```bash
+rake test
+```
+
 ## License
 
 [MIT License](LICENSE)

data/Rakefile

@@ -2,8 +2,8 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
   t.libs << "lib"
+  t.libs << "test"
   t.test_files = FileList['test/*_test.rb']
 end
 

data/lib/synapse_api/client.rb

@@ -1,4 +1,3 @@
-require 'json'
 require_relative './http_request'
 require_relative './user'
 require_relative './users'
@@ -12,8 +11,6 @@ require_relative './subnet'
 require_relative './subnets'
 require 'pp'
 
-
-
 module Synapse
 	# Initializes various wrapper settings such as development mode and request
  	# header values
@@ -29,7 +26,6 @@ module Synapse
   	# Alias for #http_client
   	alias_method :client, :http_client
 
-
   	# @param client_id [String] should be stored in environment variable
     # @param client_secret [String] should be stored in environment variable
     # @param ip_address [String] user's IP address
@@ -52,7 +48,8 @@ module Synapse
                                      fingerprint: fingerprint,
                                      ip_address: ip_address,
                                      raise_for_202: raise_for_202,
-                                     **options)
+                                     **options
+                                     )
     end
 
     # Queries Synapse API to create a new user
@@ -63,14 +60,12 @@ module Synapse
     def create_user(payload:, **options)
       response = client.post(user_path,payload, options)
 
-      user = User.new(
-            user_id:           response['_id'],
-            refresh_token:     response['refresh_token'],
-            client:            client,
-            full_dehydrate:    "no",
-            payload:           response
-          )
-      user
+      User.new(user_id:           response['_id'],
+               refresh_token:     response['refresh_token'],
+               client:            client,
+               full_dehydrate:    "no",
+               payload:           response
+              )
 	  end
 
     # Update headers in HTTPClient class
@@ -97,14 +92,12 @@ module Synapse
   		path = user_path(user_id: user_id, full_dehydrate: options[:full_dehydrate])
   		response = client.get(path)
 
-  		user = User.new(
-            user_id:                response['_id'],
-            refresh_token:     response['refresh_token'],
-            client:            client,
-            full_dehydrate:    options[:full_dehydrate] == "yes" ? true : false,
-            payload:           response
-          )
-      user
+  		User.new(user_id:         response['_id'],
+               refresh_token:   response['refresh_token'],
+               client:          client,
+               full_dehydrate:  options[:full_dehydrate] == "yes" ? true : false,
+               payload:         response
+              )
   	end
 
   	# Queries Synapse API for platform users
@@ -112,16 +105,24 @@ module Synapse
     # users with matching name/email
     # @param page [Integer] (optional) response will default to 1
     # @param per_page [Integer] (optional) response will default to 20
-    # @note users created this way are not automatically OAuthed
     # @return [Array<Synapse::Users>]
   	def get_users(**options)
   		path = user_path(options)
   		response = client.get(path)
   		return [] if response["users"].empty?
-  		users = response["users"].map { |user_data| User.new(user_id: user_data['_id'], refresh_token: user_data['refresh_token'], client: client, full_dehydrate: "no", payload: user_data)}
-  		users = Users.new(limit: response["limit"], page: response["page"], page_count: response["page_count"], user_count: response["user_count"], payload: users, http_client: client)
-
-      users
+  		users = response["users"].map { |user_data| User.new(user_id:         user_data['_id'],
+                                                           refresh_token:   user_data['refresh_token'],
+                                                           client:          client,
+                                                           full_dehydrate:  "no",
+                                                           payload:         user_data
+                                                           )}
+  		Users.new(limit:       response["limit"],
+                page:        response["page"],
+                page_count:  response["page_count"],
+                user_count:  response["user_count"],
+                payload:     users,
+                http_client: client
+               )
   	end
 
     # Queries Synapse for all transactions on platform
@@ -141,9 +142,12 @@ module Synapse
 
   		return [] if trans["trans"].empty?
   		response = trans["trans"].map { |trans_data| Transaction.new(trans_id: trans_data['_id'], payload: trans_data)}
-  		trans = Transactions.new(limit: trans["limit"], page: trans["page"], page_count: trans["page_count"], trans_count: trans["trans_count"], payload: response)
-  		trans
-
+  		Transactions.new(limit:       trans["limit"],
+                       page:        trans["page"],
+                       page_count:  trans["page_count"],
+                       trans_count: trans["trans_count"],
+                       payload:     response
+                       )
   	end
 
     # Queries Synapse API for all nodes belonging to platform
@@ -160,8 +164,17 @@ module Synapse
   		nodes = client.get(path)
 
   		return [] if nodes["nodes"].empty?
-  		response = nodes["nodes"].map { |node_data| Node.new(node_id: node_data['_id'], user_id: node_data['user_id'], payload: node_data, full_dehydrate: "no")}
-  		nodes = Nodes.new(limit: nodes["limit"], page: nodes["page"], page_count: nodes["page_count"], nodes_count: nodes["node_count"], payload: response)
+  		response = nodes["nodes"].map { |node_data| Node.new(node_id:        node_data['_id'],
+                                                           user_id:        node_data['user_id'],
+                                                           payload:        node_data,
+                                                           full_dehydrate: "no"
+                                                           )}
+  		Nodes.new(limit:       nodes["limit"],
+                page:        nodes["page"],
+                page_count:  nodes["page_count"],
+                nodes_count: nodes["node_count"],
+                payload:     response
+               )
   	end
 
     # Queries Synapse API for all institutions available for bank logins
@@ -173,18 +186,12 @@ module Synapse
   	end
 
     # Queries Synapse API to create a webhook subscriptions for platform
-    # @param scope [Array<String>]
+    # @param scope [Hash]
     # @param idempotency_key [String] (optional)
-    # @param url [String]
     # @see https://docs.synapsefi.com/docs/create-subscription
     # @return [Synapse::Subscription]
-  	def create_subscriptions(scope:, url:, **options)
-  		payload = {
-            'scope' => scope,
-            'url' => url,
-          }
-
-  		response = client.post(subscriptions_path , payload, options)
+  	def create_subscriptions(scope:, **options)
+  		response = client.post(subscriptions_path , scope, options)
 
   		Subscription.new(subscription_id: response["_id"], url: response["url"], payload: response)
   	end
@@ -197,11 +204,17 @@ module Synapse
   		subscriptions = client.get(subscriptions_path(options))
 
   		return [] if subscriptions["subscriptions"].empty?
-  		response = subscriptions["subscriptions"].map { |subscription_data| Subscription.new(subscription_id: subscription_data["_id"], url: subscription_data["url"], payload: subscription_data)}
-  		subscriptions = Subscriptions.new(limit: subscriptions["limit"], page: subscriptions["page"], page_count: subscriptions["page_count"], subscriptions_count: subscriptions["subscription_count"], payload: response)
+  		response = subscriptions["subscriptions"].map { |subscription_data| Subscription.new(subscription_id: subscription_data["_id"],
+                                                                                           url: subscription_data["url"],
+                                                                                           payload: subscription_data)}
+  		Subscriptions.new(limit:               subscriptions["limit"],
+                        page:                subscriptions["page"],
+                        page_count:          subscriptions["page_count"],
+                        subscriptions_count: subscriptions["subscription_count"],
+                        payload:             response
+                        )
   	end
 
-
     # Queries Synapse API for a subscription by subscription_id
     # @param subscription_id [String]
     # @return [Synapse::Subscription]
@@ -211,34 +224,30 @@ module Synapse
   		Subscription.new(subscription_id: response["_id"], url: response["url"], payload: response)
   	end
 
-    # updates subscription platform subscription
+    # Updates subscription platform subscription
     # @param subscription_id [String]
-    # @param is_active [boolean]
-    # @param url [String]
-    # @param scope [Array<String>]
+    # @param body [Hash]
     # see https://docs.synapsefi.com/docs/update-subscription
     # @return [Synapse::Subscription]
-    def update_subscriptions(subscription_id:, url:nil, scope:nil, is_active:nil)
+    def update_subscriptions(subscription_id:, body:)
       path = subscriptions_path + "/#{subscription_id}"
 
-      payload = {}
-
-      payload["url"] = url if url
-      payload["scope"] = scope if scope
-      payload["is_active"] = is_active if is_active
-
-      response = client.patch(path, payload)
+      response = client.patch(path, body)
       Subscription.new(subscription_id: response["_id"], url: response["url"], payload: response)
     end
 
+    # Returns all of the webhooks belonging to client
+    # @return [Hash]
+    def webhook_logs()
+      path = subscriptions_path + "/logs"
+      client.get(path)
+    end
 
   	# Issues public key for client
-  	# @param client [Synapse::Client]
   	# @param scope [String]
     # @see https://docs.synapsefi.com/docs/issuing-public-key
   	# @note valid scope "OAUTH|POST,USERS|POST,USERS|GET,USER|GET,USER|PATCH,SUBSCRIPTIONS|GET,SUBSCRIPTIONS|POST,SUBSCRIPTION|GET,SUBSCRIPTION|PATCH,CLIENT|REPORTS,CLIENT|CONTROLS"
   	def issue_public_key(scope:)
-  		raise ArgumentError, 'scope must be a string' unless scope.is_a?(String)
   		path = '/client?issue_public_key=YES'
   		path += "&scope=#{scope}"
   		response = client.get(path)
@@ -293,9 +302,7 @@ module Synapse
       data
     end
 
-
     private
-
     def user_path(user_id: nil, **options)
     	path = "/users"
     	path += "/#{user_id}" if user_id

data/lib/synapse_api/error.rb

@@ -16,28 +16,12 @@ module Synapse
     # Raised on the HTTP status code 402
     RequestDeclined = Class.new(ClientError)
 
-    # Raised on the HTTP status code 403
-    # Forbidden = Class.new(ClientError)
-    # '403' => Synapse::Error::Forbidden,
-
     # Raised on the HTTP status code 404
     NotFound = Class.new(ClientError)
 
-    # Raised on the HTTP status code 406
-    # NotAcceptable = Class.new(ClientError)
-    # '406' => Synapse::Error::NotAcceptable,
-
     # Raised on the HTTP status code 409
     Conflict = Class.new(ClientError)
 
-    # Raised on the HTTP status code 415
-    # UnsupportedMediaType = Class.new(ClientError)
-    # '415' => Synapse::Error::UnsupportedMediaType,
-
-    # Raised on the HTTP status code 422
-    # UnprocessableEntity = Class.new(ClientError)
-    # '422' => Synapse::Error::UnprocessableEntity,
-
     # Raised on the HTTP status code 429
     TooManyRequests = Class.new(ClientError)
 
@@ -47,21 +31,10 @@ module Synapse
     # Raised on the HTTP status code 500
     InternalServerError = Class.new(ServerError)
 
-    # Raised on the HTTP status code 502
-    # BadGateway = Class.new(ServerError)
-    # '502' => Synapse::Error::BadGateway,
-
     # Raised on the HTTP status code 503
     ServiceUnavailable = Class.new(ServerError)
 
-    # Raised on the HTTP status code 504
-    # GatewayTimeout = Class.new(ServerError)
-    # '504' => Synapse::Error::GatewayTimeout
-
     # HTTP status code to Error subclass mapping
-    #
-    # @todo doesn't do well when there's an html response from nginx for bad gateway/timeout
-
     ERRORS = {
       '202' => Synapse::Error::Accepted,
       '400' => Synapse::Error::BadRequest,

data/lib/synapse_api/http_request.rb

@@ -1,7 +1,6 @@
 require 'rest-client'
 require 'open-uri'
 require 'json'
-require_relative './error'
 
 module Synapse
 	# Wrapper for HTTP requests using RestClient.
@@ -93,7 +92,12 @@ module Synapse
     		headers = headers.merge({'X-SP-IDEMPOTENCY-KEY' => options[:idempotency_key]})
     	end
 
-    	response = with_error_handling { RestClient::Request.execute(:method => :post, :url => full_url(path), :payload => payload.to_json, :headers => headers, :timeout => 300) }
+    	response = with_error_handling { RestClient::Request.execute(:method =>  :post,
+                                                                   :url =>     full_url(path),
+                                                                   :payload => payload.to_json,
+                                                                   :headers => headers,
+                                                                   :timeout => 300
+                                                                   ) }
     	puts 'RESPONSE:', JSON.parse(response) if @logging
     	response = JSON.parse(response)
 
@@ -148,7 +152,12 @@ module Synapse
     # @return [Hash] API response
     # @raise [Synapse::Error] subclass depends on HTTP response
 		def patch(path, payload)
-			response = with_error_handling {RestClient::Request.execute(:method => :patch, :url => full_url(path), :payload => payload.to_json, :headers => headers, :timeout => 300)}
+			response = with_error_handling {RestClient::Request.execute(:method =>  :patch,
+                                                                  :url =>     full_url(path),
+                                                                  :payload => payload.to_json,
+                                                                  :headers => headers,
+                                                                  :timeout => 300
+                                                                  )}
 			p 'RESPONSE:', JSON.parse(response) if @logging
 			response = JSON.parse(response)