scalingo 3.0.0.beta.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9fd4bd22f57705fe4066a2f1de8d830c4557383777a49b7a7258a9e8c7b99077
+  data.tar.gz: fbf139e41c1a12c007e08b6c64e4e8d3b54d14500f7b44b14c7ba4ba8bfce7be
+SHA512:
+  metadata.gz: 06271d0e9010d2d4835be48fa43b49545600b63f938e75ef504d17cec8434f07a9f8a5efc15cf411c9a1729c308c99a9b3504539d134530bf93acd73ec2f4565
+  data.tar.gz: 819dd71a0fb81443f934c5ed6f500c7c03105cc1113f4df60cbdb2655d4cfd057d39d38d8535b78f58d24f6deabe4c4b800c31e1022f82d719547e7646ed33d3

data/.gitignore

@@ -0,0 +1,6 @@
+*.swp
+
+coverage/
+/pkg
+
+.rspec_status

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_from: []
+
+inherit_gem:
+  standard: config/base.yml
+
+require:
+  - standard
+  - rubocop-performance
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+before_install:
+  - gem install bundler
+install: bundle update --jobs=3 --retry=3
+
+stages:
+  - lint
+  - test
+
+jobs:
+  include:
+    - stage: lint
+      name: "Linter"
+      language: ruby
+      rvm: 2.7.1
+      before_install:
+        - gem install bundler
+      install: bundle update --jobs=3 --retry=3
+      script: bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+## 3.0.0.beta1 - 2020/06/12
+
+* Full rewrite of the gem, **zero** backwards compatibility. Refer to the `README` for more information.
+
+## 2.0.1 - 2019/12/11
+
+* Bugfix: payload was not correctly serialized to JSON for POST/PUT/PATCH queries
+
+## 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/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in scalingo.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    scalingo (3.0.0.beta.1)
+      activemodel (>= 5, < 7)
+      activesupport (>= 5, < 7)
+      dry-configurable (~> 0.11)
+      faraday (~> 1.0.1)
+      faraday_middleware (~> 1.0.0)
+      multi_json (~> 1.0, >= 1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.1)
+      activesupport (= 6.0.3.1)
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    dry-configurable (0.11.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    hashdiff (1.0.1)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.4)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.83.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    standard (0.4.2)
+      rubocop (~> 0.83.0)
+      rubocop-performance (~> 1.5.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pry (~> 0.13.1)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.83.0)
+  scalingo!
+  standard (~> 0.4.2)
+  webmock (~> 3.8.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 aki017
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# Scalingo
+
+A ruby wrapper for the Scalingo API
+
+### Migration from v2
+
+This gem is changing its name from `scalingo-ruby-api` to `scalingo`,
+and the versionning does **not** reset; the first major version of `scalingo`
+will therefore be `3.x.x`.
+
+You can check the version 2 at [the v2 branch of this repository](https://github.com/Scalingo/scalingo-ruby-api/tree/v2)
+
+### The road to 3.0.0
+
+This gem is still in beta version, but its API should not change a lot until a final release.
+However, configuration may change. An issue will be opened and pinned to follow up the work that remains to be done.
+
+## Installation
+
+```ruby
+gem "scalingo", "3.0.0.beta.1"
+```
+
+And then execute:
+
+```
+bundle
+```
+
+## Usage
+
+```ruby
+require "scalingo"
+
+scalingo = Scalingo::Client.new
+scalingo.authenticate_with(access_token: ENV["SCALINGO_TOKEN"])
+scalingo.user.self
+```
+
+## Conventions
+
+Most methods map to one (and only one) request, and their signature follows this format:
+
+```ruby
+client.section.request(id, payload = {}, headers = nil, &block)
+```
+
+* Depending on the request, there may be no id (collection and/or singular resource, such as `user`), one, or two ids (many resources are nested under an app).
+* Most of the time, this library won't do any processing of the payload, but there's a few things to know:
+  * the root key shouldn't be specified, the library handles it
+  * in some cases, the payload isn't passed as supplied (`metrics`, for instance, extracts the parts that are meant to be used as url fragments)
+* headers can be supplied on a per-request basis, using either the last argument or the block version:
+  * when using the last argument, you may have to pass an empty hash payload (`{}`)
+  * when using the block form, the faraday object is supplied as argument, and you can do any kind of treatment you would like
+
+## Configuration
+
+```ruby
+Scalingo.configure do |config|
+  # Known regions. Each region should have a corresponding entry in the urls settings below
+  config.regions = %i[osc_fr1 osc_secnum_fr1]
+
+  # Default region
+  config.defaul_region = :osc_fr1
+
+  # Endpoints URLS
+  config.urls.auth = "https://auth.scalingo.com/v1"
+  config.urls.osc_fr1 = "https://api.osc-fr1.scalingo.com/v1"
+  config.urls.osc_secnum_fr1 = "https://api.osc-secnum-fr1.scalingo.com/v1"
+
+  # Configure the User Agent header
+  config.user_agent = "Scalingo Ruby Client v#{Scalingo::VERSION}"
+
+  # For how long is a bearer token considered valid (it will raise passed this delay).
+  # Set to nil to never raise.
+  config.exchanged_token_validity = 1.hour
+
+  # 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.
+  config.raise_on_missing_authentication = true
+
+  # 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 = {}
+
+  # Raise an exception when the bearer token in use is supposed to be invalid
+  config.raise_on_expired_token = false
+end
+```
+
+:warning: If you change the settings for the list of regions, you **cannot** use `require "scalingo"`; you must follow this template :
+
+```ruby
+
+require "scalingo/config"
+
+Scalingo.configure do |config|
+  config.regions = %i[my-regions]
+end
+
+require "scalingo/client"
+```
+
+## Response object
+
+Responses are parsed with the keys symbolized and then encapsulated in a `Scalingo::API::Response` object:
+* `response.status` containts the HTTP status code
+* `response.data` contains the "relevant" data, without the json root key (when relevant)
+* `response.full_data` contains the full response body
+* `response.meta` contains the meta object, if there's any
+* `response.headers` containts all the response headers
+
+Some helper methods are defined on this object:
+* `response.successful?` returns true when the code is 2XX
+* `response.paginated?` returns true if the reponse has metadata relative to pagination
+* `response.operation?` returns true if the response contains a header relative to an ongoing operation
+* `response.operation` returns the URL to query to get the status of the operation
+
+## Examples
+
+```ruby
+require "scalingo"
+
+scalingo = Scalingo::Client.new
+
+scalingo.authenticate_with(access_token: "my_access_token")
+# OR
+scalingo.authenticate_with(bearer_token: "my_bearer_jwt")
+
+# Return your profile
+scalingo.self
+
+# List your SSH Keys
+scalingo.keys.all # OR scalingo.auth.keys.all
+
+# Show one SSH Key
+scalingo.keys.show("my-key-id")
+
+# List your apps on the default region
+scalingo.apps.all # OR scalingo.region.apps.all
+
+# List your apps on osc-fr1
+scalingo.osc_fr1.apps.all
+
+# Preview the creation of an app on the default region
+scalingo.apps.create(name: "my-new-app", dry_run: true)
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "scalingo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/scalingo.rb

@@ -0,0 +1,2 @@
+require "scalingo/config"
+require "scalingo/client"

data/lib/scalingo/api/client.rb

@@ -0,0 +1,79 @@
+module Scalingo
+  module API
+    class Client
+      attr_reader :scalingo, :url
+
+      def initialize(scalingo, url)
+        @scalingo = scalingo
+        @url = url
+      end
+
+      def self.register_handlers!(handlers)
+        handlers.each do |method_name, klass|
+          define_method(method_name) do
+            value = instance_variable_get("@#{method_name}")
+
+            if value.nil?
+              value = klass.new(self)
+              instance_variable_set("@#{method_name}", value)
+            end
+
+            value
+          end
+        end
+      end
+
+      ## Faraday objects
+      def connection_options
+        headers = {
+          "User-Agent" => Scalingo.config.user_agent
+        }
+
+        if (extra = Scalingo.config.additional_headers).present?
+          extra.respond_to?(:call) ? headers.update(extra.call) : headers.update(extra)
+        end
+
+        {
+          url: url,
+          headers: headers
+        }
+      end
+
+      def connection(allow_guest: false)
+        if allow_guest
+          begin
+            authenticated_connection
+          rescue
+            unauthenticated_connection
+          end
+        else
+          authenticated_connection
+        end
+      end
+
+      def unauthenticated_connection
+        @unauthenticated_conn ||= Faraday.new(connection_options) { |conn|
+          conn.response :json, content_type: /\bjson$/, parser_options: {symbolize_names: true}
+        }
+      end
+
+      def authenticated_connection
+        return @connection if @connection
+
+        if Scalingo.config.raise_on_missing_authentication && !scalingo.token&.value
+          raise Error::Unauthenticated
+        end
+
+        @connection = Faraday.new(connection_options) { |conn|
+          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
+            conn.headers[Faraday::Request::Authorization::KEY] = auth_header
+          end
+        }
+      end
+    end
+  end
+end