starkbank 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9faf8d2408757d1281ac59d59cba4303a3db835b21382a7a89d02110c5c2ae07
-  data.tar.gz: d615e724e7e2a51a5ced3b852bc84895b512fdc5b0a1c3fb456455619f1d1744
+  metadata.gz: '0509d964f6d6ff483444229021b1ac146d3c27ca7930e1d906fc51ba7ef49541'
+  data.tar.gz: f0a14115c5b83db21dffcc339df07038c6ef21234547602e44e825d9c4b6aea4
 SHA512:
-  metadata.gz: acbc1fd9c1c9636dff4d50209bc833618fce68e7d32da3b004e965ff4bd6138aa27a464e6e14a6766fe700bca41f4736ddfda58ae7a3d3d49f8e84d0004a2888
-  data.tar.gz: 8728b2cfb5c1afa974c90f54eb0439d43f21f9e72ab968a715a6dddb8a0262f72d9d0ffeeaf462c837602d4cb6b7c70413770c27624dadb6cdb87fa51def730c
+  metadata.gz: d74d8dbc64191c7ad538b0d7529372860cc23cf8b429158d130911dd2e7a568207ccd635c929b0fe106805036110e72e16567686cb4a161c250fcde4d7cf0811
+  data.tar.gz: e7737c06154ce9430e4345682fdc7efbffc297e95aa18f6ca6583512a5183dbbbb6ee054a3e1c7a3c3d9834d6fe1efbb3ced9a40c7fdb1dde943cc0422ac5384

data/lib/boleto/boleto.rb

@@ -27,6 +27,8 @@ module StarkBank
   # - fine [float, default 0.0]: Boleto fine for overdue payment in %. ex: 2.5
   # - interest [float, default 0.0]: Boleto monthly interest for overdue payment in %. ex: 5.2
   # - overdue_limit [integer, default 59]: limit in days for payment after due date. ex: 7 (max: 59)
+  # - receiver_name [string]: receiver (Sacador Avalista) full name. ex: 'Anthony Edward Stark'
+  # - receiver_tax_id [string]: receiver (Sacador Avalista) tax ID (CPF or CNPJ) with or without formatting. ex: '01234567890' or '20.018.183/0001-80'
   # - descriptions [list of dictionaries, default nil]: list of dictionaries with 'text':string and (optional) 'amount':int pairs
   # - discounts [list of dictionaries, default nil]: list of dictionaries with 'percentage':float and 'date':Date or string pairs
   # - tags [list of strings]: list of strings for tagging
@@ -39,11 +41,12 @@ module StarkBank
   # - status [string, default nil]: current Boleto status. ex: 'registered' or 'paid'
   # - created [DateTime, default nil]: creation datetime for the Boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Boleto < StarkBank::Utils::Resource
-    attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :tags, :descriptions, :discounts, :id, :fee, :line, :bar_code, :status, :created
+    attr_reader :amount, :name, :tax_id, :street_line_1, :street_line_2, :district, :city, :state_code, :zip_code, :due, :fine, :interest, :overdue_limit, :receiver_name, :receiver_tax_id, :tags, :descriptions, :discounts, :id, :fee, :line, :bar_code, :status, :created
     def initialize(
       amount:, name:, tax_id:, street_line_1:, street_line_2:, district:, city:, state_code:, zip_code:,
-      due: nil, fine: nil, interest: nil, overdue_limit: nil, tags: nil, descriptions: nil, discounts: nil,
-      id: nil, fee: nil, line: nil, bar_code: nil, status: nil, created: nil
+      due: nil, fine: nil, interest: nil, overdue_limit: nil, receiver_name: nil, receiver_tax_id: nil,
+      tags: nil, descriptions: nil, discounts: nil, id: nil, fee: nil, line: nil, bar_code: nil,
+      status: nil, created: nil
     )
       super(id)
       @amount = amount
@@ -59,6 +62,8 @@ module StarkBank
       @fine = fine
       @interest = interest
       @overdue_limit = overdue_limit
+      @receiver_name = receiver_name
+      @receiver_tax_id = receiver_tax_id
       @tags = tags
       @descriptions = descriptions
       @discounts = discounts
@@ -109,12 +114,13 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
+    # - layout [string]: Layout specification. Available options are "default" and "booklet"
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Boleto pdf file
-    def self.pdf(id, user: nil)
-      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+    def self.pdf(id, layout: nil, user: nil)
+      StarkBank::Utils::Rest.get_pdf(id: id, layout: layout, user: user, **resource)
     end
 
     # # Retrieve Boletos
@@ -158,7 +164,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted Boleto with updated attributes
+    # - deleted Boleto object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
@@ -181,6 +187,8 @@ module StarkBank
             fine: json['fine'],
             interest: json['interest'],
             overdue_limit: json['overdue_limit'],
+            receiver_name: json['receiver_name'],
+            receiver_tax_id: json['receiver_tax_id'],
             tags: json['tags'],
             descriptions: json['descriptions'],
             discounts: json['discounts'],

data/lib/boleto_payment/boleto_payment.rb

@@ -133,7 +133,7 @@ module StarkBank
     # Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     # Return:
-    # - deleted BoletoPayment with updated attributes
+    # - deleted BoletoPayment object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/event/event.rb

@@ -33,14 +33,15 @@ module StarkBank
       @is_delivered = is_delivered
       @subscription = subscription
 
-      maker = {
+      resource = {
         'transfer': StarkBank::Transfer::Log.resource,
         'boleto': StarkBank::Boleto::Log.resource,
         'boleto-payment': StarkBank::BoletoPayment::Log.resource,
         'utility-payment': StarkBank::UtilityPayment::Log.resource
-      }[subscription.to_sym][:resource_maker]
+      }[subscription.to_sym]
 
-      @log = StarkBank::Utils::API.from_api_json(maker, log)
+      @log = log
+      @log = StarkBank::Utils::API.from_api_json(resource[:resource_maker], log) unless resource.nil?
     end
 
     # # Retrieve a specific notification Event
@@ -96,7 +97,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted Event with updated attributes
+    # - deleted Event object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/key.rb

@@ -15,7 +15,7 @@ module StarkBank
     # ## Return:
     # - private and public key pems
     def self.create(path = nil)
-      private_key = PrivateKey.new
+      private_key = EllipticCurve::PrivateKey.new
       public_key = private_key.publicKey
 
       private_key_pem = private_key.toPem

data/lib/starkbank.rb

@@ -18,5 +18,6 @@ require_relative('event/event')
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank
   @user = nil
-  class << self; attr_accessor :user; end
+  @language = 'en-US'
+  class << self; attr_accessor :user, :language; end
 end

data/lib/transaction/transaction.rb

@@ -87,15 +87,16 @@ module StarkBank
     # - 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)
+    # - 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']
     # - 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, external_ids: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, tags: nil, external_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, external_ids: external_ids, **resource)
+      StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, tags: tags, external_ids: external_ids, **resource)
     end
 
     def self.resource

data/lib/transfer/transfer.rb

@@ -21,6 +21,7 @@ module StarkBank
   #
   # ## 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)
   #
   # ## Attributes (return-only):
   # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
@@ -30,8 +31,8 @@ module StarkBank
   # - created [DateTime, default nil]: creation datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   # - updated [DateTime, default nil]: latest update datetime for the transfer. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Transfer < StarkBank::Utils::Resource
-    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
-    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
+    attr_reader :amount, :name, :tax_id, :bank_code, :branch_code, :account_number, :scheduled, :transaction_ids, :fee, :tags, :status, :id, :created, :updated
+    def initialize(amount:, name:, tax_id:, bank_code:, branch_code:, account_number:, scheduled: nil, transaction_ids: nil, fee: nil, tags: nil, status: nil, id: nil, created: nil, updated: nil)
       super(id)
       @amount = amount
       @name = name
@@ -39,6 +40,7 @@ module StarkBank
       @bank_code = bank_code
       @branch_code = branch_code
       @account_number = account_number
+      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
       @transaction_ids = transaction_ids
       @fee = fee
       @tags = tags
