scalingo-ruby-api 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b675815e2e7ddd2cec118d6a5fcd090feec9a4ffeb396e681aa4e40c7eb01da
-  data.tar.gz: f7d3d4a8a902e1cec4f94d83b68a023f36bc5d2138950e16a6215f85bf28d498
+  metadata.gz: 9cac65a8cb02d5c36c8a21f1079f5da30a22499183f4df5f5c218c0f31df8362
+  data.tar.gz: f5d702234ea4b5c2f13ac430f945dcc1e66986258a56526a8ae0167a3fa9e55b
 SHA512:
-  metadata.gz: 4fa502142904cc808b139bf7d2d49cdb84216aede098f9f76f1f92ff39dc8a1c69f3d60c9ba6d550c18b61fcd715e8226be30127f099c338a35422d8604ecfce
-  data.tar.gz: 74c516c26bd5a82a251e2dc733b0d21d3868d19f0c1d1632e327fad63291662ed392a81636df4150254ffd8af409392aaf64c43189f7a5f4ff7113f8b3e07389
+  metadata.gz: d47763e0fb6b43781cdeaccda286a666efdc5240671889b2a1a7c152c2a32b5512685eacf945b2e0f3787ec64dd814b785c16d42c49ebc546d830b8dda69e26a
+  data.tar.gz: 56a4f6d9996a71d2d1b2ca43fd1bd9948d0e90559ec9415d2e0d4b426f86087926fd3f9bda21c90fef55be014ce31ff9555504512779ed9cec918d37c10bd7d6

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## 2.0.0 - 2019/12/05
+
+* Compatibility with new API tokens
+* Compatibility with multi-region infrastructure
+* Add missing resources: `regions`, `autoscalers`, `notifiers`, `alerts`
+
+## 1.1.1 - 2019/01/08
+
+* Update metadata on rubygems
+
+## 1.1.0 - 2019/01/08
+
+* Add /apps/:id/containers and /apps/:id/stats endpoints
+
+## 1.0.0 - 2017/24/01
+
+* First tag 1.0.0, API won't be broken
+
+## 1.0.0.alpha1
+
+* Initial alpha release

data/README.md

