esplanade 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0682d7613229adb081ec4a064b247e46c9be269
-  data.tar.gz: c073b32fbb358e9628942e2bcf3948948f0ae554
+  metadata.gz: 136faea6ccc9fb08600dfb9c8d597172bb72e270
+  data.tar.gz: 92d86b6dcf3cc3d8d7ad3622bfb99b0c45aabf07
 SHA512:
-  metadata.gz: 876e8d7fbe6c903bcde139ca4c194994d8975e84fbd0ec05d54a9d03fdde1c95d8e2f8ee762f634424e5ac1312cedb45f23c269ac85de717ed2793f65120f942
-  data.tar.gz: 6f5910dd3c251ef09b428eb3fe433c1c0cf4f92762ab4bc5e78cf5f21c5550141589c2a3beef37eba62830e5f00a469ee10747edc360ce77c3e1a050e9db2121
+  metadata.gz: 1dfbc8ba44102440c149a1d84be28151fe3ed5a918b7d43233ee58a6cb9d7c2713219571f9555d6e5b577184673827b1e7b109299ab5104cb4abefbd997cd754
+  data.tar.gz: ee811221aa1764c746afead9aa85365b035dcc1eecf5f768a27dd503f9acc9c200bccded11c7d7c168a7e482d5aaedbf15ee74ea16273151622565a51b46ae78

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.2
 
 Metrics/LineLength:
   Max: 120
@@ -9,3 +9,12 @@ Style/Documentation:
 
 Style/FrozenStringLiteralComment:
   Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.2.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 2.2
+before_install: gem install bundler -v 1.12

data/README.md

@@ -1,21 +1,11 @@
 # Esplanade
 
