starkbank 2.2.0 → 2.5.0

data/lib/utility_payment/utility_payment.rb

@@ -51,7 +51,7 @@ module StarkBank
     # - payments [list of UtilityPayment objects]: list of UtilityPayment objects to be created in the API
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - list of UtilityPayment objects with updated attributes
@@ -67,7 +67,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - UtilityPayment object with updated attributes
@@ -84,12 +84,12 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - UtilityPayment pdf file
     def self.pdf(id, user: nil)
-      StarkBank::Utils::Rest.get_pdf(id: id, user: user, **resource)
+      StarkBank::Utils::Rest.get_content(id: id, user: user, sub_resource_name: 'pdf', **resource)
     end
 
     # # Retrieve UtilityPayments
@@ -98,26 +98,59 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - after [Date, DateTime, Time or string, default nil] date filter for objects created only after specified date. ex: Date.new(2020, 3, 10)
-    # - before [Date, DateTime, Time or string, default nil] date filter for objects created only before specified date. ex: Date.new(2020, 3, 10)
+    # - 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
+    # - user [Organization/Project object]: Organization or 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, 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(
+      StarkBank::Utils::Rest.get_stream(
+        limit: limit,
+        after: after,
+        before: before,
+        tags: tags,
+        ids: ids,
+        status: status,
         user: user,
+        **resource
+      )
+    end
+
+    # # Retrieve paged UtilityPayments
+    #
+    # Receive a list of up to 100 UtilityPayment objects previously created in the Stark Bank API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - 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']
+    # - 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 [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of UtilityPayment objects with updated attributes and cursor to retrieve the next page of UtilityPayment objects
+    def self.page(cursor: nil, 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)
+      return StarkBank::Utils::Rest.get_page(
+        cursor: cursor,
         limit: limit,
         after: after,
         before: before,
         tags: tags,
         ids: ids,
         status: status,
+        user: user,
         **resource
       )
     end
@@ -130,7 +163,7 @@ module StarkBank
     # - id [string]: UtilityPayment unique id. ex:'5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted UtilityPayment object

data/lib/utils/api.rb

@@ -57,6 +57,7 @@ module StarkBank
       def self.endpoint(resource_name)
         kebab = StarkBank::Utils::Case.camel_to_kebab(resource_name)
         kebab.sub!('-log', '/log')
+        kebab.sub!('-attempt', '/attempt')
         kebab
       end
 

data/lib/utils/request.rb

@@ -61,7 +61,7 @@ module StarkBank
         req['Access-Time'] = access_time
         req['Access-Signature'] = signature
         req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.2.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.5.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/utils/resource.rb

@@ -1,32 +1,13 @@
 # frozen_string_literal: true
+require_relative("sub_resource")
 
 module StarkBank
   module Utils
-    class Resource
+    class Resource < StarkBank::Utils::SubResource
       attr_reader :id
       def initialize(id = nil)
         @id = id
       end
-
-      def to_s
-        string_vars = []
-        instance_variables.each do |key|
-          value = instance_variable_get(key).to_s.lines.map(&:chomp).join("\n  ")
-          string_vars << "#{key[1..-1]}: #{value}"
-        end
-        fields = string_vars.join(",\n  ")
-        "#{class_name}(\n  #{fields}\n)"
-      end
-
-      def inspect
-        "#{class_name}[#{@id}]"
-      end
-
-      private
-
-      def class_name
-        self.class.name.split('::').last.downcase
-      end
     end
   end
 end

data/lib/utils/rest.rb

@@ -6,7 +6,21 @@ require_relative('api')
 module StarkBank
   module Utils
     module Rest
-      def self.get_list(resource_name:, resource_maker:, user: nil, **query)
+      def self.get_page(resource_name:, resource_maker:, user: nil, **query)
+        json = StarkBank::Utils::Request.fetch(
+          method: 'GET',
+          path: StarkBank::Utils::API.endpoint(resource_name),
+          query: query,
+          user: user
+        ).json
+        entities = []
+        json[StarkBank::Utils::API.last_name_plural(resource_name)].each do |entity_json|
+          entities << StarkBank::Utils::API.from_api_json(resource_maker, entity_json)
+        end
+        return entities, json['cursor']
+      end
+
+      def self.get_stream(resource_name:, resource_maker:, user: nil, **query)
         limit = query[:limit]
         query[:limit] = limit.nil? ? limit : [limit, 100].min
 
@@ -31,8 +45,7 @@ module StarkBank
 
             cursor = json['cursor']
             query['cursor'] = cursor
-
-            break if cursor.nil? || (!limit.nil? && limit <= 0)
+            break if cursor.nil? || cursor.empty? || (!limit.nil? && limit <= 0)
           end
         end
       end
@@ -47,19 +60,10 @@ module StarkBank
         StarkBank::Utils::API.from_api_json(resource_maker, entity)
       end
 
