webspicy 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41838b2f4db0842af70e1449780812ed8e211551
-  data.tar.gz: 51d875cc4515fa99e8c5f643f8086ee6b8cbe989
+  metadata.gz: 2f7e458fbf3c7ac65bd95574e127f16791f56391
+  data.tar.gz: e2cdfa60d3e9ba3831bd49cb4a6931e675752eea
 SHA512:
-  metadata.gz: 1f2d125ccb018ab4e4b524cf5798024474084ea7ff8b46f036b2418a300072bf21814cae586cbf65d7de3ce4fef3f8b7712d67783a8ab9260edec20fa74b7b99
-  data.tar.gz: 1d2bfa5d4009220a4b4cb1aabbdc1a17017c02281cd1c497c1b1a909867aca21ae29566ce3f8dc03d1a3d7d264497c37e2b03fc2071b6db9b9703d25f5be157f
+  metadata.gz: 94edf71925034c01b1297c58e049f2f4729330c80e4db0e601e24f9409b6d609f88b24b8b8f8c707d3d6e52c7cf18dc137d948d4728e222e2305bf097ca1dfd8
+  data.tar.gz: a88aecd9681674821f4953e96519635f1a2a5d452abf100de57de0fd8d01b7121f54a72f97252384be4d23e2c93dcee5d6518f1b2ff1f1ef317d8e8de07c99b0

data/examples/restful/Gemfile

@@ -5,3 +5,4 @@ gem 'sinatra', "~> 2.0"
 gem "path", "~> 1.3"
 gem "finitio", "~> 0.5.2"
 gem "webspicy", path: "../.."
+gem "rack-robustness", "~> 1.1.0"

data/examples/restful/Gemfile.lock

@@ -1,25 +1,26 @@
 PATH
   remote: ../..
   specs:
-    webspicy (0.3.0.pre.rc2)
+    webspicy (0.5.0.pre.rc0)
       finitio (~> 0.5.2)
       http (~> 2)
       path (~> 1.3)
+      rack-robustness (~> 1.1.0)
       rack-test (~> 0.6.3)
       rspec (~> 3.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.1)
-      public_suffix (~> 2.0, >= 2.0.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     citrus (3.0.2)
     diff-lcs (1.3)
     domain_name (0.5.20170404)
       unf (>= 0.0.5, < 1.0.0)
     finitio (0.5.2)
       citrus (>= 2.4, < 4.0)
-    http (2.2.1)
+    http (2.2.2)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 1.0.1)
@@ -30,10 +31,11 @@ GEM
     http_parser.rb (0.6.0)
     mustermann (1.0.0)
     path (1.3.3)
-    public_suffix (2.0.5)
+    public_suffix (3.0.0)
     rack (2.0.3)
     rack-protection (2.0.0)
       rack
+    rack-robustness (1.1.0)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.5.0)
@@ -66,6 +68,7 @@ PLATFORMS
 DEPENDENCIES
   finitio (~> 0.5.2)
   path (~> 1.3)
+  rack-robustness (~> 1.1.0)
   rake (~> 10)
   sinatra (~> 2.0)
   webspicy!

data/examples/restful/app.rb

@@ -2,6 +2,7 @@ require 'sinatra'
 require 'json'
 require 'path'
 require 'finitio'
+require 'rack/robustness'
 
 SCHEMA = Finitio::DEFAULT_SYSTEM.parse (Path.dir/'webspicy/schema.fio').read
 
@@ -21,6 +22,15 @@ enable :raise_errors
 
 set :todolist, TODOLIST.dup
 
+use Rack::Robustness do |g|
+  g.no_catch_all
+  g.status 400
+  g.content_type 'application/json'
+  g.body{|ex| { error: ex.message }.to_json }
+  g.on(Finitio::TypeError)
+end
+
+
 post '/reset' do
   settings.todolist = TODOLIST.dup
   status 200
@@ -56,6 +66,21 @@ get '/todo/:id' do |id|
   end
 end
 
+patch '/todo/:id' 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
+    patch = SCHEMA["TodoPatch"].dress(JSON.load(request.body.read))
+    patched = todo.merge(patch)
+    settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
+    settings.todolist << patched
+    patched.to_json
+  end
+end
+
 delete '/todo/:id' do |id|
   content_type :json
   todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }

data/examples/restful/webspicy/schema.fio

@@ -2,3 +2,12 @@ Todo = {
   id          : Integer
   description : String
 }
+
+TodoPatch = {
+  id          :? Integer
+  description :? String
+}
+
+ErrorSchema = {
+  error: String
+}

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

@@ -23,9 +23,7 @@ services:
     .
 
   error_schema: |-
-    {
-      error: String
-    }
+    ErrorSchema
 
   examples:
 

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

@@ -23,9 +23,7 @@ services:
     Todo
 
   error_schema: |-
-    {
-      error: String
-    }
+    ErrorSchema
 
   examples:
 

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

@@ -22,8 +22,7 @@ services:
     [Todo]
 
   error_schema: |-
-    {
-    }
+    ErrorSchema
 
   examples:
 

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

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

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

@@ -21,9 +21,7 @@ services:
     Todo
 
   error_schema: |-
-    {
-      error: String
-    }
+    ErrorSchema
 
   examples:
 

data/lib/webspicy/client/http_client.rb

@@ -24,7 +24,7 @@ module Webspicy
       api.public_send(service.method.to_s.downcase.to_sym, url, params, headers)
 
       # Return the result
-      Resource::Service::Invocation.new(service, test_case, api.last_response)
+      Resource::Service::Invocation.new(service, test_case, api.last_response, self)
     end
 
     class Api
@@ -38,6 +38,8 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
       def post(url, params = {}, headers = nil)
@@ -47,6 +49,19 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
+      end
+
+      def patch(url, params = {}, headers = nil)
+        Webspicy.info("PATCH #{url} -- #{params.inspect}")
+
+        @last_response = HTTP[headers || {}].patch(url, body: params.to_json)
+
+        Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
+        Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
       def post_form(url, params = {}, headers = nil)
@@ -56,6 +71,8 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
       def delete(url, params = {}, headers = nil)
@@ -65,6 +82,8 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
     end

data/lib/webspicy/client/rack_test_client.rb

@@ -5,13 +5,11 @@ module Webspicy
       Factory.new(app)
     end
 
-    def initialize(scope, app, domain)
+    def initialize(scope, app)
       super(scope)
       @api = Api.new(app)
-      @domain = domain
     end
     attr_reader :api
-    attr_reader :domain
 
     def call(test_case)
       service, resource = test_case.service, test_case.resource
@@ -22,13 +20,13 @@ module Webspicy
 
       # Instantiate the url and strip parameters
       url, params = resource.instantiate_url(params)
-      url = "http://#{domain}#{url}" if domain
+      url = scope.to_real_url(url){ url }
 
       # Invoke the service now
       api.public_send(service.method.to_s.downcase.to_sym, url, params, headers)
 
       # Return the result
-      Resource::Service::Invocation.new(service, test_case, api.last_response)
+      Resource::Service::Invocation.new(service, test_case, api.last_response, self)
     end
 
     class Factory
@@ -37,15 +35,9 @@ module Webspicy
         @app = app
       end
       attr_reader :app
-      attr_reader :domain
-
-      def on(domain)
-        @domain = domain
-        self
-      end
 
       def new(scope)
-        RackTestClient.new(scope, app, domain)
+        RackTestClient.new(scope, app)
       end
 
     end # class Factory
@@ -78,6 +70,8 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
       def post(url, params = {}, headers = nil)
@@ -90,6 +84,22 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
+      end
+
+      def patch(url, params = {}, headers = nil)
+        handler = get_handler(headers)
+
+        Webspicy.info("PATCH #{url} -- #{params.inspect} -- #{headers.inspect}")
+
+        handler.patch(url, params.to_json, {"CONTENT_TYPE" => "application/json"})
+        @last_response = handler.last_response
+
+        Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
+        Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
       def post_form(url, params = {}, headers = nil)
@@ -102,6 +112,8 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
       def delete(url, params = {}, headers = nil)
@@ -114,6 +126,8 @@ module Webspicy
 
         Webspicy.debug("Headers: #{@last_response.headers.to_hash}")
         Webspicy.debug("Response: #{@last_response.body}")
+
+        @last_response
       end
 
     private

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

@@ -3,13 +3,14 @@ module Webspicy
     class Service
       class Invocation
 
-        def initialize(service, test_case, response)
+        def initialize(service, test_case, response, client)
           @service = service
           @test_case = test_case
           @response = response
+          @client = client
         end
 
-        attr_reader :service, :test_case, :response
+        attr_reader :service, :test_case, :response, :client
 
         ### Getters on response
 

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

@@ -75,7 +75,7 @@ module Webspicy
 
         def instrument
           service.preconditions.each do |pre|
-            pre.ensure(self)
+            pre.instrument(self)
           end
         end
 

data/lib/webspicy/scope.rb

@@ -93,8 +93,12 @@ module Webspicy
     end
 
     # Convert an instantiated URL found in a webservice definition
-    # to a real URL, using the configuration host
-    def to_real_url(url)
+    # to a real URL, using the configuration host.
+    #
+    # When no host resolved on the configuration and the url is not
+    # already an absolute URL, yields the block if given, or raise
+    # an exception.
+    def to_real_url(url, &bl)
       case config.host
       when Proc
         config.host.call(url)
@@ -102,6 +106,7 @@ module Webspicy
         url =~ /^http/ ? url : "#{config.host}#{url}"
       else
         return url if url =~ /^http/
+        return yield(url) if block_given?
         raise "Unable to resolve `#{url}` : no host resolver provided\nSee `Configuration#host="
       end
     end

data/lib/webspicy/version.rb

@@ -1,8 +1,8 @@
 module Webspicy
   module Version
     MAJOR = 0
-    MINOR = 4
-    TINY  = 2
+    MINOR = 5
+    TINY  = 0
   end
   VERSION = "#{Version::MAJOR}.#{Version::MINOR}.#{Version::TINY}"
 end

data/spec/unit/scope/test_to_real_url.rb

@@ -18,7 +18,12 @@ module Webspicy
         expect(got).to eql(url)
       end
 
-      it 'fails on relative URLs' do
+      it 'yields the block relative URLs' do
+        got = scope.to_real_url("/todo"){ "hello" }
+        expect(got).to eql("hello")
+      end
+
+      it 'fails on relative URLs and no block is given' do
         expect(->(){
           scope.to_real_url("/todo")
         }).to raise_error(/Unable to resolve `\/todo`/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Bernard Lambeau
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rack-robustness
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: Webspicy helps testing web services as software operation black boxes
 email: blambeau@gmail.com
 executables: []
@@ -129,6 +143,7 @@ files:
 - examples/restful/webspicy/todo/deleteTodo.yml
 - examples/restful/webspicy/todo/getTodo.yml
 - examples/restful/webspicy/todo/getTodos.yml
+- examples/restful/webspicy/todo/patchTodo.yml
 - examples/restful/webspicy/todo/postTodos.yml
 - lib/webspicy.rb
 - lib/webspicy/checker.rb