@toa.io/extensions.exposition 1.0.0-alpha.0 → 1.0.0-alpha.100

package/features/octets.download.feature

@@ -0,0 +1,189 @@
+Feature: Download external resources
+
+  Scenario Outline: Download from trusted location defined as <type>
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            trust:
+              - <location> # <type>
+              - https://github.com
+        /*:
+          GET:
+            octets:get:
+              meta: true
+      """
+
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+
+      id: ${{ id }}
+      type: image/png
+      """
+
+    When the following request is received:
+      """
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: image/png
+      content-length: 1288
+      etag: "${{ id }}"
+      """
+
+    # origin is stored in the entry
+    When the following request is received:
+      """
+      GET /${{ id }} HTTP/1.1
+      host: nex.toa.io
+      accept: application/vnd.toa.octets.entry+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      id: ${{ id }}
+      type: image/png
+      origin: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      """
+
+    # untrusted location
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://github.githubassets.com/assets/yolo-default-be0bbff04951.png
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Location is not trusted
+      """
+
+    # content-length must be 0
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      content-length: 1
+      accept: application/yaml
+
+      1
+      """
+    Then the following reply is sent:
+      """
+      400 Bad Request
+
+      Content-Length must be 0 when Content-Location is used
+      """
+
+    # invalid content-location
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: Hello there!
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Location is not trusted
+      """
+
+    # unavailable location
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://github.com/toa-io/no
+      content-length: 0
+      accept: application/yaml
+      """
+    Then the following reply is sent:
+      """
+      404 Not Found
+
+      Location is not available
+      """
+
+    Examples:
+      | type       | location                                   |
+      | origin     | https://avatars.githubusercontent.com      |
+      | expression | /^https://avatars\.githubusercontent\.com/ |
+
+  Scenario: Download size limit
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            limit: 1kb
+            trust:
+              - https://avatars.githubusercontent.com
+      """
+    When the following request is received:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-location: https://avatars.githubusercontent.com/u/92763022?s=48&v=4
+      content-length: 0
+      accept: text/plain
+      """
+    Then the following reply is sent:
+      """
+      413 Request Entity Too Large
+
+      Size limit is 1kb
+      """
+
+  Scenario: Allow `content-location` request header
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put:
+            limit: 1kb
+            trust:
+              - https://avatars.githubusercontent.com
+      """
+    When the following request is received:
+      """
+      OPTIONS / HTTP/1.1
+      host: nex.toa.io
+      origin: https://hello.world
+      """
+    Then the following reply is sent:
+      """
+      204 No Content
+      access-control-allow-headers: accept, authorization, content-type, etag, if-match, if-none-match, content-attributes, content-location
+      """

package/features/octets.entries.feature

@@ -0,0 +1,81 @@
+Feature: Accessing metadata
+
+  Scenario: Metadata is not accessible by default
+    Given the annotation:
+      """yaml
+      /:
+        io:output: true
+        auth:anonymous: true
+        octets:context: octets
+        POST:
+          octets:put: ~
+        /*:
+          GET:
+            octets:get: ~
+      """
+    When the stream of `lenna.ascii` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      content-type: application/octet-stream
+      """
+    Then the following reply is sent:
+      """
+      201 Created
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
+      accept: text/vnd.toa.octets.entry+plain
+      """
+    Then the following reply is sent:
+      """
+      403 Forbidden
+
+      Metadata is not accessible
+      """
+
+  Scenario: Accessing metadata
+    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 / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    And the stream of `lenna.png` is received with the following headers:
+      """
+      POST / HTTP/1.1
+      host: nex.toa.io
+      accept: application/yaml
+      content-type: application/octet-stream
+      """
+    When the following request is received:
+      """
+      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
+      accept: application/vnd.toa.octets.entry+yaml
+      """
+    Then the following reply is sent:
+      """
+      200 OK
+      content-type: application/yaml
+
+      id: 10cf16b458f759e0d617f2f3d83599ff
+      type: application/octet-stream
+      size: 8169
+      """

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
       """
@@ -53,6 +62,7 @@ Feature: Octets directive family
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       """
     Then the stream equals to `lenna.ascii` is sent with the following headers:
       """
@@ -64,38 +74,17 @@ Feature: Octets directive family
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       if-none-match: ${{ ETAG }}
       """
     Then the following reply is sent:
       """
       304 Not Modified
       """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff:meta HTTP/1.1
-      accept: text/plain
-      """
-    Then the following reply is sent:
-      """
-      403 Forbidden
-
-      Metadata is not accessible.
-      """
-    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
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -104,6 +93,7 @@ Feature: Octets directive family
     When the following request is received:
       """
       DELETE /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
+      host: nex.toa.io
       """
     Then the following reply is sent:
       """
@@ -112,113 +102,122 @@ Feature: Octets directive family
     When the following request is received:
       """
       GET /10cf16b458f759e0d617f2f3d83599ff 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:
       """
@@ -229,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:
@@ -242,54 +243,5 @@ Feature: Octets directive family
       404 Not Found
       content-type: text/plain
 
-      Trailing slash is redundant.
-      """
-
-  Scenario: Accessing an Entry and the original BLOLB
-    Given the annotation:
-      """yaml
-      debug: true
-      /:
-        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:meta HTTP/1.1
-      accept: application/yaml
-      """
-    Then the following reply is sent:
-      """
-      200 OK
-      content-type: application/yaml
-      content-length: 124
-
-      id: 10cf16b458f759e0d617f2f3d83599ff
-      type: application/octet-stream
-      size: 8169
-      """
-    When the following request is received:
-      """
-      GET /10cf16b458f759e0d617f2f3d83599ff HTTP/1.1
-      """
-    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
+      """