fitting 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf841d9b8d6f50655b5d8f0a265980660be83232
-  data.tar.gz: 0413072e04a9eab17e619c0821d4bc05f0cd2592
+  metadata.gz: 39a9c98935fdc1df35f3ee2a3777873fc5b4961a
+  data.tar.gz: 6526756da2a69633d954dc9f4e488de09f3cfd70
 SHA512:
-  metadata.gz: 2f08e076fcfd2c8fae3ffa8a3173a35b727b47e240fb3cd7ad2fa65b9fd77da4cdb481cd07aabc60ec05b9bd56fa50fa6144f8071b2ea78026e51a362661b634
-  data.tar.gz: 610bcca9e1152c96af7fbfff997ff3146ffe7cfcdca20777b97e775c1384b7a0b0b34d2711795d717afd9ad1151560642a3d51095f617c8bb704235aeca5ce6f
+  metadata.gz: 2be0e322093ef0574c3bd71587a8c808344b20d519e40dcc652b7edf21e090779a0852f32da4fc186bfb819642393daeba8b9317f68ab6a6c01ee28d69110ed6
+  data.tar.gz: 56f0baa5c8745db69f0233e3a2ceeee7dc92b8fff9e008ade95212c520c06d31ca04fbc1771b64dd8ca6c0e3e171e326d015f31e75f8befc0783ae046e163403

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change log
 
+### 2.4.0 - 2018-02-05
+
+* features
+  * add include_resources and include_actions configs
+* deprecations
+  * white_list and resource_white_list configs
+  * configure
+
 ### 2.3.0 - 2017-09-13
 
 * features

data/README.md

@@ -4,6 +4,7 @@
   <img src="https://funbox.ru/badges/sponsored_by_funbox.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.
@@ -27,16 +28,18 @@ Or install it yourself as:
 
 ## Usage
 
+In your `.fitting.yml`:
+
+```yaml
+apib_path: /path/to/doc.apib
+```
+
 In your `spec_helper.rb`:
 
 ```ruby
 require 'fitting'
 
 Fitting.statistics
-
-Fitting.configure do |config|
-  config.apib_path = '/path/to/doc.apib'
-end
 ```
 
 or
@@ -55,10 +58,6 @@ RSpec.configure do |config|
     responses.statistics.save
   end
 end
-
-Fitting.configure do |config|
-  config.apib_path = '/path/to/doc.apib'
-end
 ```
 
 ## Example output
@@ -142,13 +141,17 @@ Default: all paths. This is an array of paths that are mandatory for implementat
 This list does not affect the work of the matcher.
 This list is only for the report in the console.
 
-```ruby
-config.white_list = {
-  '/users' =>                ['DELETE', 'POST'],
-  '/users/{id}' =>           ['GET', 'PATCH'],
-  '/users/{id}/employees' => ['GET'],
-  '/sessions' =>             []
-}
+```yaml
+white_list:
+  /users:
+    - DELETE
+    - POST
+  /users/{id}:
+    - GET
+    - PATCH
+  /users/{id}/employees:
+    - GET
+  /sessions: []
 ```
 
 Empty array `[]` means all methods.
@@ -159,22 +162,56 @@ Default: all resources. This is an array of resources that are mandatory for imp
 This list does not affect the work of the matcher.
 This list is only for the report in the console.
 
-```ruby
-config.resource_white_list = {
-  '/users' =>                ['DELETE /users/{id}', 'POST /users', 'GET /users/{id}', 'PATCH /users/{id}'],
-  '/users/{id}/employees' => ['GET /users/{id}/employees'],
-  '/sessions' =>             []
-}
+```yaml
+resource_white_list:
+  /users:
+    - DELETE /users/{id}
+    - POST /users
+    - GET /users/{id}
+    - PATCH /users/{id}
+  /users/{id}/employees:
+    - GET /users/{id}/employees
+  /sessions: []
 ```
 
 Empty array `[]` means all methods.
 
+### include_resources
+
+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.
+
+```yaml
+include_resources:
+  - /sessions
+```
+
+### include_actions
+
+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.
+
+```yaml
+include_actions:
+  - DELETE /users/{id}
+  - POST /users
+  - GET /users/{id}
+  - PATCH /users/{id}
+  - GET /users/{id}/employees
+```
+
 ### ignore_list
 
 You can use ignore list for omit checks with matchers.
 
-```ruby
-config.ignore_list = [%r{/api/v1/users/[1-9].}, %r{/api/v1/comments}]
+```yaml
+ignore_list:
+  - %r{/api/v1/users/[1-9].}
+  - %r{/api/v1/comments}
 ```
 
 It's work only for match_schema (NOT FOR strictly_match_schema)

data/lib/fitting/configuration/legacy.rb

@@ -9,7 +9,9 @@ module Fitting
                     :prefix,
                     :white_list,
                     :resource_white_list,
-                    :ignore_list
+                    :ignore_list,
+                    :include_resources,
+                    :include_actions
 
       def initialize
         @strict = false