-      def self.get_pdf(resource_name:, resource_maker:, id:, user: nil, **query)
+      def self.get_content(resource_name:, resource_maker:, sub_resource_name:, 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
-
-      def self.get_qrcode(resource_name:, resource_maker:, id:, user: nil, **query)
-        StarkBank::Utils::Request.fetch(
-          method: 'GET',
-          path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/qrcode",
+          path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/#{sub_resource_name}",
           query: StarkBank::Utils::API.cast_json_to_api_format(query),
           user: user
         ).content
@@ -116,6 +120,17 @@ module StarkBank
         entity = json[StarkBank::Utils::API.last_name(resource_name)]
         StarkBank::Utils::API.from_api_json(resource_maker, entity)
       end
+
+      def self.get_sub_resource(resource_name:, sub_resource_maker:, sub_resource_name:, id:, user: nil, **query)
+        json = StarkBank::Utils::Request.fetch(
+          method: 'GET',
+          path: "#{StarkBank::Utils::API.endpoint(resource_name)}/#{id}/#{StarkBank::Utils::API.endpoint(sub_resource_name)}",
+          user: user,
+          query: StarkBank::Utils::API.cast_json_to_api_format(query)
+        ).json
+        entity = json[StarkBank::Utils::API.last_name(sub_resource_name)]
+        StarkBank::Utils::API.from_api_json(sub_resource_maker, entity)
+      end
     end
   end
 end

data/lib/utils/sub_resource.rb

@@ -0,0 +1,28 @@
+
+
+module StarkBank
+    module Utils
+        class SubResource    
+            def to_s
+                string_vars = []
+                instance_variables.each do |key|
+                    value = instance_variable_get(key).to_s.lines.map(&:chomp).join("\n  ")
+                    string_vars << "#{key[1..-1]}: #{value}"
+                end
+                fields = string_vars.join(",\n  ")
+                "#{class_name}(\n  #{fields}\n)"
+            end
+
+            def inspect
+                "#{class_name}[#{@id}]"
+            end
+        
+            private
+        
+            def class_name
+                self.class.name.split('::').last.downcase
+            end
+        end
+    end
+end
+  

data/lib/utils/url.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'erb'
+
 
 module StarkBank
   module Utils
@@ -17,7 +19,7 @@ module StarkBank
 
         query_list = []
         string_params.each do |key, value|
-          query_list << "#{key}=#{value}"
+          query_list << "#{key}=#{ERB::Util.url_encode(value)}"
         end
         '?' + query_list.join('&')
       end

data/lib/webhook/webhook.rb

@@ -8,12 +8,12 @@ module StarkBank
   # # Webhook subscription object
   #
   # A Webhook is used to subscribe to notification events on a user-selected endpoint.
-  # Currently available services for subscription are transfer, boleto, boleto-payment,
-  # and utility-payment
+  # Currently available services for subscription are transfer, invoice, deposit, brcode-payment,
+  # boleto, boleto-payment and utility-payment
   #
   # ## 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', 'deposit']
   #
   # ## Attributes:
   # - id [string, default nil]: unique id returned when the webhook is created. ex: '5656565656565656'
@@ -31,10 +31,10 @@ module StarkBank
     #
     # ## 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']
+    # - subscriptions [list of strings]: list of any non-empty combination of the available services. ex: ['transfer', 'invoice']
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Webhook object with updated attributes
@@ -50,7 +50,7 @@ module StarkBank
     # - id [string]: object unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - Webhook object with updated attributes
@@ -64,12 +64,33 @@ module StarkBank
     #
     # ## Parameters (optional):
     # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
-    # - user [Project object, default nil]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - generator of Webhook objects with updated attributes
     def self.query(limit: nil, user: nil)
-      StarkBank::Utils::Rest.get_list(user: user, limit: limit, **resource)
+      StarkBank::Utils::Rest.get_stream(user: user, limit: limit, **resource)
+    end
+
+    # # Retrieve paged Webhooks
+    #
+    # Receive a list of up to 100 Webhook objects previously created in the Stark Bank API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of Webhook objects with updated attributes and cursor to retrieve the next page of Webhook objects
+    def self.page(cursor: nil, limit: nil, user: nil)
+      return StarkBank::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit,
+        user: user,
+        **resource
+      )
     end
 
     # # Delete a Webhook entity
@@ -80,7 +101,7 @@ module StarkBank
     # - id [string]: Webhook unique id. ex: '5656565656565656'
     #
     # ## Parameters (optional):
-    # - user [Project object]: Project object. Not necessary if StarkBank.user was set before function call
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
     #
     # ## Return:
     # - deleted Webhook object

