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 @@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
.
%{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.
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 @@
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
.
%{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.
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 @@