passerelle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4d615ed2f33f0e8fa815939e2c408f7d239289a59b7d0a306d1adf46181fa9b
+  data.tar.gz: 6a2b031da7ab9c6559a3b22e7bc64bfa4d47fd94edaaa45614135c7d28cee2ac
+SHA512:
+  metadata.gz: a92e7567046538bb461f60459ca06752227852303e5a86e8f1214d54a7c5ff4e4e9e8332fa6e33294438721764245de3ec4aac8115d9bd52c201714290a11fde
+  data.tar.gz: a2bb38d607fe0312453b9937ad666f5707f9b51ffb786bdbfe2ea1f739992a32364de79705dfcf6667daa8c639a63f1c8fda9df0d5a2923dea9852db2c6f43fa

data/README.md

@@ -0,0 +1,54 @@
+# Passerelle
+
+**Passerelle** is a convention-over-configuration OpenAPI schema builder for Rails. It's a simple engine you mount in your routes that automatically generates OpenAPI 3.0 schemas from your Rails models.
+
+> **⚠️ Work in Progress**: Passerelle is under development. Nothing works yet.
+
+## Philosophy
+
+- **Convention first**: Your database and ActiveRecord layer dictate the schema defaults. Easy to keep aligned with changes.
+- **Write as little as possible, as much as necessary**: Layer in types and customizations only where needed. Convention handles the rest.
+- **Verifiable**: Generate schema dumps, test against them, commit and track changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'passerelle'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Quick Start
+
+1. Create a schema class:
+
+```ruby
+# app/api/api_schema.rb
+class ApiSchema < Passerelle::Schema
+  # That's it! Convention generates CRUD endpoints for all models
+end
+```
+
+2. Generate and view your OpenAPI spec:
+
+```ruby
+ApiSchema.new.to_json  # => Full OpenAPI 3.0 specification
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports, feature requests, and ideas are welcome on GitHub at <https://github.com/manufaktor/passerelle>.
+
+Note: This project is not currently accepting code contributions (pull requests), but feedback and suggestions are always appreciated.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/passerelle/schema.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Passerelle
+  class Schema
+    class << self
+      # DSL methods will be defined here
+      def model(model_class, &block)
+        # TODO: Store model configuration
+      end
+
+      def endpoint(path, method:, &block)
+        # TODO: Store custom endpoint configuration
+      end
+
+      def info(&block)
+        # TODO: Store API info (title, version, description)
+      end
+
+      def server(url)
+        # TODO: Store server URL
+      end
+
+      def security_scheme(name, &block)
+        # TODO: Store security scheme
+      end
+
+      def models(*model_classes)
+        # TODO: Override default model discovery
+      end
+    end
+
+    def initialize
+      # By convention, discover all ApplicationRecord descendants
+      @models = discover_models
+      @endpoints = []
+      @info = default_info
+    end
+
+    def to_json
+      to_h.to_json
+    end
+
+    def to_h
+      {
+        openapi: "3.0.3",
+        info: @info,
+        paths: generate_paths,
+        components: generate_components
+      }
+    end
+
+    private
+
+    def discover_models
+      # TODO: Discover all ApplicationRecord descendants
+      # ApplicationRecord.descendants
+      []
+    end
+
+    def default_info
+      {
+        title: "API",
+        version: "1.0.0",
+        description: "Auto-generated API by Passerelle"
+      }
+    end
+
+    def generate_paths
+      # TODO: Generate OpenAPI paths from models
+      {}
+    end
+
+    def generate_components
+      # TODO: Generate OpenAPI components (schemas)
+      { schemas: {} }
+    end
+  end
+end

data/lib/passerelle/version.rb

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

data/lib/passerelle.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Passerelle
+  class Error < StandardError; end
+end
+
+require_relative "passerelle/version"

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: passerelle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- manufaktor
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Passerelle (French for 'gateway') automatically generates OpenAPI schemas
+  and API endpoints from your Rails models by convention, with configuration where
+  you need it.
+email:
+- manufaktor@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/passerelle.rb
+- lib/passerelle/schema.rb
+- lib/passerelle/version.rb
+homepage: https://github.com/manufaktor/passerelle
+licenses: []
+metadata:
+  homepage_uri: https://github.com/manufaktor/passerelle
+  source_code_uri: https://github.com/manufaktor/passerelle
+  changelog_uri: https://github.com/manufaktor/passerelle/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Convention-over-configuration OpenAPI schema builder for Rails
+test_files: []