revolut-connect 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9267f44243fdcd4eb8506475f0766c8696e86c1ca1eff5d015b0023faed2ea10
-  data.tar.gz: b310c700d99c101e6f923a2066264a15b0b143d769b963d92df5e626c6021188
+  metadata.gz: eaa3d08b4482201ea41200d2968900654790c24c29aaa7d2b9f2d55708711343
+  data.tar.gz: ac2db034b2f14493f620052056cb2691b57162289f242ed6fa16bf03d84a26a9
 SHA512:
-  metadata.gz: 3d3bf7d3d056bcf68e3199fd0d9f6264ba81301ae5dc9c503aa83d46f1de2172d74cb58fbded6c3c116479c6438ebf9b14488f76a7a2ddf8ab6173c4e870ad01
-  data.tar.gz: 6130b8b132106023f1f8aac3e924829e443119c4ec2b104403b9a2b38751142bd269997e103c3d635e72f32229f69b96c2490c0e03ca5197f2ac824bed003690
+  metadata.gz: 8014cbb4379beb6eccd20b0a8dc7c67e3746638eb1ad0435b522d998aa12f87ced1672e2b33627b266bff390c3ab3ebd240543179f29861c6b5e94e627cd1ba3
+  data.tar.gz: f1c2c09b9fc86fb9319befb7fe9e97bb55b823f1f8a4dca8731f0414365da4b9a0ee0a3abd6d9612a93924920c80e3c75e19caebdc4d30ebb1240a2f95a8f97a

data/Gemfile

@@ -15,6 +15,7 @@ group :development, :test do
   gem "pry-stack_explorer", "~> 0.6.1"
   gem "dotenv"
   gem "standard", "~> 1.3"
+  gem "timecop"
 end
 
 group :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    revolut-connect (0.1.0)
+    revolut-connect (0.1.1)
       faraday (>= 1)
       faraday-retry (>= 1)
       jwt (>= 1)
@@ -114,6 +114,7 @@ GEM
     standard-performance (1.3.1)
       lint_roller (~> 1.1)
       rubocop-performance (~> 1.20.2)
+    timecop (0.9.8)
     unicode-display_width (2.5.0)
     uri (0.13.0)
     webmock (3.23.0)
@@ -137,6 +138,7 @@ DEPENDENCIES
   simplecov
   simplecov-cobertura
   standard (~> 1.3)
+  timecop
   webmock (~> 3.23.0)
 
 BUNDLED WITH

data/README.md

@@ -1,12 +1,13 @@
 # Revolut Connect
 
-<a href="https://codecov.io/github/moraki-finance/revolut-connect" >
- <img src="https://codecov.io/github/moraki-finance/revolut-connect/graph/badge.svg?token=SKTT14JJGV"/>
-</a>
 
