rodauth-openapi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce74f8234f280f924c119e914ee31e88ee7714ccd10770626de4034edcac7da
-  data.tar.gz: 42f9cd22c79d36a6ae06e4703ce80a0da926908e5bd72f4eeb0a77644db1cf68
+  metadata.gz: a86dd14abeb963d0eebce7cda224b27079e8baec4afef8a26dd8835d61a6d1c2
+  data.tar.gz: de83fbc7157062e19dddf785fdb133ba2d32082e7bee857bba211b0a43d6dba2
 SHA512:
-  metadata.gz: e3797f271d6735174e03beda40c98f2392a338d295dcb15d06d323d52cc8828a1b0c654d798a8c3380039759a7eb769f8c9747ad4a7f0678a0f293e07eaa16de
-  data.tar.gz: bbdd36a6a8ab3d499b4f2af8487291111084e7a51851ef3e5463b861a6118922a20d217e2f5e56c185ca74e8f2a2b01b50d9694cbebd1f6312bf51cb18316b84
+  metadata.gz: 2099f86cb751e6288cded721a96477702e33f1f671958576da458dbb3283352f0d3ed3f9d1034a5778790436b86628b6ee394d96b12bb9f393beb0d29d43dbdd
+  data.tar.gz: 38833efb47e16efcf639549e166ada6d4735baa7c54f619cf873e71e378d3e4ac7cbd19588de63afef436a00e225bf0a3a2b94af3aee48403d6b1ae01b11b623

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.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.1.1"
   spec.authors       = ["Janko Marohnić"]
   spec.email         = ["janko.marohnic@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rodauth-openapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Janko Marohnić
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rodauth