scalingo 3.0.0.beta.1 → 3.0.0.beta.2

data/lib/scalingo/client.rb

@@ -4,24 +4,33 @@ require "faraday_middleware"
 require "scalingo/bearer_token"
 require "scalingo/errors"
 require "scalingo/auth"
+require "scalingo/billing"
 require "scalingo/regional"
 
 module Scalingo
   class Client
     extend Forwardable
 
+    attr_reader :config
+
+    def initialize(attributes = {})
+      @config = Configuration.new(attributes, Scalingo.config)
+
+      define_regions!
+    end
+
     ## Authentication helpers / Token management
     attr_reader :token
 
     def token=(input)
-      @token = input.is_a?(BearerToken) ? input : BearerToken.new(input.to_s)
+      @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(access_token: nil, bearer_token: nil, expires_in: nil)
+    def authenticate_with(access_token: nil, bearer_token: nil, expires_at: nil)
       if !access_token && !bearer_token
         raise ArgumentError, "You must supply one of `access_token` or `bearer_token`"
       end
@@ -30,18 +39,19 @@ module Scalingo
         raise ArgumentError, "You cannot supply both `access_token` and `bearer_token`"
       end
 
-      if expires_in && !bearer_token
-        raise ArgumentError, "`expires_in` can only be used with `bearer_token`. `access_token` have a 1 hour expiration."
+      if expires_at && !bearer_token
+        raise ArgumentError, "`expires_at` can only be used with `bearer_token`. `access_token` have a 1 hour expiration."
       end
 
       if access_token
-        expiration = Time.now + Scalingo.config.exchanged_token_validity
+        expiration = Time.now + config.exchanged_token_validity
         response = auth.tokens.exchange(access_token)
 
         if response.successful?
           self.token = BearerToken.new(
             response.data[:token],
-            expires_in: expiration,
+            expires_at: expiration,
+            raise_on_expired: config.raise_on_expired_token,
           )
         end
 
@@ -49,35 +59,33 @@ module Scalingo
       end
 
       if bearer_token
-        self.token = expires_in ? BearerToken.new(bearer_token.to_s, expires_in: expires_in) : bearer_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: config.raise_on_expired_token,
+          )
+        else
+          bearer_token
+        end
+
+        true
       end
     end
 
     ## API clients
     def auth
-      @auth ||= Auth.new(self, Scalingo.config.urls.auth)
+      @auth ||= Auth.new(self, config.auth)
     end
 
-    def region
-      public_send(Scalingo.config.default_region)
+    def billing
+      @billing ||= Billing.new(self, config.billing)
     end
 
-    Scalingo.config.regions.each do |region|
-      if Scalingo.config.urls[region].blank?
-        raise ArgumentError, "Scalingo: no url configured for region #{region}"
-      end
-
-      define_method(region) do
-        region_client = instance_variable_get :"@#{region}"
-
-        unless region_client
-          region_client = Regional.new(self, Scalingo.config.urls[region])
-
-          instance_variable_set :"@#{region}", region_client
-        end
-
-        region_client
-      end
+    def region(name = nil)
+      public_send(name || config.default_region)
     end
 
     ## Delegations
@@ -101,5 +109,23 @@ module Scalingo
     def_delegator :region, :notifiers
     def_delegator :region, :operations
     def_delegator :region, :scm_repo_links
+
+    private
+
+    def define_regions!
+      config.regions.each_pair do |region, _|
+        define_singleton_method(region) do
+          region_client = instance_variable_get :"@#{region}"
+
+          unless region_client
+            region_client = Regional.new(self, config.regions.public_send(region))
+
+            instance_variable_set :"@#{region}", region_client
+          end
+
+          region_client
+        end
+      end
+    end
   end
 end

data/lib/scalingo/configuration.rb

