starkbank 2.1.0 → 2.4.0

data/lib/user/organization.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative('user')
+
+module StarkBank
+  # # Organization object
+  # The Organization object is an authentication entity for the SDK that
+  # represents your entire Organization, being able to access any Workspace
+  # underneath it and even create new Workspaces. Only a legal representative
+  # of your organization can register or change the Organization credentials.
+  # All requests to the Stark Bank API must be authenticated via an SDK user,
+  # which must have been previously created at the Stark Bank website
+  # [https://sandbox.web.starkbank.com] or [https://web.starkbank.com]
+  # before you can use it in this SDK. Organizations may be passed as the user parameter on
+  # each request or may be defined as the default user at the start (See README).
+  # If you are accessing a specific Workspace using Organization credentials, you should
+  # specify the workspace ID when building the Organization object or by request, using
+  # the Organization.replace(organization, workspace_id) method, which creates a copy of the organization
+  # object with the altered workspace ID. If you are listing or creating new Workspaces, the
+  # workspace_id should be nil.
+  #
+  # ## Parameters (required):
+  # - environment [string]: environment where the organization is being used. ex: 'sandbox' or 'production'
+  # - id [string]: unique id required to identify organization. ex: '5656565656565656'
+  # - private_key [string]: PEM string of the private key linked to the organization. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
+  # - workspace_id [string]: unique id of the accessed Workspace, if any. ex: nil or '4848484848484848'
+  #
+  # ## Attributes (return-only):
+  # - pem [string]: private key in pem format. ex: '-----BEGIN PUBLIC KEY-----\nMFYwEAYHKoZIzj0CAQYFK4EEAAoDQgAEyTIHK6jYuik6ktM9FIF3yCEYzpLjO5X/\ntqDioGM+R2RyW0QEo+1DG8BrUf4UXHSvCjtQ0yLppygz23z0yPZYfw==\n-----END PUBLIC KEY-----'
+  class Organization < StarkBank::User
+    attr_reader :workspace_id
+    def initialize(id:, environment:, private_key:, workspace_id: nil)
+      super(environment, id, private_key)
+      @workspace_id = workspace_id
+    end
+
+    def access_id
+      if @workspace_id
+        "organization/#{@id}/workspace/#{@workspace_id}"
+      else
+        "organization/#{@id}"
+      end
+    end
+
+    def self.replace(organization, workspace_id)
+      Organization.new(
+        environment: organization.environment,
+        id: organization.id,
+        private_key: organization.pem,
+        workspace_id: workspace_id
+      )
+    end
+  end
+end

data/lib/user/project.rb

@@ -5,20 +5,21 @@ require_relative('user')
 module StarkBank
   # # Project object
   #
-  # The Project object is the main authentication entity for the SDK.
-  # All requests to the Stark Bank API must be authenticated via a project,
+  # The Project object is an authentication entity for the SDK that is permanently
+  # linked to a specific Workspace.
+  # All requests to the Stark Bank API must be authenticated via an SDK user,
   # which must have been previously created at the Stark Bank website
   # [https://sandbox.web.starkbank.com] or [https://web.starkbank.com]
-  # before you can use it in this SDK. Projects may be passed as a parameter on
+  # before you can use it in this SDK. Projects may be passed as the user parameter on
   # 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-----'
+  # - private_key [string]: 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'
+  # - 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
@@ -28,5 +29,9 @@ module StarkBank
       @name = name
       @allowed_ips = allowed_ips
     end
+
+    def access_id
+      "project/#{@id}"
+    end
   end
 end

data/lib/user/user.rb

@@ -13,10 +13,6 @@ module StarkBank
       @environment = StarkBank::Utils::Checks.check_environment(environment)
     end
 
-    def access_id
-      "#{self.class.name.split('::').last.downcase}/#{@id}"
-    end
-
     def private_key
       EllipticCurve::PrivateKey.fromPem(@pem)
     end

data/lib/utility_payment/log.rb

@@ -37,7 +37,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:
       # - Log object with updated attributes
@@ -55,7 +55,7 @@ module StarkBank
       # - 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
+      # - user [Organization/Project object]: Organization or Project object. Not necessary if Starkbank.user was set before function call
       #
       # ## Return:
       # - list of Log objects with updated attributes

data/lib/utility_payment/utility_payment.rb

@@ -36,7 +36,7 @@ module StarkBank
       @line = line
       @bar_code = bar_code
       @tags = tags
-      @scheduled = StarkBank::Utils::Checks.check_datetime(scheduled)
+      @scheduled = StarkBank::Utils::Checks.check_date(scheduled)
       @amount = amount
       @fee = fee
       @status = status
