esplanade 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff2aa7471fbccccd7a52e52ba79faa5c181c3fc9
-  data.tar.gz: 34d21fc0cb3cf09954ce401805076c206508b9d2
+  metadata.gz: f025bdf4dd1ab531595638a97e29c752ff806f67
+  data.tar.gz: e0fed6c59b1d29d6f093ed56f499ef0671f51214
 SHA512:
-  metadata.gz: e4cf2e079c8773cdb0b10241ba8166834ab6b6c03b108273e9b7963efa7d812b8a2a2cc7ba249b7c429fffdb80b0dcf36b5b167665b7fef2e00177568f51a32c
-  data.tar.gz: 62b6623aa9df749907c7d6dc5e6413103bab3083368cc616140c63b9bb3cd4cdfa596a60c857fef5ab57e40b9e8d7a168a606b421ed8db7c079e640387bc8c7a
+  metadata.gz: e54ccff39207044c6cb62e4e58d6d4b4372841a3dad3a2392994b3817074f9bf74ab8c93872992ac0ec2b45dbbb4584ddbec45545cb3d39d29c8d63bb0aace53
+  data.tar.gz: 201f34eca6b8e5b351f14aab8734efcf73797e64856d62a6c5872bdcb361c29d53f5bb00f3a02d7908bc61ba2691b574958eb4c49b974bfe0793b6e40581d198

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Change log
 
+### 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

@@ -7,7 +7,7 @@
 [![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 will help 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.

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'
 

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/doc.rb

@@ -8,12 +8,14 @@ module Esplanade
 
       def tomogram
         raise PrefixNotMatch, 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?
+
         @tomogram
       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
         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

data/lib/esplanade/request/validation.rb

@@ -10,7 +10,8 @@ module Esplanade
       end
 
       def valid!
-        raise ContentTypeIsNotJson, mini_message unless @doc.content_type  == 'application/json'
+        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?
@@ -21,7 +22,7 @@ module Esplanade
       def mini_message
         {
           method: @doc.method,
-          path:   @doc.path,
+          path: @doc.path,
           content_type: @doc.content_type
         }
       end
@@ -29,10 +30,10 @@ module Esplanade
       def message
         {
           method: @raw.method,
-          path:   @raw.path,
+          path: @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

@@ -9,6 +9,7 @@ module Esplanade
       def tomogram
         @tomogram ||= @request.doc.responses.find_all { |response| response['status'] == @raw.status }
         raise NotDocumented, message if @tomogram == []
+
         @tomogram
       end
 

data/lib/esplanade/response/error.rb

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

data/lib/esplanade/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -213,6 +213,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