webspicy 0.15.3 → 0.15.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d510f36443e5ef38eaabf4c09c6286c1e1aa556a9bb67fd5f5b67303b1faef4c
-  data.tar.gz: bb8b064c714f10bef673d6e61fa0fe71037d8b0e0f8479a4bdb874bbce5484e6
+  metadata.gz: e1d234226f15d51777e61c010557ed1691660613cd87ba11ce19844b2f7cc812
+  data.tar.gz: 40fcd4639ce847f7f69f3471ef9676c64e8e6be489388563d5abd51ca1bf39d7
 SHA512:
-  metadata.gz: dce79c2eba1d8fa74408280cabc8d06eee163fc4f1e8d5b8dfbfb1d4f167063dba68c54a0b1f18d4a72ac2ae88baa5f1a169f9f54b9073cce2c1174efd0b02a8
-  data.tar.gz: b0665863864804a9977c73f25eb22d12930cf623e0db3bf67ea07a15d81162434ecf0e5cf1c12007abba6a6d1ea37f8fdb91cb99afa82893fd4e0b15c7d98ec6
+  metadata.gz: c4d0ec9a0567955bac41c5ee887164e783799e2baf66966fabff404147376c29192a4b28090c7d816a20fd15bc7e470b20136e253b9b1a7d663ac57de4958d99
+  data.tar.gz: 4ddccde82357c81066108133b0e5b63ea8b5a0b714556b56b4d4743ba26aaaf17a9187633061dc2f721b88833cdfb536f795d8256aa158723c4fa5a255957144

data/bin/webspicy

@@ -29,7 +29,8 @@ if ARGV.size != 1
   exit(-1)
 elsif (p = Path(ARGV.first)).exists?
   config = Webspicy::Configuration.dress(p)
-  Webspicy::Tester.new(config).call
+  res = Webspicy::Tester.new(config).call
+  abort("Some tests failed") unless res == 0
 else
   puts "No such file or directory `#{ARGV.first}`"
   showhelp

data/examples/restful/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem "rake", "~> 10"
-gem 'sinatra', "~> 2.0", ">= 2.0.2"
+gem "rake", "~> 12"
+gem 'sinatra', "~> 2"
 gem "webspicy", path: "../.."

data/examples/restful/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.15.3)
+    webspicy (0.15.8)
       finitio (>= 0.8.0)
       http (>= 2)
       mustermann (~> 1.0)
@@ -18,48 +18,53 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     citrus (3.0.2)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    ffi (1.13.1)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
     finitio (0.8.0)
       citrus (>= 2.4, < 4.0)
     hansi (0.2.0)
-    http (2.2.2)
+    http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
-      http-form_data (~> 1.0.1)
-      http_parser.rb (~> 0.6.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (1.0.3)
-    http_parser.rb (0.6.0)
+    http-form_data (2.3.0)
+    http-parser (1.2.1)
+      ffi-compiler (>= 1.0, < 2.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
     mustermann-contrib (1.1.1)
       hansi (~> 0.2.0)
       mustermann (= 1.1.1)
-    path (1.3.3)
-    public_suffix (4.0.3)
-    rack (2.2.2)
+    path (2.0.1)
+    public_suffix (4.0.5)
+    rack (2.2.3)
     rack-protection (2.0.8.1)
       rack
     rack-robustness (1.1.0)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rake (10.5.0)
+    rake (12.3.3)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
     ruby2_keywords (0.0.2)
@@ -71,14 +76,14 @@ GEM
     tilt (2.0.10)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.6)
+    unf_ext (0.0.7.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rake (~> 10)
-  sinatra (~> 2.0, >= 2.0.2)
+  rake (~> 12)
+  sinatra (~> 2)
   webspicy!
 
 BUNDLED WITH

data/examples/restful/app.rb

@@ -119,6 +119,21 @@ patch '/todo/:id', :auth => :user do |id|
   end
 end
 
+put '/todo/:id', :auth => :user do |id|
+  content_type :json
+  todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
+  if todo.nil?
+    status 404
+    {error: "No such todo"}.to_json
+  else
+    put = SCHEMA["TodoPut"].dress(loaded_body.merge(id: Integer(id)))
+    updated = todo.merge(put)
+    settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
+    settings.todolist << updated
+    updated.to_json
+  end
+end
+
 delete '/todo/:id', :auth => :admin do |id|
   content_type :json
   todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }

data/examples/restful/webspicy/schema.fio

@@ -10,6 +10,11 @@ TodoPatch = {
   description :? String
 }
 
+TodoPut = {
+  id          : Integer
+  description : String
+}
+
 ErrorSchema = {
   error: String
 }

data/examples/restful/webspicy/todo/putTodo.yml

@@ -0,0 +1,65 @@
+---
+name: |-
+  Todo
+
+url: |-
+  /todo/{id}
+
+services:
+- method: |-
+    PUT
+
+  description: |-
+    Update a single Todo item
+
+  preconditions:
+    - Must be authenticated
+
+  input_schema: |-
+    TodoPut
+
+  output_schema: |-
+    Todo
+
+  error_schema: |-
+    ErrorSchema
+
+  default_example:
+    expected:
+      content_type: application/json
+      status: 200
+
+  examples:
+
+    - description: |-
+        when requested on an existing TODO
+      params:
+        id: 1
+        description: 'hello world'
+      assert:
+        - "pathFD('', description: 'hello world')"
+
+  counterexamples:
+
+    - description: |-
+        when requested on an unexisting TODO
+      params:
+        id: 999254654
+        description: 'hello world'
+      expected:
+        content_type: application/json
+        status: 404
+      assert:
+        - "pathFD('', error: 'No such todo')"
+
+    - description: |-
+        when violating the Put data type
+      params:
+        id: 1
+        description: 'hello world'
+        nosuchone: 'foobar'
+      dress_params:
+        false
+      expected:
+        content_type: application/json
+        status: 400

data/lib/webspicy.rb

@@ -14,6 +14,7 @@ module Webspicy
   ### Load library
   ###
 
+  require 'webspicy/support'
   require 'webspicy/configuration'
   require 'webspicy/file_upload'
   require 'webspicy/scope'

data/lib/webspicy/client/http_client.rb

@@ -107,6 +107,18 @@ module Webspicy
         @last_response
       end
 
+      def put(url, params = {}, headers = nil, body = nil)
+        info_request("PUT", url, params, headers, body)
+
+        headers ||= {}
+        headers['Content-Type'] ||= 'application/json'
+        @last_response = HTTP[headers].put(url, body: params.to_json)
+
+        debug_response(@last_response)
+
+        @last_response
+      end
+
       def post_form(url, params = {}, headers = nil, body = nil)
         info_request("POST", url, params, headers, body)
 

data/lib/webspicy/client/rack_test_client.rb

@@ -126,6 +126,19 @@ module Webspicy
         @last_response
       end
 
+      def put(url, params = {}, headers = nil, body = nil)
+        handler = get_handler(headers)
+
+        info_request("PUT", url, params, headers, body)
+
+        handler.put(url, params.to_json, {"CONTENT_TYPE" => "application/json"})
+        @last_response = handler.last_response
+
+        debug_response(@last_response)
+
+        @last_response
+      end
+
       def post_form(url, params = {}, headers = nil, body = nil)
         handler = get_handler(headers)
 

data/lib/webspicy/configuration.rb

@@ -11,6 +11,7 @@ module Webspicy
       @postconditions = []
       @listeners = Hash.new{|h,k| h[k] = [] }
       @rspec_options = default_rspec_options
+      @run_examples = default_run_examples
       @run_counterexamples = default_run_counterexamples
       @file_filter = default_file_filter
       @service_filter = default_service_filter
@@ -94,6 +95,23 @@ module Webspicy
       !children.empty?
     end
 
+    # Sets whether examples have to be ran or not.
+    def run_examples=(run_examples)
+      @run_examples = run_examples
+    end
+    attr_reader :run_examples
+
+    # Whether counter examples must be ran or not.
+    def run_examples?
+      @run_examples
+    end
+
+    # Returns the defaut value for run_examples
+    def default_run_examples
+      ENV['ROBUST'].nil? || (ENV['ROBUST'] != 'only')
+    end
+    private :default_run_examples
+
     # Sets whether counter examples have to be ran or not.
     def run_counterexamples=(run_counterexamples)
       @run_counterexamples = run_counterexamples

data/lib/webspicy/formaldoc.fio

@@ -1,7 +1,7 @@
 @import finitio/data
 
 Method =
-    String( s | s =~ /^(GET|POST|POST_FORM|PUT|DELETE|PATCH|OPTIONS)$/ )
+    String( s | s =~ /^(GET|POST|POST_FORM|PUT|DELETE|PATCH|PUT|OPTIONS)$/ )
 
 Tag = String( s | s.length > 0 )
 
@@ -51,7 +51,7 @@ TestCase =
         requester        :? String
         metadata         :? { ...: .Object }
         expected         :? {
-            status       :? Integer
+            status       :? StatusRange
             content_type :? String|Nil
             error        :? String
             headers      :? .Hash
@@ -61,3 +61,7 @@ TestCase =
     }
 
 Params = .Array|.Hash
+
+StatusRange = .Webspicy::Support::StatusRange
+  <int> Integer
+  <str> String(s | s =~ /^\dxx$/ )

data/lib/webspicy/mocker.rb

@@ -57,7 +57,7 @@ module Webspicy
 
     def best_status_code(service)
       if ex = service.examples.first
-        ex.expected_status || 200
+        (ex.expected_status && ex.expected_status.to_i) || 200
       else
         200
       end

data/lib/webspicy/resource/service/invocation.rb

@@ -53,7 +53,7 @@ module Webspicy
         end
 
         def is_expected_success?
-          test_case.expected_status >= 200 && test_case.expected_status < 300
+          test_case.expected_status.to_i >= 200 && test_case.expected_status.to_i < 300
         end
 
         def is_success?
@@ -73,7 +73,7 @@ module Webspicy
         def expected_status_unmet
           expected = test_case.expected_status
           got = response.status
-          expected == got ? nil : "#{expected} != #{got}"
+          expected === got ? nil : "#{expected} !== #{got}"
         end
 
         def meets_expected_status?
@@ -89,7 +89,7 @@ module Webspicy
           if ect.nil?
             got.nil? ? nil : "#{ect} != #{got}"
           else
-            ect.to_s == got.to_s ? nil : "#{ect} != #{got}"
+            got.to_s.start_with?(ect.to_s) ? nil : "#{ect} != #{got}"
           end
         end
 

data/lib/webspicy/resource/service/test_case.rb

@@ -82,7 +82,7 @@ module Webspicy
         end
 
         def is_expected_status?(status)
-          expected_status == status
+          expected_status === status
         end
 
         def expected_error

data/lib/webspicy/scope.rb

@@ -46,23 +46,26 @@ module Webspicy
       resource.services.select(&to_filter_proc(config.service_filter)).each(&bl)
     end
 
-    def each_example(service)
-      service.examples.select(&to_filter_proc(config.test_case_filter)).each{|e|
-        yield(expand_example(service, e))
-      }
+    def each_example(service, &bl)
+      service.examples
+        .map{|e| expand_example(service, e) }
+        .select(&to_filter_proc(config.test_case_filter))
+        .each(&bl) if config.run_examples?
     end
 
     def each_counterexamples(service, &bl)
-      service.counterexamples.select(&to_filter_proc(config.test_case_filter)).each{|e|
-        yield(expand_example(service, e))
-      } if config.run_counterexamples?
+      service.counterexamples
+        .map{|e| expand_example(service, e) }
+        .select(&to_filter_proc(config.test_case_filter))
+        .each(&bl) if config.run_counterexamples?
     end
 
     def each_generated_counterexamples(service, &bl)
       Webspicy.with_scope(self) do
-        service.generated_counterexamples.select(&to_filter_proc(config.test_case_filter)).each{|e|
-          yield(expand_example(service, e))
-        }
+        service.generated_counterexamples
+          .map{|e| expand_example(service, e) }
+          .select(&to_filter_proc(config.test_case_filter))
+          .each(&bl) if config.run_counterexamples?
       end if config.run_counterexamples?
     end
 

data/lib/webspicy/support.rb

@@ -0,0 +1 @@
+require_relative 'support/status_range'

data/lib/webspicy/support/status_range.rb

@@ -0,0 +1,50 @@
+module Webspicy
+  module Support
+    class StatusRange
+
+      def initialize(range)
+        @range = range
+      end
+      attr_reader :range
+
+      def self.int(i)
+        new(i..i)
+      end
+
+      def to_int
+        @range.first
+      end
+
+      def self.str(s)
+        from = s[/^(\d)/,1].to_i * 100
+        new(from...from+100)
+      end
+
+      def to_str
+        "#{@range.first/100}xx"
+      end
+
+      def to_i
+        @range.first
+      end
+
+      def ===(status)
+        range === status
+      end
+
+      def ==(other)
+        other.is_a?(StatusRange) && self.range == other.range
+      end
+      alias :eql? :==
+
+      def hash
+        @range.hash
+      end
+
+      def to_s
+        @range.to_s
+      end
+
+    end # class StatusRange
+  end # module Support
+end # module Webspicy

data/lib/webspicy/version.rb

@@ -2,7 +2,7 @@ module Webspicy
   module Version
     MAJOR = 0
     MINOR = 15
-    TINY  = 3
+    TINY  = 8
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/scope/test_expand_example.rb

@@ -53,7 +53,7 @@ module Webspicy
         expect(subject).to be_a(Resource::Service::TestCase)
         expect(subject.description).to eql("Hello world")
         expect(subject.expected).to eql({
-          status: 200,
+          status: Support::StatusRange.int(200),
           content_type: "application/json"
         })
       end

data/spec/unit/support/test_status_range.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+module Webspicy
+  module Support
+    describe StatusRange do
+
+      it 'has a int information contract' do
+        expect(StatusRange.int(100).range).to eql(100..100)
+        expect(StatusRange.int(100).to_int).to eql(100)
+      end
+
+      it 'has a str information contract' do
+        expect(StatusRange.str("3xx").range).to eql(300...400)
+        expect(StatusRange.str("3xx").to_str).to eql("3xx")
+      end
+
+      it 'has a to_i that returns the first status of the range' do
+        expect(StatusRange.int(300).to_i).to eql(300)
+        expect(StatusRange.str("3xx").to_i).to eql(300)
+      end
+
+      it 'has a matching method' do
+        expect(StatusRange.str("3xx") === 300).to eql(true)
+        expect(StatusRange.str("3xx") === 302).to eql(true)
+        expect(StatusRange.str("3xx") === 400).to eql(false)
+      end
+
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.15.3
+  version: 0.15.8
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-05 00:00:00.000000000 Z
+date: 2020-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,34 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +200,7 @@ files:
 - examples/restful/webspicy/todo/postCsv.yml
 - examples/restful/webspicy/todo/postFile.yml
 - examples/restful/webspicy/todo/postTodos.yml
+- examples/restful/webspicy/todo/putTodo.yml
 - examples/restful/webspicy/todo/todos.csv
 - lib/webspicy.rb
 - lib/webspicy/checker.rb
@@ -224,6 +219,8 @@ files:
 - lib/webspicy/resource/service/invocation.rb
 - lib/webspicy/resource/service/test_case.rb
 - lib/webspicy/scope.rb
+- lib/webspicy/support.rb
+- lib/webspicy/support/status_range.rb
 - lib/webspicy/tester.rb
 - lib/webspicy/tester/asserter.rb
 - lib/webspicy/tester/assertions.rb
@@ -239,6 +236,7 @@ files:
 - spec/unit/scope/test_expand_example.rb
 - spec/unit/scope/test_to_real_url.rb
 - spec/unit/spec_helper.rb
+- spec/unit/support/test_status_range.rb
 - spec/unit/test_configuration.rb
 - spec/unit/tester/test_assertions.rb
 - tasks/gem.rake