scalingo 3.3.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd6577391c3a1b7c40866c6fbcc56eff45216d448f415ceb16a4ebfbe8ce4f38
-  data.tar.gz: 02d3d754ec2c0216b95a254621d5d06a09114131a6ea661699124039b6ead7c7
+  metadata.gz: 98e17d7eb47e72aad2aefb6a07c6096542b1debd1533b15353b79ae7681c95f0
+  data.tar.gz: f224c29ecdeaba0fe9bba5d3bd3898fb9ed34de6c1ad6a58fddab89fcce2cedc
 SHA512:
-  metadata.gz: d11cd9d73cba2c8890949db5fb3e9f450ae5db662e7a5f9c91e7dedfeb2f96be72468b1f56000a0dd250379d1b979572283c4e3ef866fef72556e0563852f331
-  data.tar.gz: 3b3cf9f52ba33b05d14941c5e83aa0ef618bf0b85339a1b55212336b162131ea49265cfa9d051f591886f67d988473c7927108ea6595ea9d70792cffd2a19307
+  metadata.gz: bd981473899a583adab7c970aa2255fd0f5c70d112d3358241d512e7c300f7d710d5cc6c71ac73050f07bfe36b7aad0bf74fadc8219cfd7dbf5e245e1a9f80f5
+  data.tar.gz: 524aea983112d2e5a323151fc974104b8890e7b133f0bcaaa974a7884f93e76caf2f5a78894e831092467f4ea1de4ab5b91d1a3c9ec1becd856e9ff94e499073

data/.github/workflows/dependabot.yml

@@ -0,0 +1,17 @@
+name: Dependabot auto-approve
+on: pull_request
+
+permissions:
+  # Mandatory for both the auto-merge enabling and approval steps
+  pull-requests: write
+  # Mandatory for the auto-merge enabling step
+  contents: write
+
+jobs:
+  dependabot:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Automatically merge Dependabot PRs
+        uses: scalingo/ghaction-dependabot-automerge@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/publish.yml

@@ -7,15 +7,18 @@ on:
 
 jobs:
   build:
+    name: Build + Publish
     runs-on: ubuntu-latest
-
+    permissions:
+      contents: read
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0
+        ruby-version: "3.1"
         bundler-cache: true
+        rubygems: "latest"
     - name: Publish to RubyGems
       run: |
         mkdir -p $HOME/.gem

data/.github/workflows/ruby.yml

@@ -14,7 +14,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -27,9 +27,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.2']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3']
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - 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/.rubocop.yml

@@ -1,32 +1,20 @@
-inherit_from: []
-
-inherit_gem:
-  standard: config/base.yml
-
 require:
   - standard
+  - standard-custom
+  - standard-performance
   - rubocop-performance
 
+inherit_gem:
+  standard: config/base.yml
+  standard-custom: config/base.yml
+  standard-performance: config/base.yml
+
 AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
   SuggestExtensions: false
   Exclude:
     - 'node_modules/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
     - '.git/**/*'
-
-Style/TrailingCommaInArguments:
-  Enabled: true
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: true
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: true
-  EnforcedStyleForMultiline: consistent_comma
-
-Style/Alias:
-  Enabled: true
-  EnforcedStyle: prefer_alias_method

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## Unreleased
 
+## 3.5.0 - 2023-12-28
+
+* Change: update Faraday to 2.x, released about two years ago. The public API of this gem doesn't change, therefore this is not a major release. However, if you manipulate directly faraday's objects, you may encounter breaking changes. Refer to [Faraday's website](https://lostisland.github.io/faraday/) for how to migrate.
+* Compat: drop support for Ruby < 3. The lib is still expected to work for the time being.
+* Compat: include Ruby 3.3 in the test matrix
+
+## 3.4.0 - 2023-01-26
+
+* New: Add `databases#upgrade` endpoint for database API ([#51](https://github.com/Scalingo/scalingo-ruby-api/pull/51))
+
 ## 3.3.0 - 2023-01-03
 
 * Bugfix: response of Backups#create was not properly unpacked ([#44](https://github.com/Scalingo/scalingo-ruby-api/issues/44))

data/README.md

@@ -191,7 +191,7 @@ bundle
 ### Run tests
 
 ```bash
-bundle exec rake test
+bundle exec rspec
 ```
 
 ### Release a new version

data/lib/scalingo/api/client.rb

@@ -29,11 +29,11 @@ module Scalingo
 
       def self.register_handler!(method_name, klass)
         define_method(method_name) do
-          value = instance_variable_get("@#{method_name}")
+          value = instance_variable_get(:"@#{method_name}")
 
           if value.nil?
             value = klass.new(self)
-            instance_variable_set("@#{method_name}", value)
+            instance_variable_set(:"@#{method_name}", value)
           end
 
           value
@@ -54,7 +54,7 @@ module Scalingo
       def headers
         hash = {
           "User-Agent" => config.user_agent,
-          "Accept" => "application/json",
+          "Accept" => "application/json"
         }
 
         if (extra = config.additional_headers).present?
@@ -67,7 +67,7 @@ module Scalingo
       def connection_options
         {
           url: url,
-          headers: headers,
+          headers: headers
         }
       end
 
@@ -106,11 +106,7 @@ module Scalingo
         @connection = Faraday.new(connection_options) { |conn|
           conn.response :json, content_type: /\bjson$/, parser_options: {symbolize_names: true}
           conn.request :json
-
-          if token_holder.token&.value
-            auth_header = Faraday::Request::Authorization.header "Bearer", token_holder.token.value
-            conn.headers[Faraday::Request::Authorization::KEY] = auth_header
-          end
+          conn.request :authorization, "Bearer", -> { token_holder.token&.value }
 
           conn.adapter(config.faraday_adapter) if config.faraday_adapter
         }
@@ -123,12 +119,7 @@ module Scalingo
         @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.request :authorization, "Bearer", -> { token_holder.database_tokens[database_id]&.value }
 
           conn.adapter(config.faraday_adapter) if config.faraday_adapter
         }

data/lib/scalingo/api/response.rb

@@ -1,8 +1,8 @@
 module Scalingo
   module API
     class Response
-      def self.unpack(client, key: nil, keys: nil, &block)
-        response = block.call
+      def self.unpack(client, key: nil, keys: nil)
+        response = yield
 
         body = response.body
         has_hash_body = body.present? && body.respond_to?(:key)
@@ -24,7 +24,7 @@ module Scalingo
           headers: response.headers,
           data: data,
           meta: meta,
-          full_body: body,
+          full_body: body
         )
       end
 

data/lib/scalingo/auth/tokens.rb

@@ -5,10 +5,10 @@ module Scalingo
     def exchange(token, headers = nil, &block)
       data = nil
 
-      authorization = Faraday::Request::BasicAuthentication.header("", token)
+      authorization = Faraday::Utils.basic_header_from("", token)
 
       request_headers = {
-        Faraday::Request::Authorization::KEY => authorization,
+        Faraday::Request::Authorization::KEY => authorization
       }
 
       request_headers.update(headers) if headers

data/lib/scalingo/auth.rb

@@ -13,7 +13,7 @@ module Scalingo
       scm_integrations: ScmIntegrations,
       tokens: Tokens,
       two_factor_auth: TwoFactorAuth,
-      user: User,
+      user: User
     )
 
     alias_method :tfa, :two_factor_auth

data/lib/scalingo/billing.rb

@@ -5,7 +5,7 @@ module Scalingo
     require "scalingo/billing/profile"
 
     register_handlers!(
-      profile: Profile,
+      profile: Profile
     )
   end
 end

data/lib/scalingo/client.rb

@@ -10,21 +10,21 @@ module Scalingo
     def auth
       @auth ||= Auth.new(
         "https://auth.scalingo.com/v1",
-        scalingo: self,
+        scalingo: self
       )
     end
 
     def billing
       @billing ||= Billing.new(
         "https://cashmachine.scalingo.com",
-        scalingo: self,
+        scalingo: self
       )
     end
 
     def osc_fr1
       @osc_fr1 ||= Regional.new(
         "https://api.osc-fr1.scalingo.com/v1",
-        scalingo: self,
+        scalingo: self
       )
     end
     alias_method :apps_api_osc_fr1, :osc_fr1
@@ -32,7 +32,7 @@ module Scalingo
     def osc_secnum_fr1
       @osc_secnum_fr1 ||= Regional.new(
         "https://api.osc-secnum-fr1.scalingo.com/v1",
-        scalingo: self,
+        scalingo: self
       )
     end
     alias_method :apps_api_osc_secnum_fr1, :osc_secnum_fr1
@@ -40,14 +40,14 @@ module Scalingo
     def db_api_osc_fr1
       @db_api_osc_fr1 ||= RegionalDatabase.new(
         "https://db-api.osc-fr1.scalingo.com/api",
-        scalingo: self,
+        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,
+        scalingo: self
       )
     end
   end

