synapse_pay_rest 3.4.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 92076f52668f8985f892f4d4c2e7747032331cce
-  data.tar.gz: 565e475469416d09ddb3ec13c054a31a5e248f73
+SHA256:
+  metadata.gz: 5c739268324bccef13ac3b3cfdcf97c6de821b0acfd30ec0ab8df1a7b7d4466a
+  data.tar.gz: 8b19a633a2da3cf57040b3d765a5b71e12231b30fa008b44eef0a94ec649b801
 SHA512:
-  metadata.gz: 8d02e29de00d3232f5826704528bddb6e00f8ed7abdca5bccf9fd8ef69a89aa659e5707fe376f656f2ac78e1b6ae766428d6987e3fdb5e4a9d5ba98d1561700b
-  data.tar.gz: f0962e044936a8e633a78bc2cfc307efe6a885ae42b1b75e2d490c8045546436655a5f82e7505f03e3e5ec924371c6db1dbfb7fb3c5443839d565bbaf7966cc8
+  metadata.gz: e3f12fd2df17e7b2f6b0c2f805497dd30ce031299af3eadc1ed38ee8ef0fd1819791d5c1d2673200cfd5adc9e50ee271339978f1c7d704f3160e99a7e0a16f4e
+  data.tar.gz: 243fa3411c03815f237cf606d4882ac34bf993897d5ce71815873b85af43fa8c842eb392a5c0661b4e30683b87afd76f7c067d86239284209715d3e4093f9ac6

data/.env.sample

@@ -5,4 +5,5 @@
  
  # For running tests
  TEST_CLIENT_ID=your_sandbox_client_id
- TEST_CLIENT_SECRET=your_sandbox_client_secret
+ TEST_CLIENT_SECRET=your_sandbox_client_secret
+

data/lib/synapse_pay_rest.rb

@@ -12,6 +12,7 @@ require 'synapse_pay_rest/api/institutions'
 require 'synapse_pay_rest/api/client'
 require 'synapse_pay_rest/api/atms'
 require 'synapse_pay_rest/api/crypto_quotes'
+require 'synapse_pay_rest/api/statements'
 
 # general library classes
 require 'synapse_pay_rest/error'
@@ -88,6 +89,8 @@ require 'synapse_pay_rest/models/atm/atm'
 
 require 'synapse_pay_rest/models/crypto_quote/crypto_quote'
 
+require 'synapse_pay_rest/models/statement/statement'
+
 
 # Namespace for all SynapsePayRest classes and modules
 module SynapsePayRest

data/lib/synapse_pay_rest/api/statements.rb

@@ -0,0 +1,41 @@
+module SynapsePayRest
+  # Wrapper class for /client endpoint
+  class Statements
+
+    # Valid optional args for #get
+    # @todo Should refactor this to HTTPClient
+    VALID_QUERY_PARAMS = [:page, :per_page].freeze
+
+    # @!attribute [rw] client
+    #   @return [SynapsePayRest::HTTPClient]
+    attr_accessor :client
+
+    # @param client [SynapsePayRest::HTTPClient]
+    def initialize(client)
+      @client = client
+    end
+    
+    # Sends a GET request /node or /user statments endpoint to retrieve statements, and returns the
+    # response.
+    # 
+    # @param user_id [String]
+    # @param node_id [String] optional
+    # 
+    # @raise [SynapsePayRest::Error] may return subclasses of error based on 
+    # HTTP response from API
+    # 
+    # @return [Hash] API response
+    def get(user_id:, node_id: nil, **options)
+      params = VALID_QUERY_PARAMS.map do |p|
+        options[p] ? "#{p}=#{options[p]}" : nil
+      end.compact
+
+      path = "/users/#{user_id}"
+      path += "/nodes/#{node_id}" if node_id
+      path += "/statements"
+      path += '?' + params.join('&') if params.any?
+      client.get(path)
+    end
+    
+  end
+end

data/lib/synapse_pay_rest/client.rb

@@ -14,7 +14,7 @@ module SynapsePayRest
     # @!attribute [rw] subscriptions
     #   @return [SynapsePayRest::Subscriptions]
     attr_accessor :http_client, :users, :nodes, :subnets, :transactions, :subscriptions, :institutions,
-                  :client_endpoint, :atms, :crypto_quotes
+                  :client_endpoint, :atms, :crypto_quotes, :statements
 
     # Alias for #transactions (legacy name)
     alias_method :trans, :transactions
@@ -51,6 +51,7 @@ module SynapsePayRest
       @client_endpoint  = ClientEndpoint.new @http_client
       @atms             = Atms.new @http_client
       @crypto_quotes    = CryptoQuotes.new @http_client
+      @statements       = Statements.new @http_client
     end
 
   

data/lib/synapse_pay_rest/models/statement/statement.rb

