starkbank 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08a72ad1389e8bcaa2f466c4fc6e3f0d299773da12d934449a389a36410b21eb'
-  data.tar.gz: 128f8bb159e098b3c1013332900e3cc949d05f4c62e4fcadead1c70b2f722581
+  metadata.gz: df05543973d4dbbc39842f117e914f0ab892e382637766bae66e58297bbbf639
+  data.tar.gz: 56e8433e4d08637c893bf45cf717b798233619782ff6f1874ed01b5b74f4f45e
 SHA512:
-  metadata.gz: 5811d6b08b2cd51589aee78ffb3b01193ff8df586af0ae7dcb401b1f0913448a420175090447cc4ace0cdbd318cc800664ea0d997ff2681a30426be0e0716b41
-  data.tar.gz: 00005b82bf82aaa0a2af6ec6df1b4001e2646848562688e874d8ea8a08d985c7ceacea0b34c4762d93c3fcc3aabc67d63594cb35752a49a71fe865c2f34e12e6
+  metadata.gz: 32c50715be122647ff026491515c953818c6d2570157088da4e7d27d5687686d305475c2c3711798f97aad70d1269f181f72f48bdb4e8fc379fff03b8408d88d
+  data.tar.gz: b2a9b0d86a9e293c26f75649d0c2f2cf41e373f7503ac5edb59765bb9ab44bdf8f8e6231d236c104d524ecded335fd205bb8188ae822a2bf2572582dee21abae

data/lib/brcode_preview/brcode_preview.rb

@@ -35,7 +35,8 @@ module StarkBank
       @reconciliation_id = reconciliation_id
     end
 
-    # # Retrieve BrcodePreviews
+    # # BrcodePreview is DEPRECATED: Please use PaymentPreview instead.
+    # Retrieve BrcodePreviews
     #
     # Receive a generator of BrcodePreview objects previously created in the Stark Bank API
     #
@@ -46,6 +47,7 @@ module StarkBank
     # ## Return:
     # - generator of BrcodePreview objects with updated attributes
     def self.query(limit: nil, brcodes: nil, user: nil)
+      warn "[DEPRECATION] `BrcodePreview` is deprecated.  Please use `PaymentPreview` instead."
       StarkBank::Utils::Rest.get_stream(
         user: user,
         limit: nil,

data/lib/invoice/invoice.rb

@@ -10,6 +10,8 @@ module StarkBank
   # When you initialize an Invoice, the entity will not be automatically
   # sent to the Stark Bank API. The 'create' function sends the objects
   # to the Stark Bank API and returns the list of created objects.
+  # To create scheduled Invoices, which will display the discount, interest, etc. on the final users banking interface,
+  # use dates instead of datetimes on the "due" and "discounts" fields.
   #
   # ## Parameters (required):
   # - amount [integer]: Invoice value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34)
@@ -47,13 +49,12 @@ module StarkBank
     )
       super(id)
       @amount = amount
-      @due = StarkBank::Utils::Checks.check_datetime(due)
+      @due = StarkBank::Utils::Checks.check_date_or_datetime(due)
       @tax_id = tax_id
       @name = name
       @expiration = expiration
       @fine = fine
       @interest = interest
-      @discounts = discounts
       @tags = tags
       @pdf = pdf
       @link = link
@@ -68,6 +69,14 @@ module StarkBank
       @transaction_ids = transaction_ids
       @updated = StarkBank::Utils::Checks.check_datetime(updated)
       @created = StarkBank::Utils::Checks.check_datetime(created)
+      if !discounts.nil?
+        checked_discounts = []
+        discounts.each do |discount|
+          discount["due"] = StarkBank::Utils::Checks.check_date_or_datetime(discount["due"])
+          checked_discounts.push(discount)
+        end
+        @discounts = checked_discounts
+      end
     end
 
     # # Create Invoices

