mortymer 0.0.2

data/lib/mortymer/openapi_generator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "endpoint_registry"
+require_relative "utils/string_transformations"
+
+module Mortymer
+  # Generate an openapi doc based on the registered endpoints
+  class OpenapiGenerator
+    include Utils::StringTransformations
+
+    def initialize(prefix: "", title: "Rick on Rails API", version: "v1", description: "", registry: [])
+      @prefix = prefix
+      @title = title
+      @version = version
+      @description = description
+      @endpoints_registry = registry
+    end
+
+    def generate
+      {
+        openapi: "3.0.1",
+        info: { title: @title, version: @version, description: @description },
+        paths: generate_paths,
+        components: { schemas: generate_schemas }
+      }
+    end
+
+    private
+
+    def generate_paths
+      @endpoints_registry.each_with_object({}) do |endpoint, paths|
+        next unless endpoint.routeable?
+
+        schema = endpoint.generate_openapi_schema || {}
+        schema = schema.transform_keys { |k| @prefix + k }
+        paths.merge!(schema)
+      end || {}
+    end
+
+    def generate_schemas # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+      schemas = {
+        "Error422" => {
+          type: "object",
+          required: %w[error details],
+          properties: {
+            error: {
+              type: "string",
+              description: "Error type identifier",
+              example: "Validation Failed"
+            },
+            details: {
+              type: "string",
+              description: "Detailed error message",
+              example: 'type_error: ["foo"] is not a valid Integer'
+            }
+          }
+        }
+      }
+
+      @endpoints_registry.each do |endpoint|
+        next unless endpoint.routeable?
+
+        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)
+        end
+
+        if endpoint.output_class && !schemas.key?(demodulize(endpoint.output_class.name))
+          schemas[demodulize(endpoint.output_class.name)] =
+            Dry::Swagger::DocumentationGenerator.new.from_struct(endpoint.output_class)
+        end
+      end
+      schemas
+    end
+  end
+end

data/lib/mortymer/rails/configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mortymer
+  module Rails
+    # A configuration api for Rails & Morty integration
+    class Configuration
+      attr_accessor :base_controller_class, :error_handler, :wrap_methods
+
+      def initialize
+        @base_controller_class = "ApplicationController"
+        @error_handler = ->(error) { raise error }
+        @wrap_methods = true
+      end
+    end
+  end
+end

data/lib/mortymer/rails/endpoint_wrapper_controller.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Mortymer
+  module Rails
+    # This controller acts as a wrapper for Morty endpoints, handling param conversion
+    # and response rendering
+    class EndpointWrapperController < ::ActionController::API
+      rescue_from Dry::Struct::Error, with: :handle_invalid_params
+      rescue_from Dry::Types::CoercionError, with: :handle_invalid_params
+
+      # This method should be used when inheriting from a Controller
+      def execute
+        endpoint_class = request.env["morty.endpoint_class"]
+        dispatch_action_to(self, endpoint_class.action, endpoint_class.input_class)
+      end
+
+      def handle
+        endpoint_class = request.env["morty.endpoint_class"]
+        controller_class = endpoint_class.controller_class
+        handler = controller_class.new
+        dispatch_action_to(handler, endpoint_class.action, endpoint_class.input_class)
+      end
+
+      private
+
+      def action_params
+        p = params.to_unsafe_h.to_h.deep_transform_keys(&:to_sym)
+        p.delete(:controller)
+        p.delete(:actioncontroller)
+        p
+      end
+
+      def dispatch_action_to(controller, method, input_class)
+        input = input_class.new(action_params)
+        output = controller.send(method, input)
+        render json: output.to_h, status: :ok
+      end
+
+      def handle_invalid_params(error)
+        render json: { error: "Validation Failed", details: error.message }, status: :unprocessable_entity
+      end
+    end
+  end
+end

data/lib/mortymer/rails/routes.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Mortymer
+  module Rails
+    # This module is in charge of making each registered Morty Endpoint
+    # routeable through rails
+    class Routes
+      def initialize(drawer)
+        @drawer = drawer
+      end
+
+      def mount_morty_endpoints
+        Morty::EndpointRegistry.registry.each do |endpoint|
+          mount_endpoint(endpoint)
+        end
+      end
+
+      def mount_controllers
+        Morty::EndpointRegistry.registry.each do |endpoint|
+          mount_controller(endpoint)
+        end
+      end
+
+      private
+
+      def mount_controller(endpoint)
+        return unless endpoint.routeable?
+
+        @drawer.send(
+          endpoint.http_method,
+          endpoint.path,
+          to: "#{endpoint.controller_name.gsub(/_controller$/, "")}##{endpoint.action}",
+          as: "#{endpoint.http_method}_#{endpoint.api_name}"
+        )
+      end
+
+      def mount_endpoint(endpoint)
+        return unless endpoint.routeable?
+
+        path = endpoint.path || endpoint.infer_path_from_class
+
+        # Store the endpoint class in the request env for the wrapper to access
+        defaults = { controller: "morty/rails/endpoint_wrapper", action: "handle" }
+        constraints = lambda do |request|
+          request.env["morty.endpoint_class"] = endpoint
+          true
+        end
+
+        case endpoint.http_method
+        when :get
+          @drawer.get path, to: "morty/rails/endpoint_wrapper#handle", defaults: defaults, constraints: constraints
+        when :post
+          @drawer.post path, to: "morty/rails/endpoint_wrapper#handle", defaults: defaults, constraints: constraints
+        when :put
+          @drawer.put path, to: "morty/rails/endpoint_wrapper#handle", defaults: defaults, constraints: constraints
+        when :delete
+          @drawer.delete path, to: "morty/rails/endpoint_wrapper#handle", defaults: defaults, constraints: constraints
+        end
+      end
+    end
+  end
+end

data/lib/mortymer/rails.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "morty/rails/configuration"
+require "morty/rails/endpoint_wrapper_controller"
+require "morty/rails/routes"
+
+module Mortymer
+  module Rails
+    class << self
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+  end
+end

data/lib/mortymer/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "rails/routes"
+require_relative "rails/configuration"
+require_relative "rails/endpoint_wrapper_controller"
+
+module Mortymer
+  class Railtie < ::Rails::Railtie
+    config.morty = Mortymer::Rails::Configuration.new
+
+    initializer "mortymer.initialize" do |app|
+    end
+  end
+end

data/lib/mortymer/utils/string_transformations.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Mortymer
+  module Utils
+    # Provides string transformation utilities similar to ActiveSupport's methods
+    module StringTransformations
+      module_function
+
+      def underscore(camel_cased_word)
+        return camel_cased_word unless camel_cased_word.is_a?(String)
+
+        word = camel_cased_word.to_s.dup
+        word.gsub!(/::/, "/")
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+
+      def demodulize(path)
+        return path unless path.is_a?(String)
+
+        path.split("::").last
+      end
+    end
+  end
+end

data/lib/mortymer/version.rb

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

data/lib/mortymer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# typed: true
+
+require "dry/struct"
+require "mortymer/model"
+require "mortymer/endpoint"
+require "mortymer/dry_swagger"
+require "mortymer/endpoint_registry"
+require "mortymer/utils/string_transformations"
+require "mortymer/api_metadata"
+require "mortymer/openapi_generator"
+require "mortymer/container"
+require "mortymer/dependencies_dsl"
+require "mortymer/rails" if defined?(Rails)
+require "mortymer/railtie" if defined?(Rails::Railtie)

data/lib/mortymermer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# typed: true
+
+require "dry/struct"
+require "mortymer/model"
+require "mortymer/endpoint"
+require "mortymer/dry_swagger"
+require "mortymer/endpoint_registry"
+require "mortymer/utils/string_transformations"
+require "mortymer/api_metadata"
+require "mortymer/openapi_generator"
+require "mortymer/container"
+require "mortymer/dependencies_dsl"
+require "mortymer/rails" if defined?(Rails)
+require "mortymer/railtie" if defined?(Rails::Railtie)

data/mortymer.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/mortymer/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mortymer"
+  spec.version = Mortymer::VERSION
+  spec.authors = ["Adrian Gonzalez"]
+  spec.email = ["adriangonzalezsanchez1996@gmail.com"]
+
+  spec.summary = "A really simple DSL for writing API endpoints with openapi support"
+  spec.description = "A simple DSL to describe metadata for endpoints and automatic params construction based on dry-struct schemas. Support for openapi"
+  spec.homepage = "https://github.com/adriangs1996/morty"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "dry-monads", "~> 1.7"
+  spec.add_dependency "dry-struct", "~> 1.7"
+  spec.add_dependency "dry-swagger", "~> 2.0"
+  spec.add_dependency "dry-system", "~> 1.2"
+  spec.add_dependency "dry-validation", "~> 1.11"
+
+  spec.add_development_dependency "rails", "~> 8.0"
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end