scalingo 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc653c0172dd4bc1b2b1cb80948582e0069c058d615f74dcc2bb9fac3d467245
-  data.tar.gz: 4482433e8ca28c3a7ab72d2f22471f2ef2f61a5aa6b0f34d40c2faba9ecb5d98
+  metadata.gz: 90d46c83c5910349a51d707d80748ed81a542947e95397ce34f52c0f75a0bd56
+  data.tar.gz: e6e2840344c04d9ea78ef69dbfadfb601f4dd1c7c62f3af511c16a0652f6b1d2
 SHA512:
-  metadata.gz: 708a8fbe40bf16f20e0cb2fcd94506d2e2e21d3c02c0d9e521fc02396897835efb695fda4b472f0eafb48d29e262e3f679166af8c5e1efeab4978bf841539d15
-  data.tar.gz: 5d75e30a6bdef5ae37be20869ffb81da7ceb82cd01d1a6cb97387054de87c3e1b4c6e2d6927deaaee22eb8195dd5d6ab0b51e177dfd66b57fc0fca6ec4a289ff
+  metadata.gz: 7f166cbc46cd1ef4237e72765fb69348374f1c0d5f6e42bc3c544ff2f8926c3832a115d135241e2f3dd5a679297ce9b5a0196af80660d189d57aba3b9b11ab3f
+  data.tar.gz: f261a4617f0dc6f8ef3158ac918386020bb6243d93a89f315efb1a338bc7348287f23d7ae3307f61c9e29eef673f4fe41c23343d168cc3fd8ebb526530b15187

data/.github/workflows/ruby.yml

@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.6', '2.7', '3.0', '3.2']
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Unreleased
 
+## 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))
+* New: Add default region for database API ([#45](https://github.com/Scalingo/scalingo-ruby-api/issues/44))
+
 ## 3.2.0 - 2022-12-23
 
 * Removal: `Scalingo::Client#agora_fr1` had been removed since the region no longer exists.

data/README.md

@@ -174,6 +174,10 @@ 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)
+
+# you can omit the region to use the default one
+scalingo.databases.find(addon_id)
+
 ```
 
 ## Development
@@ -187,7 +191,7 @@ bundle
 ### Run tests
 
 ```bash
-bundle exec rake test
+bundle exec rspec
 ```
 
 ### Release a new version

data/lib/scalingo/core_client.rb

@@ -41,6 +41,10 @@ module Scalingo
       public_send(name || config.default_region)
     end
 
+    def database_region(name = nil)
+      public_send(name || "db_api_#{config.default_region}")
+    end
+
     ## Authentication helpers / Token management
     def authenticate_with(access_token: nil, bearer_token: nil, expires_at: nil)
       if !access_token && !bearer_token
@@ -102,5 +106,8 @@ module Scalingo
     def_delegator :region, :notifiers
     def_delegator :region, :operations
     def_delegator :region, :scm_repo_links
+
+    def_delegator :database_region, :databases
+    def_delegator :database_region, :backups
   end
 end

data/lib/scalingo/regional_database/backups.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack { response }
+      unpack(:database_backup) { response }
     end
 
     def for(addon_id, headers = nil, &block)

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

@@ -1,3 +1,3 @@
 module Scalingo
-  VERSION = "3.2.0"
+  VERSION = "3.4.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": {
@@ -18,13 +18,15 @@
       "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"
+      "database_backup": {
+        "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

@@ -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/spec/scalingo/core_client_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe Scalingo::CoreClient do
+  subject { described_class.new }
+
+  describe "#database_region" do
+    it "forwards call to the specified region" do
+      allow(subject).to receive("db_api_osc_secnum_fr1")
+
+      subject.database_region("db_api_osc_secnum_fr1")
+
+      expect(subject).to have_received("db_api_osc_secnum_fr1")
+    end
+
+    it "forwards call to default db_api region" do
+      allow(subject).to receive("db_api_#{subject.config.default_region}")
+
+      subject.database_region
+
+      expect(subject).to have_received("db_api_#{subject.config.default_region}")
+    end
+  end
+end

data/spec/scalingo/regional_database/databases_spec.rb

@@ -20,4 +20,20 @@ RSpec.describe Scalingo::RegionalDatabase::Databases do
       it_behaves_like "a client error"
     end
   end
+
+  describe_method "upgrade" do
+    context "success" do
+      let(:arguments) { [meta[:id]] }
+      let(:stub_pattern) { "upgrade-202" }
+
+      it_behaves_like "a singular object response", 202
+    end
+
+    context "failure" do
+      let(:arguments) { [meta[:id]] }
+      let(:stub_pattern) { "upgrade-400" }
+
+      it_behaves_like "a client error"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalingo
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Leo Unbekandt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-23 00:00:00.000000000 Z
+date: 2023-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -428,6 +428,8 @@ files:
 - samples/regional_database/databases/_meta.json
 - samples/regional_database/databases/find-200.json
 - samples/regional_database/databases/find-400.json
+- samples/regional_database/databases/upgrade-202.json
+- samples/regional_database/databases/upgrade-400.json
 - scalingo.gemspec
 - spec/scalingo/api/client_spec.rb
 - spec/scalingo/api/endpoint_spec.rb
@@ -443,6 +445,7 @@ files:
 - spec/scalingo/billing_spec.rb
 - spec/scalingo/client_spec.rb
 - spec/scalingo/configuration_spec.rb
+- spec/scalingo/core_client_spec.rb
 - spec/scalingo/regional/addons_spec.rb
 - spec/scalingo/regional/apps_spec.rb
 - spec/scalingo/regional/autoscalers_spec.rb
@@ -486,7 +489,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for Scalingo APIs
@@ -505,6 +508,7 @@ test_files:
 - spec/scalingo/billing_spec.rb
 - spec/scalingo/client_spec.rb
 - spec/scalingo/configuration_spec.rb
+- spec/scalingo/core_client_spec.rb
 - spec/scalingo/regional/addons_spec.rb
 - spec/scalingo/regional/apps_spec.rb
 - spec/scalingo/regional/autoscalers_spec.rb