@@ -0,0 +1,90 @@
+# Scalingo-ruby-api
+
+A ruby wrapper for the Scalingo API
+
+## Installation
+
+```ruby
+gem 'scalingo-ruby-api', '~> 2'
+```
+
+And then execute:
+
+```
+bundle
+```
+
+Or install it yourself as:
+
+```
+gem install scalingo-ruby-api
+```
+
+## Usage
+
+### Global configuration
+
+```ruby
+require 'scalingo'
+
+Scalingo.token = 'tk-your-token'
+Scalingo.region = 'osc-fr1'
+
+# Or
+
+Scalingo.configure do |config|
+  config.token = 'tk-your-token'
+  config.region = 'osc-fr1'
+end
+
+client = Scalingo::Client.new
+```
+
+### Client configuration
+
+```ruby
+client = Scalingo::Client.new(region: 'osc-fr1', token: 'tk-your-token')
+
+# Or both can be combined
+
+Scalingo.token = 'tk-your-token'
+
+client_region1 = Scalingo::Client.new(region: 'osc-fr1')
+client_region2 = Scalingo::Client.new(region: 'agora-fr1')
+```
+
+### Examples
+
+```ruby
+# Get all apps
+apps = client.apps.all
+
+# Get logs of one app
+app = client.apps.find('my-app')
+puts app.logs.dump
+```
+
+### Notes
+
+Client contains a cache with the regions endpoints and the current valid bearer
+token used for authentication.
+
+If a lot of calls are done and to avoid making useless requests and slowing
+down your queries, it is encouraged to re-use your client.
+
+## Hacking
+
+Using another authentication endpoint for hacking is possible through
+
+```
+client = Scalingo::Client.new(auth_endpoint: 'http://172.17.0.1:1234/v1', region: 'local')
+apps = client.apps.all
+```
+
+## Special Thanks
+
+To aki017 who made [slack-ruby-gem](http://github.com/aki017/slack-ruby-gem).
+
+It was used as an inspirational source for this project.
+
+Thanks [Aethelflaed](https://github.com/Aethelflaed) for the original implementation of this gem

data/lib/scalingo.rb

@@ -14,11 +14,6 @@ module Scalingo
     Scalingo::Client.new(options)
   end
 
-  def self.method_missing(method, *args, &block)
-    return super unless client.respond_to?(method)
-    client.send(method, *args, &block)
-  end
-
   def self.respond_to?(method)
     return client.respond_to?(method) || super
   end

data/lib/scalingo/api.rb

@@ -1,7 +1,9 @@
 require_relative 'connection'
+require_relative 'jwt'
 require_relative 'request'
 require_relative 'configuration'
 require_relative 'endpoint'
+require_relative 'regions_cache'
 
 module Scalingo
   class Api
@@ -15,8 +17,10 @@ module Scalingo
     end
 
     include Connection
+    include JWT
     include Request
     include Endpoint
+    include RegionsCache
   end
 end
 

data/lib/scalingo/configuration.rb

@@ -9,9 +9,10 @@ module Scalingo
       :adapter,
       :token,
       :endpoint,
+      :auth_endpoint,
+      :region,
       :user_agent,
       :proxy,
-      :parse_json,
     ].freeze
 
     # The adapter that will be used to connect if none is set
@@ -22,10 +23,8 @@ module Scalingo
     # By default, don't set an token
     DEFAULT_TOKEN = nil
 
-    # The endpoint that will be used to connect if none is set
-    #
-    # @note There is no reason to use any other endpoint at this time
-    DEFAULT_ENDPOINT = 'https://api.scalingo.com/v1/'.freeze
+    # The endpoint to exchange the token with a JWT
+    DEFAULT_AUTH_ENDPOINT = 'https://auth.scalingo.com/v1'.freeze
 
     # By default, don't use a proxy server
     DEFAULT_PROXY = nil
@@ -33,9 +32,6 @@ module Scalingo
     # The user agent that will be sent to the Api endpoint if none is set
     DEFAULT_USER_AGENT = "Scalingo Ruby Gem #{Scalingo::VERSION}".freeze
 
-    # Parse json by default, only changed when getting text result (e.g. Logs)
-    DEFAULT_PARSE_JSON = true
-
     # @private
     attr_accessor *VALID_OPTIONS_KEYS
 
@@ -58,12 +54,13 @@ module Scalingo
 
     # Reset all configuration options to defaults
     def reset
-      self.adapter    = DEFAULT_ADAPTER
-      self.token      = DEFAULT_TOKEN
-      self.endpoint   = DEFAULT_ENDPOINT
-      self.user_agent = DEFAULT_USER_AGENT
-      self.proxy      = DEFAULT_PROXY
-      self.parse_json = DEFAULT_PARSE_JSON
+      self.adapter       = DEFAULT_ADAPTER
+      self.token         = DEFAULT_TOKEN
+      self.endpoint      = nil
+      self.auth_endpoint = DEFAULT_AUTH_ENDPOINT
+      self.region        = nil
+      self.user_agent    = DEFAULT_USER_AGENT
+      self.proxy         = DEFAULT_PROXY
     end
   end
 end

data/lib/scalingo/connection.rb

@@ -1,31 +1,32 @@
 require 'faraday_middleware'
-Dir[File.expand_path('../../faraday/*.rb', __FILE__)].each{|f| require f}
+Dir[File.expand_path('../faraday/*.rb', __dir__)].each { |f| require f }
 
 module Scalingo
   module Connection
     private
-    def connection
-      raise MissingToken.new if !token
 
-      options = {
-        :headers => {
-          'Accept' => 'application/json; charset=utf-8',
-          'Content-Type' => 'application/json',
-          'User-Agent' => user_agent,
-        },
-        :proxy => proxy,
-        :url => endpoint,
-      }
+    def build_connection(opts = {})
+      raise MissingToken if !token
 
-      Faraday::Connection.new(options) do |connection|
+      Faraday::Connection.new(connection_options) do |connection|
         connection.use Faraday::Request::Multipart
         connection.use Faraday::Request::UrlEncoded
-        connection.use Faraday::Response::ParseJson if parse_json
         connection.use FaradayMiddleware::RaiseHttpException
+        connection.response :json, :content_type => /\bjson$/
         connection.adapter(adapter)
-        connection.basic_auth('', token)
       end
     end
+
+    def connection_options
+      return {
+        headers: {
+          'Accept' => 'application/json; charset=utf-8',
+          'Content-Type' => 'application/json',
+          'User-Agent' => user_agent,
+        },
+        proxy: proxy,
+      }
+    end
   end
 end
 

data/lib/scalingo/endpoint.rb

@@ -9,8 +9,13 @@ module Scalingo
     module ClassMethods
       def resources(name, opts = {})
         name = name.to_s
+
+        endpoint_opts = { auth_api: opts[:auth_api] }
+
         define_method(name.pluralize.underscore) do
-          Scalingo::Endpoint.const_get(name.pluralize.camelize).new(self)
+          Scalingo::Endpoint.const_get(
+            name.pluralize.camelize,
+          ).new(self, nil, endpoint_opts)
         end
 
         return if opts[:collection_only]
@@ -23,22 +28,28 @@ module Scalingo
 
     extend ClassMethods
     resources :apps
-    resources :account_keys
+    resources :account_keys,     auth_api: true
     resources :addon_providers,  collection_only: true
     resources :addon_categories, collection_only: true
+    resources :regions,          collection_only: true, auth_api: true
 
     module Base
       attr_accessor :api
       attr_accessor :prefix
+      attr_accessor :auth_api
 
-      def initialize(api, prefix = nil)
+      def initialize(api, prefix = nil, opts = {})
         self.api = api
+        self.auth_api = opts.fetch(:auth_api, false)
         self.prefix = prefix || self.class.name.split('::').last.underscore.pluralize
       end
 
       Request::REQUEST_METHODS.each do |method|
         define_method(method) do |path = nil, options = {}|
-          api.send(method, "#{prefix}/#{path}", options)
+          req_path = prefix
+          req_path += "/#{path}" if !path.nil? && path != ''
+          options.merge!(auth_api: auth_api) if auth_api
+          api.send(method, req_path, options)
         end
       end
     end
@@ -47,8 +58,8 @@ module Scalingo
       include Base
       include Endpoint
 
-      def initialize(api, prefix, data = {})
-        Base.instance_method(:initialize).bind(self).call(api, prefix)
+      def initialize(api, prefix, opts = {}, data = {})
+        Base.instance_method(:initialize).bind(self).call(api, prefix, opts)
         OpenStruct.instance_method(:initialize).bind(self).call(data)
       end
     end
@@ -59,16 +70,16 @@ module Scalingo
       include Enumerable
 
       def all
-        get[collection_name].map{|r| resource_class.new(self, r[find_by], r)}
+        get[collection_name].map { |r| resource_class.new(self, r[find_by], {}, r) }
       end
-      alias_method :to_a, :all
+      alias to_a all
 
       def each
         block_given? ? all.each(&Proc.new) : all.each
       end
 
       def find(id)
-        detect{|r| r[find_by] == id}
+        detect { |r| r[find_by] == id }
       end
 
       def collection_name

data/lib/scalingo/endpoint/account_keys.rb

@@ -1,8 +1,8 @@
 module Scalingo
   module Endpoint
     class AccountKeys < Collection
-      def initialize(api)
-        super(api, 'account/keys')
+      def initialize(api, _, opts = {})
+        super(api, 'keys', opts)
       end
 
       def collection_name
@@ -10,7 +10,7 @@ module Scalingo
       end
 
       def create(name, content)
-        post(nil, {key: {name: name, content: content}})
+        post(nil, key: { name: name, content: content })
       end
     end
     class AccountKey < Resource
@@ -20,4 +20,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/addon_categories.rb

@@ -4,4 +4,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/addon_provider.rb

@@ -4,4 +4,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/addons.rb

@@ -2,12 +2,12 @@ module Scalingo
   module Endpoint
     class Addons < Collection
       def create(addon_provider_id, plan_id)
-        post(nil, {addon:{addon_provider_id: addon_provider_id, plan_id: plan_id}})
+        post(nil, addon: { addon_provider_id: addon_provider_id, plan_id: plan_id })
       end
     end
     class Addon < Resource
       def update(plan_id)
-        patch(nil, {addon: {plan_id: plan_id}})
+        patch(nil, addon: { plan_id: plan_id })
       end
 
       def destroy
@@ -16,4 +16,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/alerts.rb

@@ -0,0 +1,25 @@
+module Scalingo
+  module Endpoint
+    # - container_type: can be any container type of an application (e.g. web, clock…)
+    # - limit: Any float value. For any resource consumption, please provide 0.1 if you need to be alerted when the consumption goes above 10%.
+    # - metric: e.g. RPM per container, RAM consumption…
+    # - notifiers: list of notifier ID that will receive the alerts (optional)
+    # - send_when_below: will the alert be sent when the value goes above or below the limit (optional)
+    # - duration_before_trigger: the alert is triggered if the value is above the limit for the specified duration. Duration is expressed in nanoseconds. (optional)
+    # - remind_every: send the alert at regular interval when activated (optional)
+    class Alerts < Collection
+      def create(params)
+        post(nil, alert: params)
+      end
+    end
+    class Alert < Resource
+      def update(params)
+        patch(nil, alert: params)
+      end
+
+      def destroy
+        delete
+      end
+    end
+  end
+end

data/lib/scalingo/endpoint/apps.rb

@@ -2,7 +2,7 @@ module Scalingo
   module Endpoint
     class Apps < Collection
       def create(name)
-        post(nil, {app: {name: name}})
+        post(nil, app: { name: name })
       end
 
       def find_by
@@ -11,15 +11,15 @@ module Scalingo
     end
     class App < Resource
       def scale(containers)
-        post('scale', {containers: containers})
+        post('scale', containers: containers)
       end
 
       def restart(*scopes)
-        post('restart', {scope: scopes})
+        post('restart', scope: scopes)
       end
 
       def destroy(current_name)
-        delete(nil, {current_name: current_name})
+        delete(nil, current_name: current_name)
       end
 
       def destroy!
@@ -27,14 +27,15 @@ module Scalingo
       end
 
       def rename(new_name, current_name)
-        post('rename', {new_name: new_name, current_name: current_name})
+        post('rename', new_name: new_name, current_name: current_name)
       end
+
       def rename!(new_name)
         rename(new_name, prefix)
       end
 
       def transfer(email)
-        patch(nil, {app: {owner: {email: email}}})
+        patch(nil, app: { owner: { email: email } })
       end
 
       def logs_url
@@ -46,7 +47,7 @@ module Scalingo
       end
 
       def run(command, env = {})
-        post('run', {command: command, env: env})
+        post('run', command: command, env: env)
       end
 
       resources :addons
@@ -56,8 +57,10 @@ module Scalingo
       resources :domains
       resources :stats
       resources :variables
+      resources :notifiers
+      resources :alerts
+      resources :autoscalers
       resources :events, collection_only: true
     end
   end
 end
-

data/lib/scalingo/endpoint/autoscalers.rb

@@ -0,0 +1,27 @@
+module Scalingo
+  module Endpoint
+    class Autoscalers < Collection
+      # - container_type: can be any container type of an application (e.g. web, clock…)
+      # - min_containers: lower limit of containers
+      # - max_containers: upper limit of containers
+      # - metric: e.g. RPM per container, RAM consumption. The list of available metrics is here.
+      # - target: the autoscaler will keep the metric value as close to the target as possible by scaling the application
+      # https://developers.scalingo.com/autoscalers
+      def create(params)
+        post(nil, autoscaler: params)
+      end
+    end
+    class Autoscaler < Resource
+      # - container_type can't be changed
+      # Additional fields
+      # - disabled: if true, autoscaler will stop manipulating container formation
+      def update(params)
+        patch(nil, autoscaler: params)
+      end
+
+      def destroy
+        delete
+      end
+    end
+  end
+end

data/lib/scalingo/endpoint/collaborators.rb

@@ -2,7 +2,7 @@ module Scalingo
   module Endpoint
     class Collaborators < Collection
       def create(email)
-        post(nil, {collaborator: {email: email}})
+        post(nil, collaborator: { email: email })
       end
     end
     class Collaborator < Resource
@@ -12,4 +12,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/deployments.rb

@@ -9,4 +9,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/domains.rb

@@ -3,15 +3,15 @@ module Scalingo
     class Domains < Collection
       def create(name, tlscert = nil, tlskey = nil)
         if tlskey
-          post(nil, {domain: {name: name, tlscert: tlscert, tlskey: tlskey}})
+          post(nil, domain: { name: name, tlscert: tlscert, tlskey: tlskey })
         else
-          post(nil, {domain: {name: name}})
+          post(nil, domain: { name: name })
         end
       end
     end
     class Domain < Resource
       def update(tlscert, tlskey)
-        path(nil, {domain: {tlscert: tlscert, tlskey: tlskey}})
+        path(nil, domain: { tlscert: tlscert, tlskey: tlskey })
       end
 
       def destroy
@@ -20,4 +20,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/events.rb

@@ -4,4 +4,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/endpoint/notifiers.rb

@@ -0,0 +1,28 @@
+module Scalingo
+  module Endpoint
+    # - platform_id
+    # - name
+    # - send_all_alerts (optional)
+    # - send_all_events (optional)
+    # - type_data (optional)
+    # - selected_event_ids (optional)
+    # - active (optional)
+    # https://developers.scalingo.com/notifiers
+    #
+    class Notifiers < Collection
+      def create(params)
+        post(nil, notifier: params)
+      end
+    end
+    class Notifier < Resource
+      # params: platform_id can't be changed
+      def update(params)
+        patch(nil, notifier: params)
+      end
+
+      def destroy
+        delete
+      end
+    end
+  end
+end

data/lib/scalingo/endpoint/regions.rb

@@ -0,0 +1,6 @@
+module Scalingo
+  module Endpoint
+    class Regions < Collection
+    end
+  end
+end

data/lib/scalingo/endpoint/variables.rb

@@ -2,16 +2,16 @@ module Scalingo
   module Endpoint
     class Variables < Collection
       def all(aliases = true)
-        get(nil, {aliases: aliases})[collection_name]
+        get(nil, aliases: aliases)[collection_name]
       end
 
       def create(name, value)
-        post(nil, {variable: {name: name, value: value}})
+        post(nil, variable: { name: name, value: value })
       end
     end
     class Variable < Resource
       def update(value)
-        patch(nil, {variable: {value: value}})
+        patch(nil, variable: { value: value })
       end
 
       def destroy
@@ -20,4 +20,3 @@ module Scalingo
     end
   end
 end
-

data/lib/scalingo/error.rb

@@ -2,9 +2,15 @@ module Scalingo
   # Custom error class for rescuing from all Scalingo errors
   class Error < StandardError; end
 
-  # Raised when Scalingo try a connection without any token
+  # Raised when the client tries a connection without any token
   class MissingToken < Error; end
 
+  # Raised when the client tries a connection without a region defined
+  class MissingRegion < Error; end
+
+  # Raise if the region named used is invalid, like if it doesn't exist
+  class InvalidRegion < Error; end
+
   # Raised when Scalingo returns the HTTP status code 400
   class BadRequest < Error; end
 

data/lib/scalingo/jwt.rb

@@ -0,0 +1,37 @@
+require 'jwt'
+
+module Scalingo
+  module JWT
+    attr_reader :current_jwt
+
+    private
+
+    def current_jwt
+      return @current_jwt if current_jwt_valid?
+
+      @current_jwt = exchange_token_jwt
+      return @current_jwt
+    end
+
+    def current_jwt_valid?
+      return false if @current_jwt.nil?
+
+      ::JWT.decode @current_jwt, nil, false
+
+      return true
+    rescue ::JWT::ExpiredSignature
+      return false
+    end
+
+    def exchange_token_jwt
+      jwt_connection = build_connection
+      jwt_connection.basic_auth('', token)
+      jwt_connection.url_prefix = auth_endpoint
+
+      response = jwt_connection.post do |request|
+        request.path = '/v1/tokens/exchange'
+      end
+      return response.body['token']
+    end
+  end
+end

data/lib/scalingo/logs.rb

@@ -5,9 +5,8 @@ module Scalingo
     attr_reader :app
 
     def initialize(app)
-      super({endpoint: ''})
-      self.parse_json = false
       @app = app
+      super()
     end
 
     def dump(lines = 10)
@@ -19,15 +18,12 @@ module Scalingo
     end
 
     protected
-    def log_token
-      self.endpoint, log_token = app.logs_url.split('?')
-      @log_token = log_token.split('=').last
-    end
 
     def request(method, path, options)
-      options.merge!(token: log_token)
+      endpoint, query = app.logs_url.split('?')
+      log_token = query.split('=').last
+      options.merge!(token: log_token, endpoint: endpoint)
       super(method, path, options)
     end
   end
 end
-

data/lib/scalingo/realtime/logs.rb

@@ -26,12 +26,10 @@ module Scalingo
 
           ws.on :message do |event|
             data = JSON.parse(event.data)
-            if data['event'] == 'log'
-              @callbacks.each{|c| c.call(data['log'])}
-            end
+            @callbacks.each { |c| c.call(data['log']) } if data['event'] == 'log'
           end
 
-          ws.on :close do |event|
+          ws.on :close do
             ws = nil
           end
 
@@ -41,8 +39,10 @@ module Scalingo
       end
 
       protected
+
       def url
-        "#{app.logs_url}&stream=true"
+        url = app.logs_url.gsub(/^http/, 'ws')
+        return "#{url}&stream=true"
       end
     end
   end

data/lib/scalingo/regions_cache.rb

@@ -0,0 +1,12 @@
+module Scalingo
+  module RegionsCache
+    def region_api_endpoint(name)
+      @regions_cache ||= regions.all
+
+      region = @regions_cache.select { |r| r.name == name }.first
+      raise InvalidRegion, name if region.nil?
+
+      return "#{region['api']}/v1"
+    end
+  end
+end

data/lib/scalingo/request.rb

@@ -5,8 +5,8 @@ module Scalingo
       :post,
       :patch,
       :put,
-      :delete
-    ]
+      :delete,
+    ].freeze
 
     REQUEST_METHODS.each do |method|
       define_method(method) do |path, options = {}|
