webspicy 0.10.2 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9aa4e36d2bd121fc10a478253ed1670e8c77bad2
-  data.tar.gz: a0bee8049568070cb32ad4e2069e6cf6b0f23b04
+  metadata.gz: 7b4b049f47d49e0353773deb3bd73a9e7781c9ff
+  data.tar.gz: 2092dcafacd9cdfe793add174e7e275b5626c723
 SHA512:
-  metadata.gz: 80bd1389d546f45be39f0c5298f5d3f0ef0b8f717feceaf5d6e4022e1d35e6bf1c48c58e0523b5186251e9fab1ce363617af453cadcdcc03336c03626e700a46
-  data.tar.gz: 5e1791bf8cdb6992d2e1835bf6e0f91b33f7f4d53353275b0aa47e97792ddb290cca6066ef994ea913f19cd21c957c6b8899e62c8b761ee24bfe7cd422e8fa32
+  metadata.gz: 20368b7c88e963da7731dc5f4afc1981cafdd27368735927c289b73a840ffd4693163b830f97a84911e1ab219084de272faccde7481ad37a553d2cc6fd10cbae
+  data.tar.gz: f68ad3769913376bb49173c19242e116fccfa95d7c221456fe171cf0a536132dcd911f45b0fe173027f8382f604c228c3f3f47a5c589d5fa15116e1d6ffc2054

data/examples/restful/Gemfile

@@ -1,8 +1,5 @@
 source "https://rubygems.org"
 
 gem "rake", "~> 10"
-gem 'sinatra', "~> 2.0"
-gem "path", "~> 1.3"
-gem "finitio", "~> 0.5.2"
+gem 'sinatra', "~> 2.0", ">= 2.0.2"
 gem "webspicy", path: "../.."
-gem "rack-robustness", "~> 1.1.0"

data/examples/restful/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: ../..
   specs:
     webspicy (0.10.2)
-      finitio (>= 0.5.2)
+      finitio (>= 0.6.1)
       http (~> 2)
       path (~> 1.3)
       rack-robustness (~> 1.1.0)
@@ -16,9 +16,9 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     citrus (3.0.2)
     diff-lcs (1.3)
-    domain_name (0.5.20170404)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
-    finitio (0.5.2)
+    finitio (0.6.1)
       citrus (>= 2.4, < 4.0)
     http (2.2.2)
       addressable (~> 2.3)
@@ -29,35 +29,35 @@ GEM
       domain_name (~> 0.5)
     http-form_data (1.0.3)
     http_parser.rb (0.6.0)
-    mustermann (1.0.0)
+    mustermann (1.0.2)
     path (1.3.3)
     public_suffix (3.0.2)
     rack (2.0.3)
-    rack-protection (2.0.0)
+    rack-protection (2.0.3)
       rack
     rack-robustness (1.1.0)
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    sinatra (2.0.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sinatra (2.0.3)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.0)
+      rack-protection (= 2.0.3)
       tilt (~> 2.0)
-    tilt (2.0.7)
+    tilt (2.0.8)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.5)
@@ -66,11 +66,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  finitio (~> 0.5.2)
-  path (~> 1.3)
-  rack-robustness (~> 1.1.0)
   rake (~> 10)
-  sinatra (~> 2.0)
+  sinatra (~> 2.0, >= 2.0.2)
   webspicy!
 
 BUNDLED WITH

data/examples/restful/app.rb

@@ -23,6 +23,28 @@ enable :raise_errors
 
 set :todolist, TODOLIST.dup
 
+set(:auth) do |role|
+  condition do
+    token = env['HTTP_AUTHORIZATION']
+    case token
+    when NilClass
+      halt [
+        401,
+        {'Content-Type' => 'application/json'},
+        [{ error: "Please log in first" }.to_json]
+      ]
+    when "Bearer #{role}"
+      true
+    else
+      halt [
+        401,
+        {'Content-Type' => 'application/json'},
+        [{ error: "#{role.capitalize} required" }.to_json]
+      ]
+    end
+  end
+end
+
 use Rack::Robustness do |g|
   g.no_catch_all
   g.status 400
@@ -47,7 +69,7 @@ get '/todo/' do
   settings.todolist.to_json
 end
 
-post '/todo/' do
+post '/todo/', :auth => :user do
   content_type :json
   case todos = loaded_body
   when Array
@@ -82,7 +104,7 @@ get '/todo/:id' do |id|
   end
 end
 
