bb_statements 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed022da729839b6b43e2486553f96b2d10acb08d873975029159178dfa94f93a
+  data.tar.gz: 437e58b8207f4cea3f603701ea8797663ece81ade47ebfc6444a27ac8fc35905
+SHA512:
+  metadata.gz: '09a82c547e369ebf629f27aa7103e39ffae290d4d180b041838cf35873bc7528307e0f8b2eb550b194b9cc5c4b2bcff922b0f22e05f57970ad3ba4f53685ac16'
+  data.tar.gz: 5f156c2a57d13c85853d6a9505770f12cbfe32ed395e9dd96b69b1ad5c61522f9de95a1377691841e6bb2cb824a5e62e6f30e7474889da69a9e06587d03d60ea

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.2.2
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-29
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at luanbritop7@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ruby-banco-brasil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 luanbrito7
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# bb_statements
+
+BancoBrasilStatements - The Ruby gem for the the Banco do Brasil Statements API
+
+- API version: 1.0
+- Package version: 1.0.0
+For more information, please visit [https://developers.bb.com.br](https://developers.bb.com.br)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build bb_statements.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./bb_statements-1.0.0.gem
+```
+(for development, run `gem install --dev ./bb_statements-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'bb_statements', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'bb_statements', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'bb_statements'
+# Setup authorization
+BancoBrasilStatements.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2-CC
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BancoBrasilStatements::StatementsApi.new
+id = 'id_example' # String | Código identificador do pagamento.
+gw_dev_app_key = 'gw_dev_app_key_example' # String | Chave de acesso do aplicativo do desenvolvedor. Esta chave é única e obtida no Portal “BB for Developers” e usada para identificar as requisições da aplicação do desenvolvedor.  Example: 0021239456d80136bebf005056891bed
+authorization = 'authorization_example' # String | É um “token” de acesso fornecido pelo OAuth 2.0.  Example: Bearer [ACCESS_TOKEN]
+opts = {
+  start_date: Date.yesterday,
+  end_date: Date.current,
+  page_size: 50,
+  page_index: 1
+}
+
+begin
+  # branch_office, account, opts
+  result = api_instance.consult_statements(1505, 1348, opts)
+  p result
+rescue BancoBrasilStatements::ApiError => e
+  puts "Exception when calling StatementsApi->consult_statements: #{e}"
+end
+# Setup authorization
+BancoBrasilStatements.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2-CC
+  config.access_token = 'YOUR ACCESS TOKEN'
+end

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bb_statements.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+$:.push File.expand_path("../lib", __FILE__)
+require "bb_statements/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bb_statements"
+  spec.version = BancoBrasilStatements::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ["Luan", "Hent"]
+  spec.email = ["luanbritop7@gmail.com", "tech@hent.com.br"]
+
+  spec.summary = "A ruby wrapper for Banco do Brasil Statements"
+  spec.description = "This gem maps to the BB Statements API"
+  spec.homepage = "https://github.com/ruby-banco-brasil/bb-statement"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/ruby-banco-brasil/bb-statement"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'faraday', '~> 2.9.0'
+  spec.add_runtime_dependency 'json', '~> 2.6', '>= 2.1.0'
+  spec.add_runtime_dependency 'bb_oauth', '~> 1.0.3'
+  spec.add_runtime_dependency 'rails', '~> 7.1.2'
+
+  spec.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  spec.add_development_dependency 'byebug', '~> 11.1.3'
+  spec.add_development_dependency 'webmock', '~> 3.22.0'
+  spec.add_development_dependency 'activesupport', '~> 7.1', '>= 7.1.3.2'
+end

data/lib/bb_statements/api/statements_api.rb

@@ -0,0 +1,59 @@
+module BancoBrasilStatements
+  class StatementsApi
+    attr_accessor :api_client, :gw_app_key
+
+    PAGE_SIZE = 50
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+      @gw_app_key = api_client.config.gw_app_key
+    end
+
+    # GET /conta-corrente/agencia/{agencia}/conta/{conta}
+    # Consulta os extratos de uma conta.
+    def consult_statements(branch_office, account, opts = {})
+      client_opts = build_client_opts(api_client: api_client,
+                                      gw_app_key: gw_app_key,
+                                      opts: opts) 
+
+      # query parameters
+      query_params = client_opts[:query_params]
+      query_params[@api_client.config.app_key_name.to_sym] = gw_app_key
+      query_params[:dataInicioSolicitacao] = opts[:start_date].strftime('%d%m%Y').to_i unless opts[:start_date].nil?
+      query_params[:dataFimSolicitacao] = opts[:end_date].strftime('%d%m%Y').to_i unless opts[:end_date].nil?
+      query_params[:quantidadeRegistroPaginaSolicitacao] = unless opts[:page_size].nil?
+        opts[:page_size]
+      else
+        PAGE_SIZE
+      end
+
+      query_params[:numeroPaginaSolicitacao] = opts[:page_index] unless opts[:page_index].nil?
+
+      unless Rails.env.production?
+        branch_office = 452
+        account = 123873
+      end
+
+      api_client.call_api(:GET, "/conta-corrente/agencia/#{branch_office}/conta/#{account}", client_opts)
+    end
+  
+    private
+  
+    def build_client_opts(api_client:, gw_app_key:, opts:, return_type: 'Object', body: nil)
+      client_opts = {
+        base_path: '/extratos/v1',
+        body: opts[:body] || body,
+        form_params: opts[:form_params] || {},
+        return_type: opts[:return_type] || return_type,
+        auth_names: opts[:auth_names] || ['OAuth2-CC'],
+        query_params: opts[:query_params] || {},
+        header_params: opts[:header_params] || {}
+      }
+
+      # query parameters
+      client_opts[:query_params][api_client.config.app_key_name.to_sym] = gw_app_key
+
+      client_opts
+    end
+  end
+end

data/lib/bb_statements/api_client.rb

@@ -0,0 +1,107 @@
+require 'date'
+require 'json'
+require 'logger'
+require 'tempfile'
+require 'faraday'
+require 'uri'
+
+module BancoBrasilStatements
+  class ApiClient
+    TOKEN_EXPIRE_TIME = 570
+
+    attr_accessor :config, :default_headers, :access_token_requested_at
+
+    # Initializes the ApiClient
+    # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
+    def initialize(config = Configuration.default)
+      @config = config
+      @user_agent = "bb-statements-gem/#{VERSION}/ruby"
+      @default_headers = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => @user_agent
+      }
+      @access_token_requested_at = nil
+    end
+
+    def self.default
+      @@default ||= ApiClient.new
+    end
+
+    def call_api(http_method, path, opts = {})
+      request = build_request(path, opts)
+      response = request.send(http_method.downcase.to_sym)
+
+      if @config.debugging
+        @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
+      end
+
+      response.body
+    rescue Faraday::Error => e
+      fail BancoBrasilStatements::ApiError.new(e.message)
+    end
+
+    def build_request(path, opts = {})
+      base_path = opts[:base_path]
+      url = build_request_url(path, base_path)
+
+      header_params = @default_headers.merge(opts[:header_params] || {})
+      header_params['Accept-Encoding'] = 'gzip'
+      header_params['x-br-com-bb-ipa-mciteste'.to_sym] = '704950857' unless Rails.env.production?
+      query_params = opts[:query_params] || {}
+      form_params = opts[:form_params] || {}
+
+      update_params_for_auth! header_params
+
+      Faraday.new(url: url) do |faraday|
+        faraday.request :url_encoded
+        faraday.request :json
+        faraday.adapter Faraday.default_adapter
+
+        if @config.verify_ssl
+          faraday.ssl.verify = true
+          faraday.ssl.verify_mode = @config.verify_ssl_host ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+          faraday.ssl.client_cert = @config.cert_file if @config.cert_file
+          faraday.ssl.client_key = @config.key_file if @config.key_file
+          faraday.ssl.key_password = @config.ssl_key_passwd if @config.ssl_key_passwd
+          faraday.ssl.ca_file = @config.ssl_ca_cert if @config.ssl_ca_cert
+        else
+          faraday.ssl.verify = false
+        end
+
+        faraday.response :logger if @config.debugging
+        faraday.response :raise_error
+        faraday.response :json
+        faraday.headers = header_params
+        faraday.params = query_params
+        faraday.options.timeout = @config.timeout if @config.timeout
+      end
+    end
+
+    def build_request_url(path, base_path = nil)
+      # Add leading and trailing slashes to path
+      path = "/#{path}".gsub(/\/+/, '/')
+      @config.base_url(base_path || @config.base_path) + path
+    end
+
+    def update_params_for_auth!(header_params)
+      renew_token unless valid_token?
+
+      header_params['Authorization'] = "Bearer #{@config.access_token}"
+    end
+
+    def valid_token?
+      access_token_requested_at &&
+        (Time.zone.now - access_token_requested_at) < TOKEN_EXPIRE_TIME
+    end
+
+    def renew_token
+      api_instance = BancoBrasilClientCredentials::DefaultApi.new @config.client_credentials_api
+      result = api_instance.oauth_token_post('client_credentials',
+                                             @config.access_token_scopes, @config.basic_auth_token,
+                                             'application/x-www-form-urlencoded')
+      self.access_token_requested_at = Time.zone.now
+      @config.access_token = result.access_token
+      result.access_token
+    end
+  end
+end

data/lib/bb_statements/api_error.rb

@@ -0,0 +1,16 @@
+module BancoBrasilStatements
+  class ApiError < StandardError
+    def initialize(message)
+      super message
+    end
+
+    # Override to_s to display a friendly error message
+    def to_s
+      message
+    end
+
+    def message
+      @message || "Error message: the server returns an error"
+    end
+  end
+end

data/lib/bb_statements/configuration.rb

@@ -0,0 +1,219 @@
+module BancoBrasilStatements
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url for oauth
+    attr_accessor :oauth_host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Chave de acesso do aplicativo do desenvolvedor.
+    # Esta chave é única e obtida no Portal “BB for Developers”
+    # Usada para identificar as requisições da aplicação do desenvolvedor.
+    attr_accessor :gw_app_key
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    ### TLS/SSL setting
+    # Client private key passphrase (for client certificate)
+    attr_accessor :ssl_key_passwd
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    attr_accessor :access_token_scopes
+
+    attr_accessor :app_key_name
+
+    def initialize
+      @scheme = 'https'
+      @app_key_name = 'gw-app-key'
+      @host = 'api-extratos.bb.com.br'
+      @oauth_host = 'oauth.bb.com.br'
+      @base_path = 'extratos/v1'
+      @api_key = {}
+      @api_key_prefix = {}
+      @timeout = nil
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @params_encoding = nil
+      @cert_file = nil
+      @key_file = nil
+      @debugging = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Jets) ? Jets.logger : Logger.new(STDOUT)
+      @access_token_scopes = 'extrato-info'
+
+      yield(self) if block_given?
+    end
+
+    def client_credentials_api
+      @client_credentials_api ||= BancoBrasilClientCredentials::ApiClient.new oauth_config
+    end
+
+    def oauth_config
+      oauth_config = BancoBrasilClientCredentials::Configuration.new
+      oauth_config.host = oauth_host
+      oauth_config.base_path = ''
+      oauth_config.logger = logger
+      oauth_config.debugging = debugging
+      oauth_config.verify_ssl = verify_ssl
+      oauth_config.verify_ssl_host = verify_ssl_host
+      oauth_config.access_token = access_token
+      oauth_config.username = username
+      oauth_config.password = password
+      oauth_config.ssl_ca_cert = ssl_ca_cert
+      oauth_config
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    def base_url(base_path)
+      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name)
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+      else
+        @api_key[param_name]
+      end
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + Base64.encode64("#{username}:#{password}").delete("\r\n")
+    end
+  end
+end

data/lib/bb_statements/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BancoBrasilStatements
+  VERSION = "0.1.0"
+end

data/lib/bb_statements.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bb_oauth'
+require "bb_statements/version"
+require 'bb_statements/api_error'
+require 'bb_statements/api_client'
+require 'bb_statements/configuration'
+require 'bb_statements/api/statements_api'
+
+module BancoBrasilStatements
+  class << self
+    # Customize default settings for the SDK using block.
+    #   BancoBrasilStatements.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: bb_statements
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Luan
+- Hent
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: bb_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.1.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.22.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.2
+description: This gem maps to the BB Statements API
+email:
+- luanbritop7@gmail.com
+- tech@hent.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bb_statements.gemspec
+- lib/bb_statements.rb
+- lib/bb_statements/api/statements_api.rb
+- lib/bb_statements/api_client.rb
+- lib/bb_statements/api_error.rb
+- lib/bb_statements/configuration.rb
+- lib/bb_statements/version.rb
+homepage: https://github.com/ruby-banco-brasil/bb-statement
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ruby-banco-brasil/bb-statement
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for Banco do Brasil Statements
+test_files: []