synapse_pay_rest 3.2.5 → 3.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 712e02a3aa89c4f26d4f770a56478c9853bc1a08
-  data.tar.gz: 41e153b3fa82b7aefc3714c254088f8674a050c7
+  metadata.gz: 1c72de6543bbbb47edefe1df209eaf2091f73c44
+  data.tar.gz: b460b9fdce9f6585cfeb0168beeea3d7d6266b6e
 SHA512:
-  metadata.gz: 390d572c5819a1a1d1672869598819ea1182275ab4d5d91eccc667dca3f90955d6c2f4b41932665adc920a0cf391db7a953d70a4998d8eb5350ecd788db00f5e
-  data.tar.gz: 8d0b7dd0db5a5794ae2cb3f1dd44e56b5d88c103222f859e4ad2c835568ac2ac804a5c11ff438238dacf57fe3ba9da431aba741fd6e7d9d9edb289c0e7767aaa
+  metadata.gz: '0780e99faa813c86be03e05b2ee7082de33bf6a56b6a9a03c60ba7ff3f3d7f981a002476bdb4556424885a76b946c3d9f0aa4a1e9d4fe8ed78942a67295bb465'
+  data.tar.gz: 46bd306c307582b55688cc7419382b0ef0659a3ef1a4230ee938518a83cd044ac8760f767caaf66dace5dbd0e5c3e596db6bbb0dd06f00bba30f7cfe3bef2b67

data/.gitignore

@@ -43,3 +43,4 @@ Gemfile.lock
 .env
 *.yml
 test.rb
+*.txt

data/lib/synapse_pay_rest.rb

@@ -7,6 +7,7 @@ require 'synapse_pay_rest/api/users'
 require 'synapse_pay_rest/api/nodes'
 require 'synapse_pay_rest/api/transactions'
 require 'synapse_pay_rest/api/subscriptions'
+require 'synapse_pay_rest/api/institutions'
 
 # general library classes
 require 'synapse_pay_rest/error'
@@ -31,6 +32,8 @@ require 'synapse_pay_rest/models/node/base_node'
 require 'synapse_pay_rest/models/node/synapse_us_node.rb'
 require 'synapse_pay_rest/models/node/synapse_ind_node.rb'
 require 'synapse_pay_rest/models/node/synapse_np_node.rb'
+require 'synapse_pay_rest/models/node/subaccount_us_node.rb'
+
 # ach
 require 'synapse_pay_rest/models/node/ach_us_node.rb'
 require 'synapse_pay_rest/models/node/unverified_node.rb'
@@ -44,6 +47,8 @@ require 'synapse_pay_rest/models/node/wire_int_node.rb'
 require 'synapse_pay_rest/models/node/reserve_us_node.rb'
 # triump subaccount
 require 'synapse_pay_rest/models/node/triumph_subaccount_us_node.rb'
+require 'synapse_pay_rest/models/node/subaccount_us_node.rb'
+
 # iou
 require 'synapse_pay_rest/models/node/iou_node.rb'
 
@@ -56,6 +61,9 @@ require 'synapse_pay_rest/models/transaction/transaction'
 # subscription-related classes
 require 'synapse_pay_rest/models/subscription/subscription'
 
+# institution-related classes
+require 'synapse_pay_rest/models/institution/institution'
+
 # Namespace for all SynapsePayRest classes and modules
 module SynapsePayRest
   # Modifies the default method to print a warning when deprecated constants

data/lib/synapse_pay_rest/api/institutions.rb

@@ -0,0 +1,33 @@
+module SynapsePayRest
+  # Wrapper class for /institutions endpoints
+  # 
+  # 
+  class Institutions
+
+    # @!attribute [rw] client
+    #   @return [SynapsePayRest::HTTPClient]
+    attr_accessor :client
+
+    # @param client [SynapsePayRest::HTTPClient]
+    def initialize(client)
+      @client = client
+    end
+
+    # Sends a GET request to /v3.1/institutions endpoint. Queries a specific subscription_id
+    # 
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    # 
+    # @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()
+      path = '/institutions'
+      client.get(path)
+    end
+    
+  end
+end

data/lib/synapse_pay_rest/client.rb

@@ -13,7 +13,7 @@ module SynapsePayRest
     #   @return [SynapsePayRest::Transactions]
     # @!attribute [rw] subscriptions
     #   @return [SynapsePayRest::Subscriptions]
-    attr_accessor :http_client, :users, :nodes, :transactions, :subscriptions
+    attr_accessor :http_client, :users, :nodes, :transactions, :subscriptions, :institutions
 
     # Alias for #transactions (legacy name)
     alias_method :trans, :transactions
@@ -45,6 +45,7 @@ module SynapsePayRest
       @nodes         = Nodes.new @http_client
       @transactions  = Transactions.new @http_client
       @subscriptions = Subscriptions.new @http_client
+      @institutions  = Institutions.new @http_client
     end
   end
 end

data/lib/synapse_pay_rest/models/institution/institution.rb

