scalingo 3.0.0.beta.2 → 3.0.0.beta.3

data/lib/scalingo/regional/environment.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :variables)
+      unpack(:variables) { response }
     end
 
     def create(app_id, payload = {}, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :variable)
+      unpack(:variable) { response }
     end
 
     def update(app_id, variable_id, value, headers = nil, &block)
@@ -38,7 +38,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :variable)
+      unpack(:variable) { response }
     end
 
     def destroy(app_id, variable_id, headers = nil, &block)
@@ -51,7 +51,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
 
     def bulk_update(app_id, variables, headers = nil, &block)
@@ -64,7 +64,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :variables)
+      unpack(:variables) { response }
     end
 
     def bulk_destroy(app_id, variable_ids, headers = nil, &block)
@@ -77,7 +77,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
   end
 end

data/lib/scalingo/regional/events.rb

@@ -10,7 +10,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :events)
+      unpack(:events) { response }
     end
 
     def for(app_id, payload = {}, headers = nil, &block)
@@ -23,7 +23,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :events)
+      unpack(:events) { response }
     end
 
     def types(headers = nil, &block)
@@ -36,7 +36,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :event_types)
+      unpack(:event_types) { response }
     end
 
     def categories(headers = nil, &block)
@@ -49,7 +49,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :event_categories)
+      unpack(:event_categories) { response }
     end
   end
 end

data/lib/scalingo/regional/logs.rb

@@ -10,7 +10,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
 
     def archives(app_id, headers = nil, &block)
@@ -23,7 +23,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :archives)
+      unpack(:archives) { response }
     end
 
     ## Helper method to avoid having to manually chain two operations

data/lib/scalingo/regional/metrics.rb

@@ -22,7 +22,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
 
     def types(headers = nil, &block)
@@ -35,7 +35,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :metrics)
+      unpack(:metrics) { response }
     end
   end
 end

data/lib/scalingo/regional/notifiers.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :notifiers)
+      unpack(:notifiers) { response }
     end
 
     def find(app_id, notifier_id, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :notifier)
+      unpack(:notifier) { response }
     end
 
     def create(app_id, payload = {}, headers = nil, &block)
@@ -38,7 +38,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :notifier)
+      unpack(:notifier) { response }
     end
 
     def update(app_id, notifier_id, payload = {}, headers = nil, &block)
@@ -51,7 +51,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :notifier)
+      unpack(:notifier) { response }
     end
 
     def destroy(app_id, notifier_id, headers = nil, &block)
@@ -64,7 +64,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
 
     def test(app_id, notifier_id, headers = nil, &block)
@@ -77,7 +77,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
 
     def platforms(headers = nil, &block)
@@ -90,7 +90,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :notification_platforms)
+      unpack(:notification_platforms) { response }
     end
   end
 end

data/lib/scalingo/regional/operations.rb

@@ -20,7 +20,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :operation)
+      unpack(:operation) { response }
     end
   end
 end

data/lib/scalingo/regional/scm_repo_links.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_repo_link)
+      unpack(:scm_repo_link) { response }
     end
 
     def create(app_id, payload = {}, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_repo_link)
+      unpack(:scm_repo_link) { response }
     end
 
     def update(app_id, payload = {}, headers = nil, &block)
@@ -38,7 +38,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_repo_link)
+      unpack(:scm_repo_link) { response }
     end
 
     def destroy(app_id, headers = nil, &block)
@@ -51,7 +51,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_repo_link)
+      unpack(:scm_repo_link) { response }
     end
 
     def deploy(app_id, branch, headers = nil, &block)
@@ -64,7 +64,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :deployment)
+      unpack(:deployment) { response }
     end
 
     def review_app(review_app, pull_request_id, headers = nil, &block)
@@ -77,7 +77,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :review_app)
+      unpack(:review_app) { response }
     end
 
     def branches(app_id, headers = nil, &block)
