starkbank 0.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0509d964f6d6ff483444229021b1ac146d3c27ca7930e1d906fc51ba7ef49541'
-  data.tar.gz: f0a14115c5b83db21dffcc339df07038c6ef21234547602e44e825d9c4b6aea4
+  metadata.gz: 2cde164881e744d7dd89ef1890e4793bb3b00b176309fd68878154562204f0fa
+  data.tar.gz: f216ff9ab2526f9807d13e3599412a3c8439d3b20e1ba7396df1aa7b50b75a8b
 SHA512:
-  metadata.gz: d74d8dbc64191c7ad538b0d7529372860cc23cf8b429158d130911dd2e7a568207ccd635c929b0fe106805036110e72e16567686cb4a161c250fcde4d7cf0811
-  data.tar.gz: e7737c06154ce9430e4345682fdc7efbffc297e95aa18f6ca6583512a5183dbbbb6ee054a3e1c7a3c3d9834d6fe1efbb3ced9a40c7fdb1dde943cc0422ac5384
+  metadata.gz: 2abcedf46bd193107cbafb446461199d573c72ef8fdf2c9182479e0ee897396f16298debb9d19920fba358babc1247c3f48a2bd8e9b80155d6f7a867de22987e
+  data.tar.gz: 2d95dd80a1fd990aa4d1a71dc32c01674c7c52471e7d8369db5787faf382e3c3043300762bc9d85d15a597e31399e7084eb3a25e943603176ea8503c0b258082

data/lib/payment_request/payment_request.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # PaymentRequest object
+  # A PaymentRequest is an indirect request to access a specific cash-out service
+  # (such as Transfer, BoletoPayments, etc.) which goes through the cost center
+  #  approval flow on our website. To emit a PaymentRequest, you must direct it to
+  #  a specific cost center by its ID, which can be retrieved on our website at the
+  #  cost center page.
+  #
+  # ## Parameters (required):
+  # - center_id [String]: target cost center ID. ex: '5656565656565656'
+  # - payment [Transfer, BoletoPayment, UtilityPayment, Transaction or dictionary]: payment entity that should be approved and executed.
+  #
+  # ## Parameters (optional):
+  # - type [String]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'boleto-payment'
+  # - due [Date, DateTime, Time or string]: Payment target date in ISO format. ex: 2020-12-31
+  # - tags [list of strings]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [String]: unique id returned when PaymentRequest is created. ex: '5656565656565656'
+  # - amount [integer, default nil]: PaymentRequest amount. ex: 100000 = R$1.000,00
+  # - status [string, default nil]: current PaymentRequest status.ex: 'pending' or 'approved'
+  # - actions [list of dictionaries, default nil]: list of actions that are affecting this PaymentRequest. ex: [{'type': 'member', 'id': '56565656565656, 'action': 'requested'}]
+  # - updated [DateTime, default nil]: latest update datetime for the PaymentRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - created [DateTime, default nil]: creation datetime for the PaymentRequest. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  #
+  class PaymentRequest < StarkBank::Utils::Resource
+    attr_reader :center_id, :payment, :type, :due, :tags, :amount, :status, :actions, :updated, :created
+    def initialize(
+      payment:, center_id:, id: nil, type: nil, due: nil, tags: nil, amount: nil, status: nil,
+      actions: nil, updated: nil, created: nil
+    )
+      super(id)
+      @center_id = center_id
+      @due = due
+      @tags = tags
+      @amount = amount
+      @status = status
+      @actions = actions
+      @updated = updated
+      @created = created
+
+      @payment, @type = parse_payment(payment: payment, type: type)
+    end
+
+    ## Create PaymentRequests
+    # Sends a list of PaymentRequests objects for creating in the Stark Bank API
+    #
+    # ## Parameters
+    # - payment_requests [list of PaymentRequest objects]: list of PaymentRequest objects to be created in the API
+    # - user [Project object]: Project object. Not necessary if StarkBank.User.Default was set before function call
+    #
+    # ## Return
+    # - list of PaymentRequest objects with updated attributes
+    #
+    def self.create(payment_requests, user: nil)
+      StarkBank::Utils::Rest.post(entities: payment_requests, user: user, **resource)
+    end
+
+    # # Retrieve PaymentRequests
+    #
+    # Receive a generator of PaymentRequest objects previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - center_id [string]: target cost center ID. ex: '5656565656565656'
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - after [Date , DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
+    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - status [string, default '-created']: sort order considered in response. Valid options are '-created' or '-due'.
+    # - type [string, default nil]: payment type, inferred from the payment parameter if it is not a dictionary. ex: 'transfer', 'boleto-payment'
+    # - sort [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of PaymentRequest objects with updated attributes
+    def self.query(center_id:, limit: nil, after: nil, before: nil, status: nil, type: nil, sort: nil, tags: nil, ids: nil, user: nil)
+      after = StarkBank::Utils::Checks.check_date(after)
+      before = StarkBank::Utils::Checks.check_date(before)
+      StarkBank::Utils::Rest.get_list(
+        center_id: center_id,
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        type: type,
+        sort: sort,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    def parse_payment(payment:, type:)
+      return [payment, 'transfer'] if payment.is_a?(StarkBank::Transfer)
+      return [payment, 'transaction'] if payment.is_a?(StarkBank::Transaction)
+      return [payment, 'boleto-payment'] if payment.is_a?(StarkBank::BoletoPayment)
+      return [payment, 'utility-payment'] if payment.is_a?(StarkBank::UtilityPayment)
+
+      raise(Exception('Payment must either be a Transfer, a Transaction, a BoletoPayment, a UtilityPayment or a hash.')) unless payment.is_a?(Hash)
+
+      resource = {
+        'transfer': StarkBank::Transfer.resource,
+        'transaction': StarkBank::Transaction.resource,
+        'boleto-payment': StarkBank::BoletoPayment.resource,
+        'utility-payment': StarkBank::UtilityPayment.resource
+      }[type.to_sym]
+
+      payment = StarkBank::Utils::API.from_api_json(resource[:resource_maker], payment) unless resource.nil?
+
+      [payment, type]
+    end
+
+    def self.resource
+      {
+        resource_name: 'PaymentRequest',
+        resource_maker: proc { |json|
+          PaymentRequest.new(
+            id: json['id'],
+            payment: json['payment'],
+            center_id: json['centerId'],
+            type: json['type'],
+            tags: json['tags'],
+            amount: json['amount'],
+            status: json['status'],
+            actions: json['actions'],
+            updated: json['updated'],
+            created: json['created']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/starkbank.rb

@@ -14,6 +14,7 @@ require_relative('utility_payment/utility_payment')
 require_relative('utility_payment/log')
 require_relative('webhook/webhook')
 require_relative('event/event')
+require_relative('payment_request/payment_request')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank

data/lib/transaction/transaction.rb

@@ -89,14 +89,24 @@ module StarkBank
     # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
     # - external_ids [list of strings, default nil]: list of external ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Transaction objects with updated attributes
-    def self.query(limit: nil, after: nil, before: nil, tags: nil, external_ids: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, tags: nil, external_ids: nil, ids: nil, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
-      StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, tags: tags, external_ids: external_ids, **resource)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        external_ids: external_ids,
+        ids: ids,
+        user: user,
+        **resource
+      )
     end
 
     def self.resource

data/lib/transfer/transfer.rb

@@ -126,11 +126,12 @@ module StarkBank
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'success' or 'failed'
     # - tax_id [string, default nil]: filter for transfers sent to the specified tax ID. ex: "012.345.678-90"
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Transfer objects with updated attributes
-    def self.query(limit: nil, after: nil, before: nil, transaction_ids: nil, status: nil, tax_id: nil, sort: nil, tags: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, transaction_ids: nil, status: nil, tax_id: nil, sort: nil, tags: nil, ids: nil, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_list(
@@ -142,6 +143,7 @@ module StarkBank
         tax_id: tax_id,
         sort: sort,
         tags: tags,
+        ids: ids,
         user: user,
         **resource
       )

data/lib/utils/api.rb

@@ -5,16 +5,22 @@ require_relative('case')
 module StarkBank
   module Utils
     module API
-      def self.api_json(entity)
+      def self.build_entity_hash(entity)
         if entity.is_a?(Hash)
           entity_hash = entity
         else
           entity_hash = {}
           entity.instance_variables.each do |key|
-            entity_hash[key[1..-1]] = entity.instance_variable_get(key)
+            variable = entity.instance_variable_get(key)
+            entity_hash[key[1..-1]] = variable.is_a?(StarkBank::Utils::Resource) ? build_entity_hash(variable) : entity.instance_variable_get(key)
           end
         end
-        cast_json_to_api_format(entity_hash)
+        entity_hash
+      end
+
+      def self.api_json(entity)
+        built_hash = build_entity_hash(entity)
+        cast_json_to_api_format(built_hash)
       end
 
       def self.cast_json_to_api_format(hash)
@@ -30,6 +36,8 @@ module StarkBank
               list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
             end
             value = list
+          elsif value.is_a?(Hash)
+            value = cast_json_to_api_format(value)
           end
 
           entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value

data/lib/utils/request.rb

@@ -61,7 +61,7 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.5.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.0.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - starkbank
@@ -80,6 +80,7 @@ files:
 - lib/error.rb
 - lib/event/event.rb
 - lib/key.rb
+- lib/payment_request/payment_request.rb
 - lib/starkbank.rb
 - lib/transaction/transaction.rb
 - lib/transfer/log.rb