starkbank 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a8806c80a8e9dbc2e9a5a4bae7a2e6896f26965c9dbc49b89c696bfffe6d39
-  data.tar.gz: f262f62c95a8b4f6c96c324bbce27132ab6ca53a82bd288bb03241b5c113d352
+  metadata.gz: 7aa5336a1427970ca71e3d9ca7a68f7aa3402be6936ee27a701d0a6fba183ce2
+  data.tar.gz: 8c7d657462bbcb6d86e5771d6eb0dd0be71bee6be53eae6fc4c55dbc2d7c1557
 SHA512:
-  metadata.gz: fb86b4fed4b17b56328c23291cc228349efed8c37cd76c556162c6b13f8f205786c6091d209b7953a9aa99a575c2d3e864660e0ae3554925586bb13c1925288f
-  data.tar.gz: 5bd3b78074da5436482dd0dbddb0fa3a63cdd4921e04063aa1d0559c442f58702748722e9f90602822a25ae6e9b3da8946ac5fcd75f6f7e1d533977379179e5f
+  metadata.gz: 80882aa5140ad914f1be8a0f069b07ef50806b7e0517fee3cf61f8cac63dce37de0c7f1ecb84d34fea25c862a38505b43ccfe7699a1d9c92ae3af1ac23795c1a
+  data.tar.gz: 8a47d333f417739b7b7ea59aa8a575b3539042809d99b84a8127e91eb6f453722b91b9d122f464c85d33e0e2ffdafd1d1b8f8c1c7f83475ed42a2939572f9f8d

data/lib/boleto/boleto.rb

@@ -79,7 +79,7 @@ module StarkBank
     #
     # ## Return:
     # - list of Boleto objects with updated attributes
-    def self.create(boletos:, user: nil)
+    def self.create(boletos, user: nil)
       StarkBank::Utils::Rest.post(entities: boletos, user: user, **resource)
     end
 
@@ -95,7 +95,7 @@ module StarkBank
     #
     # ## Return:
     # - Boleto 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
 
@@ -111,7 +111,7 @@ module StarkBank
     #
     # ## Return:
     # - Boleto 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
 
@@ -121,19 +121,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" 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"]
     # - 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)
+    # - 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 Boleto 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, 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(user: user, limit: limit, status: status, tags: tags, ids: ids, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        status: status,
+        tags: tags,
+        ids: ids,
+        user: user,
+        **resource
+      )
     end
 
     # # Delete a Boleto entity
@@ -148,7 +157,7 @@ module StarkBank
     #
     # ## Return:
     # - deleted Boleto 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/boleto/log.rb

@@ -42,7 +42,7 @@ module StarkBank
       #
       # ## 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
 
@@ -52,18 +52,26 @@ module StarkBank
       #
       # ## Parameters (optional):
       # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-      # - boleto_ids [list of strings, default nil]: list of Boleto ids to filter logs. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter for log event types. ex: "paid" or "registered"
       # - 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)
+      # - 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
       #
       # ## Return:
       # - list of Log objects with updated attributes
-      def self.query(limit: nil, boleto_ids: nil, types: nil, after: nil, before: nil, user: nil)
+      def self.query(limit: nil, after: nil, before: nil, types: nil, boleto_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, boleto_ids: boleto_ids, types: types, after: after, before: before, **resource)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          boleto_ids: boleto_ids,
+          user: user,
+          **resource
+        )
       end
 
       def self.resource

data/lib/ledger/transaction.rb

@@ -17,17 +17,17 @@ module StarkBank
   #
   # ## Parameters (required):
   # - amount [integer]: amount in cents to be transferred. ex: 1234 (= R$ 12.34)
-  # - description [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: "funds redistribution"
-  # - external_id [string]: unique id, generated by user, to avoid duplicated transactions. ex: "transaction ABC 2020-03-30"
-  # - received_id [string]: unique id of the receiving workspace. ex: "5656565656565656"
+  # - description [string]: text to be displayed in the receiver and the sender statements (Min. 10 characters). ex: 'funds redistribution'
+  # - external_id [string]: unique id, generated by user, to avoid duplicated transactions. ex: 'transaction ABC 2020-03-30'
+  # - received_id [string]: unique id of the receiving workspace. ex: '5656565656565656'
   #
   # ## Parameters (optional):
-  # - tags [list of strings]: list of strings for reference when searching transactions (may be empty). ex: ["abc", "test"]
+  # - tags [list of strings]: list of strings for reference when searching transactions (may be empty). ex: ['abc', 'test']
   #
   # ## Attributes (return-only):
-  # - sender_id [string]: unique id of the sending workspace. ex: "5656565656565656"
-  # - 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"
+  # - sender_id [string]: unique id of the sending workspace. ex: '5656565656565656'
+  # - 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)
   # - created [DateTime, default nil]: creation datetime for the boleto. ex: DateTime.new(2020, 3, 10, 10, 30, 0, 0)
   class Transaction < StarkBank::Utils::Resource
@@ -57,7 +57,7 @@ module StarkBank
     #
     # ## Return:
     # - list of Transaction objects with updated attributes
-    def self.create(transactions:, user: nil)
+    def self.create(transactions, user: nil)
       StarkBank::Utils::Rest.post(entities: transactions, user: user, **resource)
     end
 
@@ -73,7 +73,7 @@ module StarkBank
     #
     # ## Return:
     # - Transaction 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
 
@@ -83,17 +83,17 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - external_ids [list of strings, default nil]: list of external 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 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
     #
     # ## Return:
     # - generator of Transaction objects with updated attributes
-    def self.query(limit: nil, external_ids: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: 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, external_ids: external_ids, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(user: user, limit: limit, after: after, before: before, external_ids: external_ids, **resource)
     end
 
     def self.resource

data/lib/payment/boleto/boleto.rb

@@ -57,7 +57,7 @@ module StarkBank
     #
     # ## Return:
     # - list of BoletoPayment 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
 
@@ -73,7 +73,7 @@ module StarkBank
     #
     # ## Return:
     # - BoletoPayment 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
 
@@ -90,7 +90,7 @@ module StarkBank
     #
     # ## Return:
     # - BoletoPayment 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
 
@@ -100,18 +100,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"]
     # - 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)
+    # - 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'
     # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of BoletoPayment 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 BoletoPayment entity
@@ -124,7 +134,7 @@ module StarkBank
     # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
     # Return:
     # - deleted BoletoPayment 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/payment/boleto/log.rb

@@ -42,7 +42,7 @@ module StarkBank
       #
       # ## 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
 
@@ -54,16 +54,24 @@ module StarkBank
       # - 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 BoletoPayment ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter retrieved objects by event types. ex: "paid" or "registered"
+      # - 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
       #
       # ## 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(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          payment_ids: payment_ids,
+          user: user,
+          **resource
+        )
       end
 
       def self.resource

data/lib/payment/utility/log.rb

@@ -41,7 +41,7 @@ module StarkBank
       #
       # ## 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
 
@@ -53,16 +53,24 @@ module StarkBank
       # - 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"
+      # - 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

@@ -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
 
@@ -71,7 +71,7 @@ module StarkBank
     #
     # ## 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
 
@@ -88,7 +88,7 @@ module StarkBank
     #
     # ## 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)
+    # - 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
@@ -125,7 +134,7 @@ module StarkBank
     #
     # ## 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/transfer/log.rb

@@ -41,7 +41,7 @@ module StarkBank
       #
       # ## 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
-      # - transfer_ids [list of strings, default nil]: list of Transfer ids to filter retrieved objects. ex: ["5656565656565656", "4545454545454545"]
-      # - types [list of strings, default nil]: filter retrieved objects by types. ex: "success" or "failed"
       # - 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)
+      # - 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
       #
       # ## Return:
       # - list of Log objects with updated attributes
-      def self.query(limit: nil, transfer_ids: nil, types: nil, after: nil, before: nil, user: nil)
+      def self.query(limit: nil, after: nil, before: nil, types: nil, transfer_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, transfer_ids: transfer_ids, types: types, after: after, before: before, **resource)
+        StarkBank::Utils::Rest.get_list(
+          limit: limit,
+          after: after,
+          before: before,
+          types: types,
+          transfer_ids: transfer_ids,
+          user: user,
+          **resource
+        )
       end
 
       def self.resource

data/lib/transfer/transfer.rb

@@ -13,20 +13,20 @@ module StarkBank
   #
   # ## Parameters (required):
   # - 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]: receiver 1 to 3 digits of the bank institution in Brazil. ex: "200" or "341"
-  # - 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"
+  # - 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]: receiver 1 to 3 digits of the bank institution in Brazil. ex: '200' or '341'
+  # - 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"]
+  # - tags [list of strings]: list of strings for reference when searching for transfers. ex: ['employees', 'monthly']
   #
   # ## Attributes (return-only):
-  # - id [string, default nil]: unique id returned when Transfer is created. ex: "5656565656565656"
+  # - id [string, default nil]: unique id returned when Transfer is created. ex: '5656565656565656'
   # - fee [integer, default nil]: fee charged when transfer is created. ex: 200 (= R$ 2.00)
-  # - status [string, default nil]: current boleto status. ex: "registered" or "paid"
-  # - transaction_ids [list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ["19827356981273"]
+  # - status [string, default nil]: current boleto status. ex: 'registered' or 'paid'
+  # - transaction_ids [list of strings, default nil]: ledger transaction ids linked to this transfer (if there are two, second is the chargeback). ex: ['19827356981273']
   # - 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
@@ -59,7 +59,7 @@ module StarkBank
     #
     # ## Return:
     # - list of Transfer objects with updated attributes
-    def self.create(transfers:, user: nil)
+    def self.create(transfers, user: nil)
       StarkBank::Utils::Rest.post(entities: transfers, user: user, **resource)
     end
 
@@ -75,7 +75,7 @@ module StarkBank
     #
     # ## Return:
     # - Transfer 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
 
@@ -92,7 +92,7 @@ module StarkBank
     #
     # ## Return:
     # - Transfer 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
 
@@ -102,19 +102,29 @@ 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" 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"]
     # - 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)
+    # - 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']
     # - 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, status: nil, tags: nil, transaction_ids: nil, sort: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, transaction_ids: nil, status: 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(user: user, limit: limit, status: status, tags: tags, transaction_ids: transaction_ids, sort: sort, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        limit: limit,
+        after: after,
+        before: before,
+        transaction_ids: transaction_ids,
+        status: status,
+        sort: sort,
+        tags: tags,
+        user: user,
+        **resource
+      )
     end
 
     def self.resource

data/lib/user/project.rb

@@ -13,14 +13,14 @@ module StarkBank
   # each request or may be defined as the default user at the start (See README).
   #
   # ## Parameters (required):
-  # - id [string]: unique id required to identify project. ex: "5656565656565656"
-  # - private_key [EllipticCurve.Project()]: PEM string of the private key linked to the project. ex: "-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----"
-  # - environment [string]: environment where the project is being used. ex: "sandbox" or "production"
+  # - id [string]: unique id required to identify project. ex: '5656565656565656'
+  # - private_key [EllipticCurve.Project()]: PEM string of the private key linked to the project. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
+  # - environment [string]: environment where the project is being used. ex: 'sandbox' or 'production'
   #
   # ## Attributes (return-only):
-  # - name [string, default ""]: project name. ex: "MyProject"
-  # - allowed_ips [list of strings]: list containing the strings of the ips allowed to make requests on behalf of this project. ex: ["190.190.0.50"]
-  # - pem [string]: private key in pem format. ex: "-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----"
+  # - name [string, default ']: project name. ex: 'MyProject'
+  # - allowed_ips [list of strings]: list containing the strings of the ips allowed to make requests on behalf of this project. ex: ['190.190.0.50']
+  # - pem [string]: private key in pem format. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
   class Project < StarkBank::User
     attr_reader :name, :allowed_ips
     def initialize(environment:, id:, private_key:, name: '', allowed_ips: nil)

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.0.3"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-0.1.0"
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }
 

data/lib/webhook/event.rb

@@ -55,7 +55,7 @@ module StarkBank
     #
     # ## Return:
     # - Event 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
 
@@ -65,17 +65,24 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - is_delivered [bool, default nil]: bool to filter successfully delivered events. ex: True or False
     # - 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)
+    # - 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
     #
     # ## Return:
     # - generator of Event objects with updated attributes
-    def self.query(limit: nil, is_delivered: nil, after: nil, before: nil, user: nil)
+    def self.query(limit: nil, after: nil, before: nil, is_delivered: 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, is_delivered: is_delivered, after: after, before: before, **resource)
+      StarkBank::Utils::Rest.get_list(
+        user: user,
+        limit: limit,
+        after: after,
+        before: before,
+        is_delivered: is_delivered,
+        **resource
+      )
     end
 
     # # Delete a notification Event
@@ -90,7 +97,7 @@ module StarkBank
     #
     # ## Return:
     # - deleted Event 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
 
@@ -108,7 +115,7 @@ module StarkBank
     #
     # ## Return:
     # - target Event with updated attributes
-    def self.update(id:, is_delivered:, user: nil)
+    def self.update(id, is_delivered:, user: nil)
       StarkBank::Utils::Rest.patch_id(id: id, user: user, is_delivered: is_delivered, **resource)
     end
 
@@ -130,6 +137,12 @@ module StarkBank
     def self.parse(content:, signature:, user: nil)
       event = StarkBank::Utils::API.from_api_json(resource[:resource_maker], JSON.parse(content)['event'])
 
+      begin
+        signature = EllipticCurve::Signature.fromBase64(signature)
+      rescue
+        raise(StarkBank::Error::InvalidSignatureError, 'The provided signature is not valid')
+      end
+
       return event if verify_signature(content: content, signature: signature, user: user)
 
       return event if verify_signature(content: content, signature: signature, user: user, refresh: true)
@@ -141,7 +154,6 @@ module StarkBank
       private
 
       def verify_signature(content:, signature:, user:, refresh: false)
-        signature = EllipticCurve::Signature.fromBase64(signature)
         public_key = StarkBank::Utils::Cache.starkbank_public_key
         if public_key.nil? || refresh
           pem = get_public_key_pem(user)

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 log 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.1.0
 platform: ruby
 authors:
 - starkbank