data/lib/fitting/configuration/yaml.rb

@@ -10,7 +10,9 @@ module Fitting
                     :prefix,
                     :white_list,
                     :resource_white_list,
-                    :ignore_list
+                    :ignore_list,
+                    :include_resources,
+                    :include_actions
 
       def initialize(yaml, title = 'fitting')
         @apib_path = yaml['apib_path']
@@ -20,6 +22,8 @@ module Fitting
         @white_list = yaml['white_list']
         @resource_white_list = yaml['resource_white_list']
         @ignore_list = yaml['ignore_list']
+        @include_resources = yaml['include_resources']
+        @include_actions = yaml['include_actions']
         @title = title
         default
       end

data/lib/fitting/statistics/template.rb

@@ -19,7 +19,7 @@ module Fitting
       end
 
       def stats
-        if documented.to_a.size > documented_requests_white.size
+        if @config.white_list.present? || @config.resource_white_list.present? || @config.include_resources.present?
           [
             ['[Black list]', black_statistics].join("\n"),
             ['[White list]', white_statistics].join("\n"),
@@ -80,8 +80,11 @@ module Fitting
 
       def white_list
         @white_list ||= Fitting::Storage::WhiteList.new(
+          @config.prefix,
           @config.white_list,
           @config.resource_white_list,
+          @config.include_resources,
+          @config.include_actions,
           @config.tomogram.to_resources
         )
       end

data/lib/fitting/storage/white_list.rb

@@ -3,17 +3,28 @@ require 'tomograph'
 module Fitting
   module Storage
     class WhiteList
-      def initialize(white_list, resource_white_list, resources)
+      def initialize(prefix, white_list, resource_white_list, include_resources, include_actions, resources)
+        @prefix = prefix
         @white_list = white_list
         @resource_white_list = resource_white_list
+        @include_resources = include_resources
+        @include_actions = include_actions
         @resources = resources
         @warnings = []
       end
 
       def to_a
-        return nil if @white_list == nil && @resource_white_list == nil
+        return nil if @white_list == nil && @resource_white_list == nil && @include_resources == nil && @include_actions == nil
         return @white_list if @white_list
-        @white_list = transformation
+        return @white_list = transformation if @resource_white_list
+        @white_list = {}
+        if @include_resources
+          @white_list.merge!(new_transformation)
+        end
+        if @include_actions
+          @white_list.merge!(postnew_transformation)
+        end
+        @white_list
       end
 
       def without_group
@@ -71,6 +82,74 @@ module Fitting
           path: Tomograph::Path.new(array[1]).to_s
         }
       end
+
+      def new_transformation
+        @new_resources = {}
+        @resources.map do |key, value|
+          @new_resources.merge!(Tomograph::Path.new(key).to_s => value)
+        end
+        result = new_without_group.group_by { |action| action[:path] }
+        result.inject({}) do |res, group|
+          methods = group.last.map { |gr| gr[:method] }
+          res.merge(group.first => methods)
+        end
+      end
+
+      def new_without_group
+        return @newwithout_group_list if @newwithout_group_list
+        @newwithout_group_list = @include_resources.inject([]) do |all_requests, resource|
+          if resource[0] == '/'
+            new_resource_selection(resource, all_requests)
+          else
+            new_resource_selection("/#{resource}", all_requests)
+          end
+        end.flatten.uniq
+        puts_warnings
+        @newwithout_group_list
+      end
+
+      def new_resource_selection(resource, all_requests)
+        new_find_warnings(resource)
+        new_requests(@new_resources[resource], all_requests)
+      end
+
+      def new_requests(resource, all_requests)
+        return all_requests unless resource
+
+        resource.map do |request|
+          all_requests.push(request_hash(request))
+        end
+        all_requests
+      end
+
+      def new_find_warnings(resource)
+        return nil if @new_resources[resource]
+        @warnings.push(
+          "FITTING WARNING: In the documentation there isn't resource from the resource_white_list #{resource}"
+        )
+      end
+
+      def postnew_transformation
+        result = postnew_without_group.group_by { |action| action[:path] }
+        result.inject({}) do |res, group|
+          methods = group.last.map { |gr| gr[:method] }
+          res.merge(group.first => methods)
+        end
+      end
+
+      def postnew_without_group
+        return @postnewwithout_group_list if @postnewwithout_group_list
+        @postnewwithout_group_list = @include_actions.inject([]) do |all_requests, resource|
+          method, path = resource.split(' ')
+          if path[0] == '/'
+            new_requests(["#{method} #{@prefix}#{path}"], all_requests)
+          else
+            new_requests(["#{method} #{@prefix}/#{path}"], all_requests)
+          end
+        end.flatten.uniq
+        puts_warnings
+        @postnewwithout_group_list
+      end
     end
   end
 end

data/lib/fitting/version.rb

@@ -1,3 +1,3 @@
 module Fitting
-  VERSION = '2.3.0'.freeze
+  VERSION = '2.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-13 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema