kodmin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e01fb7cb8499fb6440f0eb149c4ceeba1ed722160382803310069235bed179f7
+  data.tar.gz: c2de270472ce412a75c8b95f05fac239308f2d91dc0e89163c6adf95e3dad318
+SHA512:
+  metadata.gz: bec3f58de443e770824833207894ac1a082bf7304effbc4f94d6196d45851238b0847a9137f45895b3bd71d0f66c698ad8f9c229335bdcfd4a4bb9f392c31784
+  data.tar.gz: fbe60ec196e0cc88048d5993d9e65babc54ac5c2239cceb65e4f1dddd81bf0f8f020b88fa33c0bdd4c25dffb338f091c749df3f22820e3be15a718386c9a1abc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+*.DS_Store
+.idea

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kodmin.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    kodmin (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.0)
+    rake (13.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  kodmin!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Wu Zixing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Kodmin
+
+It is the ruby client of [kong](https://github.com/Kong/kong)'s admin API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kodmin'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install kodmin
+
+## Usage
+
+```ruby
+require 'kodmin'
+
+# initialize the client
+Kodmin.init('http://kong.amdin.url') 
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wuzixing/kodmin.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kodmin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kodmin.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/kodmin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kodmin"
+  spec.version       = Kodmin::VERSION
+  spec.authors       = ["Wu Zixing"]
+  spec.email         = ["wzixing@gmail.com"]
+
+  spec.summary       = %q{A ruby client of kong's admin API v2.x.}
+  spec.homepage      = "https://github.com/WuZixing/kodmin"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/WuZixing/kodmin.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/kodmin.rb

@@ -0,0 +1,16 @@
+require_relative 'kodmin/version'
+require_relative 'kodmin/consumers'
+require_relative 'kodmin/plugins'
+
+# Client of kong's admin API.
+module Kodmin
+  class << self
+    def consumers
+      Kodmin::Consumers.instance
+    end
+
+    def plugins
+      Kodmin::Plugins.instance
+    end
+  end
+end

data/lib/kodmin/client.rb

@@ -0,0 +1,95 @@
+require 'json'
+require 'net/http'
+
+# Client of kong's admin API.
+module Kodmin
+  # Error.
+  class Error < StandardError
+    def initialize(code, error)
+      super("#{code}: #{error}")
+    end
+  end
+
+  # HTTP client of API.
+  module Client
+    class << self
+      attr_accessor :kong_url
+    end
+
+    def get(path, query_params = {})
+      uri = uri_of(path, query_params)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Get.new(uri.request_uri)
+        set_request_headers(req)
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    def post(path, data = {})
+      uri = uri_of(path)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Post.new(uri.request_uri)
+        set_request_headers(req)
+        req['Content-Type'] = 'application/json'
+        req.body = data.to_json
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    def put(path, data = {})
+      uri = uri_of(path)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Put.new(uri.request_uri)
+        set_request_headers(req)
+        req['Content-Type'] = 'application/json'
+        req.body = data.to_json
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    def delete(path, query_params = {})
+      uri = uri_of(path, query_params)
+      resp = Net::HTTP.start(uri.host, uri.port, nil, nil, nil, nil, use_ssl: (uri.scheme == 'https')) do |http|
+        req = Net::HTTP::Delete.new(uri.request_uri)
+        set_request_headers(req)
+        http.request(req)
+      end
+      check_and_return(resp)
+    end
+
+    private
+
+    def uri_of(path, query_params = {})
+      url = Client.kong_url + path
+      if query_params.empty?
+        URI(url)
+      else
+        queries = URI.encode_www_form(query_params)
+        url.include?('?') ? URI(url + '&' + queries) : URI(url + '?' + queries)
+      end
+    end
+
+    def set_request_headers(request)
+      request[:Accept] = 'application/json'
+    end
+
+    def check_and_return(response)
+      if response.is_a?(Net::HTTPSuccess)
+        response.body
+      else
+        raise Error.new(response.code, response.body)
+      end
+    end
+  end
+
+  class << self
+    # Initialize the Kong admin client.
+    # @param kong_url [String] URL of the Kong Admin API, e.x. 'http://127.0.0.1:8001'.
+    def init(kong_url)
+      Client.kong_url = kong_url.delete_suffix('/')
+    end
+  end
+end

data/lib/kodmin/consumers.rb

@@ -0,0 +1,133 @@
+require 'singleton'
+require 'securerandom'
+require_relative 'client'
+
+module Kodmin
+  # Consumer of Kong API.
+  class Consumer
+    attr_accessor :id, :username, :custom_id, :created_at, :tags
+
+    # New a consumer.
+    # @param attributes [Hash] attributes of a consumer.
+    def initialize(attributes = {})
+      from_hash(attributes)
+    end
+
+    # Assign attributes from a Hash.
+    # @param attributes [Hash] attributes.
+    def from_hash(attributes)
+      attributes.each_key do |key|
+        setter = "#{key}=".to_sym
+        send(setter, attributes[key]) if respond_to?(setter)
+      end
+    end
+
+    def to_hash
+      hash = {}
+      hash[:id] = id unless id.nil?
+      hash[:username] = username unless username.nil?
+      hash[:custom_id] = custom_id unless custom_id.nil?
+      hash[:created_at] = created_at unless created_at.nil?
+      hash[:tags] = tags unless tags.nil?
+      hash
+    end
+
+    # Consumer's HMAC credential.
+    class HmacAuth
+      attr_accessor :id, :consumer, :username, :secret, :created_at
+
+      # New a HmacAuth.
+      # @param attributes [Hash] attributes of the HmacAuth.
+      def initialize(attributes = {})
+        from_hash(attributes)
+      end
+
+      # Assign attributes from a Hash object.
+      # @param attributes [Hash] hash representation of attributes.
+      def from_hash(attributes)
+        attributes.each_key do |key|
+          if key.to_sym == :consumer
+            self.consumer = Consumer.new(attributes[key])
+          else
+            setter = "#{key}=".to_sym
+            send(setter, attributes[key]) if respond_to?(setter)
+          end
+        end
+      end
+
+      def to_hash
+        hash = {}
+        hash[:id] = id unless id.nil?
+        hash[:consumer] = consumer.to_hash unless consumer.nil?
+        hash[:username] = username unless username.nil?
+        hash[:secret] = secret unless secret.nil?
+        hash[:created_at] = created_at unless created_at.nil?
+        hash
+      end
+    end
+  end
+
+  # Operations on consumer.
+  class Consumers
+    include Singleton
+    include Client
+
+    # List a page of consumers.
+    # @param offset [String] the offset token for pagination. An empty offset token refers to the first page.
+    # @return [Hash] a Hash with keys of :consumers and :offset.
+    def list_consumers(offset = '')
+      params = offset.empty? ? {} : { offset: offset }
+      resp = get('/consumers', params)
+      resp = JSON.parse(resp)
+      consumers = []
+      resp['data'].each do |v|
+        consumers << Consumer.new(v)
+      end
+      offset_token = nil
+      unless resp['next'].nil? || resp['next'].empty?
+        offset_token = resp['next'].split('=')[1]
+      end
+      { consumers: consumers, offset: offset_token }
+    end
+
+    # Create a new consumer.
+    # @param attributes [Hash] attributes of the consumer.
+    # @return [Consumer] the created consumer.
+    def create_consumer(attributes)
+      resp = post('/consumers', attributes)
+      Consumer.new(JSON.parse(resp))
+    end
+
+    # Delete a consumer.
+    # @param id [String] id of the consumer to be removed.
+    def delete_consumer(id)
+      delete("/consumers/#{id}")
+    end
+
+    # Get a consumers's HMAC credentials.
+    # @param id [String] id of the consumer.
+    # @param offset [String] the offset token for pagination. An empty offset token refers to the first page.
+    # @return [Hash] a Hash with keys of :credentials and :offset.
+    def list_consumer_hmac_credentials(id, offset = '')
+      params = offset.empty? ? {} : { offset: offset }
+      resp = get("/consumers/#{id}/hmac-auth", params)
+      resp = JSON.parse(resp)
+      credentials = []
+      resp['data'].each do |v|
+        credentials << Consumer::HmacAuth.new(v)
+      end
+      offset_token = nil
+      unless resp['next'].nil? || resp['next'].empty?
+        offset_token = resp['next'].split('=')[1]
+      end
+      { credentials: credentials, offset: offset_token }
+    end
+
+    def create_consumer_hmac_credential(id)
+      access_key = SecureRandom.hex(16)
+      secret_key = SecureRandom.hex(16)
+      resp = post("/consumers/#{id}/hmac-auth", {username: access_key, secret: secret_key})
+      Consumer::HmacAuth.new(JSON.parse(resp))
+    end
+  end
+end

data/lib/kodmin/plugins.rb

@@ -0,0 +1,43 @@
+require 'singleton'
+require_relative 'client'
+require_relative 'plugins/hmac_auth'
+
+module Kodmin
+  # Plugins of Kong.
+  class Plugins
+    include Singleton
+    include Client
+
+    def list_plugins(offset = '')
+      params = offset.empty? ? {} : { offset: offset }
+      resp = get('/plugins', params)
+      resp = JSON.parse(resp)
+      plugins = []
+      resp['data'].each do |v|
+        plugins << plugin_from_hash(v)
+      end
+      offset_token = nil
+      unless resp['next'].nil? || resp['next'].empty?
+        offset_token = resp['next'].split('=')[1]
+      end
+      { plugins: plugins, offset: offset_token }
+    end
+
+    def enable_plugin(attributes)
+      resp = post('/plugins', attributes)
+      resp = JSON.parse(resp)
+      plugin_from_hash(resp)
+    end
+
+    def disable_plugin(id)
+      delete("/plugins/#{id}")
+    end
+
+    def plugin_from_hash(attributes)
+      case attributes['name']
+      when Kodmin::Plugins::HmacAuth::NAME then Kodmin::Plugins::HmacAuth.new(attributes)
+      else Kodmin::Plugins::Plugin.new(attributes)
+      end
+    end
+  end
+end

data/lib/kodmin/plugins/hmac_auth.rb

@@ -0,0 +1,61 @@
+require_relative 'plugin'
+
+module Kodmin
+  class Plugins
+    # Plugin: hmac-auth
+    class HmacAuth < Plugin
+      NAME = 'hmac-auth'.freeze
+
+      # HMAC auth's nested configuration.
+      class Config
+        attr_accessor :hide_credentials, :clock_skew, :anonymous, :validate_request_body, :enforce_headers, :algorithms
+        def initialize(attrs = {})
+          attrs.each_key do |key|
+            setter = "#{key}="
+            send(setter, attrs[key]) if respond_to?(setter)
+          end
+        end
+
+        def to_hash
+          hash = {}
+          hash[:hide_credentials] = hide_credentials unless hide_credentials.nil?
+          hash[:clock_skew] = clock_skew unless clock_skew.nil?
+          hash[:anonymous] = anonymous unless anonymous.nil?
+          hash[:validate_request_body] = validate_request_body unless validate_request_body.nil?
+          hash[:enforce_headers] = enforce_headers unless enforce_headers.nil?
+          hash[:algorithms] = algorithms unless algorithms.nil?
+          hash
+        end
+      end
+
+      attr_accessor :config
+
+      def initialize(attrs = {})
+        form_hash(attrs)
+      end
+
+      def name
+        HmacAuth::NAME
+      end
+
+      def to_hash
+        hash = super
+        hash[:config] = config.to_hash unless config.nil?
+        hash
+      end
+
+      # Assign attributes from Hash.
+      # @param attrs [Hash] attributes in Hash object.
+      def form_hash(attrs = {})
+        attrs.each_key do |key|
+          if key.to_sym == :config
+            self.config = HmacAuth::Config.new(attrs[key])
+          else
+            setter = "#{key}=".to_sym
+            send(setter, attrs[key]) if respond_to?(setter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kodmin/plugins/plugin.rb

@@ -0,0 +1,31 @@
+module Kodmin
+  class Plugins
+    # Basic definition of plugin.
+    class Plugin
+      attr_reader :name
+      attr_accessor :id, :created_at, :protocols, :enabled, :tags
+
+      def initialize(attributes = {})
+        from_hash(attributes)
+      end
+
+      def from_hash(attributes)
+        attributes.each_key do |key|
+          setter = "#{key}=".to_sym
+          send(setter, attributes[key]) if respond_to?(setter)
+        end
+      end
+
+      def to_hash
+        hash = {}
+        hash[:name] = name unless name.nil?
+        hash[:id] = id unless nil.nil?
+        hash[:created_at] = created_at unless created_at.nil?
+        hash[:protocols] = protocols unless protocols.nil?
+        hash[:enabled] = enabled unless enabled.nil?
+        hash[:tags] = tags unless tags.nil?
+        hash
+      end
+    end
+  end
+end

data/lib/kodmin/version.rb

@@ -0,0 +1,3 @@
+module Kodmin
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: kodmin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Wu Zixing
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- wzixing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kodmin.gemspec
+- lib/kodmin.rb
+- lib/kodmin/client.rb
+- lib/kodmin/consumers.rb
+- lib/kodmin/plugins.rb
+- lib/kodmin/plugins/hmac_auth.rb
+- lib/kodmin/plugins/plugin.rb
+- lib/kodmin/version.rb
+homepage: https://github.com/WuZixing/kodmin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/WuZixing/kodmin
+  source_code_uri: https://github.com/WuZixing/kodmin.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A ruby client of kong's admin API v2.x.
+test_files: []