skull_island 0.14.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2a3355226814eb0d485dbac28624003b323eb62b4a1116493ef5da234108930
-  data.tar.gz: 8fe0388fb91633ea0bd1eba39e98671bb3fe88bc691700573ed1a6daa7814e8e
+  metadata.gz: 2599c9fbc76abcc4be21923b95477c784515165c3891aa5155d7a9d88c5c887b
+  data.tar.gz: df6f3715f49a4a6cb09118bd446f1c7097fa7d0228dfce497e7396e63921e13c
 SHA512:
-  metadata.gz: 9e429af9e6768ad18c00e2b6e0f60844f2194eb32c627c7bb9cacfa4a0c282cb3069ed70c54a5be686c9c36a7b5f3882b0c6dfe34d5566a7c48a92b648894632
-  data.tar.gz: 320f1a3e376ac977d050460d978e6e838914932d759f82542bba0c797ae37c1ef2bb1f830f2c810f2843d0db91238074ac9c9f3a371a1e13eaa05beeb2d9c07e
+  metadata.gz: 70be200f4e3721d42c820176d16350e705c40c38254876322181a1509538b0e7612156fbb2ddb29b9a8bdfab522ec8452046b346a2fe059a3bd838f4f2c578bc
+  data.tar.gz: 7c426dfbf53dbb080ed5211c14ce22b0d5ef78aa06a8e27c1fd1d91b1534065f77554ffc93edc56728fec870aa8bdd591ed10d1fcadf454c4372f897e16f03bf

data/.rubocop.yml

@@ -8,10 +8,10 @@ Metrics/LineLength:
   Max: 100
 
 Metrics/ClassLength:
-  Max: 165
+  Max: 170
 
 Metrics/ModuleLength:
-  Max: 165
+  Max: 170
   Exclude:
     - 'lib/skull_island/helpers/resource.rb'
 
@@ -23,7 +23,7 @@ Metrics/PerceivedComplexity:
     - 'lib/skull_island/cli.rb'
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 27
 
 Metrics/BlockLength:
   Max: 35

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    skull_island (0.14.1)
+    skull_island (1.1.1)
       deepsort (~> 0.4)
       erubi (~> 1.8)
       json (~> 2.1)

data/README.md

@@ -1,6 +1,6 @@
 # Skull Island
 
-Work In Progress for a full-featured SDK for Kong 0.14.x (with 1.0.x details added for future development).
+A full-featured SDK for [Kong](https://konghq.com/kong/) 1.1.x (with support for migrating from 0.14.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).
 
 ## Installation
 
@@ -13,7 +13,7 @@ gem install skull_island
 Or add this to your Gemfile:
 
 ```ruby
-gem 'skull_island',  '~>0.2'
+gem 'skull_island',  '~> 1.1'
 ```
 
 Or add this to your .gemspec:
@@ -21,7 +21,7 @@ Or add this to your .gemspec:
 ```ruby
 Gem::Specification.new do |spec|
  # ...
- spec.add_runtime_dependency 'skull_island', '~> 0.2'
+ spec.add_runtime_dependency 'skull_island', '~> 1.1'
  # ...
 end
 ```
@@ -33,9 +33,10 @@ Skull Island comes with an executable called `skull_island` that leverages the S
 ```
 $ skull_island help
 Commands:
-  skull_island export [OPTIONS] OUTPUT_FILE  # Export the current configuration to OUTPUT_FILE
-  skull_island help [COMMAND]                # Describe available commands or one specific command
-  skull_island import [OPTIONS] INPUT_FILE   # Import a configuration from INPUT_FILE
+  skull_island export [OPTIONS] [OUTPUT|-]             # Export the current configuration to OUTPUT
+  skull_island help [COMMAND]                          # Describe available commands or one specific command
+  skull_island import [OPTIONS] [INPUT|-]              # Import a configuration from INPUT
+  skull_island migrate [OPTIONS] [INPUT|-] [OUTPUT|-]  # Migrate an older config from INPUT to OUTPUT
 
 Options:
   [--verbose], [--no-verbose]
@@ -111,13 +112,27 @@ KONG_ADMIN_URL='https://api-admin.mydomain.com' \
 skull_island import --verbose --test /path/to/export.yml
 ```
 
+### Migrating
+
+With Skull Island, it is possible to migrate a configuration from a 0.14.x gateway to one compatible with a 1.1.x gateway. If you have a previous export, you can just run `skull_island migrate /path/to/export.yml` and you'll receive a 1.1 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:
+
+```
+skull_island migrate /path/to/export.yml /output/location/migrated.yml
+```
+
+While this hasn't been heavily tested for all possible use-cases, any configuration generated or usable by the `'~> 0.14'` version of this gem should safely convert using the migration command. This tool also makes no guarantees about plugin functionality, configuration compatibility across versions, or that the same plugins are installed and available in your newer gateway. It should go without saying that you should **test and confirm** that all of your functionality was successfully migrated.
+
+If you don't have a previous export, you'll need to install an older version of this gem using `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 will likely be used heavily. 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+.
+
 ### File Format
 
-The import/export CLI functions produce YAML with support for embedded Ruby ([ERB](https://ruby-doc.org/stdlib-2.5.3/libdoc/erb/rdoc/ERB.html)). The file is structured like this (as an example):
+The import/export/migrate CLI functions produce YAML with support for embedded Ruby ([ERB](https://ruby-doc.org/stdlib-2.5.3/libdoc/erb/rdoc/ERB.html)). The file is structured like this (as an example):
 
 ```yaml
 ---
-version: '0.14'
+version: '1.1'
 certificates: []
 consumers:
 - username: foo
@@ -172,7 +187,7 @@ plugins:
     key_names:
     - x-api-key
     run_on_preflight: true
-  service_id: "<%= lookup :service, 'search_api' %>"
+  service: "<%= lookup :service, 'search_api' %>"
 ```
 
 All top-level keys (other than `version`) require an Array as a parameter, either by providing a list of entries or 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.
@@ -295,7 +310,7 @@ service.routes.size
 # => 4
 ```
 
-From here, the SDK mostly wraps the attributes described in the [Kong API Docs](https://docs.konghq.com/0.14.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/1.1.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.
 
 #### Certificates
 
@@ -365,7 +380,7 @@ resource.enabled  = true            # A Boolean
 resource.config   = { 'minute' => 50, 'hour' => 1000 } # A Hash of config keys and values
 
 # Either reference related resources by ID
-resource.service  = '5fd1z584-1adb-40a5-c042-63b19db49x21'
+resource.service  = { 'id' => '5fd1z584-1adb-40a5-c042-63b19db49x21' }
 resource.service
 # => #<SkullIsland::Resources::Services:0x00007f9f201f6f44...
 

data/lib/skull_island.rb

@@ -41,6 +41,7 @@ require 'skull_island/simple_api_client'
 require 'skull_island/resource_collection'
 require 'skull_island/helpers/resource'
 require 'skull_island/helpers/resource_class'
+require 'skull_island/helpers/migration'
 require 'skull_island/validations/resource'
 require 'skull_island/resource'
 require 'skull_island/resources/certificate'

data/lib/skull_island/api_client_base.rb

@@ -31,6 +31,7 @@ module SkullIsland
 
     def get(uri, data = nil)
       client_action do |client|
+        # TODO: Support the API's pagination through the "next" top-level key
         if data
           JSON.parse client[uri].get(json_headers.merge(params: data))
         else

data/lib/skull_island/cli.rb

@@ -10,9 +10,11 @@ require 'thor'
 module SkullIsland
   # Base CLI for SkullIsland
   class CLI < Thor
+    include Helpers::Migration
+
     class_option :verbose, type: :boolean
 
-    desc 'export [OPTIONS] OUTPUT_FILE', 'Export the current configuration to OUTPUT_FILE'
+    desc 'export [OPTIONS] [OUTPUT|-]', 'Export the current configuration to OUTPUT'
     def export(output_file = '-')
       if output_file == '-'
         STDERR.puts '[INFO] Outputting to STDOUT' if options['verbose']
@@ -24,7 +26,9 @@ module SkullIsland
         end
       end
 
-      output = { 'version' => '0.14' }
+      validate_server_version
+
+      output = { 'version' => '1.1' }
 
       [
         Resources::Certificate,
@@ -41,29 +45,17 @@ module SkullIsland
       end
     end
 
-    desc 'import [OPTIONS] INPUT_FILE', 'Import a configuration from INPUT_FILE'
+    desc 'import [OPTIONS] [INPUT|-]', 'Import a configuration from INPUT'
     option :test, type: :boolean, desc: "Don't do anything, just show what would happen"
     def import(input_file = '-')
-      raw ||= if input_file == '-'
-                STDERR.puts '[INFO] Reading from STDOUT' if options['verbose']
-                STDIN.read
-              else
-                full_filename = File.expand_path(input_file)
-                unless File.exist?(full_filename) && File.ftype(full_filename) == 'file'
-                  raise Exceptions::InvalidArguments, "#{full_filename} is invalid"
-                end
-
-                begin
-                  File.read(full_filename)
-                rescue StandardError => e
-                  raise "Unable to process #{relative_path}: #{e.message}"
-                end
-              end
+      raw ||= acquire_input(input_file, options['verbose'])
 
       # rubocop:disable Security/YAMLLoad
       input = YAML.load(raw)
       # rubocop:enable Security/YAMLLoad
 
+      validate_config_version input['version']
+
       [
         Resources::Certificate,
         Resources::Consumer,
@@ -73,6 +65,35 @@ module SkullIsland
       ].each { |clname| import_class(clname, input) }
     end
 
+    desc(
+      'migrate [OPTIONS] [INPUT|-] [OUTPUT|-]',
+      'Migrate an older config from INPUT to OUTPUT'
+    )
+    def migrate(input_file = '-', output_file = '-')
+      raw ||= acquire_input(input_file, options['verbose'])
+
+      # rubocop:disable Security/YAMLLoad
+      input = YAML.load(raw)
+      # rubocop:enable Security/YAMLLoad
+
+      validate_migrate_version input['version']
+
+      output = migrate_config(input)
+
+      if output_file == '-'
+        STDERR.puts '[INFO] Outputting to STDOUT' if options['verbose']
+        STDOUT.puts output.to_yaml
+      else
+        full_filename = File.expand_path(output_file)
+        dirname = File.dirname(full_filename)
+        unless File.exist?(dirname) && File.ftype(dirname) == 'directory'
+          raise Exceptions::InvalidArguments, "#{full_filename} is invalid"
+        end
+
+        File.write(full_filename, output.to_yaml)
+      end
+    end
+
     private
 
     def export_class(class_name, output_data)
@@ -88,5 +109,54 @@ module SkullIsland
         test: options['test']
       )
     end
+
+    # Used to pull input from either STDIN or the specified file
+    def acquire_input(input_file, verbose = false)
+      if input_file == '-'
+        STDERR.puts '[INFO] Reading from STDIN' if verbose
+        STDIN.read
+      else
+        full_filename = File.expand_path(input_file)
+        unless File.exist?(full_filename) && File.ftype(full_filename) == 'file'
+          raise Exceptions::InvalidArguments, "#{full_filename} is invalid"
+        end
+
+        begin
+          File.read(full_filename)
+        rescue StandardError => e
+          raise "Unable to process #{relative_path}: #{e.message}"
+        end
+      end
+    end
+
+    def validate_config_version(version)
+      if version && version == '1.1'
+        validate_server_version
+      elsif version && ['0.14', '1.0'].include?(version)
+        STDERR.puts '[CRITICAL] Config version is too old. Try `migrate` instead of `import`.'
+        exit 2
+      else
+        STDERR.puts '[CRITICAL] Config version is unknown or not supported.'
+        exit 3
+      end
+    end
+
+    def validate_migrate_version(version)
+      if version && version == '0.14'
+        true
+      else
+        STDERR.puts '[CRITICAL] Config version must be 0.14 for migration.'
+        exit 4
+      end
+    end
+
+    def validate_server_version
+      if SkullIsland::APIClient.about_service['version'].start_with? '1.1'
+        true
+      else
+        STDERR.puts '[CRITICAL] Server version mismatch!'
+        exit 1
+      end
+    end
   end
 end

data/lib/skull_island/helpers/migration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SkullIsland
+  module Helpers
+    # Simple helper methods for migrating old configs
+    module Migration
+      def migrate_config(config)
+        if config['version'] == '0.14'
+          migrate_0_14_to_1_1(config)
+        else
+          false # Just return false if it can't be migrated
+        end
+      end
+
+      def migrate_0_14_to_1_1(config)
+        new_config = config.dup
+        config['plugins']&.each_with_index do |plugin, plugin_index|
+          %w[consumer route service].each do |rtype|
+            if plugin["#{rtype}_id"]&.start_with?('<%=')
+              new_config['plugins'][plugin_index][rtype] = plugin["#{rtype}_id"].dup
+              new_config['plugins'][plugin_index].delete("#{rtype}_id")
+            elsif plugin["#{rtype}_id"]
+              new_config['plugins'][plugin_index][rtype] = {
+                'id' => plugin["#{rtype}_id"].dup
+              }
+            end
+          end
+        end
+        new_config['version'] = '1.1'
+        new_config
+      end
+    end
+  end
+end

data/lib/skull_island/helpers/resource.rb

@@ -18,9 +18,10 @@ module SkullIsland
       def delayed_set(property, data, key)
         # rubocop:disable Security/Eval
         if data[key]
+          value = data[key].is_a?(String) ? eval(Erubi::Engine.new(data[key]).src) : data[key]
           send(
             "#{property}=".to_sym,
-            data[key].is_a?(String) ? eval(Erubi::Engine.new(data[key]).src) : data[key]
+            value.is_a?(String) && value.start_with?('{"') ? eval(value) : value
           )
         end
         # rubocop:enable Security/Eval
@@ -94,13 +95,13 @@ module SkullIsland
       def lookup(type, value)
         case type
         when :consumer
-          Resources::Consumer.find(:username, value).id
+          { 'id' => Resources::Consumer.find(:username, value).id }
         when :route
-          Resources::Route.find(:name, value).id
+          { 'id' => Resources::Route.find(:name, value).id }
         when :service
-          Resources::Service.find(:name, value).id
+          { 'id' => Resources::Service.find(:name, value).id }
         when :upstream
-          Resources::Upstream.find(:name, value).id
+          { 'id' => Resources::Upstream.find(:name, value).id }
         else
           raise Exceptions::InvalidArguments, "#{type} is not a valid lookup type"
         end

data/lib/skull_island/resources/basicauth_credential.rb

@@ -10,8 +10,8 @@ module SkullIsland
       property :username, required: true, validate: true
       property :password, validated: true
       property(
-        :consumer_id,
-        required: true, validate: true, preprocess: true, postprocess: true, as: :consumer
+        :consumer,
+        required: true, validate: true, preprocess: true, postprocess: true
       )
       property :created_at, read_only: true, postprocess: true
 
@@ -22,7 +22,7 @@ module SkullIsland
           resource = new
           resource.username = resource_data['username']
           resource.password = resource_data['password'] if resource_data['password']
-          resource.delayed_set(:consumer, resource_data, 'consumer_id')
+          resource.delayed_set(:consumer, resource_data, 'consumer')
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
         end
       end
@@ -41,7 +41,7 @@ module SkullIsland
 
       def export(options = {})
         hash = { 'username' => username, 'password' => password }
-        hash['consumer_id'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
+        hash['consumer'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -58,10 +58,10 @@ module SkullIsland
 
       private
 
-      def postprocess_consumer_id(value)
-        if value.is_a?(String)
+      def postprocess_consumer(value)
+        if value.is_a?(Hash)
           Consumer.new(
-            entity: { 'id' => value },
+            entity: value,
             lazy: true,
             tainted: false
           )
@@ -70,18 +70,18 @@ module SkullIsland
         end
       end
 
-      def preprocess_consumer_id(input)
-        if input.is_a?(String)
+      def preprocess_consumer(input)
+        if input.is_a?(Hash)
           input
         else
-          input.id
+          { 'id' => input.id }
         end
       end
 
       # Used to validate {#consumer} on set
-      def validate_consumer_id(value)
-        # allow either a Consumer object or a String
-        value.is_a?(Consumer) || value.is_a?(String)
+      def validate_consumer(value)
+        # allow either a Consumer object or a Hash
+        value.is_a?(Consumer) || value.is_a?(Hash)
       end
 
       # Used to validate {#password} on set

data/lib/skull_island/resources/certificate.rb

@@ -5,12 +5,13 @@ module SkullIsland
   module Resources
     # The Certificate resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#certificate-object Certificate API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#certificate-object Certificate API definition
     class Certificate < Resource
       property :cert, required: true, validate: true
       property :key, required: true, validate: true
       property :snis, validate: true
       property :created_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       def self.batch_import(data, verbose: false, test: false)
         raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
@@ -20,12 +21,15 @@ module SkullIsland
           resource.cert = resource_data['cert']
           resource.key = resource_data['key']
           resource.snis = resource_data['snis'] if resource_data['snis']
+          resource.tags = resource_data['tags'] if resource_data['tags']
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
         end
       end
 
       def export(options = {})
-        hash = { 'cert' => cert, 'key' => key, 'snis' => snis }
+        hash = { 'cert' => cert, 'key' => key }
+        hash['snis'] = snis if snis && !snis.empty?
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -67,8 +71,13 @@ module SkullIsland
 
       # Used to validate {#snis} on set
       def validate_snis(value)
-        # only Array is allowed
-        value.is_a?(Array)
+        return false unless value.is_a?(Array)
+
+        # allow only valid hostnames
+        value.each do |sni|
+          return false unless sni.match?(host_regex) && !sni.match?(/_/)
+        end
+        true
       end
     end
   end

data/lib/skull_island/resources/consumer.rb

@@ -5,11 +5,12 @@ module SkullIsland
   module Resources
     # The Consumer resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#consumer-object Consumer API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#consumer-object Consumer API definition
     class Consumer < Resource
       property :username
       property :custom_id
       property :created_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       def self.batch_import(data, verbose: false, test: false)
         raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
@@ -18,12 +19,13 @@ module SkullIsland
           resource = new
           resource.username = resource_data['username']
           resource.custom_id = resource_data['custom_id']
+          resource.tags = resource_data['tags'] if resource_data['tags']
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
 
           BasicauthCredential.batch_import(
             (
               resource_data.dig('credentials', 'basic-auth') || []
-            ).map { |t| t.merge('consumer_id' => resource.id) },
+            ).map { |t| t.merge('consumer' => { 'id' => resource.id }) },
             verbose: verbose,
             test: test
           )
@@ -31,7 +33,7 @@ module SkullIsland
           KeyauthCredential.batch_import(
             (
               resource_data.dig('credentials', 'key-auth') || []
-            ).map { |t| t.merge('consumer_id' => resource.id) },
+            ).map { |t| t.merge('consumer' => { 'id' => resource.id }) },
             verbose: verbose,
             test: test
           )
@@ -75,6 +77,7 @@ module SkullIsland
         hash = { 'username' => username, 'custom_id' => custom_id }
         creds = credentials_for_export
         hash['credentials'] = creds unless creds.empty?
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -106,12 +109,12 @@ module SkullIsland
         creds = {}
         unless credentials['key-auth'].empty?
           creds['key-auth'] = credentials['key-auth'].collect do |cred|
-            cred.export(exclude: 'consumer_id')
+            cred.export(exclude: 'consumer')
           end
         end
         unless credentials['basic-auth'].empty?
           creds['basic-auth'] = credentials['basic-auth'].collect do |cred|
-            cred.export(exclude: 'consumer_id')
+            cred.export(exclude: 'consumer')
           end
         end
         creds

data/lib/skull_island/resources/keyauth_credential.rb

@@ -9,8 +9,8 @@ module SkullIsland
     class KeyauthCredential < Resource
       property :key, validate: true
       property(
-        :consumer_id,
-        required: true, validate: true, preprocess: true, postprocess: true, as: :consumer
+        :consumer,
+        required: true, validate: true, preprocess: true, postprocess: true
       )
       property :created_at, read_only: true, postprocess: true
 
@@ -20,7 +20,7 @@ module SkullIsland
         data.each_with_index do |resource_data, index|
           resource = new
           resource.key = resource_data['key']
-          resource.delayed_set(:consumer, resource_data, 'consumer_id')
+          resource.delayed_set(:consumer, resource_data, 'consumer')
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
         end
       end
@@ -39,7 +39,7 @@ module SkullIsland
 
       def export(options = {})
         hash = { 'key' => key }
-        hash['consumer_id'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
+        hash['consumer'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -56,10 +56,10 @@ module SkullIsland
 
       private
 
-      def postprocess_consumer_id(value)
-        if value.is_a?(String)
+      def postprocess_consumer(value)
+        if value.is_a?(Hash)
           Consumer.new(
-            entity: { 'id' => value },
+            entity: value,
             lazy: true,
             tainted: false
           )
@@ -68,18 +68,18 @@ module SkullIsland
         end
       end
 
-      def preprocess_consumer_id(input)
-        if input.is_a?(String)
+      def preprocess_consumer(input)
+        if input.is_a?(Hash)
           input
         else
-          input.id
+          { 'id' => input.id }
         end
       end
 
       # Used to validate {#consumer} on set
-      def validate_consumer_id(value)
-        # allow either a Consumer object or a String
-        value.is_a?(Consumer) || value.is_a?(String)
+      def validate_consumer(value)
+        # allow either a Consumer object or a Hash
+        value.is_a?(Consumer) || value.is_a?(Hash)
       end
 
       # Used to validate {#key} on set

data/lib/skull_island/resources/plugin.rb

@@ -5,16 +5,17 @@ module SkullIsland
   module Resources
     # The Plugin resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#plugin-object Plugin API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#plugin-object Plugin API definition
     class Plugin < Resource
       property :name
       property :enabled, type: :boolean
-      # property :run_on  # 1.0.x only
+      property :run_on, validate: true
       property :config, validate: true, preprocess: true, postprocess: true
-      property :consumer_id, validate: true, preprocess: true, postprocess: true, as: :consumer
-      property :route_id, validate: true, preprocess: true, postprocess: true, as: :route
-      property :service_id, validate: true, preprocess: true, postprocess: true, as: :service
+      property :consumer, validate: true, preprocess: true, postprocess: true
+      property :route, validate: true, preprocess: true, postprocess: true
+      property :service, validate: true, preprocess: true, postprocess: true
       property :created_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       def self.batch_import(data, verbose: false, test: false)
         raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
@@ -23,10 +24,12 @@ module SkullIsland
           resource = new
           resource.name = resource_data['name']
           resource.enabled = resource_data['enabled']
+          resource.run_on = resource_data['run_on'] if resource_data['run_on']
           resource.config = resource_data['config'].deep_sort if resource_data['config']
-          resource.delayed_set(:consumer, resource_data, 'consumer_id')
-          resource.delayed_set(:route, resource_data, 'route_id')
-          resource.delayed_set(:service, resource_data, 'service_id')
+          resource.tags = resource_data['tags'] if resource_data['tags']
+          resource.delayed_set(:consumer, resource_data, 'consumer')
+          resource.delayed_set(:route, resource_data, 'route')
+          resource.delayed_set(:service, resource_data, 'service')
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
         end
       end
@@ -45,9 +48,10 @@ module SkullIsland
           'enabled' => enabled?,
           'config' => config.deep_sort
         }
-        hash['consumer_id'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
-        hash['route_id'] = "<%= lookup :route, '#{route.name}' %>" if route
-        hash['service_id'] = "<%= lookup :service, '#{service.name}' %>" if service
+        hash['consumer'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
+        hash['route'] = "<%= lookup :route, '#{route.name}' %>" if route
+        hash['service'] = "<%= lookup :service, '#{service.name}' %>" if service
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -94,8 +98,7 @@ module SkullIsland
         value.deep_sort
       end
 
-      # TODO: 1.0.x requires refactoring as `consumer_id` becomes `consumer`
-      def postprocess_consumer_id(value)
+      def postprocess_consumer(value)
         if value.is_a?(Hash)
           Consumer.new(
             entity: value,
@@ -113,19 +116,17 @@ module SkullIsland
         end
       end
 
-      # TODO: 1.0.x requires refactoring as `consumer_id` becomes `consumer`
-      def preprocess_consumer_id(input)
+      def preprocess_consumer(input)
         if input.is_a?(Hash)
-          input['id']
+          input
         elsif input.is_a?(Consumer)
-          input.id
+          { 'id' => input.id }
         else
           input
         end
       end
 
-      # TODO: 1.0.x requires refactoring as `route_id` becomes `route`
-      def postprocess_route_id(value)
+      def postprocess_route(value)
         if value.is_a?(Hash)
           Route.new(
             entity: value,
@@ -143,19 +144,17 @@ module SkullIsland
         end
       end
 
-      # TODO: 1.0.x requires refactoring as `route_id` becomes `route`
-      def preprocess_route_id(input)
+      def preprocess_route(input)
         if input.is_a?(Hash)
-          input['id']
+          input
         elsif input.is_a?(Route)
-          input.id
+          { 'id' => input.id }
         else
           input
         end
       end
 
-      # TODO: 1.0.x requires refactoring as `service_id` becomes `service`
-      def postprocess_service_id(value)
+      def postprocess_service(value)
         if value.is_a?(Hash)
           Service.new(
             entity: value,
@@ -173,12 +172,11 @@ module SkullIsland
         end
       end
 
-      # TODO: 1.0.x requires refactoring as `service_id` becomes `service`
-      def preprocess_service_id(input)
+      def preprocess_service(input)
         if input.is_a?(Hash)
-          input['id']
+          input
         elsif input.is_a?(Service)
-          input.id
+          { 'id' => input.id }
         else
           input
         end
@@ -191,21 +189,27 @@ module SkullIsland
       end
 
       # Used to validate {#consumer} on set
-      def validate_consumer_id(value)
+      def validate_consumer(value)
         # allow either a Consumer object or a Hash of a specific structure
-        value.is_a?(Consumer) || value.is_a?(String)
+        value.is_a?(Consumer) || value.is_a?(Hash)
       end
 
       # Used to validate {#route} on set
-      def validate_route_id(value)
+      def validate_route(value)
+        # allow either a Route object or a Hash of a specific structure
+        value.is_a?(Route) || value.is_a?(Hash)
+      end
+
+      # Used to validate {#run_on} on set
+      def validate_run_on(value)
         # allow either a Route object or a Hash of a specific structure
-        value.is_a?(Route) || value.is_a?(String)
+        %w[first second all].include?(value)
       end
 
       # Used to validate {#service} on set
-      def validate_service_id(value)
+      def validate_service(value)
         # allow either a Service object or a Hash of a specific structure
-        value.is_a?(Service) || value.is_a?(String)
+        value.is_a?(Service) || value.is_a?(Hash)
       end
     end
   end

data/lib/skull_island/resources/route.rb

@@ -5,8 +5,9 @@ module SkullIsland
   module Resources
     # The Route resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#route-object Route API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#route-object Route API definition
     class Route < Resource
+      property :name
       property :methods
       property :paths
       property :protocols,      validate: true
@@ -14,23 +15,23 @@ module SkullIsland
       property :regex_priority, validate: true
       property :strip_path,     type: :boolean
       property :preserve_host,  type: :boolean
-      # The following are 1.0+ only
-      # property :name
-      # property :snis
-      # property :sources
-      # property :destinations
+      property :snis,           validate: true
+      property :sources
+      property :destinations
       property :service, validate: true, preprocess: true, postprocess: true
       property :created_at, read_only: true, postprocess: true
       property :updated_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/AbcSize
       def self.batch_import(data, verbose: false, test: false)
         raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
 
         data.each_with_index do |rdata, index|
           resource = new
-          # resource.name = rdata['name'] # 1.0+ only
+          resource.name = rdata['name']
           resource.methods = rdata['methods'] if rdata['methods']
           resource.paths = rdata['paths'] if rdata['paths']
           resource.protocols = rdata['protocols'] if rdata['protocols']
@@ -38,21 +39,25 @@ module SkullIsland
           resource.regex_priority = rdata['regex_priority'] if rdata['regex_priority']
           resource.strip_path = rdata['strip_path'] unless rdata['strip_path'].nil?
           resource.preserve_host = rdata['preserve_host'] unless rdata['preserve_host'].nil?
+          resource.snis = rdata['snis'] if rdata['snis']
+          resource.tags = rdata['tags'] if rdata['tags']
           resource.delayed_set(:service, rdata, 'service')
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
         end
       end
       # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/AbcSize
 
       # Provides a collection of related {Plugin} instances
       def plugins
         Plugin.where(:route, self, api_client: api_client)
       end
 
+      # rubocop:disable Metrics/AbcSize
       def export(options = {})
         hash = {
-          # 'name' => name, # 1.0+ only
+          'name' => name,
           'methods' => methods,
           'paths' => paths,
           'protocols' => protocols,
@@ -61,7 +66,9 @@ module SkullIsland
           'strip_path' => strip_path?,
           'preserve_host' => preserve_host?
         }
-        hash['service'] = { 'id' => "<%= lookup :service, '#{service.name}' %>" } if service
+        hash['service'] = "<%= lookup :service, '#{service.name}' %>" if service
+        hash['snis'] = snis if snis && !snis.empty?
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -70,15 +77,13 @@ module SkullIsland
         end
         hash.reject { |_, value| value.nil? }
       end
+      # rubocop:enable Metrics/AbcSize
 
       def modified_existing?
         return false unless new?
 
-        # Find routes of the same host, path, protocol, and service
-        same_name_and_service = self.class.where(:protocols, protocols)
-                                    .and(:hosts, hosts)
-                                    .and(:paths, paths)
-                                    .and(:service, service)
+        # Find routes of the same name and service
+        same_name_and_service = self.class.where(:name, name).and(:service, service)
 
         existing = same_name_and_service.size == 1 ? same_name_and_service.first : nil
 
@@ -140,6 +145,17 @@ module SkullIsland
         # allow either a Service object or a Hash of a specific structure
         value.is_a?(Service) || (value.is_a?(Hash) && value['id'].is_a?(String))
       end
+
+      # Used to validate {#snis} on set
+      def validate_snis(value)
+        return false unless value.is_a?(Array)
+
+        # allow only valid hostnames
+        value.each do |sni|
+          return false unless sni.match?(host_regex) && !sni.match?(/_/)
+        end
+        true
+      end
     end
   end
 end

data/lib/skull_island/resources/service.rb

@@ -5,7 +5,7 @@ module SkullIsland
   module Resources
     # The Service resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#service-object Service API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#service-object Service API definition
     class Service < Resource
       property :name
       property :retries
@@ -18,6 +18,7 @@ module SkullIsland
       property :read_timeout,       validate: true
       property :created_at, read_only: true, postprocess: true
       property :updated_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
@@ -36,6 +37,7 @@ module SkullIsland
           resource.connect_timeout = rdata['connect_timeout'] if rdata['connect_timeout']
           resource.write_timeout = rdata['write_timeout'] if rdata['write_timeout']
           resource.read_timeout = rdata['read_timeout'] if rdata['read_timeout']
+          resource.tags = rdata['tags'] if rdata['tags']
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
 
           Route.batch_import(
@@ -80,6 +82,7 @@ module SkullIsland
           'read_timeout' => read_timeout
         }
         hash['routes'] = routes.collect { |route| route.export(exclude: 'service') }
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end

data/lib/skull_island/resources/upstream.rb

@@ -5,7 +5,7 @@ module SkullIsland
   module Resources
     # The Upstream resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#upstream-objects Upstream API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#upstream-objects Upstream API definition
     class Upstream < Resource
       property :name, required: true, validate: true
       property :slots, validate: true
@@ -17,6 +17,7 @@ module SkullIsland
       property :hash_on_cookie_path, validate: true
       property :healthchecks, validate: true
       property :created_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       # rubocop:disable Metrics/CyclomaticComplexity
       # rubocop:disable Metrics/PerceivedComplexity
@@ -39,11 +40,12 @@ module SkullIsland
             resource.hash_on_cookie_path = rdata['hash_on_cookie_path']
           end
           resource.healthchecks = rdata['healthchecks'] if rdata['healthchecks']
+          resource.tags = rdata['tags'] if rdata['tags']
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
           puts '[INFO] Processing UpstreamTarget entries...' if verbose
 
           UpstreamTarget.batch_import(
-            (rdata['targets'] || []).map { |t| t.merge('upstream_id' => resource.id) },
+            (rdata['targets'] || []).map { |t| t.merge('upstream' => { 'id' => resource.id }) },
             verbose: verbose,
             test: test
           )
@@ -77,7 +79,7 @@ module SkullIsland
 
       def target(target_id)
         UpstreamTarget.new(
-          entity: { 'id' => target_id, 'upstream_id' => id },
+          entity: { 'id' => target_id, 'upstream' => { 'id' => id } },
           lazy: true,
           tainted: false,
           api_client: api_client
@@ -116,6 +118,7 @@ module SkullIsland
           'healthchecks' => healthchecks
         }
         hash['targets'] = targets.collect { |route| route.export(exclude: 'upstream_id') }
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end

data/lib/skull_island/resources/upstream_target.rb

@@ -5,15 +5,16 @@ module SkullIsland
   module Resources
     # The Upstream Target resource class
     #
-    # @see https://docs.konghq.com/0.14.x/admin-api/#target-object Target API definition
+    # @see https://docs.konghq.com/1.1.x/admin-api/#target-object Target API definition
     class UpstreamTarget < Resource
       property :target, required: true, validate: true, preprocess: true
       property(
-        :upstream_id,
-        required: true, validate: true, preprocess: true, postprocess: true, as: :upstream
+        :upstream,
+        required: true, validate: true, preprocess: true, postprocess: true
       )
       property :weight, validate: true
       property :created_at, read_only: true, postprocess: true
+      property :tags, validate: true
 
       def self.batch_import(data, verbose: false, test: false)
         raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
@@ -21,8 +22,9 @@ module SkullIsland
         data.each_with_index do |resource_data, index|
           resource = new
           resource.target = resource_data['target']
-          resource.delayed_set(:upstream, resource_data, 'upstream_id')
+          resource.delayed_set(:upstream, resource_data, 'upstream')
           resource.weight = resource_data['weight'] if resource_data['weight']
+          resource.tags = resource_data['tags'] if resource_data['tags']
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
         end
       end
@@ -46,7 +48,8 @@ module SkullIsland
 
       def export(options = {})
         hash = { 'target' => target, 'weight' => weight }
-        hash['upstream_id'] = "<%= lookup :upstream, '#{upstream.name}' %>" if upstream
+        hash['upstream'] = "<%= lookup :upstream, '#{upstream.name}' %>" if upstream
+        hash['tags'] = tags if tags
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
@@ -82,20 +85,20 @@ module SkullIsland
         end
       end
 
-      def preprocess_upstream_id(input)
+      def preprocess_upstream(input)
         if input.is_a?(Hash)
-          input['id']
-        elsif input.is_a?(String)
           input
+        elsif input.is_a?(String)
+          { 'id' => input }
         else
-          input.id
+          { 'id' => input.id }
         end
       end
 
-      def postprocess_upstream_id(value)
-        if value.is_a?(String)
+      def postprocess_upstream(value)
+        if value.is_a?(Hash)
           Upstream.new(
-            entity: { 'id' => value },
+            entity: value,
             lazy: true,
             tainted: false
           )
@@ -113,9 +116,9 @@ module SkullIsland
       end
 
       # Used to validate #upstream on set
-      def validate_upstream_id(value)
-        # allow either a Upstream object or a String
-        value.is_a?(Upstream) || value.is_a?(String)
+      def validate_upstream(value)
+        # allow either a Upstream object or a Hash
+        value.is_a?(Upstream) || value.is_a?(Hash) || value.is_a?(String)
       end
 
       # Used to validate {#weight} on set

data/lib/skull_island/validations/resource.rb

@@ -19,6 +19,15 @@ module SkullIsland
           raise Exceptions::InvalidArguments if data[name.to_s].nil?
         end
       end
+
+      # Used to validate #tags on set
+      def validate_tags(value)
+        # allow only valid hostnames
+        value.each do |tag|
+          return false unless tag.is_a?(String) && tag.match?(/\w_-\.~/)
+        end
+        true
+      end
     end
   end
 end

data/lib/skull_island/version.rb

@@ -2,8 +2,8 @@
 
 module SkullIsland
   VERSION = [
-    0,  # Major
-    14, # Minor
-    1   # Patch
+    1, # Major
+    1, # Minor
+    1  # Patch
   ].join('.')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skull_island
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deepsort
@@ -242,6 +242,7 @@ files:
 - lib/skull_island/exceptions/invalid_where_query.rb
 - lib/skull_island/exceptions/new_instance_with_id.rb
 - lib/skull_island/helpers/api_client.rb
+- lib/skull_island/helpers/migration.rb
 - lib/skull_island/helpers/resource.rb
 - lib/skull_island/helpers/resource_class.rb
 - lib/skull_island/lru_cache.rb