scalingo 3.0.0.beta.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6582ca860b783b598a3f31874afc37958ead26c29c17c099e6cba1ef094f933d
-  data.tar.gz: c0206b25118775599be97e0c6a7ef06c40914a34711c882a21268521f964ae24
+  metadata.gz: 0c6c044b3045115cfbb02eb44ff90880f115ad308f72962d3a2e396d094d57a1
+  data.tar.gz: 108a902824f01dd1bfc7ccd347ce3a1915ff5e68298ad236b8cd786d85f7df1a
 SHA512:
-  metadata.gz: 1e7e41bb52927a17d3de0c840f281754ee1907a000db36735ec779d5115a345f91bf944aad068421e9292fcb3ab9f92db49690a25e61f4f81cd8ff45c625f550
-  data.tar.gz: e2ebc1468f18304b3086ad927db4e89f09ef1d6256395a6f72a089776eeba8643b923bec88af1690f0264786dd46d6982b421f741b99f23a86ec513a3841fba9
+  metadata.gz: 2bf6692720bdcaaebf692d5c9e714da314acd0e56cbab9d0d616e308efaeb70ec7bc03e0596e94ba80e554daa9f92bc7519dc8da6eb29faf801c11b4f8099a73
+  data.tar.gz: 2ae4d7349ac2cc5821109273b7adf1d489ee9e99c721694c4c6e1f3449ecf2f7c0a4341aea46874c9bb5fa50d1f4642c48fbc4822fe5409bb646c9ae40322790

data/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish gem
+
+on:
+  workflow_dispatch:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/ruby.yml

@@ -0,0 +1,45 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI - PR/master
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0
+        bundler-cache: true
+    - name: Rubocop checks
+      run: bundle exec rubocop
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -7,10 +7,26 @@ require:
   - standard
   - rubocop-performance
 
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+
 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,29 @@
 ## Unreleased
 
+## 3.1.0
+
+* Compat: support for ActiveSupport (and therefore Rails) 7, @Intrepidd
+
+## 3.0.1
+
+* Internals: allow `unpack` to dig into nested structures
+
+## 3.0.0
+
+* New: Regional API autoscalers endpoints
+* New: User#stop_free_trial method
+
+## 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

@@ -10,15 +10,10 @@ 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.
-[This issue tracks the remaining work](https://github.com/Scalingo/scalingo-ruby-api/issues/13).
-
 ## Installation
 
 ```ruby
-gem "scalingo", "3.0.0.beta.2"
+gem "scalingo", "3.0.0"
 ```
 
 And then execute:
@@ -63,20 +58,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 +77,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
 ```
 
@@ -159,3 +144,23 @@ scalingo.osc_fr1.apps.all # OR scalingo.region(:osc_fr1).apps.all
 # Preview the creation of an app on the default region
 scalingo.apps.create(name: "my-new-app", dry_run: true)
 ```
+
+## Development
+
+### Install
+
+```bash
+bundle
+```
+
+### Run tests
+
+```bash
+bundle exec rake test
+```
+
+### Release a new version
+
+```bash
+# TODO
+```

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(*keys, &block)
+        Response.unpack(client, keys: keys, &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, keys: nil, &block)
+        response = block.call
+
         body = response.body
         has_hash_body = body.present? && body.respond_to?(:key)
 
@@ -9,7 +11,10 @@ module Scalingo
         meta = nil
 
         if has_hash_body
-          data = body[key] if response.success? && key.present?
+          keys = [key] if key.present?
+
+          data = body.dig(*keys) if response.success? && keys.present?
+
           meta = body[:meta]
         end
 
@@ -34,6 +39,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,20 @@ module Scalingo
         &block
       )
 
-      unpack(response, key: :user)
+      unpack(:user) { response }
+    end
+
+    def stop_free_trial(headers = nil, &block)
+      data = nil
+
+      response = connection.post(
+        "users/stop_free_trial",
+        data,
+        headers,
+        &block
+      )
+
+      unpack { 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