fitting 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e04b182de6052b1d8c395f48016e8b9f37d6b769
-  data.tar.gz: 392e75a0af97023f53585472e27a94cb83843406
+  metadata.gz: bf841d9b8d6f50655b5d8f0a265980660be83232
+  data.tar.gz: 0413072e04a9eab17e619c0821d4bc05f0cd2592
 SHA512:
-  metadata.gz: 639a9c1b2d78babd961fabc52464b962017e97904dc1b1c3b10cab94e14434880ec315eb8509ee6aa081a5af83b4ad494b1b16b8cf4f841634996d03c6cdfa4f
-  data.tar.gz: 4200b2c82e8ef7f8b4b1b893818859c8ac7f5ec2fb6bce148b93b782b644b0945c9a0393343930afd6905283b8901754ee766ce6a8c5ad54721a1c7207677d9c
+  metadata.gz: 2f08e076fcfd2c8fae3ffa8a3173a35b727b47e240fb3cd7ad2fa65b9fd77da4cdb481cd07aabc60ec05b9bd56fa50fa6144f8071b2ea78026e51a362661b634
+  data.tar.gz: 610bcca9e1152c96af7fbfff997ff3146ffe7cfcdca20777b97e775c1384b7a0b0b34d2711795d717afd9ad1151560642a3d51095f617c8bb704235aeca5ce6f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log
 
+### 2.3.0 - 2017-09-13
+
+* features
+  * configuration via yaml file
+  * setting for multiple prefixes
+
+### 2.2.0 - 2017-08-23
+
+* features
+  * ignore requests which match with ignore list
+
 ### 2.1.3 - 2017-08-07
 
 * bug fixes

data/README.md

@@ -1,5 +1,9 @@
 # Fitting
 
+<a href="https://funbox.ru">
+  <img src="https://funbox.ru/badges/sponsored_by_funbox.svg" alt="Sponsored by FunBox" width=250 />
+</a>
+
 [![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.
@@ -113,6 +117,9 @@ expect(response).to strictly_match_schema
 
 ## 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 documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.

data/lib/fitting.rb

@@ -1,8 +1,6 @@
 require 'fitting/version'
 require 'fitting/configuration'
-require 'fitting/storage/documentation'
 require 'fitting/matchers/response_matcher'
-require 'fitting/statistics'
 require 'fitting/documentation'
 require 'fitting/storage/responses'
 
@@ -13,7 +11,7 @@ module Fitting
     end
 
     def configuration
-      @configuration ||= Configuration.new
+      @configuration ||= Configuration.craft
     end
 
     def statistics

data/lib/fitting/configuration.rb

@@ -1,17 +1,47 @@
+require 'fitting/configuration/yaml'
+require 'fitting/configuration/legacy'
+require 'yaml'
+
 module Fitting
   class Configuration
-    attr_accessor :apib_path,
-                  :drafter_yaml_path,
-                  :strict,
-                  :prefix,
-                  :white_list,
-                  :resource_white_list,
-                  :ignore_list
+    class << self
+      def craft
+        if one_yaml?
+          one_yaml
+        elsif more_than_one_yaml?
+          more_than_one_yaml
+        else
+          legacy
+        end
+      end
+
+      def one_yaml?
+        File.file?('.fitting.yml')
+      end
+
+      def more_than_one_yaml?
+        !Dir['fitting/*.yml'].empty?
+      end
+
+      def one_yaml
+        yaml = YAML.safe_load(File.read('.fitting.yml'))
+        Fitting::Configuration::Yaml.new(yaml)
+      end
+
+      def more_than_one_yaml
+        files.map do |file|
+          yaml = YAML.safe_load(File.read(file))
+          Fitting::Configuration::Yaml.new(yaml, file[8..-5])
+        end
+      end
+
+      def legacy
+        Fitting::Configuration::Legacy.new
+      end
 
-    def initialize
-      @strict = false
-      @prefix = ''
-      @ignore_list = []
+      def files
+        Dir['fitting/*.yml']
+      end
     end
   end
 end

data/lib/fitting/configuration/legacy.rb

@@ -0,0 +1,41 @@
+require 'tomograph'
+
+module Fitting
+  class Configuration
+    class Legacy
+      attr_accessor :apib_path,
+                    :drafter_yaml_path,
+                    :strict,
+                    :prefix,
+                    :white_list,
+                    :resource_white_list,
+                    :ignore_list
+
+      def initialize
+        @strict = false
+        @prefix = ''
+        @ignore_list = []
+      end
+
+      def tomogram
+        @tomogram ||= Tomograph::Tomogram.new(
+          prefix: @prefix,
+          apib_path: @apib_path,
+          drafter_yaml_path: @drafter_yaml_path
+        )
+      end
+
+      def title
+        'fitting'
+      end
+
+      def stats_path
+        'fitting/stats'
+      end
+
+      def not_covered_path
+        'fitting/not_covered'
+      end
+    end
+  end
+end

data/lib/fitting/configuration/yaml.rb

@@ -0,0 +1,60 @@
+require 'tomograph'
+
+module Fitting
+  class Configuration
+    class Yaml
+      attr_reader   :title
+      attr_accessor :apib_path,
+                    :drafter_yaml_path,
+                    :strict,
+                    :prefix,
+                    :white_list,
+                    :resource_white_list,
+                    :ignore_list
+
+      def initialize(yaml, title = 'fitting')
+        @apib_path = yaml['apib_path']
+        @drafter_yaml_path = yaml['drafter_yaml_path']
+        @strict = yaml['strict']
+        @prefix = yaml['prefix']
+        @white_list = yaml['white_list']
+        @resource_white_list = yaml['resource_white_list']
+        @ignore_list = yaml['ignore_list']
+        @title = title
+        default
+      end
+
+      def tomogram
+        @tomogram ||= Tomograph::Tomogram.new(
+          prefix: @prefix,
+          apib_path: @apib_path,
+          drafter_yaml_path: @drafter_yaml_path
+        )
+      end
+
+      def stats_path
+        if @title == 'fitting'
+          'fitting/stats'
+        else
+          "fitting/#{@title}/stats"
+        end
+      end
+
+      def not_covered_path
+        if @title == 'fitting'
+          'fitting/not_covered'
+        else
+          "fitting/#{@title}/not_covered"
+        end
+      end
+
+      private
+
+      def default
+        @strict ||= false if @strict.nil?
+        @prefix ||= ''
+        @ignore_list ||= []
+      end
+    end
+  end
+end

data/lib/fitting/matchers/response_matcher.rb

@@ -1,20 +1,16 @@
 require 'fitting/response'
-require 'fitting/storage/documentation'
 require 'fitting/configuration'
 
 module Fitting
   module Matchers
     class Response
       def matches?(response)
-        @response = Fitting::Response.new(
-          response,
-          Fitting::Storage::Documentation.tomogram
-        )
-        return true if @response.ignored?(Fitting.configuration.ignore_list)
-        if @response.within_prefix?(Fitting.configuration.prefix)
-          @response.fully_validates.valid?
+        if Fitting.configuration.is_a?(Array)
+          Fitting.configuration.all? do |config|
+            one_match(response, config)
+          end
         else
-          true
+          one_match(response, Fitting.configuration)
         end
       end
 
@@ -35,15 +31,28 @@ module Fitting
           "got: #{@response.got}\n\n"\
           "errors: \n#{@response.fully_validates}\n"
       end
+
+      private
+
+      def one_match(response, config)
+        response = Fitting::Response.new(response, config.tomogram)
+        if response.within_prefix?(config.prefix)
+          @response = response
+          return true if @response.ignored?(config.ignore_list)
+          return @response.fully_validates.valid?
+        else
+          true
+        end
+      end
     end
 
     class StrictResponse
       def matches?(response)
-        @response = Fitting::Response.new(
-          response,
-          Fitting::Storage::Documentation.tomogram
-        )
-        @response.strict_fully_validates.valid?
+        if Fitting.configuration.is_a?(Array)
+          one_match(response, Fitting.configuration[0])
+        else
+          one_match(response, Fitting.configuration)
+        end
       end
 
       def ===(other)
@@ -63,6 +72,16 @@ module Fitting
           "got: #{@response.got}\n\n"\
           "errors: \n#{@response.strict_fully_validates}\n"
       end
+
+      private
+
+      def one_match(response, config)
+        @response = Fitting::Response.new(
+          response,
+          config.tomogram
+        )
+        @response.strict_fully_validates.valid?
+      end
     end
 
     def match_schema

data/lib/fitting/records/documented/request.rb

@@ -0,0 +1,53 @@
+module Fitting
+  class Records
+    class Documented
+      class Request
+        def initialize(tomogram_request, white_list)
+          @tomogram_request = tomogram_request
+          @white_list = white_list
+        end
+
+        def method
+          @method ||= @tomogram_request['method']
+        end
+
+        def path
+          @path ||= @tomogram_request['path']
+        end
+
+        def json_schema
+          @json_schema ||= @tomogram_request['json_schema']
+        end
+
+        def responses
+          @responses ||= groups.map do |group|
+            {
+              'status' => group[0],
+              'json_schemas' => group[1].map { |subgroup| subgroup['body'] }
+            }
+          end
+        end
+
+        def white
+          @white ||= white?
+        end
+
+        private
+
+        def white?
+          return true if @white_list == nil
+          return false if @white_list[path.to_s] == nil
+          return true if @white_list[path.to_s] == []
+          return true if @white_list[path.to_s].include?(method)
+          false
+        end
+
+        def groups
+          @groups ||= @tomogram_request['responses'].group_by do |tomogram_response|
+            tomogram_response['status']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fitting/records/tested/request.rb

@@ -0,0 +1,30 @@
+require 'tomograph/path'
+require 'fitting/records/tested/response'
+
+module Fitting
+  class Records
+    class Tested
+      class Request
+        def initialize(env_response)
+          @env_response = env_response
+        end
+
+        def method
+          @method ||= @env_response.request.request_method
+        end
+
+        def path
+          @path ||= Tomograph::Path.new(@env_response.request.env['PATH_INFO'] || @env_response.request.fullpath)
+        end
+
+        def body
+          @body ||= @env_response.request.env['action_dispatch.request.request_parameters']
+        end
+
+        def response
+          @response ||= Fitting::Records::Tested::Response.new(@env_response)
+        end
+      end
+    end
+  end
+end

data/lib/fitting/records/tested/response.rb

@@ -0,0 +1,19 @@
+module Fitting
+  class Records
+    class Tested
+      class Response
+        def initialize(env_response)
+          @env_response = env_response
+        end
+
+        def status
+          @status ||= @env_response.status
+        end
+
+        def body
+          @body ||= @env_response.body
+        end
+      end
+    end
+  end
+end

data/lib/fitting/records/unit/json_schema.rb

@@ -0,0 +1,25 @@
+require 'json-schema'
+
+module Fitting
+  class Records
+    class Unit
+      class JsonSchema
+        def initialize(json_schema, tested_bodies)
+          @json_schema = json_schema
+          @tested_bodies = tested_bodies
+        end
+
+        def bodies
+          @bodies ||= @tested_bodies.inject([]) do |res, tested_body|
+            begin
+              next res unless JSON::Validator.validate(@json_schema, tested_body)
+              res.push(tested_body)
+            rescue JSON::Schema::UriError
+              res.push(tested_body)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fitting/records/unit/request.rb

@@ -0,0 +1,36 @@
+require 'fitting/records/unit/response'
+
+module Fitting
+  class Records
+    class Unit
+      class Request
+        def initialize(documented_request, tested_requests)
+          @documented_request = documented_request
+          @tested_requests = tested_requests
+        end
+
+        def path
+          @path ||= @documented_request.path
+        end
+
+        def method
+          @method ||= @documented_request.method
+        end
+
+        def responses
+          @responses ||= @documented_request.responses.to_a.inject([]) do |res, documented_response|
+            res.push(Fitting::Records::Unit::Response.new(documented_response, tested_responses))
+          end
+        end
+
+        def tested_responses
+          @tested_responses ||= @tested_requests.inject([]) do |res, tested_request|
+            next res unless @documented_request.method == tested_request.method &&
+                            @documented_request.path.match(tested_request.path.to_s)
+            res.push(tested_request.response)
+          end
+        end
+      end
+    end
+  end
+end