-patch '/todo/:id' do |id|
+patch '/todo/:id', :auth => :user do |id|
   content_type :json
   todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
   if todo.nil?
@@ -97,7 +119,7 @@ patch '/todo/:id' do |id|
   end
 end
 
-delete '/todo/:id' do |id|
+delete '/todo/:id', :auth => :admin do |id|
   content_type :json
   todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
   if todo.nil?

data/examples/restful/webspicy/config.rb

@@ -1 +1,15 @@
-Webspicy::Configuration.new(Path.dir)
+def webspicy_config(&bl)
+  Webspicy::Configuration.new(Path.dir) do |c|
+
+    c.precondition MustBeAuthenticated
+    c.precondition MustBeAnAdmin
+
+    c.instrument do |tc, client|
+      role = tc.metadata[:role]
+      tc.headers['Authorization'] = "Bearer #{role}" if role
+    end
+
+    bl.call(c) if bl
+  end
+end
+webspicy_config

data/examples/restful/webspicy/rack.rb

@@ -1,4 +1,5 @@
-Webspicy::Configuration.inherits(Path.dir) do |c|
+require_relative 'config'
+webspicy_config do |c|
   c.client = Webspicy::RackTestClient.for(::Sinatra::Application)
   c.before_each do |_,client|
     client.api.post "/reset"

data/examples/restful/webspicy/real.rb

@@ -1,4 +1,5 @@
-Webspicy::Configuration.inherits(Path.dir) do |c|
+require_relative 'config'
+webspicy_config do |c|
   c.host = "http://127.0.0.1:4567"
   c.client = Webspicy::HttpClient
   c.before_each do |_,client|

data/examples/restful/webspicy/support/must_be_an_admin.rb

@@ -0,0 +1,20 @@
+require_relative 'must_be_authenticated'
+class MustBeAnAdmin < MustBeAuthenticated
+  include Webspicy::Precondition
+
+  def self.match(service, pre)
+    MustBeAnAdmin.new(:admin) if pre =~ /Must be an admin/
+  end
+
+  def counterexamples(service)
+    examples = super
+    examples << counterexample(
+      "When authenticated as a normal user",
+      "user",
+      "Admin required",
+      401
+    )
+    examples
+  end
+
+end

data/examples/restful/webspicy/support/must_be_authenticated.rb

@@ -0,0 +1,48 @@
+class MustBeAuthenticated
+  include Webspicy::Precondition
+
+  def initialize(role = :user)
+    @role = role
+  end
+  attr_reader :role
+
+  def self.match(service, pre)
+    MustBeAuthenticated.new if pre =~ /Must be authenticated/
+  end
+
+  def instrument(test_case, client)
+    return if test_case.metadata.has_key?(:role)
+    return if test_case.description =~ /When not authenticated at all/
+    test_case.metadata[:role] = role
+  end
+
+  def counterexamples(service)
+    examples = super
+    examples << counterexample(
+      "When not authenticated at all",
+      "~",
+      "Please log in first",
+      401
+    )
+    examples
+  end
+
+  def counterexample(description, role, expected, status = 401)
+    YAML.load <<-YML.gsub(/^\s+[#][ ]/, "")
+    # description: |-
+    #   (#{self.class.name}) #{description}
+    # params:
+    #   id: 1
+    # dress_params:
+    #   false
+    # metadata:
+    #   role: #{role}
+    # expected:
+    #   content_type: application/json
+    #   status: #{status}
+    # assert:
+    #   - "pathFD('', error: '#{expected}')" 
+    YML
+  end
+
+end

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

@@ -12,7 +12,8 @@ services:
   description: |-
     Deletes a single todo item
 
-  preconditions: |-
+  preconditions:
+    - Must be an admin
 
   input_schema: |-
     {

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

@@ -12,8 +12,6 @@ services:
   description: |-
     Returns a single todo item
 
-  preconditions: |-
-
   input_schema: |-
     {
       id: Integer

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

@@ -12,8 +12,6 @@ services:
   description: |-
     Returns the list of todo items
 
-  preconditions: |-
-
   input_schema: |-
     {
     }

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

@@ -12,8 +12,6 @@ services:
   description: |-
     Returns options about the web service
 
-  preconditions: |-
-
   input_schema: |-
     {
     }

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

@@ -12,7 +12,8 @@ services:
   description: |-
     Patches a single Todo item
 
-  preconditions: |-
+  preconditions:
+    - Must be authenticated
 
   input_schema: |-
     TodoPatch

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

@@ -12,7 +12,8 @@ services:
   description: |-
     Creates new todo items through a CSV import
 
-  preconditions: |-
+  preconditions:
+    - Must be authenticated
 
   input_schema: |-
     {}

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

@@ -12,7 +12,8 @@ services:
   description: |-
     Creates new todo items through a CSV file upload
 
-  preconditions: |-
+  preconditions:
+    - Must be authenticated
 
   input_schema: |-
     .

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

@@ -12,7 +12,8 @@ services:
   description: |-
     Creates a new todo item
 
-  preconditions: |-
+  preconditions:
+    - Must be authenticated
 
   input_schema: |-
     Todo

data/lib/webspicy/client.rb

@@ -33,6 +33,13 @@ module Webspicy
     end
     private :_around
 
+    def instrument(*args, &bl)
+      args << self
+      config.listeners(:instrument).each do |i|
+        i.call(*args, &bl)
+      end
+    end
+
     def before(*args, &bl)
       args << self
       config.listeners(:before_each).each do |beach|

data/lib/webspicy/configuration.rb

@@ -247,6 +247,12 @@ module Webspicy
       register_listener(:around_each, listener)
     end
 
+    # Installs a listener that will be called right after all precondition
+    # instrumentations.
+    def instrument(&instrumentor)
+      register_listener(:instrument, instrumentor)
+    end
+
     # Allows setting the options passed at RSpec, which is used by both the runner
     # and checker classes.
     #

data/lib/webspicy/formaldoc.fio

@@ -44,6 +44,7 @@ TestCase =
         file_upload      :? FileUpload
         seeds            :? String
         requester        :? String
+        metadata         :? { ...: .Object }
         expected: {
             status       :  Integer
             content_type :? String|Nil

data/lib/webspicy/postcondition.rb

@@ -0,0 +1,14 @@
+module Webspicy
+  module Postcondition
+
+    def self.match(service, descr)
+    end
+
+    def instrument(test_case, client)
+    end
+
+    def check(invocation)
+    end
+
+  end # module Postcondition
+end # module Webspicy

data/lib/webspicy/precondition.rb

@@ -0,0 +1,15 @@
+module Webspicy
+  module Precondition
+
+    def self.match(service, pre)
+    end
+
+    def instrument(test_case, client)
+    end
+
+    def counterexamples(service)
+      []
+    end
+
+  end # module Precondition
+end # module Webspicy

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

@@ -28,6 +28,10 @@ module Webspicy
           @raw[:headers] ||= {}
         end
 
+        def metadata
+          @raw[:metadata] ||= {}
+        end
+
         def dress_params
           @raw.fetch(:dress_params){ true }
         end

data/lib/webspicy/tester.rb

@@ -60,6 +60,7 @@ module Webspicy
           client.around(test_case) do
             client.before(test_case)
             test_case.instrument(client)
+            client.instrument(test_case)
             @invocation = client.call(test_case)
             example.run
             client.after(test_case)

data/lib/webspicy/version.rb

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

data/lib/webspicy.rb

@@ -20,6 +20,8 @@ module Webspicy
   require 'webspicy/client/http_client'
   require 'webspicy/client/rack_test_client'
   require 'webspicy/resource'
+  require 'webspicy/precondition'
+  require 'webspicy/postcondition'
   require 'webspicy/checker'
   require 'webspicy/tester'
   require 'webspicy/tester/assertions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webspicy
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
 platform: ruby
 authors:
 - Bernard Lambeau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,16 +28,16 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,8 @@ files:
 - examples/restful/webspicy/rack.rb
 - examples/restful/webspicy/real.rb
 - examples/restful/webspicy/schema.fio
+- examples/restful/webspicy/support/must_be_an_admin.rb
+- examples/restful/webspicy/support/must_be_authenticated.rb
 - examples/restful/webspicy/todo/deleteTodo.yml
 - examples/restful/webspicy/todo/getTodo.yml
 - examples/restful/webspicy/todo/getTodos.yml
@@ -157,6 +159,8 @@ files:
 - lib/webspicy/configuration.rb
 - lib/webspicy/file_upload.rb
 - lib/webspicy/formaldoc.fio
+- lib/webspicy/postcondition.rb
+- lib/webspicy/precondition.rb
 - lib/webspicy/resource.rb
 - lib/webspicy/resource/service.rb
 - lib/webspicy/resource/service/invocation.rb