esplanade 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85995e3ffde40ae8fb299e8bdc4ac1173283590c
-  data.tar.gz: 0f1242bec48b135345a4b6d1680cd6f4fc98f698
+  metadata.gz: ff2aa7471fbccccd7a52e52ba79faa5c181c3fc9
+  data.tar.gz: 34d21fc0cb3cf09954ce401805076c206508b9d2
 SHA512:
-  metadata.gz: d332f111d4860bd09e341c2c8aebfb35157e1582b6506b70d8176ef9ad118b101f14ca6f8aa98898ef95ec0394ae2be2aae9ef9a433bee86411c0367a2f93f82
-  data.tar.gz: e8d29d45efa8908f74c2f1046c61840131a816218ebd222c618edadaca5a45dedac020a319c56625dbac9aa75140054cf30b6197d97e8602d21db14f991f05e5
+  metadata.gz: e4cf2e079c8773cdb0b10241ba8166834ab6b6c03b108273e9b7963efa7d812b8a2a2cc7ba249b7c429fffdb80b0dcf36b5b167665b7fef2e00177568f51a32c
+  data.tar.gz: 62b6623aa9df749907c7d6dc5e6413103bab3083368cc616140c63b9bb3cd4cdfa596a60c857fef5ab57e40b9e8d7a168a606b421ed8db7c079e640387bc8c7a

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # Change log
 
+### 1.3.0 - 2018-03-16
+
+* features
+  * add Esplanade::Request::ContentTypeIsNotJson erro
+  * add reduced version message about request body
+
 ### 1.2.1 - 2018-02-20
 
-* improvement
+* features
   * more information about the invalid request
 
 ### 1.2.0 - 2018-02-15
@@ -16,12 +22,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
@@ -31,5 +37,5 @@
 
 ### 1.0.1 - 2017-10-09
 
-* bug fixes
+* fixes
   * allow request body to be nil

data/README.md

@@ -1,7 +1,7 @@
 # Esplanade
 
 <a href="https://funbox.ru">
-  <img src="https://funbox.ru/badges/sponsored_by_funbox.svg" alt="Sponsored by FunBox" width=250 />
+  <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)
@@ -71,21 +71,23 @@ From him the `Esplanade::Request::PrefixNotMatch`, `Esplanade::Request::NotDocum
 
 #### Esplanade::Request::PrefixNotMatch
 
-Error message: `{:method=>"method", :path=>"path"}`.
+Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type"}`.
 
 #### Esplanade::Request::NotDocumented
 
-Error message: `{:method=>"method", :path=>"path"}`.
+Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type"}`.
 
-#### Esplanade::Request::BodyIsNotJson
+#### Esplanade::Request::ContentTypeIsNotJson
+
+Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type"}`.
 
-Only if the documentation for this request indicates that `Content-Type: application/json`.
+#### Esplanade::Request::BodyIsNotJson
 
-Error message: `{:method=>"method", :path=>"path", :body=>"{\"state\": 1"}`.
+Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type", :body=>"{\"state\": 1"}`.
 
 #### Esplanade::Request::Invalid
 
-Error message: `{:method=>"method", :path=>"path", :body=>"body", :error=>["error"]}`.
+Error message: `{:method=>"method", :path=>"path", :content_type=>"content_type", :body=>"body", :error=>["error"]}`.
 
 ### Esplanade::Response::Error
 

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', '~> 1.2', '>= 1.2.0'
+  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'

data/lib/esplanade/request/doc.rb

@@ -8,7 +8,11 @@ module Esplanade
 
       def tomogram
         raise PrefixNotMatch, message unless @main_documentation.prefix_match?(@raw.path)
-        @tomogram = @main_documentation.find_request(method: @raw.method, path: @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?
         @tomogram
       end
@@ -25,6 +29,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 +44,8 @@ module Esplanade
       def message
         {
           method: @raw.method,
-          path: @raw.path
+          path: @raw.path,
+          content_type: @raw.content_type
         }
       end
     end

data/lib/esplanade/request/error.rb

@@ -3,17 +3,70 @@ module Esplanade
     class Error < Esplanade::Error; end
 
     class PrefixNotMatch < Error; end
-    class NotDocumented  < Error; end
-    class BodyIsNotJson  < Error; end
 
-    class Invalid < Error
-      attr_reader :method, :path, :body, :error
+    class NotDocumented < Error
+      def initialize(method:, path:, content_type:)
+        @method = method
+        @path = path
+        @content_type = content_type
+
+        super(to_hash)
+      end
 
-      def initialize(method:, path:, body:, error:)
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          content_type: @content_type
+        }
+      end
+    end
+
+    class ContentTypeIsNotJson < Error
+      def initialize(method:, path:, content_type:)
+        @method = method
+        @path = path
+        @content_type = content_type
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          content_type: @content_type
+        }
+      end
+    end
+
+    class BodyIsNotJson < Error
+      def initialize(method:, path:, content_type:, body:)
+        @method = method
+        @path = path
+        @content_type = content_type
+        @body = body
+
+        super(to_hash)
+      end
+
+      def to_hash
+        {
+          method: @method,
+          path: @path,
+          content_type: @content_type,
+          body: @body
+        }
+      end
+    end
+
+    class Invalid < Error
+      def initialize(method:, path:, content_type:, body:, error:)
         @method = method
-        @path   = path
-        @body   = body
-        @error  = error
+        @path = path
+        @content_type = content_type
+        @body = body
+        @error = error
 
         super(to_hash)
       end
@@ -21,9 +74,10 @@ module Esplanade
       def to_hash
         {
           method: @method,
-          path:   @path,
-          body:   @body,
-          error:  @error
+          path: @path,
+          content_type: @content_type,
+          body: @body,
+          error: @error
         }
       end
     end

data/lib/esplanade/request/raw.rb

@@ -18,6 +18,10 @@ module Esplanade
       def body
         @body ||= Body.new(self, @env)
       end
+
+      def content_type
+        @content_type ||= @env['CONTENT_TYPE']
+      end
     end
   end
 end

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

@@ -26,13 +26,22 @@ module Esplanade
           raise BodyIsNotJson, message
         end
 
+        def reduced_version
+          @reduced_version ||= if to_string.size >= 1000
+            "#{to_string[0..499]}...#{to_string[500..-1]}"
+          else
+            to_string
+          end
+        end
+
         private
 
         def message
           {
             method: @raw_request.method,
             path: @raw_request.path,
-            body: to_string
+            content_type: @raw_request.content_type,
+            body: reduced_version
           }
         end
       end

data/lib/esplanade/request/validation.rb

@@ -10,6 +10,7 @@ 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 Invalid, message unless @error.empty?
@@ -17,10 +18,19 @@ module Esplanade
 
       private
 
+      def mini_message
+        {
+          method: @doc.method,
+          path:   @doc.path,
+          content_type: @doc.content_type
+        }
+      end
+
       def message
         {
           method: @raw.method,
           path:   @raw.path,
+          content_type: @raw.content_type,
           body:   @raw.body.to_hash,
           error:  @error
         }

data/lib/esplanade/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement