krakend-openapi-importer 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3a9eaa2da627c77ada30ddbb82c624063130d80c59087f3a57b9a8eb366afb8
-  data.tar.gz: a6e0280bee0c8a7a14cf669ac29bd341b29125e34fda209170c9eb8497556110
+  metadata.gz: 8982d7b1d96d3d3a4f1213075474be32a5d7a4d95c7671bd9bdd266090027bd3
+  data.tar.gz: c8006aa961b9df1cf3fb5ea9f2a7b1f47874f4757592517bfc6777a48f91f9fc
 SHA512:
-  metadata.gz: 2d41c42b8df2419cf1c50dc3688d1461abceedb1fc25506a5c13ab32751a9323eff94d8b62fd15c4a8782903d3e299c3ec180976f3fbe2035df95f1b8589325d
-  data.tar.gz: cd0bcff75ae8effeca81e6fadb7afea44de51c2460a9c09e8c581370f67a5b05f5b216b5ae4f999571c9d001eb3869a749dabb7879d828b14f9a23c7ac937508
+  metadata.gz: 7b379be6f47cb870610a66b4471aab2cc9a6cce059724099f2f78c49a509d60cf312bd06d8d123e65196ec6ce4965c5e6d5f2a83d9c5ec50d630920def216d67
+  data.tar.gz: 1581b80a865b139636892bab36ee36353af888e15d5b66259fb92f6c74fb20917928540a200f75d42a844dedfe56052285548aea2d83142b78c3c2c01cf691c0

data/Gemfile

@@ -13,5 +13,10 @@ group :test do
 end
 
 group :development do
+  gem 'bump', '~> 0.10.0'
   gem 'rubocop', require: false
 end
+
+group :test, :development do
+  gem 'awesome_print'
+end

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    krakend-openapi-importer (0.3.1)
+    krakend-openapi-importer (0.4.0)
       thor (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     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)
@@ -40,6 +42,8 @@ PLATFORMS
   x86_64-darwin-21
 
 DEPENDENCIES
+  awesome_print
+  bump (~> 0.10.0)
   fakefs (~> 2.0)
   krakend-openapi-importer!
   minitest (~> 5.13)

data/README.md