data/lib/scalingo/configuration.rb

@@ -37,7 +37,7 @@ module Scalingo
       :additional_headers,
 
       # Specify an adapter for faraday. Leave nil for the default one (Net::HTTP)
-      :faraday_adapter,
+      :faraday_adapter
     ]
 
     ATTRIBUTES.each { |attr| attr_accessor(attr) }
@@ -49,13 +49,13 @@ module Scalingo
         exchanged_token_validity: 1.hour,
         raise_on_missing_authentication: true,
         raise_on_expired_token: false,
-        additional_headers: {},
+        additional_headers: {}
       )
     end
 
     def initialize(attributes = {}, parent = nil)
       ATTRIBUTES.each do |name|
-        public_send("#{name}=", attributes.fetch(name, parent&.public_send(name)))
+        public_send(:"#{name}=", attributes.fetch(name, parent&.public_send(name)))
       end
     end
   end

data/lib/scalingo/core_client.rb

@@ -1,6 +1,5 @@
 require "forwardable"
 require "faraday"
-require "faraday_middleware"
 require "scalingo/token_holder"
 require "scalingo/errors"
 
@@ -67,7 +66,7 @@ module Scalingo
           self.token = BearerToken.new(
             response.data[:token],
             expires_at: expiration,
-            raise_on_expired: config.raise_on_expired_token,
+            raise_on_expired: config.raise_on_expired_token
           )
         end
 
@@ -78,7 +77,7 @@ module Scalingo
         authenticate_with_bearer_token(
           bearer_token,
           expires_at: expires_at,
-          raise_on_expired_token: config.raise_on_expired_token,
+          raise_on_expired_token: config.raise_on_expired_token
         )
 
         true

data/lib/scalingo/regional/addons.rb

@@ -89,7 +89,7 @@ module Scalingo
         addon_id,
         token,
         expires_at: Time.now + 1.hour,
-        raise_on_expired_token: client.config.raise_on_expired_token,
+        raise_on_expired_token: client.config.raise_on_expired_token
       )
 
       response

data/lib/scalingo/regional.rb

@@ -31,7 +31,7 @@ module Scalingo
       metrics: Metrics,
       notifiers: Notifiers,
       operations: Operations,
-      scm_repo_links: ScmRepoLinks,
+      scm_repo_links: ScmRepoLinks
     )
   end
 end

data/lib/scalingo/regional_database/databases.rb

@@ -14,5 +14,18 @@ module Scalingo
 
       unpack(:database) { response }
     end
+
+    def upgrade(id, headers = nil, &block)
+      data = nil
+
+      response = database_connection(id).post(
+        "databases/#{id}/upgrade",
+        data,
+        headers,
+        &block
+      )
+
+      unpack(:database) { response }
+    end
   end
 end

data/lib/scalingo/regional_database.rb

@@ -7,7 +7,7 @@ module Scalingo
 
     register_handlers!(
       databases: Databases,
-      backups: Backups,
+      backups: Backups
     )
   end
 end

data/lib/scalingo/token_holder.rb

@@ -55,7 +55,7 @@ module Scalingo
       BearerToken.new(
         token,
         expires_at: expires_at,
-        raise_on_expired: raise_on_expired_token,
+        raise_on_expired: raise_on_expired_token
       )
     end
   end

data/lib/scalingo/version.rb

@@ -1,3 +1,3 @@
 module Scalingo
-  VERSION = "3.3.0"
+  VERSION = "3.5.0"
 end

data/samples/regional_database/backups/_meta.json

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

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups/5bb95a904ffb096e9a2831b8/archive",
+  "path": "/databases/63bfe3b600deff4f0516cc12/backups/5bb95a904ffb096e9a2831b8/archive",
   "method": "get",
   "request": {
     "headers": {
@@ -18,7 +18,7 @@
       "Referrer-Policy": "strict-origin-when-cross-origin"
     },
     "json_body": {
-      "download_url": "https://regional-database.scalingo.test/databases/ad-5ed10967884fef000f5e4fff/backups/5bb95a904ffb096e9a2831b8/download?token=token1234"
+      "download_url": "https://regional-database.scalingo.test/databases/63bfe3b600deff4f0516cc12/backups/5bb95a904ffb096e9a2831b8/download?token=token1234"
     }
   }
 }

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups/5bb95a904ffb096e9a2831b8/archive",
+  "path": "/databases/63bfe3b600deff4f0516cc12/backups/5bb95a904ffb096e9a2831b8/archive",
   "method": "get",
   "request": {
     "headers": {

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "path": "/databases/63bfe3b600deff4f0516cc12/backups",
   "method": "post",
   "request": {
     "headers": {

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "path": "/databases/63bfe3b600deff4f0516cc12/backups",
   "method": "post",
   "request": {
     "headers": {

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "path": "/databases/63bfe3b600deff4f0516cc12/backups",
   "method": "get",
   "request": {
     "headers": {

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff/backups",
+  "path": "/databases/63bfe3b600deff4f0516cc12/backups",
   "method": "get",
   "request": {
     "headers": {

data/samples/regional_database/databases/_meta.json

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

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff",
+  "path": "/databases/63bfe3b600deff4f0516cc12",
   "method": "get",
   "request": {
     "headers": {
@@ -19,7 +19,7 @@
     },
     "json_body": {
       "database": {
-        "id": "ad-5ed10967884fef000f5e4fff",
+        "id": "63bfe3b600deff4f0516cc12",
         "resource_id": "my-db-123",
         "app_name": "my-app",
         "created_at": "2019-02-05T15:38:14.343+01:00",
@@ -38,7 +38,9 @@
         "instances": [],
         "readable_version": "3.2.9-1",
         "periodic_backups_enabled": true,
-        "periodic_backups_scheduled_at": [0]
+        "periodic_backups_scheduled_at": [
+          0
+        ]
       }
     }
   }

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

@@ -1,5 +1,5 @@
 {
-  "path": "/databases/ad-5ed10967884fef000f5e4fff",
+  "path": "/databases/63bfe3b600deff4f0516cc12",
   "method": "get",
   "request": {
     "headers": {

data/samples/regional_database/databases/upgrade-202.json

@@ -0,0 +1,39 @@
+{
+  "path": "/databases/63bfe3b600deff4f0516cc12/upgrade",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 202,
+    "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",
+      "Location": "https://db-api.osc-st-fr1.st-sc.fr/api/operations/63bef2179307d55a9658cd99"
+    },
+    "json_body": {
+      "message": "Database upgrade to 7.0.5-1 is pending",
+      "id": "6335961fb07f4c000fe7461c",
+      "created_at": "2022-09-29T12:57:03.372Z",
+      "updated_at": "2022-09-29T12:57:03.372Z",
+      "database_type_id": "5eea3345d6f2bd5a55e2aad0",
+      "major": 7,
+      "minor": 0,
+      "patch": 5,
+      "build": 1,
+      "features": [
+        "tls"
+      ],
+      "release_number": 330,
+      "allowed_plugins": null,
+      "warning_message": ""
+    }
+  }
+}

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

@@ -0,0 +1,24 @@
+{
+  "path": "/databases/63bfe3b600deff4f0516cc12/upgrade",
+  "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/scalingo.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
     "changelog_uri" => "https://github.com/Scalingo/scalingo-ruby-api/blob/master/CHANGELOG.md",
     "documentation_uri" => "https://developers.scalingo.com/",
     "homepage_uri" => "https://www.scalingo.com/",
-    "source_code_uri" => "https://github.com/Scalingo/scalingo-ruby-api",
+    "source_code_uri" => "https://github.com/Scalingo/scalingo-ruby-api"
   }
 
   # Specify which files should be added to the gem when it is released.
@@ -32,18 +32,15 @@ Gem::Specification.new do |s|
   s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.test_files = Dir["spec/**/*_spec.rb"]
-
   s.add_dependency "activesupport", [">= 5", "< 8"]
-  s.add_dependency "faraday", "~> 1.0"
-  s.add_dependency "faraday_middleware", "~> 1.0"
+  s.add_dependency "faraday", "~> 2.0"
   s.add_dependency "multi_json", ">= 1.0.3", "~> 1.0"
 
   s.add_development_dependency "bundler", "~> 2.0"
   s.add_development_dependency "rake", "~> 13.0"
   s.add_development_dependency "rspec", "~> 3.0"
-  s.add_development_dependency "standard", "~> 1.1.0"
+  s.add_development_dependency "standard", "~> 1.32"
   s.add_development_dependency "rubocop-rspec"
   s.add_development_dependency "pry", "~> 0.14.1"
-  s.add_development_dependency "webmock", "~> 3.12.2"
+  s.add_development_dependency "webmock", "~> 3.19"
 end