webspicy 0.18.0 → 0.19.0

data/examples/restful/webspicy/config.rb

@@ -1,24 +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.errcondition  TodoNotRemoved
-
-    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/formaldef/todo/_one/delete.yml

@@ -1,55 +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
-
-  errconditions:
-    - If it existed, the todo has not 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/formaldef/todo/_one/get.simpler.yml

@@ -1,46 +0,0 @@
----
-url: |-
-  /todo/{id}
-
-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')"

data/examples/restful/webspicy/formaldef/todo/_one/get.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')"

data/examples/restful/webspicy/formaldef/todo/_one/patch.yml

@@ -1,66 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/{id}
-
-services:
-- method: |-
-    PATCH
-
-  description: |-
-    Patches a single Todo item
-
-  preconditions:
-    - Must be authenticated
-
-  input_schema: |-
-    TodoPatch
-
-  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'
-      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/formaldef/todo/_one/put.yml

@@ -1,65 +0,0 @@
----
-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/examples/restful/webspicy/formaldef/todo/get.yml

@@ -1,36 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/
-
-services:
-- method: |-
-    GET
-
-  description: |-
-    Returns the list of todo items
-
-  input_schema: |-
-    {
-    }
-
-  output_schema: |-
-    [Todo]
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested
-      params: {}
-      expected:
-        content_type: application/json
-        status: 200
-      assert:
-        - notEmpty
-
-  counterexamples: []

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

@@ -1,32 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/
-
-services:
-- method: |-
-    OPTIONS
-
-  description: |-
-    Returns options about the web service
-
-  input_schema: |-
-    {
-    }
-
-  output_schema: |-
-    Any
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested on an existing TODO
-      params: {}
-      expected:
-        content_type: ~
-        status: 204

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

@@ -1,43 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/
-
-services:
-- method: |-
-    POST
-
-  description: |-
-    Creates new todo items through a CSV import
-
-  preconditions:
-    - Must be authenticated
-
-  input_schema: |-
-    {}
-
-  output_schema: |-
-    { count: Integer }
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested with a valid CSV
-      params: {}
-      headers:
-        Content-Type: text/csv
-      body: |-
-        id,description
-        10,Write documentation
-        11,Create website
-        12,Add smart tools
-      expected:
-        content_type: application/json
-        status: 201
-      assert:
-        - "pathFD('', count: 3)"

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

@@ -1,40 +0,0 @@
----
-name: |-
-  Todo
-
-url: |-
-  /todo/
-
-services:
-- method: |-
-    POST
-
-  description: |-
-    Creates new todo items through a CSV file upload
-
-  preconditions:
-    - Must be authenticated
-
-  input_schema: |-
-    Any
-
-  output_schema: |-
-    { count: Integer }
-
-  error_schema: |-
-    ErrorSchema
-
-  examples:
-
-    - description: |-
-        when requested with a valid CSV file
-      tags:
-        - upload
-      file_upload:
-        path: ./todos.csv
-        content_type: "text/csv"
-      expected:
-        content_type: application/json
-        status: 201
-      assert:
-        - "pathFD('', count: 3)"