@@ -15,8 +15,26 @@ module Scalingo
     end
 
     protected
+
     def request(method, path, options)
+      auth_api = options.delete(:auth_api)
+      endpoint = options.delete(:endpoint)
+
+      connection = build_connection
+
+      if auth_api
+        connection.url_prefix = URI(auth_endpoint)
+      elsif endpoint
+        connection.url_prefix = endpoint
+      else
+        raise MissingRegion if !region
+
+        connection.url_prefix = URI(region_api_endpoint(region))
+      end
+
       response = connection.send(method) do |request|
+        request.headers['Authorization'] = "Bearer #{current_jwt}"
+
         case method
         when :get, :delete
           request.url(path, options)

data/lib/scalingo/version.rb

@@ -1,4 +1,3 @@
 module Scalingo
-  VERSION = '1.1.1'
+  VERSION = '2.0.0'
 end
-

data/test/connection_test.rb

@@ -4,21 +4,8 @@ class ConnectionTest < BaseTestCase
   test 'missing token' do
     Scalingo.token = nil
     assert_raise(Scalingo::MissingToken) do
-      Scalingo.apps.all
+      client = Scalingo::Client.new(region: 'test-1')
+      client.apps.all
     end
   end
-
-  test 'parse_json' do
-    stub(:get, 'parse_json').to_return(body: {hello: :world}.to_json)
-    result = Scalingo.get('parse_json')
-    assert_equal({"hello" => "world"}, result)
-  end
-
-  test 'parse_json false' do
-    Scalingo.parse_json = false
-    stub(:get, 'parse_json').to_return(body: {hello: :world}.to_json)
-    result = Scalingo.get('parse_json')
-    assert_equal('{"hello":"world"}', result)
-  end
 end