@@ -90,7 +90,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :branches)
+      unpack(:branches) { response }
     end
 
     def pulls(app_id, headers = nil, &block)
@@ -103,7 +103,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :pulls)
+      unpack(:pulls) { response }
     end
   end
 end

data/lib/scalingo/token_holder.rb

@@ -0,0 +1,31 @@
+require "scalingo/bearer_token"
+
+module Scalingo
+  module TokenHolder
+    def self.included(base)
+      base.attr_reader :token
+    end
+
+    def token=(input)
+      @token = input.is_a?(BearerToken) ? input : BearerToken.new(input.to_s, raise_on_expired: config.raise_on_expired_token)
+    end
+
+    def authenticated?
+      token.present? && !token.expired?
+    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
+    end
+  end
+end

data/lib/scalingo/version.rb

@@ -1,3 +1,3 @@
 module Scalingo
-  VERSION = "3.0.0.beta.2"
+  VERSION = "3.0.0.beta.3"
 end

data/samples/regional/addons/token-200.json

@@ -0,0 +1,49 @@
+{
+  "path": "/apps/5ed10967884fef000f5e4fff/addons/ad-6733873b-1628-4b8e-8e74-c30f1c3f3b63/token",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:09:00 GMT",
+      "Etag": "W/\"ece1ff1263aad47584f356e20127cf3b\"",
+      "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": {
+      "addon": {
+        "id": "ad-6733873b-1628-4b8e-8e74-c30f1c3f3b63",
+        "app_id": "5ed10967884fef000f5e4fff",
+        "resource_id": "some_example_5629",
+        "addon_provider": {
+          "id": "postgresql",
+          "name": "PostgreSQL",
+          "logo_url": "//cdn.scalingo.com/addons/Scalingo_Postgresql.svg"
+        },
+        "plan": {
+          "id": "5d1e03873e6b3b000eefa827",
+          "name": "postgresql-sandbox",
+          "display_name": "Sandbox",
+          "price": 0.0,
+          "description": "<p>Pouet</p>\n",
+          "position": null,
+          "on_demand": false,
+          "disabled": false,
+          "disabled_alternative_plan_id": null,
+          "sku": "ovh-st-fr1-postgresql-sandbox"
+        },
+        "provisioned_at": "2020-05-29T13:08:58.103Z",
+        "deprovisioned_at": null,
+        "status": "provisioning",
+        "token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJTY2FsaW5nbyIsImlhdCI6MTU5Mjg0MjQ3OSwidXVpZCI6InVzLTY3NmJiMGMxLTFjYTktNDY4Mi04ZWUxLTI1NzQyMmU5ZWFiNSIsInJuZCI6IjlhZGZlMzNlNDUxNzNmZTBiNjg4ZjQxZTY4OTg1OWQ0IiwiZXhwIjoxNTkyODQ2MDc5LCJhZGRvbl91dWlkIjoiYWQtNTRlYzczMzItYjViOS00MGUyLTg2NWQtYmNkYTg1Yzc2Y2I2In0.-rYijDhFRWcycSFLcCbdQD3tg9rh1MhXE_rTvlOtQt-48BJcPmxH9Wpazzp7tkspYrx8jfIrWrALoujvW33WVw"
+      }
+    }
+  }
+}

data/samples/regional/addons/token-404.json

@@ -0,0 +1,24 @@
+{
+  "path": "/apps/5ed10967884fef000f5e4fff/addons/wrong-addon-id/token",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 404,
+    "headers": {
+      "Date": "Fri, 29 May 2020 13:08:59 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "no-cache",
+      "Referrer-Policy": "strict-origin-when-cross-origin"
+    },
+    "json_body": {
+      "resource": "addon",
+      "error": "not found"
+    }
+  }
+}

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.

data/spec/scalingo/api/client_spec.rb

@@ -3,14 +3,61 @@ require "spec_helper"
 RSpec.describe Scalingo::API::Client do
   let(:url) { "http://localhost" }
 
-  subject { described_class.new(scalingo, url) }
+  subject { described_class.new(url, scalingo: scalingo) }
 
   describe "initialize" do
-    it "stores the scalingo client and the url" do
-      instance = described_class.new(:scalingo, :url)
+    let(:config) { {default_region: :test} }
 
-      expect(instance.scalingo).to eq(:scalingo)
-      expect(instance.url).to eq(:url)
+    describe "with only url" do
+      subject { described_class.new(:url) }
+
+      it "stores the url" do
+        expect(subject.url).to eq(:url)
+      end
+
+      it "uses itself as token holder" do
+        expect(subject.token_holder).to eq(subject)
+      end
+
+      it "configuration is the global one" do
+        expect(Scalingo::Configuration).to receive(:new).with({}, Scalingo.config).and_return(:config).once
+
+        expect(subject.config).to eq(:config)
+      end
+    end
+
+    describe "with scalingo client supplied" do
+      subject { described_class.new(:url, scalingo: scalingo) }
+
+      it "uses the scalingo client as token holder" do
+        expect(subject.token_holder).to eq(scalingo)
+      end
+
+      it "configuration is herited from the scalingo client" do
+        expect(Scalingo::Configuration).to receive(:new).with({}, scalingo.config).once
+
+        subject
+      end
+    end
+
+    describe "with config supplied" do
+      subject { described_class.new(:url, config: config) }
+
+      it "configuration is herited from the global one" do
+        expect(Scalingo::Configuration).to receive(:new).with(config, Scalingo.config).and_return(:config).once
+
+        expect(subject.config).to eq(:config)
+      end
+    end
+
+    describe "with both supplied" do
+      subject { described_class.new(:url, scalingo: scalingo, config: config) }
+
+      it "configuration is herited from the scalingo one" do
+        expect(Scalingo::Configuration).to receive(:new).with(config, scalingo.config).once
+
+        subject
+      end
     end
   end
 
@@ -26,7 +73,7 @@ RSpec.describe Scalingo::API::Client do
       mock = double
 
       described_class.register_handler!(:handler, mock)
-      instance = described_class.new(:scalingo, :url)
+      instance = described_class.new(:url, scalingo: scalingo)
 
       # Only 1 instanciation should be done, no matter how many calls are done below
       expect(mock).to receive(:new).with(instance).and_return("1st").once
@@ -55,20 +102,20 @@ RSpec.describe Scalingo::API::Client do
       proc { {"X-Another" => "another"} }
     }
 
-    it "only returns the user agent if nothing else is configured" do
-      expect(subject.headers).to eq("User-Agent" => user_agent)
+    it "only returns the user agent and accept if nothing else is configured" do
+      expect(subject.headers).to eq("Accept" => "application/json", "User-Agent" => user_agent)
     end
 
     it "allows additional headers to be globally configured" do
       expect(scalingo.config).to receive(:additional_headers).and_return(extra_hash)
 
-      expect(subject.headers).to eq("User-Agent" => user_agent, "X-Other" => "other")
+      expect(subject.headers).to eq("Accept" => "application/json", "User-Agent" => user_agent, "X-Other" => "other")
     end
 
     it "additional headers can be a block" do
       expect(scalingo.config).to receive(:additional_headers).and_return(extra_block)
 
-      expect(subject.headers).to eq("User-Agent" => user_agent, "X-Another" => "another")
+      expect(subject.headers).to eq("Accept" => "application/json", "User-Agent" => user_agent, "X-Another" => "another")
     end
   end
 
@@ -118,7 +165,7 @@ RSpec.describe Scalingo::API::Client do
 
     context "with bearer token" do
       it "has an authentication header set with a bearer scheme" do
-        expect(subject.connection.headers["Authorization"]).to eq "Bearer #{subject.scalingo.token.value}"
+        expect(subject.connection.headers["Authorization"]).to eq "Bearer #{subject.token_holder.token.value}"
       end
     end
   end