starkbank 2.6.0 → 2.8.0

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: starkbank
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - starkbank
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-04 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: starkbank-ecdsa
+  name: starkcore
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.81'
-description:
-email:
+description: 
+email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -81,12 +81,13 @@ files:
 - lib/boleto_payment/log.rb
 - lib/brcode_payment/brcode_payment.rb
 - lib/brcode_payment/log.rb
-- lib/brcode_preview/brcode_preview.rb
+- lib/brcode_payment/rule.rb
 - lib/darf_payment/darf_payment.rb
 - lib/darf_payment/log.rb
 - lib/deposit/deposit.rb
 - lib/deposit/log.rb
 - lib/dict_key/dict_key.rb
+- lib/dynamic_brcode/dynamic_brcode.rb
 - lib/error.rb
 - lib/event/attempt.rb
 - lib/event/event.rb
@@ -94,7 +95,6 @@ files:
 - lib/invoice/invoice.rb
 - lib/invoice/log.rb
 - lib/invoice/payment.rb
-- lib/key.rb
 - lib/payment_preview/boleto_preview.rb
 - lib/payment_preview/brcode_preview.rb
 - lib/payment_preview/payment_preview.rb
@@ -106,29 +106,19 @@ files:
 - lib/tax_payment/tax_payment.rb
 - lib/transaction/transaction.rb
 - lib/transfer/log.rb
+- lib/transfer/rule.rb
 - lib/transfer/transfer.rb
-- lib/user/organization.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
-- lib/utils/checks.rb
-- lib/utils/environment.rb
-- lib/utils/request.rb
-- lib/utils/resource.rb
+- lib/utils/parse.rb
 - lib/utils/rest.rb
-- lib/utils/sub_resource.rb
-- lib/utils/url.rb
 - lib/webhook/webhook.rb
 - lib/workspace/workspace.rb
 homepage: https://github.com/starkbank/sdk-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -143,8 +133,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.0.3.1
+signing_key: 
 specification_version: 4
 summary: SDK to facilitate Ruby integrations with Stark Bank
 test_files: []

data/lib/brcode_preview/brcode_preview.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require_relative('../utils/resource')
-require_relative('../utils/rest')
-require_relative('../utils/checks')
-
-module StarkBank
-  # # BrcodePreview object
-  #
-  # A BrcodePreview is used to get information from a BR Code you received to check the informations before paying it.
-  #
-  # ## Attributes (return-only):
-  # - status [string]: Payment status. ex: 'active', 'paid', 'canceled' or 'unknown'
-  # - name [string]: Payment receiver name. ex: 'Tony Stark'
-  # - tax_id [string]: Payment receiver tax ID. ex: '012.345.678-90'
-  # - bank_code [string]: Payment receiver bank code. ex: '20018183'
-  # - branch_code [string]: Payment receiver branch code. ex: '0001'
-  # - account_number [string]: Payment receiver account number. ex: '1234567'
-  # - account_type [string]: Payment receiver account type. ex: 'checking'
-  # - allow_change [bool]: If True, the payment is able to receive amounts that are diferent from the nominal one. ex: True or False
-  # - amount [integer]: Value in cents that this payment is expecting to receive. If 0, any value is accepted. ex: 123 (= R$1,23)
-  # - reconciliation_id [string]: Reconciliation ID linked to this payment. ex: 'txId', 'payment-123'
-  class BrcodePreview < StarkBank::Utils::Resource
-    attr_reader :status, :name, :tax_id, :bank_code, :branch_code, :account_number, :account_type, :allow_change, :amount, :reconciliation_id
-    def initialize(status:, name:, tax_id:, bank_code:, branch_code:, account_number:, account_type:, allow_change:, amount:, reconciliation_id:)
-      @status = status
-      @name = name
-      @tax_id = tax_id
-      @bank_code = bank_code
-      @branch_code = branch_code
-      @account_number = account_number
-      @account_type = account_type
-      @allow_change = allow_change
-      @amount = amount
-      @reconciliation_id = reconciliation_id
-    end
-
-    # # BrcodePreview is DEPRECATED: Please use PaymentPreview instead.
-    # Retrieve BrcodePreviews
-    #
-    # Receive a generator of BrcodePreview objects previously created in the Stark Bank API
-    #
-    # ## Parameters (optional):
-    # - brcodes [list of strings]: List of brcodes to preview. ex: %w[00020126580014br.gov.bcb.pix0136a629532e-7693-4846-852d-1bbff817b5a8520400005303986540510.005802BR5908T'Challa6009Sao Paulo62090505123456304B14A]
-    # - user [Organization/Project object]: Organization or Project object. Not necessary if StarkBank.user was set before function call
-    #
-    # ## Return:
-    # - generator of BrcodePreview objects with updated attributes
-    def self.query(limit: nil, brcodes: nil, user: nil)
-      warn "[DEPRECATION] `BrcodePreview` is deprecated.  Please use `PaymentPreview` instead."
-      StarkBank::Utils::Rest.get_stream(
-        user: user,
-        limit: nil,
-        brcodes: brcodes,
-        **resource
-      )
-    end
-
-    def self.resource
-      {
-        resource_name: 'BrcodePreview',
-        resource_maker: proc { |json|
-          BrcodePreview.new(
-            status: json['status'],
-            name: json['name'],
-            tax_id: json['tax_id'],
-            bank_code: json['bank_code'],
-            branch_code: json['branch_code'],
-            account_number: json['account_number'],
-            account_type: json['account_type'],
-            allow_change: json['allow_change'],
-            amount: json['amount'],
-            reconciliation_id: json['reconciliation_id']
-          )
-        }
-      }
-    end
-  end
-end

data/lib/key.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require('fileutils')
-require('starkbank-ecdsa')
-
-module StarkBank
-  module Key
-    # # Generate a new key pair
-    # Generates a secp256k1 ECDSA private/public key pair to be used in the API
-    # authentications
-    #
-    # ## Parameters (optional):
-    # - path [string]: path to save the keys .pem files. No files will be saved if this parameter isn't provided
-    #
-    # ## Return:
-    # - private and public key pems
-    def self.create(path = nil)
-      private_key = EllipticCurve::PrivateKey.new
-      public_key = private_key.publicKey
-
-      private_key_pem = private_key.toPem
-      public_key_pem = public_key.toPem
-
-      unless path.nil?
-        FileUtils.mkdir_p(path)
-        File.write(File.join(path, 'private.pem'), private_key_pem)
-        File.write(File.join(path, 'public.pem'), public_key_pem)
-      end
-
-      [private_key_pem, public_key_pem]
-    end
-  end
-end

data/lib/user/organization.rb

@@ -1,54 +0,0 @@
-# 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://web.sandbox.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

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative('user')
-
-module StarkBank
-  # # Project object
-  #
-  # 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://web.sandbox.starkbank.com] or [https://web.starkbank.com]
-  # 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 [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'
-  # - 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)
-      super(environment, id, private_key)
-      @name = name
-      @allowed_ips = allowed_ips
-    end
-
-    def access_id
-      "project/#{@id}"
-    end
-  end
-end

data/lib/user/user.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require('starkbank-ecdsa')
-require_relative('../utils/resource')
-
-module StarkBank
-  class User < StarkBank::Utils::Resource
-    attr_reader :pem, :environment
-    def initialize(environment, id, private_key)
-      require_relative('../utils/checks')
-      super(id)
-      @pem = StarkBank::Utils::Checks.check_private_key(private_key)
-      @environment = StarkBank::Utils::Checks.check_environment(environment)
-    end
-
-    def private_key
-      EllipticCurve::PrivateKey.fromPem(@pem)
-    end
-  end
-end

data/lib/utils/api.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require_relative('case')
-
-module StarkBank
-  module Utils
-    module API
-      def self.build_entity_hash(entity)
-        if entity.is_a?(Hash)
-          entity_hash = entity
-        else
-          entity_hash = {}
-          entity.instance_variables.each do |key|
-            variable = entity.instance_variable_get(key)
-            entity_hash[key[1..-1]] = variable.is_a?(StarkBank::Utils::Resource) ? build_entity_hash(variable) : entity.instance_variable_get(key)
-          end
-        end
-        entity_hash
-      end
-
-      def self.api_json(entity)
-        built_hash = build_entity_hash(entity)
-        cast_json_to_api_format(built_hash)
-      end
-
-      def self.cast_json_to_api_format(hash)
-        entity_hash = {}
-        hash.each do |key, value|
-          next if value.nil?
-
-          entity_hash[StarkBank::Utils::Case.snake_to_camel(key)] = parse_value(value)
-        end
-        entity_hash
-      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)
-
-        list = []
-        value.each do |v|
-          list << (v.is_a?(Hash) ? cast_json_to_api_format(v) : v)
-        end
-        list
-      end
-
-      def self.from_api_json(resource_maker, json)
-        snakes = {}
-        json.each do |key, value|
-          snakes[StarkBank::Utils::Case.camel_to_snake(key)] = value
-        end
-        resource_maker.call(snakes)
-      end
-
-      def self.endpoint(resource_name)
-        kebab = StarkBank::Utils::Case.camel_to_kebab(resource_name)
-        kebab.sub!('-log', '/log')
-        kebab.sub!('-attempt', '/attempt')
-        kebab
-      end
-
-      def self.last_name_plural(resource_name)
-        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"
-      end
-
-      def self.last_name(resource_name)
-        StarkBank::Utils::Case.camel_to_kebab(resource_name).split('-').last
-      end
-    end
-  end
-end

data/lib/utils/cache.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module StarkBank
-  module Utils
-    module Cache
-      @starkbank_public_key = nil
-      class << self; attr_accessor :starkbank_public_key; end
-    end
-  end
-end