-[![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)
+|  Tests |  Coverage  |
+|:-:|:-:|
+| [![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 connector for Revolut. Revolut docs: <https://developer.revolut.com/>
+A lightweight API client for Revolut featuring authentication, permission scopes, token expiration and automatic renewal.
+
+Revolut docs: <https://developer.revolut.com/>
 
 _:warning: The extracted API objects don't do input parameters validations. It's a simple faraday wrapper that allows you to send as many inputs as you want. The Revolut API might fail when passing a wrong set of parameters._
 
@@ -131,6 +132,15 @@ Revolut.configure do |config|
   # Default: example.com
   config.iss = ENV["REVOLUT_ISS"]
 
+  # Optional: JWT token duration. After this duration, the token will be renewed (for security reasons, in case of token leakage)
+  # Default: 120 seconds (2 minutes).
+  config.token_duration = ENV["REVOLUT_TOKEN_DURATION"]
+
+  # Optional: Revolut authorization scope. You can restrict which features the app will have access to by passing different scopes.
+  # More info in https://developer.revolut.com/docs/business/business-api
+  # Default: nil
+  config.scope = ENV["REVOLUT_SCOPE"]
+
   # Optional: Timeout of the underlying faraday requests.
   # Default: 120
   config.request_timeout = 120

data/lib/revolut/client.rb

@@ -6,6 +6,8 @@ module Revolut
       client_id
       signing_key
       iss
+      token_duration
+      scope
       authorize_redirect_uri
       base_uri
       environment

data/lib/revolut/http.rb

@@ -103,7 +103,7 @@ module Revolut
         iss:,
         sub: client_id,
         aud: "https://revolut.com",
-        exp: Time.now.to_i + 120 # Expires in 2 minutes
+        exp: Time.now.to_i + token_duration
       }
 
       header = {

data/lib/revolut/middlewares/catch_error.rb

@@ -1,17 +1,22 @@
 # Helper middleware only intended to be used in the console.
 # The idea is to have a fast extraction of the API error message from the response body.
-class CatchError < Faraday::Middleware
-  def on_complete(env)
-    raise_error_middleware.on_complete(env)
-  rescue Faraday::Error => e
-    raise e, JSON.parse(e.response[:body])["message"]
-  end
 
-  private
+module Revolut
+  module Middleware
+    class CatchError < Faraday::Middleware
+      def on_complete(env)
+        raise_error_middleware.on_complete(env)
+      rescue Faraday::Error => e
+        raise e, JSON.parse(e.response[:body])["message"]
+      end
+
+      private
 
-  def raise_error_middleware
-    @raise_error_middleware ||= Faraday::Response::RaiseError.new
+      def raise_error_middleware
+        @raise_error_middleware ||= Faraday::Response::RaiseError.new
+      end
+    end
   end
 end
 
-Faraday::Response.register_middleware catch_error: CatchError
+Faraday::Response.register_middleware catch_error: Revolut::Middleware::CatchError

data/lib/revolut/resources/auth.rb

@@ -2,6 +2,8 @@ require "jwt"
 
 module Revolut
   class Auth < Resource
+    shallow
+
     class NotAuthorizedError < StandardError
       def initialize
         super(
@@ -21,7 +23,11 @@ module Revolut
       #
       # @return [String] The authorization URL.
       def authorize_url
-        "#{authorize_base_uri}?client_id=#{Revolut.config.client_id}&redirect_uri=#{Revolut.config.authorize_redirect_uri}&response_type=code#authorise"
+        URI::HTTPS.build(
+          host: authorize_uri_host,
+          path: "/app-confirm",
+          query: "client_id=#{Revolut.config.client_id}&redirect_uri=#{Revolut.config.authorize_redirect_uri}&response_type=code" + (Revolut.config.scope ? "&scope=#{Revolut.config.scope}" : "")
+        ).to_s + "#authorise"
       end
 
       # Exchanges the authorization code for an access token.
@@ -90,6 +96,15 @@ module Revolut
         expires_at && Time.now.to_i >= @expires_at
       end
 
+      # Checks if the user is authenticated.
+      #
+      # Returns:
+      # - true if the access token is present and not expired
+      # - false otherwise
+      def authenticated?
+        !@access_token.nil? && !expired?
+      end
+
       # Loads authentication information from environment variable REVOLUT_AUTH_JSON.
       #
       # If the access token is not already set and the environment variable REVOLUT_AUTH_JSON is present,
@@ -107,12 +122,18 @@ module Revolut
         load(JSON.parse(env_json))
       end
 
+      # Clears the authentication information.
+      def clear
+        @access_token = nil
+        @token_type = nil
+        @expires_at = nil
+        @refresh_token = nil
+      end
+
       private
 
-      def authorize_base_uri
-        Revolut.sandbox? ?
-          "https://sandbox-business.revolut.com/app-confirm" :
-          "https://business.revolut.com/app-confirm"
+      def authorize_uri_host
+        Revolut.sandbox? ? "sandbox-business.revolut.com" : "business.revolut.com"
       end
     end
   end

data/lib/revolut/version.rb

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

data/lib/revolut.rb

@@ -21,13 +21,14 @@ module Revolut
   class NotImplementedError < Error; end
 
   class Configuration
-    attr_accessor :request_timeout, :global_headers, :environment
+    attr_accessor :request_timeout, :global_headers, :environment, :token_duration, :scope
     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_ENVIRONMENT = "sandbox"
     DEFAULT_REQUEST_TIMEOUT = 120
+    DEFAULT_TOKEN_DURATION = 120 # 2 minutes
 
     def initialize
       @request_timeout = DEFAULT_REQUEST_TIMEOUT
@@ -36,6 +37,8 @@ module Revolut
       @signing_key = ENV["REVOLUT_SIGNING_KEY"]&.gsub("\\n", "\n")
       @iss = ENV.fetch("REVOLUT_ISS", "example.com")
       @authorize_redirect_uri = ENV["REVOLUT_AUTHORIZE_REDIRECT_URI"]
+      @token_duration = ENV.fetch("REVOLUT_TOKEN_DURATION", DEFAULT_TOKEN_DURATION)
+      @scope = ENV["REVOLUT_SCOPE"]
       @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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: revolut-connect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Martin Mochetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-01 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt