starkbank 0.5.0 → 2.2.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0509d964f6d6ff483444229021b1ac146d3c27ca7930e1d906fc51ba7ef49541'
-  data.tar.gz: f0a14115c5b83db21dffcc339df07038c6ef21234547602e44e825d9c4b6aea4
+  metadata.gz: 766b123365232a3f071a9a12072eaf8fc2f30021a72ed0f4a41b54726fca81c5
+  data.tar.gz: 5c8349015b1ee06624223bdeb28ca9f3765e92bba3d62ebe04e76656a0ec14e8
 SHA512:
-  metadata.gz: d74d8dbc64191c7ad538b0d7529372860cc23cf8b429158d130911dd2e7a568207ccd635c929b0fe106805036110e72e16567686cb4a161c250fcde4d7cf0811
-  data.tar.gz: e7737c06154ce9430e4345682fdc7efbffc297e95aa18f6ca6583512a5183dbbbb6ee054a3e1c7a3c3d9834d6fe1efbb3ced9a40c7fdb1dde943cc0422ac5384
+  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_holmes/boleto_holmes.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # BoletoHolmes object
+  #
+  # When you initialize a BoletoHolmes, the entity will not be automatically
+  # created in the Stark Bank API. The 'create' function sends the objects
+  # to the Stark Bank API and returns the list of created objects.
+  #
+  # ## Parameters (required):
+  # - boleto_id [string]: investigated boleto entity ID. ex: '5656565656565656'
+  #
+  # ## Parameters (optional):
+  # - tags [list of strings]: list of strings for tagging
+  #
+  # ## Attributes (return-only):
+  # - id [string, default nil]: unique id returned when holmes is created. ex: '5656565656565656'
+  # - status [string, default nil]: current holmes status. ex: 'solving' or 'solved'
+  # - result [string, default nil]: result of boleto status investigation. ex: 'paid' or 'cancelled'
+  # - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  # - updated [DateTime, default nil]: latest update datetime for the holmes. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+  class BoletoHolmes < StarkBank::Utils::Resource
+    attr_reader :boleto_id, :tags, :id, :status, :result, :created, :updated
+    def initialize(
+      boleto_id:, tags: nil, id: nil, status: nil, result: nil, created: nil, updated: nil
+    )
+      super(id)
+      @boleto_id = boleto_id
+      @tags = tags
+      @status = status
+      @result = result
+      @created = StarkBank::Utils::Checks.check_datetime(created)
+      @updated = StarkBank::Utils::Checks.check_datetime(updated)
+    end
+
+    # # Create BoletoHolmes
+    #
+    # Send a list of BoletoHolmes objects for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - holmes [list of BoletoHolmes objects]: list of BoletoHolmes 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 BoletoHolmes objects with updated attributes
+    def self.create(holmes, user: nil)
+      StarkBank::Utils::Rest.post(entities: holmes, user: user, **resource)
+    end
+
+    # # Retrieve a specific BoletoHolmes
+    #
+    # Receive a single BoletoHolmes 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:
+    # - BoletoHolmes object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve BoletoHolmes
+    #
+    # Receive a generator of BoletoHolmes 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: 'solved'
+    # - 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']
+    # - boleto_id [string, default nil]: filter for holmes that investigate a specific boleto by its ID. ex: '5656565656565656'
+    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of BoletoHolmes objects with updated attributes
+    def self.query(limit: nil, after: nil, before: nil, status: nil, tags: nil, ids: nil, boleto_id: 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,
+        boleto_id: boleto_id,
+        user: user,
+        **resource
+      )
+    end
+
+    def self.resource
+      {
+        resource_name: 'BoletoHolmes',
+        resource_maker: proc { |json|
+          BoletoHolmes.new(
+            boleto_id: json['boleto_id'],
+            tags: json['tags'],
+            id: json['id'],
+            status: json['status'],
+            result: json['result'],
+            created: json['created'],
+            updated: json['updated']
+          )
+        }
+      }
+    end
+  end
+end

data/lib/boleto_holmes/log.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('boleto_holmes')
+
+module StarkBank
+  class BoletoHolmes
+    # # BoletoHolmes::Log object
+    #
+    # Every time a BoletoHolmes entity is modified, a corresponding BoletoHolmes::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 BoletoHolmes.
+    #
+    # ## Attributes:
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
+    # - holmes [BoletoHolmes]: BoletoHolmes entity to which the log refers to.
+    # - type [string]: type of the Boleto event which triggered the log creation. ex: 'registered' 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, :holmes, :type, :created
+      def initialize(id:, holmes:, type:, created:)
+        super(id)
+        @holmes = holmes
+        @type = type
+        @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 'registered'
+      # - holmes_ids [list of strings, default nil]: list of BoletoHolmes 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, holmes_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,
+          holmes_ids: holmes_ids,
+          user: user,
+          **resource
+        )
+      end
+
+      def self.resource
+        holmes_maker = StarkBank::BoletoHolmes.resource[:resource_maker]
+        {
+          resource_name: 'BoletoHolmesLog',
+          resource_maker: proc { |json|
+            Log.new(
+              id: json['id'],
+              holmes: StarkBank::Utils::API.from_api_json(holmes_maker, json['holmes']),
+              type: json['type'],
+              created: json['created']
+            )
+          }
+        }
+      end
+    end
+  end
+end

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

@@ -8,6 +8,8 @@ require_relative('../utils/checks')
 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')
@@ -21,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'
@@ -35,9 +37,11 @@ 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
+        'utility-payment': StarkBank::UtilityPayment::Log.resource,
+        'boleto-holmes': StarkBank::BoletoHolmes::Log.resource
       }[subscription.to_sym]
 
       @log = log

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/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

@@ -4,8 +4,12 @@ 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')
+require_relative('boleto_holmes/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
 require_relative('boleto_payment/boleto_payment')
@@ -14,6 +18,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

@@ -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
@@ -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/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

@@ -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)
@@ -22,19 +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
-          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)
@@ -52,7 +61,12 @@ module StarkBank
       end
 
       def self.last_name_plural(resource_name)
-        "#{last_name(resource_name)}s"
+        base = last_name(resource_name)
+
+        return base if base[-1].eql?('s')
+        return "#{base[0...-1]}ies" if base[-1].eql?('y')
+
+        "#{base}s"
       end
 
       def self.last_name(resource_name)

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-0.5.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: 0.5.0
+  version: 2.2.0.beta2
 platform: ruby
 authors:
 - starkbank
@@ -75,11 +75,16 @@ files:
 - lib/balance/balance.rb
 - lib/boleto/boleto.rb
 - lib/boleto/log.rb
+- lib/boleto_holmes/boleto_holmes.rb
+- lib/boleto_holmes/log.rb
 - lib/boleto_payment/boleto_payment.rb
 - 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
 - lib/transaction/transaction.rb
 - lib/transfer/log.rb
@@ -113,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: