revolut-connect 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9010d58ab099e0739336f7645c70fa7f859aeb8742109a3f48459262221302b8
-  data.tar.gz: d53d5e9b0a475252d5b00eaf9984a8557c67b0e31d03eb80ea4f4f39fdacc0e8
+  metadata.gz: b0b5d6b9801d9238ff7de1397f5398dd26651944e8d82de4f80eb497cbd89878
+  data.tar.gz: d9057ed5cbcc377551854526e4be16fcc11ad5bbcb0419ec7e6806e36d81ef52
 SHA512:
-  metadata.gz: 638eea99c2401f8fcdf5053f4fcc664975c6e677bf67eca9a83747337bac1389138da6e8a4a8f9632552d1ef848084e6f003a324c3577a2875810989971c77e6
-  data.tar.gz: 4e6e92b18f575b031861890f8e7f93b0ea6070e0c9c7321a515e01e3ad52f72ce8a6250b9e9d969757fa5e5268b4bffff8423d6a104a32d3d3c13da7b4bb020b
+  metadata.gz: 68f7f02ffc2a8dba0c99ae87953ca8d02f880dde5343478678ff85fb88d0b736840b60260a82b893d750369214a7ae7b1cbe0f73e5643e9cf67d3e7973ceda8d
+  data.tar.gz: 778f06a9e1fe00e69450f8b74213461df563aa51ba51f95850f42cf75a6bca64a7cd7626b2ef44a69a7b8c0b1c15f5ccb163168170a32dcce99911bc4a15dd55

data/Gemfile

@@ -5,7 +5,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in revolut-connect.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem "rake", "~> 13.2"
 
 group :development, :test do
   gem "byebug", "~> 11.1"
@@ -14,13 +14,13 @@ group :development, :test do
   gem "pry-rescue", "~> 1.5"
   gem "pry-stack_explorer", "~> 0.6.1"
   gem "dotenv"
-  gem "standard", "~> 1.3"
+  gem "standard", "~> 1.36"
   gem "timecop"
 end
 
 group :test do
   gem "rspec", "~> 3.0"
-  gem "webmock", "~> 3.23.0"
+  gem "webmock", "~> 3.23.1"
   gem "simplecov"
   gem "simplecov-cobertura"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    revolut-connect (0.1.5)
+    revolut-connect (0.1.7)
       faraday (>= 2)
       faraday-retry (>= 2)
       jwt (>= 1)
@@ -9,13 +9,13 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
-    binding_of_caller (1.0.0)
-      debug_inspector (>= 0.0.1)
+    bigdecimal (3.1.8)
+    binding_of_caller (1.0.1)
+      debug_inspector (>= 1.2.0)
     byebug (11.1.3)
     coderay (1.1.3)
     crack (1.0.0)
@@ -23,26 +23,28 @@ GEM
       rexml
     debug_inspector (1.2.0)
     diff-lcs (1.5.1)
-    docile (1.4.0)
-    dotenv (3.1.0)
-    faraday (2.9.0)
+    docile (1.4.1)
+    dotenv (3.1.2)
+    faraday (2.10.0)
       faraday-net_http (>= 2.0, < 3.2)
-    faraday-net_http (3.1.0)
+      logger
+    faraday-net_http (3.1.1)
       net-http
-    faraday-retry (2.2.0)
+    faraday-retry (2.2.1)
       faraday (~> 2.0)
     hashdiff (1.1.0)
     interception (0.5)
-    json (2.7.1)
-    jwt (2.8.1)
+    json (2.7.2)
+    jwt (2.8.2)
       base64
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    method_source (1.0.0)
+    logger (1.6.0)
+    method_source (1.1.0)
     net-http (0.4.1)
       uri
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -57,26 +59,27 @@ GEM
     pry-stack_explorer (0.6.1)
       binding_of_caller (~> 1.0)
       pry (~> 0.13)
-    public_suffix (5.0.4)
-    racc (1.7.3)
+    public_suffix (6.0.1)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.61.0)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -84,14 +87,14 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.1)
-      parser (>= 3.3.0.4)
-    rubocop-performance (1.20.2)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -102,28 +105,30 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.34.0)
+    standard (1.39.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.60)
+      rubocop (~> 1.64.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.4)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.4.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    timecop (0.9.8)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
+    timecop (0.9.10)
     unicode-display_width (2.5.0)
     uri (0.13.0)
