Merge pull request #1299 from b4ldr/feature/https_method

Stdlib::Http::Method: Add new type for http methods

Author: ekohl

REFERENCE.md

@@ -289,6 +289,8 @@ OpenSSL.
 * [`Stdlib::HTTPSUrl`](#Stdlib--HTTPSUrl): Validate a HTTPS URL
 * [`Stdlib::HTTPUrl`](#Stdlib--HTTPUrl): Validate a HTTP(S) URL
 * [`Stdlib::Host`](#Stdlib--Host): Validate a host (FQDN or IP address)
+* [`Stdlib::Http::Method`](#Stdlib--Http--Method): Valid HTTP method verbs
+* [`Stdlib::Http::Status`](#Stdlib--Http--Status): A valid HTTP status code per RFC9110
 * [`Stdlib::HttpStatus`](#Stdlib--HttpStatus): Validate a HTTP status code
 * [`Stdlib::IP::Address`](#Stdlib--IP--Address): Validate an IP address
 * [`Stdlib::IP::Address::Nosubnet`](#Stdlib--IP--Address--Nosubnet): Validate an IP address without subnet
@@ -7796,11 +7798,32 @@ Validate a host (FQDN or IP address)
 
 Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]`
 
+### <a name="Stdlib--Http--Method"></a>`Stdlib::Http::Method`
+
+Valid HTTP method verbs
+
+* **See also**
+  * https://www.iana.org/assignments/http-methods/http-methods.xhtml
+
+Alias of `Enum['ACL', 'BASELINE-CONTROL', 'BIND', 'CHECKIN', 'CHECKOUT', 'CONNECT', 'COPY', 'DELETE', 'GET', 'HEAD', 'LABEL', 'LINK', 'LOCK', 'MERGE', 'MKACTIVITY', 'MKCALENDAR', 'MKCOL', 'MKREDIRECTREF', 'MKWORKSPACE', 'MOVE', 'OPTIONS', 'ORDERPATCH', 'PATCH', 'POST', 'PRI', 'PROPFIND', 'PROPPATCH', 'PUT', 'REBIND', 'REPORT', 'SEARCH', 'TRACE', 'UNBIND', 'UNCHECKOUT', 'UNLINK', 'UNLOCK', 'UPDATE', 'UPDATEREDIRECTREF', 'VERSION-CONTROL']`
+
+### <a name="Stdlib--Http--Status"></a>`Stdlib::Http::Status`
+
+A valid HTTP status code per RFC9110
+
+* **See also**
+  * https://httpwg.org/specs/rfc9110.html#overview.of.status.codes
+
+Alias of `Integer[100, 599]`
+
 ### <a name="Stdlib--HttpStatus"></a>`Stdlib::HttpStatus`
 
 Validate a HTTP status code
 
-Alias of `Integer[100, 599]`
+* **See also**
+  * Stdlib::Http::Status
+
+Alias of `Stdlib::Http::Status`
 
 ### <a name="Stdlib--IP--Address"></a>`Stdlib::IP::Address`
 

spec/type_aliases/http__method_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe 'Stdlib::Http::Method' do
+  describe 'valid HTTP Methods' do
+    [
+      'HEAD',
+      'GET',
+      'PUT',
+      'DELETE',
+      'TRACE',
+    ].each do |value|
+      describe value.inspect do
+        it { is_expected.to allow_value(value) }
+      end
+    end
+  end
+
+  describe 'invalid path handling' do
+    context 'garbage inputs' do
+      [
+        nil,
+        [nil],
+        [nil, nil],
+        { 'foo' => 'bar' },
+        {},
+        '',
+        'https',
+        '199',
+        600,
+        1_000,
+        'Ok',
+        'get',
+      ].each do |value|
+        describe value.inspect do
+          it { is_expected.not_to allow_value(value) }
+        end
+      end
+    end
+  end
+end

spec/type_aliases/http__status_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'Stdlib::Http::Status' do
+  describe 'valid HTTP Status' do
+    [
+      200,
+      302,
+      404,
+      418,
+      503,
+    ].each do |value|
+      describe value.inspect do
+        it { is_expected.to allow_value(value) }
+      end
+    end
+  end
+
+  describe 'invalid path handling' do
+    context 'garbage inputs' do
+      [
+        nil,
+        [nil],
+        [nil, nil],
+        { 'foo' => 'bar' },
+        {},
+        '',
+        'https',
+        '199',
+        600,
+        1_000,
+      ].each do |value|
+        describe value.inspect do
+          it { is_expected.not_to allow_value(value) }
+        end
+      end
+    end
+  end
+end

types/http/method.pp

@@ -0,0 +1,43 @@
+# @summary Valid HTTP method verbs
+# @see https://www.iana.org/assignments/http-methods/http-methods.xhtml
+type Stdlib::Http::Method = Enum[
+  'ACL',
+  'BASELINE-CONTROL',
+  'BIND',
+  'CHECKIN',
+  'CHECKOUT',
+  'CONNECT',
+  'COPY',
+  'DELETE',
+  'GET',
+  'HEAD',
+  'LABEL',
+  'LINK',
+  'LOCK',
+  'MERGE',
+  'MKACTIVITY',
+  'MKCALENDAR',
+  'MKCOL',
+  'MKREDIRECTREF',
+  'MKWORKSPACE',
+  'MOVE',
+  'OPTIONS',
+  'ORDERPATCH',
+  'PATCH',
+  'POST',
+  'PRI',
+  'PROPFIND',
+  'PROPPATCH',
+  'PUT',
+  'REBIND',
+  'REPORT',
+  'SEARCH',
+  'TRACE',
+  'UNBIND',
+  'UNCHECKOUT',
+  'UNLINK',
+  'UNLOCK',
+  'UPDATE',
+  'UPDATEREDIRECTREF',
+  'VERSION-CONTROL',
+]

types/http/status.pp

@@ -0,0 +1,3 @@
+# @summary A valid HTTP status code per RFC9110
+# @see https://httpwg.org/specs/rfc9110.html#overview.of.status.codes
+type Stdlib::Http::Status = Integer[100, 599]

types/httpstatus.pp

@@ -1,2 +1,4 @@
 # @summary Validate a HTTP status code
-type Stdlib::HttpStatus = Integer[100, 599]
+# @deprecated Use Stdlib::Http::Status
+# @see Stdlib::Http::Status
+type Stdlib::HttpStatus = Stdlib::Http::Status