krakend-openapi-importer 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcf0121c7781a444cd9a6bc8201f03375b48931608fa9cb74da2c2baa03be0bf
-  data.tar.gz: 480d12883093ede9c9d7d712d730496d91fee39741b2a58fc21eb18f6811701f
+  metadata.gz: eccd5c3cd0254e656a85647f09b55dc6ab23a2cbe12df54f300e9f55b6232680
+  data.tar.gz: 1c00cf1e660f5f2d0c56eb82eea50300448b433f6396476ec2c5d0b212720703
 SHA512:
-  metadata.gz: d93e9f5bff44369fb37669daf610baa79465dd40eae0f9fb43dd301da2198ed1a59dbfa6239d665052ce3d63b25a01956d78ffb6265cd8206981e359c51546c9
-  data.tar.gz: 552b075ed012355bb4381b1a057aeed02054a71c644eceafde7ea466c342ecfe21a29542a01f30d0364cd2aae2a941398951380ea5e4ed62bf2d9564f7774077
+  metadata.gz: 9fd2c84e3b98e8953a26b730804179c3b567ec0e3b70e242e53ab4d8d9fc52123894c174a82c382e405fbd09368c460b989c68bd27c107b2d2fd432dacafd466
+  data.tar.gz: b10e0267cd7a62694bfe94ce853fc5f648d3a88adacc667855d6fafb012084e7ece04a399960d0cdf8e531bfd27317fbebc4c16e9ff67ada60f0f74f7433f025

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    krakend-openapi-importer (0.1.0)
+    krakend-openapi-importer (0.3.0)
       thor (~> 1.2)
 
 GEM

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.
 
@@ -17,14 +17,14 @@ Execute
 Import OpenAPI spec from SPEC file. Writes KrakenD config to output.json
 
 ```bash
-krakend-openapi-importer import SPEC
+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
@@ -34,11 +34,15 @@ Example config
 ```yaml
 ---
 all_roles: ['admin', 'guest'] # all available roles for JWT validator
+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/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.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.1.0'
+  VERSION = '0.3.0'
 end

data/lib/importer.rb

@@ -7,9 +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
     end

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
@@ -32,7 +35,7 @@ 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|

data/lib/writers/krakend_writer.rb

@@ -5,16 +5,21 @@ require 'json'
 module KrakendOpenAPI
   # Writes KrakenD configuration to a file
   class KrakendWriter
-    def initialize
-      @file_path = "#{Dir.pwd}/output.json"
+    def initialize(endpoints, importer_config)
+      @endpoints = endpoints
+      @importer_config = importer_config
+      @output = @importer_config['output'] || 'output.json'
+      @file_path = "#{Dir.pwd}/#{@output}"
     end
 
-    def write(endpoints)
-      File.write(@file_path, JSON.dump({
-                                         '$schema': 'https://www.krakend.io/schema/v3.json',
-                                         version: 3,
-                                         endpoints: 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
+                                                }))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: krakend-openapi-importer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Denis Semenenko
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor