fitting 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 587fd41b2b12c20bbacc053f70f7e9f7daa1f866
-  data.tar.gz: db1f83a7fd72f7d556bb43b957d1de236b76f5ea
+  metadata.gz: c4da6330584b695ce8964a021a89fbf7e5d6c73e
+  data.tar.gz: 5972f7305b5eaf446e738d6bf3d68dda0772c804
 SHA512:
-  metadata.gz: c637ed7b9d401ee99b08b59cd2934f147fb64d55dc24f0f9c7572632695e9280af1aaf849876cbaf3c1d95dfcbd1252c64b5b0c5cd184c710d3d1e21d470b8ec
-  data.tar.gz: ba647de857ecf54c62b169b10d60884666a2847d71764131f96a7d78fcbbfc0bc84fa85f9c9775ea9d8ad364b1cedd2ec9e9ffcce377d5e0d4d21777b1d706f2
+  metadata.gz: 14b06b29a08066358392409e23dd9813d6a8fdaede35aa7b975356064266be5e32d6a0ed3f27931f80c636a884252cc8c972a40b0c1f227804768d5c4a3171b4
+  data.tar.gz: 8200a2a160af99edf0b163157f0db626241361100770e2915cb19f39b622efe43bf8cd26560f00b25b04d6b46e21d1235552543b856296b5e30240a2cf041979

data/README.md

@@ -2,8 +2,8 @@
 
 [![Build Status](https://travis-ci.org/funbox/fitting.svg?branch=master)](https://travis-ci.org/funbox/fitting)
 
-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.
+This gem will help you implement your API in strict accordance to the documentation in [API Bluprint](https://apiblueprint.org/) format.
+To do this, when you run your RSpec tests on controllers, it automatically searches for the corresponding json-schemas in the documentation and then validates responses with them.
 
 ## Installation
 
@@ -27,55 +27,59 @@ In your `spec_helper.rb`:
 
 ```ruby
   Fitting.configure do |config|
-    config.apib_path = `doc.apib`
+    config.apib_path = '/path/to/doc.apib'
   end
 ```
 
 ## Example output
 
-After running tests you will get statistics in the console.
+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).
 ```
 
 ## Matchers
 
-If you want know describe why you get crosses instead of checkmarks you can use matchers for RSpec.
+If you want to know why you get crosses instead of checkmarks you can use matchers for RSpec.
+
+```ruby
+config.include Fitting::Matchers, type: :controller
+```
 
 ### match_response
 
-Makes a simple validation JSON Schema.
+Makes a simple validation against JSON Schema.
 
-```
+```ruby
 expect(response).to match_response
 ```
 
 ### strict_match_response
 
-Makes a strict validation JSON Schema. All properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
+Makes a strict validation against JSON Schema. All properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
 
-```
+```ruby
 expect(response).to strict_match_response
 ```
 
@@ -83,29 +87,29 @@ expect(response).to strict_match_response
 
 ### apib_path
 
-Path for API Blueprint documentation. There must be an installed library [drafter](https://github.com/apiaryio/drafter).
+Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
 
 ### drafter_yaml_path
 
-Path for API Blueprint documentation after use drafter and transformation in yaml.
+Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
 ### necessary_fully_implementation_of_responses
 
-Default `true`. It returns `exit 1` if not implemented all(with tests expect match response) the responses.
+Default `true`. It returns `exit 1` if not all responses are implemented according to the documentation. For this to work, `match_response` (see above) should run.
 
 ### strict
 
-Default `false`. If `true` than all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
+Default `false`. If `true` then all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
 
 ### prefix
 
-Prefix for request.
+Prefix of API requests. Example: `'/api'`.
 
 ### white_list
 
-Default all resources. This is an array of resources that are mandatory for implementation.
-This list does not affect the work of the match expert.
-This list is only for the report in the console and verify implementation.
+Default: all resources. This is an array of resources that are mandatory for implementation.
+This list does not affect the work of the matcher.
+This list is only for the report in the console.
 
 ```ruby
 config.white_list = {
@@ -118,20 +122,14 @@ config.white_list = {
 
 Empty array `[]` means all methods.
 
-Result be two statistic for two list.
-
 ### create_report_with_name
 
-Create report with name.
+File name for the report.
 
 ### show_statistics_in_console
 
 Default `true`.
 
-## Report
-
-Autogenerate `report_request_by_response.yaml` and `report_response.yaml reports`.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/funbox/fitting. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/fitting.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['d.efimov@fun-box.ru']
 
   spec.summary       = 'Validation in the rspec of API Blueprint'
-  spec.description   = 'Validation requests and responses in the rspec with the help of API Blueprint'
+  spec.description   = 'Validation responses in the rspec with the help of API Blueprint'
   spec.homepage      = 'https://github.com/funbox/fitting'
   spec.license       = 'MIT'
 

data/lib/fitting/route.rb

@@ -5,9 +5,13 @@ require 'fitting/route/responses'
 module Fitting
   class Route
     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)
+      @coverage = Fitting::Route::Coverage.new(all_responses, routes, strict)
+      @requests = Fitting::Route::Requests.new(@coverage)
+      @responses = Fitting::Route::Responses.new(routes, @coverage)
+    end
+
+    def not_coverage?
+      @coverage.not_coverage.present?
     end
 
     def statistics

data/lib/fitting/statistics.rb

@@ -9,7 +9,7 @@ module Fitting
     end
 
     def not_coverage?
-      @white_route.not_coverage.present?
+      @white_route.not_coverage?
     end
 
     def save(name)

data/lib/fitting/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2017-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -212,7 +212,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.43.0
-description: Validation requests and responses in the rspec with the help of API Blueprint
+description: Validation responses in the rspec with the help of API Blueprint
 email:
 - d.efimov@fun-box.ru
 executables: []