scalingo 3.0.0.beta.2 → 3.1.0

data/samples/regional/autoscalers/for-200.json

@@ -0,0 +1,41 @@
+{
+  "path": "/apps/example-running-application/autoscalers",
+  "method": "get",
+  "request": {
+    "headers": {
+      "Accept": "application/json",
+      "Authorization": "Bearer the-bearer-token"
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Date": "Fri, 28 Aug 2020 11:48:30 GMT",
+      "Etag": "W/\"78d382e1680bcf4d9ff9e58c906714ba\"",
+      "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": {
+      "autoscalers": [
+        {
+          "created_at": "2020-08-28T11:48:29.963Z",
+          "updated_at": "2020-08-28T11:48:29.963Z",
+          "id": "sc-5418fe67-885d-4e50-8cbe-9a9a2d2d690a",
+          "app_id": "5f48ecb6f112e2000ef34f14",
+          "container_type": "web",
+          "alert_id_scale_up": "al-ecf1cff6-c415-4e7b-8a86-e0ef697b2d87",
+          "alert_id_scale_down": "al-6ef726e8-d69b-44e1-8d67-3acef2a4802d",
+          "min_containers": 3,
+          "max_containers": 7,
+          "last_scale": "0001-01-01T00:00:00Z",
+          "disabled": false,
+          "metric": "rpm_per_container",
+          "target": 150
+        }
+      ]
+    }
+  }
+}

data/samples/regional/autoscalers/update-200.json

@@ -0,0 +1,45 @@
+{
+  "path": "/apps/example-running-application/autoscalers/sc-5418fe67-885d-4e50-8cbe-9a9a2d2d690a",
+  "method": "patch",
+  "request": {
+    "headers": {
+      "Accept": "application/json",
+      "Authorization": "Bearer the-bearer-token",
+      "Content-Type": "application/json"
+    },
+    "json_body": {
+      "autoscaler": {
+        "target": 200
+      }
+    }
+  },
+  "response": {
+    "status": 200,
+    "headers": {
+      "Date": "Fri, 28 Aug 2020 11:48:31 GMT",
+      "Etag": "W/\"f11b66f818316c26bb369e2e72009d4e\"",
+      "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": {
+      "autoscaler": {
+        "created_at": "2020-08-28T11:48:29.963Z",
+        "updated_at": "2020-08-28T11:48:31.56609493Z",
+        "id": "sc-5418fe67-885d-4e50-8cbe-9a9a2d2d690a",
+        "app_id": "5f48ecb6f112e2000ef34f14",
+        "container_type": "web",
+        "alert_id_scale_up": "al-ecf1cff6-c415-4e7b-8a86-e0ef697b2d87",
+        "alert_id_scale_down": "al-6ef726e8-d69b-44e1-8d67-3acef2a4802d",
+        "min_containers": 3,
+        "max_containers": 7,
+        "last_scale": "0001-01-01T00:00:00Z",
+        "disabled": false,
+        "metric": "rpm_per_container",
+        "target": 200
+      }
+    }
+  }
+}

data/samples/regional/autoscalers/update-404.json

@@ -0,0 +1,31 @@
+{
+  "path": "/apps/example-running-application/autoscalers/wrong-autoscaler-id",
+  "method": "patch",
+  "request": {
+    "headers": {
+      "Accept": "application/json",
+      "Authorization": "Bearer the-bearer-token",
+      "Content-Type": "application/json"
+    },
+    "json_body": {
+      "autoscaler": {
+        "target": 200
+      }
+    }
+  },
+  "response": {
+    "status": 404,
+    "headers": {
+      "Date": "Fri, 28 Aug 2020 11:48:30 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": "autoscaler",
+      "error": "not found"
+    }
+  }
+}

data/samples/regional/autoscalers/update-500.json

@@ -0,0 +1,30 @@
+{
+  "path": "/apps/example-running-application/autoscalers/sc-5418fe67-885d-4e50-8cbe-9a9a2d2d690a",
+  "method": "patch",
+  "request": {
+    "headers": {
+      "Accept": "application/json",
+      "Authorization": "Bearer the-bearer-token",
+      "Content-Type": "application/json"
+    },
+    "json_body": {
+      "autoscaler": {
+        "metric": "unknown"
+      }
+    }
+  },
+  "response": {
+    "status": 500,
+    "headers": {
+      "Date": "Fri, 28 Aug 2020 11:48:31 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": {
+      "error": "Internal error occured, we're on it!"
+    }
+  }
+}

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.
@@ -34,16 +34,16 @@ Gem::Specification.new do |s|
 
   s.test_files = Dir["spec/**/*_spec.rb"]
 
-  s.add_dependency "activesupport", [">= 5", "< 7"]
-  s.add_dependency "faraday", "~> 1.0.1"
-  s.add_dependency "faraday_middleware", "~> 1.0.0"
+  s.add_dependency "activesupport", [">= 5", "< 8"]
+  s.add_dependency "faraday", "~> 1.0"
+  s.add_dependency "faraday_middleware", "~> 1.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 "rubocop", "~> 0.83.0"
-  s.add_development_dependency "standard", "~> 0.4.2"
-  s.add_development_dependency "pry", "~> 0.13.1"
-  s.add_development_dependency "webmock", "~> 3.8.0"
+  s.add_development_dependency "standard", "~> 1.1.0"
+  s.add_development_dependency "rubocop-rspec"
+  s.add_development_dependency "pry", "~> 0.14.1"
+  s.add_development_dependency "webmock", "~> 3.12.2"
 end

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,17 +73,17 @@ 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
 
       # Not yet loaded...
-      expect(instance.instance_variable_get(:"@handler")).to eq(nil)
+      expect(instance.instance_variable_get(:@handler)).to eq(nil)
       instance.handler
 
       # Memoized...
-      expect(instance.instance_variable_get(:"@handler")).not_to eq(nil)
+      expect(instance.instance_variable_get(:@handler)).not_to eq(nil)
 
       # More calls won't try to perform more instanciations
       instance.handler
@@ -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

data/spec/scalingo/api/endpoint_spec.rb

@@ -21,10 +21,25 @@ RSpec.describe Scalingo::API::Endpoint do
   end
 
   describe "unpack" do
-    it "forwards unpack to Response" do
-      expect(Scalingo::API::Response).to receive(:unpack).with(client, :a, :b, :c).and_return(:d).once
+    it "forwards unpack to Response without keys" do
+      mock = proc { 1 }
 
-      expect(subject.send(:unpack, :a, :b, :c)).to eq :d
+      expect(Scalingo::API::Response).to receive(:unpack).with(client, keys: [], &mock).and_return(:d).once
+      expect(subject.send(:unpack, &mock)).to eq :d
+    end
+
+    it "forwards unpack to Response with a single key" do
+      mock = proc { 1 }
+
+      expect(Scalingo::API::Response).to receive(:unpack).with(client, keys: [:a], &mock).and_return(:d).once
+      expect(subject.send(:unpack, :a, &mock)).to eq :d
+    end
+
+    it "forwards unpack to Response with many keys" do
+      mock = proc { 1 }
+
+      expect(Scalingo::API::Response).to receive(:unpack).with(client, keys: [:a, :b], &mock).and_return(:d).once
+      expect(subject.send(:unpack, :a, :b, &mock)).to eq :d
     end
   end
 end

data/spec/scalingo/api/response_spec.rb

@@ -33,19 +33,19 @@ RSpec.describe Scalingo::API::Response do
     }
 
     it "passes the client supplied" do
-      object = described_class.unpack(:some_client, response)
+      object = described_class.unpack(:some_client) { response }
 
       expect(object.client).to eq :some_client
     end
 
     it "passes the response status" do
-      object = described_class.unpack(:client, response)
+      object = described_class.unpack(:client) { response }
 
       expect(object.status).to eq status
     end
 
     it "passes the response headers" do
-      object = described_class.unpack(:client, response)
+      object = described_class.unpack(:client) { response }
 
       expect(object.headers).to eq headers
     end
@@ -54,7 +54,7 @@ RSpec.describe Scalingo::API::Response do
       let(:body) { "" }
 
       it "without key" do
-        object = described_class.unpack(client, response)
+        object = described_class.unpack(client) { response }
 
         expect(object.data).to eq ""
         expect(object.full_body).to eq ""
@@ -62,7 +62,7 @@ RSpec.describe Scalingo::API::Response do
       end
 
       it "ignores key if supplied" do
-        object = described_class.unpack(client, response, key: :key)
+        object = described_class.unpack(client, key: :key) { response }
 
         expect(object.data).to eq ""
         expect(object.full_body).to eq ""
@@ -74,7 +74,7 @@ RSpec.describe Scalingo::API::Response do
       let(:body) { nil }
 
       it "without key" do
-        object = described_class.unpack(client, response)
+        object = described_class.unpack(client) { response }
 
         expect(object.data).to eq nil
         expect(object.full_body).to eq nil
@@ -82,7 +82,7 @@ RSpec.describe Scalingo::API::Response do
       end
 
       it "ignores key if supplied" do
-        object = described_class.unpack(client, response, key: :key)
+        object = described_class.unpack(client, key: :key) { response }
 
         expect(object.data).to eq nil
         expect(object.full_body).to eq nil
@@ -94,7 +94,7 @@ RSpec.describe Scalingo::API::Response do
       let(:body) { "this is a string body, probably due to an error" }
 
       it "without key" do
-        object = described_class.unpack(client, response)
+        object = described_class.unpack(client) { response }
 
         expect(object.data).to eq body
         expect(object.full_body).to eq body
@@ -102,7 +102,7 @@ RSpec.describe Scalingo::API::Response do
       end
 
       it "ignores key if supplied" do
-        object = described_class.unpack(client, response, key: :key)
+        object = described_class.unpack(client, key: :key) { response }
 
         expect(object.data).to eq body
         expect(object.full_body).to eq body
@@ -116,7 +116,7 @@ RSpec.describe Scalingo::API::Response do
       }
 
       it "without key" do
-        object = described_class.unpack(client, response)
+        object = described_class.unpack(client) { response }
 
         expect(object.data).to eq body
         expect(object.full_body).to eq body
@@ -124,7 +124,7 @@ RSpec.describe Scalingo::API::Response do
       end
 
       it "ignores key if supplied" do
-        object = described_class.unpack(client, response, key: :root)
+        object = described_class.unpack(client, key: :root) { response }
 
         expect(object.data).to eq body
         expect(object.full_body).to eq body
@@ -138,7 +138,7 @@ RSpec.describe Scalingo::API::Response do
       }
 
       it "without key" do
-        object = described_class.unpack(client, response)
+        object = described_class.unpack(client) { response }
 
         expect(object.data).to eq body
         expect(object.full_body).to eq body
@@ -146,7 +146,7 @@ RSpec.describe Scalingo::API::Response do
       end
 
       it "with valid key" do
-        object = described_class.unpack(client, response, key: :root)
+        object = described_class.unpack(client, key: :root) { response }
 
         expect(object.data).to eq({key: :value})
         expect(object.full_body).to eq body
@@ -154,7 +154,23 @@ RSpec.describe Scalingo::API::Response do
       end
 
       it "with invalid key" do
-        object = described_class.unpack(client, response, key: :other)
+        object = described_class.unpack(client, key: :other) { response }
+
+        expect(object.data).to eq nil
+        expect(object.full_body).to eq body
+        expect(object.meta).to eq nil
+      end
+
+      it "with valid keys" do
+        object = described_class.unpack(client, keys: [:root, :key]) { response }
+
+        expect(object.data).to eq(:value)
+        expect(object.full_body).to eq body
+        expect(object.meta).to eq nil
+      end
+
+      it "with invalid keys" do
+        object = described_class.unpack(client, keys: [:root, :other]) { response }
 
         expect(object.data).to eq nil
         expect(object.full_body).to eq body
@@ -167,7 +183,7 @@ RSpec.describe Scalingo::API::Response do
         }
 
         it "extracts the meta object" do
-          object = described_class.unpack(client, response)
+          object = described_class.unpack(client) { response }
 
           expect(object.meta).to eq({meta1: :value})
         end
@@ -179,7 +195,7 @@ RSpec.describe Scalingo::API::Response do
       let(:body) { {root: {key: :value}} }
 
       it "does not dig in the response hash, even with a valid key" do
-        object = described_class.unpack(client, response, key: :root)
+        object = described_class.unpack(client, key: :root) { response }
 
         expect(object.data).to eq body
         expect(object.full_body).to eq body

data/spec/scalingo/auth/user_spec.rb

@@ -22,4 +22,10 @@ RSpec.describe Scalingo::Auth::User do
       it_behaves_like "an unprocessable request"
     end
   end
+
+  describe_method "stop_free_trial" do
+    let(:stub_pattern) { "stop-free-trial" }
+
+    it_behaves_like "a successful response"
+  end
 end

data/spec/scalingo/auth_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 RSpec.describe Scalingo::Auth do
-  subject { described_class.new(:client, :url) }
+  subject { described_class.new("url") }
 
   %w[keys scm_integrations tokens two_factor_auth user].each do |section|
     it "handles requests for #{section}" do

data/spec/scalingo/billing_spec.rb

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

data/spec/scalingo/client_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe Scalingo::Client do
     context "with access token" do
       it "is successful with valid token" do
         fake_response = OpenStruct.new(
-          "successful?": true,
+          successful?: true,
           data: {token: "response token"},
         )
 
@@ -64,7 +64,7 @@ RSpec.describe Scalingo::Client do
 
       it "fails with invalid token" do
         fake_response = OpenStruct.new(
-          "successful?": false,
+          successful?: false,
         )
 
         expect(subject.auth.tokens).to receive(:exchange).and_return(fake_response)

data/spec/scalingo/configuration_spec.rb

@@ -3,36 +3,6 @@ require "spec_helper"
 RSpec.describe Scalingo::Configuration do
   subject { described_class.default }
 
-  describe "default_region" do
-    it "must be an existing region" do
-      expect {
-        subject.default_region = "another-region"
-      }.to raise_error(ArgumentError)
-    end
-  end
-
-  describe "regions" do
-    it "can be assigned from a hash" do
-      subject.regions = {
-        local_name: "some-url"
-      }
-
-      expect(subject.regions.local_name).to eq "some-url"
-    end
-
-    it "can be assigned from a openstruct" do
-      subject.regions = OpenStruct.new(local_name: "some-url")
-
-      expect(subject.regions.local_name).to eq "some-url"
-    end
-
-    it "raises with an argument from the wrong type" do
-      expect {
-        subject.regions = "1"
-      }.to raise_error(ArgumentError)
-    end
-  end
-
   describe "inheritance" do
     it "can inherit configuration from a parent" do
       object = described_class.new({}, subject)
@@ -52,4 +22,36 @@ RSpec.describe Scalingo::Configuration do
       expect(object.user_agent).to eq "Agent"
     end
   end
+
+  describe "faraday adapter" do
+    let(:scalingo) { Scalingo::Client.new(config).tap { |s| s.authenticate_with(bearer_token: "some-token") } }
+    let(:client) { Scalingo::API::Client.new("http://example.test", scalingo: scalingo) }
+
+    context "when unspecified" do
+      let(:config) { {} }
+
+      it "uses the default one when unspecificied" do
+        expect(client.authenticated_connection.adapter).to eq Faraday::Adapter::NetHttp
+        expect(client.unauthenticated_connection.adapter).to eq Faraday::Adapter::NetHttp
+      end
+    end
+
+    context "when set to an unkown adapter" do
+      let(:config) { {faraday_adapter: :yo} }
+
+      it "uses the default one when unspecificied" do
+        expect { client.authenticated_connection.adapter }.to raise_error(Faraday::Error)
+        expect { client.unauthenticated_connection.adapter }.to raise_error(Faraday::Error)
+      end
+    end
+
+    context "when set to a valid adapter" do
+      let(:config) { {faraday_adapter: :test} }
+
+      it "uses the default one when unspecificied" do
+        expect(client.authenticated_connection.adapter).to eq Faraday::Adapter::Test
+        expect(client.unauthenticated_connection.adapter).to eq Faraday::Adapter::Test
+      end
+    end
+  end
 end

data/spec/scalingo/regional/addons_spec.rb

@@ -99,6 +99,22 @@ RSpec.describe Scalingo::Regional::Addons do
     end
   end
 
+  describe_method "token" do
+    context "success" do
+      let(:arguments) { [meta[:app_id], meta[:id]] }
+      let(:stub_pattern) { "token-200" }
+
+      it_behaves_like "a singular object response"
+    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]] }