skull_island 2.0.4 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b70ddd0dfb6534cdcbf0c362ac9a8329123bff76de67497e107f968b1679cc28
-  data.tar.gz: 1d03c93f9fe6cdee72449e30febe26b59932011e8c55e68807ea9c5937a96729
+  metadata.gz: 57af8762038a7aaa846d5c128fe4a8960171e15ee568f6f6e7bbfad4ca429bfa
+  data.tar.gz: 4de11e341de6bd39a38834daa63c3c2db1b98b4c287edbbdf97bbb450429e7db
 SHA512:
-  metadata.gz: e3c0fddd3e23b2e7d0f6577900cb2865212712d7d2b3774c465a7562279a96416a0e142180281306fe93689ee600a8700b9bb85a5fadfb2cfab0ed9ef750fd89
-  data.tar.gz: 81fc8486b6afcdd90d3641eb63ef64992b87dd57fd726e414a3359b8437df4d7e7d1597aa1484387fa3473c7bd4e9c1ba952b57f60566ee467649aa8f61a9918
+  metadata.gz: 01a602058e36398d2b54e108a160e0d4f4ef5b0659605416c76b0014c92a79abf3e4ec430b4b5f2035fe236ca36d9293776f386d5d18c3cbf41f3cdbf98f39cb
+  data.tar.gz: 7fc4b55ab20a8fb38689fee1b79941b43d0de5887452e2f0b180daf3f71d8635bd89e24b9e9030d99b0936fc31d77312b987b03af536eaa40b40ea7627f1b072

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
+  NewCops: enable
 
 Metrics/MethodLength:
   Max: 50
@@ -13,6 +14,14 @@ Layout/LineLength:
 Layout/SpaceAroundMethodCallOperator:
   Enabled: true
 
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'spec/spec_helper.rb'
+
+Lint/MissingSuper:
+  Enabled: false
+
 Lint/RaiseException:
   Enabled: true
 
@@ -20,7 +29,7 @@ Lint/StructNewOverride:
   Enabled: true
 
 Metrics/ClassLength:
-  Max: 190
+  Max: 200
 
 Metrics/ModuleLength:
   Max: 175
@@ -28,12 +37,13 @@ Metrics/ModuleLength:
     - 'lib/skull_island/helpers/resource.rb'
 
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 8
 
 Metrics/ParameterLists:
   Max: 6
 
 Metrics/PerceivedComplexity:
+  Max: 8
   Exclude:
     - 'lib/skull_island/cli.rb'
 
@@ -71,5 +81,8 @@ Style/NumericLiterals:
   Exclude:
     - 'spec/**/*_spec.rb'
 
+Style/OptionalBooleanParameter:
+  Enabled: false
+
 Style/SlicingWithRange:
   Enabled: true

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
 cache: bundler
 rvm:
-- 2.5
-- 2.6
-before_install: gem install bundler -v 2.0.1
+- 3.0
+before_install: gem install bundler -v '~> 2.2'
 deploy:
   provider: rubygems
   api_key:
@@ -11,4 +10,5 @@ deploy:
   gem: skull_island
   on:
     tags: true
+    rvm: 3.0
     repo: jgnagy/skull_island

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.5-alpine
+FROM ruby:3.0-alpine
 LABEL maintainer="Jonathan Gnagy <jonathan.gnagy@gmail.com>"
 
 COPY . /install

data/Gemfile.lock

@@ -1,47 +1,46 @@
 PATH
   remote: .
   specs:
-    skull_island (2.0.4)
+    skull_island (2.3.0)
       deepsort (~> 0.4)
       erubi (~> 1.8)
-      json (~> 2.1)
       linguistics (~> 2.1)
       rest-client (~> 2.1)
-      thor (~> 0.20)
+      thor (~> 1.0)
       will_paginate (~> 3.1)