@@ -79,6 +81,22 @@ module StarkBank
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
+    # # Delete a Transfer entity
+    #
+    # Delete a Transfer entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: Transfer unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - deleted Transfer object
+    def self.delete(id, user: nil)
+      StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
+    end
+
     # # Retrieve a specific Transfer pdf file
     #
     # Receive a single Transfer pdf receipt file generated in the Stark Bank API by passing its id.
@@ -106,12 +124,13 @@ module StarkBank
     # - before [Date, DateTime, Time or string, default nil] date filter for objects created or updated only before specified date. ex: Date.new(2020, 3, 10)
     # - transactionIds [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
     # - 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']
     # - 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, 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, user: nil)
       after = StarkBank::Utils::Checks.check_date(after)
       before = StarkBank::Utils::Checks.check_date(before)
       StarkBank::Utils::Rest.get_list(
@@ -120,6 +139,7 @@ module StarkBank
         before: before,
         transaction_ids: transaction_ids,
         status: status,
+        tax_id: tax_id,
         sort: sort,
         tags: tags,
         user: user,
@@ -139,6 +159,7 @@ module StarkBank
             bank_code: json['bank_code'],
             branch_code: json['branch_code'],
             account_number: json['account_number'],
+            scheduled: json['scheduled'],
             transaction_ids: json['transaction_ids'],
             fee: json['fee'],
             tags: json['tags'],

data/lib/user/user.rb

@@ -2,12 +2,12 @@
 
 require('starkbank-ecdsa')
 require_relative('../utils/resource')
-require_relative('../utils/checks')
 
 module StarkBank
   class User < StarkBank::Utils::Resource
     attr_reader :pem, :environment
     def initialize(environment, id, private_key)
+      require_relative('../utils/checks')
       super(id)
       @pem = StarkBank::Utils::Checks.check_private_key(private_key)
       @environment = StarkBank::Utils::Checks.check_environment(environment)

data/lib/utility_payment/utility_payment.rb

@@ -133,7 +133,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted UtilityPayment with updated attributes
+    # - deleted UtilityPayment object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

data/lib/utils/checks.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require('starkbank-ecdsa')
 require('date')
-require_relative('../user/user')
+require('starkbank-ecdsa')
 require_relative('environment')
+require_relative('../user/user')
 
 module StarkBank
   module Utils
@@ -17,6 +17,14 @@ module StarkBank
         user
       end
 
+      def self.check_language
+        language = StarkBank.language
+        accepted_languages = %w[en-US pt-BR]
+        raise(ArgumentError, "Select a valid language: #{accepted_languages.join(', ')}") unless accepted_languages.include?(language)
+
+        language
+      end
+
       def self.check_environment(environment)
         environments = StarkBank::Utils::Environment.constants(false).map { |c| StarkBank::Utils::Environment.const_get(c) }
         raise(ArgumentError, "Select a valid environment: #{environments.join(', ')}") unless environments.include?(environment)

data/lib/utils/request.rb

@@ -24,6 +24,7 @@ module StarkBank
 
       def self.fetch(method:, path:, payload: nil, query: nil, user: nil)
         user = Checks.check_user(user)
+        language = Checks.check_language
 
         base_url = {
           Environment::PRODUCTION => 'https://api.starkbank.com/',
@@ -60,7 +61,8 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.2.1"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.5.0"
+        req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }
 

data/lib/utils/rest.rb

@@ -47,10 +47,11 @@ module StarkBank
         StarkBank::Utils::API.from_api_json(resource_maker, entity)
       end
 
-      def self.get_pdf(resource_name:, resource_maker:, id:, user: nil)
+      def self.get_pdf(resource_name:, resource_maker:, id:, user: nil, **query)
         StarkBank::Utils::Request.fetch(
           method: 'GET',
           path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/pdf",
+          query: StarkBank::Utils::API.cast_json_to_api_format(query),
           user: user
         ).content
       end

data/lib/webhook/webhook.rb

@@ -83,7 +83,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
-    # - deleted Webhook with updated attributes
+    # - deleted Webhook object
     def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - starkbank
@@ -16,28 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 5.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 5.14.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.81'
 description: 
 email: 
 executables: []
@@ -89,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: SDK to facilitate Ruby integrations with Stark Bank