starkbank 2.0.0 → 2.2.0

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 an 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,8 +4,18 @@ 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('dict_key/dict_key')
+require_relative('deposit/deposit')
+require_relative('deposit/log')
+require_relative('brcode_preview/brcode_preview')
+require_relative('brcode_payment/brcode_payment')
+require_relative('brcode_payment/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')

data/lib/transfer/transfer.rb

@@ -15,13 +15,13 @@ module StarkBank
   # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
   # - name [string]: receiver full name. ex: 'Anthony Edward Stark'
   # - tax_id [string]: receiver tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
-  # - bank_code [string]: 1 to 3 digits of the receiver bank institution in Brazil. ex: '200' or '341'
+  # - bank_code [string]: code of the receiver bank institution in Brazil. If an ISPB (8 digits) is informed, a PIX transfer will be created, else a TED will be issued. ex: '20018183' or '260'
   # - branch_code [string]: receiver bank account branch. Use '-' in case there is a verifier digit. ex: '1357-9'
   # - account_number [string]: Receiver Bank Account number. Use '-' before the verifier digit. ex: '876543-2'
   #
   # ## Parameters (optional):
   # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
-  # - scheduled [string, default now]: datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 11, 8, 0, 0, 0)
+  # - scheduled [string, default now]: datetime when the transfer will be processed. May be pushed to next business day if necessary. ex: DateTime.new(2020, 3, 11, 8, 13, 12, 11)
   #
   # ## Attributes (return-only):
   # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
@@ -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_or_datetime(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)
@@ -60,7 +61,13 @@ 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}s" if base[-2..-1].eql?('ey')
+        return "#{base[0...-1]}ies" if base[-1].eql?('y')
+
+        "#{base}s"
       end
 
       def self.last_name(resource_name)

data/lib/utils/checks.rb

@@ -39,6 +39,17 @@ module StarkBank
         raise(ArgumentError, 'Private-key must be a valid secp256k1 ECDSA string in pem format')
       end
 
+      def self.check_date_or_datetime(data)
+        return if data.nil?
+
+        return data if data.is_a?(Time) || data.is_a?(DateTime)
+
+        return data if data.is_a?(Date)
+
+        data, type = check_datetime_string(data)
+        type == 'date' ? Date.new(data.year, data.month, data.day) : data
+      end
+
       def self.check_datetime(data)
         return if data.nil?
 
@@ -46,7 +57,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 +68,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 +80,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.0.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.2.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/utils/rest.rb

@@ -56,6 +56,15 @@ module StarkBank
         ).content
       end
 
+      def self.get_qrcode(resource_name:, resource_maker:, id:, user: nil, **query)
+        StarkBank::Utils::Request.fetch(
+          method: 'GET',
+          path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/qrcode",
+          query: StarkBank::Utils::API.cast_json_to_api_format(query),
+          user: user
+        ).content
+      end
+
       def self.post(resource_name:, resource_maker:, entities:, user: nil)
         jsons = []
         entities.each do |entity|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - starkbank
@@ -75,10 +75,20 @@ 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/brcode_payment/brcode_payment.rb
+- lib/brcode_payment/log.rb
+- lib/brcode_preview/brcode_preview.rb
+- lib/deposit/deposit.rb
+- lib/deposit/log.rb
+- lib/dict_key/dict_key.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