starkbank 2.1.0 → 2.2.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21f296f6ce46e6451eb4650fcc5bd8f77b657184b10662daae70c79c4df26cc3
-  data.tar.gz: 2a0355e608aa51c1302ea55c8491741981afbfefd2bb86f56fb606fc4ab38c76
+  metadata.gz: 766b123365232a3f071a9a12072eaf8fc2f30021a72ed0f4a41b54726fca81c5
+  data.tar.gz: 5c8349015b1ee06624223bdeb28ca9f3765e92bba3d62ebe04e76656a0ec14e8
 SHA512:
-  metadata.gz: cce7c99b52dc834e4110caa9861a89dbb039d02d080d17631995666298798f6c1ca7024796958cc170d7f08d5a594a8f8ee4bb98078f8897e75a8455dad55987
-  data.tar.gz: 2e5c9d0a3d0f33b050f08b29e35453db3011190760145aec59a87a993a1086c038e9d430004cd8bdf7fe1ef657d08554d4eea4fec14d5e9d2692f57df71808c5
+  metadata.gz: b397a9af3581435b2398b7d0e19ff6e252c73024b7bad74d1f49e909f1eda18c95b89b4a95741340e6519aab69d7c1247bfcdb5b05dca5ecf589bb2c404ce743
+  data.tar.gz: 1bf497cdc47b95a04bba1b3dc199ffda07cff053c9b4aeced2feb82538ad2d0183b8d5049b677068a4cc2bdbdc63d6f5f4d1ec64f615d602be27678f41b77514

data/lib/boleto/boleto.rb

@@ -58,7 +58,7 @@ module StarkBank
       @city = city
       @state_code = state_code
       @zip_code = zip_code
-      @due = due
+      @due = StarkBank::Utils::Checks.check_date(due)
       @fine = fine
       @interest = interest
       @overdue_limit = overdue_limit

data/lib/boleto_payment/boleto_payment.rb

@@ -37,7 +37,7 @@ module StarkBank
       @description = description
       @line = line
       @bar_code = bar_code
-      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
       @tags = tags
       @status = status
       @amount = amount

data/lib/event/event.rb

@@ -9,6 +9,7 @@ require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
 require_relative('../boleto_holmes/log')
+require_relative('../invoice/log')
 require_relative('../transfer/log')
 require_relative('../boleto_payment/log')
 require_relative('../utility_payment/log')
@@ -22,7 +23,7 @@ module StarkBank
   #
   # ## Attributes:
   # - id [string]: unique id returned when the event is created. ex: '5656565656565656'
-  # - log [Log]: a Log object from one the subscription services (TransferLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
+  # - log [Log]: a Log object from one the subscription services (TransferLog, InvoiceLog, BoletoLog, BoletoPaymentlog or UtilityPaymentLog)
   # - created [DateTime]: creation datetime for the notification event. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - is_delivered [bool]: true if the event has been successfully delivered to the user url. ex: False
   # - subscription [string]: service that triggered this event. ex: 'transfer', 'utility-payment'
@@ -36,6 +37,7 @@ module StarkBank
 
       resource = {
         'transfer': StarkBank::Transfer::Log.resource,
+        'invoice': StarkBank::Invoice::Log.resource,
         'boleto': StarkBank::Boleto::Log.resource,
         'boleto-payment': StarkBank::BoletoPayment::Log.resource,
         'utility-payment': StarkBank::UtilityPayment::Log.resource,

data/lib/invoice/invoice.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Invoice object
+  #
+  # 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.
+  #
+  # ## Parameters (required):
+  # - amount [integer]: Invoice value in cents. Minimum = 0 (any value will be accepted). ex: 1234 (= R$ 12.34)
+  # - tax_id [string]: payer tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
+  # - name [string]: payer name. ex: 'Iron Bank S.A.'
+  #
+  # ## Parameters (optional):
+  # - due [DateTime or string, default today + 2 days]: Invoice due date in UTC ISO format. ex: '2020-10-28T17:59:26.249976+00:00'
+  # - expiration [integer, default 5097600 (59 days)]: time interval in seconds between due date and expiration date. ex 123456789
+  # - fine [float, default 0.0]: Invoice fine for overdue payment in %. ex: 2.5
+  # - interest [float, default 0.0]: Invoice monthly interest for overdue payment in %. ex: 5.2
+  # - discounts [list of hashes, default nil]: list of hashes with 'percentage':float and 'due':DateTime or string pairs
+  # - descriptions [list of hashes, default nil]: list of hashes with 'key':string and 'value':string pairs
+  # - tags [list of strings, default nil]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when Invoice is created. ex: '5656565656565656'
+  # - nominal_amount [integer, default nil]: Invoice emission value in cents (will change if invoice is updated, but not if it's paid). ex: 400000
+  # - fine_amount [integer, default nil]: Invoice fine value calculated over nominal_amount. ex: 20000
+  # - interest_amount [integer, default nil]: Invoice interest value calculated over nominal_amount. ex: 10000
+  # - discount_amount [integer, default nil]: Invoice discount value calculated over nominal_amount. ex: 3000
+  # - brcode [string, default nil]: BR Code for the Invoice payment. ex: '00020101021226800014br.gov.bcb.pix2558invoice.starkbank.com/f5333103-3279-4db2-8389-5efe335ba93d5204000053039865802BR5913Arya Stark6009Sao Paulo6220051656565656565656566304A9A0'
+  # - status [string, default nil]: current Invoice status. ex: 'registered' or 'paid'
+  # - created [DateTime, default nil]: creation datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime, default nil]: latest update datetime for the Invoice. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class Invoice < StarkBank::Utils::Resource
+    attr_reader :amount, :due, :tax_id, :name, :expiration, :fine, :interest, :discounts, :tags, :descriptions, :nominal_amount, :fine_amount, :interest_amount, :discount_amount, :id, :brcode, :status, :created, :updated
+    def initialize(
+      amount:, due:, tax_id:, name:, expiration: nil, fine: nil, interest: nil, discounts: nil,
+      tags: nil, descriptions: nil, nominal_amount: nil, fine_amount: nil, interest_amount: nil,
+      discount_amount: nil, id: nil, brcode: nil, status: nil, created: nil, updated: nil
+    )
+      super(id)
+      @amount = amount
+      @due = StarkBank::Utils::Checks.check_datetime(due)
+      @tax_id = tax_id
+      @name = name
+      @expiration = expiration
+      @fine = fine
+      @interest = interest
+      @discounts = discounts
+      @tags = tags
+      @descriptions = descriptions
+      @nominal_amount = nominal_amount
+      @fine_amount = fine_amount
+      @interest_amount = interest_amount
+      @discount_amount = discount_amount
+      @brcode = brcode
+      @status = status
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+    end
+
+    # # Create Invoices
+    #
+    # Send a list of Invoice objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - invoices [list of Invoice objects]: list of Invoice objects to be created in the API
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of Invoice objects with updated attributes
+    def self.create(invoices, user: nil)
+      StarkBank::Utils::Rest.post(entities: invoices, user: user, **resource)
+    end
+
+    # # Retrieve a specific Invoice
+    #
+    # Receive a single Invoice object previously created in the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Invoice object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Invoices
+    #
+    # Receive a generator of Invoice objects previously created in the Stark Bank API
+    #
+    # ## 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 nil]: filter for status of retrieved objects. ex: 'paid' or 'registered'
+    # - 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 Invoice objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: 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(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
+    end
+
+    # # Update an Invoice entity
+    #
+    # Update an Invoice entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: Invoice unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - deleted Invoice object
+    def self.update(id, status: nil, amount: nil, due: nil, expiration: nil, user: nil)
+      StarkBank::Utils::Rest.patch_id(id: id, status: status, amount: amount, due: due, expiration: expiration, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Invoice',
+        resource_maker: proc { |json|
+          Invoice.new(
+            id: json['id'],
+            amount: json['amount'],
+            due: json['due'],
+            tax_id: json['tax_id'],
+            name: json['name'],
+            expiration: json['expiration'],
+            fine: json['fine'],
+            interest: json['interest'],
+            discounts: json['discounts'],
+            tags: json['tags'],
+            descriptions: json['descriptions'],
+            nominal_amount: json['nominal_amount'],
+            fine_amount: json['fine_amount'],
+            interest_amount: json['interest_amount'],
+            discount_amount: json['discount_amount'],
+            brcode: json['brcode'],
+            status: json['status'],
+            updated: json['updated'],
+            created: json['created'],
+          )
+        }
+      }
+    end
+  end
+end

data/lib/invoice/log.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('invoice')
+
+module StarkBank
+  class Invoice
+    # # Invoice::Log object
+    #
+    # Every time a Invoice entity is updated, a corresponding Invoice::Log
+    # is generated for the entity. This log is never generated by the
+    # user, but it can be retrieved to check additional information
+    # on the Invoice.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - invoice [Invoice]: Invoice entity to which the log refers to.
+    # - errors [list of strings]: list of errors linked to this Invoice event
+    # - type [string]: type of the Invoice event which triggered the log creation. ex: 'canceled' or 'paid'
+    # - created [DateTime]: creation datetime for the log. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    class Log < StarkBank::Utils::Resource
+      attr_reader :id, :created, :type, :errors, :invoice
+      def initialize(id:, created:, type:, errors:, invoice:)
+        super(id)
+        @type = type
+        @errors = errors
+        @invoice = invoice
+        @created = StarkBank::Utils::Checks.check_datetime(created)
+      end
+
+      # # Retrieve a specific Log
+      #
+      # Receive a single Log object previously created by the Stark Bank API by passing its id
+      #
+      # ## Parameters (required):
+      # - id [string]: object unique id. ex: '5656565656565656'
+      #
+      # ## Parameters (optional):
+      # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - Log object with updated attributes
+      def self.get(id, user: nil)
+        StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+      end
+
+      # # Retrieve Logs
+      #
+      # Receive a generator of Log objects previously created in the Stark Bank API
+      #
+      # ## 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)
+      # - types [list of strings, default nil]: filter for log event types. ex: 'paid' or 'canceled'
+      # - invoice_ids [list of strings, default nil]: list of Invoice ids to filter logs. ex: ['5656565656565656', '4545454545454545']
+      # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+      #
+      # ## Return:
+      # - list of Log objects with updated attributes
+      def self.query(limit: nil, after: nil, before: nil, types: nil, invoice_ids: nil, user: nil)
+        after = StarkBank::Utils::Checks.check_date(after)
+        before = StarkBank::Utils::Checks.check_date(before)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          invoice_ids: invoice_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        invoice_maker = StarkBank::Invoice.resource[:resource_maker]
+        {
+          resource_name: 'InvoiceLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              created: json['created'],
+              type: json['type'],
+              errors: json['errors'],
+              invoice: StarkBank::Utils::API.from_api_json(invoice_maker, json['invoice'])
+            )
+          }
+        }
+      end
+    end
+  end
+end

data/lib/starkbank.rb

@@ -4,6 +4,8 @@ require_relative('key')
 require_relative('user/project')
 require_relative('balance/balance')
 require_relative('transaction/transaction')
+require_relative('invoice/invoice')
+require_relative('invoice/log')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
 require_relative('boleto_holmes/boleto_holmes')

data/lib/transfer/transfer.rb

@@ -40,7 +40,7 @@ module StarkBank
       @bank_code = bank_code
       @branch_code = branch_code
       @account_number = account_number
-      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
       @transaction_ids = transaction_ids
       @fee = fee
       @tags = tags

data/lib/utility_payment/utility_payment.rb

@@ -36,7 +36,7 @@ module StarkBank
       @line = line
       @bar_code = bar_code
       @tags = tags
-      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
       @amount = amount
       @fee = fee
       @status = status

data/lib/utils/api.rb

@@ -28,21 +28,22 @@ module StarkBank
         hash.each do |key, value|
           next if value.nil?
 
-          value = value.is_a?(Date) || value.is_a?(DateTime) || value.is_a?(Time) ? value.strftime('%Y-%m-%d') : value
+          entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = parse_value(value)
+        end
+        entity_hash
+      end
 
-          if value.is_a?(Array)
-            list = []
-            value.each do |v|
-              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
+      def self.parse_value(value)
+        return value.strftime('%Y-%m-%d') if value.is_a?(Date)
+        return value.strftime('%Y-%m-%dT%H:%M:%S+00:00') if value.is_a?(DateTime) || value.is_a?(Time)
+        return cast_json_to_api_format(value) if value.is_a?(Hash)
+        return value unless value.is_a?(Array)
 
-          entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value
+        list = []
+        value.each do |v|
+          list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
         end
-        entity_hash
+        list
       end
 
       def self.from_api_json(resource_maker, json)

data/lib/utils/checks.rb

@@ -46,7 +46,8 @@ module StarkBank
 
         return Time.new(data.year, data.month, data.day) if data.is_a?(Date)
 
-        check_datetime_string(data)
+        data, _type = check_datetime_string(data)
+        data
       end
 
       def self.check_date(data)
@@ -56,9 +57,9 @@ module StarkBank
 
         return data if data.is_a?(Date)
 
-        data = check_datetime_string(data)
+        data, type = check_datetime_string(data)
 
-        Date.new(data.year, data.month, data.day)
+        type == 'date' ? Date.new(data.year, data.month, data.day) : data
       end
 
       class << self
@@ -68,17 +69,17 @@ module StarkBank
           data = data.to_s
 
           begin
-            return DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S.%L+00:00')
+            return [DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S.%L+00:00'), 'datetime']
           rescue ArgumentError
           end
 
           begin
-            return DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S+00:00')
+            return [DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S+00:00'), 'datetime']
           rescue ArgumentError
           end
 
           begin
-            return DateTime.strptime(data, '%Y-%m-%d')
+            return [DateTime.strptime(data, '%Y-%m-%d'), 'date']
           rescue ArgumentError
             raise(ArgumentError, 'invalid datetime string ' + data)
           end

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.1.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.2.0.beta2"
         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: 2.1.0
+  version: 2.2.0.beta2
 platform: ruby
 authors:
 - starkbank
@@ -81,6 +81,8 @@ files:
 - lib/boleto_payment/log.rb
 - lib/error.rb
 - lib/event/event.rb
+- lib/invoice/invoice.rb
+- lib/invoice/log.rb
 - lib/key.rb
 - lib/payment_request/payment_request.rb
 - lib/starkbank.rb
@@ -116,9 +118,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: