revolut-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b839fefd5c6946b7a458278de2a4d050d933b26379f0acbb491e8f0c47e9658
+  data.tar.gz: b3eed9fc2bec72a95d5ce2b46f67e71ec3837fa4657737f1d374e56c3aabc26f
+SHA512:
+  metadata.gz: f6f9db586b2d09776bf3ac056377dc33969e1059e122b61c5ae24236790efc297f90997e1aaf92b79986d7c736e77202ee5f72a8024f08ecdb9904a52c18b617
+  data.tar.gz: 03e93f10777bc7b52cf94f9b78bab92c68b59ea149ec73e909af76ad563cf3f03714439f937a6f142d9b6e7d111d7608a43e52e372f01f831643ccede50da391

data/.gitignore

@@ -0,0 +1,27 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# pry history
+.pry_history
+
+# appraisals
+/gemfiles/*.lock
+
+# credentials
+credentials.yml
+
+# RVM
+.ruby-version
+.ruby-gemset
+
+# DS_Store
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at sebastian.johnsson@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    revolut-api (0.1.0)
+      faraday (>= 0.15)
+      faraday_middleware (>= 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.12.2)
+      faraday (>= 0.7.4, < 1.0)
+    hashdiff (0.3.7)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    rdoc (6.0.4)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rdoc (~> 6.0)
+  revolut-api!
+  rspec (~> 3.0)
+  vcr (~> 4.0)
+  webmock (~> 3.1)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Sebastian
+
+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,238 @@
+# Revolut::Api
+
+Revolut::Api is a Ruby gem to interact with Revolut's internal consumer API.
+
+This is the actual API used by the iOS/Android apps and this is not the business API.
+
+I've reverse engineered the API by checking what endpoints are invoked using [Charles Proxy](https://www.charlesproxy.com).
+
+This API is subject to change at any time and you should obviously take care using this client since it could result in loss of funds in your Revolut account.
+
+Hopefully Revolut will release an official API for the personal app and not just for Revolut Business.
+
+_NOTE: I do not take any responsibility of loss of funds or similar issues due to using this client!_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'revolut-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install revolut-api
+
+## Usage
+
+### Public client
+
+If you just want to use the public client to check exchange rates:
+
+```ruby
+public_client = Revolut::Api::Public::Client.new
+public_client.quotes(from: "EUR,USD", to: "SEK")
+```
+
+You can also check quotes for cryptocurrencies:
+
+```ruby
+public_client = Revolut::Api::Public::Client.new
+public_client.quotes(from: "BTC,ETH,LTC,XRP", to: "USD")
+```
+
+### Private/authenticated client
+
+#### Authentication
+
+In order to use the private/authenticated endpoints of Revolut's API you need to sign in first using your phone number and your PIN/password:
+
+```ruby
+client = Revolut::Api::Client.new
+client.signin(phone: "+1555555555", password: "1337")
+```
+
+After invoking this method Revolut will send you a text message with a code to confirm your sign in attempt. When you've received this code (which is valid for 10 minutes), do the following:
+
+```ruby
+client.confirm_signin(phone: "+1555555555", code: "CODE_RECEIVED_FROM_REVOLUT")
+=> {:id=>"YOUR-USER-ID", :access_token=>"YOUR-ACCESS-TOKEN"}
+```
+
+If the call is successful you should receive a hash containing your user id and your access token.
+
+If you haven't configured the device id the library will automatically generate one using `SecureRandom.uuid`. I'd also suggest saving this id and use it for configuring subsequent API calls using the client:
+
+```ruby
+Revolut::Api.configuration.device_id
+=> "SOME-RANDOM-DEVICE-GUID"
+```
+
+Update your configuration file (e.g. an initializer if you're using Rails) for setting up Revolut::API:
+
+```ruby
+Revolut::Api.configure do |config|
+  config.user_id          =   "YOUR-USER-ID"
+  config.access_token     =   "YOUR-ACCESS-TOKEN"
+  config.device_id        =   "SOME-RANDOM-DEVICE-GUID"
+end
+```
+
+This way you don't have to sign in / confirm your sign in next time you want to interact with the API.
+
+Verify that you can call endpoints that require correct authorization:
+
+```ruby
+client.user
+=> #<Revolut::Api::Response::User:0x00007ff27615eee0
+ @address=#<Revolut::Api::Response::Address:0x00007ff27615ed00 @city="Random Town", @country="US", @postcode="111111", @region="REGION", @street_line_one="Epic Street", @street_line_two=nil>,
+ @birth_date=[1999, 12, 31],
+```
+
+Revolut::Api::AuthorizationError is raised if there are any issues with authorization.
+
+#### User data
+
+##### User details
+
+To get your current Revolut user details:
+
+```ruby
+client.user
+```
+
+##### Wallet & pockets
+
+```ruby
+client.wallet
+```
+
+##### Cards
+
+```ruby
+client.cards
+```
+
+##### Update address
+
+```ruby
+client.update_address(city: "New City")
+```
+
+#### Transactions
+
+Fetch and memoize all transactions executed the current year:
+
+```ruby
+client.transactions(fetch_all: true, memoize: true)
+```
+
+Fetch and memoize all completed transfer transactions executed the current year:
+
+```ruby
+client.transactions(type: :transfer, completed: true, fetch_all: true, memoize: true)
+```
+
+Fetch and memoize all completed card payment transactions executed the current year:
+
+```ruby
+client.transactions(type: :card_payment, completed: true, fetch_all: true, memoize: true)
+```
+
+Fetch and memoize all pending card payment transactions executed the current year:
+
+```ruby
+client.transactions(type: :card_payment, pending: true, fetch_all: true, memoize: true)
+```
+
+Fetch a specific transaction by its transaction id:
+
+```ruby
+client.transaction("TRANSACTION_ID")
+```
+
+#### Exchange
+
+##### Fiat
+
+Exchange 0.1 EUR to USD:
+
+```ruby
+client.exchange(from: "EUR", to: "USD", amount: 0.1, side: :sell)
+```
+
+Exchange all available USD to EUR:
+
+```ruby
+client.exchange(from: "USD", to: "EUR", amount: :all, side: :sell)
+```
+
+##### Cryptocurrency
+
+Buy/exchange 10 EUR worth of BTC:
+
+```ruby
+client.exchange(from: "EUR", to: "BTC", amount: 10, side: :sell)
+```
+
+Buy/exchange 10 EUR worth of LTC:
+
+```ruby
+client.exchange(from: "EUR", to: "LTC", amount: 10, side: :sell)
+```
+
+Buy/exchange 10 EUR worth of ETH:
+
+```ruby
+client.exchange(from: "EUR", to: "ETH", amount: 10, side: :sell)
+```
+
+Buy/exchange 10 EUR worth of XRP:
+
+```ruby
+client.exchange(from: "EUR", to: "XRP", amount: 10, side: :sell)
+```
+
+## Development & Testing
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Copy credentials.yml.example to credentials.yml. If you do not already have your user id and an access token, run `bin/console`:
+
+```ruby
+client = Revolut::Api::Client.new
+client.signin(phone: "+1555555555", password: "1337")
+client.confirm_signin(phone: "+1555555555", code: "CODE_RECEIVED_FROM_REVOLUT")
+=> {:id=>"YOUR-USER-ID", :access_token=>"YOUR-ACCESS-TOKEN"}
+Revolut::Api.configuration.device_id
+=> "SOME-RANDOM-DEVICE-GUID"
+```
+
+Update credentials.yml with your user id, access token and device id.
+
+You can now run `rake spec` to run the tests.
+
+WARNING: If you delete the VCR cassettes in the spec/fixtures/vcr_cassettes-folder real API calls will be made to Revolut and real data will be returned from Revolut.
+
+For the current test suite this means performing actual exchanges from EUR to USD and exchanging _all_ available USD in your wallet to EUR.
+
+_I repeat: I do not take any responsibility for any loss of funds._
+
+The data returned from Revolut will contain your real user data. You have to manually edit all VCR cassette files and replace your personal/sensitive data with dummy data.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SebastianJ/revolut-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Revolut project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/revolut-api/blob/master/CODE_OF_CONDUCT.md).