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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6582ca860b783b598a3f31874afc37958ead26c29c17c099e6cba1ef094f933d
-  data.tar.gz: c0206b25118775599be97e0c6a7ef06c40914a34711c882a21268521f964ae24
+  metadata.gz: b8b0dc7d7cdf0153981710c5892540959c678f74a1a563f1f4c116e2727ef84c
+  data.tar.gz: 42d6d9577d47d7c34470471a9e30a1cccd1509611fefd5e68cb9da730d2607c1
 SHA512:
-  metadata.gz: 1e7e41bb52927a17d3de0c840f281754ee1907a000db36735ec779d5115a345f91bf944aad068421e9292fcb3ab9f92db49690a25e61f4f81cd8ff45c625f550
-  data.tar.gz: e2ebc1468f18304b3086ad927db4e89f09ef1d6256395a6f72a089776eeba8643b923bec88af1690f0264786dd46d6982b421f741b99f23a86ec513a3841fba9
+  metadata.gz: 7912d747ee122a34cd73be6f4a143c31f8a3e0e23c4f903a630c7b18fc157075d84ebb47545a5853e804ce9d4fd389e966277aff7bc67445ea348fd0d5661ede
+  data.tar.gz: 5099227b25fc7e8e5453dbe2919d14fc003da860864bc20464fa91b3d81cec7d46cdd78639e9988c5c6c6d0102746603bdba3f3f4d4c9d2e98d13841b1df7259

data/.rubocop.yml

@@ -11,6 +11,14 @@ 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,16 @@
 ## Unreleased
 
+## 3.0.0.beta.3 - 2020/08/15
+
+* Change: Requests have the header `Accept: application/json` by default
+* Private API Change: `unpack` signature
+* Change: allow api clients standalone use (without a main scalingo client)
+* Change: remove regions-related configuration, except for the default region
+* Bugfix: remove `https` configuration option (development artifact) (#20)
+* Improv: configure the faraday adapter to use (#20)
+* Improv: prettier `inspect` for common objects (#20)
+* New: Add `addons#token` endpoint (#20)
+
 ## 3.0.0.beta.2 - 2020/06/18
 
 * Bugfix: do not "dig" into the response body if it is not a 2XX (#18, #19)

data/README.md

@@ -63,20 +63,7 @@ changing the configuration globally will therefore not affect already existing o
 
 ```ruby
 Scalingo.configure do |config|
-  # Authentication API url
-  config.auth = "https://auth.scalingo.com/v1"
-
-  # Billing API url
-  config.billing = "https://cashmachine.scalingo.com"
-
-  # Known regions and their api's url
-  config.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. Must match an entry in `regions`
+  # Default region. Must be a supported region (agora_fr1, osc_fr1, osc_secnum_fr1)
   config.default_region = :osc_fr1
 
   # Configure the User Agent header
@@ -95,6 +82,9 @@ Scalingo.configure do |config|
   # 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.
   config.additional_headers = {}
+
+  # Specify an adapter for faraday. Leave nil for the default one (Net::HTTP)
+  config.faraday_adapter = nil
 end
 ```
 

data/lib/scalingo/api/client.rb

@@ -1,11 +1,24 @@
+require "scalingo/token_holder"
+
 module Scalingo
   module API
     class Client
-      attr_reader :scalingo, :url
+      include TokenHolder
+
+      attr_reader :config, :token_holder, :url
 
-      def initialize(scalingo, url)
-        @scalingo = scalingo
+      def initialize(url, scalingo: nil, config: {})
         @url = url
+        parent_config = Scalingo.config
+
+        if scalingo
+          @token_holder = scalingo
+          parent_config = scalingo.config
+        else
+          @token_holder = self
+        end
+
+        @config = Configuration.new(config, parent_config)
       end
 
       def self.register_handlers!(handlers)
@@ -27,13 +40,24 @@ module Scalingo
         end
       end
 
+      def inspect
+        str = %(<#{self.class}:0x#{object_id.to_s(16)} url:"#{@url}" methods:)
+
+        methods = self.class.instance_methods - Scalingo::API::Client.instance_methods
+        str << methods.to_s
+
+        str << ">"
+        str
+      end
+
       ## Faraday objects
       def headers
         hash = {
-          "User-Agent" => scalingo.config.user_agent
+          "User-Agent" => config.user_agent,
+          "Accept" => "application/json",
         }
 
-        if (extra = scalingo.config.additional_headers).present?
+        if (extra = config.additional_headers).present?
           extra.respond_to?(:call) ? hash.update(extra.call) : hash.update(extra)
         end
 
@@ -43,7 +67,7 @@ module Scalingo
       def connection_options
         {
           url: url,
-          headers: headers
+          headers: headers,
         }
       end
 
@@ -66,6 +90,8 @@ module Scalingo
         @unauthenticated_conn ||= Faraday.new(connection_options) { |conn|
           conn.response :json, content_type: /\bjson$/, parser_options: {symbolize_names: true}
           conn.request :json
+
+          conn.adapter(config.faraday_adapter) if config.faraday_adapter
         }
       end
 
@@ -73,8 +99,8 @@ module Scalingo
         return @connection if @connection
 
         # Missing token handling. Token expiration is handled in the `value` method.
-        unless scalingo.token&.value
-          if scalingo.config.raise_on_missing_authentication
+        unless token_holder.token&.value
+          if config.raise_on_missing_authentication
             raise Error::Unauthenticated
           else
             return unauthenticated_connection
@@ -85,10 +111,12 @@ module Scalingo
           conn.response :json, content_type: /\bjson$/, parser_options: {symbolize_names: true}
           conn.request :json
 
-          if scalingo.token&.value
-            auth_header = Faraday::Request::Authorization.header "Bearer", scalingo.token.value
+          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.adapter(config.faraday_adapter) if config.faraday_adapter
         }
       end
     end

data/lib/scalingo/api/endpoint.rb

@@ -13,10 +13,20 @@ module Scalingo
 
       def_delegator :client, :connection
 
+      def inspect
+        str = %(<#{self.class}:0x#{object_id.to_s(16)} base_url:"#{@client.url}" endpoints:)
+
+        methods = self.class.instance_methods - Scalingo::API::Endpoint.instance_methods
+
+        str << methods.to_s
+        str << ">"
+        str
+      end
+
       private
 
-      def unpack(*args)
-        Response.unpack(client, *args)
+      def unpack(key = nil, &block)
+        Response.unpack(client, key: key, &block)
       end
     end
   end

data/lib/scalingo/api/response.rb

@@ -1,7 +1,9 @@
 module Scalingo
   module API
     class Response
-      def self.unpack(client, response, key: nil)
+      def self.unpack(client, key: nil, &block)
+        response = block.call
+
         body = response.body
         has_hash_body = body.present? && body.respond_to?(:key)
 
@@ -34,6 +36,10 @@ module Scalingo
         @meta = meta
       end
 
+      def inspect
+        %(<#{self.class}:0x#{object_id.to_s(16)} status:#{@status} data:#{@data} meta:#{@meta}>)
+      end
+
       def successful?
         status >= 200 && status < 300
       end

data/lib/scalingo/auth/keys.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :keys)
+      unpack(:keys) { response }
     end
 
     def show(id, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :key)
+      unpack(:key) { response }
     end
 
     def create(payload, headers = nil, &block)
@@ -38,7 +38,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :key)
+      unpack(:key) { response }
     end
 
     def destroy(id, headers = nil, &block)
@@ -50,7 +50,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
   end
 end

data/lib/scalingo/auth/scm_integrations.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_integrations)
+      unpack(:scm_integrations) { response }
     end
 
     def show(id, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_integration)
+      unpack(:scm_integration) { response }
     end
 
     def create(payload, headers = nil, &block)
@@ -38,7 +38,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :scm_integration)
+      unpack(:scm_integration) { response }
     end
 
     def destroy(id, headers = nil, &block)
@@ -51,7 +51,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
   end
 end

data/lib/scalingo/auth/tokens.rb

@@ -8,7 +8,7 @@ module Scalingo
       authorization = Faraday::Request::BasicAuthentication.header("", token)
 
       request_headers = {
-        Faraday::Request::Authorization::KEY => authorization
+        Faraday::Request::Authorization::KEY => authorization,
       }
 
       request_headers.update(headers) if headers
@@ -20,7 +20,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
 
     def all(headers = nil, &block)
@@ -33,7 +33,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :tokens)
+      unpack(:tokens) { response }
     end
 
     def create(payload, headers = nil, &block)
@@ -46,7 +46,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :token)
+      unpack(:token) { response }
     end
 
     def renew(id, headers = nil, &block)
@@ -59,7 +59,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :token)
+      unpack(:token) { response }
     end
 
     def destroy(id, headers = nil, &block)
@@ -72,7 +72,7 @@ module Scalingo
         &block
       )
 
-      unpack(response)
+      unpack { response }
     end
   end
 end

data/lib/scalingo/auth/two_factor_auth.rb

@@ -16,7 +16,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :tfa)
+      unpack(:tfa) { response }
     end
 
     def initiate(provider = DEFAULT_PROVIDER, headers = nil, &block)
@@ -29,7 +29,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :tfa)
+      unpack(:tfa) { response }
     end
 
     def validate(attempt, headers = nil, &block)
@@ -42,7 +42,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :tfa)
+      unpack(:tfa) { response }
     end
 
     def disable(headers = nil, &block)
@@ -55,7 +55,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :tfa)
+      unpack(:tfa) { response }
     end
   end
 end

data/lib/scalingo/auth/user.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :user)
+      unpack(:user) { response }
     end
 
     def update(payload, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :user)
+      unpack(:user) { response }
     end
   end
 end

data/lib/scalingo/bearer_token.rb

@@ -9,6 +9,21 @@ module Scalingo
       @raise_on_expired = raise_on_expired
     end
 
+    def inspect
+      str = "<#{self.class}:0x#{object_id.to_s(16)} "
+
+      str << if expired?
+        "(expired) "
+      elsif expires_at.present?
+        "expires_at: #{expires_at} "
+      else
+        "(no expiration) "
+      end
+
+      str << %(value:"#{value}">)
+      str
+    end
+
     def raise_on_expired?
       @raise_on_expired
     end

data/lib/scalingo/billing/profile.rb

@@ -12,7 +12,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :profile)
+      unpack(:profile) { response }
     end
 
     def create(payload = {}, headers = nil, &block)
@@ -25,7 +25,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :profile)
+      unpack(:profile) { response }
     end
 
     def update(id, payload = {}, headers = nil, &block)
@@ -38,7 +38,7 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :profile)
+      unpack(:profile) { response }
     end
 
     alias_method :self, :show

data/lib/scalingo/client.rb

@@ -1,131 +1,44 @@
-require "forwardable"
-require "faraday"
-require "faraday_middleware"
-require "scalingo/bearer_token"
-require "scalingo/errors"
+require "scalingo/core_client"
 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, 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_at: nil)
-      if !access_token && !bearer_token
-        raise ArgumentError, "You must supply one of `access_token` or `bearer_token`"
-      end
-
-      if access_token && bearer_token
-        raise ArgumentError, "You cannot supply both `access_token` and `bearer_token`"
-      end
-
-      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 + config.exchanged_token_validity
-        response = auth.tokens.exchange(access_token)
-
-        if response.successful?
-          self.token = BearerToken.new(
-            response.data[:token],
-            expires_at: expiration,
-            raise_on_expired: config.raise_on_expired_token,
-          )
-        end
-
-        return response.successful?
-      end
-
-      if 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
-
+  class Client < CoreClient
     ## API clients
     def auth
-      @auth ||= Auth.new(self, config.auth)
+      @auth ||= Auth.new(
+        "https://auth.scalingo.com/v1",
+        scalingo: self,
+      )
     end
 
     def billing
-      @billing ||= Billing.new(self, config.billing)
+      @billing ||= Billing.new(
+        "https://cashmachine.scalingo.com",
+        scalingo: self,
+      )
     end
 
-    def region(name = nil)
-      public_send(name || config.default_region)
+    def agora_fr1
+      @agora_fr1 ||= Regional.new(
+        "https://api.agora-fr1.scalingo.com/v1",
+        scalingo: self,
+      )
     end
 
-    ## Delegations
-    def_delegator :auth, :keys
-    def_delegator :auth, :scm_integrations
-    def_delegator :auth, :tokens
-    def_delegator :auth, :two_factor_auth
-    def_delegator :auth, :tfa
-    def_delegator :auth, :user
-
-    def_delegator :region, :addons
-    def_delegator :region, :apps
-    def_delegator :region, :collaborators
-    def_delegator :region, :containers
-    def_delegator :region, :deployments
-    def_delegator :region, :domains
-    def_delegator :region, :environment
-    def_delegator :region, :events
-    def_delegator :region, :logs
-    def_delegator :region, :metrics
-    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
+    def osc_fr1
+      @osc_fr1 ||= Regional.new(
+        "https://api.osc-fr1.scalingo.com/v1",
+        scalingo: self,
+      )
+    end
 
-          region_client
-        end
-      end
+    def osc_secnum_fr1
+      @osc_secnum_fr1 ||= Regional.new(
+        "https://api.osc-secnum-fr1.scalingo.com/v1",
+        scalingo: self,
+      )
     end
   end
 end