apicraft-rails 0.5.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 847b284dc12a51e2364740eef912f4238c771a7e9d143fa7ea63090afca69e03
+  data.tar.gz: 1a2c2c667280415035ca7af8a95de9dbadc2859ee932a65c4890b30f37208821
+SHA512:
+  metadata.gz: 588307957dd26f89f9f661ab36f55ea33d47fd601e4f563481e32a29a526734c8daa8e2c51bd2741ace545a52079549587f7cc720f9c1f84f7187533cf4dd294
+  data.tar.gz: 4a65d260b4f9124733cb1aeb1d069598f0f87ad6e4a6322c0bfa2ba842fdbcca2de626e23fb6dfbcae0340eb8ddb51a4400867e544a278c4fa2dd12c237bfe4b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-26
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at abhisheksarka@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,257 @@
+# APICraft Rails (Beta)
+[![Build](https://github.com/apicraft-dev/apicraft-rails/actions/workflows/build.yml/badge.svg)](https://github.com/apicraft-dev/apicraft-rails/actions/workflows/build.yml)
+
+🚀 Accelerates your development by 2-3x with an API Design First approach. Seamlessly integrates with your Rails application server — no fancy tooling or expenses required.
+
+![APICraft Rails Logo](assets/apicraft_rails.png)
+
+## ✨ Features
+- 🧑‍💻️ **Dynamic Mock Data Generation** - Detects the specifications and instantly mounts working routes with mock responses. No extra configuration required.
+
+- ⚙️ **Customizable Mock Responses** - Tailor mock responses to simulate different scenarios and edge cases, helping your team prepare for real-world conditions right from the start.
+
+- 🔍 **API Introspections** - Introspect API schemas without needing to dig into the docs everytime.
+
+- 📺 **Documentation Out of the Box** - Documentation using `SwaggerDoc` and `Redoc` both.
+
+- 🗂 **Easy Contracts Management** - Management of `openapi` specifications from within `app/contracts` directory. No new syntax, just plain old `openapi` standard with `.json` or `.yaml` formats
+
+- 🔜 **Request Validations** - Automatic request validations (coming soon)
+
+
+## 🪄 Works Like Magic
+
+Once you’ve installed the gem, getting started is a breeze. Simply create your OpenAPI contracts within the `app/contracts` directory of your Rails application. You’re free to organize this directory in a way that aligns with your project's standards and preferences. That’s it—your APIs will be up and running with mock responses, ready for development without any additional setup. It's as effortless as it sounds!
+
+## 🕊 API Design First Philosophy
+
+![APICraft Rails Logo](assets/api_first_workflow.jpg)
+
+The API Design First philosophy is at the heart of APICraft Rails, and it’s a game-changer for development speed and efficiency:
+
+- 🔄 **Parallel Development:** By designing your APIs upfront, both frontend and backend teams can work simultaneously using mock APIs, eliminating bottlenecks and reducing wait times.
+
+- 📜 **Clear Contracts:** OpenAPI contracts serve as a single source of truth, ensuring that all teams are aligned on how the API should behave, reducing misunderstandings and rework.
+
+- ⚙️ **Early Testing:** Mock APIs allow QA to begin testing earlier in the development cycle, catching issues before they become costly to fix.
+
+- 🔍 **Faster Feedback Loop:** Immediate feedback on API design helps you iterate quickly, refining your API based on real usage scenarios, ultimately leading to a more robust product.
+
+- 🚀 **Reduced Integration Time:** With consistent API contracts in place, integrating various components becomes smoother and faster, cutting down on the time required to bring everything together.
+
+By adopting an API Design First approach with APICraft Rails, you can accelerate your development process by 2-3x, delivering high-quality APIs faster and with fewer headaches.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apicraft-rails', '~> 0.5.0.beta1'
+```
+
+And then execute:
+
+    $ bundle install
+
+After the installation in your rails project, you can start adding contracts in the `app/contracts` directory. This can have any internal directory structure based on your API versions, standards, etc.
+
+Add the following into your Rails application, via the `config/application.rb`
+
+```ruby
+# config/application.rb
+module App
+  class Application < Rails::Application
+    # Rest of the configuration...
+
+    config.middleware.use Apicraft::Middlewares::Mocker
+    config.middleware.use Apicraft::Middlewares::Introspector
+
+    Apicraft.configure do |config|
+      config.contracts_path = Rails.root.join("app/contracts")
+    end
+  end
+end
+```
+
+Now every API in the specification has a functional version. For any path (from the contracts), APICraft serves a mock response when `Apicraft-Mock: true` is passed in the headers otherwise, it forwards the request to your application as usual.
+
+## Usage
+
+Add your specification files to the `app/contracts` directory in your Rails project. You can also configure this directory to be something else.
+```
+my_rails_app/
+├── app/
+│   ├── controllers/
+│   │   ├── application_controller.rb
+│   │   └── users_controller.rb
+│   ├── contracts/
+│   │   ├── users_contract.yaml
+│   │   └── orders_contract.yaml
+│   ├── models/
+│   │   ├── user.rb
+│   │   └── order.rb
+```
+### 🥷 Working with Mock APIs
+**APICraft** dynamically generates mock APIs by interpreting contract specifications on the fly. You can request the mock response by passing `Apicraft-Mock: true` in the headers.
+
+`https://yoursite.com/api/orders`
+```
+headers: {
+  Apicraft-Mock: true
+}
+```
+```json
+[
+  {
+    "id": 66,
+    "name": "tempora",
+    "description": "error"
+  },
+  {
+    "id": 41,
+    "name": "et",
+    "description": "id"
+  }
+]
+```
+
+The above is an example of a 200 response. If you have more responses documented you can force that behaviour using `Apicraft-Response-Code` header in the mock request.
+
+`https://yoursite.com/api/orders`
+```
+headers: {
+  Apicraft-Response-Code: 400
+  Apicraft-Mock: true
+}
+```
+```json
+{
+  "code": 400,
+  "message": "Something's not right"
+}
+```
+
+### 👀 API Introspection
+All APIs are can be introspected. You can do so by passing the `Apicraft-Introspection` header.
+
+```
+headers: {
+  Apicraft-Introspection: true
+}
+```
+
+Example: `https://yoursite.com/api/orders`
+```json
+{
+  "summary": "Retrieve a list of orders",
+  "description": "Returns a list of orders in either JSON or XML format.",
+  "operationId": "getOrders",
+  "parameters": [
+    {
+      "name": "format",
+      "in": "query",
+      "description": "The response format (json or xml)",
+      "required": false,
+      "schema": {
+        "type": "string",
+        "enum": [
+          "json",
+          "xml"
+        ]
+      }
+    }
+  ],
+  "responses": {
+    ...
+  }
+}
+```
+### 👀 API Documentation
+
+Mount the documentation views in your route file.
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  # Rest of the routes...
+  mount Apicraft::Web::App, at: "/apicraft"
+end
+```
+
+You can browse API Documentation at
+- `/apicraft/swaggerdoc`
+- `/apicraft/redoc`
+
+Enable authentication for the `/apicraft` namespace.
+
+```ruby
+# config/application.rb
+module App
+  class Application < Rails::Application
+    # Rest of the configuration...
+    Apicraft::Web::App.use do |user, password|
+      [user, password] == ["admin", "password"]
+    end
+  end
+end
+```
+
+## Configuration
+
+List of available configurations.
+
+```ruby
+Apicraft.configure do |config|
+  config.contracts_path = Rails.root.join("app/contracts")
+
+  # Enables or disables the mocking features
+  # Defaults to true
+  config.mocks = true
+
+  # Enables or disables the introspection features
+  # Defaults to true
+  config.introspection = true
+
+  # allows you to enforce stricter validation of $ref
+  # references in your OpenAPI specifications.
+  # When this option is enabled, the parser will raise
+  # an error if any $ref references in your OpenAPI
+  # document are invalid, ensuring that all references
+  # are correctly defined and resolved.
+  # Defaults to true
+  config.strict_reference_validation = true
+
+  config.headers = {
+    # The name of the header used to control
+    # the response code of the mock
+    # Defaults to Apicraft-Response-Code
+    response_code: "Apicraft-Response-Code",
+
+    # The name of the header to introspect the API.
+    # Defaults to Apicraft-Introspect
+    introspect: "Apicraft-Introspect"
+
+    # The name of the header to mock the API.
+    # Defaults to Apicraft-Mock
+    mock: "Apicraft-Mock"
+  }
+end
+
+Apicraft::Web::App.use do |user, password|
+  [user, password] == ["admin", "password"]
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apicraft-dev/apicraft-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/apicraft-dev/apicraft-rails/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Apicraft project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/apicraft/blob/main/CODE_OF_CONDUCT.md).

data/apicraft-rails.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/apicraft/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "apicraft-rails"
+  spec.version = Apicraft::VERSION
+  spec.authors = ["Abhishek Sarkar"]
+  spec.email = ["abhisheksarka@gmail.com"]
+
+  spec.summary = "APICraft Rails - Simplified API Design First Development"
+  spec.description = "🚀 Accelerates your development by 2-3x with an API Design First approach. Seamlessly integrates with your Rails application server — no fancy tooling or expenses required."
+  spec.homepage = "https://github.com/apicraft-dev/apicraft-rails"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/apicraft-dev/apicraft-rails"
+  spec.metadata["changelog_uri"] = "https://github.com/apicraft-dev/apicraft-rails/blob/main/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.glob("{lib,bin,web}/**/*") + Dir.glob("*.{gemspec,md}")
+  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 "activesupport"
+  spec.add_dependency "erb"
+  spec.add_dependency "faker"
+  spec.add_dependency "mime-types"
+  spec.add_dependency "openapi_parser"
+  spec.add_dependency "rack"
+  spec.add_dependency "railties"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "apicraft-rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/apicraft/concerns/cacheable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Apicraft
+  module Concerns
+    # Simple cache structure to not
+    # fetch the same data multiple times
+    # from the contracts
+    module Cacheable
+      @cache = {
+        key: {
+          loaded: true,
+          content: {}
+        }
+      }.with_indifferent_access
+
+      def self.cache
+        @cache
+      end
+
+      def with_cache(key)
+        data = Cacheable.cache[key]
+        return data[:content] if data.present?
+
+        c = yield
+        Cacheable.cache[key] = { content: c } if c.present?
+        c
+      end
+    end
+  end
+end

data/lib/apicraft/concerns.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "concerns/cacheable"
+
+module Apicraft
+  # Namespace module for Concerns
+  module Concerns; end
+end

data/lib/apicraft/config.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Apicraft
+  # Configuration class for Apicraft.
+  #
+  # This class provides a simple way to configure Apicraft's behavior.
+  # It uses a hash-based configuration system, where default values can be
+  # overridden by user-provided options.
+  class Config
+    DEFAULTS = {
+      contracts_path: nil,
+      headers: {
+        response_code: "Apicraft-Response-Code",
+        introspect: "Apicraft-Introspect",
+        mock: "Apicraft-Mock",
+        content_type: "Content-Type"
+      },
+      mocks: true,
+      introspection: true,
+      strict_reference_validation: true,
+      request_validations: true
+    }.with_indifferent_access
+
+    def initialize(opts = {})
+      @opts = DEFAULTS.merge(
+        opts
+      ).with_indifferent_access
+    end
+
+    def headers
+      @opts[:headers]
+    end
+
+    def strict_reference_validation
+      @opts[:strict_reference_validation]
+    end
+
+    def contracts_path
+      @opts[:contracts_path]
+    end
+
+    def mocks
+      @opts[:mocks]
+    end
+
+    def introspection
+      @opts[:introspection]
+    end
+
+    def contracts_path=(contracts_path)
+      @opts[:contracts_path] = contracts_path
+    end
+
+    def mocks=(enabled)
+      @opts[:mocks] = enabled
+    end
+
+    def introspection=(enabled)
+      @opts[:introspection] = enabled
+    end
+
+    def strict_reference_validation=(enabled)
+      @opts[:strict_reference_validation] = enabled
+    end
+
+    def request_validations=(enabled)
+      @opts[:request_validations] = enabled
+    end
+
+    def headers=(headers)
+      @opts[:headers] = @opts[:headers].merge(
+        headers.with_indifferent_access
+      )
+    end
+  end
+end

data/lib/apicraft/constants.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Apicraft
+  # All constants for Apicraft
+  module Constants
+    HTTP_METHODS = %i[
+      get
+      post
+      put
+      patch
+      delete
+      head
+      options
+      trace
+    ].freeze
+
+    MIME_TYPE_CONVERTORS = {
+      "application/json": :to_json,
+      "application/xml": :to_xml,
+      "application/yaml": :to_yaml,
+      "application/x-yaml": :to_yaml,
+      "text/csv": :to_csv,
+      "text/plain": :to_s,
+      "text/html": :to_html,
+      "application/msgpack": :to_msgpack
+    }.with_indifferent_access
+  end
+end

data/lib/apicraft/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Apicraft
+  class Errors
+    class RouteNotFound < StandardError; end
+    class InvalidContractsPath < StandardError; end
+    class InvalidContract < StandardError; end
+    class InvalidOperation < StandardError; end
+    class InvalidResponse < StandardError; end
+  end
+end

data/lib/apicraft/loader.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Apicraft
+  # Recursively loads and processes YAML files from the
+  # application's contract folder during the application boot.
+  # This class is responsible for loading and initializing the
+  # contracts defined in the YAML files.
+  class Loader
+    def self.load!
+      contracts_path = Apicraft.config.contracts_path
+      return if contracts_path.blank?
+
+      raise Errors::InvalidContractsPath unless Dir.exist?(contracts_path)
+
+      Find.find(contracts_path) do |path|
+        next unless File.file?(path) && %w[.yaml .yml .json].include?(File.extname(path))
+
+        load_file!(path)
+
+        route = path.sub(contracts_path.to_s, "")
+        Web::Router.add(route, path)
+      end
+    end
+
+    def self.config
+      Apicraft.config
+    end
+
+    def self.load_file!(file)
+      ext = File.extname(file)
+
+      parsed = if ext == ".json"
+                 JSON.parse(File.read(file))
+               else
+                 YAML.load_file(file)
+               end
+
+      OpenAPIParser.parse(
+        parsed,
+        {
+          strict_reference_validation: config.strict_reference_validation
+        }
+      )
+
+      Openapi::Contract.create!(
+        OpenAPIParser.parse(parsed)
+      )
+    end
+  end
+end

data/lib/apicraft/middlewares/introspector.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Apicraft
+  module Middlewares
+    # Apicraft Middleware to handle API Introspection.
+    class Introspector
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        return @app.call(env) unless config.introspection
+
+        request = ActionDispatch::Request.new(env)
+        return @app.call(env) unless introspect?(request)
+
+        schema = Apicraft::Openapi::Contract.find_by_operation(
+          request.method, request.path_info
+        )&.operation(
+          request.method, request.path_info
+        )&.raw_schema
+        return @app.call(env) if schema.blank?
+
+        [
+          200,
+          { 'Content-Type': "application/json" },
+          [schema.to_json]
+        ]
+      end
+
+      private
+
+      def config
+        @config ||= Apicraft.config
+      end
+
+      def introspect?(request)
+        request.headers[config.headers[:introspect]].present?
+      end
+    end
+  end
+end