fitting 2.11.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9fe2c40a89499b32b2a4989a88cb8d294c420191
-  data.tar.gz: cd0deaa0b1fb6003bc6c58054def0843fa22e656
+SHA256:
+  metadata.gz: 036f174c7154d494520197fefae664cf6086fb47feaad76f091d25f194016ce8
+  data.tar.gz: 339e5f12a4a85e86f10bb112bdf23231d9f0af5bbc6a2fba0145f344a37802da
 SHA512:
-  metadata.gz: 1e2e177b230a274a1e53d2eb525f6f59f89ffcdcc9ae4392183f0021ae727f3a4d48499dd870bf853ea49a21d7eeec00c9196f1659506348d14dae07287688e3
-  data.tar.gz: a4ae0ec1d99a3f6b9d9e9fd10bcdeaf592be1335ada092481dece76250da9caa5f4f3cf084d290f792bb16fa897fe361a0967c4c739f918fcedb53a4e8d3bac9
+  metadata.gz: dde3886c4f56bcab60b00f91f0a3c129676f430b2c3c5c3687a08fe28c207474e3076d21780e8f9adb2a2c6f6e0bc02f490a4101d77394ed2d92ec5f9687f9cd
+  data.tar.gz: f2d6bc93bed0cfe10d0fadb3bb528e837cb4b9867e479991e2f71f772f961113a937c9559903435b55b64d3c2993a275872b804f31fb09c077d252db7d9fb8b2

data/.gitignore

@@ -9,4 +9,3 @@
 /tmp/
 .idea/
 .byebug_history
-.tool-versions

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.3
 
 Metrics/LineLength:
   Max: 120

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.3.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.3.0

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,5 +1,52 @@
 # Change log
 
+### 2.14.0 - 2020-09-18
+
+* features
+  * save tests for all prefixes [#35](https://github.com/funbox/fitting/issues/35)
+  * prefix checking [#37](https://github.com/funbox/fitting/issues/37)
+  * html view for prefix checking [#39](https://github.com/funbox/fitting/issues/39)
+  * add actions join in new html report [#41](https://github.com/funbox/fitting/issues/41)
+  * add responses join in new report [#43](https://github.com/funbox/fitting/issues/43)
+  * add combinations join in new report [#47](https://github.com/funbox/fitting/issues/47)
+  * add action page [#49](https://github.com/funbox/fitting/issues/49)
+  * show more information in new report [#51](https://github.com/funbox/fitting/issues/51)
+  * add accordion for prefixes [#55](https://github.com/funbox/fitting/issues/55)
+  * move json-schemas to separate files [#57](https://github.com/funbox/fitting/issues/57)
+  * add method for tests without actions [#61](https://github.com/funbox/fitting/issues/61)
+  * show tests without responses [#63](https://github.com/funbox/fitting/issues/63)
+  * add console output for new report [#69](https://github.com/funbox/fitting/issues/69)
+  * check test in new console [#71](https://github.com/funbox/fitting/issues/71)
+* fixes
+  * fix vulnerability CVE-2020-7660 [#53](https://github.com/funbox/fitting/issues/53)
+  * fix cover if response without combinations [#59](https://github.com/funbox/fitting/issues/59)
+  * fix cover if combinations without tests [#66](https://github.com/funbox/fitting/issues/66)
+  * do not check tests without combinations [#73](https://github.com/funbox/fitting/issues/73)
+
+### 2.13.1 - 2020-04-17
+
+* fixes
+  * combinations
+
+### 2.13.0 - 2020-02-26
+
+* features
+  * use request tests
+
+* patch
+  * improve combination name for enum cover
+  * improve combination name for required cover
+
+### 2.12.1 - 2020-02-07
+
+* fixes
+  * oneOf
+
+### 2.12.0 - 2019-09-10
+
+* features
+  * Add l size (for cover oneOf in json-schema) in rake tasks fitting:documentation_responses, fitting:documentation_responses_error
+
 ### 2.11.0 - 2019-09-09
 
 * features

data/README.md

@@ -1,40 +1,42 @@
 # Fitting
 
-<a href="https://funbox.ru">
-  <img src="https://funbox.ru/badges/sponsored_by_funbox_compact.svg" alt="Sponsored by FunBox" width=250 />
-</a>
-
 [![Gem Version](https://badge.fury.io/rb/fitting.svg)](https://badge.fury.io/rb/fitting)
 [![Build Status](https://travis-ci.org/funbox/fitting.svg?branch=master)](https://travis-ci.org/funbox/fitting)
 
 This gem will help you implement your API in strict accordance to the documentation in [API Blueprint](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.
+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
 
-Add this line to your application's Gemfile:
+First you need to install [drafter](https://github.com/apiaryio/drafter).
+
+Then add this line to your application's Gemfile:
 
 ```ruby
 gem 'fitting'
 ```
 
-And then execute:
+After that execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
-Or install it yourself as:
+Or install the gem by yourself:
 
-    $ gem install fitting
+```bash
+$ gem install fitting
+```
 
 ## Usage
 
-In your `.fitting.yml`:
+Add this to your `.fitting.yml`:
 
 ```yaml
 apib_path: /path/to/doc.apib
 ```
 
-In your `spec_helper.rb`:
+And this to your `spec_helper.rb`:
 
 ```ruby
 require 'fitting'
@@ -42,11 +44,11 @@ require 'fitting'
 Fitting.save_test_data
 ```
 
-The files will be created in ./fitting_tests/ path
+The result files will be created in `./fitting_tests/` folder.
 
-Example:
+Output example:
 
-```
+```json
 [
   {
     "method": "GET",
@@ -73,20 +75,45 @@ Example:
     },
     "title": "/spec/controllers/api/v1/books_controller_spec.rb:22",
     "group": "/spec/controllers/api/v1/books_controller_spec.rb"
-  },
-  ...
+  }
+]
 ```
 
+## Documentation coverage
+
+To match routes and validate JSON-schemas run:
+
+```bash
+rake fitting:documentation_responses[report_size]
+```
 
-## Check documentation cover
+There are four types (or `report_size`) of reports available: 
+  
+- `xs` — the smallest report;
+- `s` — includes coverage for `required` fields;
+- `m` — includes coverage for `required` and `enum` fields;
+- `l` — includes coverage for `required`, `enum` and `oneOf` fields.
 
-### xs size
+E.g. for `xs` size:
 
-For match routes and valid json-schemas run `rake fitting:documentation_responses[xs]`
+```bash
+rake fitting:documentation_responses[xs]
+```
 
-You will get statistics:
+**Note**: In zsh you should add quotes around the task:
 
+```bash
+rake 'fitting:documentation_responses[xs]'
 ```
+
+Also you can use `documentation_responses_error` to get more detailed errors description.
+Check the examples below. 
+
+### Examples
+
+`xs` size:
+
+```text
 Fully conforming requests:
 DELETE  /api/v1/book                 ✔ 200 ✔ 201 ✔ 404
 DELETE  /api/v1/book/{id}            ✔ 200 ✔ 201 ✔ 404
@@ -110,11 +137,9 @@ API responses conforming to the blueprint: 16 (64.00% of 25).
 API responses with validation errors or untested: 9 (36.00% of 25).
 ```
 
-### s size
-
-In addition to the previous comand, you will learn the coverage(required) json-schemas with task `rake fitting:documentation_responses[s]`
+`s` size:
 
-```
+```text
 Fully conforming requests:
 DELETE  /api/v1/book                 100% 200 100% 201 100% 404
 DELETE  /api/v1/book/{id}            100% 200 100% 201 100% 404
@@ -138,7 +163,7 @@ API responses conforming to the blueprint: 16 (64.00% of 25).
 API responses with validation errors or untested: 9 (36.00% of 25).
 ```
 
-For details `rake fitting:documentation_responses_error[s]`
+`documentation_responses_error[s]` example:
 
 ```
 request method: GET
@@ -149,63 +174,79 @@ combination: ["required", "pages"]
 new json-schema: {"$schema"=>"http://json-schema.org/draft-04/schema#", "type"=>"object", ...}
 ```
 
-### m size
+### Experimental report
+
+This report will be available and properly documented in the next major update, but you already can try it by running:   
 
-In addition to the previous comand, you will learn the coverage(enum) json-schemas with task `rake fitting:documentation_responses[m]`
-For details `rake fitting:documentation_responses_error[m]`
+```bash
+bundle e rake fitting:report
+```
+
+Using this you can document API prefixes. 
+The task will create JSON (`fitting/report.json`) and HTML (`fitting/index.html`) reports.
 
-## Check tests cover
+## Tests coverage
 
-### xs size
+Only `xs` size is available for tests coverage:
 
-`rake fitting:tests_responses[xs]`
+```bash
+rake fitting:tests_responses[xs]
+```
 
 ## Config
 
-You can specify the settings either in a yaml file `.fitting.yml` or in config.
-If your project uses several prefixes, for each one you need to create a separate yaml file in the folder `fitting` (`fitting/*.yml`).
+You can specify the settings either in a YAML file `.fitting.yml` or in a config.
+If your project uses several prefixes, for each one you should create a separate YAML file in the folder `fitting` (`fitting/*.yml`).
 
-### apib_path
+All the available config options are described below.
 
-Path to API Blueprint v3 documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
+### `apib_path`
 
-### drafter_yaml_path
+Path to API Blueprint v3 documentation. 
+There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
 
-Path to API Blueprint v3 documentation pre-parsed with `drafter` and saved to a YAML file.
+### `drafter_yaml_path`
 
-### drafter_4_apib_path
+Path to API Blueprint v3 documentation, pre-parsed with `drafter` and saved to a YAML file.
 
-Path to API Blueprint v4 documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
+### `drafter_4_apib_path`
 
-### drafter_4_yaml_path
+Path to API Blueprint v4 documentation. 
+There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
 
-Path to API Blueprint v4 documentation pre-parsed with `drafter` and saved to a YAML file.
+### `drafter_4_yaml_path`
 
-### crafter_apib_path
+Path to API Blueprint v4 documentation, pre-parsed with `drafter` and saved to a YAML file.
+
+### `crafter_apib_path`
 
 Path to API Blueprint v4 documentation.
 
-### crafter_yaml_path
+### `crafter_yaml_path`
 
-Path to API Blueprint v4 documentation pre-parsed with `crafter` and saved to a YAML file.
+Path to API Blueprint v4 documentation, pre-parsed with `crafter` and saved to a YAML file.
 
-### tomogram_json_path
+### `tomogram_json_path`
 
-Path to Tomogram documentation pre-parsed with [tomograph](https://github.com/funbox/tomograph) and saved to a JSON file.
+Path to Tomogram documentation, pre-parsed with [tomograph](https://github.com/funbox/tomograph) and saved to a JSON file.
 
-### strict
+### `strict`
 
-Default `false`. If `true` then all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
+Default: `false`
 
-### prefix
+When `true` all properties are considered to have `"required": true` and all objects are considered to have `"additionalProperties": false`.
 
-Prefix of API requests. Example: `'/api'`. Validation will not be performed if the request path does not start with a prefix.
+### `prefix`
 
-### white_list
+Prefix for API requests. E.g. `'/api'`. Validation will not be performed if the request path does not start with a prefix.
 
-Default: all paths. This is an array of paths 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.
+### `white_list`
+
+Default: all paths
+ 
+This is an array of paths that are mandatory for implementation.
+The list does not affect the work of the matcher.
+It's used for the CLI report only.
 
 ```yaml
 white_list:
@@ -220,13 +261,15 @@ white_list:
   /sessions: []
 ```
 
-Empty array `[]` means all methods.
+Empty array (`[]`) means all methods.
+
+### `resource_white_list`
 
-### resource_white_list
+Default: all resources
 
-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.
+This is an array of resources that are mandatory for implementation.
+The list does not affect the work of the matcher.
+It's used for the CLI report only.
 
 ```yaml
 resource_white_list:
@@ -240,31 +283,35 @@ resource_white_list:
   /sessions: []
 ```
 
-Empty array `[]` means all methods.
+Empty array (`[]`) means all methods.
+
+### `json_schema_cover`
 
-### json_schema_cover
+Default: false
 
-Default: false. Json-schema covering becomes mandatory.
-Or you can call `responses.statistics.cover_save` if you don't use call `Fitting.statistics`.
+JSON-schema covering becomes mandatory.
+However, if you don't use `Fitting.statistics` you can call `responses.statistics.cover_save`.
 
-### include_resources
+### `include_resources`
+
+Default: all resources (but only when `include_resources` and `include_actions` are not defined)
 
-Default: all resources if  `include_resources` and `include_actions` is not used.
 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.
+The list does not affect the work of the matcher.
+It's used for the CLI report only.
 
 ```yaml
 include_resources:
   - /sessions
 ```
 
-### include_actions
+### `include_actions`
+
+Default: all paths (but only when `include_resources` and `include_actions` are not defined)
 
-Default: all paths if `include_resources` and `include_actions` is not used.
 This is an array of paths 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.
+The list does not affect the work of the matcher.
+It's used for the CLI report only.
 
 ```yaml
 include_actions:
@@ -275,9 +322,9 @@ include_actions:
   - GET /users/{id}/employees
 ```
 
-### ignore_list
+### `ignore_list`
 
-You can use ignore list for omit checks with matchers.
+You can use ignore list to omit checks with matchers.
 
 ```yaml
 ignore_list:
@@ -285,12 +332,25 @@ ignore_list:
   - %r{/api/v1/comments}
 ```
 
-It works only for match_schema (NOT FOR strictly_match_schema)
+It works only for `match_schema` and **not** for `strictly_match_schema`.
+
+### `prefixes`
+
+Example:
+
+```yaml
+prefixes:
+  - name: /api/v1
+  - name: /api/v2
+```
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at [github.com/funbox/fitting](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.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[![Sponsored by FunBox](https://funbox.ru/badges/sponsored_by_funbox_centered.svg)](https://funbox.ru)