krakend-openapi-importer 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1a7b6aa237ddcad0132e8c293cd42181382f5f4e32cbf174b18c9760abb5120
-  data.tar.gz: 243242837fbc0ebca42f8e311eeb8da9a7a1aed32fc4b1f2d7ceddf9f70db7c7
+  metadata.gz: d3a9eaa2da627c77ada30ddbb82c624063130d80c59087f3a57b9a8eb366afb8
+  data.tar.gz: a6e0280bee0c8a7a14cf669ac29bd341b29125e34fda209170c9eb8497556110
 SHA512:
-  metadata.gz: 9b6f24df2079fd9131a46a1cb2e19af2e17c4eba7a5b47db4b1fbccc57ed9c3d6b707663918117bf5f0d3b09bde7e8e122476eab8b8cfa2be6e8142af162ef1f
-  data.tar.gz: 67ec817c14e10bb62d087b7038750100fad0f3f219e32028d5531b054c2b74263df2ecdde38fb75fbdf6d35e196fa69bbb510c1f7a007b04eedc787e6471b9b4
+  metadata.gz: 2d41c42b8df2419cf1c50dc3688d1461abceedb1fc25506a5c13ab32751a9323eff94d8b62fd15c4a8782903d3e299c3ec180976f3fbe2035df95f1b8589325d
+  data.tar.gz: cd0bcff75ae8effeca81e6fadb7afea44de51c2460a9c09e8c581370f67a5b05f5b216b5ae4f999571c9d001eb3869a749dabb7879d828b14f9a23c7ac937508

data/Gemfile

@@ -6,5 +6,12 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', require: false
+
+group :test do
+  gem 'fakefs', '~> 2.0'
+  gem 'minitest', '~> 5.13'
+end
+
+group :development do
+  gem 'rubocop', require: false
+end

data/Gemfile.lock

@@ -1,15 +1,16 @@
 PATH
   remote: .
   specs:
-    krakend-openapi-importer (0.2.0)
+    krakend-openapi-importer (0.3.1)
       thor (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    diff-lcs (1.4.4)
+    fakefs (2.0.0)
     json (2.6.2)
+    minitest (5.13.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -17,19 +18,6 @@ GEM
     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)
@@ -52,9 +40,10 @@ PLATFORMS
   x86_64-darwin-21
 
 DEPENDENCIES
+  fakefs (~> 2.0)
   krakend-openapi-importer!
+  minitest (~> 5.13)
   rake (~> 13.0)
-  rspec (~> 3.0)
   rubocop
 
 BUNDLED WITH

data/README.md

@@ -2,7 +2,7 @@
 
 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)
+[![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.
 
@@ -34,12 +34,15 @@ Example config
 ```yaml
 ---
 all_roles: ['admin', 'guest'] # all available roles for JWT validator
-pretty: false
+pretty: true
+output: 'output.json'
 defaults:
   endpoint:
     output_encoding: "no-op" # act like a no-op proxy
     input_headers: [ "*" ]
     input_query_strings: [ "*" ]
+  backend:
+    - encoding: "no-op"
   plugins:
     auth_validator:
       alg: 'RS256'

data/Rakefile

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require 'rake/testtask'
 
-RSpec::Core::RakeTask.new(:spec)
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
 
-task default: :spec
+task default: :test

data/lib/commands/import.rb

@@ -17,9 +17,9 @@ module KrakendOpenAPI
     end
 
     def execute
-      paths = OA3Reader.new.read(@spec).paths
-      endpoints = OA3ToKrakendTransformer.new(@importer_config).transform_paths(paths)
-      KrakendWriter.new(@importer_config).write(endpoints)
+      paths = OA3Reader.new(@spec).paths
+      endpoints = OA3ToKrakendTransformer.new(paths, @importer_config).transform_paths
+      KrakendWriter.new(endpoints, @importer_config).write
     end
   end
 end

data/lib/importer/version.rb

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

data/lib/readers/json_reader.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'json'
+
 module KrakendOpenAPI
   # Reads JSON files
   class JsonReader

data/lib/readers/oa3_reader.rb

@@ -6,22 +6,27 @@ require_relative '../readers/yaml_reader'
 module KrakendOpenAPI
   # Reads OpenAPI spec files
   class OA3Reader
-    attr_reader :data
+    def initialize(path)
+      @path = path
+    end
+
+    def paths
+      read unless @data
+      @data['paths']
+    end
 
-    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
+    private
+
+    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
 
       self
     end
-
-    def paths
-      data['paths']
-    end
   end
 end

data/lib/transformers/oa3_transformer.rb

@@ -5,14 +5,17 @@ require_relative './jwt_validator_transformer'
 module KrakendOpenAPI
   # Transforms OpenAPI paths to KrakenD endpoints
   class OA3ToKrakendTransformer
-    def initialize(importer_config)
+    def initialize(paths, importer_config)
+      @paths = paths
       @importer_config = importer_config
     end
 
-    def transform_paths(paths)
-      paths.map { |path, methods| transform_path(path, methods) }.flatten
+    def transform_paths
+      @paths.map { |path, methods| transform_path(path, methods) }.flatten
     end
 
+    private
+
     def transform_path(path, methods)
       methods.map { |method, operation| transform_method(path, method, operation) }
     end
@@ -21,10 +24,12 @@ module KrakendOpenAPI
       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'])
+      if @importer_config['defaults']&.dig('plugins', 'auth_validator')
+        plugins << JwtValidatorTransformer
+                     .new
+                     .transform_to_hash(roles: roles,
+                                        config: @importer_config['defaults']['plugins']['auth_validator'])
+      end
 
       endpoint = {
         endpoint: path,
@@ -32,14 +37,17 @@ module KrakendOpenAPI
         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 }]
+        backend: [{ url_pattern: path, encoding: @importer_config['defaults']['backend'][0]['encoding'] }]
       }
 
-      extra_config = plugins.each_with_object({}) do |plugin, memo|
-        memo[plugin[:name].to_sym] = plugin[:value]
+      if plugins&.length > 0
+        extra_config = plugins.each_with_object({}) do |plugin, memo|
+          memo[plugin[:name].to_sym] = plugin[:value]
+        end
+
+        endpoint[:extra_config] = extra_config
       end
 
-      endpoint[:extra_config] = extra_config
       endpoint
     end
   end

data/lib/writers/krakend_writer.rb

@@ -5,18 +5,20 @@ require 'json'
 module KrakendOpenAPI
   # Writes KrakenD configuration to a file
   class KrakendWriter
-    def initialize(importer_config)
+    def initialize(endpoints, importer_config)
+      @endpoints = endpoints
       @importer_config = importer_config
-      @file_path = "#{Dir.pwd}/output.json"
+      @output = @importer_config['output'] || 'output.json'
+      @file_path = "#{Dir.pwd}/#{@output}"
     end
 
-    def write(endpoints)
+    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
+                                                  endpoints: @endpoints
                                                 }))
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: krakend-openapi-importer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Denis Semenenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -35,7 +35,6 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock

data/.rspec

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