+      yajl-ruby (~> 1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.3)
+    activesupport (5.2.4.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    coveralls (0.7.1)
-      multi_json (~> 1.3)
-      rest-client
-      simplecov (>= 0.7)
-      term-ansicolor
-      thor
+    ast (2.4.2)
+    concurrent-ruby (1.1.8)
+    coveralls_reborn (0.20.0)
+      simplecov (>= 0.18.1, < 0.22.0)
+      term-ansicolor (~> 1.6)
+      thor (>= 0.20.3, < 2.0)
+      tins (~> 1.16)
     deepsort (0.4.5)
-    diff-lcs (1.3)
-    docile (1.3.2)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    erubi (1.9.0)
-    ethon (0.12.0)
-      ffi (>= 1.3.0)
-    faraday (1.0.1)
+    erubi (1.10.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
     faraday_middleware (1.0.0)
       faraday (~> 1.0)
-    ffi (1.12.2)
-    gh (0.17.0)
+    gh (0.18.0)
       activesupport (~> 5.0)
       addressable (~> 2.4)
       faraday (~> 1.0)
@@ -53,104 +52,111 @@ GEM
     http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    i18n (1.8.2)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    json (2.3.0)
+    json (2.5.1)
+    json_pure (2.5.1)
     launchy (2.4.3)
       addressable (~> 2.3)
     linguistics (2.1.0)
       loggability (~> 0.11)
-    loggability (0.17.0)
+    loggability (0.18.2)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    minitest (5.14.1)
-    multi_json (1.14.1)
+    mime-types-data (3.2021.0212)
+    minitest (5.14.3)
+    multi_json (1.15.0)
     multipart-post (2.1.1)
     net-http-persistent (2.9.4)
     net-http-pipeline (1.0.1)
     netrc (0.11.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    public_suffix (4.0.5)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
     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.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.83.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
       rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.4)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.20.3)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tins (1.25.0)
+    tins (1.28.0)
       sync
-    travis (1.9.1)
+    travis (1.10.0)
       faraday (~> 1.0)
       faraday_middleware (~> 1.0)
       gh (~> 0.13)
       highline (~> 2.0)
-      json (~> 2.3)
+      json_pure (~> 2.3)
       launchy (~> 2.1, < 2.5.0)
       pusher-client (~> 0.4)
-      typhoeus (~> 0.6, >= 0.6.8)
-    typhoeus (0.8.0)
-      ethon (>= 0.8.0)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
     unicode-display_width (1.7.0)
-    websocket (1.2.8)
+    websocket (1.2.9)
     will_paginate (3.3.0)
-    yard (0.9.25)
+    yajl-ruby (1.4.1)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
-  coveralls (~> 0.7)
+  coveralls_reborn (~> 0.20)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.50)
-  simplecov (~> 0.17)
+  simplecov (~> 0.21)
   skull_island!
   travis (~> 1.8)
   yard (~> 0.9.20)
 
 BUNDLED WITH
-   2.1.4
+   2.2.10

data/README.md

@@ -1,6 +1,6 @@
 # Skull Island
 
