starkbank 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aa5336a1427970ca71e3d9ca7a68f7aa3402be6936ee27a701d0a6fba183ce2
-  data.tar.gz: 8c7d657462bbcb6d86e5771d6eb0dd0be71bee6be53eae6fc4c55dbc2d7c1557
+  metadata.gz: 5ed02a2cf89a34081d504370f79d01068b224aa3f6530a16a7e74f2582045faf
+  data.tar.gz: 189183b442509752217bcf826336da7236e6fa801af8743f90ac1f2af8736c92
 SHA512:
-  metadata.gz: 80882aa5140ad914f1be8a0f069b07ef50806b7e0517fee3cf61f8cac63dce37de0c7f1ecb84d34fea25c862a38505b43ccfe7699a1d9c92ae3af1ac23795c1a
-  data.tar.gz: 8a47d333f417739b7b7ea59aa8a575b3539042809d99b84a8127e91eb6f453722b91b9d122f464c85d33e0e2ffdafd1d1b8f8c1c7f83475ed42a2939572f9f8d
+  metadata.gz: 5e23b7e130e111c4c7f79d106c3f81066422c41d4af80b6fba92874b30472d9be9d0f2e181f47e1059deb0e0e08a340605df879f254fc6022f9cce1a16c926af
+  data.tar.gz: 53fd72934ef9b5ae3b16914ea9ac4060926df848e96f2a2caf5c3ea27f72c43f282d18909653a0bd981c77125c4d2610a3c1c19bf8b5cb1b2876c822e3bab954

data/lib/boleto/boleto.rb

@@ -21,13 +21,14 @@ module StarkBank
   # - city [string]: payer address city. ex: Rio de Janeiro
   # - state_code [string]: payer address state. ex: GO
   # - zip_code [string]: payer address zip code. ex: 01311-200
-  # - due [Date, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30
   #
   # ## Parameters (optional):
+  # - due [Date, DateTime, Time or string, default today + 2 days]: Boleto due date in ISO format. ex: 2020-04-30
   # - 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 automatic Boleto cancellation after due date. ex: 7 (max: 59)
   # - 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
   #
   # ## Attributes (return-only):
@@ -38,11 +39,11 @@ 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, :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, :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, id: nil, fee: nil, line: nil,
-      bar_code: nil, status: nil, created: nil
+      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
     )
       super(id)
       @amount = amount
@@ -60,6 +61,7 @@ module StarkBank
       @overdue_limit = overdue_limit
       @tags = tags
       @descriptions = descriptions
+      @discounts = discounts
       @fee = fee
       @line = line
       @bar_code = bar_code
@@ -121,8 +123,8 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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']
@@ -181,6 +183,7 @@ module StarkBank
             overdue_limit: json['overdue_limit'],
             tags: json['tags'],
             descriptions: json['descriptions'],
+            discounts: json['discounts'],
             id: json['id'],
             fee: json['fee'],
             line: json['line'],

data/lib/boleto/log.rb

@@ -52,8 +52,8 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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'
       # - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ['5656565656565656', '4545454545454545']
       # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call

