webspicy 0.16.1 → 0.19.0

data/examples/restful/Rakefile

@@ -1,25 +0,0 @@
-$LOAD_PATH.unshift File.expand_path("..", __FILE__)
-require 'app'
-
-desc "Checks all .yml definition files"
-task :check do
-  Webspicy::Checker.new(Path.dir/'webspicy').call
-end
-
-namespace :test do
-  desc "Run all tests directly on Sinatra application using rack/test"
-  task :rack do
-    Webspicy::Tester.new(Path.dir/'webspicy/rack.rb').call
-  end
-
-  desc "Runs all tests on the real web server (must be launched previously)"
-  task :real do
-    Webspicy::Tester.new(Path.dir/'webspicy/real.rb').call
-  end
-end
-
-desc "Runs all checks and tests"
-task :test => :check
-task :test => :"test:rack"
-
-task :default => :test

data/examples/restful/app.rb

@@ -1,180 +0,0 @@
-require 'webspicy'
-require 'sinatra'
-require 'json'
-require 'path'
-require 'finitio'
-require 'rack/robustness'
-require 'csv'
-
-SCHEMA = Finitio::DEFAULT_SYSTEM.parse (Path.dir/('webspicy/schema.fio')).read
-
-TODOLIST = [
-  {
-    id: 1,
-    description: "Refactor the framework"
-  },
-  {
-    id: 2,
-    description: "Write documentation"
-  }
-]
-
-disable :show_exceptions
-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
-  g.content_type 'application/json'
-  g.body{|ex| { error: ex.message }.to_json }
-  g.on(Finitio::TypeError)
-end
-
-options '*' do
-  status 204
-  ""
-end
-
-post '/reset' do
-  settings.todolist = TODOLIST.dup
-  status 200
-  ""
-end
-
-get '/todo/' do
-  raise unless request.env['HTTP_ACCEPT'] == 'application/json'
-  content_type :json
-  settings.todolist.to_json
-end
-
-post '/todo/', :auth => :user do
-  content_type :json
-  case todos = loaded_body
-  when Array
-    n = 0
-    todos.each do |todo|
-      settings.todolist << todo
-      n += 1
-    end
-    status 201
-    { count: n }.to_json
-  when Hash
-    todo = SCHEMA["Todo"].dress(todos)
-    if settings.todolist.find{|t| t[:id] == todo[:id] }
-      status 409
-      {error: "Identifier already in use"}.to_json
-    else
-      settings.todolist << todo
-      status 201
-      todo.to_json
-    end
-  end
-end
-
-get '/todo/:id' do |id|
-  raise unless request.env['HTTP_ACCEPT'] == 'application/json'
-  content_type :json
-  todo = settings.todolist.find{|todo| todo[:id] == Integer(id) }
-  if todo.nil?
-    status 404
-    {error: "No such todo"}.to_json
-  else
-    todo.to_json
-  end
-end
-
-patch '/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
-    patch = SCHEMA["TodoPatch"].dress(loaded_body.merge("id" => Integer(id)))
-    patched = todo.merge(patch)
-    settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
-    settings.todolist << patched
-    patched.to_json
-  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) }
-  if todo.nil?
-    status 404
-    {error: "No such todo"}.to_json
-  else
-    settings.todolist = settings.todolist.reject{|todo| todo[:id] == Integer(id) }
-    status 204
-    content_type "text/plain"
-  end
-end
-
-###
-
-def loaded_body
-  case ctype = request.content_type
-  when /json/
-    JSON.load(request.body.read)
-  when /csv/
-    csv = ::CSV.new(request.body.read, :headers => true, :header_converters => :symbol)
-    csv.map {|row| row.to_hash }
-  when /multipart\/form-data/
-    file_body params[:file]
-  else
-    halt [415,{},["Unsupported content type: `#{ctype}`"]]
-  end
-end
-
-def file_body(file)
-  ctype = Path(file[:filename] || file["filename"]).extname
-  ctype = (file[:type] || file["type"]) if ctype.nil? or ctype.empty?
-  case ctype
-  when /csv/
-    str = file[:tempfile].read
-    csv = ::CSV.new(str, :headers => true, :header_converters => :symbol)
-    csv.map {|row| row.to_hash }
-  else
-    halt [415,{},["Unsupported content type: `#{ctype}`\n#{file.inspect}"]]
-  end
-end

data/examples/restful/webspicy/config.rb

@@ -1,23 +0,0 @@
-def webspicy_config(&bl)
-  Webspicy::Configuration.new(Path.dir) do |c|
-
-    c.precondition MustBeAuthenticated
-    c.precondition MustBeAnAdmin
-
-    c.precondition Webspicy::Specification::Precondition::GlobalRequestHeaders.new({
-      'Accept' => 'application/json'
-    }){|service| service.method == "GET" }
-
-    c.precondition Webspicy::Specification::Precondition::RobustToInvalidInput.new
-
-    c.postcondition TodoRemoved
-
-    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,7 +0,0 @@
-require_relative 'config'
-webspicy_config do |c|
-  c.client = Webspicy::Tester::RackTestClient.for(::Sinatra::Application)
-  c.before_each do |_,client|
-    client.api.post "/reset"
-  end
-end

data/examples/restful/webspicy/real.rb

@@ -1,8 +0,0 @@
-require_relative 'config'
-webspicy_config do |c|
-  c.host = "http://127.0.0.1:4567"
-  c.client = Webspicy::Tester::HttpClient
-  c.before_each do |_,client|
-    client.api.post "http://127.0.0.1:4567/reset"
-  end
-end

data/examples/restful/webspicy/schema.fio

@@ -1,20 +0,0 @@
-@import webspicy/scalars
-
-Todo = {
-  id          : Integer
-  description : String
-}
-
-TodoPatch = {
-  id          :  Integer
-  description :? String
-}
-
-TodoPut = {
-  id          : Integer
-  description : String
-}
-
-ErrorSchema = {
-  error: String
-}

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

@@ -1,20 +0,0 @@
-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

@@ -1,48 +0,0 @@
-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: |-
-    #   #{description} (#{self.class.name} PRE)
-    # 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/support/todo_removed.rb

@@ -1,18 +0,0 @@
-class TodoRemoved
-  include Webspicy::Specification::Postcondition
-
-  def self.match(service, descr)
-    return TodoRemoved.new if descr =~ /The todo has been removed/
-  end
-
-  def check(invocation)
-    client = invocation.client
-    id = invocation.test_case.params['id']
-    url = "/todo/#{id}"
-    response = client.api.get(url, {}, {
-      "Accept" => "application/json"
-    })
-    return nil if response.status == 404
-    "Todo `#{id}` was not deleted, it has been found"
-  end
-end

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

@@ -1,52 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/{id}
-
-services:
-- method: |-
-    DELETE
-
-  description: |-
-    Deletes a single todo item
-
-  preconditions:
-    - Must be an admin
-
-  postconditions:
-    - The todo has been removed
-
-  input_schema: |-
-    {
-      id: Integer
-    }
-
-  output_schema: |-
-    Any
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested on an existing TODO
-      params:
-        id: 1
-      expected:
-        content_type: ~
-        status: 204
-
-  counterexamples:
-
-    - description: |-
-        when requested on an unexisting TODO
-      params:
-        id: 999254654
-      expected:
-        content_type: application/json
-        status: 404
-      assert:
-        - "pathFD('', error: 'No such todo')"

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

@@ -1,50 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/{id}
-
-services:
-- method: |-
-    GET
-
-  description: |-
-    Returns a single todo item
-
-  input_schema: |-
-    {
-      id: Integer
-    }
-
-  output_schema: |-
-    Todo
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested on an existing TODO
-      params:
-        id: 1
-      expected:
-        content_type: application/json
-        status: 200
-      assert:
-        - "pathFD('', id: 1)"
-        - "match('description', /Refactor/)"
-        - "notMatch('description', /Foo/)"
-
-  counterexamples:
-
-    - description: |-
-        when requested on an unexisting TODO
-      params:
-        id: 999254654
-      expected:
-        content_type: application/json
-        status: 404
-      assert:
-        - "pathFD('', error: 'No such todo')"