krakend-openapi-importer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d1a7b6aa237ddcad0132e8c293cd42181382f5f4e32cbf174b18c9760abb5120
+  data.tar.gz: 243242837fbc0ebca42f8e311eeb8da9a7a1aed32fc4b1f2d7ceddf9f70db7c7
+SHA512:
+  metadata.gz: 9b6f24df2079fd9131a46a1cb2e19af2e17c4eba7a5b47db4b1fbccc57ed9c3d6b707663918117bf5f0d3b09bde7e8e122476eab8b8cfa2be6e8142af162ef1f
+  data.tar.gz: 67ec817c14e10bb62d087b7038750100fad0f3f219e32028d5531b054c2b74263df2ecdde38fb75fbdf6d35e196fa69bbb510c1f7a007b04eedc787e6471b9b4

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.6
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+.idea/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/data/
+output.json
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1,2 @@
+2.7.6
+

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in krakend-openapi-importer.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', require: false

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    krakend-openapi-importer (0.2.0)
+      thor (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+  x86_64-darwin-21
+
+DEPENDENCIES
+  krakend-openapi-importer!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Denis Semenenko
+
+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,65 @@
+# KrakenD OpenAPI Importer
+
+Import endpoints from OpenAPI spec to KrakenD endpoint configuration. Supports OpenAPI v3.0 and up.
+
+[![Ruby](https://github.com/denblackstache/krakend-openapi-importer/actions/workflows/main.yml/badge.svg)](https://github.com/denblackstache/krakend-openapi-importer/actions/workflows/main.yml)
+
+In case you have a different version of OpenAPI you can use https://github.com/LucyBot-Inc/api-spec-converter to convert to the v3.0.
+
+## Installation
+
+Execute
+
+    gem install krakend-openapi-importer
+
+## Usage
+
+Import OpenAPI spec from SPEC file. Writes KrakenD config to output.json
+
+```bash
+krakend-openapi-importer import SPEC -c CONFIG 
+```
+
+```bash
+Options:
+-c, --config=CONFIG  # Path to importer.yaml config
+-s, [--syntax=SYNTAX]  # Specifies input data syntax: json or yaml. Defaults to json
+# Default: json
+```
+
+## Configuration
+
+Example config
+
+```yaml
+---
+all_roles: ['admin', 'guest'] # all available roles for JWT validator
+pretty: false
+defaults:
+  endpoint:
+    output_encoding: "no-op" # act like a no-op proxy
+    input_headers: [ "*" ]
+    input_query_strings: [ "*" ]
+  plugins:
+    auth_validator:
+      alg: 'RS256'
+      jwk_url: 'https://KEYCLOAK_URL/auth/realms/master/protocol/openid-connect/certs'
+      cache: false
+      operation_debug: true
+      roles_key: 'realm_access.roles'
+      roles_key_is_nested: true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/denblackstache/krakend-openapi-importer.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'importer'
+
+# 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/exe/krakend-openapi-importer

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'importer'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  KrakendOpenAPI::Importer.start(ARGV)
+rescue StandardError => e
+  raise e # TODO: Remove this line after debugging
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/krakend-openapi-importer.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative './lib/importer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'krakend-openapi-importer'
+  spec.version       = KrakendOpenAPI::VERSION
+  spec.authors       = ['Denis Semenenko']
+  spec.email         = ['hypercoderx@gmail.com']
+
+  spec.summary       = 'Import OpenAPI spec to KrakenD configuration'
+  spec.description   = 'Import endpoints from OpenAPI spec to KrakenD endpoint configuration. Supports OpenAPI v3.0'
+  spec.homepage      = 'https://hypercoder.net'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/denblackstache/krakend-openapi-importer'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'thor', '~> 1.2'
+end

data/lib/commands/import.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative '../readers/oa3_reader'
+require_relative '../transformers/oa3_transformer'
+require_relative '../writers/krakend_writer'
+
+module KrakendOpenAPI
+  # Import Command
+  class ImportCommand
+    def initialize(spec:, syntax:, config:)
+      @spec = spec
+      @syntax = syntax
+      @config = config
+
+      @importer_config = YAML.safe_load(File.read("#{Dir.pwd}/#{@config}"))
+    end
+
+    def execute
+      paths = OA3Reader.new.read(@spec).paths
+      endpoints = OA3ToKrakendTransformer.new(@importer_config).transform_paths(paths)
+      KrakendWriter.new(@importer_config).write(endpoints)
+    end
+  end
+end

data/lib/importer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KrakendOpenAPI
+  VERSION = '0.2.0'
+end

data/lib/importer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'commands/import'
+
+module KrakendOpenAPI
+  # Importer CLI
+  class Importer < Thor
+    desc 'import SPEC', 'Import OpenAPI spec from SPEC file. Writes KrakenD config to output.json'
+    method_option :config, aliases: '-c', desc: 'Path to importer.yaml config', required: true
+    method_option :syntax, aliases: '-s', default: 'json',
+                           desc: 'Specifies input data syntax: json or yaml. Defaults to json'
+    def import(spec)
+      ImportCommand.new(spec: spec, syntax: options[:syntax], config: options[:config]).execute
+    end
+  end
+end

data/lib/readers/json_reader.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module KrakendOpenAPI
+  # Reads JSON files
+  class JsonReader
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def read
+      JSON.parse(File.read("#{Dir.pwd}/#{@file_path}"))
+    end
+  end
+end

data/lib/readers/oa3_reader.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../readers/json_reader'
+require_relative '../readers/yaml_reader'
+
+module KrakendOpenAPI
+  # Reads OpenAPI spec files
+  class OA3Reader
+    attr_reader :data
+
+    def read(path)
+      if ['.json'].include?(File.extname(path))
+        @data = JsonReader.new(path).read
+      elsif %w[.yaml .yml].include?(File.extname(path))
+        @data = YamlReader.new(path).read
+      else
+        raise StandardError, 'OA3Reader does not support this format'
+      end
+
+      self
+    end
+
+    def paths
+      data['paths']
+    end
+  end
+end

data/lib/readers/yaml_reader.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module KrakendOpenAPI
+  # Reads YAML files
+  class YamlReader
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def read
+      YAML.safe_load(File.read("#{Dir.pwd}/#{@file_path}"))
+    end
+  end
+end

data/lib/transformers/jwt_validator_transformer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module KrakendOpenAPI
+  # Transforms OpenAPI paths to KrakenD endpoints
+  class JwtValidatorTransformer
+    def transform_to_hash(roles:, config:)
+      {
+        name: 'auth/validator',
+        value: {
+          'alg': config['alg'],
+          'jwk_url': config['jwk_url'],
+          'cache': config['cache'],
+          'operation_debug': config['operation_debug'],
+          'roles_key_is_nested': config['roles_key_is_nested'],
+          'roles_key': config['roles_key'],
+          'roles': roles
+        }
+      }
+    end
+  end
+end

data/lib/transformers/oa3_transformer.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative './jwt_validator_transformer'
+
+module KrakendOpenAPI
+  # Transforms OpenAPI paths to KrakenD endpoints
+  class OA3ToKrakendTransformer
+    def initialize(importer_config)
+      @importer_config = importer_config
+    end
+
+    def transform_paths(paths)
+      paths.map { |path, methods| transform_path(path, methods) }.flatten
+    end
+
+    def transform_path(path, methods)
+      methods.map { |method, operation| transform_method(path, method, operation) }
+    end
+
+    def transform_method(path, method, operation)
+      roles = operation['x-jwt-roles']&.length ? operation['x-jwt-roles'] : @importer_config['all_roles']
+
+      plugins = []
+      plugins << JwtValidatorTransformer
+                 .new
+                 .transform_to_hash(roles: roles,
+                                    config: @importer_config['defaults']['plugins']['auth_validator'])
+
+      endpoint = {
+        endpoint: path,
+        method: method.upcase,
+        output_encoding: @importer_config['defaults']['endpoint']['output_encoding'],
+        input_headers: @importer_config['defaults']['endpoint']['input_headers'],
+        input_query_strings: @importer_config['defaults']['endpoint']['input_query_strings'],
+        backend: [{ url_pattern: path }]
+      }
+
+      extra_config = plugins.each_with_object({}) do |plugin, memo|
+        memo[plugin[:name].to_sym] = plugin[:value]
+      end
+
+      endpoint[:extra_config] = extra_config
+      endpoint
+    end
+  end
+end

data/lib/writers/krakend_writer.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module KrakendOpenAPI
+  # Writes KrakenD configuration to a file
+  class KrakendWriter
+    def initialize(importer_config)
+      @importer_config = importer_config
+      @file_path = "#{Dir.pwd}/output.json"
+    end
+
+    def write(endpoints)
+      pretty_output = !!@importer_config['pretty'] # rubocop:disable Style/DoubleNegation
+      json_generate = pretty_output ? ->(obj) { JSON.pretty_generate(obj) } : ->(obj) { JSON.dump(obj) }
+      File.write(@file_path, json_generate.call({
+                                                  '$schema': 'https://www.krakend.io/schema/v3.json',
+                                                  version: 3,
+                                                  endpoints: endpoints
+                                                }))
+    end
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: krakend-openapi-importer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Denis Semenenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Import endpoints from OpenAPI spec to KrakenD endpoint configuration.
+  Supports OpenAPI v3.0
+email:
+- hypercoderx@gmail.com
+executables:
+- krakend-openapi-importer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/krakend-openapi-importer
+- krakend-openapi-importer.gemspec
+- lib/commands/import.rb
+- lib/importer.rb
+- lib/importer/version.rb
+- lib/readers/json_reader.rb
+- lib/readers/oa3_reader.rb
+- lib/readers/yaml_reader.rb
+- lib/transformers/jwt_validator_transformer.rb
+- lib/transformers/oa3_transformer.rb
+- lib/writers/krakend_writer.rb
+homepage: https://hypercoder.net
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://hypercoder.net
+  source_code_uri: https://github.com/denblackstache/krakend-openapi-importer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Import OpenAPI spec to KrakenD configuration
+test_files: []