esplanade 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc7479b76e247ba0d85009c91c9114b000069b78
-  data.tar.gz: 7efc7851a8cce81fc368ca748a69309f2e382c43
+  metadata.gz: d56ac3bbfdcd35af5878ab7c38ba6192ef4e5957
+  data.tar.gz: a17fd30d62e0039c6d70389e8f197e1b46a8bf17
 SHA512:
-  metadata.gz: 7e107bd64e45b84dfe9575e0e2e3324bb4e9b4cb565f50eb96de51b3e35bf71afbbe89434a541fa33251023cac1ec582addce0a6b44e121a0fa495bea61b1f6b
-  data.tar.gz: 751af6d98761fd85d58a11a017c12111f0997ca00bda8528e4f50ef19bc9a305a93293636bff0139374dcde430ed124fa55cc07a20da0afad2a867fba105b4cf
+  metadata.gz: fcbf87e4765ff6ac1b388e490c03dd9c72f57e062fdd9598e247ad4425e51f1723234142af8e0b89ff8611fe7e45834abbbb7c6c49e7237f23729cbe2b07209e
+  data.tar.gz: 40d6f05bbc3ac4125d0e26f5ff21d0df8fd96fea36eb86efdb99547d3a16d1decb28feb8e93e86ee0cb0382bd21a1453d94cf77b0131e1974fae5ac1487be652

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+### 1.2.0 - 2018-02-15
+
+* features
+  * add safe and dangerous middleware
+  * add middleware for check custom response
+* deprecations
+  * configure
+  * Esplanade::Middleware
+
 ### 1.1.2 - 2018-02-14
 
 * bug fixes

data/README.md

@@ -30,38 +30,35 @@ Or install it yourself as:
 
 ## Usage
 
-Example:
-
-`middlewares/your_middleware.rb`
+`config/application.rb`
 
 ```ruby
-class YourMiddleware < Esplanade::Middleware
-  def call(env)
-    request = Esplanade::Request.new(@documentation, env)
-    request.validation.valid!
+config.middleware.use Esplanade::SafeMiddleware, apib_path: 'doc.apib'
+```
 
-    status, headers, body = @app.call(env)
+## Middleware
 
-    response = Esplanade::Response.new(request, status, body)
-    response.validation.valid!
+### Esplanade::SafeMiddleware
 
-    [status, headers, body]
-  rescue Esplanade::Error => e
-    your_render_error(e)
-  end
-end
-```
+Only debug logger.
 
-`config/application.rb`
+### Esplanade::DangerousMiddleware
+
+It throws errors, so you will need to add your own middleware for processing.
 
 ```ruby
-require 'esplanade'
-Esplanade.configure do |config|
-  config.apib_path = 'doc/backend.apib'
-end
+    config.middleware.use YourMiddleware
+    config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
+```
+
+### Esplanade::CheckCustomResponseMiddleware
 
-require_relative '../middlewares/your_middleware'
-config.middleware.use YourMiddleware
+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'
 ```
 
 ## Esplanade::Error
@@ -108,7 +105,7 @@ Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status"
 
 Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body", :error=>["error"]}`.
 
-## Config
+## Middleware args
 
 ### apib_path
 

data/lib/esplanade.rb

@@ -1,4 +1,7 @@
 require 'esplanade/middleware'
+require 'esplanade/middlewares/safe_middleware'
+require 'esplanade/middlewares/dangerous_middleware'
+require 'esplanade/middlewares/check_custom_response_middleware'
 require 'esplanade/configuration'
 
 module Esplanade

data/lib/esplanade/middleware.rb

@@ -4,12 +4,17 @@ require 'esplanade/response'
 
 module Esplanade
   class Middleware
-    def initialize(app)
+    def initialize(
+      app,
+      prefix: Esplanade.configuration.prefix,
+      apib_path: Esplanade.configuration.apib_path,
+      drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
+    )
       @app = app
       @documentation = Tomograph::Tomogram.new(
-        prefix: Esplanade.configuration.prefix,
-        apib_path: Esplanade.configuration.apib_path,
-        drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
+        prefix: prefix,
+        apib_path: apib_path,
+        drafter_yaml_path: drafter_yaml_path
       )
     end
 

data/lib/esplanade/middlewares/check_custom_response_middleware.rb

@@ -0,0 +1,32 @@
+require 'tomograph'
+require 'esplanade/request'
+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
+    )
+      @app = app
+      @documentation = Tomograph::Tomogram.new(
+        prefix: prefix,
+        apib_path: apib_path,
+        drafter_yaml_path: drafter_yaml_path
+      )
+    end
+
+    def call(env)
+      request = Esplanade::Request.new(@documentation, env)
+
+      status, headers, body = @app.call(env)
+
+      response = Esplanade::Response.new(request, status, body)
+      response.validation.valid!
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/esplanade/middlewares/dangerous_middleware.rb

@@ -0,0 +1,33 @@
+require 'tomograph'
+require 'esplanade/request'
+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
+    )
+      @app = app
+      @documentation = Tomograph::Tomogram.new(
+        prefix: prefix,
+        apib_path: apib_path,
+        drafter_yaml_path: drafter_yaml_path
+      )
+    end
+
+    def call(env)
+      request = Esplanade::Request.new(@documentation, env)
+      request.validation.valid!
+
+      status, headers, body = @app.call(env)
+
+      response = Esplanade::Response.new(request, status, body)
+      response.validation.valid!
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/esplanade/middlewares/safe_middleware.rb

@@ -0,0 +1,47 @@
+require 'tomograph'
+require 'esplanade/request'
+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
+    )
+      @app = app
+      @documentation = Tomograph::Tomogram.new(
+        prefix: prefix,
+        apib_path: apib_path,
+        drafter_yaml_path: drafter_yaml_path
+      )
+    end
+
+    def call(env)
+      request = Esplanade::Request.new(@documentation, env)
+      check_request(request)
+
+      status, headers, body = @app.call(env)
+
+      response = Esplanade::Response.new(request, status, body)
+      check_response(response)
+
+      [status, headers, body]
+    end
+
+    def check_request(request)
+      request.validation.valid!
+      Rails.logger.debug 'ESPLANADE SAYS THAT THE REQUEST IS VALID'
+    rescue Esplanade::Request::Error => e
+      Rails.logger.debug "ESPLANADE SKIP: #{e.inspect}"
+    end
+
+    def check_response(response)
+      response.validation.valid!
+      Rails.logger.debug 'ESPLANADE SAYS THAT THE RESPONSE IS VALID'
+    rescue Esplanade::Response::Error => e
+      Rails.logger.debug "ESPLANADE SKIP: #{e.inspect}"
+    end
+  end
+end

data/lib/esplanade/version.rb

@@ -1,3 +1,3 @@
 module Esplanade
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -202,6 +202,9 @@ files:
 - lib/esplanade/configuration.rb
 - lib/esplanade/error.rb
 - lib/esplanade/middleware.rb
+- lib/esplanade/middlewares/check_custom_response_middleware.rb
+- lib/esplanade/middlewares/dangerous_middleware.rb
+- lib/esplanade/middlewares/safe_middleware.rb
 - lib/esplanade/request.rb
 - lib/esplanade/request/doc.rb
 - lib/esplanade/request/raw.rb