esplanade 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a2030af1a5071793987d6ee1bab57942a83efd21ae68b6323de133c0667e4b
-  data.tar.gz: 2474417384e61677938e602e48657bb8acffaeed13cdbf1593c64c4d97620f42
+  metadata.gz: 8c136a3d8b6813e9a5be58f5cd21ed11014290ba75aa609fe9d8ba2444326a5d
+  data.tar.gz: 5e38971b73680f6e33274360b52343ff459eee5910f9bb16b564751ff45e6a03
 SHA512:
-  metadata.gz: 490ca6b622daf918b964966a523d751744923048a5ea78a7eaea7bb4fee5bd6d4623a8951d5255ba0fae49ac78eeba5bc00b6bff876f05c38d9cec88e706a170
-  data.tar.gz: b8bfb543326e2d7789d4a1842c96ae163e1a84ba6b3118ee95b57fe53451a308429dc103f7678b613f081d61e29df9668842e2ef8c9062dcdc139bdfa80a0c65
+  metadata.gz: 21f291d6c57c8ef46908f9844e6fc01bc1d28590cc9817c61947fcc37309c2fca318b2d1a2a8a3756f5175c93677c2a1ef32ab0aba7f385950db505655cf36b0
+  data.tar.gz: 2e0384d3a06fc34cf2ba17162bfa447af7a0f35775b9fc50e0c645680b7c7da1277538a48e73dc8c3b0ff0e3ecefeba65470cdcd23383beb7832b13aa6aeaa39

data/.github/workflows/ruby.yml

@@ -23,10 +23,10 @@ jobs:
     - 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
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
       with:
-        ruby-version: 2.6
+        ruby-version: 2.7
     - name: Install dependencies
       run: bundle install
     - name: Run tests

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+### 1.7.0 - 2020-12-22
+
+* improvements
+  * changed middleware arguments
+
 ### 1.6.0 - 2020-10-12
 
 * features

data/README.md

@@ -57,7 +57,7 @@ $ gem install esplanade
 `config/application.rb`:
 
 ```ruby
-config.middleware.use Esplanade::SafeMiddleware, apib_path: 'doc.apib'
+config.middleware.use Esplanade::SafeMiddleware, drafter_yaml_path: 'doc.yaml'
 ```
 
 ## Middlewares
@@ -72,7 +72,7 @@ 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 Esplanade::DangerousMiddleware, drafter_yaml_path: 'doc.yaml'
 ```
 
 ### Esplanade::CheckCustomResponseMiddleware
@@ -80,9 +80,9 @@ config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
 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 Esplanade::CheckCustomResponseMiddleware, drafter_yaml_path: 'doc.yaml'
 config.middleware.use YourMiddleware
-config.middleware.use Esplanade::DangerousMiddleware, apib_path: 'doc.apib'
+config.middleware.use Esplanade::DangerousMiddleware, drafter_yaml_path: 'doc.yaml'
 ```
 
 ## Esplanade::Error
@@ -95,7 +95,7 @@ Parent class for those described below. Inherited from `Esplanade::Error`.
 
 #### Esplanade::Request::PrefixNotMatch
 
-Error message format: 
+Error message format:
 
 ```ruby
 {
@@ -169,7 +169,7 @@ Parent class for those described below. Inherited from `Esplanade::Error`.
 
 #### Esplanade::Response::PrefixNotMatch
 
-Error message format: 
+Error message format:
 
 ```ruby
 {
@@ -233,17 +233,7 @@ Error message format:
 
 ## Middleware args
 
-### `apib_path`
-
-Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
-
-### `drafter_yaml_path`
-
-Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
-
-### `prefix`
-
-Prefix for API requests. Example: `'/api'`. The prefix is added to the requests in the documentation.
+Support any [tomograph constructor-params](https://github.com/funbox/tomograph/tree/master#constructor-params)
 
 ## License
 

data/lib/esplanade/configuration.rb

@@ -1,11 +1,9 @@
 module Esplanade
   class Configuration
-    attr_accessor :apib_path,
-                  :drafter_yaml_path,
-                  :prefix
+    attr_accessor :params
 
     def initialize
-      @prefix = ''
+      @params = {}
     end
   end
 end

data/lib/esplanade/middleware.rb

@@ -4,18 +4,9 @@ require 'esplanade/response'
 
 module Esplanade
   class Middleware
-    def initialize(
-      app,
-      prefix: Esplanade.configuration.prefix,
-      apib_path: Esplanade.configuration.apib_path,
-      drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/middlewares/check_custom_response_middleware.rb

@@ -4,18 +4,9 @@ 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
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/middlewares/dangerous_middleware.rb

@@ -4,18 +4,9 @@ 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
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/middlewares/safe_middleware.rb

@@ -4,18 +4,9 @@ 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
-    )
+    def initialize(app, **params)
       @app = app
-      @documentation = Tomograph::Tomogram.new(
-        prefix: prefix,
-        apib_path: apib_path,
-        drafter_yaml_path: drafter_yaml_path
-      )
+      @documentation = Tomograph::Tomogram.new(Esplanade.configuration.params.merge(params))
     end
 
     def call(env)

data/lib/esplanade/version.rb

@@ -1,3 +1,3 @@
 module Esplanade
-  VERSION = '1.6.0'.freeze
+  VERSION = '1.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema