esplanade 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3373c627cdf10a0e2f896e87f1d35ac03f54e35633a405feb2948e550ed8a1c
-  data.tar.gz: f264e61df01786b3d14ecb9771691c330b6e028ddba7e2067e0a73b2fbfbace5
+  metadata.gz: f5a2030af1a5071793987d6ee1bab57942a83efd21ae68b6323de133c0667e4b
+  data.tar.gz: 2474417384e61677938e602e48657bb8acffaeed13cdbf1593c64c4d97620f42
 SHA512:
-  metadata.gz: ffa353a02394d3bafe0d2197932b3e1243bed4dd2fe11c47cc7a235f733db739c00fa698bdb9f689624fd1064c24f0af2c74a2ff26b31dbe6c4eb7e359e4cb13
-  data.tar.gz: b9a19774d5bdd62d65854525b1a8606bc4babb0cd1eb02ffcb0737c5e12f05f72e0c81fb60866fcb86e5db5e5cebad9f7849aab75a520aec3a8176feacd06812
+  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/.tool-versions

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

data/CHANGELOG.md

@@ -1,6 +1,15 @@
 # Change log
 
-### 1.4.1 - 2020-04-07
+### 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

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 to validate and synchronize 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,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", :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::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

@@ -18,7 +18,7 @@ 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_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'

data/lib/esplanade/request/doc.rb

@@ -19,8 +19,8 @@ module Esplanade
         @tomogram
       end
 
-      def json_schema
-        @json_schema ||= tomogram.request
+      def json_schemas
+        @json_schemas ||= tomogram.requests
       end
 
       def method
@@ -47,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

@@ -37,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

@@ -12,17 +12,38 @@ module Esplanade
       def valid!
         raise ContentTypeIsNotJson.new(**mini_message) unless @doc.content_type == 'application/json'
 
-        @error ||= JSON::Validator.fully_validate(@doc.json_schema, @raw.body.to_hash)
+        @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
@@ -31,6 +52,7 @@ module Esplanade
         {
           method: @raw.method,
           path: @raw.path,
+          raw_path: @raw.raw_path,
           content_type: @raw.content_type,
           body: @raw.body.to_hash,
           error: @error

data/lib/esplanade/response/doc.rb

@@ -11,6 +11,8 @@ module Esplanade
         raise NotDocumented.new(**message) if @tomogram == []
 
         @tomogram
+      rescue Esplanade::Request::PrefixNotMatch
+        raise PrefixNotMatch.new(**message)
       end
 
       def json_schemas
@@ -27,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

@@ -2,10 +2,13 @@ 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)
@@ -16,7 +19,8 @@ module Esplanade
           request:
             {
               method: @method,
-              path: @path
+              path: @path,
+              raw_path: @raw_path
             },
           status: @status
         }
@@ -27,6 +31,7 @@ module Esplanade
       def initialize(request:, status:, body:)
         @method = request[:method]
         @path = request[:path]
+        @raw_path = request[:raw_path]
         @status = status
         @body = body
 
@@ -38,7 +43,8 @@ module Esplanade
           request:
             {
               method: @method,
-              path: @path
+              path: @path,
+              raw_path: @raw_path
             },
           status: @status,
           body: @body
@@ -50,6 +56,7 @@ module Esplanade
       def initialize(request:, status:, body:, error:)
         @method = request[:method]
         @path = request[:path]
+        @raw_path = request[:raw_path]
         @status = status
         @body = body
         @error = error
@@ -62,7 +69,8 @@ module Esplanade
           request:
             {
               method: @method,
-              path: @path
+              path: @path,
+              raw_path: @raw_path
             },
           status: @status,
           body: @body,

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

@@ -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

@@ -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.5.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.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -165,12 +165,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gempush.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile

data/.github/workflows/gempush.yml

@@ -1,28 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-before_install: gem install bundler