openapi_rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b9f9ec3e1e0cb9018ac93737caeac7449033514d8394f2059e3f7f26b9e75d0
+  data.tar.gz: acfb5e12dec63680f74203c8e8d3356b4421952f969237bd3ba5b32c7f74c8d4
+SHA512:
+  metadata.gz: 4cba7fc2504377bcb3a975d62c6d04bb8f5bcd8409fc9571a90fc65748427af5feac6c927c3992f57be463e431855b2d4f62628783fd0c13b71d572d58e2c7f1
+  data.tar.gz: a86a7efecf68cf4330d8efa5bcfa9b86eb6229488f85f6d33eb35d9a69e69dde8c87ed710a5c48a7437134e816084bf01920625cf13a9e4e475c178a537501db

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 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,47 @@
+[gem]: https://rubygems.org/gems/openapi_rspec
+[travis]: https://travis-ci.org/llcmedsolutions/openapi_rspec
+[codeclimate]: https://codeclimate.com/github/llcmedsolutions/openapi_rspec
+
+# openapi_rspec
+[![Gem Version](https://badge.fury.io/rb/openapi_rspec.svg)][gem]
+[![Build Status](https://travis-ci.org/llcmedsolutions/openapi_rspec.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/llcmedsolutions/openapi_rspec/badges/gpa.svg)][codeclimate]
+[![Test Coverage](https://codeclimate.com/github/llcmedsolutions/openapi_rspec/badges/coverage.svg)][codeclimate]
+
+Test your API against OpenApi v3 documentation
+
+Inspired by [Apivore](https://github.com/westfieldlabs/apivore)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapi_rspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openapi_rspec
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 tags, 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/llcmedsolutions/openapi_rspec.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/openapi_rspec/documentation_validator.rb

@@ -0,0 +1,16 @@
+module OpenapiRspec
+  class DocumentationValidator
+    def matches?(doc)
+      @result = doc.validate_documentation
+      @result.valid?
+    end
+
+    def description
+      "be a valid documentation"
+    end
+
+    def failure_message
+      @result.errors.join("\n")
+    end
+  end
+end

data/lib/openapi_rspec/matchers.rb

@@ -0,0 +1,14 @@
+require "openapi_rspec/documentation_validator"
+require "openapi_rspec/request_validator"
+
+module OpenapiRspec
+  module Matchers
+    def validate_documentation
+      DocumentationValidator.new
+    end
+
+    def validate_request(**attrs)
+      RequestValidator.new(**attrs)
+    end
+  end
+end

data/lib/openapi_rspec/request_validator.rb

@@ -0,0 +1,68 @@
+require "rack/test"
+require "uri"
+
+module OpenapiRspec
+  class RequestValidator
+    include Rack::Test::Methods
+
+    def app
+      OpenapiRspec.app
+    end
+
+    def initialize(path:, method:, code:, params: {}, query: {}, headers: {})
+      @path = path
+      @method = method
+      @code = code
+      @query = query
+      @headers = headers
+      @params = params
+    end
+
+    attr_reader :method, :path, :code, :query, :headers, :params
+
+    def matches?(doc)
+      @result = doc.validate_request(path: path, method: method, code: code)
+      return false unless @result.valid?
+
+      headers.each do |key, value|
+        header key, value
+      end
+      request(request_uri(doc), method: method, **request_params)
+      response = last_response
+      @result.validate_response(body: response.body, code: response.status)
+      @result.valid?
+    end
+
+    def request_uri(doc)
+      path.scan(/\{([^\}]*)\}/).each do |param|
+        key = param.first.to_sym
+        if params && params[key]
+          @path = path.gsub "{#{key}}", params.delete(key).to_s
+        else
+          raise URI::InvalidURIError, "No substitution data found for {#{key}}"\
+            " to test the path #{path}."
+        end
+      end
+      "#{doc.api_base_path}#{path}?#{URI.encode_www_form(query)}"
+    end
+
+    def request_params
+      {
+        headers: headers,
+        params: params,
+      }
+    end
+
+    def description
+      "return valid response with code #{code} on `#{method.to_s.upcase} #{path}`"
+    end
+
+    def failure_message
+      if last_response
+        (%W(Response: #{last_response.body}) + @result.errors).join("\n")
+      else
+        @result.errors.join("\n")
+      end
+    end
+  end
+end

data/lib/openapi_rspec/version.rb

@@ -0,0 +1,3 @@
+module OpenapiRspec
+  VERSION = "0.1.0"
+end

data/lib/openapi_rspec.rb

@@ -0,0 +1,22 @@
+require "dry-configurable"
+require "openapi_validator"
+require "openapi_builder"
+require "rspec"
+
+require "openapi_rspec/matchers"
+require "openapi_rspec/version"
+
+module OpenapiRspec
+  extend Dry::Configurable
+
+  setting :app, reader: true
+
+  def self.api(doc, build: false, **params)
+    doc = OpenapiBuilder.call(doc).data if build
+    OpenapiValidator.call(doc, **params)
+  end
+
+  RSpec.configure do |config|
+    config.include Matchers
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: openapi_rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Svyatoslav Kryukov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: openapi_builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: openapi_validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- s.g.kryukov@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/openapi_rspec.rb
+- lib/openapi_rspec/documentation_validator.rb
+- lib/openapi_rspec/matchers.rb
+- lib/openapi_rspec/request_validator.rb
+- lib/openapi_rspec/version.rb
+homepage: https://github.com/llcmedsolutions/openapi_rspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Test your API against OpenApi v3 documentation
+test_files: []