starkbank 0.0.3 → 0.4.0

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
@@ -14,11 +14,11 @@ module StarkBank
     # be retrieved to check additional information on the UtilityPayment.
     #
     # ## Attributes:
-    # - id [string]: unique id returned when the log is created. ex: "5656565656565656"
+    # - id [string]: unique id returned when the log is created. ex: '5656565656565656'
     # - payment [UtilityPayment]: UtilityPayment entity to which the log refers to.
-    # - errors [list of strings]: list of errors linked to this BoletoPayment event.
-    # - type [string]: type of the UtilityPayment event which triggered the log creation. ex: "registered" or "paid"
-    # - created [DateTime]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
+    # - errors [list of strings]: list of errors linked to this UtilityPayment event.
+    # - type [string]: type of the UtilityPayment event which triggered the log creation. ex: 'processing' or 'success'
+    # - 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, :payment
       def initialize(id:, created:, type:, errors:, payment:)
@@ -34,14 +34,14 @@ module StarkBank
       # 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"
+      # - 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)
+      def self.get(id, user: nil)
         StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
       end
 
@@ -51,18 +51,26 @@ 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)
-      # - payment_ids [list of strings, default nil]: list of UtilityPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: "paid" or "registered"
+      # - 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
       #
       # ## Return:
       # - list of Log objects with updated attributes
-      def self.query(limit: nil, after: nil, before: nil, payment_ids: nil, types: nil, user: nil)
+      def self.query(limit: nil, after: nil, before: nil, types: nil, payment_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, payment_ids: payment_ids, types: types, **resource)
+        StarkBank::Utils::Rest.get_list(
+          user: user,
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          payment_ids: payment_ids,
+          **resource
+        )
       end
 
       def self.resource

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
@@ -12,19 +12,19 @@ module StarkBank
   # to the Stark Bank API and returns the list of created objects.
   #
   # ## Parameters (conditionally required):
-  # - line [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar_code' parameters are required. If both are sent, they must match. ex: "34191.09008 63571.277308 71444.640008 5 81960000000062"
-  # - bar_code [string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: "34195819600000000621090063571277307144464000"
+  # - line [string, default nil]: Number sequence that describes the payment. Either 'line' or 'bar_code' parameters are required. If both are sent, they must match. ex: '34191.09008 63571.277308 71444.640008 5 81960000000062'
+  # - bar_code [string, default nil]: Bar code number that describes the payment. Either 'line' or 'barCode' parameters are required. If both are sent, they must match. ex: '34195819600000000621090063571277307144464000'
   #
   # ## Parameters (required):
-  # - description [string]: Text to be displayed in your statement (min. 10 characters). ex: "payment ABC"
+  # - 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):
-  # - id [string, default nil]: unique id returned when payment is created. ex: "5656565656565656"
-  # - status [string, default nil]: current payment status. ex: "registered" or "paid"
+  # - id [string, default nil]: unique id returned when payment is created. ex: '5656565656565656'
+  # - status [string, default nil]: current payment status. ex: 'success' or 'failed'
   # - amount [int, default nil]: amount automatically calculated from line or bar_code. ex: 23456 (= R$ 234.56)
   # - fee [integer, default nil]: fee charged when utility payment is created. ex: 200 (= R$ 2.00)
   # - created [DateTime, default nil]: creation datetime for the payment. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
@@ -55,7 +55,7 @@ module StarkBank
     #
     # ## Return:
     # - list of UtilityPayment objects with updated attributes
-    def self.create(payments:, user: nil)
+    def self.create(payments, user: nil)
       StarkBank::Utils::Rest.post(entities: payments, user: user, **resource)
     end
 
@@ -64,31 +64,31 @@ module StarkBank
     # Receive a single UtilityPayment object previously created by the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - 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:
     # - UtilityPayment object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
     # # Retrieve a specific UtilityPayment pdf file
     #
     # Receive a single UtilityPayment pdf file generated in the Stark Bank API by passing its id.
-    # Only valid for utility payments with "success" status.
+    # Only valid for utility payments with 'success' status.
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - 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:
     # - UtilityPayment pdf file
-    def self.pdf(id:, user: nil)
+    def self.pdf(id, user: nil)
       StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
     end
 
@@ -98,19 +98,28 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - status [string, default nil]: filter for status of retrieved objects. ex: "paid"
-    # - 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"]
-    # - 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'
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of UtilityPayment objects with updated attributes
-    def self.query(limit: nil, status: nil, tags: nil, ids: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, tags: nil, ids: nil, status: 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, status: status, tags: tags, ids: ids, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
+        **resource
+      )
     end
 
     # # Delete a UtilityPayment entity
@@ -118,14 +127,14 @@ module StarkBank
     # Delete a UtilityPayment entity previously created in the Stark Bank API
     #
     # ## Parameters (required):
-    # - id [string]: UtilityPayment unique id. ex: "5656565656565656"
+    # - id [string]: UtilityPayment unique id. ex:'5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted UtilityPayment with updated attributes
-    def self.delete(id:, user: nil)
+    def self.delete(id, user: nil)
       StarkBank::Utils::Rest.delete_id(id: id, user: user, **resource)
     end
 

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/checks.rb

@@ -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.0.3"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.4.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

@@ -13,10 +13,10 @@ module StarkBank
   #
   # ## Parameters (required):
   # - url [string]: Url that will be notified when an event occurs.
-  # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "boleto-payment"]
+  # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'boleto-payment']
   #
   # ## Attributes:
-  # - id [string, default nil]: unique id returned when the log is created. ex: "5656565656565656"
+  # - id [string, default nil]: unique id returned when the webhook is created. ex: '5656565656565656'
   class Webhook < StarkBank::Utils::Resource
     attr_reader :url, :subscriptions, :id
     def initialize(url:, subscriptions:, id: nil)
@@ -30,8 +30,8 @@ module StarkBank
     # Send a single Webhook subscription for creation in the Stark Bank API
     #
     # ## Parameters (required):
-    # - url [string]: url to which notification events will be sent to. ex: "https://webhook.site/60e9c18e-4b5c-4369-bda1-ab5fcd8e1b29"
-    # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ["transfer", "boleto-payment"]
+    # - url [string]: url to which notification events will be sent to. ex: 'https://webhook.site/60e9c18e-4b5c-4369-bda1-ab5fcd8e1b29'
+    # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'boleto-payment']
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
@@ -47,14 +47,14 @@ module StarkBank
     # Receive a single Webhook subscription object previously created in the Stark Bank API by passing its id
     #
     # ## Parameters (required):
-    # - id [string]: object unique id. ex: "5656565656565656"
+    # - 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:
     # - Webhook object with updated attributes
-    def self.get(id:, user: nil)
+    def self.get(id, user: nil)
       StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
     end
 
@@ -77,14 +77,14 @@ module StarkBank
     # Delete a Webhook entity previously created in the Stark Bank API
     #
     # ## Parameters (required):
-    # - id [string]: Webhook unique id. ex: "5656565656565656"
+    # - id [string]: Webhook unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Webhook with updated attributes
-    def self.delete(id:, user: nil)
+    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.0.3
+  version: 0.4.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: