![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.

<!-- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nubank_sdk`. To experiment with that code, run `bin/console` for an interactive prompt. -->

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'nubank_sdk'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install nubank_sdk

## Usage

```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

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/viserion77/nubank_sdk.

This project was based on the python implementation in this project: [andreroggeri/pynubank](https://github.com/andreroggeri/pynubank)