-    webmock (3.23.0)
+    webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-darwin-23
+  x86_64-linux
 
 DEPENDENCIES
   byebug (~> 11.1)
@@ -132,14 +137,14 @@ DEPENDENCIES
   pry-byebug (~> 3.10)
   pry-rescue (~> 1.5)
   pry-stack_explorer (~> 0.6.1)
-  rake (~> 13.0)
+  rake (~> 13.2)
   revolut-connect!
   rspec (~> 3.0)
   simplecov
   simplecov-cobertura
-  standard (~> 1.3)
+  standard (~> 1.36)
   timecop
-  webmock (~> 3.23.0)
+  webmock (~> 3.23.1)
 
 BUNDLED WITH
    2.4.22

data/README.md

@@ -19,20 +19,20 @@ _:warning: For now this connector only supports the [Business API](https://devel
 
 - `Account`
 - `Counterparty`
+- `ForeignExchange`
 - `Payment`
 - `Transaction`
 - `TransferReason`
 - `Webhook`
+- `Simulation`
 
 ## :construction: Roadmap
 
 ### Business API
 
 - `Card` resource
-- `ForeignExchange` resource
 - `PaymentDraft` resource
 - `PayoutLink` resource
-- `Simulation` resource
 - `TeamMember` resource
 - `Transfer` resource
 
@@ -101,7 +101,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
     And then, when you need to load the auth again:
 
     ```rb
-    Revolut::Auth.load(auth_to_persist)
+    Revolut::Auth.load(JSON.parse(auth_to_persist))
     ```
 
     You can also store this json in an environment variable and the gem will auto load it:
@@ -149,8 +149,8 @@ Revolut.configure do |config|
   # Useful for observability tools like Helicone: https://www.helicone.ai/
   # Default: {}
   config.global_headers = {
-    "Helicone-Auth": "Bearer {HELICONE_API_KEY}"
-    "helicone-stream-force-format" => "true",
+    "Helicone-Auth": "Bearer {HELICONE_API_KEY}",
+    "helicone-stream-force-format" => "true"
   }
 
   # Optional: Set the environment to be production or sandbox.
@@ -218,6 +218,35 @@ retrieved_counterparty = Revolut::Counterparty.retrieve(created_counterparty.id)
 deleted = Revolut::Counterparty.delete(retrieved_counterparty.id)
 ```
 
+#### ForeignExchange
+
+<https://developer.revolut.com/docs/business/foreign-exchange>
+
+```rb
+# Exchange currencies
+exchange = Revolut::ForeignExchange.exchange(
+  request_id: "49c6a48b-6b58-40a0-b974-0b8c4888c8a9", # The ID of the request, provided by you. It helps you identify the transaction in your system.
+  from: {
+    account_id: "8fe12333-5b27-4ad5-896c-38a25673fcc8",
+    currency: "USD"
+  },
+  to: {
+    account_id: "b4a3bcd2-c1dd-47cc-ac50-40cdb5856d42",
+    currency: "GBP",
+    amount: 10
+  },
+ reference: "exchange"
+)
+
+
+# Retrieve information on exchange rates between currencies
+rate = Revolut::ForeignExchange.rate(
+  from: "EUR",
+  to: "USD",
+  amount: 100
+)
+```
+
 #### Payments
 
 <https://developer.revolut.com/docs/business/create-payment>
@@ -247,6 +276,99 @@ transaction = Revolut::Payment.retrieve(payment.id)
 deleted = Revolut::Payment.delete(transaction.id)
 ```
 
+#### Simulations
+
+<https://developer.revolut.com/docs/business/simulations>
+
+```rb
+# Update a transaction
+transaction = Revolut::Simulation.update_transaction("a6ea39d7-62c9-481c-8ba6-8a887a44c486", action: :complete)
+
+# Top up an account
+transaction = Revolut::Simulation.top_up_account("e042f1fe-f721-49cc-af82-db7a6c46944f",
+  amount: 100,
+  currency: "GBP",
+  reference: "Test Top-up",
+  state: "completed"
+)
+```
+
+#### Webhooks
+
+<https://developer.revolut.com/docs/business/webhooks-v-2>
+
+```rb
+# Create a webhook
+webhook = Revolut::Webhook.create(
+  url: "https://www.example.com",
+  events: [
+    "TransactionCreated",
+    "PayoutLinkCreated"
+  ]
+)
+
+# List webhooks
+webhooks = Revolut::Webhook.list
+
+# Retrieve a webhook
+webhook = Revolut::Webhook.retrieve(webhook.id)
+
+# Update a webhook
+webhook = Revolut::Webhook.update(webhook.id, url: "https://www.example.com/")
+
+# Delete a webhook
+deleted = Revolut::Webhook.delete(webhook.id)
+
+# Rotate webhook secret
+rotated = Revolut::Webhook.rotate_signing_secret(webhook.id)
+
+# Retrieve list of failing events
+failed_events = Revolut::Webhook.failed_events(webhook.id)
+```
+
+#### Webhooks in web applications (Rails example)
+
+In order to start listening to revolut webhook events you'll first have to create a webhook in your revolut instance so that revolut knows that it needs to start pushing events to a certain URL:
+
+```rb
+webhook = Revolut::Webhook.create(url: "http://{your web app webhook URL}")
+puts webhook.signing_secret
+```
+
+You can then copy the signing secret and store it in the env variables as follows:
+
+```text
+REVOLUT_WEBHOOK_SECRET={copy your signing secret here}
+```
+
+Then, in the revolut webhook controller, you can do the following to coerce revolut events (rails example):
+
+```rb
+class Webhooks::RevolutController < ApplicationController
+
+  def run
+    coerced = Revolut::WebhookEvent.construct_from(request, ENV["REVOLUT_WEBHOOK_SECRET"])
+    case coerced.event
+      when "TransactionStateChanged"
+        # handle event
+      when "PayoutLinkCreated"
+        # handle event
+      ...
+    end
+  rescue Revolut::SignatureVerificationError => e
+    # Do something when the signature verification fails
+    head :bad_request
+  end
+
+end
+```
+
+The rails routes would look something like this:
+
+```rb
+post "webhooks/revolut", to: "webhooks/revolut#run"
+```
+
 ## Development
 
 You can use `bin/console` to access an interactive console. This will preload environment variables from a `.env` file.

data/lib/revolut/resources/account.rb

@@ -7,6 +7,10 @@ module Revolut
       "accounts"
     end
 
+    # Retrieves the bank details for a specific account.
+    #
+    # @param id [String] The ID of the account.
+    # @return [Array<Revolut::BankAccount>] An array of bank account objects.
     def self.bank_details(id)
       response = http_client.get("/#{resources_name}/#{id}/bank-details")
 

data/lib/revolut/resources/foreign_exchange.rb

@@ -0,0 +1,28 @@
+require "forwardable"
+
+module Revolut
+  class ForeignExchange < Resource
+    shallow
+
+    class << self
+      extend Forwardable
+
+      def resource_name
+        "exchange"
+      end
+
+      def exchange(**attrs)
+        response = http_client.post("/#{resource_name}", data: attrs)
+
+        new(response.body)
+      end
+
+      # Delegate rate to the rate resource
+      def_delegators :rate_resource, :rate
+
+      def rate_resource
+        Revolut::Rate
+      end
+    end
+  end
+end

data/lib/revolut/resources/rate.rb

@@ -0,0 +1,15 @@
+module Revolut
+  class Rate < Resource
+    shallow
+
+    def self.resource_name
+      "rate"
+    end
+
+    def self.rate(**)
+      response = http_client.get("/#{resource_name}", **)
+
+      new(response.body)
+    end
+  end
+end

data/lib/revolut/resources/resource.rb

@@ -57,12 +57,12 @@ module Revolut
         @coerce_with ||= attrs
       end
 
-      protected
-
       def http_client
         @http_client ||= Revolut::Client.instance
       end
 
+      protected
+
       def resource_name
         resources_name
       end
@@ -88,16 +88,10 @@ module Revolut
 
       def check_not_allowed
         method = caller(1..1).first.match(/`(\w+)'/)[1].to_sym
-        raise Revolut::Error, "`#{method}` is not allowed on this resource" if not_allowed_to.include?(method) || only.any? && !only.include?(method)
+        raise Revolut::UnsupportedOperationError, "`#{method}` operation is not allowed on this resource" if not_allowed_to.include?(method) || only.any? && !only.include?(method)
       end
     end
 
-    def to_json
-      @_raw.to_json
-    end
-
-    protected
-
     def initialize(attrs = {})
       @_raw = attrs
 
@@ -121,5 +115,9 @@ module Revolut
 
       instance_variables.each { |iv| self.class.send(:attr_accessor, iv.to_s[1..].to_sym) }
     end
+
+    def to_json
+      @_raw.to_json
+    end
   end
 end

data/lib/revolut/resources/simulation.rb

@@ -0,0 +1,41 @@
+module Revolut
+  # Reference: https://developer.revolut.com/docs/business/counterparties
+  class Simulation < Resource
+    shallow
+
+    def self.resources_name
+      "sandbox"
+    end
+
+    # Updates a transaction in the sandbox environment.
+    #
+    # @param id [String] The ID of the transaction to update.
+    # @param action [Symbol] The action to perform on the transaction.
+    # @return [Revolut::Transaction] The updated transaction object.
+    # @raise [Revolut::UnsupportedOperationError] If the method is called in a non-sandbox environment or if the action is not supported.
+    def self.update_transaction(id, action:)
+      raise Revolut::UnsupportedOperationError, "#update_transaction is meant to be run only in sandbox environments" unless Revolut.sandbox?
+      raise Revolut::UnsupportedOperationError, "The action `#{action}` is not supported" unless %i[complete revert declined fail].include?(action)
+
+      response = http_client.post("/#{resources_name}/transactions/#{id}/#{action}")
+
+      Revolut::Transaction.new(response.body)
+    end
+
+    # Adds funds to the specified account in the sandbox environment.
+    #
+    # @param id [String] The ID of the account to top up.
+    # @param data [Hash] Additional data for the top-up request.
+    # @option data [Float] :amount The amount to top up the account by.
+    # @option data [String] :currency The currency of the top-up amount.
+    # @return [Revolut::Transaction] The transaction object representing the top-up.
+    # @raise [Revolut::UnsupportedOperationError] If the method is called outside of the sandbox environment.
+    def self.top_up_account(id, **data)
+      raise Revolut::UnsupportedOperationError, "#top_up_account is meant to be run only in sandbox environments" unless Revolut.sandbox?
+
+      response = http_client.post("/#{resources_name}/topup", data: data.merge(account_id: id))
+
+      Revolut::Transaction.new(response.body)
+    end
+  end
+end

data/lib/revolut/resources/webhook_event.rb

@@ -14,12 +14,12 @@ module Revolut
     def self.construct_from(request, signing_secret)
       json = request.body.read
       timestamp = request.headers["Revolut-Request-Timestamp"]
-      header_signature = request.headers["Revolut-Signature"]
+      header_signatures = request.headers["Revolut-Signature"].split(",")
       payload_to_sign = "v1.#{timestamp}.#{json}"
       digest = OpenSSL::Digest.new("sha256")
       signature_digest = "v1=" + OpenSSL::HMAC.hexdigest(digest, signing_secret, payload_to_sign)
 
-      if signature_digest == header_signature
+      if header_signatures.include? signature_digest
         new(JSON.parse(json))
       else
         raise Revolut::SignatureVerificationError, "Signature verification failed"

data/lib/revolut/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Revolut
-  VERSION = "0.1.5"
+  VERSION = "0.1.7"
 end

data/lib/revolut.rb

@@ -19,6 +19,8 @@ module Revolut
 
   class SignatureVerificationError < Error; end
 
+  class UnsupportedOperationError < Error; end
+
   class Configuration
     attr_accessor :request_timeout, :global_headers, :environment, :token_duration, :scope, :auth_json, :api_version
     attr_writer :client_id, :signing_key, :iss, :authorize_redirect_uri

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revolut-connect
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Martin Mochetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -82,8 +82,11 @@ files:
 - lib/revolut/resources/auth.rb
 - lib/revolut/resources/bank_account.rb
 - lib/revolut/resources/counterparty.rb
+- lib/revolut/resources/foreign_exchange.rb
 - lib/revolut/resources/payment.rb
+- lib/revolut/resources/rate.rb
 - lib/revolut/resources/resource.rb
+- lib/revolut/resources/simulation.rb
 - lib/revolut/resources/transaction.rb
 - lib/revolut/resources/transfer_reason.rb
 - lib/revolut/resources/webhook.rb