data/lib/{payment/boleto/boleto.rb → boleto_payment/boleto_payment.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../../utils/resource')
-require_relative('../../utils/rest')
-require_relative('../../utils/checks')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
 
 module StarkBank
   # # BoletoPayment object
@@ -20,7 +20,7 @@ module StarkBank
   # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
   #
   # ## Parameters (optional):
-  # - scheduled [Date, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
+  # - scheduled [Date, DateTime, Time or string, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
   # - tags [list of strings]: list of strings for tagging
   #
   # ## Attributes (return-only):
@@ -100,8 +100,8 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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']
     # - ids [list of strings, default nil]: list of strings to get specific entities by ids. ex: ['12376517623', '1928367198236']
     # - status [string, default nil]: filter for status of retrieved objects. ex: 'paid'

data/lib/{payment/boleto → boleto_payment}/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../../utils/resource')
-require_relative('../../utils/rest')
-require_relative('../../utils/checks')
-require_relative('boleto')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('boleto_payment')
 
 module StarkBank
   class BoletoPayment
@@ -52,8 +52,8 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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 retrieved objects by event types. ex: 'paid' or 'registered'
       # - payment_ids [list of strings, default nil]: list of BoletoPayment 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

data/lib/{webhook → event}/event.rb

@@ -9,8 +9,8 @@ require_relative('../utils/cache')
 require_relative('../error')
 require_relative('../boleto/log')
 require_relative('../transfer/log')
-require_relative('../payment/boleto/log')
-require_relative('../payment/utility/log')
+require_relative('../boleto_payment/log')
+require_relative('../utility_payment/log')
 
 module StarkBank
   # # Webhook Event object
@@ -65,8 +65,8 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, default nil]: date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil]: date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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)
     # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: True or False
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
@@ -164,7 +164,7 @@ module StarkBank
       end
 
       def get_public_key_pem(user)
-        StarkBank::Utils::Request.fetch(method: 'GET', path: 'public-key', query: {limit: 1}, user: user).json['publicKeys'][0]['content']
+        StarkBank::Utils::Request.fetch(method: 'GET', path: 'public-key', query: { limit: 1 }, user: user).json['publicKeys'][0]['content']
       end
 
       def resource

data/lib/starkbank.rb

@@ -2,18 +2,18 @@
 
 require_relative('key')
 require_relative('user/project')
-require_relative('ledger/balance')
-require_relative('ledger/transaction')
+require_relative('balance/balance')
+require_relative('transaction/transaction')
 require_relative('boleto/boleto')
 require_relative('boleto/log')
 require_relative('transfer/transfer')
 require_relative('transfer/log')
-require_relative('payment/boleto/boleto')
-require_relative('payment/boleto/log')
-require_relative('payment/utility/utility')
-require_relative('payment/utility/log')
+require_relative('boleto_payment/boleto_payment')
+require_relative('boleto_payment/log')
+require_relative('utility_payment/utility_payment')
+require_relative('utility_payment/log')
 require_relative('webhook/webhook')
-require_relative('webhook/event')
+require_relative('event/event')
 
 # SDK to facilitate Ruby integrations with Stark Bank
 module StarkBank

data/lib/{ledger → transaction}/transaction.rb

@@ -29,10 +29,11 @@ module StarkBank
   # - source [string, default nil]: locator of the entity that generated the transaction. ex: 'charge/1827351876292', 'transfer/92873912873/chargeback'
   # - id [string, default nil]: unique id returned when Transaction is created. ex: '7656565656565656'
   # - fee [integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
+  # - balance [integer, default nil]: account balance after transaction was processed. ex: 100000000 (= R$ 1,000,000.00)
   # - created [DateTime, default nil]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Transaction < StarkBank::Utils::Resource
     attr_reader :amount, :description, :external_id, :receiver_id, :sender_id, :tags, :id, :fee, :created, :source
-    def initialize(amount:, description:, external_id:, receiver_id:, sender_id: nil, tags: nil, id: nil, fee: nil, created: nil, source: nil)
+    def initialize(amount:, description:, external_id:, receiver_id:, sender_id: nil, tags: nil, id: nil, fee: nil, source: nil, balance: nil, created: nil)
       super(id)
       @amount = amount
       @description = description
@@ -42,6 +43,7 @@ module StarkBank
       @tags = tags
       @fee = fee
       @source = source
+      @balance = balance
       @created = StarkBank::Utils::Checks.check_datetime(created)
     end
 
@@ -83,8 +85,8 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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)
     # - 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
     #
@@ -109,8 +111,9 @@ module StarkBank
             tags: json['tags'],
             id: json['id'],
             fee: json['fee'],
-            created: json['created'],
-            source: json['source']
+            source: json['source'],
+            balance: json['balance'],
+            created: json['created']
           )
         }
       }

data/lib/transfer/log.rb

@@ -51,8 +51,8 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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 retrieved objects by types. ex: 'success' or 'failed'
       # - transfer_ids [list of strings, default nil]: list of Transfer 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

data/lib/transfer/transfer.rb

@@ -102,8 +102,8 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - after [Date, DateTime, Time or string, default nil] date filter for objects created or updated only after specified date. ex: Date.new(2020, 3, 10)
+    # - 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: 'paid' or 'registered'
     # - tags [list of strings, default nil]: tags to filter retrieved objects. ex: ['tony', 'stark']

data/lib/{payment/utility → utility_payment}/log.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative('../../utils/resource')
-require_relative('../../utils/rest')
-require_relative('../../utils/checks')
-require_relative('utility')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+require_relative('utility_payment')
 
 module StarkBank
   class UtilityPayment
@@ -51,8 +51,8 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-      # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+      # - 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 retrieved objects by event types. ex: 'paid' or 'registered'
       # - payment_ids [list of strings, default nil]: list of UtilityPayment 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

data/lib/{payment/utility/utility.rb → utility_payment/utility_payment.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative('../../utils/resource')
-require_relative('../../utils/rest')
-require_relative('../../utils/checks')
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
 
 module StarkBank
   # # UtilityPayment object
@@ -19,7 +19,7 @@ module StarkBank
   # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
   #
   # ## Parameters (optional):
-  # - scheduled [Date, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
+  # - scheduled [Date, DateTime, Time or string, default today]: payment scheduled date. ex: Date.new(2020, 3, 10)
   # - tags [list of strings]: list of strings for tagging
   #
   # ## Attributes (return-only):
@@ -98,8 +98,8 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, default nil] date filter for objects only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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']
     # - ids [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: 'paid'

data/lib/utils/api.rb

@@ -6,9 +6,13 @@ module StarkBank
   module Utils
     module API
       def self.api_json(entity)
-        entity_hash = {}
-        entity.instance_variables.each do |key|
-          entity_hash[key[1..-1]] = entity.instance_variable_get(key)
+        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)
+          end
         end
         cast_json_to_api_format(entity_hash)
       end
@@ -19,6 +23,15 @@ module StarkBank
           next if value.nil?
 
           value = value.is_a?(Date) || value.is_a?(DateTime) || value.is_a?(Time) ? value.strftime('%Y-%m-%d') : value
+
+          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
+
           entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value
         end
         entity_hash

data/lib/utils/request.rb

@@ -60,7 +60,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.1.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.2.0"
 
         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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - starkbank
@@ -44,21 +44,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/balance/balance.rb
 - lib/boleto/boleto.rb
 - lib/boleto/log.rb
+- lib/boleto_payment/boleto_payment.rb
+- lib/boleto_payment/log.rb
 - lib/error.rb
+- lib/event/event.rb
 - lib/key.rb
-- lib/ledger/balance.rb
-- lib/ledger/transaction.rb
-- lib/payment/boleto/boleto.rb
-- lib/payment/boleto/log.rb
-- lib/payment/utility/log.rb
-- lib/payment/utility/utility.rb
 - lib/starkbank.rb
+- lib/transaction/transaction.rb
 - lib/transfer/log.rb
 - lib/transfer/transfer.rb
 - lib/user/project.rb
 - lib/user/user.rb
+- lib/utility_payment/log.rb
+- lib/utility_payment/utility_payment.rb
 - lib/utils/api.rb
 - lib/utils/cache.rb
 - lib/utils/case.rb
@@ -68,7 +69,6 @@ files:
 - lib/utils/resource.rb
 - lib/utils/rest.rb
 - lib/utils/url.rb
-- lib/webhook/event.rb
 - lib/webhook/webhook.rb
 homepage: https://github.com/starkbank/sdk-ruby
 licenses: