king_hmac 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,8 +1,8 @@
-= king-hmac
+= king_hmac
 
 This gem started with a copy & disection of auth-hmac gem v1.1.1
 
-king-hmac is a Ruby implementation of HMAC[http://en.wikipedia.org/wiki/HMAC]
+king_hmac is a Ruby implementation of HMAC[http://en.wikipedia.org/wiki/HMAC]
 based authentication of HTTP requests. HMAC authentication involves a client and
 server having a shared secret key. When sending the request the client, signs
 the request using the secret key. This involves building a canonical
@@ -26,12 +26,12 @@ but without the Amazon specific components, i.e. it is HMAC for the rest of us.
 
 == INSTALL:
 Gem hosted on gemcutter.org
-  sudo gem install king-hmac
+  sudo gem install king_hmac
 
 == Source Code
-See http://github.com/salesking/king-hmac
+See http://github.com/salesking/king_hmac
 The source repository:
-  git clone git://github.com/salesking/king-hmac.git
+  git clone git://github.com/salesking/king_hmac.git
 
 == When to use it?
 
@@ -126,7 +126,7 @@ following:
 
 The result is then Base64 encoded and added to the headers of the request as the
 +Authorization+ header in the format:
-  Authorization: KingHmac::Auth <access_id>:<base64 encoded king-hmac>
+  Authorization: KingHmac::Auth <access_id>:<base64 encoded king_hmac>
 
 When authenaticating a request, KingHmac::Auth looks for the Authorization
 header in the above format, parses out the components, regenerates a HMAC for
@@ -140,6 +140,6 @@ KingHmac::Auth style requests in other languages.
 
 == Authors and Contributors
 
-This gem started with a copy & disection of auth-king-hmac gem v1.1.1.
+This gem started with a copy & disection of auth-king_hmac gem v1.1.1.
 Most of this doc was written by Sean Geoghegan
-auth-king-hmac was developed by Sean Geoghegan http://rubyforge.org/projects/auth-king-hmac &&  by Peerworks[http://peerworks.org].
+auth-king_hmac was developed by Sean Geoghegan http://rubyforge.org/projects/auth-king_hmac &&  by Peerworks[http://peerworks.org].

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/king_hmac.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{king_hmac}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2010-04-10}
+  s.date = %q{2010-04-23}
   s.description = %q{A Ruby Gem for authenticating HTTP requests using a HMAC}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [

data/lib/king_hmac/rack/middleware.rb

@@ -4,28 +4,29 @@ module KingHmac
     class Middleware
 
       # === Parameter
-      # opts<Hash>::
+      # app<Object>:: Another Rack app, just a class responding to .call
+      # opts<Hash>:: {'keys'=>{'my_access_key'=>'my_secret'}, 'only'=>['a path', 'backend', 'api'] }
       # === opts params:
-      # keys<Hash{String=>String}>:: Must be an array of accesskey=> secret
+      # keys<Hash{String=>String}>:: Multiple sets of accesskey=> secret
       # respond to the [] method and return a secret for access key id
-      # only<Array[String]>:: path's to protect
+      # only<Array[String]>:: path's to protect ['admin', 'backend', 'api']
       def initialize(app, opts={})
         @app = app
         @opts = opts
-        @plain_error = "HMAC Authentication failed. Get yourself a valid HMAC Key .. Dude .. or ask your admin to get you some credentials"
+        @error = "HMAC Authentication failed. Get yourself a valid HMAC Key .. Dude .. or ask your admin to get you some credentials"
         @hmac_auth = KingHmac::Auth.new(@opts['keys'])
       end
 
       def call(env)
-        path = env['PATH_INFO']
+        path = env['PATH_INFO'] || '' #root path / does not have path info
         do_hmac_check = @opts['only'].detect{|i| path.include?(i) }
         if do_hmac_check
           unless hmac_authenticated?(::Rack::Request.new(env))
             headers = {'Content-Type' => "text/plain",
-                      'Content-Length' => "#{@plain_error.length}",
+                      'Content-Length' => "#{@error.length}",
                       'WWW-Authenticate' => 'AuthHMAC'
                       }
-            [401, headers, [@plain_error]]
+            [401, headers, [@error]]
           else #valid credentials
             @app.call(env)
           end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 +02:00
+date: 2010-04-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency