scalingo 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 888ac51dbfb37ca019f77fd142a1243719d957472802b57ab928020db57b5998
-  data.tar.gz: 764d9825719123b3140a7caab2fa6a45b05669c83d70247cc689f524d4f4f49d
+  metadata.gz: 6d40c7b4678cc9197b5a458363ef014ef2bfd410777000c1f9556296384b8e05
+  data.tar.gz: b6805bfca83725d5a95321b1d60bee2112ca3c02643fb0dc6c3cc04245d779ad
 SHA512:
-  metadata.gz: 02fc7e709e9fff36442f74727f71f01de94bdca37c307f59fb01f2bc837145d4c3c527e0c3633931789007baa79a1eb62effbd84d165c7d7456b76fdcfbff521
-  data.tar.gz: 791a7f54c8fa380a5c96d8be8da56beb7f2ae517a69a7976abf92e4c43bbd293e5189cc0b2ac6c48ce73fed8ab172ddacde9788d4e9d10e073796a0cb4a3a4cb
+  metadata.gz: c5245c6052411b5cd2615616948a5768c17f608018dd30c24d4c3f6fe0c6c7ab0745f8171db011b70b5cc95d2be3a6b81ae08921d2f487f5b201682befae13e7
+  data.tar.gz: 3afeb0434dbb32079f4858f6e09317f4259618e925c2e09b0b0e3f595bc0d1d8ff0c94afdfd5ca75a6526e28fb43f99c318e6142a3413077dcbfc74614fb7bd1

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,6 +7,14 @@ require:
   - standard
   - rubocop-performance
 
+AllCops:
+  SuggestExtensions: false
+  Exclude:
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'vendor/**/*'
+    - '.git/**/*'
+
 Style/TrailingCommaInArguments:
   Enabled: true
   EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## Unreleased
+## 3.0.1
+
+* Internals: allow `unpack` to dig into nested structures
 
 ## 3.0.0
 

data/README.md

@@ -144,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/endpoint.rb

@@ -25,8 +25,8 @@ module Scalingo
 
       private
 
-      def unpack(key = nil, &block)
-        Response.unpack(client, key: key, &block)
+      def unpack(*keys, &block)
+        Response.unpack(client, keys: keys, &block)
       end
     end
   end

data/lib/scalingo/api/response.rb

@@ -1,7 +1,7 @@
 module Scalingo
   module API
     class Response
-      def self.unpack(client, key: nil, &block)
+      def self.unpack(client, key: nil, keys: nil, &block)
         response = block.call
 
         body = response.body
@@ -11,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
 

data/lib/scalingo/version.rb

@@ -1,3 +1,3 @@
 module Scalingo
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/scalingo.gemspec

@@ -35,14 +35,15 @@ Gem::Specification.new do |s|
   s.test_files = Dir["spec/**/*_spec.rb"]
 
   s.add_dependency "activesupport", [">= 5", "< 7"]
-  s.add_dependency "faraday", "~> 1.0.1"
-  s.add_dependency "faraday_middleware", "~> 1.0.0"
+  s.add_dependency "faraday", "~> 1.0"
+  s.add_dependency "faraday_middleware", "~> 1.0"
   s.add_dependency "multi_json", ">= 1.0.3", "~> 1.0"
 
   s.add_development_dependency "bundler", "~> 2.0"
   s.add_development_dependency "rake", "~> 13.0"
   s.add_development_dependency "rspec", "~> 3.0"
-  s.add_development_dependency "standard", "~> 0.10.1"
-  s.add_development_dependency "pry", "~> 0.13.1"
-  s.add_development_dependency "webmock", "~> 3.10.0"
+  s.add_development_dependency "standard", "~> 1.1.0"
+  s.add_development_dependency "rubocop-rspec"
+  s.add_development_dependency "pry", "~> 0.14.1"
+  s.add_development_dependency "webmock", "~> 3.12.2"
 end

data/spec/scalingo/api/client_spec.rb

@@ -79,11 +79,11 @@ RSpec.describe Scalingo::API::Client do
       expect(mock).to receive(:new).with(instance).and_return("1st").once
 
       # Not yet loaded...
-      expect(instance.instance_variable_get(:"@handler")).to eq(nil)
+      expect(instance.instance_variable_get(:@handler)).to eq(nil)
       instance.handler
 
       # Memoized...
-      expect(instance.instance_variable_get(:"@handler")).not_to eq(nil)
+      expect(instance.instance_variable_get(:@handler)).not_to eq(nil)
 
       # More calls won't try to perform more instanciations
       instance.handler

data/spec/scalingo/api/endpoint_spec.rb

@@ -21,11 +21,25 @@ RSpec.describe Scalingo::API::Endpoint do
   end
 
   describe "unpack" do
-    it "forwards unpack to Response" do
+    it "forwards unpack to Response without keys" do
       mock = proc { 1 }
 
-      expect(Scalingo::API::Response).to receive(:unpack).with(client, key: :a, &mock).and_return(:d).once
+      expect(Scalingo::API::Response).to receive(:unpack).with(client, keys: [], &mock).and_return(:d).once
+      expect(subject.send(:unpack, &mock)).to eq :d
+    end
+
+    it "forwards unpack to Response with a single key" do
+      mock = proc { 1 }
+
+      expect(Scalingo::API::Response).to receive(:unpack).with(client, keys: [:a], &mock).and_return(:d).once
       expect(subject.send(:unpack, :a, &mock)).to eq :d
     end
+
+    it "forwards unpack to Response with many keys" do
+      mock = proc { 1 }
+
+      expect(Scalingo::API::Response).to receive(:unpack).with(client, keys: [:a, :b], &mock).and_return(:d).once
+      expect(subject.send(:unpack, :a, :b, &mock)).to eq :d
+    end
   end
 end

data/spec/scalingo/api/response_spec.rb

@@ -161,6 +161,22 @@ RSpec.describe Scalingo::API::Response do
         expect(object.meta).to eq nil
       end
 
+      it "with valid keys" do
+        object = described_class.unpack(client, keys: [:root, :key]) { response }
+
+        expect(object.data).to eq(:value)
+        expect(object.full_body).to eq body
+        expect(object.meta).to eq nil
+      end
+
+      it "with invalid keys" do
+        object = described_class.unpack(client, keys: [:root, :other]) { response }
+
+        expect(object.data).to eq nil
+        expect(object.full_body).to eq body
+        expect(object.meta).to eq nil
+      end
+
       context "with meta" do
         let(:body) {
           {root: {key: :value}, meta: {meta1: :value}}

data/spec/scalingo/client_spec.rb

@@ -51,7 +51,7 @@ RSpec.describe Scalingo::Client do
     context "with access token" do
       it "is successful with valid token" do
         fake_response = OpenStruct.new(
-          "successful?": true,
+          successful?: true,
           data: {token: "response token"},
         )
 
@@ -64,7 +64,7 @@ RSpec.describe Scalingo::Client do
 
       it "fails with invalid token" do
         fake_response = OpenStruct.new(
-          "successful?": false,
+          successful?: false,
         )
 
         expect(subject.auth.tokens).to receive(:exchange).and_return(fake_response)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scalingo
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Leo Unbekandt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -37,28 +37,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -127,42 +127,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.1
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.12.2
 description: Ruby client library for the web APIs of Scalingo, a european Platform-as-a-Service
 email:
 - leo@scalingo.com
@@ -171,9 +185,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-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