data/lib/payment_preview/boleto_preview.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative('../utils/sub_resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  class PaymentPreview
+    # # BoletoPreview object
+    #
+    # A BoletoPreview is used to get information from a Boleto payment you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - status [string]: current boleto status. ex: 'active', 'expired' or 'inactive'
+    # - amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
+    # - discount_amount [int]: discount amount to be paid. ex: 23456 (= R$ 234.56)
+    # - fine_amount [int]: fine amount to be paid. ex: 23456 (= R$ 234.56)
+    # - interest_amount [int]: interest amount to be paid. ex: 23456 (= R$ 234.56)
+    # - due [DateTime or string]: Boleto due date. ex: '2020-04-30'
+    # - expiration [DateTime or string]: Boleto expiration date. ex: '2020-04-30'
+    # - name [string]: beneficiary full name. ex: 'Anthony Edward Stark'
+    # - tax_id [string]: beneficiary tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+    # - receiver_name [string]: receiver (Sacador Avalista) full name. ex: 'Anthony Edward Stark'
+    # - receiver_tax_id [string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+    # - payer_name [string]: payer full name. ex: 'Anthony Edward Stark'
+    # - payer_tax_id [string]: payer tax ID (CPF or CNPJ). ex: '20.018.183/0001-80'
+    # - line [string]: Number sequence that identifies the payment. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062'
+    # - bar_code [string]: Bar code number that identifies the payment. ex: '34195819600000000621090063571277307144464000'
+    class BoletoPreview < StarkBank::Utils::SubResource
+      attr_reader :status, :amount, :discount_amount, :fine_amount, :interest_amount, :due, :expiration, :name, :tax_id, :receiver_name, :receiver_tax_id, :payer_name, :payer_tax_id, :line, :bar_code
+      def initialize(status:, amount:, discount_amount:, fine_amount:, interest_amount:, due:, expiration:, name:, tax_id:, receiver_name:, receiver_tax_id:, payer_name:, payer_tax_id:, line:, bar_code:)
+        @status = status
+        @amount = amount
+        @discount_amount = discount_amount
+        @fine_amount = fine_amount
+        @interest_amount = interest_amount
+        @due = StarkBank::Utils::Checks.check_datetime(due)
+        @expiration = StarkBank::Utils::Checks.check_datetime(expiration)
+        @name = name
+        @tax_id = tax_id
+        @receiver_name = receiver_name
+        @receiver_tax_id = receiver_tax_id
+        @payer_name = payer_name
+        @payer_tax_id = payer_tax_id
+        @line = line
+        @bar_code = bar_code
+      end
+
+      def self.resource
+        {
+          resource_name: 'BoletoPreview',
+          resource_maker: proc { |json|
+            BoletoPreview.new(
+              status: json['status'],
+              amount: json['amount'],
+              discount_amount: json['discount_amount'],
+              fine_amount: json['fine_amount'],
+              interest_amount: json['interest_amount'],
+              due: json['due'],
+              expiration: json['expiration'],
+              name: json['name'],
+              tax_id: json['tax_id'],
+              receiver_name: json['receiver_name'],
+              receiver_tax_id: json['receiver_tax_id'],
+              payer_name: json['payer_name'],
+              payer_tax_id: json['payer_tax_id'],
+              line: json['line'],
+              bar_code: json['bar_code'],
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment_preview/brcode_preview.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative('../utils/sub_resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  class PaymentPreview
+    # # BrcodePreview object
+    #
+    # A BrcodePreview is used to get information from a BR Code you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
+    # - name [string]: Payment receiver name. ex: 'Tony Stark'
+    # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
+    # - bank_code [string]: Payment receiver bank code. ex: '20018183'
+    # - branch_code [string]: Payment receiver branch code. ex: '0001'
+    # - account_number [string]: Payment receiver account number. ex: '1234567'
+    # - account_type [string]: Payment receiver account type. ex: 'checking'
+    # - allow_change [bool]: If True, the payment is able to receive amounts that are different from the nominal one. ex: True or False
+    # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
+    # - nominal_amount [integer]: Original value in cents that this payment was expecting to receive without the discounts, fines, etc.. If 0, any value is accepted. ex: 123 (= R$1,23)
+    # - interest_amount [integer]: Current interest value in cents that this payment is charging. If 0, any value is accepted. ex: 123 (= R$1,23)
+    # - fine_amount [integer]: Current fine value in cents that this payment is charging. ex: 123 (= R$1,23)
+    # - reduction_amount [integer]: Current value reduction value in cents that this payment is expecting. ex: 123 (= R$1,23)
+    # - discount_amount [integer]: Current discount value in cents that this payment is expecting. ex: 123 (= R$1,23)
+    # - reconciliation_id [string]: Reconciliation ID linked to this payment. ex: 'txId', 'payment-123'
+    class BrcodePreview < StarkBank::Utils::SubResource
+      attr_reader :status, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :allow_change, :amount, :nominal_amount, :interest_amount, :fine_amount, :reduction_amount, :discount_amount, :reconciliation_id
+      def initialize(status:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, allow_change:, amount:, nominal_amount:, interest_amount:, fine_amount:, reduction_amount:, discount_amount:, reconciliation_id:)
+        @status = status
+        @name = name
+        @tax_id = tax_id
+        @bank_code = bank_code
+        @branch_code = branch_code
+        @account_number = account_number
+        @account_type = account_type
+        @allow_change = allow_change
+        @amount = amount
+        @nominal_amount = nominal_amount
+        @interest_amount = interest_amount
+        @fine_amount = fine_amount
+        @reduction_amount = reduction_amount
+        @discount_amount = discount_amount
+        @reconciliation_id = reconciliation_id
+      end
+
+      def self.resource
+        {
+          resource_name: 'BrcodePreview',
+          resource_maker: proc { |json|
+            BrcodePreview.new(
+              status: json['status'],
+              name: json['name'],
+              tax_id: json['tax_id'],
+              bank_code: json['bank_code'],
+              branch_code: json['branch_code'],
+              account_number: json['account_number'],
+              account_type: json['account_type'],
+              allow_change: json['allow_change'],
+              amount: json['amount'],
+              nominal_amount: json['nominal_amount'],
+              interest_amount: json['interest_amount'],
+              fine_amount: json['fine_amount'],
+              reduction_amount: json['reduction_amount'],
+              discount_amount: json['discount_amount'],
+              reconciliation_id: json['reconciliation_id']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment_preview/payment_preview.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # PaymentPreview object
+  #
+  # A PaymentPreview is used to get information from a payment code before confirming the payment.
+  # This resource can be used to preview BR Codes and bar codes of boleto, tax and utility payments
+  #
+  # ## Attributes (return-only):
+  # - id [string]: Main identification of the payment. This should be the BR Code for Pix payments and lines or bar codes for payment slips. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062', '00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A'
+  # - scheduled [DateTime or string]: intended payment date. Right now, this parameter only has effect on BrcodePreviews. ex: '2020-04-30'
+  # - type [string]: Payment type. ex: 'brcode-payment', 'boleto-payment', 'utility-payment' or 'tax-payment'
+  # - payment [BrcodePreview, BoletoPreview, UtilityPreview or TaxPreview]: Information preview of the informed payment.
+  class PaymentPreview < StarkBank::Utils::Resource
+    attr_reader :id, :scheduled, :type, :payment
+    def initialize(id: nil, scheduled: nil, type: nil, payment: nil)
+      super(id)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
+      @type = type
+      @payment = payment
+      return if type.nil?
+
+      resource = {
+        'brcode-payment': StarkBank::PaymentPreview::BrcodePreview.resource,
+        'boleto-payment': StarkBank::PaymentPreview::BoletoPreview.resource,
+        'tax-payment': StarkBank::PaymentPreview::TaxPreview.resource,
+        'utility-payment': StarkBank::PaymentPreview::UtilityPreview.resource
+      }[type.to_sym]
+
+      @payment = StarkBank::Utils::API.from_api_json(resource[:resource_maker], payment) unless resource.nil?
+    end
+
+    # # Create PaymentPreviews
+    #
+    # Send a list of PaymentPreviews objects for processing in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - previews [list of PaymentPreviews objects]: list of PaymentPreviews objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of PaymentPreviews objects with updated attributes
+    def self.create(previews, user: nil)
+      StarkBank::Utils::Rest.post(entities: previews, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'PaymentPreview',
+        resource_maker: proc { |json|
+          PaymentPreview.new(
+            id: json['id'],
+            scheduled: json['scheduled'],
+            type: json['type'],
+            payment: json['payment']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/payment_preview/tax_preview.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative('../utils/sub_resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  class PaymentPreview
+    # # TaxPreview object
+    #
+    # A TaxPreview is used to get information from a Tax Payment you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
+    # - name [string]: beneficiary full name. ex: "Iron Throne"
+    # - description [string]: tax payment description. ex: "ISS Payment - Iron Throne"
+    # - line [string]: Number sequence that identifies the payment. ex: "85660000006 6 67940064007 5 41190025511 7 00010601813 8"
+    # - bar_code [string]: Bar code number that identifies the payment. ex: "85660000006679400640074119002551100010601813"
+    class TaxPreview < StarkBank::Utils::SubResource
+      attr_reader :amount, :name, :description, :line, :bar_code
+      def initialize(amount:, name:, description:, line:, bar_code:)
+        @amount = amount
+        @name = name
+        @description = description
+        @line = line
+        @bar_code = bar_code
+      end
+
+      def self.resource
+        {
+          resource_name: 'TaxPreview',
+          resource_maker: proc { |json|
+            TaxPreview.new(
+              amount: json['amount'],
+              name: json['name'],
+              description: json['description'],
+              line: json['line'],
+              bar_code: json['bar_code']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/payment_preview/utility_preview.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative('../utils/sub_resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  class PaymentPreview
+    # # UtilityPreview object
+    #
+    # A UtilityPreview is used to get information from a Utility Payment you received before confirming the payment.
+    #
+    # ## Attributes (return-only):
+    # - amount [int]: final amount to be paid. ex: 23456 (= R$ 234.56)
+    # - name [string]: beneficiary full name. ex: "Light Company"
+    # - description [string]: utility payment description. ex: "Utility Payment - Light Company"
+    # - line [string]: Number sequence that identifies the payment. ex: "82660000002 8 44361143007 7 41190025511 7 00010601813 8"
+    # - bar_code [string]: Bar code number that identifies the payment. ex: "82660000002443611430074119002551100010601813"
+    class UtilityPreview < StarkBank::Utils::SubResource
+      attr_reader :amount, :name, :description, :line, :bar_code
+      def initialize(amount:, name:, description:, line:, bar_code:)
+        @amount = amount
+        @name = name
+        @description = description
+        @line = line
+        @bar_code = bar_code
+      end
+
+      def self.resource
+        {
+          resource_name: 'UtilityPreview',
+          resource_maker: proc { |json|
+            UtilityPreview.new(
+              amount: json['amount'],
+              name: json['name'],
+              description: json['description'],
+              line: json['line'],
+              bar_code: json['bar_code']
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/starkbank.rb

@@ -33,6 +33,11 @@ require_relative('webhook/webhook')
 require_relative('event/event')
 require_relative('event/attempt')
 require_relative('payment_request/payment_request')
+require_relative('payment_preview/payment_preview')
+require_relative('payment_preview/brcode_preview')
+require_relative('payment_preview/boleto_preview')
+require_relative('payment_preview/tax_preview')
+require_relative('payment_preview/utility_preview')
 require_relative('institution/institution')
 
 # SDK to facilitate Ruby integrations with Stark Bank

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-2.5.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.6.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - starkbank
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: starkbank-ecdsa
@@ -95,6 +95,11 @@ files:
 - lib/invoice/log.rb
 - lib/invoice/payment.rb
 - lib/key.rb
+- lib/payment_preview/boleto_preview.rb
+- lib/payment_preview/brcode_preview.rb
+- lib/payment_preview/payment_preview.rb
+- lib/payment_preview/tax_preview.rb
+- lib/payment_preview/utility_preview.rb
 - lib/payment_request/payment_request.rb
 - lib/starkbank.rb
 - lib/tax_payment/log.rb