scalingo 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c6c044b3045115cfbb02eb44ff90880f115ad308f72962d3a2e396d094d57a1
-  data.tar.gz: 108a902824f01dd1bfc7ccd347ce3a1915ff5e68298ad236b8cd786d85f7df1a
+  metadata.gz: bc653c0172dd4bc1b2b1cb80948582e0069c058d615f74dcc2bb9fac3d467245
+  data.tar.gz: 4482433e8ca28c3a7ab72d2f22471f2ef2f61a5aa6b0f34d40c2faba9ecb5d98
 SHA512:
-  metadata.gz: 2bf6692720bdcaaebf692d5c9e714da314acd0e56cbab9d0d616e308efaeb70ec7bc03e0596e94ba80e554daa9f92bc7519dc8da6eb29faf801c11b4f8099a73
-  data.tar.gz: 2ae4d7349ac2cc5821109273b7adf1d489ee9e99c721694c4c6e1f3449ecf2f7c0a4341aea46874c9bb5fa50d1f4642c48fbc4822fe5409bb646c9ae40322790
+  metadata.gz: 708a8fbe40bf16f20e0cb2fcd94506d2e2e21d3c02c0d9e521fc02396897835efb695fda4b472f0eafb48d29e262e3f679166af8c5e1efeab4978bf841539d15
+  data.tar.gz: 5d75e30a6bdef5ae37be20869ffb81da7ceb82cd01d1a6cb97387054de87c3e1b4c6e2d6927deaaee22eb8195dd5d6ab0b51e177dfd66b57fc0fca6ec4a289ff

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    reviewers:
+      - "ksol"

data/.github/workflows/publish.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.github/workflows/ruby.yml

@@ -1,7 +1,3 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
@@ -18,7 +14,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -33,7 +29,7 @@ jobs:
       matrix:
         ruby-version: ['2.6', '2.7', '3.0']
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):

data/.sclng/metadata.toml

@@ -0,0 +1,8 @@
+dependencies = []
+description = "Ruby API client"
+destination_server = []
+flags = ["global", "scalingo-app"]
+languages = ["ruby"]
+owner = "kevin@scalingo.com"
+team = "UFS"
+version = "1.1.0"

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Unreleased
 
+## 3.2.0 - 2022-12-23
+
+* Removal: `Scalingo::Client#agora_fr1` had been removed since the region no longer exists.
+* New: Add `addons#authenticate!` endpoint
+* New API: database API
+* New API: backup API
+
 ## 3.1.0
 
 * Compat: support for ActiveSupport (and therefore Rails) 7, @Intrepidd

data/README.md

@@ -5,7 +5,7 @@ A ruby wrapper for the Scalingo API
 ### Migration from v2
 
 This gem is changing its name from `scalingo-ruby-api` to `scalingo`,
