mortymer 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23f37db069ed2b34095d8c6d60bb257478af6544361fd4bc61349bdb8d764ca7
-  data.tar.gz: 6dd9aa47b963f63de8f5f50a6e81341e4f090d0deeff244d2f8094e468438f03
+  metadata.gz: c454029d3e20ca350725c27aa1352769467599d1dcc06fa91bc79eda2f63c967
+  data.tar.gz: f1a4f441ec003b1bcc7d54ad1451fdd11ef796802931f98c1d0ee765d0758c3d
 SHA512:
-  metadata.gz: ce8c2077ad575b4c7cc289d14d2cddbb8c3a7f8c970f57f8a57df6046a13df05dfc7836b679784b641092214ba938e028661dc57b7ef7ac281dd6c453e415ced
-  data.tar.gz: f87678c7131a5abefe616819e42befc9b0065ac7e6d31a5e8800bf3806d63fa903e22f7f8006b6d3a10cbfcd66dbb8980a948823e59ce23a8a8144d76fb94473
+  metadata.gz: cde4a983859216b21cc13f9f5e582d3e47b4b6a7436fa17598afc0c69f750f0538fc0f95b71c298d876c0da03d78251e7d31868ab54d23f850dde3b1e30e6bb8
+  data.tar.gz: 47213cc011672d545cc97b97f2393f1064e3f658a883fec3352047034ea539991a795561879d13dea1a46fb9f953ccea0e2fa4f14875bc3759a4de1b881c898a

data/docs/guide/quick-start.md

@@ -27,21 +27,6 @@ Then install it:
 bundle install
 ```
 
-Mortymer requires that every class is autoloaded for it to work. This is deafault rails
-behavior when running in production, but it is disabled by default on development, so,
-we first need to enable eager load
-
-```ruby
-# config/environments/development.rb
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-
-  config.eager_load = true # This line is false by default, change it to true
-
-  # other configs hers ...
-end
-```
-
 In rails environments, Mortymer can automatically create the routes for you, it is not necessary
 that you register them one by one.
 
@@ -109,11 +94,10 @@ end
 Set up your API controller with Mortymer's features:
 
 ```ruby
-# app/controllers/api/books_controller.rb
-module Api
-  class BooksController < ApplicationController
-    include Mortymer::DependeciesDsl
+# app/controllers/example_controller.rb
+class ExampleController < ApplicationController
     include Mortymer::ApiMetadata
+    include Mortymer::DependenciesDsl
 
     inject BookService, as: :books
 
@@ -130,13 +114,13 @@ module Api
       attribute :published_year, Coercible::Integer
     end
 
-    # GET /api/books
-    get input: Empty, output: ListAllBooksOutput
+    tags :Books
+
+    get input: Empty, output: ListAllBooksOutput, path: "/examples/list_books"
     def list_all_books(_params)
       ListAllBooksOutput.new(books: @books.list_books)
     end
 
-    # POST /api/books
     post input: CreateBookInput, output: Book
     def create_book(params)
       @books.create_book(
@@ -145,7 +129,6 @@ module Api
         published_year: params.published_year
       )
     end
-  end
 end
 ```
 
@@ -182,3 +165,16 @@ This simple example showcases several of Mortymer's powerful features:
 - ✨ **Type System**: Strong typing with `Mortymer::Models` which are powered by `Dry::Struct`
 - 🔌 **Dependency Injection**: Clean service injection with `inject :book_service`
 - ✅ **Parameter Validation**: Built-in request validation in controllers
+
+## OpenAPI Documentation
+
+Mortymer automatically generates OpenAPI (Swagger) documentation for your API endpoints. After setting up your application, you can access the Swagger UI at `/api-docs`:
+
+![Swagger UI](../assets/swagg.png)
+
+This interactive documentation allows you to:
+
+- Browse all available endpoints
+- See request/response schemas
+- Test API endpoints directly from the browser
+- Download the OpenAPI specification

data/lib/mortymer/api_metadata.rb

@@ -15,20 +15,39 @@ module Mortymer
 
     # The DSL
     module ClassMethods
-      def get(input:, output:, path: nil)
-        register_endpoint(:get, input, output, path)
+      def secured_with(security)
+        @__endpoint_security__ = security
       end
 
-      def post(input:, output:, path: nil)
-        register_endpoint(:post, input, output, path)
+      def remove_security!
+        @__endpoint_security__ = nil
       end
 
-      def put(input:, output:, path: nil)
-        register_endpoint(:put, input, output, path)
+      def tags(*tag_list)
+        @__endpoint_tags__ = tag_list
       end
 
-      def delete(input:, output:, path: nil)
-        register_endpoint(:delete, input, output, path)
+      def __default_tag_for_endpoint__
+        # Assuming the endpoint is always defined inside a module
+        # the Tag would be the module of that endpoint. If no module, then
+        # we take the endpoint and remove any endpoint, controller suffix
+        [name.split("::").last(2).first] || [name.gsub(/Controller$/, "").gsub(/Endpoint$/, "")]
+      end
+
+      def get(input:, output:, path: nil, security: nil)
+        register_endpoint(:get, input, output, path, security || @__endpoint_security__)
+      end
+
+      def post(input:, output:, path: nil, security: nil)
+        register_endpoint(:post, input, output, path, security || @__endpoint_security__)
+      end
+
+      def put(input:, output:, path: nil, security: nil)
+        register_endpoint(:put, input, output, path, security || @__endpoint_security__)
+      end
+
+      def delete(input:, output:, path: nil, security: nil)
+        register_endpoint(:delete, input, output, path, security || @__endpoint_security__)
       end
 
       private
@@ -56,14 +75,16 @@ module Mortymer
         end
       end
 
-      def register_endpoint(http_method, input_class, output_class, path)
+      def register_endpoint(http_method, input_class, output_class, path, security)
         @__endpoint_signature__ =
           {
             http_method: http_method,
             input_class: input_class,
             output_class: output_class,
             path: path,
-            controller_class: self
+            controller_class: self,
+            security: security,
+            tags: @__endpoint_tags__ || __default_tag_for_endpoint__
           }
       end
 

data/lib/mortymer/configuration.rb

@@ -19,7 +19,7 @@ module Mortymer
   # Global configuration for Mortymer
   class Configuration
     attr_accessor :container, :serve_swagger, :swagger_title, :swagger_path, :swagger_root, :api_version,
-                  :api_description
+                  :api_description, :security_schemes
 
     def initialize
       @container = Mortymer::Container.new
@@ -29,6 +29,7 @@ module Mortymer
       @swagger_root = "/api-docs"
       @api_description = "An awsome API developed with MORTYMER"
       @api_version = "v1"
+      @security_schemes = {}
     end
   end
 end

data/lib/mortymer/endpoint.rb

@@ -13,6 +13,8 @@ module Mortymer
       @path = opts[:path] || infer_path_from_class
       @controller_class = opts[:controller_class]
       @action = opts[:action]
+      @security = opts[:security]
+      @tags = opts[:tags]
     end
 
     def routeable?
@@ -37,7 +39,7 @@ module Mortymer
     def generate_openapi_schema # rubocop:disable Metrics/MethodLength
       return unless defined?(@input_class) && defined?(@output_class)
 
-      input_schema = Dry::Swagger::DocumentationGenerator.new.from_struct(@input_class)
+      input_schema = @input_class.respond_to?(:json_schema) ? @input_class.json_schema : Dry::Swagger::DocumentationGenerator.new.from_struct(@input_class)
       responses = {
         "200" => {
           description: "Successful response",
@@ -61,14 +63,17 @@ module Mortymer
         }
       end
 
+      operation = {
+        operation_id: operation_id,
+        parameters: generate_parameters,
+        requestBody: generate_request_body,
+        responses: responses,
+        tags: @tags
+      }
+      operation[:security] = security if @security
       {
         path.to_s => {
-          http_method.to_s => {
-            operation_id: operation_id,
-            parameters: generate_parameters,
-            requestBody: generate_request_body,
-            responses: responses
-          }
+          http_method.to_s => operation
         }
       }
     end
@@ -90,6 +95,16 @@ module Mortymer
       has_required || has_coercions
     end
 
+    def security
+      return [] if @security.nil?
+
+      return [{ @security => [] }] if @security.is_a?(Symbol)
+
+      return [@security.scheme] if @security.respond_to?(:scheme)
+
+      [@security]
+    end
+
     def generate_parameters
       return [] unless @input_class && %i[get delete].include?(@http_method)
 

data/lib/mortymer/openapi_generator.rb

@@ -8,12 +8,14 @@ module Mortymer
   class OpenapiGenerator
     include Utils::StringTransformations
 
-    def initialize(prefix: "", title: "Rick on Rails API", version: "v1", description: "", registry: [])
+    def initialize(prefix: "", title: "Rick on Rails API", version: "v1", description: "", registry: [],
+                   security_schemes: {})
       @prefix = prefix
       @title = title
       @version = version
       @description = description
       @endpoints_registry = registry
+      @security_schemes = security_schemes
     end
 
     def generate
@@ -21,7 +23,10 @@ module Mortymer
         openapi: "3.0.1",
         info: { title: @title, version: @version, description: @description },
         paths: generate_paths,
-        components: { schemas: generate_schemas }
+        components: {
+          schemas: generate_schemas,
+          securitySchemes: @security_schemes
+        }
       }
     end
 
@@ -32,8 +37,11 @@ module Mortymer
         next unless endpoint.routeable?
 
         schema = endpoint.generate_openapi_schema || {}
-        schema = schema.transform_keys { |k| @prefix + k }
-        paths.merge!(schema)
+        schema.each do |path, methods|
+          prefixed_path = @prefix + path
+          paths[prefixed_path] ||= {}
+          paths[prefixed_path].merge!(methods)
+        end
       end || {}
     end
 
@@ -62,13 +70,21 @@ module Mortymer
 
         if endpoint.input_class && !schemas.key?(demodulize(endpoint.input_class.name))
           schemas[demodulize(endpoint.input_class.name)] =
-            Dry::Swagger::DocumentationGenerator.new.from_struct(endpoint.input_class)
+            if endpoint.input_class.respond_to?(:json_schema)
+              endpoint.input_class.json_schema
+            else
+              Dry::Swagger::DocumentationGenerator.new.from_struct(endpoint.input_class)
+            end
         end
 
-        if endpoint.output_class && !schemas.key?(demodulize(endpoint.output_class.name))
-          schemas[demodulize(endpoint.output_class.name)] =
+        next unless endpoint.output_class && !schemas.key?(demodulize(endpoint.output_class.name))
+
+        schemas[demodulize(endpoint.output_class.name)] =
+          if endpoint.output_class.respond_to?(:json_schema)
+            endpoint.output_class.json_schema
+          else
             Dry::Swagger::DocumentationGenerator.new.from_struct(endpoint.output_class)
-        end
+          end
       end
       schemas
     end

data/lib/mortymer/railtie.rb

@@ -26,7 +26,8 @@ module Mortymer
             registry: Mortymer::EndpointRegistry.registry,
             title: Mortymer.config.swagger_title,
             version: Mortymer.config.api_version,
-            description: Mortymer.config.api_description
+            description: Mortymer.config.api_description,
+            security_schemes: Mortymer.config.security_schemes
           )
 
           # Save OpenAPI spec to public directory

data/lib/mortymer/security_schemes.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Mortymer
+  module SecuritySchemes
+    # Define the Bearer Auth security scheme
+    class Bearer
+      def self.scheme(scopes = [].freeze)
+        { BearerAuth: scopes }
+      end
+
+      def self.to_scheme
+        {
+          BearerAuth: {
+            type: :http,
+            scheme: :bearer
+          }
+        }
+      end
+    end
+
+    # Define the API Key security scheme
+    class ApiKey
+      def self.scheme(scopes = [].freeze)
+        { ApiKeyAuth: scopes }
+      end
+
+      def self.to_scheme(name: "X-API-Key", in: :header)
+        {
+          ApiKeyAuth: {
+            type: :apiKey,
+            name: name,
+            in: binding.local_variable_get(:in) # Use binding because 'in' is a reserved word
+          }
+        }
+      end
+    end
+
+    # Define the Basic Auth security scheme
+    class Basic
+      def self.scheme(scopes = [].freeze)
+        { BasicAuth: scopes }
+      end
+
+      def self.to_scheme
+        {
+          BasicAuth: {
+            type: :http,
+            scheme: :basic
+          }
+        }
+      end
+    end
+
+    # Define the OAuth2 security scheme
+    class OAuth2
+      def self.scheme(scopes = [].freeze)
+        { OAuth2: scopes }
+      end
+
+      def self.to_scheme(flows: {})
+        {
+          OAuth2: {
+            type: :oauth2,
+            flows: flows || {
+              implicit: {
+                authorizationUrl: "/oauth/authorize",
+                scopes: {
+                  "read:api" => "Read access",
+                  "write:api" => "Write access"
+                }
+              },
+              password: {
+                tokenUrl: "/oauth/token",
+                scopes: {
+                  "read:api" => "Read access",
+                  "write:api" => "Write access"
+                }
+              }
+            }
+          }
+        }
+      end
+    end
+  end
+end

data/lib/mortymer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Mortymer
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/mortymer.rb

@@ -12,5 +12,6 @@ require "mortymer/api_metadata"
 require "mortymer/openapi_generator"
 require "mortymer/container"
 require "mortymer/dependencies_dsl"
+require "mortymer/security_schemes"
 require "mortymer/rails" if defined?(Rails)
 require "mortymer/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mortymer
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Adrian Gonzalez
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads
@@ -116,6 +116,7 @@ files:
 - docs/.vitepress/theme/style.css
 - docs/advanced/dependency-injection.md
 - docs/advanced/openapi.md
+- docs/assets/swagg.png
 - docs/guide/api-metadata.md
 - docs/guide/introduction.md
 - docs/guide/models.md
@@ -136,6 +137,7 @@ files:
 - lib/mortymer/rails/endpoint_wrapper_controller.rb
 - lib/mortymer/rails/routes.rb
 - lib/mortymer/railtie.rb
+- lib/mortymer/security_schemes.rb
 - lib/mortymer/utils/string_transformations.rb
 - lib/mortymer/version.rb
 - lib/mortymermer.rb