data/lib/utils/case.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module StarkBank
-  module Utils
-    module Case
-      def self.camel_to_snake(camel)
-        camel.to_s.gsub(/([a-z])([A-Z\d])/, '\1_\2').downcase
-      end
-
-      def self.snake_to_camel(snake)
-        camel = snake.to_s.split('_').map(&:capitalize).join
-        camel[0] = camel[0].downcase
-        camel
-      end
-
-      def self.camel_to_kebab(camel)
-        camel_to_snake(camel).tr('_', '-')
-      end
-    end
-  end
-end

data/lib/utils/checks.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require('date')
-require('starkbank-ecdsa')
-require_relative('environment')
-require_relative('../user/user')
-
-module StarkBank
-  module Utils
-    class Checks
-      def self.check_user(user)
-        return user if user.is_a?(StarkBank::User)
-
-        user = user.nil? ? StarkBank.user : user
-        raise(ArgumentError, 'A user is required to access our API. Check our README: https://github.com/starkbank/sdk-ruby/') if user.nil?
-
-        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)
-
-        environment
-      end
-
-      def self.check_private_key(pem)
-        EllipticCurve::PrivateKey.fromPem(pem)
-        pem
-      rescue
-        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?
-
-        return data if data.is_a?(Time) || data.is_a?(DateTime)
-
-        return Time.new(data.year, data.month, data.day) if data.is_a?(Date)
-
-        data, _type = check_datetime_string(data)
-        data
-      end
-
-      def self.check_date(data)
-        return if data.nil?
-
-        return Date.new(data.year, data.month, data.day) 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
-
-      class << self
-        private
-
-        def check_datetime_string(data)
-          data = data.to_s
-
-          begin
-            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'), 'datetime']
-          rescue ArgumentError
-          end
-
-          begin
-            return [DateTime.strptime(data, '%Y-%m-%d'), 'date']
-          rescue ArgumentError
-            raise(ArgumentError, 'invalid datetime string ' + data)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/utils/environment.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module StarkBank
-  module Utils
-    class Environment
-      PRODUCTION = 'production'
-      public_constant :PRODUCTION
-
-      SANDBOX = 'sandbox'
-      public_constant :SANDBOX
-    end
-  end
-end

data/lib/utils/request.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require('json')
-require('starkbank-ecdsa')
-require('net/http')
-require_relative('url')
-require_relative('checks')
-require_relative('../error')
-
-module StarkBank
-  module Utils
-    module Request
-      class Response
-        attr_reader :status, :content
-        def initialize(status, content)
-          @status = status
-          @content = content
-        end
-
-        def json
-          JSON.parse(@content)
-        end
-      end
-
-      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/',
-          Environment::SANDBOX => 'https://sandbox.api.starkbank.com/'
-        }[user.environment] + 'v2'
-
-        url = "#{base_url}/#{path}#{StarkBank::Utils::URL.urlencode(query)}"
-        uri = URI(url)
-
-        access_time = Time.now.to_i
-        body = payload.nil? ? '' : payload.to_json
-        message = "#{user.access_id}:#{access_time}:#{body}"
-        signature = EllipticCurve::Ecdsa.sign(message, user.private_key).toBase64
-
-        case method
-        when 'GET'
-          req = Net::HTTP::Get.new(uri)
-        when 'DELETE'
-          req = Net::HTTP::Delete.new(uri)
-        when 'POST'
-          req = Net::HTTP::Post.new(uri)
-          req.body = body
-        when 'PATCH'
-          req = Net::HTTP::Patch.new(uri)
-          req.body = body
-        when 'PUT'
-          req = Net::HTTP::Put.new(uri)
-          req.body = body
-        else
-          raise(ArgumentError, 'unknown HTTP method ' + method)
-        end
-
-        req['Access-Id'] = user.access_id
-        req['Access-Time'] = access_time
-        req['Access-Signature'] = signature
-        req['Content-Type'] = 'application/json'
-        req['User-Agent'] = "Ruby-#{RUBY_VERSION}-SDK-2.6.0"
-        req['Accept-Language'] = language
-
-        request = Net::HTTP.start(uri.hostname, use_ssl: true) { |http| http.request(req) }
-
-        response = Response.new(Integer(request.code, 10), request.body)
-
-        raise(StarkBank::Error::InternalServerError) if response.status == 500
-        raise(StarkBank::Error::InputErrors, response.json['errors']) if response.status == 400
-        raise(StarkBank::Error::UnknownError, response.content) unless response.status == 200
-
-        response
-      end
-    end
-  end
-end

data/lib/utils/resource.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-require_relative("sub_resource")
-
-module StarkBank
-  module Utils
-    class Resource < StarkBank::Utils::SubResource
-      attr_reader :id
-      def initialize(id = nil)
-        @id = id
-      end
-    end
-  end
-end