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

package/features/octets.feature

@@ -4,40 +4,49 @@ Feature: Octets directive family
     Given the annotation:
       """yaml
       /:
+        io:output: true
         auth:anonymous: true
         octets:context: octets
         POST:
-          octets:store: ~
-        GET:
-          octets:list: ~
-        PUT:
-          octets:permute: ~
+          octets:put: ~
         /*:
           GET:
-            octets:fetch: ~
+            octets:get: ~
           DELETE:
             octets:delete: ~
         /media:
           /jpeg:
             POST:
-              octets:store:
+              octets:put:
                 accept: image/jpeg
           /jpeg-or-png:
             POST:
-              octets:store:
+              octets:put:
                 accept:
                   - image/jpeg
                   - image/png
           /images:
             POST:
-              octets:store:
+              octets:put:
                 accept: image/*
+            /*:
+              GET:
+                octets:get: ~
+        /limit-1kb:
+          POST:
+            octets:put:
+              limit: 1kb
+        /limit-100kb:
+          POST:
+            octets:put:
+              limit: 100kb
       """
 
   Scenario: Basic storage operations
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
       """
@@ -46,13 +55,14 @@ Feature: Octets directive family
       201 Created
       content-type: application/yaml
 
-      id: 10cf16b458f759e0d617f2f3d83599ff
+      id: ${{ id }}
       type: application/octet-stream
       size: 8169
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
       """
     Then the stream equals to `lenna.ascii` is sent with the following headers:
       """
@@ -63,7 +73,8 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
       if-none-match: ${{ ETAG }}
       """
     Then the following reply is sent:
@@ -72,19 +83,8 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      GET / HTTP/1.1
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-
-      - 10cf16b458f759e0d617f2f3d83599ff
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff?foo=bar HTTP/1.1
+      GET /${{ id }}?foo=bar HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -92,7 +92,8 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      DELETE /${{ id }} HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -100,114 +101,123 @@ Feature: Octets directive family
       """
     When the following request is received:
       """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
       404 Not Found
       """
 
-  Scenario: Entries permutation
-    When the stream of `lenna.ascii` is received with the following headers:
+  Scenario: Media type control
+    When the stream of `lenna.png` is received with the following headers:
       """
-      POST / HTTP/1.1
-      accept: application/yaml
-      content-type: application/octet-stream
+      POST /media/jpeg-or-png/ HTTP/1.1
+      host: nex.toa.io
+      content-type: image/jpeg
       """
-    And the stream of `lenna.png` is received with the following headers:
+    Then the following reply is sent:
       """
-      POST / HTTP/1.1
-      accept: application/yaml
-      content-type: application/octet-stream
+      400 Bad Request
       """
-    When the following request is received:
+    When the stream of `lenna.png` is received with the following headers:
       """
-      GET / HTTP/1.1
-      accept: application/yaml
+      POST /media/jpeg/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
-      200 OK
-      content-type: application/yaml
-
-      - 10cf16b458f759e0d617f2f3d83599ff
-      - 814a0034f5549e957ee61360d87457e5
+      415 Unsupported Media Type
       """
-    When the following request is received:
+    When the stream of `lenna.png` is received with the following headers:
       """
-      PUT / HTTP/1.1
-      content-type: application/yaml
-
-      - 814a0034f5549e957ee61360d87457e5
-      - 10cf16b458f759e0d617f2f3d83599ff
+      POST /media/jpeg-or-png/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
-      204 No Content
+      201 Created
       """
-    When the following request is received:
+
+  Scenario: Size limit
+    When the stream of `albert.jpg` is received with the following headers:
       """
-      GET / HTTP/1.1
-      accept: application/yaml
+      POST /limit-1kb/ HTTP/1.1
+      host: nex.toa.io
+      content-type: image/jpeg
+      accept: text/plain
       """
     Then the following reply is sent:
       """
-      200 OK
-      content-type: application/yaml
+      413 Request Entity Too Large
 
-      - 814a0034f5549e957ee61360d87457e5
-      - 10cf16b458f759e0d617f2f3d83599ff
+      Size limit is 1kb
       """
 
-  Scenario: Media type control
-    When the stream of `lenna.png` is received with the following headers:
+    When the stream of `albert.jpg` is received with the following headers:
       """
-      POST /media/jpeg-or-png/ HTTP/1.1
+      POST /limit-100kb/ HTTP/1.1
+      host: nex.toa.io
       content-type: image/jpeg
       """
     Then the following reply is sent:
       """
-      400 Bad Request
+      201 Created
       """
-    When the stream of `lenna.png` is received with the following headers:
+
+  Scenario Outline: Detecting `<type>`
+    When the stream of `sample.<ext>` is received with the following headers:
       """
-      POST /media/jpeg/ HTTP/1.1
+      POST /media/images/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
       """
     Then the following reply is sent:
       """
-      415 Unsupported Media Type
+      201 Created
+
+      type: <type>
       """
-    When the stream of `lenna.png` is received with the following headers:
+    Examples:
+      | ext  | type       |
+      | jpeg | image/jpeg |
+      | jxl  | image/jxl  |
+      | gif  | image/gif  |
+      | heic | image/heic |
+      | avif | image/avif |
+      | webp | image/webp |
+
+  Scenario: Accepting `image/svg+xml`
+    When the stream of `sample.svg` is received with the following headers:
       """
-      POST /media/jpeg-or-png/ HTTP/1.1
+      POST /media/images/ HTTP/1.1
+      host: nex.toa.io
+      content-type: image/svg+xml
+      accept: application/yaml
       """
     Then the following reply is sent:
       """
       201 Created
+
+      type: image/svg+xml
       """
 
-  Scenario Outline: Receiving <format> images
-    When the stream of `sample.<format>` is received with the following headers:
+  Scenario: Rejection video/avi
+    When the stream of `sample.avi` is received with the following headers:
       """
       POST /media/images/ HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
-      201 Created
+      415 Unsupported Media Type
       """
-    Examples:
-      | format |
-      | jpeg   |
-      | jxl    |
-      | gif    |
-      | heic   |
-      | avif   |
-      | webp   |
 
   Scenario: Fetching non-existent BLOB
     When the following request is received:
       """
       GET /whatever HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -218,12 +228,14 @@ Feature: Octets directive family
     When the stream of `lenna.ascii` is received with the following headers:
       """
       POST / HTTP/1.1
+      host: nex.toa.io
       accept: application/yaml
       content-type: application/octet-stream
       """
     And the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff/ HTTP/1.1
+      host: nex.toa.io
       accept: text/plain
       """
     Then the following reply is sent:
@@ -231,39 +243,5 @@ Feature: Octets directive family
       404 Not Found
       content-type: text/plain
 
-      Trailing slash is redundant.
-      """
-
-  Scenario: Original BLOLB is not accessible
-    Given the annotation:
-      """yaml
-      /:
-        auth:anonymous: true
-        octets:context: octets
-        POST:
-          octets:store: ~
-        /*:
-          GET:
-            octets:fetch:
-              meta: true
-              blob: false
-      """
-    When the stream of `lenna.ascii` is received with the following headers:
-      """
-      POST / HTTP/1.1
-      """
-    Then the following reply is sent:
-      """
-      201 Created
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
-      accept: text/plain
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      BLOB variant must be specified.
+      Trailing slash is redundant
       """

package/features/octets.head.feature

@@ -0,0 +1,40 @@
+Feature: Octets headers
+
+  Scenario: Accessing headers
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        /*:
+          POST:
+            octets:put: ~
+          /*:
+            HEAD:
+              octets:head: ~
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /assets/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      HEAD /assets/${{ id }} HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/octet-stream
+      content-length: 8169
+      """

package/features/octets.location.feature

@@ -0,0 +1,83 @@
+Feature: Octets location
+
+  Scenario Outline: Store octets in a specified location
+    Given the annotation:
+      """yaml
+      /:
+        /foo:
+          octets:context: octets
+          auth:anonymous: true
+          io:output: true
+          POST:
+            octets:put:
+              location: <location>
+          /bar:
+            /*:
+              GET:
+                octets:get: ~
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /foo/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      """
+    When the following request is received:
+      """
+      HEAD /foo/bar/${{ id }} HTTP/1.1
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      """
+    Examples:
+      | location  |
+      | ./bar     |
+      | /foo/bar/ |
+
+  Scenario: Executing a workflow with specified location
+    Given the `octets.tester` is running
+    And the annotation:
+      """yaml
+      /:
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            location: /hello/world/
+            workflow:
+              echo: octets.tester.echo
+          io:output: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml, multipart/yaml
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      content-type: multipart/yaml; boundary=cut
+
+      --cut
+
+      id: ${{ id }}
+      type: application/octet-stream
+      size: 8169
+      --cut
+
+      step: echo
+      status: completed
+      output:
+        path: /hello/world/${{ id }}
+      --cut--
+      """

package/features/octets.meta.feature

@@ -1,65 +1,116 @@
-Feature: Octets `content-meta` header
+Feature: Octets metadata
 
-  Scenario: Sending `content-meta` header
-    Given the `octets.tester` is running
-    And the annotation:
+  Scenario: Content-ID
+    Given the annotation:
       """yaml
       /:
+        io:output: true
         auth:anonymous: true
         octets:context: octets
         /*:
           POST:
-            octets:store: ~
+            octets:put: ~
           /*:
             GET:
-              octets:fetch:
+              octets:get:
                 meta: true
       """
     When the stream of `lenna.ascii` is received with the following headers:
       """
-      POST /meta-header/ HTTP/1.1
+      POST /attributes/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
       content-type: application/octet-stream
-      content-meta: foo, bar=baz=1
-      content-meta: baz=1
+      content-id: hello
       """
     Then the following reply is sent:
       """
       201 Created
+
+      id: hello
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /attributes/ HTTP/1.1
+      host: nex.toa.io
+      accept: text/plain
+      content-type: application/octet-stream
+      content-id: hello.txt
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Invalid Content-ID
+      """
+
+  Scenario: Content-Attributes
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        /*:
+          POST:
+            octets:put: ~
+          /*:
+            GET:
+              octets:get:
+                meta: true
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST /attributes/ HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      content-attributes: foo, bar=baz=1
+      content-attributes: baz=1
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
       """
     When the following request is received:
       """
-      GET /meta-header/10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      GET /attributes/${{ id }} HTTP/1.1
+      host: nex.toa.io
       accept: application/vnd.toa.octets.entry+yaml
       """
     Then the following reply is sent:
       """
       200 OK
 
-      id: 10cf16b458f759e0d617f2f3d83599ff
+      id: ${{ id }}
       type: application/octet-stream
       size: 8169
-      meta:
+      checksum: 10cf16b458f759e0d617f2f3d83599ff
+      attributes:
         foo: 'true'
         bar: baz=1
         baz: '1'
       """
 
-  Scenario: CORS allows `content-meta` header
+  Scenario: CORS allows `content-attributes` header
     Given the annotation:
       """yaml
       /:
         octets:context: octets
         POST:
-          octets:store: ~
+          octets:put: ~
       """
     When the following request is received:
       """
       OPTIONS / HTTP/1.1
-      origin: http://example.com
+      host: nex.toa.io
+      origin: https://example.com
       """
     Then the following reply is sent:
       """
       204 No Content
-      access-control-allow-origin: http://example.com
-      access-control-allow-headers: accept, authorization, content-type, content-meta
+      access-control-allow-origin: https://example.com
+      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-attributes
       """