esplanade 1.3.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ff2aa7471fbccccd7a52e52ba79faa5c181c3fc9
-  data.tar.gz: 34d21fc0cb3cf09954ce401805076c206508b9d2
+SHA256:
+  metadata.gz: 1709500c684e2cd5fb6c0c86445bd413e46ed575e191f5e1557c85680b3b118b
+  data.tar.gz: b7aa44c92516981b0f0433378b6b526e48656198782cd8c7fed0d2147a902249
 SHA512:
-  metadata.gz: e4cf2e079c8773cdb0b10241ba8166834ab6b6c03b108273e9b7963efa7d812b8a2a2cc7ba249b7c429fffdb80b0dcf36b5b167665b7fef2e00177568f51a32c
-  data.tar.gz: 62b6623aa9df749907c7d6dc5e6413103bab3083368cc616140c63b9bb3cd4cdfa596a60c857fef5ab57e40b9e8d7a168a606b421ed8db7c079e640387bc8c7a
+  metadata.gz: f4372ec2e97839ea3dee256282954c5a5b8540eaa592afa37ab976ef0dff7da7d49357318e292d7aa834ba27f1593b659cf589d159f1ca6e17c6bae1d13bc053
+  data.tar.gz: 3a59d0192b6d4bef73e5c239deb16dff6b4fe96eb4b353d67edbf72b645c4084aac0c5d0175e3482c01368023540166939997219b3cbde2a83b7f295dc554d3f

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -1,8 +1,9 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  NewCops: enable
+  TargetRubyVersion: 2.4
 
-Metrics/LineLength:
-  Max: 120
+Layout/LineLength:
+  Enabled: false
 
 Style/Documentation:
   Enabled: false
@@ -13,6 +14,12 @@ Style/FrozenStringLiteralComment:
 Metrics/BlockLength:
   Enabled: false
 
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
 Style/IfUnlessModifier:
   Enabled: false
 

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.7.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/CHANGELOG.md

@@ -1,9 +1,39 @@
 # Change log
 
+### 1.7.1 - 2021-02-10
+
+* setting
+  * improve gemspec dependency for tomograph
+
+### 1.7.0 - 2020-12-22
+
+* improvements
+  * changed middleware arguments
+
+### 1.6.0 - 2020-10-12
+
+* features
+  * in the errors write not only a documented path but also a raw [#11](https://github.com/funbox/esplanade/issues/11)
+  * write in the documentation that the body is empty and nil is skipped [#13](https://github.com/funbox/esplanade/issues/13)
+  * redefine error PrefixNotMatch for response [#17](https://github.com/funbox/esplanade/issues/17)
+  * content-type can contain additional parameters [#21](https://github.com/funbox/esplanade/issues/21)
+  * update esplanade for the new tomograph [#29](https://github.com/funbox/esplanade/issues/29)
+
+### 1.5.0 - 2020-04-07
+
+* improvements
+  * updated dependenses
+  * fixed warnings on ruby 2.7
+
+### 1.4.0 - 2019-08-19
+
+* features
+  * add details for Esplanade::Response::Error
+
 ### 1.3.0 - 2018-03-16
 
 * features
-  * add Esplanade::Request::ContentTypeIsNotJson erro
+  * add Esplanade::Request::ContentTypeIsNotJson error
   * add reduced version message about request body
 
 ### 1.2.1 - 2018-02-20

data/README.md

@@ -1,16 +1,36 @@
 # Esplanade
 
-<a href="https://funbox.ru">
-  <img src="https://funbox.ru/badges/sponsored_by_funbox_compact.svg" alt="Sponsored by FunBox" width=250 />
-</a>
-
 [![Gem Version](https://badge.fury.io/rb/esplanade.svg)](https://badge.fury.io/rb/esplanade)
-[![Build Status](https://travis-ci.org/funbox/esplanade.svg?branch=master)](https://travis-ci.org/funbox/esplanade)
 
-This gem will help you validation and sinhronize your API in strict accordance to the documentation in
+This gem helps you to validate and synchronize your API in strict accordance to the documentation in
 [API Blueprint](https://apiblueprint.org/) format.
-To do this it automatically searches received requestes and responses in the documentation and run validates
-json-schemas.
+To do this it automatically searches received requests and responses in the documentation and run
+JSON-schemas validators.
+
+## Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Middlewares](#middlewares)
+  - [Esplanade::SafeMiddleware](#esplanadesafemiddleware)
+  - [Esplanade::DangerousMiddleware](#esplanadedangerousmiddleware)
+  - [Esplanade::CheckCustomResponseMiddleware](#esplanadecheckcustomresponsemiddleware)
+- [Esplanade::Error](#esplanadeerror)
+  - [Esplanade::Request::Error](#esplanaderequesterror)
+    - [Esplanade::Request::PrefixNotMatch](#esplanaderequestprefixnotmatch)
+    - [Esplanade::Request::NotDocumented](#esplanaderequestnotdocumented)
+    - [Esplanade::Request::ContentTypeIsNotJson](#esplanaderequestcontenttypeisnotjson)
+    - [Esplanade::Request::BodyIsNotJson](#esplanaderequestbodyisnotjson)
+    - [Esplanade::Request::Invalid](#esplanaderequestinvalid)
+  - [Esplanade::Response::Error](#esplanaderesponseerror)
+    - [Esplanade::Response::NotDocumented](#esplanaderesponsenotdocumented)
+    - [Esplanade::Response::BodyIsNotJson](#esplanaderesponsebodyisnotjson)
+    - [Esplanade::Response::Invalid](#esplanaderesponseinvalid)
+- [Middleware args](#middleware-args)
+  - [`apib_path`](#apib_path)
+  - [`drafter_yaml_path`](#drafter_yaml_path)
+  - [`prefix`](#prefix)
+- [License](#license)
 
 ## Installation
 
@@ -20,107 +40,203 @@ Add this line to your application's Gemfile:
 gem 'esplanade'
 ```
 
-And then execute:
+After that execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or install the gem by yourself:
 
-    $ gem install esplanade
+```bash
+$ gem install esplanade
+```
 
 ## Usage
 
-`config/application.rb`
+`config/application.rb`:
 
 ```ruby
-config.middleware.use Esplanade::SafeMiddleware, apib_path: 'doc.apib'
+config.middleware.use Esplanade::SafeMiddleware, drafter_yaml_path: 'doc.yaml'
 ```
 
-## Middleware
+## Middlewares
 
 ### Esplanade::SafeMiddleware
 
-Only debug logger.
+Debug logger.
 
 ### Esplanade::DangerousMiddleware
 
-It throws errors, so you will need to add your own middleware for processing.
+It throws errors, so you should add your own middleware for processing.
 
 ```ruby
-    config.middleware.use YourMiddleware
-    config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
+config.middleware.use YourMiddleware
+config.middleware.use Esplanade::DangerousMiddleware, drafter_yaml_path: 'doc.yaml'
 ```
 
 ### Esplanade::CheckCustomResponseMiddleware
 
-If you want to be sure that you have documented new custom responses.
+Use it if you want to be sure that you have documented new custom responses.
 
 ```ruby
-    config.middleware.use Esplanade::CheckCustomResponseMiddleware, apib_path: 'doc.apib'
-    config.middleware.use YourMiddleware
-    config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
+config.middleware.use Esplanade::CheckCustomResponseMiddleware, drafter_yaml_path: 'doc.yaml'
+config.middleware.use YourMiddleware
+config.middleware.use Esplanade::DangerousMiddleware, drafter_yaml_path: 'doc.yaml'
 ```
 
 ## Esplanade::Error
 
-From him the `Esplanade::Request::Error` and `Esplanade::Response::Error` are inherited.
+Parent class for those described below.
 
 ### Esplanade::Request::Error
 
-From him the `Esplanade::Request::PrefixNotMatch`, `Esplanade::Request::NotDocumented`, `Esplanade::Request::BodyIsNotJson` and `Esplanade::Request::Invalid` are inherited.
+Parent class for those described below. Inherited from `Esplanade::Error`.
 
 #### Esplanade::Request::PrefixNotMatch
 
-Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type"}`.
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type"
+}
+```
 
 #### Esplanade::Request::NotDocumented
 
-Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type"}`.
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type"
+}
+```
 
 #### Esplanade::Request::ContentTypeIsNotJson
 
-Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type"}`.
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type"
+}
+```
 
 #### Esplanade::Request::BodyIsNotJson
 
-Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type", :body=>"{\"state\": 1"}`.
+Throws an error also when the body is empty and equal nil.
+
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type",
+  :body => "body"
+}
+```
 
 #### Esplanade::Request::Invalid
 
-Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type", :body=>"body", :error=>["error"]}`.
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type",
+  :body => "body",
+  :error => ["error"]
+}
+```
 
 ### Esplanade::Response::Error
 
-From him the `Esplanade::Response::NotDocumented`, `Esplanade::Response::BodyIsNotJson` and `Esplanade::Response::Invalid` are inherited.
+Parent class for those described below. Inherited from `Esplanade::Error`.
 
-#### Esplanade::Response::NotDocumented
+#### Esplanade::Response::PrefixNotMatch
 
-Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status"}`.
+Error message format:
 
-#### Esplanade::Response::BodyIsNotJson
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path"
+  },
+  :status => "status"
+}
+```
 
-Only if the documentation for all the responses of one request indicates that `Content-Type: application/json`.
+#### Esplanade::Response::NotDocumented
 
-Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body"}`.
+Error message format:
 
-#### Esplanade::Response::Invalid
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path",
+    :raw_path => "path"
+  },
+  :status => "status"
+}
+```
+
+#### Esplanade::Response::BodyIsNotJson
 
-Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body", :error=>["error"]}`.
+It's thrown when expected response to request isn't JSON (not `Content-Type: application/json`) and there's no non-JSON responses documented for the endpoint.
 
-## Middleware args
+Error message format:
 
-### apib_path
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path",
+    :raw_path => "path"
+  },
+  :status => "status",
+  :body => "body"
+}
+```
 
-Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
+#### Esplanade::Response::Invalid
 
-### drafter_yaml_path
+Error message format:
 
-Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path",
+    :raw_path => "path"
+  },
+  :status => "status",
+  :body => "body",
+  :error => ["error"]
+}
+```
 
-### prefix
+## Middleware args
 
-Prefix of API requests. Example: `'/api'`. The prefix is added to the requests in the documentation.
+Support any [tomograph constructor-params](https://github.com/funbox/tomograph/tree/master#constructor-params)
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)

data/esplanade.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'esplanade/version'
 
@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'json-schema', '~> 2.6', '>= 2.6.2'
   spec.add_runtime_dependency 'multi_json', '~> 1.11', '>= 1.11.1'
-  spec.add_runtime_dependency 'tomograph', '~> 2.0', '>= 2.0.0'
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'byebug', '~> 8.2', '>= 8.2.1'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.52', '>= 0.52.1'
-  spec.add_development_dependency 'simplecov', '~> 0.11', '>= 0.11.2'
+  spec.add_runtime_dependency 'tomograph', '~> 3.1', '>= 3.1.0'
+  spec.add_development_dependency 'byebug', '>= 10.0.0'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'
+  spec.add_development_dependency 'rubocop', '~> 0.81', '>= 0.81.0'
+  spec.add_development_dependency 'simplecov', '~> 0.18', '>= 0.18'
+  spec.required_ruby_version = '>= 2.4.0'
 end

data/lib/esplanade/configuration.rb

@@ -1,11 +1,9 @@
 module Esplanade
   class Configuration
-    attr_accessor :apib_path,
-                  :drafter_yaml_path,
-                  :prefix
+    attr_accessor :params
 
     def initialize
-      @prefix = ''
+      @params = {}
     end
   end
 end

data/lib/esplanade/middleware.rb

@@ -4,18 +4,9 @@ require 'esplanade/response'
 
 module Esplanade
   class Middleware
-    def initialize(
-      app,
-      prefix: Esplanade.configuration.prefix,
-      apib_path: Esplanade.configuration.apib_path,
-      drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/middlewares/check_custom_response_middleware.rb

@@ -4,18 +4,9 @@ require 'esplanade/response'
 
 module Esplanade
   class CheckCustomResponseMiddleware
-    def initialize(
-      app,
-        prefix: Esplanade.configuration.prefix,
-        apib_path: Esplanade.configuration.apib_path,
-        drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/middlewares/dangerous_middleware.rb

@@ -4,18 +4,9 @@ require 'esplanade/response'
 
 module Esplanade
   class DangerousMiddleware
-    def initialize(
-      app,
-      prefix: Esplanade.configuration.prefix,
-      apib_path: Esplanade.configuration.apib_path,
-      drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/middlewares/safe_middleware.rb

@@ -4,18 +4,9 @@ require 'esplanade/response'
 
 module Esplanade
   class SafeMiddleware
-    def initialize(
-      app,
-      prefix: Esplanade.configuration.prefix,
-      apib_path: Esplanade.configuration.apib_path,
-      drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/request/doc.rb

@@ -7,18 +7,20 @@ module Esplanade
       end
 
       def tomogram
-        raise PrefixNotMatch, message unless @main_documentation.prefix_match?(@raw.path)
+        raise PrefixNotMatch.new(**message) unless @main_documentation.prefix_match?(@raw.path)
+
         @tomogram = @main_documentation.find_request_with_content_type(
           method: @raw.method,
           path: @raw.path,
           content_type: @raw.content_type
         )
-        raise NotDocumented, message if @tomogram.nil?
+        raise NotDocumented.new(**message) if @tomogram.nil?
+
         @tomogram
       end
 
-      def json_schema
-        @json_schema ||= tomogram.request
+      def json_schemas
+        @json_schemas ||= tomogram.requests
       end
 
       def method
@@ -45,6 +47,7 @@ module Esplanade
         {
           method: @raw.method,
           path: @raw.path,
+          raw_path: @raw.raw_path,
           content_type: @raw.content_type
         }
       end

data/lib/esplanade/request/error.rb

@@ -5,9 +5,10 @@ module Esplanade
     class PrefixNotMatch < Error; end
 
     class NotDocumented < Error
-      def initialize(method:, path:, content_type:)
+      def initialize(method:, path:, raw_path:, content_type:)
         @method = method
         @path = path
+        @raw_path = raw_path
         @content_type = content_type
 
         super(to_hash)
@@ -17,14 +18,16 @@ module Esplanade
         {
           method: @method,
           path: @path,
+          raw_path: @raw_path,
           content_type: @content_type
         }
       end
     end
 
     class ContentTypeIsNotJson < Error
-      def initialize(method:, path:, content_type:)
+      def initialize(method:, path:, raw_path:, content_type:)
         @method = method
+        @raw_path = raw_path
         @path = path
         @content_type = content_type
 
@@ -35,15 +38,17 @@ module Esplanade
         {
           method: @method,
           path: @path,
+          raw_path: @raw_path,
           content_type: @content_type
         }
       end
     end
 
     class BodyIsNotJson < Error
-      def initialize(method:, path:, content_type:, body:)
+      def initialize(method:, path:, raw_path:, content_type:, body:)
         @method = method
         @path = path
+        @raw_path = raw_path
         @content_type = content_type
         @body = body
 
@@ -54,6 +59,7 @@ module Esplanade
         {
           method: @method,
           path: @path,
+          raw_path: @raw_path,
           content_type: @content_type,
           body: @body
         }
@@ -61,9 +67,10 @@ module Esplanade
     end
 
     class Invalid < Error
-      def initialize(method:, path:, content_type:, body:, error:)
+      def initialize(method:, path:, raw_path:, content_type:, body:, error:)
         @method = method
         @path = path
+        @raw_path = raw_path
         @content_type = content_type
         @body = body
         @error = error
@@ -75,6 +82,7 @@ module Esplanade
         {
           method: @method,
           path: @path,
+          raw_path: @raw_path,
           content_type: @content_type,
           body: @body,
           error: @error

data/lib/esplanade/request/raw.rb

@@ -15,12 +15,16 @@ module Esplanade
         @path ||= @env['PATH_INFO']
       end
 
+      def raw_path
+        @raw_path ||= "#{@env['PATH_INFO']}/#{@env['QUERY_STRING']}"
+      end
+
       def body
         @body ||= Body.new(self, @env)
       end
 
       def content_type
-        @content_type ||= @env['CONTENT_TYPE']
+        @content_type ||= @env['CONTENT_TYPE'].to_s.split(';').first
       end
     end
   end

data/lib/esplanade/request/raw/body.rb

@@ -11,27 +11,24 @@ module Esplanade
 
         def to_string
           return @string if @string
+
           @string = @env['rack.input'].read
           @env['rack.input'].rewind
           @string
         end
 
         def to_hash
-          @hash ||= if to_string.nil?
-                      {}
-                    else
-                      MultiJson.load(to_string)
-                    end
+          @hash ||= MultiJson.load(to_string)
         rescue MultiJson::ParseError
-          raise BodyIsNotJson, message
+          raise BodyIsNotJson.new(**message)
         end
 
         def reduced_version
-          @reduced_version ||= if to_string.size >= 1000
-            "#{to_string[0..499]}...#{to_string[500..-1]}"
-          else
-            to_string
-          end
+          @reduced_version ||= if to_string && to_string.size >= 1000
+                                 "#{to_string[0..499]}...#{to_string[500..-1]}"
+                               else
+                                 to_string
+                               end
         end
 
         private
@@ -40,6 +37,7 @@ module Esplanade
           {
             method: @raw_request.method,
             path: @raw_request.path,
+            raw_path: @raw_request.raw_path,
             content_type: @raw_request.content_type,
             body: reduced_version
           }

data/lib/esplanade/request/validation.rb

@@ -10,18 +10,40 @@ module Esplanade
       end
 
       def valid!
-        raise ContentTypeIsNotJson, mini_message unless @doc.content_type  == 'application/json'
-        @error ||= JSON::Validator.fully_validate(@doc.json_schema, @raw.body.to_hash)
+        raise ContentTypeIsNotJson.new(**mini_message) unless @doc.content_type == 'application/json'
 
-        raise Invalid, message unless @error.empty?
+        @error ||= if @doc.json_schemas.size == 1
+                     one_json_schema
+                   else
+                     more_than_one_json_schema
+                   end
+
+        raise Invalid.new(**message) unless @error.empty?
       end
 
       private
 
+      def one_json_schema
+        JSON::Validator.fully_validate(@doc.json_schemas.first, @raw.body.to_hash)
+      end
+
+      def more_than_one_json_schema
+        main_res = @doc.json_schemas.each do |json_schema|
+          res = JSON::Validator.fully_validate(json_schema, @raw.body.to_hash)
+          break res if res == []
+        end
+        if main_res != []
+          ['invalid']
+        else
+          []
+        end
+      end
+
       def mini_message
         {
           method: @doc.method,
-          path:   @doc.path,
+          path: @doc.path,
+          raw_path: @raw.raw_path,
           content_type: @doc.content_type
         }
       end
@@ -29,10 +51,11 @@ module Esplanade
       def message
         {
           method: @raw.method,
-          path:   @raw.path,
+          path: @raw.path,
+          raw_path: @raw.raw_path,
           content_type: @raw.content_type,
-          body:   @raw.body.to_hash,
-          error:  @error
+          body: @raw.body.to_hash,
+          error: @error
         }
       end
     end

data/lib/esplanade/response.rb

@@ -1,14 +1,10 @@
 require 'esplanade/response/doc'
 require 'esplanade/response/raw'
 require 'esplanade/response/validation'
+require 'esplanade/response/error'
 
 module Esplanade
   class Response
-    class Error < Esplanade::Error; end
-    class NotDocumented < Error; end
-    class BodyIsNotJson < Error; end
-    class Invalid       < Error; end
-
     attr_reader :request
 
     def initialize(request, status, raw_body)

data/lib/esplanade/response/doc.rb

@@ -8,8 +8,11 @@ module Esplanade
 
       def tomogram
         @tomogram ||= @request.doc.responses.find_all { |response| response['status'] == @raw.status }
-        raise NotDocumented, message if @tomogram == []
+        raise NotDocumented.new(**message) if @tomogram == []
+
         @tomogram
+      rescue Esplanade::Request::PrefixNotMatch
+        raise PrefixNotMatch.new(**message)
       end
 
       def json_schemas
@@ -26,6 +29,7 @@ module Esplanade
         {
           request: {
             method: @request.raw.method,
+            raw_path: @request.raw.raw_path,
             path: @request.raw.path
           },
           status: @raw.status

data/lib/esplanade/response/error.rb

@@ -0,0 +1,82 @@
+module Esplanade
+  class Response
+    class Error < Esplanade::Error; end
+
+    class PrefixNotMatch < Error; end
+
+    class NotDocumented < Error
+      def initialize(request:, status:)
+        @method = request[:method]
+        @path = request[:path]
+        @raw_path = request[:raw_path]
+        @status = status
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          request:
+            {
+              method: @method,
+              path: @path,
+              raw_path: @raw_path
+            },
+          status: @status
+        }
+      end
+    end
+
+    class BodyIsNotJson < Error
+      def initialize(request:, status:, body:)
+        @method = request[:method]
+        @path = request[:path]
+        @raw_path = request[:raw_path]
+        @status = status
+        @body = body
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          request:
+            {
+              method: @method,
+              path: @path,
+              raw_path: @raw_path
+            },
+          status: @status,
+          body: @body
+        }
+      end
+    end
+
+    class Invalid < Error
+      def initialize(request:, status:, body:, error:)
+        @method = request[:method]
+        @path = request[:path]
+        @raw_path = request[:raw_path]
+        @status = status
+        @body = body
+        @error = error
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          request:
+            {
+              method: @method,
+              path: @path,
+              raw_path: @raw_path
+            },
+          status: @status,
+          body: @body,
+          error: @error
+        }
+      end
+    end
+  end
+end

data/lib/esplanade/response/raw/body.rb

@@ -11,14 +11,14 @@ module Esplanade
         end
 
         def to_string
-          @string ||= @raw_body.body rescue nil
-          @string ||= @raw_body.first rescue nil
+          @to_string ||= @raw_body.body rescue nil
+          @to_string ||= @raw_body.first rescue nil
         end
 
         def to_hash
           @hash ||= MultiJson.load(to_string)
         rescue MultiJson::ParseError
-          raise BodyIsNotJson, message
+          raise BodyIsNotJson.new(**message)
         end
 
         private
@@ -27,7 +27,8 @@ module Esplanade
           {
             request: {
               method: @request.raw.method,
-              path: @request.raw.path
+              path: @request.raw.path,
+              raw_path: @request.raw.raw_path
             },
             status: @raw_response.status,
             body: @raw_response.body.to_string

data/lib/esplanade/response/validation.rb

@@ -15,7 +15,7 @@ module Esplanade
                    else
                      more_than_one_json_schema
                    end
-        raise Invalid, message if @error != []
+        raise Invalid.new(**message) if @error != []
       end
 
       private
@@ -40,7 +40,8 @@ module Esplanade
         {
           request: {
             method: @request.raw.method,
-            path: @request.raw.path
+            path: @request.raw.path,
+            raw_path: @request.raw.raw_path
           },
           status: @raw.status,
           body: @raw.body.to_string,

data/lib/esplanade/version.rb

@@ -1,3 +1,3 @@
 module Esplanade
-  VERSION = '1.3.0'.freeze
+  VERSION = '1.7.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.7.1
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2021-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -56,128 +56,108 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.2.1
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '8.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.2.1
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.81'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.81.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0.81'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.81.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.18'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.11.2
+        version: '0.18'
 description: 
 email:
 - d.efimov@fun-box.ru
@@ -185,10 +165,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -213,6 +194,7 @@ files:
 - lib/esplanade/request/validation.rb
 - lib/esplanade/response.rb
 - lib/esplanade/response/doc.rb
+- lib/esplanade/response/error.rb
 - lib/esplanade/response/raw.rb
 - lib/esplanade/response/raw/body.rb
 - lib/esplanade/response/validation.rb
@@ -229,15 +211,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Validate requests and responses against API Blueprint specifications

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-- 2.2
-before_install: gem install bundler -v 1.12