From 65dc3b343dad60500c3dd927ec4c6e4c28f27185 Mon Sep 17 00:00:00 2001 From: Elliott Steer <117514332+essteer@users.noreply.github.com> Date: Sat, 16 Nov 2024 23:43:28 +0800 Subject: [PATCH] feat: Add request templates for dev and prod use (#29) * feat: Add request templates for dev and prod use * docs: Update README with request template info --- README.md | 2 +- tests/requests/dev/default.posting.yaml | 3 +++ tests/requests/dev/hd.posting.yaml | 3 +++ tests/requests/dev/rf-hd.posting.yaml | 3 +++ tests/requests/dev/rf.posting.yaml | 3 +++ tests/requests/dev/ua-hd.posting.yaml | 3 +++ tests/requests/dev/ua-rf-hd-count.posting.yaml | 4 ++++ tests/requests/dev/ua-rf-hd.posting.yaml | 3 +++ tests/requests/dev/ua-rf.posting.yaml | 3 +++ tests/requests/dev/ua.posting.yaml | 3 +++ tests/requests/prod/default.posting.yaml | 3 +++ tests/requests/prod/hd.posting.yaml | 3 +++ tests/requests/prod/rf-hd.posting.yaml | 3 +++ tests/requests/prod/rf.posting.yaml | 3 +++ tests/requests/prod/ua-hd.posting.yaml | 3 +++ tests/requests/prod/ua-rf-hd-count.posting.yaml | 4 ++++ tests/requests/prod/ua-rf-hd.posting.yaml | 3 +++ tests/requests/prod/ua-rf.posting.yaml | 3 +++ tests/requests/prod/ua.posting.yaml | 3 +++ 19 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 tests/requests/dev/default.posting.yaml create mode 100644 tests/requests/dev/hd.posting.yaml create mode 100644 tests/requests/dev/rf-hd.posting.yaml create mode 100644 tests/requests/dev/rf.posting.yaml create mode 100644 tests/requests/dev/ua-hd.posting.yaml create mode 100644 tests/requests/dev/ua-rf-hd-count.posting.yaml create mode 100644 tests/requests/dev/ua-rf-hd.posting.yaml create mode 100644 tests/requests/dev/ua-rf.posting.yaml create mode 100644 tests/requests/dev/ua.posting.yaml create mode 100644 tests/requests/prod/default.posting.yaml create mode 100644 tests/requests/prod/hd.posting.yaml create mode 100644 tests/requests/prod/rf-hd.posting.yaml create mode 100644 tests/requests/prod/rf.posting.yaml create mode 100644 tests/requests/prod/ua-hd.posting.yaml create mode 100644 tests/requests/prod/ua-rf-hd-count.posting.yaml create mode 100644 tests/requests/prod/ua-rf-hd.posting.yaml create mode 100644 tests/requests/prod/ua-rf.posting.yaml create mode 100644 tests/requests/prod/ua.posting.yaml diff --git a/README.md b/README.md index b11062a..bbbbe8b 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ $ curl -X GET 'https://masquer.fly.dev/api/v1/masq?ua=true&rf=true' -H 'accept: The optional `count` parameter specifies the number of objects to return in the response. The default value is `1`. -Refer to the [API docs](`https://masquer.fly.dev/docs`) for other examples, or see [more details below](#examples) in the package documentation. +Refer to the [API docs](`https://masquer.fly.dev/docs`) for other examples, or see [more details below](#examples) in the package documentation. The `tests/requests/` directory also contains HTTP request examples for use in development and production.

diff --git a/tests/requests/dev/default.posting.yaml b/tests/requests/dev/default.posting.yaml new file mode 100644 index 0000000..926113d --- /dev/null +++ b/tests/requests/dev/default.posting.yaml @@ -0,0 +1,3 @@ +name: default +description: Default GET request with no parameters, returns a random useragent. +url: http://127.0.0.1:8000/api/v1/masq diff --git a/tests/requests/dev/hd.posting.yaml b/tests/requests/dev/hd.posting.yaml new file mode 100644 index 0000000..01b11d5 --- /dev/null +++ b/tests/requests/dev/hd.posting.yaml @@ -0,0 +1,3 @@ +name: hd +description: Returns header data with random useragent and fixed referer. +url: http://127.0.0.1:8000/api/v1/masq?ua=false&hd=true diff --git a/tests/requests/dev/rf-hd.posting.yaml b/tests/requests/dev/rf-hd.posting.yaml new file mode 100644 index 0000000..656c885 --- /dev/null +++ b/tests/requests/dev/rf-hd.posting.yaml @@ -0,0 +1,3 @@ +name: rf-hd +description: Returns header data with fixed useragent and random referer. +url: http://127.0.0.1:8000/api/v1/masq?ua=false&rf=true&hd=true diff --git a/tests/requests/dev/rf.posting.yaml b/tests/requests/dev/rf.posting.yaml new file mode 100644 index 0000000..5d168a5 --- /dev/null +++ b/tests/requests/dev/rf.posting.yaml @@ -0,0 +1,3 @@ +name: rf +description: Returns a random referer. +url: http://127.0.0.1:8000/api/v1/masq?ua=false&rf=true diff --git a/tests/requests/dev/ua-hd.posting.yaml b/tests/requests/dev/ua-hd.posting.yaml new file mode 100644 index 0000000..48b9d11 --- /dev/null +++ b/tests/requests/dev/ua-hd.posting.yaml @@ -0,0 +1,3 @@ +name: ua-hd +description: Returns header data with random useragent and fixed referer. +url: http://127.0.0.1:8000/api/v1/masq?ua=true&hd=true diff --git a/tests/requests/dev/ua-rf-hd-count.posting.yaml b/tests/requests/dev/ua-rf-hd-count.posting.yaml new file mode 100644 index 0000000..e714aa0 --- /dev/null +++ b/tests/requests/dev/ua-rf-hd-count.posting.yaml @@ -0,0 +1,4 @@ +name: ua-rf-hd-count +description: Returns multiple sets of header data with random useragent and random + referer, as specified by the count param. +url: http://127.0.0.1:8000/api/v1/masq?ua=true&rf=true&hd=true&count=3 diff --git a/tests/requests/dev/ua-rf-hd.posting.yaml b/tests/requests/dev/ua-rf-hd.posting.yaml new file mode 100644 index 0000000..1181491 --- /dev/null +++ b/tests/requests/dev/ua-rf-hd.posting.yaml @@ -0,0 +1,3 @@ +name: ua-rf-hd +description: Returns header data with random useragent and random referer. +url: http://127.0.0.1:8000/api/v1/masq?ua=true&rf=true&hd=true diff --git a/tests/requests/dev/ua-rf.posting.yaml b/tests/requests/dev/ua-rf.posting.yaml new file mode 100644 index 0000000..188f000 --- /dev/null +++ b/tests/requests/dev/ua-rf.posting.yaml @@ -0,0 +1,3 @@ +name: ua-rf +description: Returns random useragent and random referer. +url: http://127.0.0.1:8000/api/v1/masq?ua=true&rf=true diff --git a/tests/requests/dev/ua.posting.yaml b/tests/requests/dev/ua.posting.yaml new file mode 100644 index 0000000..49f0aee --- /dev/null +++ b/tests/requests/dev/ua.posting.yaml @@ -0,0 +1,3 @@ +name: ua +description: Returns a random useragent, equivalent to the default with no params. +url: http://127.0.0.1:8000/api/v1/masq?ua=true diff --git a/tests/requests/prod/default.posting.yaml b/tests/requests/prod/default.posting.yaml new file mode 100644 index 0000000..eafbd38 --- /dev/null +++ b/tests/requests/prod/default.posting.yaml @@ -0,0 +1,3 @@ +name: default +description: Default GET request with no parameters, returns a random useragent. +url: https://masquer.fly.dev/api/v1/masq diff --git a/tests/requests/prod/hd.posting.yaml b/tests/requests/prod/hd.posting.yaml new file mode 100644 index 0000000..30afbfc --- /dev/null +++ b/tests/requests/prod/hd.posting.yaml @@ -0,0 +1,3 @@ +name: hd +description: Returns header data with random useragent and fixed referer. +url: https://masquer.fly.dev/api/v1/masq?ua=false&hd=true diff --git a/tests/requests/prod/rf-hd.posting.yaml b/tests/requests/prod/rf-hd.posting.yaml new file mode 100644 index 0000000..bed123d --- /dev/null +++ b/tests/requests/prod/rf-hd.posting.yaml @@ -0,0 +1,3 @@ +name: rf-hd +description: Returns header data with fixed useragent and random referer. +url: https://masquer.fly.dev/api/v1/masq?ua=false&rf=true&hd=true diff --git a/tests/requests/prod/rf.posting.yaml b/tests/requests/prod/rf.posting.yaml new file mode 100644 index 0000000..9df11e8 --- /dev/null +++ b/tests/requests/prod/rf.posting.yaml @@ -0,0 +1,3 @@ +name: rf +description: Returns a random referer. +url: https://masquer.fly.dev/api/v1/masq?ua=false&rf=true diff --git a/tests/requests/prod/ua-hd.posting.yaml b/tests/requests/prod/ua-hd.posting.yaml new file mode 100644 index 0000000..a092174 --- /dev/null +++ b/tests/requests/prod/ua-hd.posting.yaml @@ -0,0 +1,3 @@ +name: ua-hd +description: Returns header data with random useragent and fixed referer. +url: https://masquer.fly.dev/api/v1/masq?ua=true&hd=true diff --git a/tests/requests/prod/ua-rf-hd-count.posting.yaml b/tests/requests/prod/ua-rf-hd-count.posting.yaml new file mode 100644 index 0000000..b66c919 --- /dev/null +++ b/tests/requests/prod/ua-rf-hd-count.posting.yaml @@ -0,0 +1,4 @@ +name: ua-rf-hd-count +description: Returns multiple sets of header data with random useragent and random + referer, as specified by the count param. +url: https://masquer.fly.dev/api/v1/masq?ua=true&rf=true&hd=true&count=3 diff --git a/tests/requests/prod/ua-rf-hd.posting.yaml b/tests/requests/prod/ua-rf-hd.posting.yaml new file mode 100644 index 0000000..845c3af --- /dev/null +++ b/tests/requests/prod/ua-rf-hd.posting.yaml @@ -0,0 +1,3 @@ +name: ua-rf-hd +description: Returns header data with random useragent and random referer. +url: https://masquer.fly.dev/api/v1/masq?ua=true&rf=true&hd=true diff --git a/tests/requests/prod/ua-rf.posting.yaml b/tests/requests/prod/ua-rf.posting.yaml new file mode 100644 index 0000000..994374e --- /dev/null +++ b/tests/requests/prod/ua-rf.posting.yaml @@ -0,0 +1,3 @@ +name: ua-rf +description: Returns random useragent and random referer. +url: https://masquer.fly.dev/api/v1/masq?ua=true&rf=true diff --git a/tests/requests/prod/ua.posting.yaml b/tests/requests/prod/ua.posting.yaml new file mode 100644 index 0000000..1fb2f19 --- /dev/null +++ b/tests/requests/prod/ua.posting.yaml @@ -0,0 +1,3 @@ +name: ua +description: Returns a random useragent, equivalent to the default with no params. +url: https://masquer.fly.dev/api/v1/masq?ua=true