open_api_rack 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5eac5e38b678118f9f0fc9081f43503f1c84819ce995e83e94256a0b5cdcb0e9
+  data.tar.gz: 1cd0e930a8972889861c17b1bd1a0f6623d63541c3294d5204b3960b40e1af05
+SHA512:
+  metadata.gz: c7add14b4339d57f4a6c96c2d9063b5fd7c5ece597bb27a98b5c57e4bb9739eab5d5b212b98a8e5206354284b9ec249b14c848d9347340aa8cfab54460e1bbb4
+  data.tar.gz: 793a9eac3fd373428939c633053ef3a7de1384629bb039434e81cae5d2852a57b5cee01bcc0c8ec980aaf816ec7c47465307b9c4d63d65837973d1fe18d7d621

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-10-23
+
+- 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 TODO: Write your email address. 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/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in open_api_rack.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    open_api_rack (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  open_api_rack!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.33

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Olga Leonteva
+
+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.

data/README.md

@@ -0,0 +1,95 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+gem 'open_api_rack'
+
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+1) It's pretty simple. First register middleware for a test environment  
+
+``` config/enviroments/test.rb
+
+Rails.application.configure
+  config.middleware.insert_before 0, OpenApiRack::Middleware
+end
+
+```
+
+Please, keep it only for test env!
+
+2) Then, you need to configure the gem. Create an initializer file
+
+```config/initializers/open_api_rack.rb
+
+OpenApiRack.configure do |config|
+  # list of headers you want to follow
+  config.headers_list = %w(access_token client uid access-token)
+
+  # by default gem is enabled
+  config.disable_by_default = true
+end
+
+```
+
+`header_list` setting defines the headers you want to follow
+
+3) Final step, start writing your request specs
+
+``` spec/requests/users_spec.rb
+
+RSpec.describe "Api::V1::Users", type: :request do
+  describe "GET /" do
+    before(:each) do
+      get "/api/v1/users", params: { per_page: 5, page: 1, sort: 'email', order: 'desc' }
+    end
+
+    it "returns http success" do
+      expect(response).to have_http_status(:success)
+    end
+  end
+end
+```
+
+You may also exclude specific request from documentation by adding `{ "OA_SKIP_EXAMPLE" => "true" }` to your request headers  
+
+``` spec/requests/users_spec.rb
+get "/api/v1/users", params: { per_page: 5, page: 1, sort: 'email', order: 'desc' }, headers: { "OA_SKIP_EXAMPLE" => "true" }
+```
+
+If you decide to disable doc generation, you can turn it on for specific request
+``` spec/requests/users_spec.rb
+get "/api/v1/users", params: { per_page: 5, page: 1, sort: 'email', order: 'desc' }, headers: { "OA_INCLUDE_EXAMPLE" => "true" }
+```
+
+Generated docs stored in /public/open-api.yaml
+
+## Contributing
+
+Gem in active development
+
+Known issues:
+
+- not working for DELETE HTTP method
+
+- not working for :no_content response
+
+- can not define fields types
+
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chhlga/open_api_rack. 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/[USERNAME]/open_api_rack/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 OpenApiRack project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/open_api_rack/blob/main/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "open_api_rack"
+
+# 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/open_api_rack/configuration.rb

@@ -0,0 +1,10 @@
+module OpenApiRack
+  class Configuration
+    attr_accessor :headers_list, :disable_by_default
+
+    def initialize(headers_list = nil, disable_by_default = false)
+      @headers_list = headers_list
+      @disable_by_default = disable_by_default
+    end
+  end
+end

data/lib/open_api_rack/middleware.rb

@@ -0,0 +1,155 @@
+module OpenApiRack
+  class Middleware
+    def initialize(app)
+      @app = app
+
+      @headers_list = OpenApiRack.configuration.headers_list
+    end
+
+    def call(env)
+      app_call_result = @app.call(env)
+
+      return app_call_result if skip?(env)
+
+      if File.exist?("public/open-api.yaml")
+        open_api_hash = YAML.load_file("public/open-api.yaml")
+      else
+        open_api_hash = {
+          "openapi" => "3.0.0",
+          "info" => {
+            "title" => "client_area",
+            "version" => "1.0.0"
+          },
+          "servers" => [
+            {"url" => "http://localhost:3000"}
+          ],
+          "paths" => {}
+        }
+      end
+
+      open_api_hash["paths"].merge!(
+        env["PATH_INFO"] => {
+          env["REQUEST_METHOD"].downcase => {
+            "parameters" => Rack::Request.new(env).params.map do |k, v|
+              {
+                "name" => k,
+                "in" => "query",
+                "schema" => {
+                  "type" => "string"
+                },
+                "required" => false,
+                "example" => v
+              }
+            end.concat(
+              @headers_list.map do |k|
+                {
+                  "name" => k,
+                  "in" => "header",
+                  "schema" => {
+                    "type" => "string"
+                  },
+                  "required" => false,
+                  "example" => env["HTTP_#{k.to_s.upcase}"]
+                }
+              end
+            ),
+            "responses" => {
+              app_call_result[0] => {
+                "description" => "OK",
+                "content" => {
+                  "application/json" => {
+                    "schema" => {
+                      "type" => "object",
+                      "properties" => parse_json(response_body(app_call_result))
+                    }
+                  }
+                },
+                "headers" => response_headers(app_call_result)
+              }
+            }
+          }.merge(parsed_request_body(env))
+        }
+      )
+
+      File.open('public/open-api.yaml', 'w') do |f|
+        f.write(open_api_hash.to_yaml)
+      end
+
+      app_call_result
+    end
+
+    private
+
+    def request_body(env)
+      Rack::Request.new(env).params
+    end
+
+    def parsed_request_body(env)
+      return {} unless env["REQUEST_METHOD"] == "POST" ||
+        env["REQUEST_METHOD"] == "PUT" ||
+          env["REQUEST_METHOD"] == "PATCH"
+      {
+        "requestBody" => {
+          "content" => {
+            "application/json" => {
+              "schema" => {
+                "type" => "object",
+                "properties" => parse_json(request_body(env))
+              }
+            }
+          }
+        }
+      }
+    end
+
+    def response_body(app_call_result)
+      JSON.parse(app_call_result[2].first)
+    end
+
+    def parse_json(json, result = {})
+      return result unless json.respond_to?(:each)
+      json.each do |k, v|
+        result[k], node = parse_node(v)
+        if result[k]["type"] == "object"
+          parse_json(node, result[k]["properties"])
+        elsif result[k]["type"] == "array"
+          parse_json(node, result[k]["items"]["properties"])
+        end
+      end
+      result
+    end
+
+    def parse_node(node)
+      if node.is_a?(Array)
+        return {"type" => "array", "items" => { "properties" => {} } }, node.first
+      elsif node.is_a?(Hash)
+        return {"type" => "object", "properties" => {} }, node
+      else
+        return {"type" => "string" }, node
+      end
+    end
+
+    def response_headers(app_call_result)
+      result = {}
+      app_call_result[1].keys.select { |k| @headers_list.include?(k) }.each do |k|
+        result[k] = {
+          "schema" => {
+            "type" => "string"
+          },
+          "description" => "Header #{k}"
+        }
+      end
+      result
+    end
+
+    def skip?(env)
+      disable_by_default = OpenApiRack.configuration.disable_by_default
+      skip_example = env["OA_SKIP_EXAMPLE"] == "true"
+      include_example = env["OA_INCLUDE_EXAMPLE"] == "true"
+
+      return false if include_example
+      return true if disable_by_default
+      return true if skip_example
+    end
+  end
+end

data/lib/open_api_rack/version.rb

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

data/lib/open_api_rack.rb

@@ -0,0 +1,15 @@
+require 'open_api_rack/configuration'
+
+module OpenApiRack
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @@configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/open_api_rack.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/open_api_rack/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "open_api_rack"
+  spec.version = OpenApiRack::VERSION
+  spec.authors = ["Olga Leonteva"]
+  spec.email = ["youzik@me.com"]
+
+  spec.summary = "OpenAPI 3.0.0 documentation generator"
+  spec.description = "Generate your own shiny OpenAPI 3.0.0 documentation from Rspec request specs"
+  spec.homepage = "https://github.com/chhlga/open_api_rack"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/chhlga/open_api_rack"
+  spec.metadata["changelog_uri"] = "https://github.com/chhlga/open_api_rack/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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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 "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/open_api_rack.rbs

@@ -0,0 +1,4 @@
+module OpenApiRack
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: open_api_rack
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Olga Leonteva
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-23 00:00:00.000000000 Z
+dependencies: []
+description: Generate your own shiny OpenAPI 3.0.0 documentation from Rspec request
+  specs
+email:
+- youzik@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/open_api_rack.rb
+- lib/open_api_rack/configuration.rb
+- lib/open_api_rack/middleware.rb
+- lib/open_api_rack/version.rb
+- open_api_rack.gemspec
+- sig/open_api_rack.rbs
+homepage: https://github.com/chhlga/open_api_rack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chhlga/open_api_rack
+  source_code_uri: https://github.com/chhlga/open_api_rack
+  changelog_uri: https://github.com/chhlga/open_api_rack/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: OpenAPI 3.0.0 documentation generator
+test_files: []