fitting 2.15.0 → 2.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d604ca859d26a71406a404ad3fd2ea7d232fa670ee1f930ada129df6fe55f15a
-  data.tar.gz: 919ece6a20bdf078459ef5b42351687ddbabb01296364ba52cf4f5e669e36d7d
+  metadata.gz: 86988a5ed3f114df581b0d6c6550867e2f9864f05808b6ec66a063f2ad573c93
+  data.tar.gz: 0b1c58784f5838caea3942d022f9dfaa4196912a7f30119e0b3e1b71080f9e43
 SHA512:
-  metadata.gz: '0810933b01cb101b7cee10d06e522a29e746139181ccd7c948f6af3b6aa0dcf082856db941c371b1e1945839b5a7ddff537fc2656025bf905485d06ed61685bd'
-  data.tar.gz: c08f43a84f31a7d029c0c72f4667e95c9e9769a92a3bb243a4a6de7af8da2e493bd63716794ee24f04eb7bd31dff43a71bb2ebf67ec9078685fb08dffd885195
+  metadata.gz: d8f5d03f52a1332fc7483f17c8bbfde3c3a751a1c8f539f65637137e8b6ef95d251574105b5cecd9f4292f47f3a951ad45d9a9c914cfbee450b2d1eee8f1e25e
+  data.tar.gz: d40fe0ae76fa5a381e19c1444d84ae90262571cbf2ab9d3198d299b71333f042ccd1a637f150c28403b2a4ccb96b7abf230d9638ffb4ef645700244c4d8194db

data/.github/workflows/ruby.yml

@@ -23,10 +23,10 @@ jobs:
     - 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
+      uses: ruby/setup-ruby@v1
+    # uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
       with:
-        ruby-version: 2.6
+        ruby-version: 2.7
     - name: Install dependencies
       run: bundle install
     - name: Run tests

data/.rubocop.yml

@@ -1,8 +1,8 @@
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 
-Metrics/LineLength:
-  Max: 120
+Layout/LineLength:
+  Max: 130
 
 Style/Documentation:
   Enabled: false
@@ -18,3 +18,31 @@ Style/CaseEquality:
 
 Style/NilComparison:
   Enabled: false
+
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+
+Lint/UnreachableCode:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 50
+
+# FIXME
+Metrics/AbcSize:
+  Max: 50
+
+Metrics/PerceivedComplexity:
+  Max: 20
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 7
+
+Metrics/ClassLength:
+  Max: 150
+
+Lint/UselessAssignment:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change log
 
+### 2.18.0 - 2021-09-29
+
+* patch
+  * remove multi_json [#119](https://github.com/funbox/fitting/issues/119)
+
+### 2.17.0 - 2021-09-20
+
+* features
+  * display tests_without_responses details on the main page [#115](https://github.com/funbox/fitting/issues/115)
+
+### 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

data/README.md

@@ -1,41 +1,38 @@
 # Fitting
 
-[![Gem Version](https://badge.fury.io/rb/fitting.svg)](https://badge.fury.io/rb/fitting)
+<img align="right" width="192" height="192"
+alt="Optimizt avatar: OK sign with Mona Lisa picture between the fingers"
+src="./images/logo.png">
 
-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.
+There are such ways of describing the API documentation as API Blueprint, Swagger and OpenAPI. And using the tests already writed for your code, you can reuse them to find out the documentation coverage.
+This makes it easy to find out how much the documentation matches the implementation.
 
-## Installation
+* Cool if you already have a project with tests and documentation, you can check how good everything is and fix microbags.
 
-First you need to install [drafter](https://github.com/apiaryio/drafter).
+* If are you going developing API and  write documentation for it, this tool will help you document-driven development easily create high-quality write API documentation and API.
 
-Then add this line to your application's Gemfile:
+* Also, if you have an undocumented API, this is an easy way to describe it.
 
+![exmaple](images/example.png)
+
+## Installation
+Add this line to your application's Gemfile:
 ```ruby
 gem 'fitting'
 ```
 
 After that execute:
-
 ```bash
 $ bundle
 ```
 
 Or install the gem by yourself:
-
 ```bash
 $ gem install fitting
 ```
 
 ## Usage
-
-Add this to your `.fitting.yml`:
-
-```yaml
-apib_path: /path/to/doc.apib
-```
-
-And this to your `spec_helper.rb`:
+And next to your `spec_helper.rb`:
 
 ```ruby
 require 'fitting'
@@ -43,304 +40,122 @@ require 'fitting'
 Fitting.save_test_data
 ```
 
-The result files will be created in `./fitting_tests/` folder.
-
-Output example:
-
-```json
-[
-  {
-    "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"
-  }
-]
-```
-
-## Documentation coverage
-
-To match routes and validate JSON-schemas run:
-
-```bash
-rake fitting:documentation_responses[report_size]
-```
-
-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.
-
-E.g. for `xs` size:
-
-```bash
-rake fitting:documentation_responses[xs]
-```
-
-**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
-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:
-
-```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
-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).
-```
+Add this to your `.fitting.yml`:
 
-`documentation_responses_error[s]` example:
+### OpenAPI 2.0
+Also Swagger
 
+```yaml
+prefixes:
+  - name: /api/v1
+    openapi2_json_path: doc.json
 ```
-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", ...}
-```
-
-### Experimental report
 
-This report will be available and properly documented in the next major update, but you already can try it by running:   
+### OpenAPI 3.0
+Also OpenAPI
 
-```bash
-bundle e rake fitting:report
+```yaml
+prefixes:
+  - name: /api/v1
+    openapi3_yaml_path: doc.yaml
 ```
 
-Using this you can document API prefixes. 
-The task will create JSON (`fitting/report.json`) and HTML (`fitting/index.html`) reports.
-
-## Tests coverage
+### 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.
 
-Only `xs` size is available for tests coverage:
+That is, I mean that you first need to do this
 
 ```bash
-rake fitting:tests_responses[xs]
+drafter doc.apib -o doc.yaml
 ```
 
-## Config
-
-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`).
-
-All the available config options are described below.
-
-### `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`
-
-When `true` all properties are considered to have `"required": true` and all objects are considered to have `"additionalProperties": false`.
-
-### `prefix`
-
-Prefix for API requests. E.g. `'/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.
-The list does not affect the work of the matcher.
-It's used for the CLI report only.
+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.
+### Tomograph
 
-### `resource_white_list`
-
-Default: all resources
-
-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.
+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`
-
-Default: false
-
-JSON-schema covering becomes mandatory.
-However, if you don't use `Fitting.statistics` you can call `responses.statistics.cover_save`.
-
-### `include_resources`
-
-Default: all resources (but only when `include_resources` and `include_actions` are not defined)
-
-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
-include_resources:
-  - /sessions
+## Run
+Run tests first to get run artifacts
+```bash
+bundle e rspec
 ```
 
-### `include_actions`
-
-Default: all paths (but only when `include_resources` and `include_actions` are not defined)
-
-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
-include_actions:
-  - DELETE /users/{id}
-  - POST /users
-  - GET /users/{id}
-  - PATCH /users/{id}
-  - GET /users/{id}/employees
+and then
+```bash
+bundle e rake fitting:report
 ```
 
-### `ignore_list`
+Console ouptut
 
-You can use ignore list to omit checks with matchers.
+```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
+
+tests_without_prefixes: 42
+tests_without_actions: 144
+tests_without_responses: 43
+```
+
+And task will create HTML (`fitting/index.html`) reports.
+
+![exmaple](images/example.png)
+
+More information on action coverage
+
+![exmaple2](images/example2.png)
+
+## prefix name
+
+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` and **not** for `strictly_match_schema`.
-
-### `prefixes`
-
-Example:
+## prefix skip
 
+It is not necessary to immediately describe each prefix in detail, you can only specify its name and skip it until you are ready to documented it
 ```yaml
 prefixes:
-  - name: /api/v1
-  - name: /api/v2
+- name: /api/v1
+  openapi2_json_path: doc.json
+- name: /api/v3
+  skip: true
 ```
 
 ## Contributing

data/fitting.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fitting/version'
 
@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['d.efimov']
   spec.email         = ['d.efimov@fun-box.ru']
 
-  spec.summary       = 'Validation in the rspec of API Blueprint'
-  spec.description   = 'Validation responses in the rspec with the help of API Blueprint'
+  spec.summary       = 'Coverage API Blueprint, Swagger and OpenAPI with RSpec'
+  spec.description   = 'Coverage API Blueprint, Swagger and OpenAPI with RSpec for easily make high-quality API and documenatiton'
   spec.homepage      = 'https://github.com/funbox/fitting'
   spec.license       = 'MIT'
 
@@ -18,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.6.0'
   spec.add_runtime_dependency 'json-schema', '~> 2.6', '>= 2.6.2'
-  spec.add_runtime_dependency 'multi_json', '~> 1.11'
-  spec.add_runtime_dependency 'tomograph', '~> 3.0', '>= 3.0.0'
+  spec.add_runtime_dependency 'tomograph', '~> 3.1', '>= 3.1.0'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'byebug', '~> 8.2', '>= 8.2.1'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.49.1', '>= 0.49.1'
-  spec.add_development_dependency 'simplecov', '~> 0.11', '>= 0.11.2'
+  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.3'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.22.0'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
 end

data/lib/fitting/configuration/legacy.rb

@@ -36,11 +36,12 @@ module Fitting
                           drafter_4_apib_path: @drafter_4_apib_path,
                           drafter_4_yaml_path: @drafter_4_yaml_path
                         )
-                      else Tomograph::Tomogram.new(
-                        prefix: @prefix,
-                        apib_path: @apib_path,
-                        drafter_yaml_path: @drafter_yaml_path
-                      )
+                      else
+                        Tomograph::Tomogram.new(
+                          prefix: @prefix,
+                          apib_path: @apib_path,
+                          drafter_yaml_path: @drafter_yaml_path
+                        )
                       end
       end
 

data/lib/fitting/configuration/yaml.rb

@@ -43,13 +43,13 @@ module Fitting
                         Tomograph::Tomogram.new(
                           prefix: @prefix,
                           crafter_apib_path: @crafter_apib_path,
-                          crafter_yaml_path: @crafter_yaml_path,
+                          crafter_yaml_path: @crafter_yaml_path
                         )
                       elsif @drafter_4_apib_path || @drafter_4_yaml_path
                         Tomograph::Tomogram.new(
                           prefix: @prefix,
                           drafter_4_apib_path: @drafter_4_apib_path,
-                          drafter_4_yaml_path: @drafter_4_yaml_path,
+                          drafter_4_yaml_path: @drafter_4_yaml_path
                         )
                       else
                         Tomograph::Tomogram.new(

data/lib/fitting/cover/json_schema.rb

@@ -15,17 +15,18 @@ module Fitting
 
       def inception(json_schema, combinations)
         json_schema.each do |key, value|
-          if key == 'properties' and json_schema['required'] != value.keys
+          if (key == 'properties') && (json_schema['required'] != value.keys)
             schema = json_schema.dup
             one_of = schema.delete('required') || []
             schema['properties'].each_key do |property|
               next if one_of.include?(property)
+
               combinations.push([schema.merge('required' => one_of + [property]), "required.#{property}"])
             end
           elsif value.is_a?(Hash)
             com = inception(value, [])
             com.each do |combination|
-              combination[0] = { key => value.merge(combination[0])}
+              combination[0] = { key => value.merge(combination[0]) }
               combination[1] = "#{key}.#{combination[1]}"
             end
             combinations += com

data/lib/fitting/cover/json_schema_enum.rb

@@ -24,7 +24,7 @@ module Fitting
           elsif value.is_a?(Hash)
             com = inception(value, [])
             com.each do |combination|
-              combination[0] = { key => value.merge(combination[0])}
+              combination[0] = { key => value.merge(combination[0]) }
               combination[1] = "#{key}.#{combination[1]}"
             end
             combinations += com

data/lib/fitting/cover/json_schema_one_of.rb

@@ -24,7 +24,7 @@ module Fitting
           elsif value.is_a?(Hash)
             com = inception(value, [])
             com.each do |combination|
-              combination[0] = { key => value.merge(combination[0])}
+              combination[0] = { key => value.merge(combination[0]) }
               combination[1] = "#{key}.#{combination[1]}"
             end
             combinations += com

data/lib/fitting/cover/response.rb

@@ -13,11 +13,7 @@ module Fitting
         end
       end
 
-      attr_reader :json_schemas
-
-      attr_reader :combinations
-
-      attr_reader :flags
+      attr_reader :json_schemas, :combinations, :flags
 
       def update(response)
         index = 0