krakend-openapi-importer 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8982d7b1d96d3d3a4f1213075474be32a5d7a4d95c7671bd9bdd266090027bd3
-  data.tar.gz: c8006aa961b9df1cf3fb5ea9f2a7b1f47874f4757592517bfc6777a48f91f9fc
+  metadata.gz: 7fa4ce1569286791f7a82d516f39378a66443d7e62edb4fcb58f91e44a34e71c
+  data.tar.gz: 2481a698b885aa0f7e958e86abaa608b433b25b9ad927c5e02aaeaa4daaebdda
 SHA512:
-  metadata.gz: 7b379be6f47cb870610a66b4471aab2cc9a6cce059724099f2f78c49a509d60cf312bd06d8d123e65196ec6ce4965c5e6d5f2a83d9c5ec50d630920def216d67
-  data.tar.gz: 1581b80a865b139636892bab36ee36353af888e15d5b66259fb92f6c74fb20917928540a200f75d42a844dedfe56052285548aea2d83142b78c3c2c01cf691c0
+  metadata.gz: 92c1c325b4bc2a16302fb75df279fd8cb62f305d3379c27e1d91f52fdbf109a8604b20343640a9fcaf1412585e1065c82433112d7e746b74e9672d23e6262416
+  data.tar.gz: a3a73662c1d3e274e82d29a357e82004fe5ed6408afd51feac8795efac9ba7929b265e5fa4c9c45741818407d63e7d44cb37f7ba97c680ab0623ee3df68a2037

data/.github/workflows/main.yml

@@ -1,16 +1,31 @@
-name: Ruby
+name: testing
 
 on: [push,pull_request]
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: [ '2.7', '3.0', '3.1', '3.2', '3.3', '3.4' ]
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@v1.216.0
       with:
-        ruby-version: 2.7.6
+        ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
-    - name: Run the default task
+    - name: Run tests
       run: bundle exec rake
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1.216.0
+      with:
+        ruby-version: '3.0'
+        bundler-cache: true
+    - name: Run linter
+      run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 34
+
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+Metrics/PerceivedComplexity:
+  Max: 16
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/.ruby-version

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

data/Gemfile

@@ -5,16 +5,17 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in krakend-openapi-importer.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem 'rake', '~> 13.0', '>= 13.2.1'
 
 group :test do
-  gem 'fakefs', '~> 2.0'
-  gem 'minitest', '~> 5.13'
+  gem 'fakefs', '~> 2.8', '>= 2.8.0'
+  gem 'minitest', '~> 5.25', '>= 5.25.4'
 end
 
 group :development do
   gem 'bump', '~> 0.10.0'
-  gem 'rubocop', require: false
+  gem 'rubocop', '~> 1.71', require: false
+  gem 'rubocop-performance', require: false
 end
 
 group :test, :development do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    krakend-openapi-importer (0.4.0)
+    krakend-openapi-importer (1.0.0)
       thor (~> 1.2)
 
 GEM
@@ -10,31 +10,38 @@ GEM
     ast (2.4.2)
     awesome_print (1.9.2)
     bump (0.10.0)
-    fakefs (2.0.0)
-    json (2.6.2)
-    minitest (5.13.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    fakefs (2.8.0)
+    json (2.9.1)
+    language_server-protocol (3.17.0.4)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.6.1)
-    rexml (3.2.5)
-    rubocop (1.39.0)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    rubocop (1.71.2)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.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)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.23.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    thor (1.3.2)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
 
 PLATFORMS
   ruby
@@ -44,11 +51,12 @@ PLATFORMS
 DEPENDENCIES
   awesome_print
   bump (~> 0.10.0)
-  fakefs (~> 2.0)
+  fakefs (~> 2.8, >= 2.8.0)
   krakend-openapi-importer!
-  minitest (~> 5.13)
-  rake (~> 13.0)
-  rubocop
+  minitest (~> 5.25, >= 5.25.4)
+  rake (~> 13.0, >= 13.2.1)
+  rubocop (~> 1.71)
+  rubocop-performance
 
 BUNDLED WITH
-   2.1.4
+   2.4.22

data/README.md

