revolut-connect 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab4ede6e2971a49dea7cccc0a36ec45af6b87e9d9e4b239b7870eab34b7a278
-  data.tar.gz: d253ad5ca5b9b40fb8a16989fa787a93fd199a6f01621ed626c8a18dda95eaef
+  metadata.gz: 6f6c231899d0e5bfd5e675e2b911ccead17aa1df7c8f8e7e7475ba07ebfd4800
+  data.tar.gz: b15045344651b7a013b15dba27ac2ad19b868029fb85f642129fde6be5c5dd1e
 SHA512:
-  metadata.gz: 7d023304718166aadb50b682fa557c0844932c8ffb0a0757666e8e9c8e9135fa1aeee5ddf774504348641d12099d7ec274fa29db100f66fc88b898b88dd4b340
-  data.tar.gz: 16fb000e2863c830732d031353895425fd1bde52faad6f04ebf1f60f57c8af4534221442ce12a4eb0ae209a135f36da7f6cd7a522dced82cfac35487ac3b3099
+  metadata.gz: 6c0de989febb683fff5dc5d823dd89285dac611192e4053222eccb304df0d8d9ae4b3fc0589a4e74bcf6c7e6180736f4712ac45e036a4f1262fead830c53fc07
+  data.tar.gz: 4d77b497a69a1936ffb28fe30b1f64534c8ea3b5cf94776f3b449d925d3b986b8c7c29ad8ebc9e30e964d64baa01456930a7dc274128a09c73709d0ae4e7ae47

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    revolut-connect (0.1.4)
+    revolut-connect (0.1.6)
       faraday (>= 2)
       faraday-retry (>= 2)
       jwt (>= 1)

data/README.md

@@ -5,7 +5,7 @@
 |:-:|:-:|
 | [![Tests](https://github.com/moraki-finance/revolut-connect/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/moraki-finance/revolut-connect/actions/workflows/main.yml)  |  [![Codecov Coverage](https://codecov.io/github/moraki-finance/revolut-connect/graph/badge.svg?token=SKTT14JJGV)](https://codecov.io/github/moraki-finance/revolut-connect) |
 
-A lightweight API client for Revolut featuring authentication, permission scopes, token expiration and automatic renewal.
+A lightweight API client for Revolut featuring authentication, permission scopes, token expiration and automatic renewal, webhooks, webhook events, and much more!
 
 Revolut docs: <https://developer.revolut.com/>
 
@@ -22,6 +22,8 @@ _:warning: For now this connector only supports the [Business API](https://devel
 - `Payment`
 - `Transaction`
 - `TransferReason`
+- `Webhook`
+- `Simulation`
 
 ## :construction: Roadmap
 
@@ -31,10 +33,8 @@ _:warning: For now this connector only supports the [Business API](https://devel
 - `ForeignExchange` resource
 - `PaymentDraft` resource
 - `PayoutLink` resource
-- `Simulation` resource
 - `TeamMember` resource
 - `Transfer` resource
-- `Webhooks` resource
 
 ### Merchants API
 
@@ -160,9 +160,25 @@ Revolut.configure do |config|
   # Optional: The JWT for an already exchanged token.
   # Used to preload an existing auth token so that you don't have to exchange / renew it again.
   config.auth_json = ENV["REVOLUT_AUTH_JSON"]
+
+  # Optional: The revolut api version used. Generally used to hit the webhooks API as it requires api_version 2.0.
+  # Default: "1.0".
+  config.api_version = ENV["REVOLUT_API_VERSION"]
 end
 ```
 
+If you're setting the `auth_json` config, rembember to call `Revolut::Auth.load_from_env` right after the configuration is set so that the gem loads this JSON you just set:
+
+```rb
+Revolute.configure do |config|
+  ...
+  config.auth_json = ENV.fetch("REVOLUT_AUTH_JSON", nil)
+end
+
+# Load the `auth_json` value.
+Revolut::Auth.load_from_env
+```
+
 ### Resources
 
 #### Accounts
@@ -231,6 +247,56 @@ 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)
+```
+
 ## Development
 
 You can use `bin/console` to access an interactive console. This will preload environment variables from a `.env` file.

data/lib/revolut/client.rb

@@ -9,26 +9,27 @@ module Revolut
       token_duration
       scope
       authorize_redirect_uri
-      base_uri
+      api_version
       environment
       request_timeout
       global_headers
     ].freeze
 
-    attr_reader(*CONFIG_KEYS)
+    attr_reader(*CONFIG_KEYS, :base_uri)
 
-    def self.instance
-      @instance ||= new
-    end
-
-    private
-
-    def initialize
+    def initialize(**attrs)
       CONFIG_KEYS.each do |key|
         # Set instance variables like api_type & access_token. Fall back to global config
         # if not present.
-        instance_variable_set(:"@#{key}", Revolut.config.send(key))
+        instance_variable_set(:"@#{key}", attrs[key] || Revolut.config.send(key))
       end
+
+      @base_uri = (environment == :sandbox) ? "https://sandbox-b2b.revolut.com/api/#{api_version}/" : "https://b2b.revolut.com/api/#{api_version}/"
+    end
+
+    # Instance with all the defaults
+    def self.instance
+      @instance ||= new
     end
   end
 end

data/lib/revolut/http.rb

@@ -73,8 +73,8 @@ module Revolut
         # Request middlewares
         f.request content_type
         f.request :retry, { # Retries a request after refreshing the token if we get an UnauthorizedError
-          max: 1,
           exceptions: [Faraday::UnauthorizedError],
+          methods: Faraday::Retry::Middleware::IDEMPOTENT_METHODS + %i[post patch],
           retry_block: ->(env:, options:, retry_count:, exception:, will_retry_in:) {
             Revolut::Auth.refresh(force: true)
             env.request_headers = env.request_headers.merge("Authorization" => "Bearer #{Revolut::Auth.access_token}")

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/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.rb

@@ -0,0 +1,26 @@
+module Revolut
+  # Reference: https://developer.revolut.com/docs/business/counterparties
+  class Webhook < Resource
+    class << self
+      def resources_name
+        "webhooks"
+      end
+
+      def http_client
+        @http_client ||= Revolut::Client.new(api_version: "2.0")
+      end
+
+      def rotate_signing_secret(id, **data)
+        response = http_client.post("/#{resources_name}/#{id}/rotate-signing-secret", data:)
+
+        new(response.body)
+      end
+
+      def failed_events(id)
+        response = http_client.get("/#{resources_name}/#{id}/failed-events")
+
+        response.body.map(&Revolut::WebhookEvent)
+      end
+    end
+  end
+end

data/lib/revolut/resources/webhook_event.rb

@@ -0,0 +1,29 @@
+require "openssl"
+require "digest"
+
+module Revolut
+  class WebhookEvent < Resource
+    shallow # do not allow any resource operations on this resource
+
+    # Constructs a new instance of the WebhookEvent class from a request object and a signing secret.
+    #
+    # @param request [ActionDispatch::Request] The request object containing the webhook event data.
+    # @param signing_secret [String] The signing secret used to verify the signature of the webhook event.
+    # @return [WebhookEvent] A new instance of the WebhookEvent class.
+    # @raise [Revolut::SignatureVerificationError] If the signature verification fails.
+    def self.construct_from(request, signing_secret)
+      json = request.body.read
+      timestamp = request.headers["Revolut-Request-Timestamp"]
+      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 header_signatures.include? signature_digest
+        new(JSON.parse(json))
+      else
+        raise Revolut::SignatureVerificationError, "Signature verification failed"
+      end
+    end
+  end
+end

data/lib/revolut/version.rb

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

data/lib/revolut.rb

@@ -17,12 +17,15 @@ module Revolut
 
   class NotImplementedError < Error; end
 
+  class SignatureVerificationError < Error; end
+
+  class UnsupportedOperationError < Error; end
+
   class Configuration
-    attr_accessor :request_timeout, :global_headers, :environment, :token_duration, :scope, :auth_json
+    attr_accessor :request_timeout, :global_headers, :environment, :token_duration, :scope, :auth_json, :api_version
     attr_writer :client_id, :signing_key, :iss, :authorize_redirect_uri
-    attr_reader :base_uri
 
-    DEFAULT_BASE_URI = "https://sandbox-b2b.revolut.com/api/1.0/"
+    DEFAULT_API_VERSION = "1.0"
     DEFAULT_ENVIRONMENT = "sandbox"
     DEFAULT_REQUEST_TIMEOUT = 120
     DEFAULT_TOKEN_DURATION = 120 # 2 minutes
@@ -37,8 +40,8 @@ module Revolut
       @token_duration = ENV.fetch("REVOLUT_TOKEN_DURATION", DEFAULT_TOKEN_DURATION)
       @auth_json = ENV["REVOLUT_AUTH_JSON"]
       @scope = ENV["REVOLUT_SCOPE"]
+      @api_version = ENV.fetch("REVOLUT_API_VERSION", DEFAULT_API_VERSION)
       @environment = ENV.fetch("REVOLUT_ENVIRONMENT", DEFAULT_ENVIRONMENT).to_sym
-      @base_uri = (environment == :sandbox) ? "https://sandbox-b2b.revolut.com/api/1.0/" : "https://b2b.revolut.com/api/1.0/"
     end
 
     def client_id

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revolut-connect
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Martin Mochetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -84,8 +84,11 @@ files:
 - lib/revolut/resources/counterparty.rb
 - lib/revolut/resources/payment.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
+- lib/revolut/resources/webhook_event.rb
 - lib/revolut/version.rb
 - sig/revolut/connect.rbs
 homepage: https://github.com/moraki-finance/revolut-connect