data/lib/workspace/workspace.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require_relative('../utils/resource')
+require_relative('../utils/rest')
+require_relative('../utils/checks')
+
+module StarkBank
+  # # Workspace object
+  #
+  # Workspaces are bank accounts. They have independent balances, statements, operations and permissions.
+  # The only property that is shared between your workspaces is that they are linked to your organization,
+  # which carries your basic informations, such as tax ID, name, etc..
+  #
+  # ## Parameters (required):
+  # - username [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+  # - name [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: 'Stark Bank Workspace'
+  #
+  # ## Parameters (optional):
+  # - allowed_tax_ids [list of strings]: list of tax IDs that will be allowed to send Deposits to this Workspace. ex: ['012.345.678-90', '20.018.183/0001-80']
+  #
+  # ## Attributes:
+  # - id [string, default nil]: unique id returned when the workspace is created. ex: '5656565656565656'
+  class Workspace < StarkBank::Utils::Resource
+    attr_reader :username, :name, :allowed_tax_ids, :id
+    def initialize(username:, name:, allowed_tax_ids: nil, id: nil)
+      super(id)
+      @username = username
+      @name = name
+      @allowed_tax_ids = allowed_tax_ids
+    end
+
+    # # Create Workspace
+    #
+    # Send a Workspace for creation in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - username [string]: Simplified name to define the workspace URL. This name must be unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+    # - name [string]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: 'Stark Bank Workspace'
+    #
+    # ## Parameters (optional):
+    # - user [Organization object]: Organization object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Workspace object with updated attributes
+    def self.create(username:, name:, user: nil, allowed_tax_ids: nil)
+      StarkBank::Utils::Rest.post_single(entity: Workspace.new(username: username, name: name, allowed_tax_ids: allowed_tax_ids), user: user, **resource)
+    end
+
+    # # Retrieve a specific Workspace
+    #
+    # Receive a single Workspace object previously created in the Stark Bank API by passing its id
+    #
+    # ## Parameters (required):
+    # - id [string]: object unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - Workspace object with updated attributes
+    def self.get(id, user: nil)
+      StarkBank::Utils::Rest.get_id(id: id, user: user, **resource)
+    end
+
+    # # Retrieve Workspaces
+    #
+    # Receive a generator of Workspace objects previously created in the Stark Bank API.
+    # If no filters are passed and the user is an Organization, all of the Organization Workspaces
+    # will be retrieved.
+    #
+    # ## Parameters (optional):
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - username [string]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - generator of Workspace objects with updated attributes
+    def self.query(limit: nil, username: nil, ids: nil, user: nil)
+      StarkBank::Utils::Rest.get_stream(limit: limit, username: username, ids: ids, user: user, **resource)
+    end
+
+    # # Retrieve paged Workspaces
+    #
+    # Receive a list of up to 100 Workspace objects previously created in the Stark Bank API and the cursor to the next page.
+    # Use this function instead of query if you want to manually page your requests.
+    #
+    # ## Parameters (optional):
+    # - cursor [string, default nil]: cursor returned on the previous page function call
+    # - limit [integer, default nil]: maximum number of objects to be retrieved. Unlimited if nil. ex: 35
+    # - username [string]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+    # - ids [list of strings, default nil]: list of ids to filter retrieved objects. ex: ['5656565656565656', '4545454545454545']
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - list of Workspace objects with updated attributes and cursor to retrieve the next page of Workspace objects
+    def self.page(cursor: nil, limit: nil, username: nil, ids: nil, user: nil)
+      return StarkBank::Utils::Rest.get_page(
+        cursor: cursor,
+        limit: limit, 
+        username: username, 
+        ids: ids, 
+        user: user, 
+        **resource
+      )
+    end
+
+    # # Update an Workspace entity
+    #
+    # Update an Workspace entity previously created in the Stark Bank API
+    #
+    # ## Parameters (required):
+    # - id [string]: Workspace unique id. ex: '5656565656565656'
+    #
+    # ## Parameters (optional):
+    # - username [string, default nil]: query by the simplified name that defines the workspace URL. This name is always unique across all Stark Bank Workspaces. Ex: 'starkbankworkspace'
+    # - name [string, default nil]: Full name that identifies the Workspace. This name will appear when people access the Workspace on our platform, for example. Ex: 'Stark Bank Workspace'
+    # - allowed_tax_ids [list of strings, default nil]: list of tax IDs that will be allowed to send Deposits to this Workspace. If empty, all are allowed. ex: ['012.345.678-90', '20.018.183/0001-80']
+    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
+    #
+    # ## Return:
+    # - updated Workspace object
+    def self.update(id, user: nil, username: nil, name: nil, allowed_tax_ids: nil)
+      StarkBank::Utils::Rest.patch_id(id: id, user: user, username: username, name: name, allowed_tax_ids: allowed_tax_ids, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Workspace',
+        resource_maker: proc { |json|
+          Workspace.new(
+            id: json['id'],
+            username: json['username'],
+            name: json['name'],
+            allowed_tax_ids: json['allowed_tax_ids']
+          )
+        }
+      }
+    end
+  end
+end