@toa.io/extensions.exposition 1.0.0-alpha.2 → 1.0.0-alpha.200

package/features/errors.feature

@@ -8,11 +8,14 @@ Feature: Errors
     When the following request is received:
       """
       GET <path> HTTP/1.1
-      accept: application/yaml
+      host: nex.toa.io
+      accept: text/plain
       """
     Then the following reply is sent:
       """
       404 Not Found
+
+      Route not found
       """
     Examples:
       | path                                 |
@@ -28,6 +31,7 @@ Feature: Errors
     When the following request is received:
       """
       GET /basic/greeter HTTP/1.1
+      host: nex.toa.io
       accept: application/json
       """
     Then the following reply is sent:
@@ -35,7 +39,7 @@ Feature: Errors
       404 Not Found
       content-type: application/json
 
-      "Trailing slash is required."
+      "Trailing slash is required"
       """
 
   Scenario: Missing method
@@ -43,10 +47,11 @@ Feature: Errors
     When the following request is received:
       """
       PATCH /greeter/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
-      """http
+      """
       405 Method Not Allowed
       """
 
@@ -54,10 +59,11 @@ Feature: Errors
     When the following request is received:
       """
       COPY /basic/greeter/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       """
     Then the following reply is sent:
-      """http
+      """
       501 Not Implemented
       """
 
@@ -66,11 +72,12 @@ Feature: Errors
       """yaml
       exposition:
         /:
-          POST: transit
+          POST: create
       """
     When the following request is received:
       """
       POST /pots/ HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/yaml
 
@@ -95,6 +102,7 @@ Feature: Errors
     When the following request is received:
       """
       GET /pots/?limit=1001 HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -102,7 +110,7 @@ Feature: Errors
       400 Bad Request
       content-type: text/plain
 
-      Query limit must be between 1 and 1000 inclusive.
+      Query limit must be between 1 and 100 inclusive
       """
 
   Scenario: Closed query criteria
@@ -113,11 +121,12 @@ Feature: Errors
           GET:
             endpoint: enumerate
             query:
-              criteria: temerature>60
+              criteria: temperature>60
       """
     When the following request is received:
       """
       GET /pots/hot/?criteria=volume>500 HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -125,7 +134,7 @@ Feature: Errors
       400 Bad Request
       content-type: text/plain
 
-      Query criteria is closed.
+      Query criteria is closed
       """
 
   Scenario: Additional query parameters
@@ -139,6 +148,7 @@ Feature: Errors
     When the following request is received:
       """
       GET /pots/?foo=bar HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -146,7 +156,7 @@ Feature: Errors
       400 Bad Request
       content-type: text/plain
 
-      Query must NOT have additional properties
+      Query Property foo is not expected to be here
       """
 
   Scenario: Malformed authorization header
@@ -158,6 +168,7 @@ Feature: Errors
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       authorization: Basic
       accept: text/plain
       """
@@ -165,7 +176,7 @@ Feature: Errors
       """
       401 Unauthorized
 
-      Malformed authorization header.
+      Malformed authorization header
       """
 
   Scenario Outline: Exception is thrown (debug: <debug>)
@@ -180,6 +191,7 @@ Feature: Errors
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -197,15 +209,29 @@ Feature: Errors
       """yaml
       /:
         GET:
+          io:output: true
           anonymous: true
           dev:stub: hello
       """
     When the following request is received:
       """
       GET / HTTP/1.1
+      host: nex.toa.io
       accept: image/jpeg
       """
     Then the following reply is sent:
       """
       406 Not Acceptable
       """
+
+  Scenario: Not acceptable request with error
+    When the following request is received:
+      """
+      GET /robots.txt HTTP/1.1
+      host: nex.toa.io
+      accept: text/html
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """

package/features/etag.feature

@@ -0,0 +1,236 @@
+Feature: Optimistic concurrency control
+
+  Scenario: Using `etag`
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+          /:id:
+            GET: observe
+            PUT: transit
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      etag: "1"
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      GET /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      etag: "1"
+      """
+    When the following request is received:
+      """
+      GET /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      if-none-match: "1"
+      """
+    Then the following reply is sent:
+      """
+      304 Not Modified
+      etag: "1"
+      """
+    When the following request is received:
+      """
+      PUT /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      if-match: "38"
+
+      volume: 2.5
+      """
+    Then the following reply is sent:
+      """
+      412 Precondition Failed
+      """
+    When the following request is received:
+      """
+      PUT /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      if-match: "1"
+
+      volume: 2.5
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      etag: "2"
+      """
+
+  Scenario: Using etag with enumeration
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          GET: enumerate
+      """
+    When the following request is received:
+      """
+      GET /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      etag: ${{ etag }}
+      """
+    When the following request is received:
+      """
+      GET /pots/ HTTP/1.1
+      host: nex.toa.io
+      if-none-match: ${{ etag }}
+      """
+    Then the following reply is sent:
+      """
+      304 Not Modified
+      etag: ${{ etag }}
+      """
+
+  Scenario: Weak `etag`
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          io:output: true
+          POST: create
+          /:id:
+            GET: observe
+            PUT: transit
+      """
+    When the following request is received:
+      """
+      POST /pots/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/yaml
+
+      title: Hello
+      volume: 1.5
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      etag: "1"
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      GET /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      etag: "1"
+      """
+    When the following request is received:
+      """
+      GET /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      if-none-match: W/"1"
+      """
+    Then the following reply is sent:
+      """
+      304 Not Modified
+      etag: W/"1"
+      """
+    When the following request is received:
+      """
+      PUT /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      if-match: W/"38"
+
+      volume: 2.5
+      """
+    Then the following reply is sent:
+      """
+      412 Precondition Failed
+      """
+    When the following request is received:
+      """
+      PUT /pots/${{ id }}/ HTTP/1.1
+      host: nex.toa.io
+      content-type: application/yaml
+      if-match: W/"1"
+
+      volume: 2.5
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      etag: "2"
+      """
+
+  Scenario: Unexpected `if-match` format
+    Given the `pots` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          /:id:
+            PUT: transit
+      """
+    When the following request is received:
+      """
+      PUT /pots/fa177da8393544139915795816ad6b97/ HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      content-type: application/yaml
+      if-match: "oopsie"
+
+      volume: 2.5
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Invalid ETag
+      """
+
+  Scenario: Etag with non-queryable operation
+    Given the `echo` is running with the following manifest:
+      """yaml
+      exposition:
+        /:foo/:id:
+          GET:
+            io:output: true
+            map:headers:
+              name: if-match
+            endpoint: affect
+      """
+    When the following request is received:
+      """
+      GET /echo/foo/Bob/ HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      if-match: "1"
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      Hello "1"
+      """

package/features/flow.feature

@@ -0,0 +1,148 @@
+Feature: Request flow
+
+  Scenario: Fetching URL
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        octets:context: octets
+        /:type:
+          GET:
+            anonymous: true
+            io:output: true
+            flow:fetch: octets.tester.redirect
+      """
+    When the following request is received:
+      """
+      GET /rfc HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: text/plain
+
+      Faster Than Light Speed Protocol (FLIP)
+      """
+    When the following request is received:
+      """
+      GET /img HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: image/svg+xml
+      """
+    When the following request is received:
+      """
+      GET /err HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+      """
+
+  Scenario: Composing a stream
+    Given the `sequences` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          flow:compose:
+            a: $[0]
+            b: $[1]
+            c: $[2]
+            sum: $[0] + $[1] + $[2]
+            str: \hello
+            num: 1
+            arr:
+              - $[0]
+              - $[1]
+              - $[2]
+              - $[0] + $[1] + $[2]
+            copy: $
+          POST: numbers
+      """
+    When the following request is received:
+      """
+      POST /sequences/ HTTP/1.1
+      host: nex.toa.io
+      content-type: text/plain
+      accept: application/yaml
+
+      3
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: application/yaml
+
+      a: 0
+      b: 1
+      c: 2
+      sum: 3
+      str: hello
+      num: 1
+      arr:
+        - 0
+        - 1
+        - 2
+        - 3
+      copy:
+        - 0
+        - 1
+        - 2
+      """
+
+  Scenario: Composing with multiple possible shapes
+    Given the `sequences` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          flow:compose:
+            - a: $[0].b.c
+            - b: $[0]
+          POST: numbers
+      """
+    When the following request is received:
+      """
+      POST /sequences/ HTTP/1.1
+      host: nex.toa.io
+      content-type: text/plain
+      accept: application/yaml
+
+      3
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: application/yaml
+
+      b: 0
+      """
+
+  Scenario: Composing with text value
+    Given the `sequences` is running with the following manifest:
+      """yaml
+      exposition:
+        /:
+          flow:compose: $[1]
+          POST: numbers
+      """
+    When the following request is received:
+      """
+      POST /sequences/ HTTP/1.1
+      host: nex.toa.io
+      content-type: text/plain
+      accept: application/yaml
+
+      3
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: application/yaml
+
+      1
+      """

package/features/identity.bans.feature

@@ -0,0 +1,137 @@
+@security
+Feature: Bans
+
+  Background:
+    Given the `identity.basic` database contains:
+    # developer:secret
+    # user:12345
+      | _id                              | authority | username  | password                                                     | _deleted |
+      | efe3a65ebbee47ed95a73edd911ea328 | nex       | developer | $2b$10$ZRSKkgZoGnrcTNA5w5eCcu3pxDzdTduhteVYXcp56AaNcilNkwJ.O | null     |
+      | e8e4f9c2a68d419b861403d71fabc915 | nex       | user      | $2b$10$Frszmrmsz9iwSXzBbRRMKeDVKsNxozkrLNSsN.SnVC.KPxLtQr/bK | null     |
+    And the `identity.bans` database is empty
+
+  Scenario: Banning an Identity
+    Given the `identity.roles` database contains:
+      | _id                              | identity                         | role                 |
+      | 775a648d054e4ce1a65f8f17e5b51803 | efe3a65ebbee47ed95a73edd911ea328 | system:identity:bans |
+    And the annotation:
+      """yaml
+      /:
+        /:id:
+          io:output: true
+          auth:id: id
+          GET:
+            dev:stub:
+              access: granted!
+      """
+    And the `identity.tokens` configuration:
+      """yaml
+      refresh: 1
+      """
+    When the following request is received:
+      """
+      GET /e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic dXNlcjoxMjM0NQ==
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      authorization: Token ${{ token }}
+      """
+    When the following request is received:
+      """
+      PUT /identity/bans/e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      content-type: application/yaml
+
+      banned: true
+      comment: Bye bye
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    # accessing a resource with a banned Identity
+    When the following request is received:
+      """
+      GET /e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic dXNlcjoxMjM0NQ==
+      """
+    Then the following reply is sent:
+      """
+      401 Unauthorized
+      """
+    Then after 1 second
+    When the following request is received:
+      """
+      GET /e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ token }}
+      """
+    Then the following reply is sent:
+      """
+      401 Unauthorized
+      """
+    When the following request is received:
+      """
+      PUT /identity/bans/e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      content-type: application/yaml
+
+      banned: false
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET /e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic dXNlcjoxMjM0NQ==
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+
+      authorization: Token ${{ new_token }}
+      """
+    # re-ban
+    When the following request is received:
+      """
+      PUT /identity/bans/e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic ZGV2ZWxvcGVyOnNlY3JldA==
+      content-type: application/yaml
+
+      banned: true
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    When the following request is received:
+      """
+      GET /e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Basic dXNlcjoxMjM0NQ==
+      """
+    Then the following reply is sent:
+      """
+      401 Unauthorized
+      """
+    Then after 1 second
+    When the following request is received:
+      """
+      GET /e8e4f9c2a68d419b861403d71fabc915/ HTTP/1.1
+      host: nex.toa.io
+      authorization: Token ${{ new_token }}
+      """
+    Then the following reply is sent:
+      """
+      401 Unauthorized
+      """