kongkit 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27a07fb91dbdac22f631ed9bca8c944cd2284b33
-  data.tar.gz: fc36610fb68f67d070ad0643bf3f3989f930ba30
+  metadata.gz: 21a9625c262f22f83140da50758d765ca8f12f7a
+  data.tar.gz: 5ca591d272826074cc520e911665ded42fc54ef7
 SHA512:
-  metadata.gz: 192a2966df0a1aaf62f6a79c2baee1e1a47c8548e117af52680126e42ba7a11fdac78d6050734ca0b3b45b9ed0bc6debc748d6d5176446a771ae52a3ae77e615
-  data.tar.gz: dcad30e65b60ba31e435973952bc1587f5b0a962888a0c6080c803b969c1b281b214c07adf94bdd3ccc3a1430722913883a05286f976e6cfc7298340bfa7f557
+  metadata.gz: a65d61a31eb747b5aabfbc8a316b23e1d53f733548985e1457cd9c1733566ac0c419e8029c66fb2b71296e7f1130da9acdbabe9b5dcf9052d1a0666b2148ebc4
+  data.tar.gz: 3e683b2a70ec57c49999bbc96e04bacd4e23fdc99e7f580dbb0daa851024d6a965e9093585ec985f08d8ad5b27a0e29fd49320152d4ced543589546dd608fb84

data/lib/kongkit/client/api_object.rb

@@ -11,7 +11,7 @@ module Kongkit
       # @option options [String] :upstream_url A filter on the list based on the apis `upstream_url` field
       # @option options [Integer] :size A limit on the number of objects to be returned, default: 100
       # @option options [String] :offset A cursor used for pagination. Offset is an object identifier that defines a place in the list.
-      # @return [Hash] API Objects
+      # @return [Kongkit::Client::Resource] API Objects
       def apis(options = {})
         get('/apis', query: options)
       end
@@ -20,7 +20,7 @@ module Kongkit
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#retrieve-api
       # @param identifier [String] The unique identifier or the name of the API to retrieve
-      # @return [Hash] API Object
+      # @return [Kongkit::Client::Resource] API Object
       def api(identifier)
         get(api_path(identifier))
       end
@@ -36,7 +36,7 @@ module Kongkit
       # @option attributes [String] :strip_request_path Strip the request_path value before proxying the request to the final API (optional)
       # @option attributes [String] :preserve_host Preserves the original Host header sent by the client, instead of replacing it with the hostname of the upstream_url (optional)
       # @option attributes [String] :upstream_url The base target URL that points to your API server, this URL will be used for proxying requests
-      # @return [Hash] API Object
+      # @return [Kongkit::Client::Resource] API Object
       def add_api(attributes)
         post('/apis', body: attributes)
       end
@@ -53,7 +53,7 @@ module Kongkit
       # @option attributes [String] :strip_request_path Strip the request_path value before proxying the request to the final API (optional)
       # @option attributes [String] :preserve_host Preserves the original Host header sent by the client, instead of replacing it with the hostname of the upstream_url (optional)
       # @option attributes [String] :upstream_url The base target URL that points to your API server, this URL will be used for proxying requests
-      # @return [Hash] API Object
+      # @return [Kongkit::Client::Resource] API Object
       def edit_api(identifier, attributes)
         patch(api_path(identifier), body: attributes)
       end

data/lib/kongkit/client/cluster.rb

@@ -6,7 +6,7 @@ module Kongkit
       # Retrieve the cluster status, returning information for each node in the cluster.
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#retrieve-cluster-status
-      # @return [Hash] Cluster status
+      # @return [Kongkit::Client::Resource] Cluster status
       def cluster_status
         get('/cluster')
       end

data/lib/kongkit/client/consumer.rb

@@ -9,7 +9,7 @@ module Kongkit
       # @option options [String] :username A filter on the list based on the consumer `username` field
       # @option options [Integer] :size A limit on the number of objects to be returned, default: 100
       # @option options [String] :offset A cursor used for pagination. Offset is an object identifier that defines a place in the list.
-      # @return [Hash] API Objects
+      # @return [Kongkit::Client::Resource] API Objects
       def consumers(options = {})
         get('/consumers', query: options)
       end
@@ -18,7 +18,7 @@ module Kongkit
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#retrieve-consumer
       # @param identifier [String] The unique identifier or the username of the consumer to retrieve
-      # @return [Hash] Consumer
+      # @return [Kongkit::Client::Resource] Consumer
       def consumer(identifier)
         get(consumer_path(identifier))
       end
@@ -30,7 +30,7 @@ module Kongkit
       # @see https://getkong.org/docs/0.8.x/admin-api/#create-consumer
       # @option attributes [String] :username The username of the consumer (semi-optional)
       # @option attributes [String] :custom_id Field for storing an existing ID for the consumer, useful for mapping Kong with users in your existing database (semi-optional)
-      # @return [Hash] Consumer
+      # @return [Kongkit::Client::Resource] Consumer
       def create_consumer(attributes)
         post('/consumers', body: attributes)
       end
@@ -43,7 +43,7 @@ module Kongkit
       # @param identifier [String] The unique identifier or the name of the consumer to update
       # @option attributes [String] :username The username of the consumer (semi-optional)
       # @option attributes [String] :custom_id Field for storing an existing ID for the consumer, useful for mapping Kong with users in your existing database (semi-optional)
-      # @return [Hash] Consumer
+      # @return [Kongkit::Client::Resource] Consumer
       def edit_consumer(identifier, attributes)
         patch(consumer_path(identifier), body: attributes)
       end

data/lib/kongkit/client/key_authentication.rb

@@ -0,0 +1,39 @@
+module Kongkit
+  class Client
+    module KeyAuthentication
+      # List Auth Keys for the given consumer
+      #
+      # @see https://getkong.org/plugins/key-authentication/
+      # @param identifier [String] The unique identifier or the username of the consumer
+      # @return [Kongkit::Client::Resource] Auth Keys
+      def auth_keys(identifier)
+        get(auth_key_path(identifier))
+      end
+
+      # Create a new Auth Key for the given consumer
+      #
+      # @see https://getkong.org/plugins/key-authentication/
+      # @param identifier [String] The unique identifier or the username of the consumer
+      # @return [Kongkit::Client::Resource] Auth Keys
+      def add_auth_key(identifier)
+        post(auth_key_path(identifier))
+      end
+
+      # Delete Auth Key
+      #
+      # @see https://getkong.org/docs/0.8.x/admin-api/#delete-consumer
+      # @param identifier [String] The unique identifier or the name of the consumer to delete
+      # @param id [String] The unique identifier of the Auth Key
+      # @return [Boolean] `true` if successfully deleted
+      def delete_auth_key(identifier, id)
+        delete("#{auth_key_path(identifier)}/#{id}")
+      end
+
+      private
+
+      def auth_key_path(identifier)
+        "#{consumer_path(identifier)}/key-auth"
+      end
+    end
+  end
+end

data/lib/kongkit/client/node.rb

@@ -6,7 +6,7 @@ module Kongkit
       # Retrieve generic details about a node.
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#retrieve-node-information
-      # @return [Hash] Node information
+      # @return [Kongkit::Client::Resource] Node information
       def node_information
         get('/')
       end
@@ -22,7 +22,7 @@ module Kongkit
       # every existing nginx monitoring tool or agent can be used.
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#retrieve-node-status
-      # @return [Hash] Node status
+      # @return [Kongkit::Client::Resource] Node status
       def node_status
         get('/status')
       end

data/lib/kongkit/client/plugin_object.rb

@@ -10,7 +10,7 @@ module Kongkit
       # @option options [String] :consumer_id A filter on the list based on the `consumer_id` field
       # @option options [Integer] :size A limit on the number of objects to be returned, default: 100
       # @option options [offset] :offset A cursor used for pagination. offset is an object identifier that defines a place in the list.
-      # @return [Hash] Plugin Objects
+      # @return [Kongkit::Client::Resource] Plugin Objects
       def plugins(options = {})
         get('/plugins', options)
       end
@@ -20,7 +20,7 @@ module Kongkit
       # Retrieve a list of all installed plugins on the Kong node.
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#list-enabled-plugins
-      # @return [Hash] Plugin Objects
+      # @return [Kongkit::Client::Resource] Plugin Objects
       def enabled_plugins
         get('/plugins/enabled')
       end
@@ -33,7 +33,7 @@ module Kongkit
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#list-enabled-plugins
       # @param name [String] The name of the plugin to retrieve its schema
-      # @return [Hash] Plugin Objects
+      # @return [Kongkit::Client::Resource] Plugin Objects
       def plugin_schema(name)
         get("/plugins/schema/#{name}")
       end
@@ -42,7 +42,7 @@ module Kongkit
       #
       # @see https://getkong.org/docs/0.8.x/admin-api/#retrieve-plugin
       # @param id [String] The unique identifier of the plugin to retrieve
-      # @return [Hash] Plugin Object
+      # @return [Kongkit::Client::Resource] Plugin Object
       def plugin(id)
         get("/plugins/#{id}")
       end
@@ -57,7 +57,7 @@ module Kongkit
       # @option options [String] :consumer_id A filter on the list based on the `consumer_id` field
       # @option options [Integer] :size A limit on the number of objects to be returned, default: 100
       # @option options [offset] :offset A cursor used for pagination. offset is an object identifier that defines a place in the list.
-      # @return [Hash] Plugin Objects
+      # @return [Kongkit::Client::Resource] Plugin Objects
       def api_plugins(api_identifier, options = {})
         get(api_plugins_path(api_identifier), options)
       end
@@ -69,7 +69,7 @@ module Kongkit
       # @option attributes [String] :name The name of the Plugin that's going to be added.
       # @option attributes [String] :consumer_id The unique identifier of the consumer that overrides the existing settings for this specific consumer on incoming requests (optional)
       # @option attributes [String] :config.{property} The configuration properties for the Plugin.
-      # @return [Hash] Plugin Object
+      # @return [Kongkit::Client::Resource] Plugin Object
       def add_plugin(api_identifier, attributes)
         post(api_plugins_path(api_identifier), body: attributes)
       end
@@ -82,7 +82,7 @@ module Kongkit
       # @option attributes [String] :name The name of the Plugin that's going to be added.
       # @option attributes [String] :consumer_id The unique identifier of the consumer that overrides the existing settings for this specific consumer on incoming requests (optional)
       # @option attributes [String] :config.{property} The configuration properties for the Plugin.
-      # @return [Hash] Plugin Object
+      # @return [Kongkit::Client::Resource] Plugin Object
       def edit_plugin(api_identifier, id, attributes)
         patch(api_plugin_path(api_identifier, id), body: attributes)
       end

data/lib/kongkit/client/resource.rb

@@ -48,6 +48,13 @@ module Kongkit
         status_code >= 400
       end
 
+      # Return the JSON representation of the resource
+      #
+      # @return [Hash] JSON representation
+      def to_json
+        data.merge({status_code: status_code})
+      end
+
       private
 
       attr_reader :client, :data, :status_code

data/lib/kongkit/client.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'kongkit/client/api_object'
 require 'kongkit/client/cluster'
 require 'kongkit/client/consumer'
+require 'kongkit/client/key_authentication'
 require 'kongkit/client/plugin_object'
 require 'kongkit/client/node'
 require 'kongkit/client/request'
@@ -16,6 +17,7 @@ module Kongkit
     include ApiObject
     include Cluster
     include Consumer
+    include KeyAuthentication
     include PluginObject
     include Node
     include Request

data/lib/kongkit/version.rb

@@ -1,3 +1,3 @@
 module Kongkit
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kongkit
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Fabian Mettler
@@ -144,6 +144,7 @@ files:
 - lib/kongkit/client/api_object.rb
 - lib/kongkit/client/cluster.rb
 - lib/kongkit/client/consumer.rb
+- lib/kongkit/client/key_authentication.rb
 - lib/kongkit/client/node.rb
 - lib/kongkit/client/plugin_object.rb
 - lib/kongkit/client/request.rb