fitting 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d1997d69b352bcdbba93f00c3e50cba25eb4d70
-  data.tar.gz: c39ea9c0cc9ee2c81d506f83c4f85ab614accb4f
+  metadata.gz: 587fd41b2b12c20bbacc053f70f7e9f7daa1f866
+  data.tar.gz: db1f83a7fd72f7d556bb43b957d1de236b76f5ea
 SHA512:
-  metadata.gz: 68b687226ff3b178bb8fb774cc011a4c5a285ee13b246362dab05e15a71b18bbfee1b406a7f9a88494c8bd7a786fad4b43373382fa93495d3d86dc9cffa37402
-  data.tar.gz: 74928dc7e164fdad8fd68bc96fcf88753665cb49024fbb56db5bf68f706385f8a492254c4b1efec7960fbd6c0188a5264faca35af20e015bc2b78667fd272898
+  metadata.gz: c637ed7b9d401ee99b08b59cd2934f147fb64d55dc24f0f9c7572632695e9280af1aaf849876cbaf3c1d95dfcbd1252c64b5b0c5cd184c710d3d1e21d470b8ec
+  data.tar.gz: ba647de857ecf54c62b169b10d60884666a2847d71764131f96a7d78fcbbfc0bc84fa85f9c9775ea9d8ad364b1cedd2ec9e9ffcce377d5e0d4d21777b1d706f2

data/README.md

@@ -2,9 +2,8 @@
 
 [![Build Status](https://travis-ci.org/funbox/fitting.svg?branch=master)](https://travis-ci.org/funbox/fitting)
 
-This gem will help to make your tests according to the documentation for the API.
-
-When writing tests, you can be sure that the implement API in accordance with documentation on API Blueprint.
+This gem will help to realize your API in strict accordance with the documentation in the format API Bluprint.
+To do this, when you run your RSpes tests on the controller, in the documentation automatically searches for the json-schema and then validate it with a response in the test.
 
 ## Installation
 
@@ -27,40 +26,81 @@ Or install it yourself as:
 In your `spec_helper.rb`:
 
 ```ruby
-config.include JSON::SchemaMatchers
+  Fitting.configure do |config|
+    config.apib_path = `doc.apib`
+  end
 ```
 
-This gem takes a simplified format json convert from API Blueprint which we have called API Tomogram.
-
-Use gem [tomograph](https://github.com/funbox/tomograph)
+## Example output
 
-```ruby
-  Fitting.configure do |config|
-    config.tomogram = 'tomogram.json'
-  end
+After running tests you will get statistics in the console.
 
+```
+Fully conforming requests:
+DELETE  /api/v1/book                 ✔ 200 ✔ 201 ✔ 404
+DELETE  /api/v1/book/{id}            ✔ 200 ✔ 201 ✔ 404
+GET     /api/v1/book/{id}/seller     ✔ 200 ✔ 201 ✔ 404
+ 
+Partially conforming requests:
+GET     /api/v1/book                 ✖ 200 ✔ 404
+POST    /api/v1/book                 ✖ 200 ✔ 201 ✔ 404
+GET     /api/v1/book/{id}            ✖ 200 ✔ 404 ✔ 200
+PATCH   /api/v1/book/{id}            ✖ 200 ✔ 201 ✔ 404
+ 
+Non-conforming requests:
+GET     /api/v1/seller               ✖ 200 ✖ 201 ✖ 404
+GET     /api/v1/buyer                ✖ 200 ✖ 404
+ 
+API requests with fully implemented responses: 3 (33.33% of 9).
+API requests with partially implemented responses: 4 (44.44% of 9).
+API requests with no implemented responses: 2 (22.22% of 9).
+ 
+API responses conforming to the blueprint: 16 (64.00% of 25).
+API responses with validation errors or untested: 9 (36.00% of 25).
 ```
 
-You can then write tests such as:
+## Matchers
 
-```ruby
- expect(response).to match_response
+If you want know describe why you get crosses instead of checkmarks you can use matchers for RSpec.
+
+### match_response
+
+Makes a simple validation JSON Schema.
+
+```
+expect(response).to match_response
 ```
 
-If you want check all tests:
+### strict_match_response
 
-```ruby
-config.after(:each, :type => :controller) do
-  expect(response).to match_response
-end
+Makes a strict validation JSON Schema. All properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
+
+```
+expect(response).to strict_match_response
 ```
 
 ## Config
 
+### apib_path
+
+Path for API Blueprint documentation. There must be an installed library [drafter](https://github.com/apiaryio/drafter).
+
+### drafter_yaml_path
+
+Path for API Blueprint documentation after use drafter and transformation in yaml.
+
 ### necessary_fully_implementation_of_responses
 
 Default `true`. It returns `exit 1` if not implemented all(with tests expect match response) the responses.
 
+### strict
+
+Default `false`. If `true` than all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
+
+### prefix
+
+Prefix for request.
+
 ### white_list
 
 Default all resources. This is an array of resources that are mandatory for implementation.
@@ -78,10 +118,16 @@ config.white_list = {
 
 Empty array `[]` means all methods.
 
+Result be two statistic for two list.
+
 ### create_report_with_name
 
 Create report with name.
 
+### show_statistics_in_console
+
+Default `true`.
+
 ## Report
 
 Autogenerate `report_request_by_response.yaml` and `report_response.yaml reports`.

data/fitting.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'tomogram_routing', '~> 0.1', '>= 0.1.0'
   spec.add_runtime_dependency 'multi_json'
   spec.add_runtime_dependency 'rspec-core', '~> 3.0', '>= 3.0.0'
+  spec.add_runtime_dependency 'tomograph', '~> 0.4', '>= 0.4.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/fitting/configuration.rb

@@ -1,12 +1,20 @@
 module Fitting
   class Configuration
-    attr_accessor :tomogram,
+    attr_accessor :apib_path,
+                  :drafter_yaml_path,
                   :necessary_fully_implementation_of_responses,
+                  :strict,
+                  :prefix,
                   :white_list,
-                  :create_report_with_name
+                  :create_report_with_name,
+                  :tomogram,
+                  :show_statistics_in_console
 
     def initialize
       @necessary_fully_implementation_of_responses = true
+      @strict = false
+      @prefix = ''
+      @show_statistics_in_console = true
     end
   end
 end

data/lib/fitting/documentation.rb

@@ -30,7 +30,7 @@ module Fitting
     end
 
     def all
-      @all ||= MultiJson.load(@tomogram).inject([]) do |routes, request|
+      @all ||= @tomogram.inject([]) do |routes, request|
         request['responses'].inject({}) do |responses, response|
           responses[response['status']] ||= 0
           responses[response['status']] += 1

data/lib/fitting/matchers/response_matcher.rb

@@ -1,5 +1,4 @@
 require 'fitting/response'
-require 'fitting/storage/responses'
 require 'fitting/storage/documentation'
 
 module Fitting
@@ -10,8 +9,7 @@ module Fitting
           response,
           Fitting::Storage::Documentation.tomogram
         )
-        Fitting::Storage::Responses.push(@response)
-        @response.valid?
+        @response.fully_validates.valid?
       end
 
       def ===(other)
@@ -24,11 +22,39 @@ module Fitting
                  "got: #{@response.real_request_with_status}"
         end
 
-        unless @response.valid?
+        unless @response.fully_validates.valid?
           "response does not conform to json-schema\n"\
           "schemas: \n#{@response.expected}\n\n"\
           "got: #{@response.got}\n\n"\
-          "errors: \n#{@response.diff}\n"
+          "errors: \n#{@response.fully_validates}\n"
+        end
+      end
+    end
+
+    class StrictResponse
+      def matches?(response)
+        @response = Fitting::Response.new(
+          response,
+          Fitting::Storage::Documentation.tomogram
+        )
+        @response.strict_fully_validates.valid?
+      end
+
+      def ===(other)
+        matches?(other)
+      end
+
+      def failure_message
+        unless @response.documented?
+          return "response not documented\n"\
+                 "got: #{@response.real_request_with_status}"
+        end
+
+        unless @response.strict_fully_validates.valid?
+          "response does not conform to json-schema\n"\
+          "schemas: \n#{@response.expected}\n\n"\
+          "got: #{@response.got}\n\n"\
+          "errors: \n#{@response.strict_fully_validates}\n"
         end
       end
     end
@@ -36,5 +62,9 @@ module Fitting
     def match_response
       Response.new
     end
+
+    def strict_match_response
+      StrictResponse.new
+    end
   end
 end

data/lib/fitting/response/fully_validates.rb

@@ -0,0 +1,26 @@
+require 'json-schema'
+
+module Fitting
+  class Response
+    class FullyValidates < Array
+      def self.craft(schemas, body, strict)
+        if schemas
+          new(schemas.inject([]) do |res, schema|
+            res.push(JSON::Validator.fully_validate(schema, body, :strict => strict))
+          end)
+        else
+          @valid = false
+          new
+        end
+      end
+
+      def valid?
+        @valid ||= any? { |fully_validate| fully_validate == [] }
+      end
+
+      def to_s
+        @to_s ||= join("\n\n")
+      end
+    end
+  end
+end

data/lib/fitting/response.rb

@@ -1,39 +1,35 @@
 require 'fitting/request'
-require 'json-schema'
+require 'fitting/response/fully_validates'
 
 module Fitting
   class Response
     def initialize(env_response, tomogram)
-      @request = Request.new(env_response.request, tomogram)
+      @request = Fitting::Request.new(env_response.request, tomogram)
       @status = env_response.status
       @body = env_response.body
       @schemas = @request.schemas_of_possible_responses(status: @status)
-      @fully_validates = set_fully_validate if @schemas
     end
 
-    def set_fully_validate
-      @valid = false
-      fully_validates = []
-      @schemas.map do |old_schema|
-        fully_validate = JSON::Validator.fully_validate(old_schema, @body)
-        fully_validates.push(fully_validate)
-        @valid = true if fully_validate == []
-      end
-      fully_validates
+    def fully_validates
+      @fully_validates ||= Fitting::Response::FullyValidates.craft(@schemas, @body, false)
     end
 
-    def documented?
-      @schemas && @schemas.present?
+    def strict_fully_validates
+      @strict_fully_validates ||= Fitting::Response::FullyValidates.craft(@schemas, @body, true)
     end
 
-    def valid?
-      @valid == true
+    def documented?
+      @schemas && @schemas.present?
     end
 
     def route
       "#{@request.route} #{@status} #{index}"
     end
 
+    def strict_route
+      "#{@request.route} #{@status} #{strict_index}"
+    end
+
     def real_request_with_status
       "#{@request.real_method_with_path} #{@status}"
     end
@@ -42,12 +38,6 @@ module Fitting
       @body
     end
 
-    def diff
-      @fully_validates.inject("") do |res, fully_validate|
-        res + "#{fully_validate.join("\n")}\n\n"
-      end
-    end
-
     def expected
       @schemas.inject([]) do |res, schema|
         res.push("#{schema}")
@@ -58,7 +48,15 @@ module Fitting
 
     def index
       @schemas.size.times do |i|
-        if @fully_validates[i] == []
+        if fully_validates[i] == []
+          return i
+        end
+      end
+    end
+
+    def strict_index
+      @schemas.size.times do |i|
+        if strict_fully_validates[i] == []
           return i
         end
       end

data/lib/fitting/route/coverage.rb

@@ -2,9 +2,10 @@ require 'multi_json'
 module Fitting
   class Route
     class Coverage
-      def initialize(coverage_responses, responses_routes)
+      def initialize(coverage_responses, responses_routes, strict)
         @coverage_responses = coverage_responses
         @responses_routes = responses_routes
+        @strict = strict
       end
 
       def coverage
@@ -29,9 +30,15 @@ module Fitting
       private
 
       def full_coverage
-        @coverage_responses.map do |response|
-          response.route if response.documented? && response.valid?
-        end.compact.uniq
+        if @strict
+          @coverage_responses.map do |response|
+            response.strict_route if response.documented? && response.strict_fully_validates.valid?
+          end.compact.uniq
+        else
+          @coverage_responses.map do |response|
+            response.route if response.documented? && response.fully_validates.valid?
+          end.compact.uniq
+        end
       end
     end
   end

data/lib/fitting/route.rb

@@ -4,8 +4,8 @@ require 'fitting/route/responses'
 
 module Fitting
   class Route
-    def initialize(all_responses, routes)
-      coverage = Fitting::Route::Coverage.new(all_responses, routes)
+    def initialize(all_responses, routes, strict)
+      coverage = Fitting::Route::Coverage.new(all_responses, routes, strict)
       @requests = Fitting::Route::Requests.new(coverage)
       @responses = Fitting::Route::Responses.new(routes, coverage)
     end

data/lib/fitting/statistics.rb

@@ -2,10 +2,10 @@ require 'fitting/route'
 
 module Fitting
   class Statistics
-    def initialize(documentation, all_responses)
+    def initialize(documentation, all_responses, strict)
       @documentation = documentation
-      @black_route = Fitting::Route.new(all_responses, @documentation.black)
-      @white_route = Fitting::Route.new(all_responses, @documentation.white)
+      @black_route = Fitting::Route.new(all_responses, @documentation.black, strict)
+      @white_route = Fitting::Route.new(all_responses, @documentation.white, strict)
     end
 
     def not_coverage?
@@ -19,7 +19,7 @@ module Fitting
     def to_s
       if @documentation.black.any?
         [
-          ['[Black list]', @black_route.statistics].join("\n"),
+          ['[Black list]', @black_route.statistics_with_conformity_lists].join("\n"),
           ['[White list]', @white_route.statistics_with_conformity_lists].join("\n"),
           ""
         ].join("\n\n")

data/lib/fitting/storage/documentation.rb

@@ -1,12 +1,29 @@
 require 'tomogram_routing'
 require 'fitting/configuration'
+require 'tomograph'
 
 module Fitting
   module Storage
     module Documentation
       class << self
         def tomogram
-          @tomogram ||= TomogramRouting::Tomogram.craft(Fitting.configuration.tomogram)
+          @tomogram ||= if Fitting.configuration.apib_path
+            @yaml ||= `drafter #{Fitting.configuration.apib_path}`
+            Tomograph.configure do |config|
+              config.drafter_yaml = @yaml
+              config.prefix = Fitting.configuration.prefix
+            end
+            TomogramRouting::Tomogram.craft(Tomograph::Tomogram.json)
+          elsif Fitting.configuration.tomogram
+            # legacy
+            TomogramRouting::Tomogram.craft(Fitting.configuration.tomogram)
+          else
+            Tomograph.configure do |config|
+              config.documentation = Fitting.configuration.drafter_yaml_path
+              config.prefix = Fitting.configuration.prefix
+            end
+            TomogramRouting::Tomogram.craft(Tomograph::Tomogram.json)
+          end
         end
       end
     end

data/lib/fitting/version.rb

@@ -1,3 +1,3 @@
 module Fitting
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/lib/fitting.rb

@@ -6,6 +6,7 @@ require 'fitting/matchers/response_matcher'
 require 'rspec/core'
 require 'fitting/statistics'
 require 'fitting/documentation'
+require 'fitting/storage/responses'
 
 ERROR_EXIT_CODE = 1
 
@@ -33,16 +34,18 @@ module RSpec
         return returned_exit_code if Fitting::Storage::Skip.get
 
         statistics = Fitting::Statistics.new(
-          Fitting::Documentation.new(Fitting.configuration.tomogram, Fitting.configuration.white_list),
-          Fitting::Storage::Responses.all)
-        puts statistics
+          Fitting::Documentation.new(Fitting::Storage::Documentation.tomogram, Fitting.configuration.white_list),
+          Fitting::Storage::Responses.all,
+          Fitting.configuration.strict
+        )
+        puts statistics if Fitting.configuration.show_statistics_in_console
         if Fitting.configuration.create_report_with_name
           statistics.save(Fitting.configuration.create_report_with_name)
         end
 
         if Fitting.configuration.necessary_fully_implementation_of_responses &&
           returned_exit_code == 0 &&
-          response.not_coverage?
+          statistics.not_coverage?
           return ERROR_EXIT_CODE
         end
         returned_exit_code
@@ -50,3 +53,12 @@ module RSpec
     end
   end
 end
+
+RSpec.configure do |config|
+  config.after(:each, :type => :controller) do
+    Fitting::Storage::Responses.push(
+      Fitting::Response.new(
+        response,
+        Fitting::Storage::Documentation.tomogram))
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -84,6 +84,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: tomograph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -216,6 +236,7 @@ files:
 - lib/fitting/matchers/response_matcher.rb
 - lib/fitting/request.rb
 - lib/fitting/response.rb
+- lib/fitting/response/fully_validates.rb
 - lib/fitting/route.rb
 - lib/fitting/route/coverage.rb
 - lib/fitting/route/requests.rb