-A full-featured SDK for [Kong](https://konghq.com/kong/) 2.0.x (with support for migrating from 0.14.x, 1.1.x, 1.2.x, 1.4.x, and 1.5.x). Note that this is unofficial (meaning this project is in no way officially endorsed, recommended, or related to Kong [as a company](https://konghq.com/) or an [open-source project](https://github.com/Kong/kong)). It is also in no way related to the [pet toy company](https://www.kongcompany.com/) by the same name (but hopefully that was obvious).
+A full-featured SDK for [Kong](https://konghq.com/kong/) 2.3.x (with support 2.0.x, 2.1.x, and 2.2.x, and for migrating from 0.14.x, 1.1.x, 1.2.x, 1.4.x, and 1.5.x). Note that this is unofficial (meaning this project is in no way officially endorsed, recommended, or related to Kong [as a company](https://konghq.com/) or an [open-source project](https://github.com/Kong/kong)). It is also in no way related to the [pet toy company](https://www.kongcompany.com/) by the same name (but hopefully that was obvious).
 
 ![Gem](https://img.shields.io/gem/v/skull_island)
 ![Travis (.org)](https://img.shields.io/travis/jgnagy/skull_island)
@@ -21,7 +21,9 @@ skull_island help
 
 ### Ruby Gem Install / SDK
 
-Either:
+**Note:** Starting with 2.3.0, Skull Island only supports Ruby 3.0+. If you need to use Ruby 2.x, you'll need to use a gem version < 2.3.0. I'll maintain the 2.2.x line for Ruby 2.x compatibility for 2021.
+
+To use the Skull Island gem, either:
 
 ```sh
 gem install skull_island
@@ -30,7 +32,7 @@ gem install skull_island
 Or add this to your Gemfile:
 
 ```ruby
-gem 'skull_island',  '~> 2.0'
+gem 'skull_island',  '~> 2.3'
 ```
 
 Or add this to your .gemspec:
@@ -38,7 +40,7 @@ Or add this to your .gemspec:
 ```ruby
 Gem::Specification.new do |spec|
  # ...
- spec.add_runtime_dependency 'skull_island', '~> 2.0'
+ spec.add_runtime_dependency 'skull_island', '~> 2.3'
  # ...
 end
 ```
@@ -149,7 +151,7 @@ When using the `project` feature of Skull Island, the CLI tool will automaticall
 
 ### Migrating
 
-With Skull Island, it is possible to migrate a configuration from a 0.14.x, 1.1.x, 1.2.x, 1.4.x, or 1.5.x gateway to the most recent compatible gateway. If you have a previous export, you can just run `skull_island migrate /path/to/export.yml` and you'll receive a 2.0 compatible config on standard out. If you'd prefer, you can have that config written to a file as well (just like the export command) like so:
+With Skull Island, it is possible to migrate a configuration from a 0.14.x, 1.1.x, 1.2.x, 1.4.x, or 1.5.x gateway to the most recent compatible gateway. If you have a previous export, you can just run `skull_island migrate /path/to/export.yml` and you'll receive a 2.3 compatible config on standard out. If you'd prefer, you can have that config written to a file as well (just like the export command) like so:
 
 ```sh
 skull_island migrate /path/to/export.yml /output/location/migrated.yml
@@ -159,7 +161,7 @@ While this hasn't been heavily tested for all possible use-cases, any configurat
 
 If you don't have a previous export, you'll need to install an older version of this gem using something like `gem install --version '~> 0.14' skull_island`, then perform an `export`, then you can switch back to the latest version of the gem for migrating and importing.
 
-While it would be possible to make migration _automatic_ for the `import` command, `skull_island` intentionally doesn't do this to avoid the appearance that the config is losslessly compatible across versions. In reality, the newer config version has additional features (like tagging) that are used heavily by skull_island. It makes sense to this author to maintain the migration component and the normal functionality as distinct features to encourage the use of the newer capabilities in 1.1 and beyond. That said, Skull Island does allow 1.1, 1.2, and 1.4 version configurations to be applied to 2.0 gateways, but not the opposite.
+While it would be possible to make migration _automatic_ for the `import` command, `skull_island` intentionally doesn't do this to avoid the appearance that the config is losslessly compatible across versions. In reality, the newer config version has additional features (like tagging) that are used heavily by skull_island. It makes sense to this author to maintain the migration component and the normal functionality as distinct features to encourage the use of the newer capabilities in 1.1 and beyond. That said, Skull Island does allow 1.x, 2.0.x, 2.1.x, and 2.2.x version configurations to be applied to 2.3 gateways, but not the opposite.
 
 ### Reset A Gateway
 
@@ -188,7 +190,7 @@ If you're wondering what version of `skull_island` is installed, use:
 ```sh
 $ skull_island version
 
-SkullIsland Version: 2.0.0
+SkullIsland Version: 2.3.0
 ```
 
 ### File Format
@@ -197,7 +199,7 @@ The import/export/migrate CLI functions produce YAML with support for embedded R
 
 ```yaml
 ---
-version: '2.0'
+version: '2.3'
 project: FooV2
 certificates: []
 ca_certificates:
@@ -398,7 +400,7 @@ service.routes.size
 # => 4
 ```
 
-From here, the SDK mostly wraps the attributes described in the [Kong API Docs](https://docs.konghq.com/2.0.x/admin-api/). For simplicity, I'll go over the resource types and attributes this SDK supports manipulating. Rely on the API documentation to determine which attributes are required and under which conditions.
+From here, the SDK mostly wraps the attributes described in the [Kong API Docs](https://docs.konghq.com/2.2.x/admin-api/). For simplicity, I'll go over the resource types and attributes this SDK supports manipulating. Rely on the API documentation to determine which attributes are required and under which conditions.
 
 #### CA Certificates
 
@@ -419,6 +421,14 @@ resource.created_at
 # => #<DateTime: 2018-07-17T12:51:28+00:00 ((2458317j,46288s,0n),+0s,2299161j)>
 ```
 
+Skull Island includes support for adding a _virtual_ `name` attribute to CA Certificates (useful for maintaining them over time) based on a metadata tag that Skull Island will manage for you:
+
+```ruby
+resource.name = 'internalca'
+resource.name
+# => "internalca"
+```
+
 #### Certificates
 
 ```ruby
@@ -438,6 +448,14 @@ resource.created_at
 # => #<DateTime: 2018-07-17T12:51:28+00:00 ((2458317j,46288s,0n),+0s,2299161j)>
 ```
 
+Skull Island includes support for adding a _virtual_ `name` attribute to Certificates (useful for maintaining them over time) based on a metadata tag that Skull Island will manage for you:
+
+```ruby
+resource.name = 'apicert'
+resource.name
+# => "apicert"
+```
+
 #### Consumers (along with their Access Control Lists and Credentials)
 
 Note that for Consumer credentials, only [`key-auth`](https://docs.konghq.com/hub/kong-inc/key-auth/), [`jwt`](https://docs.konghq.com/hub/kong-inc/jwt/), and [`basic-auth`](https://docs.konghq.com/hub/kong-inc/basic-auth/) are currently supported.

data/lib/skull_island.rb

@@ -9,7 +9,6 @@ Hash.include CoreExtensions::Hash::Pruning
 # Standard Library Requirements
 require 'date'
 require 'digest'
-require 'json'
 require 'singleton'
 require 'uri'
 require 'yaml'
@@ -22,6 +21,7 @@ Linguistics.use(:en)
 require 'rest-client'
 require 'will_paginate'
 require 'will_paginate/array'
+require 'yajl/json_gem'
 
 # Internal Requirements
 require 'skull_island/version'

data/lib/skull_island/cli.rb

@@ -30,7 +30,7 @@ module SkullIsland
 
       validate_server_version
 
-      output = { 'version' => '2.0' }
+      output = { 'version' => '2.2' }
       output['project'] = options['project'] if options['project']
 
       [
@@ -43,7 +43,7 @@ module SkullIsland
       ].each { |clname| export_class(clname, output) }
 
       if output_file == '-'
-        STDOUT.puts output.to_yaml
+        $stdout.puts output.to_yaml
       else
         File.write(full_filename, output.to_yaml)
       end
@@ -96,7 +96,7 @@ module SkullIsland
 
       if output_file == '-'
         warn '[INFO] Outputting to STDOUT' if options['verbose']
-        STDOUT.puts output.to_yaml
+        $stdout.puts output.to_yaml
       else
         full_filename = File.expand_path(output_file)
         dirname = File.dirname(full_filename)
@@ -175,7 +175,7 @@ module SkullIsland
     def acquire_input(input_file, verbose = false)
       if input_file == '-'
         warn '[INFO] Reading from STDIN' if verbose
-        STDIN.read
+        $stdin.read
       else
         full_filename = File.expand_path(input_file)
         unless File.exist?(full_filename) && File.ftype(full_filename) == 'file'
@@ -191,7 +191,7 @@ module SkullIsland
     end
 
     def validate_config_version(version)
-      if version && ['1.1', '1.2', '1.4', '1.5', '2.0'].include?(version)
+      if version && ['1.1', '1.2', '1.4', '1.5', '2.0', '2.1', '2.2'].include?(version)
         validate_server_version
       elsif version && ['0.14', '1.0'].include?(version)
         warn '[CRITICAL] Config version is too old. Try `migrate` instead of `import`.'
@@ -213,8 +213,12 @@ module SkullIsland
 
     def validate_server_version
       server_version = SkullIsland::APIClient.about_service['version']
-      if server_version.match?(/^2.0/)
+      case server_version
+      when /^2.[12]/
         true
+      when /^2.0/
+        warn "[WARN] Older server version #{server_version} detected! " \
+             'You may encounter Service resource API exceptions.'
       else
         warn '[CRITICAL] Server version mismatch!'
         exit 1