rodauth-openapi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce74f8234f280f924c119e914ee31e88ee7714ccd10770626de4034edcac7da
-  data.tar.gz: 42f9cd22c79d36a6ae06e4703ce80a0da926908e5bd72f4eeb0a77644db1cf68
+  metadata.gz: 4207f312e3af2d9d0ff8cd56091d559e53ed4ca6bc2467929560c58c6a2617ff
+  data.tar.gz: 29b35acd6163236b9db240a10af6aa69691ec325ceec52043c52eb6ef61c1ee3
 SHA512:
-  metadata.gz: e3797f271d6735174e03beda40c98f2392a338d295dcb15d06d323d52cc8828a1b0c654d798a8c3380039759a7eb769f8c9747ad4a7f0678a0f293e07eaa16de
-  data.tar.gz: bbdd36a6a8ab3d499b4f2af8487291111084e7a51851ef3e5463b861a6118922a20d217e2f5e56c185ca74e8f2a2b01b50d9694cbebd1f6312bf51cb18316b84
+  metadata.gz: c83451cfe842f8b736641d290daf3f0e5fdbff72b870d11133edef34923618dd18f49e1e2c574e6cb6452be51e85cd142c6aeb7761a65cc750c26e141e042c51
+  data.tar.gz: 519489230cb1ff5030635bbbcc26cc5bbde32d82c94d4a39a71d95b567bf6ca2e48ec5f253e34cf7e85cbd9e8e70311791fcee46599a288d2e8f8f75ad2f9971

data/README.md

@@ -1,6 +1,6 @@
 # Rodauth OpenAPI
 
-Generates [OpenAPI] documentation for your Rodauth endpoints.
+Generate [OpenAPI] documentation for your Rodauth endpoints.
 
 ## Installation
 
@@ -12,7 +12,7 @@ bundle add rodauth-openapi --group development
 
 The generated OpenAPI documentation can be uploaded to renderers such as [Swagger Editor] or [Redoc].
 
-### Rails
+### In Rails
 
 Assuming you have Rodauth installed in your Rails application, you can use the generator provided by this gem:
 
@@ -45,22 +45,15 @@ open_api = Rodauth::OpenAPI.new(auth_class)
 File.write("openapi.yml", open_api.to_yaml)
 ```
 
-To generate JSON API endpoints:
+Here are the various options and methods supported:
 
 ```rb
-Roduath::OpenAPI.new(auth_class, json: true)
-```
-
-To assume the account doesn't have a password:
+Rodauth::OpenAPI.new(auth_class, json: true) # generate JSON API endpoints
+Rodauth::OpenAPI.new(auth_class, password: false) # assume account has no password
 
-```rb
-Roduath::OpenAPI.new(auth_class, password: false)
-```
-
-To generate the documentation in JSON format:
-
-```rb
-Roduath::OpenAPI.new(auth_class).to_json
+Rodauth::OpenAPI.new(auth_class).to_yaml # YAML format
+Rodauth::OpenAPI.new(auth_class).to_json # JSON format
+Rodauth::OpenAPI.new(auth_class).generate # ruby hash
 ```
 
 ## License

data/lib/generators/rodauth/openapi_generator.rb

@@ -30,6 +30,8 @@ module Rodauth
         else
           puts documentation
         end
+      rescue Rodauth::OpenAPI::Error => error
+        say error.message, :red
       end
 
       private

data/lib/rodauth/openapi/routes.rb

@@ -46,6 +46,15 @@ module Rodauth
         data[:paths][path][verb] = {
           tags: [tag],
           summary: summary,
+          description: <<~MARKDOWN,
+            ```ruby
+            #{rodauth_invocation}.#{name}_route #=> "#{rodauth.send(:"#{name}_route")}"
+            #{rodauth_invocation}.#{name}_path #=> "#{path}"
+            #{rodauth_invocation}.#{name}_url #=> "https://example.com#{path}"
+
+            #{rodauth_invocation}.current_route #=> :#{name} (in the request)
+            ```
+          MARKDOWN
           responses: {},
           parameters: [],
         }
@@ -54,7 +63,8 @@ module Rodauth
       end
 
       def description(text)
-        data[:paths].values.last.values.last[:description] = text
+        path = data[:paths].values.last.values.last
+        path[:description] = [path[:description], text].compact.join("\n")
       end
 
       def param(name, description, type:, example: nil, required: false, enum: nil)
@@ -124,6 +134,14 @@ module Rodauth
       def feature?(name)
         rodauth.features.include?(name)
       end
+
+      def rodauth_invocation
+        if rodauth.class.configuration_name
+          "rodauth(:#{rodauth.class.configuration_name})"
+        else
+          "rodauth"
+        end
+      end
     end
   end
 end

data/lib/rodauth/openapi.rb

@@ -5,6 +5,8 @@ require "rodauth/openapi/routes"
 
 module Rodauth
   class OpenAPI
+    Error = Class.new(StandardError)
+
     DOCS_URL = "https://rodauth.jeremyevans.net/documentation.html"
     SPEC_VERSION = "3.0.1"
 
@@ -23,6 +25,10 @@ module Rodauth
     end
 
     def generate
+      if json? && !rodauth.features.include?(:json)
+        fail Error, "JSON API documentation was requested, but JSON feature is not enabled"
+      end
+
       data = {
         openapi: SPEC_VERSION,
         info: {

data/rodauth-openapi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "rodauth-openapi"
-  spec.version       = "0.1.0"
+  spec.version       = "0.2.0"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Janko Marohnić
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth
@@ -64,7 +63,6 @@ homepage: https://github.com/janko/rodauth-openapi
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -79,8 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Allows dynamically generating OpenAPI documentation based on Rodauth configuration.
 test_files: []