skull_island 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a7b4f233be82c0837c704cc2db5e07ede909632c2e54e413962f4343908974
-  data.tar.gz: 28589bf89713ddc2a039b861d7a1290677b6c69b5bdfe2f5a7ea62bce05fa52e
+  metadata.gz: 17234eaf013609bf69fd1bb6be226d2da41c5c2d720fcf7c8aab6320bed7be49
+  data.tar.gz: bb19cf537906e3fce0b577e75261eb9ca5cba7039086b89b07dbdb69d1b4cd61
 SHA512:
-  metadata.gz: b2530b37d2f914b1f6c6c419fa9b0c8dfb39dd9c760c51f0135bc9267eea4aab94ea3e8ae1c6058731356125a63ca1aafe5a6e97ac74ad5feb440849a28bb45b
-  data.tar.gz: c5231a55b789eb6cd602f34c7643585a8142adb81f722e96a805b0b91509d16f05df7708f811d61cfa6b76ce67dfbb0c898506b014c7395634a40c4f95808968
+  metadata.gz: 481f50743c1f3dad36f04426c2bb791484d11503df91744233f6da4789429f7b0c469ad919a25402de17da33ad03c744afb5aa60f04d11f89e96d3410e31982e
+  data.tar.gz: c2e8109e0ae1bdb10f0a8fa707ef8a0fac48266a4cb034d8092f86215d583fe164e57cef4b343a09cd6b0fc5a2241bd8a191e809b860f18712b5b03ae04544d2

data/.rubocop.yml

@@ -1,14 +1,35 @@
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
 
 Metrics/MethodLength:
   Max: 50
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
 Layout/LineLength:
   Max: 100
 
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'spec/spec_helper.rb'
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 Metrics/ClassLength:
-  Max: 190
+  Max: 200
 
 Metrics/ModuleLength:
   Max: 175
@@ -16,9 +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'
 
@@ -40,6 +65,24 @@ Security/Eval:
   Exclude:
     - 'lib/skull_island/cli.rb'
 
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: false
+
 Style/NumericLiterals:
   Exclude:
     - 'spec/**/*_spec.rb'
+
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+Style/SlicingWithRange:
+  Enabled: true

data/.travis.yml

@@ -11,4 +11,5 @@ deploy:
   gem: skull_island
   on:
     tags: true
+    rvm: 2.6
     repo: jgnagy/skull_island

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    skull_island (2.0.0)
+    skull_island (2.2.0)
       deepsort (~> 0.4)
       erubi (~> 1.8)
       json (~> 2.1)
@@ -13,118 +13,134 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
-    ast (2.4.0)
-    backports (3.16.1)
+    activesupport (5.2.4.4)
+      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.1)
+    concurrent-ruby (1.1.7)
     coveralls (0.7.1)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
       term-ansicolor
       thor
-    deepsort (0.4.3)
-    diff-lcs (1.3)
-    docile (1.3.2)
+    deepsort (0.4.5)
+    diff-lcs (1.4.4)
+    docile (1.3.3)
     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 (0.17.3)
+    erubi (1.10.0)
+    faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.14.0)
-      faraday (>= 0.7.4, < 1.0)
-    ffi (1.12.2)
-    gh (0.15.1)
-      addressable (~> 2.4.0)
-      backports
-      faraday (~> 0.8)
+      ruby2_keywords
+    faraday_middleware (1.0.0)
+      faraday (~> 1.0)
+    gh (0.18.0)
+      activesupport (~> 5.0)
+      addressable (~> 2.4)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.0)
       multi_json (~> 1.0)
       net-http-persistent (~> 2.9)
       net-http-pipeline
-    highline (1.7.10)
+    highline (2.0.3)
     http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json (2.4.1)
+    json_pure (2.4.1)
     launchy (2.4.3)
       addressable (~> 2.3)
     linguistics (2.1.0)
       loggability (~> 0.11)
-    loggability (0.15.1)
+    loggability (0.17.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.1009)
-    multi_json (1.14.1)
+    mime-types-data (3.2020.1104)
+    minitest (5.14.2)
+    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.0.2)
-      ast (~> 2.4.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
     pusher-client (0.6.2)
       json
       websocket (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
+    rake (13.0.1)
+    regexp_parser (2.0.0)
     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.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       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.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.80.0)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    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, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.4)
+    ruby2_keywords (0.0.2)
+    simplecov (0.20.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.1)
+      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)
-    tins (1.24.1)
+    thread_safe (0.3.6)
+    tins (1.26.0)
       sync
-    travis (1.8.10)
-      backports
-      faraday (~> 0.9)
-      faraday_middleware (~> 0.9, >= 0.9.1)
+    travis (1.10.0)
+      faraday (~> 1.0)
+      faraday_middleware (~> 1.0)
       gh (~> 0.13)
-      highline (~> 1.6)
-      launchy (~> 2.1)
+      highline (~> 2.0)
+      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.9)
+      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
-    unicode-display_width (1.6.1)
-    websocket (1.2.8)
-    will_paginate (3.2.1)
-    yard (0.9.24)
+    unf_ext (0.0.7.7)
+    unicode-display_width (1.7.0)
+    websocket (1.2.9)
+    will_paginate (3.3.0)
+    yard (0.9.25)
 
 PLATFORMS
   ruby
@@ -132,7 +148,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   coveralls (~> 0.7)
-  rake (~> 12.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 0.50)
   simplecov (~> 0.17)
@@ -141,4 +157,4 @@ DEPENDENCIES
   yard (~> 0.9.20)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -270,7 +270,7 @@ plugins:
   service: "<%= lookup :service, 'search_api' %>"
 ```
 
-All top-level keys (other than `version` and `project`) require an Array as a parameter, either by providing a list of entries or an empty Array (`[]`), or they can be omitted entirely which is the same as providing an empty Array. The above shows how to use the `lookup()` function to refer to another resource. This "looks up" the resource type (`service` in this case) by `name` (`search_api` in this case) and resolves its `id`. This function can also be used to lookup a `route` or `upstream` by its `name`, or a `consumer` by its `username`. Note that Kong itself doesn't _require_ `route` resources to have unique names, so you'll need to enforce that practice yourself for `lookup` to be useful for Routes.
+All top-level keys (other than `version` and `project`) require an Array as a parameter, either by providing a list of entries or an empty Array (`[]`), or they can be omitted entirely which is the same as providing an empty Array. The above shows how to use the `lookup()` function to refer to another resource. This "looks up" the resource type (`service` in this case) by `name` (`search_api` in this case) and resolves its `id`. This function can also be used to lookup a `route` or `upstream` by its `name`, or a `consumer` by its `username`. Note that Kong itself doesn't _require_ `route` resources to have unique names, so you'll need to enforce that practice yourself for `lookup` to be useful for Routes. The `lookup` function also supports a third parameter to provide just the `id` value, rather than wrapping it in a key/value pair of `id: 9992...`. Simple call `lookup` like `lookup :service, 'search_api', true` to turn on this "raw id mode".
 
 Note that while this configuration looks a lot like the [DB-less](https://docs.konghq.com/1.4.x/db-less-and-declarative-config/) configuration (and even may, at times, be interchangeable), this is merely a coincidence. **Skull Island doesn't support the DB-less mode for Kong.** This may potentially change in the future, but for now it is not a goal of this project.
 
@@ -282,7 +282,7 @@ While technically _any_ Ruby is valid, the following are pretty helpful for temp
 
 * `ENV.fetch('VARIABLE_NAME', 'default value')` - This allows looking up the environment variable `VARIABLE_NAME` and using its value, or, if it isn't defined, it uses `default value` as the value. With this we could change `host: api.example.com` to `host: <%= ENV.fetch('API_HOST', 'api.example.com') %>`. With this, if `API_HOST` is provided, it'll use that, otherwise it will default to `api.example.com`. This is especially helpful for sensitive information; you can version control the configuration but pass in things like credentials via environment variables at runtime.
 
-Note also that 1.4.x and beyond of Skull Island support two phases of embedded ruby: first, a simple phase that treats the **entire file** as just text, allowing you to use the full power of ruby for things like loops, conditional logic, and more; the second phase is applied for individual attributes within the rendered YAML document. This is where the `lookup()` function above is used. 
+Note also that 1.4.x and beyond of Skull Island support two phases of embedded ruby: first, a simple phase that treats the **entire file** as just text, allowing you to use the full power of ruby for things like loops, conditional logic, and more; the second phase is applied for individual attributes within the rendered YAML document. This is where the `lookup()` function above is used.
 
 ## SDK Usage
 

data/lib/core_extensions/hash/pruning.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CoreExtensions
+  module Hash
+    # Monkey-patches for Hash to add some recursive pruning options
+    module Pruning
+      # Recursively strips empty and nil elements from a Hash
+      # @return [Hash]
+      def prune
+        newhash = {}
+
+        each do |k, v|
+          if v.is_a?(Hash)
+            newvalue = v.prune
+            newhash[k] = newvalue unless newvalue.empty?
+          elsif v.respond_to?(:empty?)
+            newhash[k] = v unless v.empty?
+          else
+            newhash[k] = v unless v.nil?
+          end
+        end
+
+        newhash
+      end
+    end
+  end
+end

data/lib/skull_island.rb

@@ -2,7 +2,9 @@
 
 # Core Extensions
 require 'core_extensions/string/transformations'
+require 'core_extensions/hash/pruning'
 String.include CoreExtensions::String::Transformations
+Hash.include CoreExtensions::Hash::Pruning
 
 # Standard Library Requirements
 require 'date'

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

data/lib/skull_island/helpers/cli_erb.rb

@@ -12,8 +12,8 @@ module SkullIsland
       end
 
       # At this phase, we want to leave this alone...
-      def lookup(type, value)
-        "<%= lookup :#{type}, '#{value}' %>"
+      def lookup(type, value, raw = false)
+        "<%= lookup :#{type}, '#{value}', #{raw} %>"
       end
     end
   end

data/lib/skull_island/helpers/meta.rb

@@ -44,7 +44,7 @@ module SkullIsland
       end
 
       def project=(project_id)
-        unless project_id.is_a?(String) && project_id.match?(/^[\w_\-\.~]+$/)
+        unless project_id.is_a?(String) && project_id.match?(/^[\w_\-.~]+$/)
           raise Exceptions::InvalidArguments, 'project'
         end
 

data/lib/skull_island/helpers/resource.rb

@@ -16,6 +16,8 @@ module SkullIsland
 
       # rubocop:disable Style/GuardClause
       # rubocop:disable Security/Eval
+      # The delayed_set method allows a second phase of Erb templating immediately
+      # before sending data to the API. This allows the `lookup` function to work dynamically
       def delayed_set(property, data, key = property.to_s)
         if data[key]
           value = recursive_erubi(data[key])
@@ -27,11 +29,12 @@ module SkullIsland
       end
 
       def recursive_erubi(data)
-        if data.is_a?(String)
+        case data
+        when String
           eval(Erubi::Engine.new(data).src)
-        elsif data.is_a?(Array)
+        when Array
           data.map { |item| recursive_erubi(item) }
-        elsif data.is_a?(Hash)
+        when Hash
           data.map { |k, v| [k, recursive_erubi(v)] }.to_h
         else
           data
@@ -72,7 +75,7 @@ module SkullIsland
       end
 
       def host_regex
-        /^(([\w]|[\w][\w\-]*[\w])\.)*([\w]|[\w][\w\-]*[\w])$/
+        /^((\w|\w[\w\-]*\w)\.)*(\w|\w[\w\-]*\w)$/
       end
 
       def id_property
@@ -87,9 +90,8 @@ module SkullIsland
         self.class.immutable?
       end
 
-      # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
-      def import_update_or_skip(verbose: false, test: false, index:)
+      def import_update_or_skip(index:, verbose: false, test: false)
         if find_by_digest
           puts "[INFO] Skipping #{self.class} index #{index} (#{id})" if verbose
         elsif test
@@ -102,22 +104,29 @@ module SkullIsland
           puts "[ERR] Failed to save #{self.class} index #{index}"
         end
       end
-      # rubocop:enable Metrics/CyclomaticComplexity
+
       # rubocop:enable Metrics/PerceivedComplexity
 
-      def lookup(type, value)
-        case type
-        when :consumer
-          { 'id' => Resources::Consumer.find(:username, value).id }
-        when :route
-          { 'id' => Resources::Route.find(:name, value).id }
-        when :service
-          { 'id' => Resources::Service.find(:name, value).id }
-        when :upstream
-          { 'id' => Resources::Upstream.find(:name, value).id }
-        else
-          raise Exceptions::InvalidArguments, "#{type} is not a valid lookup type"
-        end
+      # Looks up IDs (and usually wraps them in a Hash)
+      def lookup(type, value, raw = false)
+        id_value = case type
+                   when :ca_certificate
+                     Resources::CACertificate.find(:name, value).id
+                   when :certificate
+                     Resources::Certificate.find(:name, value).id
+                   when :consumer
+                     Resources::Consumer.find(:username, value).id
+                   when :route
+                     Resources::Route.find(:name, value).id
+                   when :service
+                     Resources::Service.find(:name, value).id
+                   when :upstream
+                     Resources::Upstream.find(:name, value).id
+                   else
+                     raise Exceptions::InvalidArguments, "#{type} is not a valid lookup type"
+                   end
+
+        raw ? id_value : { 'id' => id_value }
       end
 
       # ActiveRecord ActiveModel::Name compatibility method