skull_island 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6ae44ca3ddea5f866e493af05df16b8355716442acd5a475e1177049260177
-  data.tar.gz: 41ee93c3a6491b28b7e516e3b13166506080f52fa6b3f439bc4510e77b8cae39
+  metadata.gz: e7c23619533ea2d31b5c07763270b49b90567bd9c4286579de345791dc3e2ae6
+  data.tar.gz: 172d74c57ef9263fb9511aedde42f7d0287ed746888bdb781cfcf9ae2fb5b297
 SHA512:
-  metadata.gz: 5996e8c7bf5773c8d43f98d2d85f8590d47caa61d19d9a198a4252f6e34f834dd41ff9989ea3726eedbb94ae323b3b79d0c6ad472ab8d6525eb902911191c0f5
-  data.tar.gz: 48f5e8d92c92c6ab399426c3ba39687a20c091dfe01f5c0126cb13d935f6efdf8fd906f0ae38fbb140c740d17781e80e866572c8d4cdab2a0ecc6cc417fb7af6
+  metadata.gz: 93d0089177792126e8a72a47d6843de52edba872e0e3f6a43ec471a5d058ba6834f3388b35193bcb899b841e5f15c11fc65d37362b790af7e9df8a353ec05d67
+  data.tar.gz: 2e626e9e42511472e7deab0ce83db1e2adb4e3b54c62a51cc7107d8b171e5b6dc5e42254936a2691f0c4da597056acb1b1cf58b5a7fbc753b2da60134809b370

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    skull_island (0.2.0)
+    skull_island (0.2.2)
+      deepsort (~> 0.4)
       erubi (~> 1.8)
       json (~> 2.1)
       linguistics (~> 2.1)
@@ -15,6 +16,7 @@ GEM
     addressable (2.4.0)
     ast (2.4.0)
     backports (3.12.0)
+    deepsort (0.4.1)
     diff-lcs (1.3)
     docile (1.3.1)
     domain_name (0.5.20180417)

data/README.md

@@ -13,7 +13,7 @@ gem install skull_island
 Or add this to your Gemfile:
 
 ```ruby
-gem 'skull_island',  '~>0.1'
+gem 'skull_island',  '~>0.2'
 ```
 
 Or add this to your .gemspec:
@@ -21,14 +21,14 @@ Or add this to your .gemspec:
 ```ruby
 Gem::Specification.new do |spec|
  # ...
- spec.add_runtime_dependency 'skull_island', '~> 0.1'
+ spec.add_runtime_dependency 'skull_island', '~> 0.2'
  # ...
 end
 ```
 
 ## CLI Usage
 
-Skull Island comes with an executable called `skull_island` that leverages the SDK under the hood. Learn about what is can do via `help`:
+Skull Island comes with an executable called `skull_island` that leverages the SDK under the hood. Learn about what it can do via `help`:
 
 ```
 $ skull_island help
@@ -246,7 +246,7 @@ resource.created_at
 # => #<DateTime: 2018-07-17T12:51:28+00:00 ((2458317j,46288s,0n),+0s,2299161j)>
 ```
 
-#### Consumers
+#### Consumers (and their Credentials)
 
 ```ruby
 resource = Resources::Consumer.new
@@ -264,6 +264,20 @@ resource.created_at
 # => #<DateTime: 2018-07-17T12:51:28+00:00 ((2458317j,46288s,0n),+0s,2299161j)>
 resource.plugins
 # => #<SkullIsland::ResourceCollection:0x00007f9f1e564f3e...
+resource.credentials
+# => {}
+resource.add_credential!(key: '932948e89e09e2989d8092') # adds a KeyauthCredential
+# => true
+resource.credentials['key-auth']
+# => #<SkullIsland::ResourceCollection:0x00007f9f1e564f3f...
+resource.credentials['key-auth'].first.key
+# => "932948e89e09e2989d8092"
+resource.add_credential!(username: 'test', password: 'passw0rd') # adds a BasicauthCredential
+# => true
+resource.credentials['basic-auth']
+# => #<SkullIsland::ResourceCollection:0x00007f9f1e564f3f...
+resource.credentials['basic-auth'].first.username
+# => "test"
 ```
 
 #### Plugins

data/lib/skull_island.rb

@@ -9,6 +9,7 @@ require 'uri'
 require 'yaml'
 
 # External Library Requirements
+require 'deepsort'
 require 'erubi'
 require 'linguistics'
 Linguistics.use(:en)
@@ -42,6 +43,8 @@ require 'skull_island/helpers/resource_class'
 require 'skull_island/validations/resource'
 require 'skull_island/resource'
 require 'skull_island/resources/certificate'
+require 'skull_island/resources/basicauth_credential'
+require 'skull_island/resources/keyauth_credential'
 require 'skull_island/resources/consumer'
 require 'skull_island/resources/plugin'
 require 'skull_island/resources/service'

data/lib/skull_island/helpers/resource.rb

@@ -79,11 +79,11 @@ module SkullIsland
         if find_by_digest
           puts "[INFO] Skipping #{self.class} index #{index} (#{id})" if verbose
         elsif test
-          puts "[INFO] Would have saved #{sef.class} index #{index}"
+          puts "[INFO] Would have saved #{self.class} index #{index}"
         elsif modified_existing?
           puts "[INFO] Modified #{self.class} index #{index} (#{id})" if verbose
         elsif save
-          puts "[INFO] Saved #{self.class} index #{index} (#{id})" if verbose
+          puts "[INFO] Created #{self.class} index #{index} (#{id})" if verbose
         else
           puts "[ERR] Failed to save #{self.class} index #{index}"
         end
@@ -187,7 +187,7 @@ module SkullIsland
           @lazy    = true
         else
           @api_client.invalidate_cache_for(relative_uri.to_s)
-          @entity = @api_client.put(relative_uri, saveable_data)
+          @entity = @api_client.patch(relative_uri, saveable_data)
         end
         @api_client.invalidate_cache_for(self.class.relative_uri.to_s) # clear any collection class
         @tainted = false

data/lib/skull_island/resource.rb

@@ -58,7 +58,7 @@ module SkullIsland
           raise Exceptions::ImmutableModification if immutable?
 
           if opts[:validate]
-            raise Exceptions::InvalidArguments unless send("validate_#{name}".to_sym, value)
+            raise Exceptions::InvalidArguments, name unless send("validate_#{name}".to_sym, value)
           end
           @entity[name.to_s] = if opts[:preprocess]
                                  send("preprocess_#{name}".to_sym, value)

data/lib/skull_island/resources/basicauth_credential.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module SkullIsland
+  # Resource classes go here...
+  module Resources
+    # The BasicauthCredential resource class
+    #
+    # @see https://docs.konghq.com/hub/kong-inc/key-auth/ Key-Auth API definition
+    class BasicauthCredential < Resource
+      property :username, required: true, validate: true
+      property :password, validated: true
+      property(
+        :consumer_id,
+        required: true, validate: true, preprocess: true, postprocess: true, as: :consumer
+      )
+      property :created_at, read_only: true, postprocess: true
+
+      def self.batch_import(data, verbose: false, test: false)
+        raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
+
+        data.each_with_index do |resource_data, index|
+          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.import_update_or_skip(index: index, verbose: verbose, test: test)
+        end
+      end
+
+      def self.relative_uri
+        'basic-auths'
+      end
+
+      def relative_uri
+        consumer ? "#{consumer.relative_uri}/basic-auth/#{id}" : nil
+      end
+
+      def save_uri
+        consumer ? "#{consumer.relative_uri}/basic-auth" : nil
+      end
+
+      def export(options = {})
+        hash = { 'username' => username, 'password' => password }
+        hash['consumer_id'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
+        [*options[:exclude]].each do |exclude|
+          hash.delete(exclude.to_s)
+        end
+        [*options[:include]].each do |inc|
+          hash[inc.to_s] = send(inc.to_sym)
+        end
+        hash.reject { |_, value| value.nil? }
+      end
+
+      # Keys can't be updated, only created or deleted
+      def modified_existing?
+        false
+      end
+
+      private
+
+      def postprocess_consumer_id(value)
+        if value.is_a?(String)
+          Consumer.new(
+            entity: { 'id' => value },
+            lazy: true,
+            tainted: false
+          )
+        else
+          value
+        end
+      end
+
+      def preprocess_consumer_id(input)
+        if input.is_a?(String)
+          input
+        else
+          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)
+      end
+
+      # Used to validate {#password} on set
+      def validate_password(value)
+        # allow a String
+        value.is_a?(String)
+      end
+
+      # Used to validate {#username} on set
+      def validate_username(value)
+        # allow a String
+        value.is_a?(String)
+      end
+    end
+  end
+end

