skooma 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 966ef8f92df0a6f38895c4aca4185b297256042173a3b42d32da01d5b826c24e
+  data.tar.gz: c1a4661e7228815c3d1a031ffb646cefd067031e1b1138346f845af469a89135
+SHA512:
+  metadata.gz: 047e598c99b797d98b7758a015ced5323c0dfe2889f64cca8e33b7a139713fa7515683da2e054c1597a1a1b79e62b9f77ab10e72d0b7276908e15b862cb54367
+  data.tar.gz: 1b0dbfa91b60430bd1397d4145cc4d339c2144bfdda88d9c9085800a51a9fa0077087e09c3eb998136cf35c95b49d9449153113976fe6c72fbf6fa5258334841

data/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog],
+and this project adheres to [Semantic Versioning].
+
+## [Unreleased]
+
+## [0.1.0] - 2023-09-27
+
+### Added
+
+- Initial implementation. ([@skryukov])
+
+[@skryukov]: https://github.com/skryukov
+
+[Unreleased]: https://github.com/skryukov/skooma/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/skryukov/skooma/commits/v0.1.0
+
+[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
+[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Svyatoslav Kryukov
+
+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,125 @@
+# Skooma – Sugar for your APIs
+
+[![Gem Version](https://badge.fury.io/rb/skooma.svg)](https://rubygems.org/gems/skooma)
+[![Ruby](https://github.com/skryukov/skooma/actions/workflows/main.yml/badge.svg)](https://github.com/skryukov/skooma/actions/workflows/main.yml)
+
+Skooma is a Ruby library for validating API implementations against OpenAPI documents.
+
+Features:
+- Supports OpenAPI 3.1.0
+- Supports OpenAPI document validation
+- Supports request/response validations against OpenAPI document
+
+<a href="https://evilmartians.com/?utm_source=skooma&utm_campaign=project_page">
+<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54">
+</a>
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add skooma
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install skooma
+
+## Usage
+
+### Configuration
+
+```ruby
+# spec/rails_helper.rb
+
+RSpec.configure do |config|
+  # ...
+  Skooma.create_registry
+  path_to_openapi = Rails.root.join("docs", "openapi.yml")
+  config.include Skooma::RSpec[path_to_openapi], type: :request
+end
+```
+
+### Validate OpenAPI document
+
+```ruby
+# spec/openapi_spec.rb
+
+require "rails_helper"
+
+describe "OpenAPI document", type: :request do
+  subject(:schema) { skooma_openapi_schema }
+
+  it { is_expected.to be_valid_document }
+end
+```
+
+### Validate request
+
+```ruby
+# spec/requests/feed_spec.rb
+
+require "rails_helper"
+
+describe "/animals/:animal_id/feed" do  
+  let(:animal) { create(:animal, :unicorn) }
+  
+  describe "POST" do
+    subject { post "/animals/#{animal.id}/feed", body:, as: :json }
+    
+    let(:body) { {food: "apple", quantity: 3} }
+
+    it { is_expected.to conform_schema(200) }
+
+    context "with wrong food type" do
+      let(:body) { {food: "wood", quantity: 1} }
+    
+      it { is_expected.to conform_schema(422) }
+    end
+  end
+end
+
+# Validation Result:
+#
+#  {"valid"=>false,
+#   "instanceLocation"=>"",
+#   "keywordLocation"=>"",
+#   "absoluteKeywordLocation"=>"urn:uuid:1b4b39eb-9b93-4cc1-b6ac-32a25d9bff50#",
+#   "errors"=>
+#     [{"instanceLocation"=>"",
+#       "keywordLocation"=>
+#         "/paths/~1animals~1{animalId}~1feed/post/responses/200"/
+#           "/content/application~1json/schema/required",
+#       "error"=>
+#         "The object is missing required properties"/
+#           " [\"animalId\", \"food\", \"amount\"]"}]}
+```
+
+## Alternatives
+
+- [openapi_first](https://github.com/ahx/openapi_first)
+- [committee](https://github.com/interagent/committee)
+
+## Feature plans
+
+- Full support for external `$ref`s
+- Full OpenAPI 3.1.0 support:
+  - `discriminator` keyword
+  - respect `style` and `explode` keywords
+  - xml
+- Callbacks and webhooks validations
+- Example validations
+- Ability to plug in custom X-*** keyword classes
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 and pull requests are welcome on GitHub at https://github.com/skryukov/skooma.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/data/oas-3.1/dialect/base.json

@@ -0,0 +1,25 @@
+{
+    "$id": "https://spec.openapis.org/oas/3.1/dialect/base",
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+
+    "title": "OpenAPI 3.1 Schema Object Dialect",
+    "description": "A JSON Schema dialect describing schemas found in OpenAPI documents",
+
+    "$vocabulary": {
+        "https://json-schema.org/draft/2020-12/vocab/core": true,
+        "https://json-schema.org/draft/2020-12/vocab/applicator": true,
+        "https://json-schema.org/draft/2020-12/vocab/unevaluated": true,
+        "https://json-schema.org/draft/2020-12/vocab/validation": true,
+        "https://json-schema.org/draft/2020-12/vocab/meta-data": true,
+        "https://json-schema.org/draft/2020-12/vocab/format-annotation": true,
+        "https://json-schema.org/draft/2020-12/vocab/content": true,
+        "https://spec.openapis.org/oas/3.1/vocab/base": false
+    },
+
+    "$dynamicAnchor": "meta",
+
+    "allOf": [
+        { "$ref": "https://json-schema.org/draft/2020-12/schema" },
+        { "$ref": "https://spec.openapis.org/oas/3.1/meta/base" }
+    ]
+}

data/data/oas-3.1/meta/base.json

@@ -0,0 +1,96 @@
+{
+    "$id": "https://spec.openapis.org/oas/3.1/meta/base",
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+
+    "title": "OAS Base vocabulary",
+    "description": "A JSON Schema Vocabulary used in the OpenAPI Schema Dialect",
+
+    "$vocabulary": {
+        "https://spec.openapis.org/oas/3.1/vocab/base": true
+    },
+
+    "$dynamicAnchor": "meta",
+
+    "type": ["object", "boolean"],
+    "properties": {
+        "example": true,
+        "discriminator": { "$ref": "#/$defs/discriminator" },
+        "externalDocs": { "$ref": "#/$defs/external-docs" },
+        "xml": { "$ref": "#/$defs/xml" }
+    },
+    "dependentSchemas": {
+      "discriminator": {
+        "anyOf": [
+          { "required": [ "oneOf" ] },
+          { "required": [ "anyOf" ] },
+          { "required": [ "allOf" ] }
+        ]
+      }
+    },
+
+    "$defs": {
+        "extensible": {
+            "patternProperties": {
+                "^x-": true
+            }
+        },
+
+        "discriminator": {
+            "$ref": "#/$defs/extensible",
+            "type": "object",
+            "properties": {
+                "propertyName": {
+                    "type": "string"
+                },
+                "mapping": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                }
+            },
+            "required": ["propertyName"],
+            "unevaluatedProperties": false
+        },
+
+        "external-docs": {
+            "$ref": "#/$defs/extensible",
+            "type": "object",
+            "properties": {
+                "url": {
+                    "type": "string",
+                    "format": "uri-reference"
+                },
+                "description": {
+                    "type": "string"
+                }
+            },
+            "required": ["url"],
+            "unevaluatedProperties": false
+        },
+
+        "xml": {
+            "$ref": "#/$defs/extensible",
+            "type": "object",
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "namespace": {
+                    "type": "string",
+                    "format": "uri"
+                },
+                "prefix": {
+                    "type": "string"
+                },
+                "attribute": {
+                    "type": "boolean"
+                },
+                "wrapped": {
+                    "type": "boolean"
+                }
+            },
+            "unevaluatedProperties": false
+        }
+    }
+}