@@ -0,0 +1,98 @@
+require "active_support/core_ext/numeric/time"
+require "scalingo/version"
+require "ostruct"
+
+module Scalingo
+  class Configuration
+    ATTRIBUTES = [
+      # URL to the authentication API
+      :auth,
+
+      # URL to the billing API
+      :billing,
+
+      # List of regions under the form {"region_id": root_url}
+      :regions,
+
+      # Default region. Must match a key in `regions`
+      :default_region,
+
+      # Wether to use https or http
+      :https,
+
+      # Configure the User Agent header
+      :user_agent,
+
+      # For how long is a bearer token considered valid (it will raise passed this delay).
+      # Set to nil to never raise.
+      :exchanged_token_validity,
+
+      # Raise an exception when trying to use an authenticated connection without a bearer token set
+      # Having this setting to true prevents performing requests that would fail due to lack of authentication headers.
+      :raise_on_missing_authentication,
+
+      # Raise an exception when the bearer token in use is supposed to be invalid
+      :raise_on_expired_token,
+
+      # These headers will be added to every request. Individual methods may override them.
+      # This should be a hash or a callable object that returns a hash.
+      :additional_headers
+    ]
+
+    ATTRIBUTES.each { |attr| attr_accessor(attr) }
+
+    def self.default
+      new(
+        auth: "https://auth.scalingo.com/v1",
+        billing: "https://cashmachine.scalingo.com",
+        regions: {
+          agora_fr1: "https://api.agora-fr1.scalingo.com/v1",
+          osc_fr1: "https://api.osc-fr1.scalingo.com/v1",
+          osc_secnum_fr1: "https://api.osc-secnum-fr1.scalingo.com/v1"
+        },
+        default_region: :osc_fr1,
+        user_agent: "Scalingo Ruby Client v#{Scalingo::VERSION}",
+        exchanged_token_validity: 1.hour,
+        raise_on_missing_authentication: true,
+        raise_on_expired_token: false,
+        additional_headers: {},
+      )
+    end
+
+    def initialize(attributes = {}, parent = nil)
+      ATTRIBUTES.each do |name|
+        public_send("#{name}=", attributes.fetch(name, parent&.public_send(name)))
+      end
+    end
+
+    def regions=(input)
+      if input.is_a?(OpenStruct)
+        @regions = input
+        return
+      end
+
+      if input.is_a?(Hash)
+        @regions = OpenStruct.new(input)
+        return
+      end
+
+      raise ArgumentError, "wrong type for argument"
+    end
+
+    def default_region=(input)
+      input = input.to_sym
+
+      raise ArgumentError, "No regions named `#{input}`" unless regions.respond_to?(input)
+
+      @default_region = input
+    end
+  end
+
+  def self.config
+    @config ||= Configuration.default
+  end
+
+  def self.configure
+    yield config
+  end
+end

data/lib/scalingo/regional/addons.rb

@@ -83,7 +83,7 @@ module Scalingo
     def categories(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "addon_categories",
         data,
         headers,
@@ -96,7 +96,7 @@ module Scalingo
     def providers(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "addon_providers",
         data,
         headers,

data/lib/scalingo/regional/containers.rb

@@ -44,7 +44,7 @@ module Scalingo
     def sizes(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "features/container_sizes",
         data,
         headers,

data/lib/scalingo/regional/events.rb

@@ -29,7 +29,7 @@ module Scalingo
     def types(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "event_types",
         data,
         headers,
@@ -42,7 +42,7 @@ module Scalingo
     def categories(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "event_categories",
         data,
         headers,

data/lib/scalingo/regional/logs.rb

@@ -3,7 +3,7 @@ module Scalingo
     def get(url, payload = {}, headers = nil, &block)
       data = payload.compact
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         url,
         data,
         headers,

data/lib/scalingo/regional/metrics.rb

@@ -28,7 +28,7 @@ module Scalingo
     def types(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "features/metrics",
         data,
         headers,

data/lib/scalingo/regional/notifiers.rb

@@ -83,7 +83,7 @@ module Scalingo
     def platforms(headers = nil, &block)
       data = nil
 
-      response = connection(allow_guest: true).get(
+      response = connection(fallback_to_guest: true).get(
         "notification_platforms",
         data,
         headers,

data/lib/scalingo/regional/operations.rb

@@ -3,10 +3,18 @@ require "scalingo/api/endpoint"
 module Scalingo
   class Regional::Operations < API::Endpoint
     def find(app_id, operation_id, headers = nil, &block)
+      get(
+        "apps/#{app_id}/operations/#{operation_id}",
+        headers,
+        &block
+      )
+    end
+
+    def get(url, headers = nil, &block)
       data = nil
 
       response = connection.get(
-        "apps/#{app_id}/operations/#{operation_id}",
+        url,
         data,
         headers,
         &block

data/lib/scalingo/version.rb

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

data/samples/billing/profile/_meta.json

@@ -0,0 +1,23 @@
+{
+  "id": "882d7733-923b-40dc-88e6-f1324e48c42a",
+  "create": {
+    "valid": {
+      "name": "Billing profile",
+      "address_line1": "1, rue de la paix",
+      "address_zip": "75001",
+      "address_city": "Paris",
+      "address_country": "France"
+    },
+    "invalid": {
+      "some": "attribute"
+    }
+  },
+  "update": {
+    "valid": {
+      "address_city": "New Somecity"
+    },
+    "invalid": {
+      "address_country": "not a country"
+    }
+  }
+}

data/samples/billing/profile/create-201.json

@@ -0,0 +1,50 @@
+{
+  "path": "/profiles",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token",
+      "Content-Type": "application/json"
+    },
+    "json_body": {
+      "profile": {
+        "name": "Billing profile",
+        "address_line1": "1, rue de la paix",
+        "address_zip": "75001",
+        "address_city": "Paris",
+        "address_country": "France"
+      }
+    }
+  },
+  "response": {
+    "status": 201,
+    "headers": {
+      "Date": "Fri, 12 Jun 2020 15:46:11 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "no-cache"
+    },
+    "json_body": {
+      "profile": {
+        "id": "882d7733-923b-40dc-88e6-f1324e48c42a",
+        "name": "Billing profile",
+        "email": null,
+        "address_line1": "1, rue de la paix",
+        "address_line2": null,
+        "address_city": "Paris",
+        "balance": 0,
+        "address_zip": "75001",
+        "address_state": null,
+        "address_country": "FR",
+        "vat_number": null,
+        "company": null,
+        "payment_method": "sepa",
+        "created_at": "2020-05-29T13:01:46.217Z",
+        "updated_at": "2020-06-12T15:45:43.535Z",
+        "credit": 0,
+        "stripe_payment_method": null
+      }
+    }
+  }
+}

data/samples/billing/profile/create-400.json

@@ -0,0 +1,27 @@
+{
+  "path": "/profiles",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token",
+      "Content-Type": "application/json"
+    },
+    "json_body": {
+      "profile": {
+      }
+    }
+  },
+  "response": {
+    "status": 400,
+    "headers": {
+      "Date": "Fri, 12 Jun 2020 15:46:10 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "no-cache"
+    },
+    "json_body": {
+      "error": "profile is required"
+    }
+  }
+}

data/samples/billing/profile/create-422.json

@@ -0,0 +1,44 @@
+{
+  "path": "/profiles",
+  "method": "post",
+  "request": {
+    "headers": {
+      "Authorization": "Bearer the-bearer-token",
+      "Content-Type": "application/json"
+    },
+    "json_body": {
+      "profile": {
+        "some": "attribute"
+      }
+    }
+  },
+  "response": {
+    "status": 422,
+    "headers": {
+      "Date": "Fri, 12 Jun 2020 15:46:11 GMT",
+      "Content-Type": "application/json; charset=utf-8",
+      "Transfer-Encoding": "chunked",
+      "Connection": "keep-alive",
+      "Cache-Control": "no-cache"
+    },
+    "json_body": {
+      "errors": {
+        "name": [
+          "can't be blank"
+        ],
+        "address_line1": [
+          "can't be blank"
+        ],
+        "address_zip": [
+          "can't be blank"
+        ],
+        "address_city": [
+          "can't be blank"
+        ],
+        "address_country": [
+          "can't be blank"
+        ]
+      }
+    }
+  }
+}