fitting 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6a1bfcb1667b2ca245f0c59adb47194c6a2798a
-  data.tar.gz: 8ef0148851c9ecd7138e3d34a1d34fe7f6d61bbb
+  metadata.gz: 56f3f0f488cdee6be583ce31472dafab117afb58
+  data.tar.gz: 3e082349195724b60655350d648b726420118bdb
 SHA512:
-  metadata.gz: 341b07818c2a02f7c8eff4cadabf036bd1af106703c587d43299de8cf6745610783d8b3c74c8b16b1d14cd1f6c5f6b815161ab99d49f26ae437578f8869fe739
-  data.tar.gz: 85d611cd383932ddeff2f6e7b5421aa757a15e5491627b293c588601d99ac21e8d0b4144c415949c72c55a09ccd3072643e3b7ae96fd619f3bf479d7c1a0d0b6
+  metadata.gz: b0084485379e61b738e6afb271fcfd6817dc10e6884ee16282b7186a4e342a0612318223c3e80abc932e711dd376d84a54a4c91ace4ad7d5561327e38e78344e
+  data.tar.gz: 0440e437b56e83c8450408b3ac0fb9dba4217c57960e736d73a55e715e8a7fd7ac5e882a30d674002655b4f39acddd59690c013c30e316095faf22776de4bcd9

data/README.md

@@ -61,6 +61,23 @@ end
 
 Default `true`. It returns `exit 1` if not implemented all(with tests expect match response) the responses.
 
+### 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.
+
+```ruby
+config.white_list = {
+  '/users' =>                ['DELETE', 'POST'],
+  '/users/{id}' =>           ['GET', 'PATCH'],
+  '/users/{id}/employees' => ['GET'],
+  '/sessions' =>             []
+}
+```
+
+Empty array `[]` means all methods.
+
 ## Report
 
 Autogenerate `report_request_by_response.yaml` and `report_response.yaml reports`.

data/lib/fitting.rb

@@ -1,6 +1,7 @@
 require 'fitting/version'
 require 'fitting/configuration'
 require 'fitting/documentation/response/route'
+require 'fitting/documentation/response/routes'
 require 'fitting/documentation/request/route'
 require 'fitting/storage/responses'
 require 'fitting/storage/documentation'
@@ -33,19 +34,28 @@ module RSpec
 
         return returned_exit_code if Fitting::Storage::Skip.get
 
-        response_routes = Fitting::Documentation::Response::Route.new(
+        responses_routes = Fitting::Documentation::Response::Routes.new(
           Fitting::Storage::Documentation.hash,
-          Fitting::Storage::Responses.all
+          Fitting.configuration.white_list
         )
-        request_routes = Fitting::Documentation::Request::Route.new(response_routes)
 
-        request_routes.conformity_lists
-        request_routes.statistics
-        response_routes.statistics
+        puts '[Black list]'
+        response_routes_black = Fitting::Documentation::Response::Route.new(
+          Fitting::Storage::Responses.all,
+          responses_routes.black
+        )
+        response_routes_black.statistics
+
+        puts '[White list]'
+        response_routes_white = Fitting::Documentation::Response::Route.new(
+          Fitting::Storage::Responses.all,
+          responses_routes.white
+        )
+        response_routes_white.statistics_with_conformity_lists
 
         if Fitting.configuration.necessary_fully_implementation_of_responses &&
           returned_exit_code == 0 &&
-          response_routes.not_coverage.present?
+          response_routes_white.not_coverage.present?
           return ERROR_EXIT_CODE
         end
         returned_exit_code

data/lib/fitting/configuration.rb

@@ -1,7 +1,8 @@
 module Fitting
   class Configuration
     attr_accessor :tomogram,
-                  :necessary_fully_implementation_of_responses
+                  :necessary_fully_implementation_of_responses,
+                  :white_list
 
     def initialize
       @necessary_fully_implementation_of_responses = true

data/lib/fitting/documentation/request/route.rb

@@ -93,7 +93,7 @@ module Fitting
         end
 
         def conformity_lists
-          puts "Conforming requests: \n#{fully_implemented.join("\n")}"
+          puts "Fully conforming requests: \n#{fully_implemented.join("\n")}"
           puts
           puts "Partially conforming requests: \n#{partially_implemented.join("\n")}"
           puts

data/lib/fitting/documentation/response/route.rb

@@ -1,42 +1,25 @@
 require 'multi_json'
+require 'fitting/documentation/request/route'
 
 module Fitting
   module Documentation
     module Response
       class Route
-        def initialize(tomogram, coverage_responses)
-          @tomogram = tomogram
+        def initialize(coverage_responses, responses_routes)
           @coverage_responses = coverage_responses
+          @responses_routes = responses_routes
         end
 
         def coverage
-          @coverage ||= @coverage_responses.map do |response|
-            response.route if response.documented? && response.valid?
-          end.compact.uniq
+          @coverage ||= @responses_routes - (@responses_routes - full_coverage)
         end
 
         def not_coverage
-          @not_coverage ||= all - coverage
-        end
-
-        def all
-          @all ||= MultiJson.load(@tomogram).inject([]) do |routes, request|
-            request['responses'].inject({}) do |responses, response|
-              responses[response['status']] ||= 0
-              responses[response['status']] += 1
-              responses
-            end.map do |status, indexes|
-              indexes.times do |index|
-                route = "#{request['method']}\t#{request['path']} #{status} #{index}"
-                routes.push(route)
-              end
-            end
-            routes
-          end.uniq
+          @not_coverage ||= @responses_routes - coverage
         end
 
         def cover_ratio
-          @cover_ratio ||= (coverage.size.to_f / all.size.to_f * 100.0).round(2)
+          @cover_ratio ||= (coverage.size.to_f / @responses_routes.size.to_f * 100.0).round(2)
         end
 
         def to_hash
@@ -46,16 +29,33 @@ module Fitting
           }
         end
 
+        def statistics_with_conformity_lists
+          @request_routes ||= Fitting::Documentation::Request::Route.new(self)
+          @request_routes.conformity_lists
+          statistics
+        end
+
         def statistics
+          @request_routes ||= Fitting::Documentation::Request::Route.new(self)
+          @request_routes.statistics
+
           valid_count = coverage.size
           valid_percentage = cover_ratio
-          total_count = all.size
+          total_count = @responses_routes.size
           invalid_count = not_coverage.size
           invalid_percentage = 100.0 - cover_ratio
           puts "API responses conforming to the blueprint: #{valid_count} (#{valid_percentage}% of #{total_count})."
           puts "API responses with validation errors or untested: #{invalid_count} (#{invalid_percentage}% of #{total_count})."
           puts
         end
+
+        private
+
+        def full_coverage
+          @coverage_responses.map do |response|
+            response.route if response.documented? && response.valid?
+          end.compact.uniq
+        end
       end
     end
   end

data/lib/fitting/documentation/response/routes.rb

@@ -0,0 +1,53 @@
+require 'multi_json'
+require 'fitting/documentation/request/route'
+
+module Fitting
+  module Documentation
+    module Response
+      class Routes
+        def initialize(tomogram, white_list)
+          @tomogram = tomogram
+          @white_list = white_list
+        end
+
+        def black
+          if @white_list
+            all.select do |response|
+              data = response.split(' ')
+              data[1] && !@white_list[data[1]] || (@white_list[data[1]] != [] && !@white_list[data[1]].include?(data[0]))
+            end
+          else
+            []
+          end
+        end
+
+        def white
+          if @white_list
+            all.select do |response|
+              data = response.split(' ')
+              data[1] && @white_list[data[1]] && (@white_list[data[1]] == [] || @white_list[data[1]].include?(data[0]))
+            end
+          else
+            all
+          end
+        end
+
+        def all
+          @all ||= MultiJson.load(@tomogram).inject([]) do |routes, request|
+            request['responses'].inject({}) do |responses, response|
+              responses[response['status']] ||= 0
+              responses[response['status']] += 1
+              responses
+            end.map do |status, indexes|
+              indexes.times do |index|
+                route = "#{request['method']}\t#{request['path']} #{status} #{index}"
+                routes.push(route)
+              end
+            end
+            routes
+          end.uniq
+        end
+      end
+    end
+  end
+end

data/lib/fitting/version.rb

@@ -1,3 +1,3 @@
 module Fitting
-  VERSION = '1.3.1'.freeze
+  VERSION = '1.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitting
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -214,6 +214,7 @@ files:
 - lib/fitting/configuration.rb
 - lib/fitting/documentation/request/route.rb
 - lib/fitting/documentation/response/route.rb
+- lib/fitting/documentation/response/routes.rb
 - lib/fitting/matchers/response_matcher.rb
 - lib/fitting/request.rb
 - lib/fitting/response.rb