fitting 2.13.1 → 2.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 483a7f1462b7204b2dbeb31d372ad2526783c775
-  data.tar.gz: eef485bd208b70fbe0fd10e350e3bda9e82ac084
+SHA256:
+  metadata.gz: dff340fba9a0bb88736f22f6f2ca3c0842d3e71b1f51228ee693f831e411a654
+  data.tar.gz: da9ca92e4c14ce44112253508840a82a3855227b742707278ac6352bd0f471b8
 SHA512:
-  metadata.gz: 16b2442c467a9a507262b721fe4d0528af989ae7ab9a7f8f703d740ca692aedf97c47c7cb8eec180955ade9b151c85948af723ca301dcdb73c56cf9b06e14250
-  data.tar.gz: 2e42661f2d0a13f794cb6c808ea5b4d6e3b7fbc8d2ae368c4948a2cfc69a7e8a398333cc8de76a3e70cc6db63bceea03f4df76b14acdc6757dc53107fc883400
+  metadata.gz: ed8f7776052d96e79ae59b75f4f60f94e48abd16cf25b8ecd7709b58860d17d4dbbfa370aa2058fbb7001517e3532d1f27837e200c8e9e7075b020924fd4334b
+  data.tar.gz: bbff5fdab51436db644ed6a6874cd7ffea8be3fe9d8566b57a0115195d8c328c2f4896aa72ef1a0d8466599b68864ff61ab27a301c74591bb9292585f6862039

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - 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
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

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.6.1

data/.tool-versions

@@ -1 +1 @@
-ruby 2.2.0
+ruby 2.6.1

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 # Change log
 
+### 2.16.1 - 2021-02-10
+* patch
+  * make prefix optional [#98](https://github.com/funbox/fitting/issues/98)
+
+### 2.16.0 - 2021-02-10
+
+* features
+  * support swagger and openapi [#96](https://github.com/funbox/fitting/issues/96)
+* patch
+  * let's bump to tomograph '3.0.1' [#95](https://github.com/funbox/fitting/issues/95)
+
+### 2.15.0 - 2020-10-12
+
+* features
+  * color for bad response [#79](https://github.com/funbox/fitting/issues/79)
+  * show test details [#81](https://github.com/funbox/fitting/issues/81)
+* patch
+  * update ruby [#83](https://github.com/funbox/fitting/issues/83)
+  * update bundler [#84](https://github.com/funbox/fitting/issues/84)
+  * update tomograph [#85](https://github.com/funbox/fitting/issues/85)
+  * use github actions for CI instead of Travis [#30](https://github.com/funbox/fitting/issues/30)
+
+### 2.14.1 - 2020-09-23
+
+* fixes
+  * fix directory error [#75](https://github.com/funbox/fitting/issues/75)
+  * upgrade node-forge [#77](https://github.com/funbox/fitting/issues/77)
+
+### 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

data/README.md

@@ -1,42 +1,25 @@
 # 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.
+Coverage API Blueprint, Swagger and OpenAPI with rspec tests for easily make high-quality API and documenatiton.
+![exmaple](example.png)
 
 ## Installation
-
-First you need to install [drafter](https://github.com/apiaryio/drafter).
-
-Second add this line to your application's Gemfile:
-
+Add this line to your application's Gemfile:
 ```ruby
 gem 'fitting'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install fitting
-
-## Usage
-
-In your `.fitting.yml`:
+After that execute:
+```bash
+$ bundle
+```
 
-```yaml
-apib_path: /path/to/doc.apib
+Or install the gem by yourself:
+```bash
+$ gem install fitting
 ```
 
-In your `spec_helper.rb`:
+## Usage
+And next to your `spec_helper.rb`:
 
 ```ruby
 require 'fitting'
@@ -44,270 +27,120 @@ require 'fitting'
 Fitting.save_test_data
 ```
 
-The files will be created in ./fitting_tests/ path
-
-Example:
+Add this to your `.fitting.yml`:
 
-```
-[
-  {
-    "method": "GET",
-    "path": "/api/v1/book",
-    "body": {},
-    "response": {
-      "status": 200,
-      "body": {
-        "title": "The Martian Chronicles"
-      }
-    },
-    "title": "/spec/controllers/api/v1/books_controller_spec.rb:11",
-    "group": "/spec/controllers/api/v1/books_controller_spec.rb"
-  },
-  {
-    "method": "POST",
-    "path": "/api/v1/book",
-    "body": {},
-    "response": {
-      "status": 200,
-      "body": {
-        "title": "The Old Man and the Sea"
-      }
-    },
-    "title": "/spec/controllers/api/v1/books_controller_spec.rb:22",
-    "group": "/spec/controllers/api/v1/books_controller_spec.rb"
-  },
-  ...
-```
+### OpenAPI 2.0
+Also Swagger
 
-
-## Check documentation cover
-
-### xs size
-
-For match routes and valid json-schemas run
-
-for bash
-```
-rake fitting:documentation_responses[xs]
-```
-
-for zsh
-```
-rake 'fitting:documentation_responses[xs]'
+```yaml
+prefixes:
+  - name: /api/v1
+    openapi2_json_path: doc.json
 ```
 
-You will get statistics:
+### OpenAPI 3.0
+Also OpenAPI
 
+```yaml
+prefixes:
+  - name: /api/v1
+    openapi3_yaml_path: doc.yaml
 ```
-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).
-```
-
-### s size
 
-In addition to the previous comand, you will learn the coverage(required) json-schemas with task `rake fitting:documentation_responses[s]`
-
-```
-Fully conforming requests:
-DELETE  /api/v1/book                 100% 200 100% 201 100% 404
-DELETE  /api/v1/book/{id}            100% 200 100% 201 100% 404
-GET     /api/v1/book/{id}/seller     100% 200 100% 201 100% 404
-
-Partially conforming requests:
-GET     /api/v1/book                 0% 200 66% 404
-POST    /api/v1/book                 0% 200 90% 201 100% 404
-GET     /api/v1/book/{id}            0% 200 88% 404 10% 200
-PATCH   /api/v1/book/{id}            0% 200 100% 201 10% 404
-
-Non-conforming requests:
-GET     /api/v1/seller               0% 200 0% 201 0 404
-GET     /api/v1/buyer                0% 200 0% 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).
-```
+### API Blueprint
+First you need to install [drafter](https://github.com/apiaryio/drafter).
+Works after conversion from API Blueprint to API Elements (in YAML file) with Drafter.
 
-For details `rake fitting:documentation_responses_error[s]`
+That is, I mean that you first need to do this
 
+```bash
+drafter doc.apib -o doc.yaml
 ```
-request method: GET
-request path: /api/v1/book
-response status: 200
-source json-schema: {"$schema"=>"http://json-schema.org/draft-04/schema#", "type"=>"object", ...}
-combination: ["required", "pages"]
-new json-schema: {"$schema"=>"http://json-schema.org/draft-04/schema#", "type"=>"object", ...}
-```
-
-### m size
 
-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]`
-
-### l size
-
-In addition to the previous comand, you will learn the coverage(oneOf) json-schemas with task `rake fitting:documentation_responses[l]`
-For details `rake fitting:documentation_responses_error[l]`
-
-## Check tests cover
-
-### xs size
-
-`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`).
-
-### apib_path
-
-Path to API Blueprint v3 documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
-
-### drafter_yaml_path
-
-Path to API Blueprint v3 documentation pre-parsed with `drafter` and saved to a YAML file.
-
-### drafter_4_apib_path
-
-Path to API Blueprint v4 documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
-
-### drafter_4_yaml_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
-
-Path to API Blueprint v4 documentation pre-parsed with `crafter` and saved to a YAML file.
-
-### tomogram_json_path
-
-Path to Tomogram documentation pre-parsed with [tomograph](https://github.com/funbox/tomograph) and saved to a JSON file.
-
-### strict
-
-Default `false`. If `true` then all properties are condisidered to have `"required": true` and all objects `"additionalProperties": false`.
-
-### prefix
-
-Prefix of API requests. Example: `'/api'`. Validation will not be performed if the request path does not start with a prefix.
-
-### white_list
-
-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.
+and then
 
 ```yaml
-white_list:
-  /users:
-    - DELETE
-    - POST
-  /users/{id}:
-    - GET
-    - PATCH
-  /users/{id}/employees:
-    - GET
-  /sessions: []
+prefixes:
+  - name: /api/v1
+    drafter_yaml_path: doc.yaml
 ```
 
-Empty array `[]` means all methods.
-
-### resource_white_list
+### Tomograph
 
-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.
+To use additional features of the pre-converted [tomograph](https://github.com/funbox/tomograph)
 
 ```yaml
-resource_white_list:
-  /users:
-    - DELETE /users/{id}
-    - POST /users
-    - GET /users/{id}
-    - PATCH /users/{id}
-  /users/{id}/employees:
-    - GET /users/{id}/employees
-  /sessions: []
+prefixes:
+  - name: /api/v1
+    tomogram_json_path: doc.json
 ```
 
-Empty array `[]` means all methods.
-
-### json_schema_cover
+## Run
+Run tests first to get run artifacts
+```bash
+bundle e rspec
+```
 
-Default: false. Json-schema covering becomes mandatory.
-Or you can call `responses.statistics.cover_save` if you don't use call `Fitting.statistics`.
+and then
+```bash
+bundle e rake fitting:report
+```
 
-### include_resources
+Console ouptut
 
-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.
+```text
+/api/v1
+POST	/api/v1/accounts/{account_id}/inboxes				 0% 200 0% 404 0% 403
+PATCH	/api/v1/accounts/{account_id}/inboxes/{id}			 0% 200 0% 404 0% 403
+POST	/api/v1/accounts/{account_id}/inboxes/{id}/set_agent_bot	 0% 204 100% 404 0% 403
+GET	/api/v1/agent_bots						 0% 200 0% 404 0% 403
+GET	/api/v1/accounts/{account_id}/conversations			 0% 200 0% 400 0% description
+POST	/api/v1/accounts/{account_id}/conversations			 0% 200 0% 403
+GET	/api/v1/accounts/{account_id}/conversations/{id}		 59% 200 0% 404 0% 403
+POST	/api/v1/accounts/{account_id}/conversations/{id}/toggle_status	 80% 200 0% 404 0% 403
+GET	/api/v1/accounts/{account_id}/conversations/{id}/messages	 47% 200 0% 404 0% 403
+POST	/api/v1/accounts/{account_id}/conversations/{id}/messages	 0% 200 0% 404 0% 403
+GET	/api/v1/accounts/{account_id}/conversations/{id}/labels		 100% 200 0% 404 0% 403
+POST	/api/v1/accounts/{account_id}/conversations/{id}/labels		 100% 200 0% 404 0% 403
+POST	/api/v1/accounts/{account_id}/conversations/{id}/assignments	 77% 200 0% 404 0% 403
+GET	/api/v1/accounts/{account_id}/contacts				 0% 200 0% 400
+POST	/api/v1/accounts/{account_id}/contacts				 14% 200 0% 400
+GET	/api/v1/accounts/{account_id}/contacts/{id}			 14% 200 0% 404 0% 403
+PUT	/api/v1/accounts/{account_id}/contacts/{id}			 0% 204 0% 404 0% 403
+GET	/api/v1/accounts/{account_id}/contacts/{id}/conversations	 0% 200 0% 404 0% 403
+GET	/api/v1/accounts/{account_id}/contacts/search			 0% 200 0% 401
+POST	/api/v1/accounts/{account_id}/contacts/{id}/contact_inboxes	 0% 200 0% 401 100% 422
+GET	/api/v1/profile							 88% 200 100% 401
 
-```yaml
-include_resources:
-  - /sessions
+tests_without_prefixes: 42
+tests_without_actions: 144
+tests_without_responses: 43
 ```
 
-### include_actions
+And task will create HTML (`fitting/index.html`) reports.
 
-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.
+![exmaple](example.png)
 
-```yaml
-include_actions:
-  - DELETE /users/{id}
-  - POST /users
-  - GET /users/{id}
-  - PATCH /users/{id}
-  - GET /users/{id}/employees
-```
+More information on action coverage
+
+![exmaple2](example2.png)
 
-### ignore_list
+## prefix name
 
-You can use ignore list for omit checks with matchers.
+Setting the prefix name is optional. For example, you can do this:
 
 ```yaml
-ignore_list:
-  - %r{/api/v1/users/[1-9].}
-  - %r{/api/v1/comments}
+prefixes:
+  - openapi2_json_path: doc.json
 ```
 
-It works only for match_schema (NOT FOR strictly_match_schema)
-
 ## 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)