-

data/test/endpoint_base_test.rb

@@ -21,26 +21,28 @@ class EndpointBaseTest < BaseTestCase
   end
 
   Scalingo::Request::REQUEST_METHODS.each do |method|
-    test "#{method}" do
+    test method.to_s do
+      default_opts = {}
+
       @base.send(method)
       assert_equal method, @api.method_called.http_method
-      assert_equal "#{@prefix}/", @api.method_called.path
-      assert_equal({}, @api.method_called.options)
+      assert_equal @prefix.to_s, @api.method_called.path
+      assert_equal(default_opts, @api.method_called.options)
 
       @base.send(method, 'test')
       assert_equal method, @api.method_called.http_method
       assert_equal "#{@prefix}/test", @api.method_called.path
-      assert_equal({}, @api.method_called.options)
+      assert_equal(default_opts, @api.method_called.options)
 
-      @base.send(method, nil, {a: 1})
+      @base.send(method, nil, a: 1)
       assert_equal method, @api.method_called.http_method
-      assert_equal "#{@prefix}/", @api.method_called.path
-      assert_equal({a: 1}, @api.method_called.options)
+      assert_equal @prefix.to_s, @api.method_called.path
+      assert_equal(default_opts.merge(a: 1), @api.method_called.options)
 
-      @base.send(method, 'test', {a: 1})
+      @base.send(method, 'test', a: 1)
       assert_equal method, @api.method_called.http_method
       assert_equal "#{@prefix}/test", @api.method_called.path
-      assert_equal({a: 1}, @api.method_called.options)
+      assert_equal(default_opts.merge(a: 1), @api.method_called.options)
     end
   end
 
@@ -49,4 +51,3 @@ class EndpointBaseTest < BaseTestCase
     assert_equal 'endpoint_base_classes', @base.prefix
   end
 end
-

data/test/endpoint_collection_test.rb

@@ -6,7 +6,6 @@ end
 class EndpointCollectionTest < BaseTestCase
   class ApiMock
     def get(path, options = {})
-      path = path[0..-2]
       {
         path => collection,
       }

data/test/endpoint_resource_test.rb

@@ -2,7 +2,9 @@ require 'test_helper'
 
 class EndpointResourceTest < BaseTestCase
   test 'initialize' do
-    resource = Scalingo::Endpoint::Resource.new('api', 'prefix', {hello: :world, world: :hello})
+    resource = Scalingo::Endpoint::Resource.new(
+      'api', 'prefix', {}, hello: :world, world: :hello,
+    )
     assert_equal 'api', resource.api
     assert_equal 'prefix', resource.prefix
 

data/test/request_test.rb

@@ -9,55 +9,64 @@ class RequestTest < BaseTestCase
         http_method: request.method,
         headers: request.headers,
         uri: request.uri,
-        query: request.uri.query ? Hash[request.uri.query.split('&').map{|q| q.split('=')}] : {},
+        query: request.uri.query ? Hash[request.uri.query.split('&').map { |q| q.split('=') }] : {},
         path: request.uri.path[4..-1],
       )
-      {status: 200}
+      { status: 200 }
     end
   end
 
   [:get, :delete].each do |sym|
-    test "#{sym}" do
-      Scalingo.public_send(sym, '')
+    test sym.to_s do
+      client = Scalingo::Client.new(region: 'test-1')
+
+      stub_regions('test-1')
+      stub_token_exchange
+
+      client.public_send(sym, '')
       assert_equal sym, @request.http_method
       assert_equal({}, @request.query)
-      assert_equal '', @request.path
+      assert_equal nil, @request.path
       assert_nil @request.body
 
-      Scalingo.public_send(sym, 'hello')
+      client.public_send(sym, 'hello')
       assert_equal sym, @request.http_method
       assert_equal({}, @request.query)
       assert_equal 'hello', @request.path
       assert_nil @request.body
 
-      Scalingo.public_send(sym, 'hello', {hello: :world})
+      client.public_send(sym, 'hello', hello: :world)
       assert_equal sym, @request.http_method
-      assert_equal({"hello" => "world"}, @request.query)
+      assert_equal({ 'hello' => 'world' }, @request.query)
       assert_equal 'hello', @request.path
       assert_nil @request.body
     end
   end
 
   [:post, :patch, :put].each do |sym|
-    test "#{sym}" do
-      Scalingo.public_send(sym, '')
+    test sym.to_s do
+      client = Scalingo::Client.new(region: 'test-1')
+
+      stub_token_exchange
+      stub_regions('test-1')
+
+      client.public_send(sym, '')
       assert_equal sym, @request.http_method
       assert_equal({}, @request.query)
-      assert_equal '', @request.path
+      assert_equal nil, @request.path
       assert_equal '', @request.body
 
-      Scalingo.public_send(sym, 'hello')
+      client.public_send(sym, 'hello')
       assert_equal sym, @request.http_method
       assert_equal({}, @request.query)
       assert_equal 'hello', @request.path
       assert_equal '', @request.body
 
-      Scalingo.public_send(sym, 'hello', {hello: :world})
+      client.public_send(sym, 'hello', hello: :world)
       assert_equal sym, @request.http_method
       assert_equal({}, @request.query)
       assert_equal 'hello', @request.path
-      assert_equal({hello: :world}, @request.body)
+      assert_equal({ hello: :world }, @request.body)
     end
   end
 end
-

data/test/scalingo_test.rb

@@ -11,15 +11,4 @@ class ScalingoTest < BaseTestCase
   test 'client' do
     assert_equal Scalingo::Client, Scalingo.client.class
   end
-
-  test 'respond_to' do
-    assert !Scalingo.methods.include?(:get)
-    assert Scalingo.respond_to?(:get)
-  end
-
-  test 'method_missing' do
-    stub(:get, '').to_return(status: 200)
-    assert Scalingo.client.get('') == Scalingo.get('')
-  end
 end
-

data/test/test_helper.rb

@@ -1,5 +1,6 @@
 require 'bundler/setup'
 require 'simplecov'
+require 'jwt'
 require 'pry'
 
 SimpleCov.configure do
@@ -26,17 +27,63 @@ class BaseTestCase < ActiveSupport::TestCase
     WebMock.reset!
   end
 
-  def endpoint_uri
-    Scalingo.endpoint.split('://').join("://:#{Scalingo.token}@")
+  def auth_endpoint_uri
+    Scalingo.auth_endpoint
   end
 
-  def stub(method, path)
+  def url_with_basic_auth(url)
+    return url.split('://').join("://:#{Scalingo.token}@")
+  end
+
+  def stub(method, path, auth_api: false, region: 'test-1')
+    uri = "https://api.#{region}.scalingo.com"
+    uri = auth_endpoint_uri if auth_api
     case path
     when String
-      stub_request(method, "#{endpoint_uri}#{path}")
+      uri = url_with_basic_auth(uri) if path == '/tokens/exchange'
+      return stub_request(method, "#{uri}#{path}")
     when Regexp
-      stub_request(method, /#{Regexp.quote(endpoint_uri)}#{path}/)
+      return stub_request(method, /#{Regexp.quote(uri)}#{path}/)
     end
   end
+
+  def stub_regions(region)
+    stub(
+      :get, '/regions', auth_api: true,
+    ).to_return(
+      status: 200,
+      headers: {
+        'Content-Type' => 'application/json',
+      },
+      body: { regions: [
+        {
+          name: region,
+          api: "https://api.#{region}.scalingo.com",
+          database_api: "https://db-api.#{region}.scalingo.com",
+        },
+      ] }.to_json,
+    )
+  end
+
+  def stub_token_exchange
+    stub(
+      :post, '/tokens/exchange', auth_api: true,
+    ).to_return(
+      status: 200,
+      headers: {
+        'Content-Type' => 'application/json',
+      },
+      body: { token: generate_test_jwt }.to_json,
+    )
+  end
+
+  def generate_test_jwt
+    payload = {
+      iss: 'Scalingo Test', iat: Time.current.utc.to_i, uuid: SecureRandom.uuid,
+      rnd: SecureRandom.hex, exp: (Time.now.utc.to_i + 3600),
+    }
+    token = JWT.encode payload, '0' * 100, 'HS512'
+    return token
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalingo-ruby-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Leo Unbekandt
@@ -9,8 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -20,7 +40,7 @@ dependencies:
         version: '0.7'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,76 +50,70 @@ dependencies:
         version: '0.7'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.3
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
-  name: faye-websocket
+  name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
-    - - "<"
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
-description: Ruby wrapper around the web API of scalingo.io
+        version: 1.0.3
+description: Ruby wrapper around the web API of scalingo.com
 email:
 - leo@scalingo.com
 - geoffroy@planquart.fr
@@ -107,6 +121,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- README.md
 - Rakefile
 - lib/faraday/raise_http_exception.rb
 - lib/scalingo.rb
@@ -119,17 +135,23 @@ files:
 - lib/scalingo/endpoint/addon_categories.rb
 - lib/scalingo/endpoint/addon_provider.rb
 - lib/scalingo/endpoint/addons.rb
+- lib/scalingo/endpoint/alerts.rb
 - lib/scalingo/endpoint/apps.rb
+- lib/scalingo/endpoint/autoscalers.rb
 - lib/scalingo/endpoint/collaborators.rb
 - lib/scalingo/endpoint/containers.rb
 - lib/scalingo/endpoint/deployments.rb
 - lib/scalingo/endpoint/domains.rb
 - lib/scalingo/endpoint/events.rb
+- lib/scalingo/endpoint/notifiers.rb
+- lib/scalingo/endpoint/regions.rb
 - lib/scalingo/endpoint/stats.rb
 - lib/scalingo/endpoint/variables.rb
 - lib/scalingo/error.rb
+- lib/scalingo/jwt.rb
 - lib/scalingo/logs.rb
 - lib/scalingo/realtime/logs.rb
+- lib/scalingo/regions_cache.rb
 - lib/scalingo/request.rb
 - lib/scalingo/version.rb
 - test/connection_test.rb
@@ -158,15 +180,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby API for the awesome scalingo project !
 test_files:
-- test/connection_test.rb
-- test/endpoint_base_test.rb
+- test/scalingo_test.rb
+- test/request_test.rb
 - test/endpoint_collection_test.rb
 - test/endpoint_resource_test.rb
-- test/request_test.rb
-- test/scalingo_test.rb
+- test/endpoint_base_test.rb
+- test/connection_test.rb
 - test/test_helper.rb