@@ -4,7 +4,7 @@ Import endpoints from OpenAPI spec to KrakenD endpoint configuration. Supports O
 
 [![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) [![Gem Version](https://badge.fury.io/rb/krakend-openapi-importer.svg)](https://badge.fury.io/rb/krakend-openapi-importer)
 
-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.
+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
 
@@ -17,7 +17,7 @@ Execute
 Import OpenAPI spec from SPEC file. Writes KrakenD config to output.json
 
 ```bash
-krakend-openapi-importer import SPEC -c CONFIG 
+krakend-openapi-importer import SPEC -c CONFIG
 ```
 
 ```bash
@@ -31,24 +31,28 @@ Example config
 
 ```yaml
 ---
-all_roles: ['admin', 'guest'] # all available roles for JWT validator
+all_roles: ["admin", "guest"] # all available roles for JWT validator
 pretty: true
-output: 'output.json'
+format: "json" # can be 'json' or 'yaml', defaults to `json`
+output: "output.json"
 defaults:
+  base:
+    name: Example application
   endpoint:
     output_encoding: "no-op" # act like a no-op proxy
-    input_headers: [ "*" ]
-    input_query_strings: [ "*" ]
+    input_headers: ["*"]
+    input_query_strings: ["*"]
   backend:
     - encoding: "no-op"
   plugins:
     auth_validator:
-      alg: 'RS256'
-      jwk_url: 'https://KEYCLOAK_URL/auth/realms/master/protocol/openid-connect/certs'
+      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: "realm_access.roles"
       roles_key_is_nested: true
+      scopes_key: scopes # only needed when defining scopes in openapi spec
 ```
 
 ## Development
@@ -59,7 +63,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/denblackstache/krakend-openapi-importer.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/denblackstache/krakend-openapi-importer>.
 
 ## License
 

data/Rakefile

@@ -2,6 +2,11 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rake'
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'test'

data/krakend-openapi-importer.gemspec

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
 
-require_relative './lib/importer/version'
+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.email         = ['den@densemenenko.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.homepage      = 'https://github.com/denblackstache/krakend-openapi-importer'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.7'
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/denblackstache/krakend-openapi-importer'

data/lib/commands/import.rb

@@ -16,8 +16,8 @@ module KrakendOpenAPI
     end
 
     def execute
-      paths = OA3Reader.new(@spec).paths
-      endpoints = OA3ToKrakendTransformer.new(paths, @importer_config).transform_paths
+      oa3_doc = OA3Reader.new(@spec)
+      endpoints = OA3ToKrakendTransformer.new(oa3_doc, @importer_config).transform_paths
       KrakendWriter.new(endpoints, @importer_config).write
     end
   end

data/lib/importer/version.rb

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

data/lib/readers/json_reader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative './file_reader'
+require_relative 'file_reader'
 
 module KrakendOpenAPI
   # Reads JSON files

data/lib/readers/oa3_reader.rb

@@ -11,22 +11,27 @@ module KrakendOpenAPI
     end
 
     def paths
-      read unless defined?(@data)
-      @data['paths']
+      data['paths']
     end
 
-    private
+    def security
+      data['security']
+    end
 
-    def read
-      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
+    def security_schemes
+      data.dig('components', 'securitySchemes')
+    end
+
+    private
 
-      self
+    def data
+      @data ||= if ['.json'].include?(File.extname(@path))
+                  JsonReader.new(@path).read
+                elsif %w[.yaml .yml].include?(File.extname(@path))
+                  YamlReader.new(@path).read
+                else
+                  raise StandardError, 'OA3Reader does not support this format'
+                end
     end
   end
 end

data/lib/readers/yaml_reader.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require_relative './file_reader'
+require_relative 'file_reader'
 
 module KrakendOpenAPI
   # Reads YAML files

data/lib/transformers/oa3_transformer.rb

@@ -1,37 +1,60 @@
 # frozen_string_literal: true
 
-require_relative './plugins/auth_validator_transformer'
+require_relative 'plugins/auth_validator_transformer'
 
 module KrakendOpenAPI
   # Transforms OpenAPI paths to KrakenD endpoints
   class OA3ToKrakendTransformer
-    def initialize(paths, importer_config)
-      @paths = paths
+    SCHEME_TYPES_WITH_ROLES = %w[openIdConnect oauth2].freeze
+
+    def initialize(spec, importer_config)
+      @spec = spec
       @importer_config = importer_config
     end
 
     def transform_paths
-      @paths.map { |path, methods| transform_path(path, methods) }.flatten
+      @spec.paths.map { |path, methods| transform_path(path, methods) }.flatten
     end
 
     private
 
+    def oauth_scopes_for(securities)
+      return nil if securities.nil?
+
+      securities.map do |security|
+        security.filter_map do |name, scopes|
+          next nil unless oauth_security_scheme_names.include?(name)
+
+          scopes
+        end
+      end.flatten.uniq
+    end
+
+    def oauth_security_scheme_names
+      @spec.security_schemes.filter_map do |name, scheme|
+        next nil unless SCHEME_TYPES_WITH_ROLES.include?(scheme['type'])
+
+        name
+      end
+    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']
-
+      scopes = oauth_scopes_for(operation['security']) || oauth_scopes_for(@spec.security)
       plugins = []
-      if @importer_config['defaults']&.dig('plugins', 'auth_validator')
-        plugins << Plugins::AuthValidatorTransformer
-                   .new
-                   .transform_to_hash(roles: roles,
-                                      config: @importer_config['defaults']['plugins']['auth_validator'])
-      end
+      plugins << auth_validator_plugin(roles, scopes) if auth_validator_plugin_enabled?(roles, scopes)
+      endpoint = krakend_endpoint(path, method)
+      endpoint[:extra_config] = endpoint_extra_config(plugins) unless plugins.empty?
+
+      endpoint
+    end
 
-      endpoint = {
+    def krakend_endpoint(path, method)
+      {
         endpoint: path,
         method: method.upcase,
         output_encoding: @importer_config['defaults']&.dig('endpoint', 'output_encoding'),
@@ -39,16 +62,27 @@ module KrakendOpenAPI
         input_query_strings: @importer_config['defaults']&.dig('endpoint', 'input_query_strings'),
         backend: [{ url_pattern: path, encoding: @importer_config['defaults']&.dig('backend', 0, 'encoding') }.compact]
       }.compact
+    end
 
-      if plugins&.length&.> 0
-        extra_config = plugins.each_with_object({}) do |plugin, memo|
-          memo[plugin[:name].to_sym] = plugin[:value]
-        end
+    def auth_validator_plugin_enabled?(roles, scopes)
+      @importer_config['defaults']&.dig('plugins', 'auth_validator') &&
+        (roles&.any? || scopes&.any?)
+    end
 
-        endpoint[:extra_config] = extra_config
-      end
+    def auth_validator_plugin(roles, scopes)
+      Plugins::AuthValidatorTransformer
+        .new
+        .transform_to_hash(
+          roles: roles,
+          scopes: scopes,
+          config: @importer_config['defaults']['plugins']['auth_validator']
+        )
+    end
 
-      endpoint
+    def endpoint_extra_config(plugins)
+      plugins.each_with_object({}) do |plugin, memo|
+        memo[plugin[:name].to_sym] = plugin[:value]
+      end
     end
   end
 end

data/lib/transformers/plugins/auth_validator_transformer.rb

@@ -4,20 +4,15 @@ module KrakendOpenAPI
   module Plugins
     # Transforms Auth Validator plugin definition
     class AuthValidatorTransformer
-      def transform_to_hash(roles:, config:)
-        raise(StandardError, 'Roles are empty') if roles.empty?
+      def transform_to_hash(config:, roles: [], scopes: [])
+        value = config.dup
+
+        value['roles'] = roles unless roles.nil? || roles.empty?
+        value['scopes'] = scopes unless scopes.nil? || scopes.empty?
 
         {
           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
-          }.compact
+          value: value
         }
       end
     end

data/lib/writers/krakend_writer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'yaml'
 
 module KrakendOpenAPI
   # Writes KrakenD configuration to a file
@@ -12,13 +13,18 @@ module KrakendOpenAPI
     end
 
     def write
-      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
-                                               }))
+      config = {
+        '$schema': 'https://www.krakend.io/schema/v3.json',
+        version: 3
+      }
+
+      config.merge!(
+        @importer_config.dig('defaults', 'base') || {}
+      )
+
+      config[:endpoints] = @endpoints
+
+      File.write(file_path, format(config))
     end
 
     def file_path
@@ -29,5 +35,28 @@ module KrakendOpenAPI
         File.expand_path(@output_file_path, pwd)
       end
     end
+
+    def format(obj)
+      format = @importer_config['format']
+      pretty_output = !!@importer_config['pretty'] # rubocop:disable Style/DoubleNegation
+
+      if format == 'yaml'
+        YAML.dump(stringify(obj))
+      elsif pretty_output
+        JSON.pretty_generate(obj)
+      else
+        JSON.dump(obj)
+      end
+    end
+
+    def stringify(obj)
+      if obj.is_a?(Array)
+        obj.map { |v| stringify(v) } if obj.is_a?(Array)
+      elsif obj.is_a?(Hash)
+        obj.to_h { |k, v| [k.to_s, stringify(v)] }
+      else
+        obj
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: krakend-openapi-importer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Denis Semenenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -27,7 +27,7 @@ dependencies:
 description: Import endpoints from OpenAPI spec to KrakenD endpoint configuration.
   Supports OpenAPI v3.0
 email:
-- hypercoderx@gmail.com
+- den@densemenenko.com
 executables:
 - krakend-openapi-importer
 extensions: []
@@ -35,6 +35,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -55,12 +56,13 @@ files:
 - lib/transformers/oa3_transformer.rb
 - lib/transformers/plugins/auth_validator_transformer.rb
 - lib/writers/krakend_writer.rb
-homepage: https://hypercoder.net
+homepage: https://github.com/denblackstache/krakend-openapi-importer
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://hypercoder.net
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/denblackstache/krakend-openapi-importer
   source_code_uri: https://github.com/denblackstache/krakend-openapi-importer
 post_install_message:
 rdoc_options: []