-and the versionning does **not** reset; the first major version of `scalingo`
+and the versioning does **not** reset; the first major version of `scalingo`
 will therefore be `3.x.x`.
 
 You can check the version 2 at [the v2 branch of this repository](https://github.com/Scalingo/scalingo-ruby-api/tree/v2)
@@ -145,6 +145,37 @@ scalingo.osc_fr1.apps.all # OR scalingo.region(:osc_fr1).apps.all
 scalingo.apps.create(name: "my-new-app", dry_run: true)
 ```
 
+### Interacting with databases
+
+Requests to the [database API](https://developers.scalingo.com/databases/) requires
+extra authentication for each addon you want to interact with. [Addon authentication
+tokens are valid for one hour](https://developers.scalingo.com/addons#get-addon-token).
+
+Supported regions for database API are `db_api_osc_fr1` and `db_api_osc_secnum_fr1`.
+
+```ruby
+require "scalingo"
+
+scalingo = Scalingo::Client.new
+scalingo.authenticate_with(access_token: "my_access_token")
+
+# First, authenticate using the `addons` API
+scalingo.osc_fr1.addons.authenticate!(app_id, addon_id)
+
+# Once authenticated for that specific addon, you can interact with
+# database and backup APIs.
+# IDs of databases are the IDs of the corresponding addons
+
+# get all information for a given database
+scalingo.db_api_osc_fr1.databases.find(addon_id)
+
+# get all backups for a given database
+scalingo.db_api_osc_fr1.backups.for(addon_id)
+
+# get URL to download backup archive
+scalingo.db_api_osc_fr1.backups.archive(addon_id, backup_id)
+```
+
 ## Development
 
 ### Install

data/lib/scalingo/api/client.rb

@@ -75,15 +75,11 @@ module Scalingo
       # this method may return the unauthenticated connection
       # even with `fallback_to_guest: false`
       def connection(fallback_to_guest: false)
-        if fallback_to_guest
-          begin
-            authenticated_connection
-          rescue Error::Unauthenticated
-            unauthenticated_connection
-          end
-        else
-          authenticated_connection
-        end
+        authenticated_connection
+      rescue Error::Unauthenticated
+        raise unless fallback_to_guest
+
+        unauthenticated_connection
       end
 
       def unauthenticated_connection
@@ -119,6 +115,24 @@ module Scalingo
           conn.adapter(config.faraday_adapter) if config.faraday_adapter
         }
       end
+
+      def database_connection(database_id)
+        raise Error::Unauthenticated unless token_holder.authenticated_for_database?(database_id)
+
+        @database_connections ||= {}
+        @database_connections[database_id] ||= Faraday.new(connection_options) { |conn|
+          conn.response :json, content_type: /\bjson$/, parser_options: {symbolize_names: true}
+          conn.request :json
+
+          bearer_token = token_holder.database_tokens[database_id]&.value
+          if bearer_token
+            auth_header = Faraday::Request::Authorization.header "Bearer", bearer_token
+            conn.headers[Faraday::Request::Authorization::KEY] = auth_header
+          end
+
+          conn.adapter(config.faraday_adapter) if config.faraday_adapter
+        }
+      end
     end
   end
 end

data/lib/scalingo/api/endpoint.rb

@@ -12,6 +12,7 @@ module Scalingo
       end
 
       def_delegator :client, :connection
+      def_delegator :client, :database_connection
 
       def inspect
         str = %(<#{self.class}:0x#{object_id.to_s(16)} base_url:"#{@client.url}" endpoints:)

data/lib/scalingo/client.rb

@@ -2,6 +2,7 @@ require "scalingo/core_client"
 require "scalingo/auth"
 require "scalingo/billing"
 require "scalingo/regional"
+require "scalingo/regional_database"
 
 module Scalingo
   class Client < CoreClient
@@ -20,19 +21,13 @@ module Scalingo
       )
     end
 
-    def agora_fr1
-      @agora_fr1 ||= Regional.new(
-        "https://api.agora-fr1.scalingo.com/v1",
-        scalingo: self,
-      )
-    end
-
     def osc_fr1
       @osc_fr1 ||= Regional.new(
         "https://api.osc-fr1.scalingo.com/v1",
         scalingo: self,
       )
     end
+    alias_method :apps_api_osc_fr1, :osc_fr1
 
     def osc_secnum_fr1
       @osc_secnum_fr1 ||= Regional.new(
@@ -40,5 +35,20 @@ module Scalingo
         scalingo: self,
       )
     end
+    alias_method :apps_api_osc_secnum_fr1, :osc_secnum_fr1
+
+    def db_api_osc_fr1
+      @db_api_osc_fr1 ||= RegionalDatabase.new(
+        "https://db-api.osc-fr1.scalingo.com/api",
+        scalingo: self,
+      )
+    end
+
+    def db_api_osc_secnum_fr1
+      @db_api_osc_secnum_fr1 ||= RegionalDatabase.new(
+        "https://db-api.osc-secnum-fr1.scalingo.com/api",
+        scalingo: self,
+      )
+    end
   end
 end

data/lib/scalingo/regional/addons.rb

@@ -80,6 +80,21 @@ module Scalingo
       unpack(:addon) { response }
     end
 
+    def authenticate!(app_id, addon_id, headers = nil, &block)
+      response = token(app_id, addon_id, headers, &block)
+      return response unless response.status == 200
+
+      token = response.data[:token]
+      client.token_holder.authenticate_database_with_bearer_token(
+        addon_id,
+        token,
+        expires_at: Time.now + 1.hour,
+        raise_on_expired_token: client.config.raise_on_expired_token,
+      )
+
+      response
+    end
+
     def token(app_id, addon_id, headers = nil, &block)
       data = nil
 

data/lib/scalingo/regional_database/backups.rb

@@ -0,0 +1,44 @@
+require "scalingo/api/endpoint"
+
+module Scalingo
+  class RegionalDatabase::Backups < API::Endpoint
+    def create(addon_id, headers = nil, &block)
+      data = nil
+
+      response = database_connection(addon_id).post(
+        "databases/#{addon_id}/backups",
+        data,
+        headers,
+        &block
+      )
+
+      unpack { response }
+    end
+
+    def for(addon_id, headers = nil, &block)
+      data = nil
+
+      response = database_connection(addon_id).get(
+        "databases/#{addon_id}/backups",
+        data,
+        headers,
+        &block
+      )
+
+      unpack(:database_backups) { response }
+    end
+
+    def archive(addon_id, backup_id, headers = nil, &block)
+      data = nil
+
+      response = database_connection(addon_id).get(
+        "databases/#{addon_id}/backups/#{backup_id}/archive",
+        data,
+        headers,
+        &block
+      )
+
+      unpack { response }
+    end
+  end
+end

data/lib/scalingo/regional_database/databases.rb

@@ -0,0 +1,18 @@
+require "scalingo/api/endpoint"
+
+module Scalingo
+  class RegionalDatabase::Databases < API::Endpoint
+    def find(id, headers = nil, &block)
+      data = nil
+
+      response = database_connection(id).get(
+        "databases/#{id}",
+        data,
+        headers,
+        &block
+      )
+
+      unpack(:database) { response }
+    end
+  end
+end

data/lib/scalingo/regional_database.rb

@@ -0,0 +1,13 @@
+require "scalingo/api/client"
+
+module Scalingo
+  class RegionalDatabase < API::Client
+    require "scalingo/regional_database/databases"
+    require "scalingo/regional_database/backups"
+
+    register_handlers!(
+      databases: Databases,
+      backups: Backups,
+    )
+  end
+end

data/lib/scalingo/token_holder.rb

@@ -4,28 +4,59 @@ module Scalingo
   module TokenHolder
     def self.included(base)
       base.attr_reader :token
+      base.attr_reader :database_tokens
     end
 
     def token=(input)
-      @token = input.is_a?(BearerToken) ? input : BearerToken.new(input.to_s, raise_on_expired: config.raise_on_expired_token)
+      @token = bearer_token(input)
+    end
+
+    def add_database_token(database_id, token)
+      @database_tokens ||= {}
+      @database_tokens[database_id] = bearer_token(token)
     end
 
     def authenticated?
-      token.present? && !token.expired?
+      valid?(token)
+    end
+
+    def authenticated_for_database?(database_id)
+      return false if database_tokens.nil?
+      return false unless database_tokens.has_key?(database_id)
+
+      valid?(database_tokens[database_id])
     end
 
     def authenticate_with_bearer_token(bearer_token, expires_at:, raise_on_expired_token:)
-      self.token = if expires_at
-        token = bearer_token.is_a?(BearerToken) ? bearer_token.value : bearer_token.to_s
-
-        BearerToken.new(
-          token,
-          expires_at: expires_at,
-          raise_on_expired: raise_on_expired_token,
-        )
-      else
-        bearer_token
-      end
+      self.token = build_bearer_token(bearer_token, expires_at: expires_at, raise_on_expired_token: raise_on_expired_token)
+    end
+
+    def authenticate_database_with_bearer_token(database_id, bearer_token, expires_at:, raise_on_expired_token:)
+      bearer_token = build_bearer_token(bearer_token, expires_at: expires_at, raise_on_expired_token: raise_on_expired_token)
+
+      add_database_token(database_id, bearer_token)
+    end
+
+    private
+
+    def valid?(token)
+      token.present? && !token.expired?
+    end
+
+    def bearer_token(token)
+      token.is_a?(BearerToken) ? token : BearerToken.new(token.to_s, raise_on_expired: config.raise_on_expired_token)
+    end
+
+    def build_bearer_token(bearer_token, expires_at:, raise_on_expired_token:)
+      return bearer_token unless expires_at
+
+      token = bearer_token.is_a?(BearerToken) ? bearer_token.value : bearer_token.to_s
+
+      BearerToken.new(
+        token,
+        expires_at: expires_at,
+        raise_on_expired: raise_on_expired_token,
+      )
     end
   end
 end

data/lib/scalingo/version.rb

@@ -1,3 +1,3 @@
 module Scalingo
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/samples/regional_database/backups/_meta.json

@@ -0,0 +1,4 @@
+{
+  "addon_id": "ad-5ed10967884fef000f5e4fff",
+  "backup_id": "5bb95a904ffb096e9a2831b8"
+}

data/samples/regional_database/backups/archive-200.json

@@ -0,0 +1,24 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups/5bb95a904ffb096e9a2831b8/archive",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "download_url": "https://regional-database.scalingo.test/databases/ad-5ed10967884fef000f5e4fff/backups/5bb95a904ffb096e9a2831b8/download?token=token1234"
+    }
+  }
+}

data/samples/regional_database/backups/archive-400.json

@@ -0,0 +1,24 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups/5bb95a904ffb096e9a2831b8/archive",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 400,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "error": "unauthorized"
+    }
+  }
+}

data/samples/regional_database/backups/create-201.json

@@ -0,0 +1,30 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 201,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "id": "5b8b36104ffb090be1ac3ce1",
+      "created_at": "2019-07-18T03:00:00.178+02:00",
+      "name": "20180902010000_kibana-3938",
+      "size": 0,
+      "status": "pending",
+      "database_id": "597601234ffb097af4f3099b",
+      "type": "postgresql"
+    }
+  }
+}

data/samples/regional_database/backups/create-400.json

@@ -0,0 +1,24 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 400,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "error": "unauthorized"
+    }
+  }
+}

data/samples/regional_database/backups/for-200.json

@@ -0,0 +1,52 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "database_backups": [
+        {
+          "id": "5bde44904ffb096c714be89c",
+          "created_at": "2018-11-04T02:00:00.154+01:00",
+          "name": "20181104010000_kibana-3938",
+          "size": 0,
+          "status": "pending",
+          "database_id": "597601234ffb097af4f3099b",
+          "type": "postgresql"
+        },
+        {
+          "id": "5bb95a904ffb096e9a2831b8",
+          "created_at": "2018-10-07T03:00:00.150+02:00",
+          "name": "20181007010000_kibana-3938",
+          "size": 0,
+          "status": "error",
+          "database_id": "597601234ffb097af4f3099b",
+          "type": "postgresql"
+        },
+        {
+          "id": "5b8b36104ffb090be1ac3ce1",
+          "created_at": "2018-09-02T03:00:00.178+02:00",
+          "name": "20180902010000_kibana-3938",
+          "size": 17484513608,
+          "status": "done",
+          "database_id": "597601234ffb097af4f3099b",
+          "type": "postgresql"
+        }
+      ]
+    }
+  }
+}

data/samples/regional_database/backups/for-400.json

@@ -0,0 +1,24 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 400,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "error": "unauthorized"
+    }
+  }
+}

data/samples/regional_database/databases/_meta.json

@@ -0,0 +1,3 @@
+{
+  "id": "ad-5ed10967884fef000f5e4fff"
+}

data/samples/regional_database/databases/find-200.json

@@ -0,0 +1,45 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "database": {
+        "id": "ad-5ed10967884fef000f5e4fff",
+        "resource_id": "my-db-123",
+        "app_name": "my-app",
+        "created_at": "2019-02-05T15:38:14.343+01:00",
+        "encryption_at_rest": true,
+        "features": [
+          {
+            "name": "redis-rdb",
+            "status": "ACTIVATED"
+          }
+        ],
+        "plan": "free",
+        "status": "running",
+        "type_id": "5bf30d1104c87f000161285a",
+        "type_name": "redis",
+        "version_id": "5bf30d1104c87f000161285b",
+        "instances": [],
+        "readable_version": "3.2.9-1",
+        "periodic_backups_enabled": true,
+        "periodic_backups_scheduled_at": [0]
+      }
+    }
+  }
+}

data/samples/regional_database/databases/find-400.json

@@ -0,0 +1,24 @@
+{
+  "path": "/databases/ad-5ed10967884fef000f5e4fff",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 400,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Etag": "W/\"a9504bb2f6f87c65ff68074ae787831e\"",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "max-age=0, private, must-revalidate",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "error": "unauthorized"
+    }
+  }
+}

data/spec/scalingo/api/client_spec.rb

@@ -170,6 +170,47 @@ RSpec.describe Scalingo::API::Client do
     end
   end
 
+  describe "database_connection" do
+    let(:database_id) { "db-id-1234" }
+
+    context "without bearer token" do
+      let(:scalingo) { scalingo_guest }
+
+      it "raises" do
+        expect {
+          subject.database_connection(database_id)
+        }.to raise_error(Scalingo::Error::Unauthenticated)
+      end
+    end
+
+    context "with bearer token" do
+      it "has an authentication header set with a bearer scheme" do
+        scalingo.authenticate_database_with_bearer_token(
+          database_id,
+          "1234",
+          expires_at: Time.now + 1.hour,
+          raise_on_expired_token: false,
+        )
+        expect(subject.database_connection(database_id).headers["Authorization"]).to eq "Bearer #{subject.token_holder.database_tokens[database_id].value}"
+      end
+    end
+
+    context "with wrong bearer token" do
+      it "raises" do
+        database_id_2 = "db-id-5678"
+        scalingo.authenticate_database_with_bearer_token(
+          database_id_2,
+          "1234",
+          expires_at: Time.now + 1.hour,
+          raise_on_expired_token: false,
+        )
+        expect {
+          subject.database_connection(database_id)
+        }.to raise_error(Scalingo::Error::Unauthenticated)
+      end
+    end
+  end
+
   describe "connection" do
     context "logged" do
       context "no fallback to guest" do

data/spec/scalingo/regional/addons_spec.rb

@@ -115,6 +115,26 @@ RSpec.describe Scalingo::Regional::Addons do
     end
   end
 
+  describe_method "authenticate!" do
+    context "success" do
+      let(:arguments) { [meta[:app_id], meta[:id]] }
+      let(:stub_pattern) { "token-200" }
+
+      it_behaves_like "a singular object response"
+      it "authenticates" do
+        response
+        expect(scalingo.authenticated_for_database?(meta[:id])).to be true
+      end
+    end
+
+    context "not found" do
+      let(:arguments) { [meta[:app_id], meta[:not_found_id]] }
+      let(:stub_pattern) { "token-404" }
+
+      it_behaves_like "a not found response"
+    end
+  end
+
   describe_method "update" do
     context "success" do
       let(:arguments) { [meta[:app_id], meta[:id], meta[:update][:valid]] }

data/spec/scalingo/regional_database/backups_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+RSpec.describe Scalingo::RegionalDatabase::Backups do
+  before do
+    scalingo.add_database_token(meta[:addon_id], "the-bearer-token")
+  end
+
+  describe_method "create" do
+    context "success" do
+      let(:arguments) { [meta[:addon_id]] }
+      let(:stub_pattern) { "create-201" }
+
+      it_behaves_like "a singular object response", 201
+    end
+
+    context "failure" do
+      let(:arguments) { [meta[:addon_id]] }
+      let(:stub_pattern) { "create-400" }
+
+      it_behaves_like "a client error"
+    end
+  end
+
+  describe_method "for" do
+    context "success" do
+      let(:arguments) { [meta[:addon_id]] }
+      let(:stub_pattern) { "for-200" }
+      let(:expected_count) { 3 }
+
+      it_behaves_like "a collection response"
+      it_behaves_like "a non-paginated collection"
+    end
+
+    context "failure" do
+      let(:arguments) { [meta[:addon_id]] }
+      let(:stub_pattern) { "for-400" }
+
+      it_behaves_like "a client error"
+    end
+  end
+
+  describe_method "archive" do
+    context "success" do
+      let(:arguments) { [meta[:addon_id], meta[:backup_id]] }
+      let(:stub_pattern) { "archive-200" }
+      let(:expected_keys) { %i[download_url] }
+
+      it_behaves_like "a singular object response"
+    end
+
+    context "failure" do
+      let(:arguments) { [meta[:addon_id], meta[:backup_id]] }
+      let(:stub_pattern) { "archive-400" }
+
+      it_behaves_like "a client error"
+    end
+  end
+end

data/spec/scalingo/regional_database/databases_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe Scalingo::RegionalDatabase::Databases do
+  before do
+    scalingo.add_database_token(meta[:id], "the-bearer-token")
+  end
+
+  describe_method "find" do
+    context "success" do
+      let(:arguments) { [meta[:id]] }
+      let(:stub_pattern) { "find-200" }
+
+      it_behaves_like "a singular object response"
+    end
+
+    context "failure" do
+      let(:arguments) { [meta[:id]] }
+      let(:stub_pattern) { "find-400" }
+
+      it_behaves_like "a client error"
+    end
+  end
+end

data/spec/scalingo/regional_database_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+RSpec.describe Scalingo::RegionalDatabase do
+  subject { described_class.new("url") }
+
+  %w[databases backups].each do |section|
+    it "handles requests for #{section}" do
+      expect(subject.respond_to?(section)).to be true
+    end
+  end
+end

data/spec/scalingo/token_holder_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+RSpec.describe Scalingo::TokenHolder do
+  subject(:token_holder_dummy_class) do
+    Class.new {
+      include(Scalingo::TokenHolder)
+      attr_accessor :config
+    }
+  end
+
+  describe "authenticate_with_bearer_token" do
+    subject { token_holder.authenticate_with_bearer_token(token, expires_at: expires_at, raise_on_expired_token: false) }
+
+    let(:token_holder) do
+      holder = token_holder_dummy_class.new
+      holder.config = Scalingo::Configuration.new
+
+      holder
+    end
+
+    context "without expiration date" do
+      let(:token) { "1234" }
+      let(:expires_at) { nil }
+
+      it "set the auth token" do
+        expect(token_holder.authenticated?).to be false
+        subject
+        expect(token_holder.authenticated?).to be true
+      end
+    end
+
+    context "with an expiration date" do
+      let(:token) { "1234" }
+      let(:expires_at) { Time.now + 1.hour }
+
+      it "refresh the auth token" do
+        token_holder.authenticate_with_bearer_token(token, expires_at: 1.hour.ago, raise_on_expired_token: false)
+        expect(token_holder.authenticated?).to be false
+
+        subject
+        expect(token_holder.authenticated?).to be true
+      end
+    end
+  end
+
+  describe "authenticate_database_with_bearer_token" do
+    subject { token_holder.authenticate_database_with_bearer_token(database_id, token, expires_at: expires_at, raise_on_expired_token: false) }
+
+    let(:token_holder) do
+      holder = token_holder_dummy_class.new
+      holder.config = Scalingo::Configuration.new
+
+      holder
+    end
+
+    let(:database_id) { "db-id-1234" }
+
+    context "without expiration date" do
+      let(:token) { "1234" }
+      let(:expires_at) { nil }
+
+      it "set the database auth token" do
+        expect(token_holder.authenticated_for_database?(database_id)).to be false
+        subject
+        expect(token_holder.authenticated_for_database?(database_id)).to be true
+      end
+    end
+
+    context "with an expiration date" do
+      let(:token) { "1234" }
+      let(:expires_at) { Time.now + 1.hour }
+
+      it "refresh the database token" do
+        token_holder.authenticate_database_with_bearer_token(database_id, token, expires_at: 1.hour.ago, raise_on_expired_token: false)
+        expect(token_holder.authenticated_for_database?(database_id)).to be false
+        subject
+        expect(token_holder.authenticated_for_database?(database_id)).to be true
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalingo
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Leo Unbekandt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,10 +185,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/publish.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".sclng/metadata.toml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -230,6 +232,9 @@ files:
 - lib/scalingo/regional/notifiers.rb
 - lib/scalingo/regional/operations.rb
 - lib/scalingo/regional/scm_repo_links.rb
+- lib/scalingo/regional_database.rb
+- lib/scalingo/regional_database/backups.rb
+- lib/scalingo/regional_database/databases.rb
 - lib/scalingo/token_holder.rb
 - lib/scalingo/version.rb
 - samples/auth/keys/_meta.json
@@ -413,6 +418,16 @@ files:
 - samples/regional/scm_repo_links/manual-deploy-200.json
 - samples/regional/scm_repo_links/show-200.json
 - samples/regional/scm_repo_links/update-200.json
+- samples/regional_database/backups/_meta.json
+- samples/regional_database/backups/archive-200.json
+- samples/regional_database/backups/archive-400.json
+- samples/regional_database/backups/create-201.json
+- samples/regional_database/backups/create-400.json
+- samples/regional_database/backups/for-200.json
+- samples/regional_database/backups/for-400.json
+- samples/regional_database/databases/_meta.json
+- samples/regional_database/databases/find-200.json
+- samples/regional_database/databases/find-400.json
 - scalingo.gemspec
 - spec/scalingo/api/client_spec.rb
 - spec/scalingo/api/endpoint_spec.rb
@@ -442,7 +457,11 @@ files:
 - spec/scalingo/regional/notifiers_spec.rb
 - spec/scalingo/regional/operations_spec.rb
 - spec/scalingo/regional/scm_repo_links_spec.rb
+- spec/scalingo/regional_database/backups_spec.rb
+- spec/scalingo/regional_database/databases_spec.rb
+- spec/scalingo/regional_database_spec.rb
 - spec/scalingo/regional_spec.rb
+- spec/scalingo/token_holder_spec.rb
 homepage: https://www.scalingo.com
 licenses:
 - MIT
@@ -467,7 +486,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Ruby client for Scalingo APIs
@@ -500,4 +519,8 @@ test_files:
 - spec/scalingo/regional/notifiers_spec.rb
 - spec/scalingo/regional/operations_spec.rb
 - spec/scalingo/regional/scm_repo_links_spec.rb
+- spec/scalingo/regional_database/backups_spec.rb
+- spec/scalingo/regional_database/databases_spec.rb
+- spec/scalingo/regional_database_spec.rb
 - spec/scalingo/regional_spec.rb
+- spec/scalingo/token_holder_spec.rb