@@ -22,9 +22,7 @@ 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
+-c, [--config=CONFIG]  # Path to importer.yaml config
 ```
 
 ## Configuration

data/exe/krakend-openapi-importer

@@ -13,7 +13,6 @@ 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/lib/commands/import.rb

@@ -1,19 +1,18 @@
 # frozen_string_literal: true
 
+require 'pathname'
 require 'yaml'
 require_relative '../readers/oa3_reader'
+require_relative '../readers/yaml_reader'
 require_relative '../transformers/oa3_transformer'
 require_relative '../writers/krakend_writer'
 
 module KrakendOpenAPI
   # Import Command
   class ImportCommand
-    def initialize(spec:, syntax:, config:)
+    def initialize(spec:, config:)
       @spec = spec
-      @syntax = syntax
-      @config = config
-
-      @importer_config = YAML.safe_load(File.read("#{Dir.pwd}/#{@config}"))
+      @importer_config = config ? YamlReader.new(config).read : {}
     end
 
     def execute

data/lib/importer/version.rb

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

data/lib/importer.rb

@@ -7,11 +7,9 @@ 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'
+    method_option :config, aliases: '-c', desc: 'Path to importer.yaml config'
     def import(spec)
-      ImportCommand.new(spec: spec, syntax: options[:syntax], config: options[:config]).execute
+      ImportCommand.new(spec: spec, config: options[:config]).execute
     end
   end
 end

data/lib/readers/file_reader.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module KrakendOpenAPI
+  # Reads absolute/relative files
+  class FileReader
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def read
+      pwd = File.expand_path(Dir.pwd)
+      if Pathname.new(@file_path).absolute?
+        File.read(@file_path)
+      else
+        File.read(File.expand_path(@file_path, pwd))
+      end
+    end
+  end
+end

data/lib/readers/json_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require_relative './file_reader'
 
 module KrakendOpenAPI
   # Reads JSON files
@@ -10,7 +11,7 @@ module KrakendOpenAPI
     end
 
     def read
-      JSON.parse(File.read("#{Dir.pwd}/#{@file_path}"))
+      JSON.parse(KrakendOpenAPI::FileReader.new(@file_path).read)
     end
   end
 end

data/lib/readers/oa3_reader.rb

@@ -11,7 +11,7 @@ module KrakendOpenAPI
     end
 
     def paths
-      read unless @data
+      read unless defined?(@data)
       @data['paths']
     end
 

data/lib/readers/yaml_reader.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require_relative './file_reader'
 
 module KrakendOpenAPI
   # Reads YAML files
@@ -10,7 +11,7 @@ module KrakendOpenAPI
     end
 
     def read
-      YAML.safe_load(File.read("#{Dir.pwd}/#{@file_path}"))
+      YAML.safe_load(KrakendOpenAPI::FileReader.new(@file_path).read)
     end
   end
 end

data/lib/transformers/oa3_transformer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './jwt_validator_transformer'
+require_relative './plugins/auth_validator_transformer'
 
 module KrakendOpenAPI
   # Transforms OpenAPI paths to KrakenD endpoints
@@ -25,22 +25,22 @@ module KrakendOpenAPI
 
       plugins = []
       if @importer_config['defaults']&.dig('plugins', 'auth_validator')
-        plugins << JwtValidatorTransformer
-                     .new
-                     .transform_to_hash(roles: roles,
-                                        config: @importer_config['defaults']['plugins']['auth_validator'])
+        plugins << Plugins::AuthValidatorTransformer
+                   .new
+                   .transform_to_hash(roles: roles,
+                                      config: @importer_config['defaults']['plugins']['auth_validator'])
       end
 
       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, encoding: @importer_config['defaults']['backend'][0]['encoding'] }]
-      }
+        output_encoding: @importer_config['defaults']&.dig('endpoint', 'output_encoding'),
+        input_headers: @importer_config['defaults']&.dig('endpoint', 'input_headers'),
+        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
 
-      if plugins&.length > 0
+      if plugins&.length&.> 0
         extra_config = plugins.each_with_object({}) do |plugin, memo|
           memo[plugin[:name].to_sym] = plugin[:value]
         end

data/lib/transformers/plugins/auth_validator_transformer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+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?
+
+        {
+          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
+        }
+      end
+    end
+  end
+end

data/lib/writers/krakend_writer.rb

@@ -8,18 +8,26 @@ module KrakendOpenAPI
     def initialize(endpoints, importer_config)
       @endpoints = endpoints
       @importer_config = importer_config
-      @output = @importer_config['output'] || 'output.json'
-      @file_path = "#{Dir.pwd}/#{@output}"
+      @output_file_path = @importer_config['output'] || 'output.json'
     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
-                                                }))
+      File.write(file_path, json_generate.call({
+                                                 '$schema': 'https://www.krakend.io/schema/v3.json',
+                                                 version: 3,
+                                                 endpoints: @endpoints
+                                               }))
+    end
+
+    def file_path
+      pwd = File.expand_path(Dir.pwd)
+      if Pathname.new(@output_file_path).absolute?
+        @output_file_path
+      else
+        File.expand_path(@output_file_path, pwd)
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: krakend-openapi-importer
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Denis Semenenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -48,11 +48,12 @@ files:
 - lib/commands/import.rb
 - lib/importer.rb
 - lib/importer/version.rb
+- lib/readers/file_reader.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/transformers/plugins/auth_validator_transformer.rb
 - lib/writers/krakend_writer.rb
 homepage: https://hypercoder.net
 licenses:

data/lib/transformers/jwt_validator_transformer.rb

@@ -1,21 +0,0 @@
-# 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