From 79e692247a95bbbeb4493037824a15c1d693d881 Mon Sep 17 00:00:00 2001 From: Felix Gilcher Date: Wed, 14 Dec 2011 16:52:07 +0100 Subject: [PATCH] update documentation --- doc/Faraday.html | 2 +- doc/HMAC.html | 2 +- doc/HMAC/Signer.html | 2 +- doc/KeyError.html | 2 +- doc/Request/Hmac.html | 2 +- doc/String.html | 2 +- doc/Warden.html | 2 +- doc/Warden/Strategies.html | 2 +- doc/Warden/Strategies/HMAC.html | 2 +- doc/Warden/Strategies/HMAC/Base.html | 2 +- doc/Warden/Strategies/HMAC/Header.html | 2 +- doc/Warden/Strategies/HMAC/Query.html | 2 +- doc/_index.html | 2 +- doc/file.README.html | 14 +++++++------- doc/index.html | 14 +++++++------- doc/top-level-namespace.html | 2 +- 16 files changed, 28 insertions(+), 28 deletions(-) diff --git a/doc/Faraday.html b/doc/Faraday.html index f433036..bc2cebc 100644 --- a/doc/Faraday.html +++ b/doc/Faraday.html @@ -87,7 +87,7 @@ diff --git a/doc/HMAC.html b/doc/HMAC.html index 1d262ed..5c83b63 100644 --- a/doc/HMAC.html +++ b/doc/HMAC.html @@ -97,7 +97,7 @@

Defined Under Namespace

diff --git a/doc/HMAC/Signer.html b/doc/HMAC/Signer.html index 0774317..f796fee 100644 --- a/doc/HMAC/Signer.html +++ b/doc/HMAC/Signer.html @@ -2500,7 +2500,7 @@

Returns:

diff --git a/doc/KeyError.html b/doc/KeyError.html index 1b18cd6..073d5d4 100644 --- a/doc/KeyError.html +++ b/doc/KeyError.html @@ -107,7 +107,7 @@ diff --git a/doc/Request/Hmac.html b/doc/Request/Hmac.html index 3108a37..adb9294 100644 --- a/doc/Request/Hmac.html +++ b/doc/Request/Hmac.html @@ -558,7 +558,7 @@

Instance Method Details

diff --git a/doc/String.html b/doc/String.html index ac3ca21..cfd71d9 100644 --- a/doc/String.html +++ b/doc/String.html @@ -253,7 +253,7 @@

Instance Method Details

diff --git a/doc/Warden.html b/doc/Warden.html index 4449c9a..bc21dfe 100644 --- a/doc/Warden.html +++ b/doc/Warden.html @@ -99,7 +99,7 @@

Defined Under Namespace

diff --git a/doc/Warden/Strategies.html b/doc/Warden/Strategies.html index ae63384..ac67898 100644 --- a/doc/Warden/Strategies.html +++ b/doc/Warden/Strategies.html @@ -99,7 +99,7 @@

Defined Under Namespace

diff --git a/doc/Warden/Strategies/HMAC.html b/doc/Warden/Strategies/HMAC.html index 5f34bc5..78cb3c5 100644 --- a/doc/Warden/Strategies/HMAC.html +++ b/doc/Warden/Strategies/HMAC.html @@ -99,7 +99,7 @@

Defined Under Namespace

diff --git a/doc/Warden/Strategies/HMAC/Base.html b/doc/Warden/Strategies/HMAC/Base.html index f832548..ca4d109 100644 --- a/doc/Warden/Strategies/HMAC/Base.html +++ b/doc/Warden/Strategies/HMAC/Base.html @@ -783,7 +783,7 @@

Returns:

diff --git a/doc/Warden/Strategies/HMAC/Header.html b/doc/Warden/Strategies/HMAC/Header.html index b6895f1..021ed6f 100644 --- a/doc/Warden/Strategies/HMAC/Header.html +++ b/doc/Warden/Strategies/HMAC/Header.html @@ -738,7 +738,7 @@

See Also:

diff --git a/doc/Warden/Strategies/HMAC/Query.html b/doc/Warden/Strategies/HMAC/Query.html index 03ff836..500c905 100644 --- a/doc/Warden/Strategies/HMAC/Query.html +++ b/doc/Warden/Strategies/HMAC/Query.html @@ -603,7 +603,7 @@

See Also:

diff --git a/doc/_index.html b/doc/_index.html index 1b1824a..41cd504 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -214,7 +214,7 @@

Namespace Listing A-Z

diff --git a/doc/file.README.html b/doc/file.README.html index 44c086d..5f1e5a3 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -178,9 +178,11 @@

Auth Scheme Name

Authentication Header Format

The format of the Authentication Header can be controlled using the :auth_header_format directive. The given format string will be interpolated -with all given options and the signature. The default value is %{auth_scheme} %{signature} which will result in an auth header with a format such as HMAC 539263f4f83878a4917d2f9c1521320c28b926a9.

+with all given options and the signature. The default value is %{scheme} %{signature} which will result in an auth header with a format such as HMAC 539263f4f83878a4917d2f9c1521320c28b926a9. The format string must contain at least the scheme and signature components.

-

The :auth_header_format directive has a companion directive, :auth_header_parse which can be a proc or a regular expression. Any given regular expression will be evaluated against the string and any named capture pattern will be added to the parameters for the request. The regular expression must at least contain a pattern named scheme and pattern named signature. The default value is /(?<scheme>\w+) (?<signature>\w+)/

+

The :auth_header_format directive has a companion directive, :auth_header_parse which must be a regular expression. Any given regular expression will be evaluated against the authorization header. The results can be retrieved using the parsed_auth_header method. The regular expression must at least contain a pattern named scheme and pattern named signature. The default value for this directive is a regular expression that is auto-generated by translating the :auth_header_format setting to a regular expression that contains a named capture group for each named part of the format string. Each capture allows for word characters, plus, dash, underscore and dot. The default :auth_header_format %{scheme} %{signature} will be translated to /(?<autschemeh_scheme>[-_+.\w]+) (?<signature>[-_+.\w]+)/.

+ +

See the section about multiple authentication secrets for a use-case and a comprehensive example.

Optional nonce

@@ -370,9 +372,7 @@

Header-Based Authentication

access_key_id = strategy.parsed_auth_header["access_key_id"] keys[access_key_id] }, - :auth_header_format => '%{scheme} %{access_key_id} %{signature}', - :auth_header_parse => /(?<scheme>\w+) (?<access_key_id>\w+) (?<signature>\w+)/ - } + :auth_header_format => '%{scheme} %{access_key_id} %{signature}' } end @@ -421,7 +421,7 @@

Faraday Middleware

Licence

-

Copyright (c) 2011 Florian Gilcher florian.gilcher@asquera.de, Felix Gilcher felix.gilcher@asquera.de

+

Copyright (c) 2011 Florian Gilcher florian.gilcher@asquera.de, Felix Gilcher felix.gilcher@asquera.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -444,7 +444,7 @@

Licence

diff --git a/doc/index.html b/doc/index.html index 9e5faac..369ad5d 100644 --- a/doc/index.html +++ b/doc/index.html @@ -178,9 +178,11 @@

Auth Scheme Name

Authentication Header Format

The format of the Authentication Header can be controlled using the :auth_header_format directive. The given format string will be interpolated -with all given options and the signature. The default value is %{auth_scheme} %{signature} which will result in an auth header with a format such as HMAC 539263f4f83878a4917d2f9c1521320c28b926a9.

+with all given options and the signature. The default value is %{scheme} %{signature} which will result in an auth header with a format such as HMAC 539263f4f83878a4917d2f9c1521320c28b926a9. The format string must contain at least the scheme and signature components.

-

The :auth_header_format directive has a companion directive, :auth_header_parse which can be a proc or a regular expression. Any given regular expression will be evaluated against the string and any named capture pattern will be added to the parameters for the request. The regular expression must at least contain a pattern named scheme and pattern named signature. The default value is /(?<scheme>\w+) (?<signature>\w+)/

+

The :auth_header_format directive has a companion directive, :auth_header_parse which must be a regular expression. Any given regular expression will be evaluated against the authorization header. The results can be retrieved using the parsed_auth_header method. The regular expression must at least contain a pattern named scheme and pattern named signature. The default value for this directive is a regular expression that is auto-generated by translating the :auth_header_format setting to a regular expression that contains a named capture group for each named part of the format string. Each capture allows for word characters, plus, dash, underscore and dot. The default :auth_header_format %{scheme} %{signature} will be translated to /(?<autschemeh_scheme>[-_+.\w]+) (?<signature>[-_+.\w]+)/.

+ +

See the section about multiple authentication secrets for a use-case and a comprehensive example.

Optional nonce

@@ -370,9 +372,7 @@

Header-Based Authentication

access_key_id = strategy.parsed_auth_header["access_key_id"] keys[access_key_id] }, - :auth_header_format => '%{scheme} %{access_key_id} %{signature}', - :auth_header_parse => /(?<scheme>\w+) (?<access_key_id>\w+) (?<signature>\w+)/ - } + :auth_header_format => '%{scheme} %{access_key_id} %{signature}' } end @@ -421,7 +421,7 @@

Faraday Middleware

Licence

-

Copyright (c) 2011 Florian Gilcher florian.gilcher@asquera.de, Felix Gilcher felix.gilcher@asquera.de

+

Copyright (c) 2011 Florian Gilcher florian.gilcher@asquera.de, Felix Gilcher felix.gilcher@asquera.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -444,7 +444,7 @@

Licence

diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index 0cf5aa6..0ada87f 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -96,7 +96,7 @@

Defined Under Namespace