-This gem helps you validate the request and response documentation API Blueprint.
+[![Build Status](https://travis-ci.org/funbox/esplanade.svg?branch=master)](https://travis-ci.org/funbox/esplanade)
 
-
-If the request to the server will be invalid tomogram, it will return a response with a 400 status and the body of the error.
-If the server's response will be invalid tomogram, it will return a response with 500 status and the body of the error.
-
-An example of an error body
-
-```ruby
-{
-  "error": [
-      "The property '#/' did not contain a required property of 'login' in schema deee53ed-f917-5f2f-bccf-0b8af3b749c7",
-      "The property '#/' did not contain a required property of 'password' in schema deee53ed-f917-5f2f-bccf-0b8af3b749c7"
-    ]
-}
-```
+This gem will help you validation and sinhronize 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.
 
 ## Installation
 
@@ -35,48 +25,93 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails
+Example:
 
-config/application.rb
+`middlewares/your_middleware.rb`
 
 ```ruby
-require 'esplanade'
-```
+class YourMiddleware < Esplanade::Middleware
+  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!
 
-### Rake
+    [status, headers, body]
+  rescue Esplanade::Error => e
+    your_render_error(e)
+  end
+end
+```
 
-config/application.rb
+`config/application.rb`
 
 ```ruby
 require 'esplanade'
-config.middleware.use Esplanade::Middleware
+Esplanade.configure do |config|
+  config.apib_path = 'doc/backend.apib'
+end
+
+require_relative '../middlewares/your_middleware'
+config.middleware.use YourMiddleware
 ```
 
-## Config
+## Esplanade::Error
 
-### tomogram
+From him the `Esplanade::Request::Error` and `Esplanade::Response::Error` are inherited.
 
-This gem takes a simplified format json convert from API Blueprint which we have called API Tomogram.
+### Esplanade::Request::Error
 
-If in your project you are using the gem tomograph, then define the configuration you are not required.
+From him the `Esplanade::Request::NotDocumented`, `Esplanade::Request::BodyIsNotJson` and `Esplanade::Request::Invalid` are inherited.
 
-```ruby
-Esplanade.configure do |config|
-  config.tomogram = 'tomogram.json'
-end
-```
+#### Esplanade::Request::NotDocumented
+
+Error message: `{:method=>"method", :path=>"path"}`.
+
+#### Esplanade::Request::BodyIsNotJson
+
+Only if the documentation for this request indicates that `Content-Type: application/json`.
+
+Error message: `{:method=>"method", :path=>"path", :body=>"{\"state\": 1"}`.
+
+#### Esplanade::Request::Invalid
+
+Error message: `{:method=>"method", :path=>"path", :body=>"body", :error=>["error"]}`.
+
+### Esplanade::Response::Error
+
+From him the `Esplanade::Response::NotDocumented`, `Esplanade::Response::BodyIsNotJson` and `Esplanade::Response::Invalid` are inherited.
+
+#### Esplanade::Response::NotDocumented
+
+Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status"}`.
+
+#### Esplanade::Response::BodyIsNotJson
+
+Only if the documentation for all the responses of one request indicates that `Content-Type: application/json`.
+
+Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body"}`.
+
+#### Esplanade::Response::Invalid
+
+Error message: `{:request=>{:method=>"method", :path=>"path"}, :status=>"status", :body=>"body", :error=>["error"]}`.
+
+## Config
 
-### skip_not_documented
+### apib_path
 
-Default true.
+Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
 
-### validation_requests
+### drafter_yaml_path
 
-Default true.
+Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
-### validation_response
+### prefix
 
-Default true.
+Prefix of API requests. Example: `'/api'`. The prefix is added to the requests in the documentation.
 
 ## License
 

data/esplanade.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'esplanade/version'
@@ -19,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'multi_json', '~> 1.11', '>= 1.11.1'
   spec.add_runtime_dependency 'json-schema', '~> 2.6', '>= 2.6.2'
-  spec.add_runtime_dependency 'tomogram_routing', '~> 0.1', '>= 0.1.0'
+  spec.add_runtime_dependency 'tomograph', '~> 1.1', '>= 1.1.0'
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'byebug', '~> 8.2', '>= 8.2.1'

data/lib/esplanade.rb

@@ -1,13 +1,5 @@
 require 'esplanade/middleware'
 require 'esplanade/configuration'
-require 'esplanade/request'
-require 'esplanade/request/body'
-require 'esplanade/request/error'
-require 'esplanade/response'
-require 'esplanade/response/body'
-require 'esplanade/response/error'
-require 'esplanade/railtie' if defined?(Rails)
-require 'tomogram_routing'
 
 module Esplanade
   class << self

data/lib/esplanade/configuration.rb

@@ -1,14 +1,11 @@
 module Esplanade
   class Configuration
-    attr_accessor :tomogram,
-                  :skip_not_documented,
-                  :validation_requests,
-                  :validation_response
+    attr_accessor :apib_path,
+                  :drafter_yaml_path,
+                  :prefix
 
     def initialize
-      @skip_not_documented = true
-      @validation_requests = true
-      @validation_response = true
+      @prefix = ''
     end
   end
 end

data/lib/esplanade/error.rb

@@ -0,0 +1,3 @@
+module Esplanade
+  class Error < RuntimeError; end
+end

data/lib/esplanade/middleware.rb

@@ -1,33 +1,20 @@
-require 'yaml'
+require 'tomograph'
+require 'esplanade/request'
+require 'esplanade/response'
 
 module Esplanade
   class Middleware
-    class Exit < RuntimeError; end
-    class ResponseNotDoc < RuntimeError; end
-
     def initialize(app)
       @app = app
-      @tomogram = TomogramRouting::Tomogram.craft(Esplanade.configuration.tomogram)
+      @documentation = Tomograph::Tomogram.new(
+        prefix: Esplanade.configuration.prefix,
+        apib_path: Esplanade.configuration.apib_path,
+        drafter_yaml_path: Esplanade.configuration.drafter_yaml_path
+      )
     end
 
     def call(env)
-      valid!(env)
-    rescue Request::NotDocumented
-      Request::Error.not_documented
-    rescue Response::NotDocumented
-      Response::Error.not_documented
-    rescue Request::Unsuitable => e
-      Request::Error.unsuitable(e.message)
-    rescue Response::Unsuitable => e
-      Response::Error.unsuitable(e.message)
-    end
-
-    def valid!(env)
-      request = Request.new(env, @tomogram)
-      request.valid! if request.validate?
       status, headers, body = @app.call(env)
-      response = Response.new(status, body, request.schema)
-      response.valid! if response.validate?
       [status, headers, body]
     end
   end

data/lib/esplanade/request.rb

@@ -1,31 +1,29 @@
-require 'json-schema'
+require 'esplanade/request/doc'
+require 'esplanade/request/raw'
+require 'esplanade/request/validation'
 
 module Esplanade
   class Request
-    attr_accessor :path, :method, :body, :schema
+    class Error < Esplanade::Error; end
+    class NotDocumented < Error; end
+    class BodyIsNotJson < Error; end
+    class Invalid       < Error; end
 
-    class Unsuitable < RuntimeError; end
-    class NotDocumented < RuntimeError; end
-
-    def initialize(env, tomogram)
-      @method = env['REQUEST_METHOD']
-      @path = env['PATH_INFO']
-      @body = Body.craft(env)
-      @schema = tomogram.find_request(method: @method, path: @path)
-      raise NotDocumented unless schema || Esplanade.configuration.skip_not_documented
-      self
+    def initialize(documentation, env)
+      @documentation = documentation
+      @env = env
     end
 
-    def error
-      JSON::Validator.fully_validate(@schema['request'], @body)
+    def doc
+      @doc ||= Doc.new(@documentation, raw)
     end
 
-    def valid!
-      raise Unsuitable, error unless error.empty?
+    def raw
+      @raw ||= Raw.new(@env)
     end
 
-    def validate?
-      @schema && Esplanade.configuration.validation_requests
+    def validation
+      @validation || Validation.new(doc, raw)
     end
   end
 end

data/lib/esplanade/request/doc.rb

@@ -0,0 +1,43 @@
+module Esplanade
+  class Request
+    class Doc
+      def initialize(main_documentation, raw)
+        @main_documentation = main_documentation
+        @raw = raw
+      end
+
+      def tomogram
+        @tomogram ||= @main_documentation.find_request(method: @raw.method, path: @raw.path)
+        raise NotDocumented, message if @tomogram.nil?
+        @tomogram
+      end
+
+      def json_schema
+        @json_schema ||= tomogram.request
+      end
+
+      def method
+        @method ||= tomogram.method
+      end
+
+      def path
+        @path ||= tomogram.path.to_s
+      end
+
+      def responses
+        @responses ||= tomogram.responses
+      rescue NotDocumented
+        []
+      end
+
+      private
+
+      def message
+        {
+          method: @raw.method,
+          path: @raw.path
+        }
+      end
+    end
+  end
+end

data/lib/esplanade/request/raw.rb

@@ -0,0 +1,23 @@
+require 'esplanade/request/raw/body'
+
+module Esplanade
+  class Request
+    class Raw
+      def initialize(env)
+        @env = env
+      end
+
+      def method
+        @method ||= @env['REQUEST_METHOD']
+      end
+
+      def path
+        @path ||= @env['PATH_INFO']
+      end
+
+      def body
+        @body ||= Body.new(self, @env)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'multi_json'
+
+module Esplanade
+  class Request
+    class Raw
+      class Body
+        def initialize(raw_request, env)
+          @raw_request = raw_request
+          @env = env
+        end
+
+        def to_string
+          @string ||= @env['rack.request.form_vars']
+        end
+
+        def to_hash
+          @hash ||= MultiJson.load(to_string)
+        rescue MultiJson::ParseError
+          raise BodyIsNotJson, message
+        end
+
+        private
+
+        def message
+          {
+            method: @raw_request.method,
+            path: @raw_request.path,
+            body: to_string
+          }
+        end
+      end
+    end
+  end
+end

data/lib/esplanade/request/validation.rb

@@ -0,0 +1,29 @@
+require 'json-schema'
+require 'esplanade/error'
+
+module Esplanade
+  class Request
+    class Validation
+      def initialize(doc, raw)
+        @doc = doc
+        @raw = raw
+      end
+
+      def valid!
+        @error ||= JSON::Validator.fully_validate(@doc.json_schema, @raw.body.to_hash)
+        raise Invalid, message if @error != []
+      end
+
+      private
+
+      def message
+        {
+          method: @raw.method,
+          path: @raw.path,
+          body: @raw.body.to_string,
+          error: @error
+        }
+      end
+    end
+  end
+end

data/lib/esplanade/response.rb

@@ -1,38 +1,32 @@
-require 'json-schema'
+require 'esplanade/response/doc'
+require 'esplanade/response/raw'
+require 'esplanade/response/validation'
 
 module Esplanade
   class Response
-    attr_accessor :status, :body, :schemas
+    class Error < Esplanade::Error; end
+    class NotDocumented < Error; end
+    class BodyIsNotJson < Error; end
+    class Invalid       < Error; end
 
-    class Unsuitable < RuntimeError; end
-    class NotDocumented < RuntimeError; end
+    attr_reader :request
 
-    def initialize(status, body, expect_request)
-      return unless Esplanade.configuration.validation_response && expect_request
+    def initialize(request, status, raw_body)
+      @request = request
       @status = status
-      @body = Body.craft(body)
-      @schemas = expect_request.find_responses(status: @status)
-      raise NotDocumented unless (@schemas&.first) || Esplanade.configuration.skip_not_documented
-      self
+      @raw_body = raw_body
     end
 
-    def error
-      return JSON::Validator.fully_validate(@schemas.first['body'], @body) if @schemas.size == 1
-
-      @schemas.each do |action|
-        res = JSON::Validator.fully_validate(action['body'], @body)
-        return res if res == []
-      end
-
-      ['invalid']
+    def doc
+      @doc ||= Doc.new(@request, raw)
     end
 
-    def valid!
-      raise Unsuitable, error unless error.empty?
+    def raw
+      @raw ||= Raw.new(@request, @status, @raw_body)
     end
 
-    def validate?
-      @schemas&.first && Esplanade.configuration.validation_response
+    def validation
+      @validation ||= Validation.new(@request, doc, raw)
     end
   end
 end

data/lib/esplanade/response/doc.rb

@@ -0,0 +1,36 @@
+module Esplanade
+  class Response
+    class Doc
+      def initialize(request, raw)
+        @request = request
+        @raw = raw
+      end
+
+      def tomogram
+        @tomogram ||= @request.doc.responses.find_all { |response| response['status'] == @raw.status }
+        raise NotDocumented, message if @tomogram == []
+        @tomogram
+      end
+
+      def json_schemas
+        @json_schemas ||= tomogram.map { |action| action['body'] }
+      end
+
+      def status
+        @status ||= tomogram['status']
+      end
+
+      private
+
+      def message
+        {
+          request: {
+            method: @request.raw.method,
+            path: @request.raw.path
+          },
+          status: @raw.status
+        }
+      end
+    end
+  end
+end

data/lib/esplanade/response/raw.rb

@@ -0,0 +1,21 @@
+require 'esplanade/response/raw/body'
+
+module Esplanade
+  class Response
+    class Raw
+      def initialize(request, raw_status, raw_body)
+        @request = request
+        @raw_status = raw_status
+        @raw_body = raw_body
+      end
+
+      def status
+        @status ||= @raw_status.to_s
+      end
+
+      def body
+        @body ||= Body.new(@request, self, @raw_body)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'multi_json'
+
+module Esplanade
+  class Response
+    class Raw
+      class Body
+        def initialize(request, raw_response, raw_body)
+          @request = request
+          @raw_response = raw_response
+          @raw_body = raw_body
+        end
+
+        def to_string
+          @string ||= @raw_body.body rescue nil
+          @string ||= @raw_body.first rescue nil
+        end
+
+        def to_hash
+          @hash ||= MultiJson.load(to_string)
+        rescue MultiJson::ParseError
+          raise BodyIsNotJson, message
+        end
+
+        private
+
+        def message
+          {
+            request: {
+              method: @request.raw.method,
+              path: @request.raw.path
+            },
+            status: @raw_response.status,
+            body: @raw_response.body.to_string
+          }
+        end
+      end
+    end
+  end
+end

data/lib/esplanade/response/validation.rb

@@ -0,0 +1,52 @@
+require 'json-schema'
+
+module Esplanade
+  class Response
+    class Validation
+      def initialize(request, doc, raw)
+        @request = request
+        @doc = doc
+        @raw = raw
+      end
+
+      def valid!
+        @error ||= if @doc.json_schemas.size == 1
+                     one_json_schema
+                   else
+                     more_than_one_json_schema
+                   end
+        raise Invalid, message if @error != []
+      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 message
+        {
+          request: {
+            method: @request.raw.method,
+            path: @request.raw.path
+          },
+          status: @raw.status,
+          body: @raw.body.to_string,
+          error: @error
+        }
+      end
+    end
+  end
+end

data/lib/esplanade/version.rb

@@ -1,3 +1,3 @@
 module Esplanade
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esplanade
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -51,25 +51,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.6.2
 - !ruby/object:Gem::Dependency
-  name: tomogram_routing
+  name: tomograph
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +188,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -198,14 +199,18 @@ files:
 - esplanade.gemspec
 - lib/esplanade.rb
 - lib/esplanade/configuration.rb
+- lib/esplanade/error.rb
 - lib/esplanade/middleware.rb
-- lib/esplanade/railtie.rb
 - lib/esplanade/request.rb
-- lib/esplanade/request/body.rb
-- lib/esplanade/request/error.rb
+- lib/esplanade/request/doc.rb
+- lib/esplanade/request/raw.rb
+- lib/esplanade/request/raw/body.rb
+- lib/esplanade/request/validation.rb
 - lib/esplanade/response.rb
-- lib/esplanade/response/body.rb
-- lib/esplanade/response/error.rb
+- lib/esplanade/response/doc.rb
+- lib/esplanade/response/raw.rb
+- lib/esplanade/response/raw/body.rb
+- lib/esplanade/response/validation.rb
 - lib/esplanade/version.rb
 homepage: 
 licenses:
@@ -227,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Validate requests and responses against API Blueprint specifications

data/lib/esplanade/railtie.rb

@@ -1,7 +0,0 @@
-module Esplanade
-  class Railtie < Rails::Railtie
-    initializer 'esplanade.insert_middleware' do |app|
-      app.config.middleware.use Esplanade::Middleware
-    end
-  end
-end

data/lib/esplanade/request/body.rb

@@ -1,14 +0,0 @@
-module Esplanade
-  class Request
-    class Body < Hash
-      private_class_method :new
-
-      def self.craft(env)
-        params_string = env['rack.input'].read
-        params_hash = {}
-        params_hash = MultiJson.load(params_string) unless params_string == ''
-        new.merge(params_hash)
-      end
-    end
-  end
-end

data/lib/esplanade/request/error.rb

@@ -1,19 +0,0 @@
-module Esplanade
-  class Request
-    class Error
-      def self.unsuitable(message)
-        status = '400'
-        headers = { 'Content-Type' => 'application/json; charset=utf-8' }
-        body = [MultiJson.dump(error: [message[2..-3]])]
-        [status, headers, body]
-      end
-
-      def self.not_documented
-        status = '400'
-        headers = { 'Content-Type' => 'application/json; charset=utf-8' }
-        body = [MultiJson.dump(error: ['Not documented'])]
-        [status, headers, body]
-      end
-    end
-  end
-end

data/lib/esplanade/response/body.rb

@@ -1,32 +0,0 @@
-module Esplanade
-  class Response
-    class Body < Hash
-      class << self
-        private_class_method :new
-
-        def craft(body)
-          # According to specification Rack http://rack.github.io
-          # body can only answer each
-          lines = []
-          body.each { |line| lines.push(line) }
-          lines_to_json(lines)
-        end
-
-        private
-
-        def lines_to_json(lines)
-          if lines.join.empty?
-            {}
-          else
-            res = lines.join('\n')
-            begin
-              MultiJson.load(res)
-            rescue MultiJson::ParseError
-              res
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/esplanade/response/error.rb

@@ -1,19 +0,0 @@
-module Esplanade
-  class Response
-    class Error
-      def self.unsuitable(message)
-        status = '500'
-        headers = { 'Content-Type' => 'application/json; charset=utf-8' }
-        body = [MultiJson.dump(error: [message[2..-3]])]
-        [status, headers, body]
-      end
-
-      def self.not_documented
-        status = '500'
-        headers = { 'Content-Type' => 'application/json; charset=utf-8' }
-        body = [MultiJson.dump(error: ['Not documented'])]
-        [status, headers, body]
-      end
-    end
-  end
-end