rails_ninja 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99a76115680edb87523d0a819db195e01041bd3ed09d6bfabc0226963505f2fc
-  data.tar.gz: bedb6982e08bd7c32864052ef14d130d0f555503006ceef2a3a0f557e6165912
+  metadata.gz: 437ec40dd224b486cc4b24755700f6b8a1bbb7c77e88dd3523760d59d1af5ff5
+  data.tar.gz: 28600e208c8c37a36d20243614abd2b8b0096a8e3abd1731e728740d466591eb
 SHA512:
-  metadata.gz: e21f4e9ea17198535d38b26a0f7e46d522cb09f84885eee3a92dc4e6c73e16606d446784262bff3841cae1578d3d88ce46ae1c66a6615564f1d2b4139a2ae891
-  data.tar.gz: dd8f2cbee49dd08ecbbd95fb86ebb2aef82db49eb37f477db1094441e9c39104e7c15b793bba91abf1f6310ecf7e76237994bf16f60bc1ecaa113d57d8d1c31f
+  metadata.gz: dfa8f772a93844aff65ffdc59bfbb67379a014f26cb0f73569fcdc3e909086b12d49219db008507065a985fc6a05b73ae3ed6588ba9ab234b36619200aafd7d9
+  data.tar.gz: ea13a4f5d9daee6f4cd80c493d55c7518e2d90e78861266e8e575e21617009fde4e3d26d1620c7f2bf42828d10a8937adb9251c269e4879ab3273a07f7f5991f

data/README.md

@@ -253,10 +253,13 @@ Generate an OpenAPI 3.2 JSON file for every API:
 ```sh
 bundle exec rake rails_ninja:openapi:generate
 bundle exec rake rails_ninja:openapi:generate OUTPUT=docs/api
+bundle exec rake rails_ninja:openapi:generate OPENAPI_VERSION=3.1.0
 ```
 
-The default output directory is `public/openapi`. File names come from the API
-class name, such as `PublicApi` to `public_api.json`.
+The default OpenAPI version is 3.2.0. Set `OPENAPI_VERSION` to a 3.0.x, 3.1.x,
+or 3.2.x version when a consumer requires another dialect. The default output
+directory is `public/openapi`. File names come from the API class name, such as
+`PublicApi` to `public_api.json`.
 
 ## Development
 

data/lib/rails_ninja/openapi/generator.rb

@@ -3,8 +3,16 @@
 module RailsNinja
   module OpenAPI
     class Generator
-      def initialize(api_class)
+      DEFAULT_VERSION = "3.2.0"
+      SUPPORTED_VERSION_PATTERN = /\A3\.(?:0|1|2)\.\d+\z/
+
+      def initialize(api_class, openapi_version: DEFAULT_VERSION)
+        unless openapi_version.match?(SUPPORTED_VERSION_PATTERN)
+          raise ArgumentError, "unsupported OpenAPI version: #{openapi_version.inspect} (expected 3.0.x, 3.1.x, or 3.2.x)"
+        end
+
         @api_class = api_class
+        @openapi_version = openapi_version
       end
 
       def to_hash
@@ -16,7 +24,7 @@ module RailsNinja
         end
 
         spec = {
-          openapi: "3.2.0",
+          openapi: @openapi_version,
           info: {
             title: @api_class._title || @api_class.name || "API",
             version: @api_class._version || "0.1.0",

data/lib/rails_ninja/tasks.rake

@@ -5,8 +5,9 @@ namespace :rails_ninja do
     desc "Generate OpenAPI JSON spec files for all registered APIs"
     task generate: :environment do
       output = ENV.fetch("OUTPUT", "public/openapi")
-      RailsNinja.generate_openapi(output: output)
-      puts "Generated OpenAPI specs in #{output}/"
+      openapi_version = ENV.fetch("OPENAPI_VERSION", RailsNinja::OpenAPI::Generator::DEFAULT_VERSION)
+      RailsNinja.generate_openapi(output: output, openapi_version: openapi_version)
+      puts "Generated OpenAPI #{openapi_version} specs in #{output}/"
     end
   end
 end

data/lib/rails_ninja/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsNinja
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/rails_ninja.rb

@@ -34,12 +34,12 @@ module RailsNinja
     @registered_apis ||= []
   end
 
-  def self.generate_openapi(output: "public/openapi")
+  def self.generate_openapi(output: "public/openapi", openapi_version: OpenAPI::Generator::DEFAULT_VERSION)
     require "fileutils"
     FileUtils.mkdir_p(output)
 
     registered_apis.each do |api_class|
-      generator = OpenAPI::Generator.new(api_class)
+      generator = OpenAPI::Generator.new(api_class, openapi_version: openapi_version)
 
       filename = api_class.name.split("::").last
         .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_ninja
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Benjamin Urrutia