@@ -0,0 +1,44 @@
+module SynapsePayRest
+  # Represents an institution record and holds methods for getting institution instances
+  # from API calls. This is built on top of the SynapsePayRest::Institution class and
+  # 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.
+  class Institution
+    attr_reader :id, :is_active, :scope, :url
+
+    class << self
+      def all(client:)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        response = client.institutions.get()
+        multiple_from_response(response['banks'])
+      end
+
+      # Creates an Institution from a response hash.
+      # 
+      # @note Shouldn't need to call this directly.
+      def from_response(response)
+        args = {
+          bank_code:                    response['bank_code'],
+          bank_name:                    response['bank_name'],
+          features:                     response['features'],
+          forgotten_password:           response['forgotten_password'],
+          is_active:                    response['is_active'],
+          logo:                         response['logo'],
+          tx_history_months:            response['tx_history_months']
+        }
+        self.new(args)
+      end
+
+      # Calls from_response on each member of a response collection.
+      def multiple_from_response(response)
+        return [] if response.empty?
+        response.map { |institution_data| from_response(institution_data)}
+      end
+
+      private
+
+    end
+  end
+end

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

@@ -15,6 +15,7 @@ module SynapsePayRest
       'SYNAPSE-NP'             => SynapseNpNode,
       'SYNAPSE-US'             => SynapseUsNode,
       'TRIUMPH-SUBACCOUNT-US'  => TriumphSubaccountUsNode,
+      'SUBACCOUNT-US'          => SubaccountUsNode,
       'WIRE-INT'               => WireIntNode,
       'WIRE-US'                => WireUsNode
     }.freeze

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

@@ -0,0 +1,15 @@
+module SynapsePayRest
+  class SubaccountUsNode < BaseNode
+    class << self
+      private
+
+      def payload_for_create(nickname:, **options)
+        args = {
+          type: 'SUBACCOUNT-US',
+          nickname: nickname
+        }.merge(options)
+        super(args)
+      end
+    end
+  end
+end

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

@@ -581,6 +581,19 @@ module SynapsePayRest
       SynapseUsNode.create(user: self, **options)
     end
 
+    # Creates a 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::SubaccountUsNode]
+    def create_subaccount_us_node(**options)
+      SubaccountUsNode.create(user: self, **options)
+    end
+
     # Creates a TRIUMPH-SUBACCOUNT-US node.
     # 
     # @param nickname [String] nickname for the node

data/lib/synapse_pay_rest/version.rb

@@ -1,4 +1,4 @@
 module SynapsePayRest
   # Gem version
-  VERSION = '3.2.5'.freeze
+  VERSION = '3.2.6'.freeze
 end

data/synapse_pay_rest.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.name     = 'synapse_pay_rest'
   s.version  = SynapsePayRest::VERSION
   s.date     = Date.today.to_s
-  s.authors  = ['Steven Broderick', 'Nikki Galusha']
+  s.authors  = ['Steven Broderick', 'Thomas Hipps']
   s.email    = 'help@synapsepay.com'
-  s.summary  = 'Synapse v3 Rest Native API Library'
+  s.summary  = 'SynapsePay v3 Rest Native API Library'
   s.homepage = 'https://rubygems.org/gems/synapse_pay_rest'
   s.license  = 'MIT'
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 3.2.5
+  version: 3.2.6
 platform: ruby
 authors:
 - Steven Broderick
-- Nikki Galusha
+- Thomas Hipps
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -151,6 +151,7 @@ files:
 - Rakefile
 - bin/console
 - lib/synapse_pay_rest.rb
+- lib/synapse_pay_rest/api/institutions.rb
 - lib/synapse_pay_rest/api/nodes.rb
 - lib/synapse_pay_rest/api/subscriptions.rb
 - lib/synapse_pay_rest/api/transactions.rb
@@ -158,6 +159,7 @@ files:
 - lib/synapse_pay_rest/client.rb
 - lib/synapse_pay_rest/error.rb
 - lib/synapse_pay_rest/http_client.rb
+- lib/synapse_pay_rest/models/institution/institution.rb
 - lib/synapse_pay_rest/models/node/ach_us_node.rb
 - lib/synapse_pay_rest/models/node/base_node.rb
 - lib/synapse_pay_rest/models/node/eft_ind_node.rb
@@ -165,6 +167,7 @@ files:
 - lib/synapse_pay_rest/models/node/iou_node.rb
 - lib/synapse_pay_rest/models/node/node.rb
 - lib/synapse_pay_rest/models/node/reserve_us_node.rb
+- lib/synapse_pay_rest/models/node/subaccount_us_node.rb
 - lib/synapse_pay_rest/models/node/synapse_ind_node.rb
 - lib/synapse_pay_rest/models/node/synapse_np_node.rb
 - lib/synapse_pay_rest/models/node/synapse_us_node.rb
@@ -207,5 +210,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Synapse v3 Rest Native API Library
+summary: SynapsePay v3 Rest Native API Library
 test_files: []