@@ -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,7 +84,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 pdf file
@@ -103,7 +103,7 @@ module StarkBank
     # - 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
@@ -130,7 +130,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

@@ -28,21 +28,22 @@ module StarkBank
         hash.each do |key, value|
           next if value.nil?
 
-          value = value.is_a?(Date) || value.is_a?(DateTime) || value.is_a?(Time) ? value.strftime('%Y-%m-%d') : value
+          entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = parse_value(value)
+        end
+        entity_hash
+      end
 
-          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
-          elsif value.is_a?(Hash)
-            value = cast_json_to_api_format(value)
-          end
+      def self.parse_value(value)
+        return value.strftime('%Y-%m-%d') if value.is_a?(Date)
+        return value.strftime('%Y-%m-%dT%H:%M:%S+00:00') if value.is_a?(DateTime) || value.is_a?(Time)
+        return cast_json_to_api_format(value) if value.is_a?(Hash)
+        return value unless value.is_a?(Array)
 
-          entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = value
+        list = []
+        value.each do |v|
+          list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
         end
-        entity_hash
+        list
       end
 
       def self.from_api_json(resource_maker, json)
@@ -63,6 +64,7 @@ module StarkBank
         base = last_name(resource_name)
 
         return base if base[-1].eql?('s')
+        return "#{base}s" if base[-2..-1].eql?('ey')
         return "#{base[0...-1]}ies" if base[-1].eql?('y')
 
         "#{base}s"

data/lib/utils/checks.rb

@@ -39,6 +39,17 @@ module StarkBank
         raise(ArgumentError, 'Private-key must be a valid secp256k1 ECDSA string in pem format')
       end
 
+      def self.check_date_or_datetime(data)
+        return if data.nil?
+
+        return data if data.is_a?(Time) || data.is_a?(DateTime)
+
+        return data if data.is_a?(Date)
+
+        data, type = check_datetime_string(data)
+        type == 'date' ? Date.new(data.year, data.month, data.day) : data
+      end
+
       def self.check_datetime(data)
         return if data.nil?
 
@@ -46,7 +57,8 @@ module StarkBank
 
         return Time.new(data.year, data.month, data.day) if data.is_a?(Date)
 
-        check_datetime_string(data)
+        data, _type = check_datetime_string(data)
+        data
       end
 
       def self.check_date(data)
@@ -56,9 +68,9 @@ module StarkBank
 
         return data if data.is_a?(Date)
 
-        data = check_datetime_string(data)
+        data, type = check_datetime_string(data)
 
-        Date.new(data.year, data.month, data.day)
+        type == 'date' ? Date.new(data.year, data.month, data.day) : data
       end
 
       class << self
@@ -68,17 +80,17 @@ module StarkBank
           data = data.to_s
 
           begin
-            return DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S.%L+00:00')
+            return [DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S.%L+00:00'), 'datetime']
           rescue ArgumentError
           end
 
           begin
-            return DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S+00:00')
+            return [DateTime.strptime(data, '%Y-%m-%dT%H:%M:%S+00:00'), 'datetime']
           rescue ArgumentError
           end
 
           begin
-            return DateTime.strptime(data, '%Y-%m-%d')
+            return [DateTime.strptime(data, '%Y-%m-%d'), 'date']
           rescue ArgumentError
             raise(ArgumentError, 'invalid datetime string ' + data)
           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.1.0"
+        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.4.0"
         req['Accept-Language'] = language
 
         request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }

data/lib/utils/rest.rb

@@ -31,8 +31,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
@@ -56,6 +55,15 @@ module StarkBank
         ).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",
+          query: StarkBank::Utils::API.cast_json_to_api_format(query),
+          user: user
+        ).content
+      end
+
       def self.post(resource_name:, resource_maker:, entities:, user: nil)
         jsons = []
         entities.each do |entity|

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,7 +64,7 @@ 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
@@ -80,7 +80,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,92 @@
+# 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'
+  #
+  # ## Attributes:
+  # - id [string, default nil]: unique id returned when the workspace is created. ex: '5656565656565656'
+  class Workspace < StarkBank::Utils::Resource
+    attr_reader :username, :name, :id
+    def initialize(username:, name:, id: nil)
+      super(id)
+      @username = username
+      @name = name
+    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)
+      StarkBank::Utils::Rest.post_single(entity: Workspace.new(username: username, name: name), 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_list(limit: limit, username: username, ids: ids, user: user, **resource)
+    end
+
+    def self.resource
+      {
+        resource_name: 'Workspace',
+        resource_maker: proc { |json|
+          Workspace.new(
+            id: json['id'],
+            username: json['username'],
+            name: json['name']
+          )
+        }
+      }
+    end
+  end
+end