esplanade 1.2.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d56ac3bbfdcd35af5878ab7c38ba6192ef4e5957
-  data.tar.gz: a17fd30d62e0039c6d70389e8f197e1b46a8bf17
+SHA256:
+  metadata.gz: f5a2030af1a5071793987d6ee1bab57942a83efd21ae68b6323de133c0667e4b
+  data.tar.gz: 2474417384e61677938e602e48657bb8acffaeed13cdbf1593c64c4d97620f42
 SHA512:
-  metadata.gz: fcbf87e4765ff6ac1b388e490c03dd9c72f57e062fdd9598e247ad4425e51f1723234142af8e0b89ff8611fe7e45834abbbb7c6c49e7237f23729cbe2b07209e
-  data.tar.gz: 40d6f05bbc3ac4125d0e26f5ff21d0df8fd96fea36eb86efdb99547d3a16d1decb28feb8e93e86ee0cb0382bd21a1453d94cf77b0131e1974fae5ac1487be652
+  metadata.gz: 490ca6b622daf918b964966a523d751744923048a5ea78a7eaea7bb4fee5bd6d4623a8951d5255ba0fae49ac78eeba5bc00b6bff876f05c38d9cec88e706a170
+  data.tar.gz: b8bfb543326e2d7789d4a1842c96ae163e1a84ba6b3118ee95b57fe53451a308429dc103f7678b613f081d61e29df9668842e2ef8c9062dcdc139bdfa80a0c65

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.6
+    - 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,5 +1,36 @@
 # Change log
 
+### 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 error
+  * add reduced version message about request body
+
+### 1.2.1 - 2018-02-20
+
+* features
+  * more information about the invalid request
+
 ### 1.2.0 - 2018-02-15
 
 * features
@@ -11,12 +42,12 @@
 
 ### 1.1.2 - 2018-02-14
 
-* bug fixes
+* fixes
   * add rewind rack.input
 
 ### 1.1.1 - 2018-02-13
 
-* bug fixes
+* fixes
   * read body if Content-Type application/json
 
 ### 1.1.0 - 2017-10-18
@@ -26,5 +57,5 @@
 
 ### 1.0.1 - 2017-10-09
 
-* bug fixes
+* fixes
   * allow request body to be nil

data/README.md

@@ -1,16 +1,36 @@
 # Esplanade
 
-<a href="https://funbox.ru">
-  <img src="https://funbox.ru/badges/sponsored_by_funbox.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,105 +40,213 @@ 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'
 ```
 
-## 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, apib_path: 'doc.apib'
 ```
 
 ### 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, apib_path: 'doc.apib'
+config.middleware.use YourMiddleware
+config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
 ```
 
 ## 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"}`.
+Error message format: 
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type"
+}
+```
 
 #### Esplanade::Request::NotDocumented
 
-Error message: `{:method=>"method", :path=>"path"}`.
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type"
+}
+```
+
+#### Esplanade::Request::ContentTypeIsNotJson
+
+Error message format:
+
+```ruby
+{
+  :method => "method",
+  :path => "path",
+  :raw_path => "path",
+  :content_type => "content_type"
+}
+```
 
 #### Esplanade::Request::BodyIsNotJson
 
-Only if the documentation for this request indicates that `Content-Type: application/json`.
+Throws an error also when the body is empty and equal nil.
 
-Error message: `{:method=>"method", :path=>"path", :body=>"{\"state\": 1"}`.
+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", :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::PrefixNotMatch
+
+Error message format: 
+
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path"
+  },
+  :status => "status"
+}
+```
 
 #### Esplanade::Response::NotDocumented
 
-Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status"}`.
+Error message format:
+
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path",
+    :raw_path => "path"
+  },
+  :status => "status"
+}
+```
 
 #### Esplanade::Response::BodyIsNotJson
 
-Only if the documentation for all the responses of one request indicates that `Content-Type: application/json`.
+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.
+
+Error message format:
 
-Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body"}`.
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path",
+    :raw_path => "path"
+  },
+  :status => "status",
+  :body => "body"
+}
+```
 
 #### Esplanade::Response::Invalid
 
-Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body", :error=>["error"]}`.
+Error message format:
+
+```ruby
+{
+  :request => {
+    :method => "method",
+    :path => "path",
+    :raw_path => "path"
+  },
+  :status => "status",
+  :body => "body",
+  :error => ["error"]
+}
+```
 
 ## Middleware args
 
-### apib_path
+### `apib_path`
 
 Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
 
-### drafter_yaml_path
+### `drafter_yaml_path`
 
 Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
-### prefix
+### `prefix`
 
-Prefix of API requests. Example: `'/api'`. The prefix is added to the requests in the documentation.
+Prefix for API requests. Example: `'/api'`. The prefix is added to the requests in the documentation.
 
 ## 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', '~> 1.2', '>= 1.2.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.0.0', '>= 3.0.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/middlewares/check_custom_response_middleware.rb

