webspicy 0.18.0 → 0.19.0

data/examples/restful/webspicy/formaldef/todo/post.yml

@@ -1,51 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/
-
-services:
-- method: |-
-    POST
-
-  description: |-
-    Creates a new todo item
-
-  preconditions:
-    - Must be authenticated
-
-  input_schema: |-
-    Todo
-
-  output_schema: |-
-    Todo
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested with a non existing ID
-      params:
-        id: 3
-        description: "Hello World"
-      expected:
-        content_type: application/json
-        status: 201
-      assert:
-        - "pathFD('', id: 3)"
-
-  counterexamples:
-
-    - description: |-
-        when requested while the id already exists
-      params:
-        id: 1
-        description: "Hello World"
-      expected:
-        content_type: application/json
-        status: 409
-      assert:
-        - "pathFD('', error: 'Identifier already in use')"

data/examples/restful/webspicy/formaldef/todo/todos.csv

@@ -1,4 +0,0 @@
-id,description
-10,Write documentation
-11,Create website
-12,Add smart tools

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_not_removed.rb

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

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

@@ -1,20 +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, scope, test_case = invocation.client,
-                               invocation.client.scope,
-                               invocation.test_case
-    id = test_case.params['id']
-    url = scope.to_real_url("/todo/#{id}", test_case){|url| url }
-    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/single_spec/spec.yml

@@ -1,59 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  http://127.0.0.1:4567/todo/{id}
-
-services:
-- method: |-
-    GET
-
-  description: |-
-    Returns a single todo item
-
-  input_schema: |-
-    {
-      id: Integer
-    }
-
-  output_schema: |-
-    {
-      id: Integer
-      description: String
-    }
-
-  error_schema: |-
-    {
-      error: String
-    }
-
-  examples:
-
-    - description: |-
-        when requested on an existing TODO
-      headers:
-        Accept: application/json
-      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
-      headers:
-        Accept: application/json
-      params:
-        id: 999254654
-      expected:
-        content_type: application/json
-        status: 404
-      assert:
-        - "pathFD('', error: 'No such todo')"

data/examples/website/config.rb

@@ -1,2 +0,0 @@
-Webspicy::Configuration.new{|c|
-}

data/examples/website/schema.fio

@@ -1 +0,0 @@
-@import webspicy/scalars

data/examples/website/specification/get-http.yml

@@ -1,30 +0,0 @@
----
-url: |-
-  http://yourbackendisbroken.dev
-
-method: |-
-  GET
-
-description: |-
-  Redirects to the https version
-
-input_schema: |-
-  Any
-
-output_schema: |-
-  Any
-
-error_schema: |-
-  Any
-
-examples:
-
-  - description: |-
-      it works
-    params:
-      id: 1
-    expected:
-      content_type: text/html
-      status: 3xx
-      headers:
-        Location: https://yourbackendisbroken.dev/?id=1

data/examples/website/specification/get-https.yml

@@ -1,30 +0,0 @@
----
-url: |-
-  https://yourbackendisbroken.dev
-
-method: |-
-  GET
-
-description: |-
-  Returns the web page
-
-input_schema: |-
-  Any
-
-output_schema: |-
-  Any
-
-error_schema: |-
-  Any
-
-examples:
-
-  - description: |-
-      it works
-    params:
-      id: 1
-    expected:
-      content_type: text/html
-      status: 200
-    assert:
-      - notEmpty

data/lib/webspicy/checker.rb

@@ -1,10 +0,0 @@
-module Webspicy
-  class Checker
-
-    def self.new(*args, &bl)
-      require_relative 'rspec/checker'
-      RSpecChecker.new(*args, &bl)
-    end
-
-  end # class Checker
-end # module Webspicy

data/lib/webspicy/mocker.rb

@@ -1,88 +0,0 @@
-require "finitio/generation"
-require "json"
-module Webspicy
-  class Mocker
-
-    def initialize(config)
-      @config = Configuration.dress(config)
-      @generator = config.generator || Finitio::Generation.new
-    end
-    attr_reader :config, :generator
-
-    def call(env)
-      req = Rack::Request.new(env)
-      path = req.path
-      meth = req.request_method
-      if meth == "OPTIONS" && has_service?(path)
-        [204, {}, []]
-      elsif service = find_service(meth, path)
-        status = best_status_code(service)
-        body = status == 204 ? "" : random_body(service, req)
-        headers = generate_headers(service)
-        [ status, headers, [ body ].compact ]
-      else
-        [404, {}, []]
-      end
-    end
-
-  private
-
-    def has_service?(path)
-      config.each_scope do |scope|
-        scope.each_specification do |specification|
-          next unless url_matches?(specification, path)
-          return true
-        end
-      end
-      return false
-    end
-
-    def find_service(method, path)
-      config.each_scope do |scope|
-        scope.each_specification do |specification|
-          next unless url_matches?(specification, path)
-          scope.each_service(specification) do |service|
-            return service if service.method == method
-          end
-        end
-      end
-      nil
-    end
-
-    def generate_headers(service)
-      {
-        "Content-Type" => best_content_type(service)
-      }.delete_if{|k,v| v.nil? }
-    end
-
-    def best_status_code(service)
-      if ex = service.examples.first
-        (ex.expected_status && ex.expected_status.to_i) || 200
-      else
-        200
-      end
-    end
-
-    def best_content_type(service)
-      if ex = service.examples.first
-        ex.expected_content_type
-      else
-        "application/json"
-      end
-    end
-
-    def url_matches?(specification, path)
-      specification.url_pattern.match(path)
-    end
-
-    def random_body(service, request)
-      world = OpenStruct.new({
-        service: service,
-        request: request
-      })
-      data = generator.call(service.output_schema.main, world)
-      JSON.pretty_generate(data) if data
-    end
-
-  end # class Mocker
-end # module Webspicy