nubank_sdk 0.4.1 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee3ffd6c280bb2b48dba0c1b46d4c3a560f985a55b22793aa251ece82f69da28
-  data.tar.gz: a4a69ad6502fd3852fb91b21fc37ee2fe872f9432a575d8d72367125201d8ecd
+  metadata.gz: 88e935ce5affb735e7676f0dd93a213658308ce205f837028172bac24d0ceb0e
+  data.tar.gz: dc9bd5c2cc72d965a2cfa0bb20e81eb3e43e6f4077806cfcab04532c1db00181
 SHA512:
-  metadata.gz: 232922b481796a104a241ee8a9c890082c93c4e23eb3de6635f06633539c0d87770cb0e85b86e1a72d94548004080a5277010cb529ab623299ac40364fa07ac9
-  data.tar.gz: 1e82254c8026f4f5cb4e9bd3d80971d31979aced7145fe15e44e9e7a7a9a4c0f6303e232f3468860b07b5ab5cf358b624f1da4f0e03669765494a4f07fd21cd2
+  metadata.gz: 7a3217000244778e41aa31f56df110888cedae14efcdcd39b88a7e6fc430bb53bac67eee8a9570a0a67de8035a9d7e2f892bc9413c65e3198772ebe92b4039b9
+  data.tar.gz: bf2509cbf0b73934c5e490fb146e499c286b658ab4050417ac47f9b17b7dc851829c31bbf9a58c265c00a9ff27714d0d3ba8ddf063186b17562e11c618d6da09

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.rubocop.yml

@@ -0,0 +1,5 @@
+require:
+  - rubocop-rspec
+
+Style/BracesAroundHashParameters:
+  Enabled: false

data/.vscode/settings.json

@@ -1,5 +1,6 @@
 {
   "cSpell.words": [
+    "dracarys",
     "faraday",
     "nubank",
     "Nubank",
@@ -11,6 +12,7 @@
     "auth",
     "client",
     "version",
-    "account"
+    "account",
+    "github"
   ]
 }

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in nubank_sdk.gemspec
 gemspec

data/Gemfile.lock

@@ -1,18 +1,36 @@
 PATH
   remote: .
   specs:
-    nubank_sdk (0.4.1)
+    nubank_sdk (0.5.1)
       faraday (~> 0.15.0)
-      json (~> 2.1.0)
+      json (~> 2.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (5.2.8.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    factory_bot (4.8.2)
+      activesupport (>= 3.0.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    json (2.1.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.1)
+    minitest (5.15.0)
     multipart-post (2.2.3)
+    parallel (1.19.2)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    powerpack (0.1.3)
+    rainbow (3.1.1)
     rake (10.5.0)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -27,15 +45,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.1)
+    rubocop (0.57.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.27.0)
+      rubocop (>= 0.56.0)
+    ruby-progressbar (1.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.10)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.17)
+  factory_bot (~> 4.8.2)
   nubank_sdk!
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.57.2)
+  rubocop-rspec (~> 1.27.0)
+  yard (~> 0.9.12)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -1,3 +1,5 @@
+![Gem](https://img.shields.io/gem/dt/nubank_sdk?color=%23701516&logo=ruby&logoColor=%23701516&style=for-the-badge)
+
 # NubankSdk (Work in progress)
 
 A gem to make it ease to monitorize your Nubank account.
@@ -22,7 +24,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'nubank_sdk'
+
+# instance a nubank account object
+user = NubankSdk::User.new(cpf: '12345678909')
+password = 'dracarys'
+```
+
+> First time?
+>
+> authenticate the account
+>
+> ```ruby
+> # request an email code
+> account_email = user.auth.request_email_code(password)
+> 
+> # get the email code from the user
+> puts "Enter the code sent to #{account_email}: "
+> email_code = gets.chomp
+> user.auth.exchange_certs(email_code, password)
+> ```
+>
+---
+>
+> Has a certificate?
+>
+> generate a access token
+>
+> ```ruby
+> user.auth.authenticate_with_certificate(password)
+> ```
+
+get the account balance
+
+```ruby
+user.account.balance # => 77.0
+```
 
 ## Development
 

data/Rakefile

@@ -2,5 +2,25 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+Bundler::GemHelper.install_tasks
 
 task :default => :spec
+
+task :start_new_release do
+  # TODO: add guard clean
+  bump = ENV['BUMP'] || 'patch'
+
+  sh 'gem install gem-release'
+  sh "gem bump --version #{bump}"
+  
+  Rake::Task[:build].invoke
+  
+  sh 'git add .'
+  sh "git commit -m \"build(version): :bookmark: bump #{bump}\"" 
+  sh 'git push'
+
+  version = NubankSdk::VERSION
+  version_tag = "v#{version}"
+  sh "git tag -a #{version_tag} -m \"Version #{version}\""
+  sh 'git push --tags'
+end

data/lib/nubank_sdk/account.rb

@@ -1,43 +1,31 @@
 module NubankSdk
   class Account
-    attr_reader :cpf, :device_id
-
-    def initialize(cpf:, key:, device_id: nil, adapter: nil)
-      @cpf = cpf
-      @device_id = device_id || generate_device_id
-
-      @api_routes = NubankSdk::ApiRoutes.new(connection_adapter: adapter)
-      @adapter = adapter
-      @key = key
+    #
+    # Returns the account statement
+    #
+    # @param [NubankSdk::Client::HTTPS] connection
+    # @param [NubankSdk::ApiRoutes] api_routes
+    def initialize(connection:, api_routes:)
+      @connection = connection
+      @api_routes = api_routes
     end
 
-    def auth
-      @auth ||= NubankSdk::Auth.new(
-        cpf: @cpf,
-        key: @key,
-        device_id: @device_id,
-        api_routes: @api_routes,
-        adapter: @adapter
+    #
+    # Returns the account balance
+    #
+    # @return [Float]
+    def balance
+      query_url = @api_routes.entrypoint(path: :ssl, entrypoint: :query)
+
+      response = @connection.post(
+        query_url, {
+          'variables': {},
+          'query': '{viewer {savingsAccount {currentSavingsBalance {netAmount}}}}'
+        }
       )
-    end
-
-    def account_balance
-      query_url = auth.api_routes.entrypoint(path: :ssl, entrypoint: :query)
-      connection = Client::HTTPS.new(auth.certificate.encoded, @adapter)
 
-      response = connection.post(query_url, {
-        'variables': {},
-        'query': '{viewer {savingsAccount {currentSavingsBalance {netAmount}}}}'
-      }, { Authorization: "Bearer #{auth.access_token}" })
-
-      data = JSON.parse(response.body, symbolize_names: true)
+      data = NubankSdk::Client.get_body(response)
       data[:data][:viewer][:savingsAccount][:currentSavingsBalance][:netAmount]
     end
-
-    private
-
-    def generate_device_id
-      SecureRandom.uuid.split('-').last
-    end
   end
-end
+end

data/lib/nubank_sdk/api_routes.rb

@@ -1,37 +1,52 @@
-# frozen_string_literal: true
-
 require 'faraday'
 require 'json'
 
 module NubankSdk
   class ApiRoutes
-    DISCOVERY_URI = "https://prod-s0-webapp-proxy.nubank.com.br"
+    DISCOVERY_URI = 'https://prod-s0-webapp-proxy.nubank.com.br'.freeze
     PROXY_PATHS = {
       default: '/api/discovery',
       app: '/api/app/discovery',
-      ssl: '',
-    }
+      ssl: ''
+    }.freeze
 
+    #
+    # Controller for the ApiRoutes class
+    #
+    # @param [Hash] url_discovery_map
+    # @param [[Symbol, Faraday::Adapter::Test::Stubs]] connection_adapter
     def initialize(url_discovery_map: {}, connection_adapter: nil)
       @url_discovery_map = url_discovery_map
       @connection_adapter = connection_adapter
     end
 
-    # types: :splitted, :full
+    #
+    # Return the url for a given path and entrypoint
+    #
+    # @param [Symbol] path
+    # @param [Symbol] entrypoint
+    # @param [Symbol] type, :splitted or :full
+    #
+    # @return [String, Array]
     def entrypoint(path: :default, entrypoint:, type: :full)
       discovery(path) if @url_discovery_map[path].nil?
 
       url = @url_discovery_map[path][entrypoint]
-      
-      if type == :full
-        return url
-      else
-        url_splitted = url.split('/api')
-      
-        return [url_splitted.first, "/api#{url_splitted.last}"]
-      end
+
+      return url if type == :full
+
+      url_splitted = url.split('/api')
+      [url_splitted.first, "/api#{url_splitted.last}"]
     end
 
+    #
+    # Add new entrypoint to url discovery map
+    #
+    # @param [Symbol] path
+    # @param [Symbol] entrypoint
+    # @param [String] url
+    #
+    # @return [Hash]
     def add_entrypoint(path: :default, entrypoint:, url:)
       path_map = @url_discovery_map[path] || {}
       path_map[entrypoint] = url
@@ -41,6 +56,12 @@ module NubankSdk
 
     private
 
+    # @!visibility private
+    # Request to the nubank api to get the url discovery map
+    #
+    # @param [Symbol] path
+    #
+    # @return [Hash]
     def discovery(path = :default)
       return @url_discovery_map[path] if @url_discovery_map[path]
 
@@ -50,6 +71,10 @@ module NubankSdk
       @url_discovery_map[path] = url_map
     end
 
+    # @!visibility private
+    # Return a default connection with the nubank api
+    #
+    # @return [Client::HTTP]
     def connection
       @connection ||= Client::HTTP.new(DISCOVERY_URI, @connection_adapter)
     end

data/lib/nubank_sdk/auth.rb

@@ -1,26 +1,36 @@
-# frozen_string_literal: true
-
 module NubankSdk
   class Auth
     attr_reader :refresh_token, :refresh_before, :access_token
 
-    def initialize(cpf:, device_id:, key: nil, api_routes: nil, adapter: nil)
+    #
+    # Auth method to connect with the nubank api
+    #
+    # @param [String] cpf the cpf to authenticate
+    # @param [String] device_id the device id to authenticate
+    # @param [NubankSdk::ApiRoutes] api_routes the api routes to connect
+    # @param [[Symbol, Faraday::Adapter::Test::Stubs]] adapter the adapter to connect
+    def initialize(cpf:, device_id: nil, api_routes: nil, connection_adapter: nil)
       @cpf = cpf
-      @device_id = device_id
-      @key = key || generate_key
+      @device_id = device_id || generate_device_id
       @api_routes = api_routes || NubankSdk::ApiRoutes.new
 
-      @adapter = adapter
-    end
-
-    def api_routes
-      @api_routes
+      @connection_adapter = connection_adapter
     end
 
+    #
+    # Return the instance of user certificate
+    #
+    # @return [NubankSdk::Certificate] the certificate instance
     def certificate
-      @certificate ||= NubankSdk::Certificate.new(@cpf, @key)
+      @certificate ||= NubankSdk::Certificate.new(@cpf)
     end
 
+    #
+    # Authenticate with the nubank api to get a new access token
+    #
+    # @param [String] password the password to authenticate
+    #
+    # @return [NubankSdk::ApiRoutes] the api routes with the new links
     def authenticate_with_certificate(password)
       token_url = @api_routes.entrypoint(path: :app, entrypoint: :token)
       response = ssl_connection.post(token_url, token_payload(password))
@@ -34,6 +44,12 @@ module NubankSdk
       update_api_routes(response_hash[:_links])
     end
 
+    #
+    # Request to nubank api to generate a new certificate
+    #
+    # @param [String] password the password to authenticate
+    #
+    # @return [String] email was has been received the code
     def request_email_code(password)
       response = default_connection.post(@gen_certificate_path, payload(password))
 
@@ -43,6 +59,10 @@ module NubankSdk
       response_parsed[:sent_to]
     end
 
+    #
+    # Verify communication with the nubank api
+    #
+    # @return [File] the certificate file
     def exchange_certs(email_code, password)
       response = default_connection.post(@gen_certificate_path, payload(password).merge({
           code: email_code,
@@ -51,11 +71,17 @@ module NubankSdk
       )
 
       response_data = Client.get_body(response)
-      certificate.process_decoded response_data[:certificate]
+      certificate.process_decoded(key, response_data[:certificate])
     end
 
     private
 
+    # @!visibility private
+    # parse the headers of the authenticate response
+    #
+    # @param [String] header_content the headers to parse
+    #
+    # @return [Hash] the parsed header
     def parse_authenticate_headers(header_content)
       chunks = header_content.split(',')
       parsed = {}
@@ -70,16 +96,28 @@ module NubankSdk
       parsed
     end
 
+    # @!visibility private
+    # Create a payload to generate a new certificate
+    #
+    # @param [String] password the password to authenticate
+    #
+    # @return [Hash] the payload to generate a new certificate
     def payload(password)
       {
         login: @cpf,
         password: password,
-        public_key: @key.public_key.to_pem,
+        public_key: key.public_key.to_pem,
         device_id: @device_id,
         model: "NubankSdk Client (#@device_id)",
       }
     end
 
+    # @!visibility private
+    # Create a payload to authenticate with the nubank api
+    #
+    # @param [String] password the password to authenticate
+    #
+    # @return [Hash] the payload to authenticate
     def token_payload(password)
       {
         'grant_type': 'password',
@@ -90,10 +128,20 @@ module NubankSdk
       }
     end
 
+    # @!visibility private
+    # Generates a new key for the certificate communication
+    #
+    # @return [OpenSSL::PKey::RSA] a new key
     def generate_key
       OpenSSL::PKey::RSA.new 2048
     end
 
+    # @!visibility private
+    # Add the new links to the api routes
+    #
+    # @param [Hash] links the new links to add
+    #
+    # @return [NubankSdk::ApiRoutes] the api routes with the new links
     def update_api_routes(links)
       feed_url_keys = ['events', 'magnitude']
       bills_url_keys = ['bills_summary']
@@ -105,33 +153,69 @@ module NubankSdk
       @api_routes.add_entrypoint(path: :ssl, entrypoint: :bills, url: find_url(bills_url_keys, links))
       @api_routes.add_entrypoint(path: :ssl, entrypoint: :customer, url: find_url(customer_url_keys, links))
       @api_routes.add_entrypoint(path: :ssl, entrypoint: :account, url: find_url(account_url_keys, links))
+      @api_routes
     end
 
+    # @!visibility private
+    # Return the url of the first key found in the links
+    #
+    # @param [Array] keys the keys to search in the links
+    # @param [Hash] list of the links to search in
+    #
+    # @return [String] the url of the first key found
     def find_url(keys, list)
       links_keys = list.keys
 
-      keys.each do |key|
-        return list[key]['href'] if links_keys.include?(key)
+      keys.each do |url_key|
+        return list[url_key]['href'] if links_keys.include?(url_key)
       end
       ''
     end
 
-    def prepare_connections
+    # @!visibility private
+    # Generates a new connection with certificate
+    #
+    # @return [Client::HTTPS] a new connection with certificate
+    def prepare_default_connection
       uri, @gen_certificate_path = @api_routes.entrypoint(
         path: :app,
         entrypoint: :gen_certificate,
         type: :splitted
       )
 
-      Client::HTTP.new(uri, @adapter)
+      Client::HTTP.new(uri, @connection_adapter)
     end
 
+    # @!visibility private
+    # Create a new default connection to the nubank api
+    #
+    # @return [Client::HTTP] a new default connection
     def default_connection
-      @default_connection ||= prepare_connections
+      @default_connection ||= prepare_default_connection
     end
 
+    # @!visibility private
+    # Create a new ssl connection to the nubank api
+    #
+    # @return [Client::HTTPS] a new ssl connection
     def ssl_connection
-      @ssl_connection ||= Client::HTTPS.new(certificate.encoded, @adapter)
+      @ssl_connection ||= Client::HTTPS.new(certificate.encoded, @connection_adapter)
+    end
+
+    # @!visibility private
+    # return the key of the certificate communication
+    #
+    # @return [OpenSSL::PKey::RSA] the key of the certificate
+    def key
+      @key ||= generate_key
+    end
+
+    # @!visibility private
+    # Generates a random device id
+    #
+    # @return [String] a random device id
+    def generate_device_id
+      SecureRandom.uuid.split('-').last
     end
   end
 end

data/lib/nubank_sdk/certificate.rb

@@ -1,43 +1,78 @@
-# frozen_string_literal: true
-
 require 'openssl'
 
 module NubankSdk
   class Certificate
-    FILES_PATH = './certificates/'
+    FILES_PATH = './certificates/'.freeze
 
-    def initialize(cpf, key)
+    #
+    # Controller of certifications
+    #
+    # @param [String] cpf
+    def initialize(cpf)
       @cpf = cpf
-      @key = key
     end
 
-    def process_decoded(certificate)
+    #
+    # Create a certificate file
+    #
+    # @param [OpenSSL::PKey::RSA] key
+    # @param [String] certificate
+    #
+    # @return [File]
+    def process_decoded(key, certificate)
       encoded = encode certificate
 
-      p12 = create_pkcs12_from encoded
+      p12 = create_pkcs12_from(key, encoded)
       save p12
     end
 
+    #
+    # Load the certificate file
+    #
+    # @return [OpenSSL::PKCS12]
     def encoded
       @encoded ||= OpenSSL::PKCS12.new(file.read, 'password')
     end
 
     private
 
+    # @!visibility private
+    # Open the encrypted certificate file
+    #
+    # @return [OpenSSL::PKCS12]
     def file
       File.open("#{FILES_PATH}#{@cpf}.p12", 'rb')
     end
 
+    # @!visibility private
+    # Create a file with the encrypted certificate
+    #
+    # @param [OpenSSL::PKCS12] p12
+    #
+    # @return [File]
     def save(p12)
       File.open("#{FILES_PATH}#{@cpf}.p12", 'wb') do |file|
         file.write p12.to_der
       end
     end
 
-    def create_pkcs12_from(certificate)
-      OpenSSL::PKCS12.create("password", "key", @key, certificate)
+    # @!visibility private
+    # crypt key and certificate to pkcs12
+    #
+    # @param [OpenSSL::PKey::RSA] key
+    # @param [OpenSSL::X509::Certificate] certificate
+    #
+    # @return [OpenSSL::PKCS12]
+    def create_pkcs12_from(key, certificate)
+      OpenSSL::PKCS12.create('password', 'key', key, certificate)
     end
 
+    # @!visibility private
+    # Enconde certificate string to certificate object
+    #
+    # @param [String] certificate
+    #
+    # @return [OpenSSL::X509::Certificate]
     def encode(certificate)
       OpenSSL::X509::Certificate.new certificate
     end

data/lib/nubank_sdk/client.rb

@@ -1,22 +1,38 @@
-# frozen_string_literal: true
-
 require 'faraday'
 require 'json'
 
 module NubankSdk
   module Client
+    #
+    # Parse the response body symbolizing keys
+    #
+    # @param [Faraday::Response] response
+    #
+    # @return [Hash]
     def self.get_body(response)
       JSON.parse(response.body, symbolize_names: true)
     end
 
     class HTTP
-      def initialize(base_url, adapter = nil)
+      #
+      # create a new connection with the given url in Faraday
+      #
+      # @param [String] base_url
+      # @param [[Symbol, Faraday::Adapter::Test::Stubs]] connection_adapter
+      def initialize(base_url, connection_adapter = nil)
         @connection = Faraday.new(url: base_url) do |faraday|
-          faraday.adapter *adapter if adapter
-          faraday.adapter Faraday.default_adapter unless adapter
+          faraday.adapter(*connection_adapter) if connection_adapter
+          faraday.adapter Faraday.default_adapter unless connection_adapter
         end
       end
 
+      #
+      # make put on connection with the given path
+      #
+      # @param [String] path
+      # @param [Hash] body
+      #
+      # @return [Faraday::Response]
       def post(path, body)
         @connection.post(path) do |req|
           req.headers['Content-Type'] = 'application/json'
@@ -24,30 +40,53 @@ module NubankSdk
         end
       end
 
+      #
+      # make get on connection with the given path
+      #
+      # @param [String] path
+      #
+      # @return [Faraday::Response]
       def get(path)
         @connection.get(path)
       end
     end
 
     class HTTPS
-      def initialize(certificate, adapter = nil)      
+      attr_accessor :headers
+
+      #
+      # Create a new instance of Faraday::Connection with client certificate
+      #
+      # @param [OpenSSL::PKCS12] certificate
+      # @param [[Symbol, Faraday::Adapter::Test::Stubs]] connection_adapter
+      def initialize(certificate, connection_adapter = nil)
         client_cert = OpenSSL::X509::Certificate.new(certificate.certificate)
         client_key = OpenSSL::PKey::RSA.new(certificate.key)
 
-        @connection = Faraday.new(ssl: { client_cert: client_cert, client_key: client_key}) do |faraday|
-          faraday.adapter *adapter if adapter
-          faraday.adapter Faraday.default_adapter unless adapter
-        end
+        @connection = Faraday.new(
+          ssl: {
+            client_cert: client_cert,
+            client_key: client_key
+          }
+        ) { |faraday| faraday.adapter(*connection_adapter) if connection_adapter }
+        @headers = {}
       end
 
-      def post(url, body, headers = {})
+      #
+      # Make a post request on connection
+      #
+      # @param [String] url
+      # @param [Hash] body
+      #
+      # @return [Faraday::Response]
+      def post(url, body)
         @connection.post(url) do |req|
           req.headers['Content-Type'] = 'application/json'
           req.headers['X-Correlation-Id'] = '772428d8-f0ee-43d6-8093-a13de3c9ce96'
           req.headers['User-Agent'] = "NubankSdk Client (#{NubankSdk::VERSION})"
 
-          headers.each do |key, value|
-            req.headers[key] = value
+          @headers.each do |header_key, value|
+            req.headers[header_key] = value
           end
 
           req.body = body.to_json

data/lib/nubank_sdk/user.rb

@@ -0,0 +1,64 @@
+module NubankSdk
+  class User
+    #
+    # Controller of user actions in nubank
+    #
+    # @param [String] cpf
+    # @param [[Symbol, Faraday::Adapter::Test::Stubs]] connection_adapter
+    def initialize(cpf:, connection_adapter: nil)
+      @cpf = cpf
+      @connection_adapter = connection_adapter
+    end
+
+    #
+    # Returns instance of authentications methods
+    #
+    # @return [NubankSdk::Auth]
+    def auth
+      @auth ||= NubankSdk::Auth.new(
+        cpf: @cpf,
+        api_routes: api_routes,
+        connection_adapter: @connection_adapter
+      )
+    end
+
+    #
+    # Returns instance of account methods
+    #
+    # @return [NubankSdk::Account]
+    def account
+      @account ||= NubankSdk::Account.new(connection: connection, api_routes: api_routes)
+    end
+
+    #
+    # An instance of apis routes
+    #
+    # @return [NubankSdk::ApiRoutes]
+    def api_routes
+      @api_routes ||= NubankSdk::ApiRoutes.new
+    end
+
+    private
+
+    # @!visibility private
+    # Returns connection with client https certificate and authorized
+    #
+    # @return [Faraday::Connection]
+    def connection
+      @connection ||= setup_connection
+    end
+
+    # @!visibility private
+    # Setup connection with client https certificate and authorized
+    #
+    # @return [Faraday::Connection]
+    def setup_connection
+      connection = Client::HTTPS.new(
+        auth.certificate.encoded,
+        @connection_adapter
+      )
+      connection.headers = { 'Authorization': "Bearer #{auth.access_token}" }
+      connection
+    end
+  end
+end

data/lib/nubank_sdk/version.rb

@@ -1,3 +1,3 @@
 module NubankSdk
-  VERSION = "0.4.1"
+  VERSION = "0.5.1"
 end

data/nubank_sdk.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "nubank_sdk/version"
@@ -25,7 +24,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.57.2"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.27.0"
+  spec.add_development_dependency "factory_bot", "~> 4.8.2"
+  spec.add_development_dependency "yard", "~> 0.9.12"
 
   spec.add_dependency "faraday", "~> 0.15.0"
-  spec.add_dependency "json", "~> 2.1.0"
+  spec.add_dependency "json", "~> 2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nubank_sdk
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Viserion77
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-24 00:00:00.000000000 Z
+date: 2022-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.27.0
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: '2.3'
 description: Monitorize balances, recent transactions, credit limit etc...
 email:
 - jeferson.a.oficial@gmail.com
@@ -87,8 +143,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".vscode/settings.json"
 - Gemfile
@@ -105,9 +163,9 @@ files:
 - lib/nubank_sdk/auth.rb
 - lib/nubank_sdk/certificate.rb
 - lib/nubank_sdk/client.rb
+- lib/nubank_sdk/user.rb
 - lib/nubank_sdk/version.rb
 - nubank_sdk.gemspec
-- usage_example.rb
 homepage: https://github.com/Viserion77/nubank_sdk
 licenses: []
 metadata: {}
@@ -126,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A gem to make it ease to monitorize your Nubank account.

data/usage_example.rb

@@ -1,19 +0,0 @@
-require 'nubank_sdk'
-
-# instance a nubank account object
-account = NubankSdk::Account.new(cpf: '12345678909')
-password = 'dracarys'
-# authenticate the account
-
-# request an email code
-account_email = account.auth.request_email_code(password)
-  
-# get the email code from the user
-puts "Enter the code sent to #{account_email}: "
-email_code = gets.chomp
-account.auth.exchange_certs(email_code, password)
-
-account.auth.authenticate_with_certificate(password)
-
-# get the account balance
-account.account_balance