@@ -6,9 +6,9 @@ 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
+      prefix: Esplanade.configuration.prefix,
+      apib_path: Esplanade.configuration.apib_path,
+      drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
     )
       @app = app
       @documentation = Tomograph::Tomogram.new(

data/lib/esplanade/request.rb

@@ -1,15 +1,10 @@
 require 'esplanade/request/doc'
 require 'esplanade/request/raw'
 require 'esplanade/request/validation'
+require 'esplanade/request/error'
 
 module Esplanade
   class Request
-    class Error < Esplanade::Error; end
-    class PrefixNotMatch < Error; end
-    class NotDocumented  < Error; end
-    class BodyIsNotJson  < Error; end
-    class Invalid        < Error; end
-
     def initialize(documentation, env)
       @documentation = documentation
       @env = env

data/lib/esplanade/request/doc.rb

@@ -7,14 +7,20 @@ module Esplanade
       end
 
       def tomogram
-        raise PrefixNotMatch, message unless @main_documentation.prefix_match?(@raw.path)
-        @tomogram = @main_documentation.find_request(method: @raw.method, path: @raw.path)
-        raise NotDocumented, message if @tomogram.nil?
+        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.new(**message) if @tomogram.nil?
+
         @tomogram
       end
 
-      def json_schema
-        @json_schema ||= tomogram.request
+      def json_schemas
+        @json_schemas ||= tomogram.requests
       end
 
       def method
@@ -25,6 +31,10 @@ module Esplanade
         @path ||= tomogram.path.to_s
       end
 
+      def content_type
+        @content_type ||= tomogram.content_type.to_s
+      end
+
       def responses
         @responses ||= tomogram.responses
       rescue NotDocumented
@@ -36,7 +46,9 @@ module Esplanade
       def message
         {
           method: @raw.method,
-          path: @raw.path
+          path: @raw.path,
+          raw_path: @raw.raw_path,
+          content_type: @raw.content_type
         }
       end
     end

data/lib/esplanade/request/error.rb

@@ -0,0 +1,93 @@
+module Esplanade
+  class Request
+    class Error < Esplanade::Error; end
+
+    class PrefixNotMatch < Error; end
+
+    class NotDocumented < Error
+      def initialize(method:, path:, raw_path:, content_type:)
+        @method = method
+        @path = path
+        @raw_path = raw_path
+        @content_type = content_type
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          raw_path: @raw_path,
+          content_type: @content_type
+        }
+      end
+    end
+
+    class ContentTypeIsNotJson < Error
+      def initialize(method:, path:, raw_path:, content_type:)
+        @method = method
+        @raw_path = raw_path
+        @path = path
+        @content_type = content_type
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          raw_path: @raw_path,
+          content_type: @content_type
+        }
+      end
+    end
+
+    class BodyIsNotJson < Error
+      def initialize(method:, path:, raw_path:, content_type:, body:)
+        @method = method
+        @path = path
+        @raw_path = raw_path
+        @content_type = content_type
+        @body = body
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          raw_path: @raw_path,
+          content_type: @content_type,
+          body: @body
+        }
+      end
+    end
+
+    class Invalid < 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
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          raw_path: @raw_path,
+          content_type: @content_type,
+          body: @body,
+          error: @error
+        }
+      end
+    end
+  end
+end

data/lib/esplanade/request/raw.rb

@@ -15,9 +15,17 @@ 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'].to_s.split(';').first
+      end
     end
   end
 end

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

@@ -11,19 +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 && to_string.size >= 1000
+                                 "#{to_string[0..499]}...#{to_string[500..-1]}"
+                               else
+                                 to_string
+                               end
         end
 
         private
@@ -32,7 +37,9 @@ module Esplanade
           {
             method: @raw_request.method,
             path: @raw_request.path,
-            body: to_string
+            raw_path: @raw_request.raw_path,
+            content_type: @raw_request.content_type,
+            body: reduced_version
           }
         end
       end

data/lib/esplanade/request/validation.rb

@@ -10,17 +10,51 @@ module Esplanade
       end
 
       def valid!
-        @error ||= JSON::Validator.fully_validate(@doc.json_schema, @raw.body.to_hash)
-        raise Invalid, message if @error != []
+        raise ContentTypeIsNotJson.new(**mini_message) unless @doc.content_type == 'application/json'
+
+        @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,
+          raw_path: @raw.raw_path,
+          content_type: @doc.content_type
+        }
+      end
+
       def message
         {
           method: @raw.method,
           path: @raw.path,
-          body: @raw.body.to_string,
+          raw_path: @raw.raw_path,
+          content_type: @raw.content_type,
+          body: @raw.body.to_hash,
           error: @error
         }
       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.2.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.6.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -56,128 +56,108 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.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.0.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
@@ -207,11 +188,13 @@ files:
 - lib/esplanade/middlewares/safe_middleware.rb
 - lib/esplanade/request.rb
 - lib/esplanade/request/doc.rb
+- lib/esplanade/request/error.rb
 - lib/esplanade/request/raw.rb
 - lib/esplanade/request/raw/body.rb
 - 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
@@ -228,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