kong_schema 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce66ed2926b783ba19d2eee0e5e85d2606ead664
+  data.tar.gz: f040ed071ff55f64c1ea86906403b3f093c4e4b6
+SHA512:
+  metadata.gz: b2ff0756f8345d767ac68f28a57b07b05336252360906cf901386f247dbd12320fe8e501b2c736a45051e0a8878a969ba3ae315e9bd945f9aa9d158fb25c4975
+  data.tar.gz: 75e4876cd89fcb9ab5dd1538427f79d0a52f5670ae4bb4429d95b60859be221b6140b4d6be98bc469d750bfa9abc9a75904fb2973c458b9d0172567e5256eee5

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle
+/coverage
+/bin

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,31 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'lib/kong_schema/cli.rb'
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/SpaceInsideBrackets:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/SignalException:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 25
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self

data/.ruby-version

@@ -0,0 +1 @@
+2.3.4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 1.0.1
+
+- Fixed a bug where an empty array of "hosts", "uris", or "methods" in "apis"
+  would raise an exception.
+- An error will now be raised if `admin_host` is not defined in config (and a
+  connection to Kong admin can not be established)
+
+# 1.0.0
+
+Initial release with support for the following Kong objects:
+
+- [Apis](https://getkong.org/docs/0.11.x/admin-api/#add-api)
+- [Upstreams](https://getkong.org/docs/0.11.x/admin-api/#add-upstream)
+- [Targets](https://getkong.org/docs/0.11.x/admin-api/#add-target)

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kong_schema.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    kong_schema (1.1.0)
+      diffy (~> 3.1)
+      gli (~> 2.16)
+      kong (~> 0.3)
+      tty-prompt (~> 0.13)
+      tty-table (~> 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    diffy (3.1.0)
+    docile (1.1.5)
+    equatable (0.5.0)
+    excon (0.49.0)
+    gli (2.16.1)
+    hitimes (1.2.6)
+    json (2.1.0)
+    kong (0.3.0)
+      excon (~> 0.49.0)
+    necromancer (0.4.0)
+    pastel (0.7.1)
+      equatable (~> 0.5.0)
+      tty-color (~> 0.4.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.15.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    simplecov_compact_json (1.0.1)
+    timers (4.1.2)
+      hitimes
+    tty-color (0.4.2)
+    tty-cursor (0.5.0)
+    tty-prompt (0.13.2)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      timers (~> 4.1.2)
+      tty-cursor (~> 0.5.0)
+      tty-reader (~> 0.1.0)
+    tty-reader (0.1.0)
+      wisper (~> 2.0.0)
+    tty-screen (0.5.0)
+    tty-table (0.8.0)
+      equatable (~> 0.5.0)
+      necromancer (~> 0.4.0)
+      pastel (~> 0.7.0)
+      tty-screen (~> 0.5.0)
+      unicode-display_width (~> 1.1.0)
+      verse (~> 0.5.0)
+    unicode-display_width (1.1.3)
+    unicode_utils (1.4.0)
+    verse (0.5.0)
+      unicode-display_width (~> 1.1.0)
+      unicode_utils (~> 1.4.0)
+    wisper (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  kong_schema!
+  rspec (~> 3.6)
+  simplecov (~> 0.15)
+  simplecov_compact_json (~> 1.0)
+
+BUNDLED WITH
+   1.15.4

data/LICENSE.md

@@ -0,0 +1,14 @@
+Copyright (C) 2017 Instructure, INC.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,197 @@
+# kong_schema
+
+Configure [Kong](https://getkong.org) using YAML or JSON source files.
+
+This package is intended for use by programmers in development environments and
+may not be optimal for admins since it does not attempt to expose the full
+power of Kong's REST API.
+
+Use of this package requires no knowledge of [Kong's REST
+API](https://getkong.org/docs/0.11.x/admin-api/) - it is meant to abstract it
+away from the user.
+
+## Installation
+
+The package requires a recent version of Ruby.
+
+```shell
+gem install kong_schema
+```
+
+If you're using Bundler, add it to your Gemfile instead:
+
+```ruby
+group :development do
+  gem 'kong_schema'
+end
+```
+
+## Usage
+
+Write your desired configuration for Kong in a file using either YAML or JSON.
+The supported "directives" are described later in this document.
+
+For now we'll assume we have such a config file:
+
+```yaml
+# file: config/kong.yml
+kong:
+  admin_host: localhost:8001
+  apis:
+    - name: application-api
+      hosts:
+        - api.application.dev
+      upstream_url: http://application-api-lb
+      uris:
+        - /api/.+
+        - /auth/.+
+      preserve_host: true
+      strip_uri: false
+  upstreams:
+    - name: application-api-lb
+  targets:
+    - upstream_id: application-api-lb
+      target:      127.0.0.1:3000
+```
+
+Then if we run the following command:
+
+```shell
+bundle exec kong_schema up config/kong.yml
+```
+
+kong_schema will read the directives found under the `kong` dictionary and
+prompt you with a list of changes it will apply to Kong through the REST API.
+
+```shell
++-----------------+------------------------------------------------+
+| Change          | Parameters                                     |
++-----------------+------------------------------------------------+
+| Create Api      | {                                              |
+|                 |   "name": "application-api",                   |
+|                 |   "hosts": [                                   |
+|                 |     "api.application.dev"                      |
+|                 |   ],                                           |
+|                 |   "upstream_url": "http://application-api-lb", |
+|                 |   "uris": [                                    |
+|                 |     "/api/.+",                                 |
+|                 |     "/auth/.+"                                 |
+|                 |   ],                                           |
+|                 |   "preserve_host": true                        |
+|                 | }                                              |
+| Create Upstream | {                                              |
+|                 |   "name": "application-api-lb"                 |
+|                 | }                                              |
+| Create Target   | {                                              |
+|                 |   "upstream_id": "application-api-lb",         |
+|                 |   "target": "127.0.0.1:3000"                   |
+|                 | }                                              |
++-----------------+------------------------------------------------+
+Commit the changes to Kong? (y/N) 
+```
+
+If you agree and everything goes well, you should see an affirmative message:
+
+```
+✓ Kong has been reconfigured!
+```
+
+Running the command again should report that there are no changes to reflect:
+
+```
+✓ Nothing to update.
+```
+
+But if you _do_ change something it will result in an "update" operation and present you with the changes it perceives to have been made.
+
+Let's add another `uri` to our API:
+
+```yaml
+# file: config/kong.yml
+# ...
+  apis:
+    - name: application-api
+      hosts:
+        - api.application.dev
+      upstream_url: http://application-api-lb
+      uris:
+        - /api/.+
+        - /auth/.+
+        - /oauth2/.+
+```
+
+And re-run `kong_schema up` as we did before:
+
+```shell
++------------+-------------------------------------------------+
+| Change     | Parameters                                      |
++------------+-------------------------------------------------+
+| Update Api |  {                                              |
+|            |    "name": "application-api",                   |
+|            |    "hosts": [                                   |
+|            |      "api.application.dev"                      |
+|            |    ],                                           |
+|            |    "upstream_url": "http://application-api-lb", |
+|            |    "uris": [                                    |
+|            |      "/api/.+",                                 |
+|            | -    "/auth/.+"                                 |
+|            | +    "/auth/.+",                                |
+|            | +    "/oauth2/.+"                               |
+|            |    ],                                           |
+|            |    "preserve_host": true                        |
+|            |  }                                              |
++------------+-------------------------------------------------+
+```
+
+Nice and easy!
+
+## Configuration
+
+### `admin_host: String`
+
+### `apis: Array<Kong::Api>`
+
+[Kong::Api](https://getkong.org/docs/0.11.x/admin-api/#add-api) configuration:
+
+- name: String
+- host: String
+- upstream_url: String
+- uris: Array<String>
+- preserve_host: Boolean
+
+### `upstreams: Array<Kong::Upstream>`
+
+[Kong::Upstream](https://getkong.org/docs/0.11.x/admin-api/#add-upstream)
+configuration:
+
+- name: String
+- ?slots: Number
+- ?orderlist: Array<Number>
+
+### `targets: Array<Kong::Target>`
+
+[Kong::Target](https://getkong.org/docs/0.11.x/admin-api/#add-target)
+configuration:
+
+- upstream_id: String
+- target: String
+- ?weight: Number
+
+## TODO
+
+Add support for the remaining Kong API objects:
+
+- [consumers](https://getkong.org/docs/0.11.x/admin-api/#create-consumer)
+- [plugins](https://getkong.org/docs/0.11.x/admin-api/#add-plugin)
+- [certificates](https://getkong.org/docs/0.11.x/admin-api/#add-certificate)
+- [snis](https://getkong.org/docs/0.11.x/admin-api/#add-sni)
+
+## License
+
+Copyright (C) 2017 Instructure, INC.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/.

data/bin/kong_schema

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'kong_schema'
+
+exit KongSchema::CLI.new.run(ARGV)
+# require 'tty-prompt'
+# require 'pastel'
+
+# pastel = Pastel.new
+# schema = KongSchema::Schema
+# config = YAML.load_file('config/application.yml')['kong']
+
+# schema.scan(config).tap do |changes|
+#   if changes.empty?
+#     puts "#{pastel.green('✓')} Nothing to update."
+
+#     Process.exit(0)
+#   else
+#     puts KongSchema::Reporter.report(changes, object_format: :json)
+
+#     if TTY::Prompt.new.yes?('Commit the changes to Kong?', default: false)
+#       schema.commit(config, changes)
+
+#       puts "#{pastel.green('✓')} Kong has been reconfigured!"
+#     end
+#   end
+# end

data/ext/kong/upstream.rb

@@ -0,0 +1,36 @@
+require 'kong'
+
+module Kong
+  class Upstream
+    # monkey patch to make it return only "active" targets
+    #
+    # see https://github.com/Mashape/kong/issues/2876#issuecomment-328667296
+    # see https://github.com/kontena/kong-client-ruby/blob/master/lib/kong/upstream.rb#L17
+    def targets
+      targets   = []
+      json_data = Client.instance.get("#{API_END_POINT}#{self.id}/targets")
+
+      if json_data['data']
+        json_data['data'].each do |target_data|
+          targets << Target.new(target_data)
+        end
+      end
+
+      by_target = targets.reduce({}) do |map, target|
+        map[target.target] ||= []
+        map[target.target] << target
+        map
+      end
+
+      by_target.keys.reduce([]) do |list, key|
+        target = by_target[key].sort_by { |x| x.attributes[:created_at].to_i }.last
+
+        if target.active?
+          list.push(target)
+        else
+          list
+        end
+      end
+    end
+  end
+end

data/kong_schema.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+
+require_relative "./lib/kong_schema/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kong_schema"
+  spec.version       = KongSchema::VERSION
+  spec.authors       = ["Ahmad Amireh"]
+  spec.email         = ["ahmad@instructure.com"]
+  spec.summary       = "Configure Kong from a file using its REST API."
+  spec.license       = 'AGPL-3.0'
+  spec.homepage      = 'https://github.com/amireh/kong_schema'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = %w(kong_schema)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency "gli", "~> 2.16"
+  spec.add_dependency "diffy", "~> 3.1"
+  spec.add_dependency "kong", "~> 0.3"
+  spec.add_dependency "tty-prompt", "~> 0.13"
+  spec.add_dependency "tty-table", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "simplecov", "~> 0.15"
+  spec.add_development_dependency "simplecov_compact_json", "~> 1.0"
+end

data/lib/kong_schema/actions.rb

@@ -0,0 +1,44 @@
+module KongSchema
+  # TODO: make a validation pass before #apply
+  module Actions
+    class Create
+      attr_reader :model, :params
+
+      def initialize(model:, params:)
+        @model = model
+        @params = params
+      end
+
+      def apply(*)
+        @model.create(@params)
+      end
+    end
+
+    class Update
+      attr_reader :model, :params, :record
+
+      def initialize(model:, record:, params:)
+        @model = model
+        @params = params
+        @record = record
+      end
+
+      def apply(*)
+        @model.update(@record, @params)
+      end
+    end
+
+    class Delete
+      attr_reader :model, :record
+
+      def initialize(model:, record:)
+        @model = model
+        @record = record
+      end
+
+      def apply(*)
+        @model.delete(@record)
+      end
+    end
+  end
+end

data/lib/kong_schema/adapter.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module KongSchema
+  class Adapter
+    def self.for(model)
+      new(model: model)
+    end
+
+    def initialize(model:)
+      @model = model
+    end
+
+    def create(params)
+      @model.create(params)
+    end
+
+    def changed?(record, directive)
+      directive.keys.any? do |key|
+        !record.send(key).eql?(directive[key])
+      end
+    end
+
+    def update(record, params)
+      params.keys.each do |key|
+        record.send "#{key}=", params[key]
+      end
+
+      record.save
+    end
+
+    def delete(record)
+      record.delete
+    end
+  end
+end

data/lib/kong_schema/cli.rb

@@ -0,0 +1,86 @@
+require 'gli'
+require 'tty-prompt'
+require 'pastel'
+
+require_relative './schema'
+require_relative './reporter'
+
+module KongSchema
+  class CLI
+    include GLI::App
+
+    def run(argv)
+      program_desc 'Configure Kong from file.'
+
+      version KongSchema::VERSION
+
+      desc 'Apply configuration from a .yml or .json file.'
+      arg(:config_file)
+
+      command :up do |c|
+        c.flag([ 'k', 'key' ], {
+          default_value: 'kong',
+          desc: 'The root configuration property key.',
+          arg_name: 'NAME'
+        })
+
+        c.flag([ 'f', 'format' ], {
+          default_value: 'json',
+          desc: 'Format to use for reporting objects. Either "json" or "yaml".',
+          long_desc: 'Available formats: "json" or "yaml".',
+          arg_name: 'FORMAT',
+          must_match: %w(json yaml)
+        })
+
+        c.switch([ 'confirm' ], {
+          default_value: true,
+          desc: 'Prompt for confirmation before applying changes.'
+        })
+
+        c.action do |global_options, options, args|
+          up(filepath: args.first, options: options)
+        end
+      end
+
+      super(argv)
+    end
+
+    private
+
+    def up(filepath:, options:)
+      pastel = Pastel.new
+      schema = KongSchema::Schema
+      config = read_property(load_file(filepath), options[:key])
+
+      schema.scan(config).tap do |changes|
+        if changes.empty?
+          puts "#{pastel.green('✓')} Nothing to update."
+        else
+          puts KongSchema::Reporter.report(changes, object_format: options[:format].to_sym)
+
+          if TTY::Prompt.new.yes?('Commit the changes to Kong?', default: false)
+            schema.commit(config, changes)
+
+            puts "#{pastel.green('✓')} Kong has been reconfigured!"
+          end
+        end
+      end
+    end
+
+    def load_file(filepath)
+      if filepath.end_with?('.json')
+        JSON.parse(File.read(filepath))
+      else
+        YAML.load_file(filepath)
+      end
+    end
+
+    def read_property(config, key)
+      if key.to_s.empty?
+        config
+      else
+        config.fetch(key.to_s)
+      end
+    end
+  end
+end

data/lib/kong_schema/client.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'kong'
+
+module KongSchema
+  module Client
+    # Configure Kong::Client to use the host specified in config['admin_host']
+    # for the duration of a proc.
+    #
+    # Example:
+    #
+    #     KongSchema::Schema.connect({ 'admin_host' => '127.0.0.1:8001' }) do
+    #       Kong::Api.all()
+    #     end
+    def self.connect(config, &_)
+      api_url = Kong::Client.api_url
+      admin_host = config['admin_host']
+
+      if admin_host.nil?
+        fail "Missing 'admin_host' property; can not connect to Kong admin!"
+      end
+
+      Kong::Client.api_url = "http://#{admin_host}"
+
+      yield Kong::Client
+    ensure
+      Kong::Client.api_url = api_url
+    end
+  end
+end