steppe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 48833f95d08ddb49a1a8e620c9d78ac4e2281232abfc6a57acd5a7bdfd99fe15
+  data.tar.gz: 3b6315a44c3492c35fc22a408b6b907ae056bbe2c1d1dadb32211a9883be787e
+SHA512:
+  metadata.gz: 99e9ca81d25178bf93cafa20d12bc4735dc0da54fe36ac38ca5c09cd0f7911edf45233be624202c9051ef9578d9476dd0f99fa106119677cf5f8a5fde51b77dd
+  data.tar.gz: 6ead736e90a6b063203ebb29f41e6af8376ff1e69db20af99172b1839c2e99f2a4263abb9350bcf134a6301ed49dad7f32848178042c534752f40f3410db5db5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.4.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-06
+
+- Initial release

data/CLAUDE.md

@@ -0,0 +1,88 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Steppe is a Ruby gem for building composable, self-documenting REST APIs. It provides a DSL for defining endpoints with built-in request validation, response serialization, and OpenAPI documentation generation.
+
+## Development Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run tests
+rake spec
+# or
+bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/endpoint_spec.rb
+
+# Run console for experimentation
+bin/console
+
+# Install gem locally
+bundle exec rake install
+
+# Release new version (updates version, creates git tag, pushes to rubygems)
+bundle exec rake release
+```
+
+## Architecture
+
+### Core Components
+
+- **Service** (`lib/steppe/service.rb`): Main container that holds multiple endpoints. Defines API metadata like title, description, servers, and tags.
+
+- **Endpoint** (`lib/steppe/endpoint.rb`): Individual API endpoints that inherit from `Plumb::Pipeline`. Each endpoint defines:
+  - HTTP verb and path (with Mustermann pattern matching)
+  - Query parameter validation via `query_schema`
+  - Request body validation via `payload_schema`
+  - Response serialization via `respond`/`serialize`
+  - Processing steps via `step`
+
+- **Responder** (`lib/steppe/responder.rb`): Handles response formatting for specific status codes and content types. Uses ResponderRegistry for resolution.
+
+- **Serializer** (`lib/steppe/serializer.rb`): Base class for response serialization using Plumb types.
+
+- **Request** (`lib/steppe/request.rb`): Wrapper around Rack::Request with additional Steppe-specific functionality.
+
+- **Result** (`lib/steppe/result.rb`): Represents processing state (Continue/Halt) with params, errors, and response data.
+
+### Key Dependencies
+
+- **Plumb**: Type validation and coercion library (used for schemas and pipelines)
+- **Mustermann**: Pattern matching for URL routes
+- **Rack**: Web server interface
+- **MIME Types**: Content type handling
+
+### Request Processing Flow
+
+1. Request hits Service endpoint
+2. URL parameters extracted via Mustermann
+3. Query parameters validated against `query_schema`
+4. Request body parsed and validated against `payload_schema`
+5. Business logic steps executed via `step` blocks
+6. Response serialized via matching Responder
+7. Rack response returned
+
+### Testing
+
+Tests use RSpec and are located in `spec/`. The main test files are:
+- `spec/endpoint_spec.rb` - Endpoint functionality
+- `spec/service_spec.rb` - Service container
+- `spec/responder_spec.rb` - Response handling
+- `spec/openapi_visitor_spec.rb` - OpenAPI generation
+
+### Example Usage
+
+See `examples/sinatra.rb` for a complete working example that integrates Steppe with Sinatra and demonstrates:
+- Defining a Service with multiple endpoints
+- Query parameter validation
+- Request body validation
+- Custom serializers
+- OpenAPI documentation generation
+
+The gem follows standard Ruby gem conventions with lib/ containing source code and spec/ containing tests.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ismael Celis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.