@@ -0,0 +1,80 @@
+module SynapsePayRest
+  # Represents a statement record and holds methods for getting statements
+  # from API calls. This is built on top of the SynapsePayRest::Client class and
+  # is intended to make it easier to use the API without knowing payload formats
+  # or knowledge of REST.
+  class Statement
+    attr_reader :client, :id, :date_end, :date_start, :csv_url, :pdf_url, :user, :node
+
+    class << self
+      # Creates a statements instance from a response hash.
+      # @note Shouldn't need to call this directly.
+      def from_response(client, response)
+        args = {
+          client:                   client,
+          id:                       response['_id'],
+          date_end:                 response['date_end'],
+          date_start:               response['date_start'],
+          csv_url:                  response['urls']['csv'],
+          pdf_url:                  response['urls']['pdf']
+        }
+        self.new(args)
+      end
+
+      # Gets statement by node or user.
+      # @param client [SynapsePayRest::Client]
+      # @param user [SynapsePayRest::User]  
+      # 
+      # @raise [SynapsePayRest::Error]
+      # 
+      # @return [SynapsePayRest::Statement] new instance corresponding to same API record
+      def by_user(client:, user:, page: nil, per_page: nil)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        raise ArgumentError, 'id must be a SynapsePayRest::User' unless user.is_a?(User)
+
+        [page, per_page].each do |arg|
+          if arg && (!arg.is_a?(Integer) || arg < 1)
+            raise ArgumentError, "#{arg} must be nil or an Integer >= 1"
+          end
+        end
+
+        response = client.statements.get(user_id: user.id, page: page, per_page: per_page)
+        multiple_from_response(client, response['statements'])
+      end
+
+      # Gets statement by node or user.
+      # @param client [SynapsePayRest::Client] 
+      # @param user [SynapsePayRest::Node] 
+      # 
+      # @raise [SynapsePayRest::Error]
+      # 
+      # @return [SynapsePayRest::Statement] new instance corresponding to same API record
+      def by_node(client:, node:, page: nil, per_page: nil)
+        raise ArgumentError, 'client must be a SynapsePayRest::Client' unless client.is_a?(Client)
+        raise ArgumentError, 'node must be a SynapsePayRest::Node' unless node.is_a?(BaseNode)
+
+        [page, per_page].each do |arg|
+          if arg && (!arg.is_a?(Integer) || arg < 1)
+            raise ArgumentError, "#{arg} must be nil or an Integer >= 1"
+          end
+        end
+
+        response = client.statements.get(user_id: node.user.id, node_id: node.id, page: page, per_page: per_page)
+        multiple_from_response(client, response['statements'])
+      end
+
+      def multiple_from_response(client, response)
+        return [] if response.empty?
+        response.map { |statement_data| from_response(client, statement_data) }
+      end
+
+    end
+
+    # @note Do not call directly. Use Statement.get or other class method
+    #   to instantiate via API action.
+    def initialize(**options)
+      options.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+  end
+end

data/lib/synapse_pay_rest/version.rb

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

data/samples.md

@@ -1407,3 +1407,29 @@ atm_args = {
 atms = SynapsePayRest::Atm.locate(atm_args)
 # => [#<SynapsePayRest::Atm>, #<SynapsePayRest::Atm>, ...]
 ```
+
+## Get Statement Method
+
+#### Get Statement By User or Node
+
+##### a) Statement#by_user
+
+```ruby
+user = SynapsePayRest::User.find(client: client, id: '5b5f95dc83403300fbc76')
+
+statements = SynapsePayRest::Statement.by_user(client: client, user: user)
+# => [#<SynapsePayRest::Statement>, #<SynapsePayRest::Statement>, ...]
+```
+
+##### b) Statement#by_node
+
+```ruby
+user = SynapsePayRest::User.find(client: client, id: '5b5f95dc83403300fbc76')
+
+node = user.find_node(id: '5b634a241jngjnei04c7b39b1')
+
+
+
+statements = SynapsePayRest::Statement.by_node(client: client, node: node)
+# => [#<SynapsePayRest::Statement>, #<SynapsePayRest::Statement>, ...]
+```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synapse_pay_rest
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.4.2
 platform: ruby
 authors:
 - Steven Broderick
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -156,6 +156,7 @@ files:
 - lib/synapse_pay_rest/api/crypto_quotes.rb
 - lib/synapse_pay_rest/api/institutions.rb
 - lib/synapse_pay_rest/api/nodes.rb
+- lib/synapse_pay_rest/api/statements.rb
 - lib/synapse_pay_rest/api/subnets.rb
 - lib/synapse_pay_rest/api/subscriptions.rb
 - lib/synapse_pay_rest/api/transactions.rb
@@ -191,6 +192,7 @@ files:
 - lib/synapse_pay_rest/models/node/unverified_node.rb
 - lib/synapse_pay_rest/models/node/wire_int_node.rb
 - lib/synapse_pay_rest/models/node/wire_us_node.rb
+- lib/synapse_pay_rest/models/statement/statement.rb
 - lib/synapse_pay_rest/models/subnet/subnet.rb
 - lib/synapse_pay_rest/models/subscription/subscription.rb
 - lib/synapse_pay_rest/models/transaction/transaction.rb
@@ -224,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: SynapsePay v3 Rest Native API Library