data/lib/skull_island/resources/certificate.rb

@@ -30,7 +30,7 @@ module SkullIsland
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end

data/lib/skull_island/resources/consumer.rb

@@ -19,9 +19,53 @@ module SkullIsland
           resource.username = resource_data['username']
           resource.custom_id = resource_data['custom_id']
           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) },
+            verbose: verbose,
+            test: test
+          )
+
+          KeyauthCredential.batch_import(
+            (
+              resource_data.dig('credentials', 'key-auth') || []
+            ).map { |t| t.merge('consumer_id' => resource.id) },
+            verbose: verbose,
+            test: test
+          )
         end
       end
 
+      # Convenience method to add upstream targets
+      def add_credential!(details)
+        r = if [BasicauthCredential, KeyauthCredential].include? details.class
+              details
+            elsif details.is_a?(Hash) && details.key?(:key)
+              cred = KeyauthCredential.new(api_client: api_client)
+              cred.key = details[:key]
+              cred
+            elsif details.is_a?(Hash) && details.key?(:username)
+              cred = BasicauthCredential.new(api_client: api_client)
+              cred.username = details[:username]
+              cred.password = details[:password]
+              cred
+            end
+
+        r.consumer = self
+        r.save
+      end
+
+      def credentials
+        creds = {}
+        keyauth_creds = KeyauthCredential.where(:consumer, self, api_client: api_client)
+        creds['key-auth'] = keyauth_creds if keyauth_creds
+        basicauth_creds = BasicauthCredential.where(:consumer, self, api_client: api_client)
+        creds['basic-auth'] = basicauth_creds if basicauth_creds
+        creds
+      end
+
       # Provides a collection of related {Plugin} instances
       def plugins
         Plugin.where(:consumer, self, api_client: api_client)
@@ -29,11 +73,13 @@ module SkullIsland
 
       def export(options = {})
         hash = { 'username' => username, 'custom_id' => custom_id }
+        creds = credentials_for_export
+        hash['credentials'] = creds unless creds.empty?
         [*options[:exclude]].each do |exclude|
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end
@@ -53,6 +99,23 @@ module SkullIsland
           false
         end
       end
+
+      private
+
+      def credentials_for_export
+        creds = {}
+        unless credentials['key-auth'].empty?
+          creds['key-auth'] = credentials['key-auth'].collect do |cred|
+            cred.export(exclude: 'consumer_id')
+          end
+        end
+        unless credentials['basic-auth'].empty?
+          creds['basic-auth'] = credentials['basic-auth'].collect do |cred|
+            cred.export(exclude: 'consumer_id')
+          end
+        end
+        creds
+      end
     end
   end
 end

data/lib/skull_island/resources/keyauth_credential.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module SkullIsland
+  # Resource classes go here...
+  module Resources
+    # The KeyauthCredential resource class
+    #
+    # @see https://docs.konghq.com/hub/kong-inc/key-auth/ Key-Auth API definition
+    class KeyauthCredential < Resource
+      property :key, validate: true
+      property(
+        :consumer_id,
+        required: true, validate: true, preprocess: true, postprocess: true, as: :consumer
+      )
+      property :created_at, read_only: true, postprocess: true
+
+      def self.batch_import(data, verbose: false, test: false)
+        raise(Exceptions::InvalidArguments) unless data.is_a?(Array)
+
+        data.each_with_index do |resource_data, index|
+          resource = new
+          resource.key = resource_data['key']
+          resource.delayed_set(:consumer, resource_data, 'consumer_id')
+          resource.import_update_or_skip(index: index, verbose: verbose, test: test)
+        end
+      end
+
+      def self.relative_uri
+        'key-auths'
+      end
+
+      def relative_uri
+        consumer ? "#{consumer.relative_uri}/key-auth/#{id}" : nil
+      end
+
+      def save_uri
+        consumer ? "#{consumer.relative_uri}/key-auth" : nil
+      end
+
+      def export(options = {})
+        hash = { 'key' => key }
+        hash['consumer_id'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
+        [*options[:exclude]].each do |exclude|
+          hash.delete(exclude.to_s)
+        end
+        [*options[:include]].each do |inc|
+          hash[inc.to_s] = send(inc.to_sym)
+        end
+        hash.reject { |_, value| value.nil? }
+      end
+
+      # Keys can't be updated, only created or deleted
+      def modified_existing?
+        false
+      end
+
+      private
+
+      def postprocess_consumer_id(value)
+        if value.is_a?(String)
+          Consumer.new(
+            entity: { 'id' => value },
+            lazy: true,
+            tainted: false
+          )
+        else
+          value
+        end
+      end
+
+      def preprocess_consumer_id(input)
+        if input.is_a?(String)
+          input
+        else
+          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)
+      end
+
+      # Used to validate {#key} on set
+      def validate_key(value)
+        # allow a String
+        value.is_a?(String)
+      end
+    end
+  end
+end

data/lib/skull_island/resources/plugin.rb

@@ -10,7 +10,7 @@ module SkullIsland
       property :name
       property :enabled, type: :boolean
       # property :run_on  # 1.0.x only
-      property :config, 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
@@ -23,7 +23,7 @@ module SkullIsland
           resource = new
           resource.name = resource_data['name']
           resource.enabled = resource_data['enabled']
-          resource.config = resource_data['config'] if resource_data['config']
+          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')
@@ -43,7 +43,7 @@ module SkullIsland
         hash = {
           'name' => name,
           'enabled' => enabled?,
-          'config' => config
+          'config' => config.deep_sort
         }
         hash['consumer_id'] = "<%= lookup :consumer, '#{consumer.username}' %>" if consumer
         hash['route_id'] = "<%= lookup :route, '#{route.name}' %>" if route
@@ -52,7 +52,7 @@ module SkullIsland
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end
@@ -86,6 +86,14 @@ module SkullIsland
 
       private
 
+      def preprocess_config(input)
+        input.deep_sort
+      end
+
+      def postprocess_config(value)
+        value.deep_sort
+      end
+
       # TODO: 1.0.x requires refactoring as `consumer_id` becomes `consumer`
       def postprocess_consumer_id(value)
         if value.is_a?(Hash)

data/lib/skull_island/resources/route.rb

@@ -68,7 +68,7 @@ module SkullIsland
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end

data/lib/skull_island/resources/service.rb

@@ -19,6 +19,8 @@ module SkullIsland
       property :created_at, read_only: true, postprocess: true
       property :updated_at, read_only: true, postprocess: 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)
@@ -37,12 +39,14 @@ module SkullIsland
           resource.import_update_or_skip(index: index, verbose: verbose, test: test)
 
           Route.batch_import(
-            rdata['routes'].map { |r| r.merge('service' => { 'id' => resource.id }) },
+            (rdata['routes'] || []).map { |r| r.merge('service' => { 'id' => resource.id }) },
             verbose: verbose,
             test: test
           )
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
       # rubocop:enable Metrics/AbcSize
 
       # Convenience method to add routes
@@ -80,7 +84,7 @@ module SkullIsland
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end

data/lib/skull_island/resources/upstream.rb

@@ -43,7 +43,7 @@ module SkullIsland
           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
           )
@@ -120,7 +120,7 @@ module SkullIsland
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end

data/lib/skull_island/resources/upstream_target.rb

@@ -51,7 +51,7 @@ module SkullIsland
           hash.delete(exclude.to_s)
         end
         [*options[:include]].each do |inc|
-          hash[inc.to_s] = send(:inc)
+          hash[inc.to_s] = send(inc.to_sym)
         end
         hash.reject { |_, value| value.nil? }
       end

data/lib/skull_island/version.rb

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

data/skull_island.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.5'
 
+  spec.add_runtime_dependency 'deepsort', '~> 0.4'
   spec.add_runtime_dependency 'erubi', '~> 1.8'
   spec.add_runtime_dependency 'json', '~> 2.1'
   spec.add_runtime_dependency 'linguistics', '~> 2.1'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: skull_island
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Jonathan Gnagy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-06 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: deepsort
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: erubi
   requirement: !ruby/object:Gem::Requirement
@@ -232,8 +246,10 @@ files:
 - lib/skull_island/lru_cache.rb
 - lib/skull_island/resource.rb
 - lib/skull_island/resource_collection.rb
+- lib/skull_island/resources/basicauth_credential.rb
 - lib/skull_island/resources/certificate.rb
 - lib/skull_island/resources/consumer.rb
+- lib/skull_island/resources/keyauth_credential.rb
 - lib/skull_island/resources/plugin.rb
 - lib/skull_island/resources/route.rb
 - lib/skull_island/resources/service.rb