signauth 0.0.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Signauth
 
-TODO: Write a gem description
+Signature authentication.
 
 ## Installation
 
@@ -16,9 +16,45 @@ Or install it yourself as:
 
     $ gem install signauth
 
-## Usage
+## Examples
 
-TODO: Write usage instructions here
+Client example
+
+```ruby
+credentials = Signauth::Credentials.new('my_key', 'my_secret')
+http_method = "GET"
+host        = "localhost"
+path        = "/action"
+params      = { "some" => "param" }
+sig_version = 1
+
+req = Signauth::Request.new( http_method, host, path, params, sig_version)
+req.add_authorization!(credentials)
+
+p req.params # => {"some"=>"param", "access_key_id"=>"my_key", "signature_version"=>"1", "signature_method"=>"HMAC-SHA-256", "signature"=>"7JNcJhJuzcUAGj6azz2wslmqnVomhDIFXZzpXZR1nkI="}
+
+HTTParty.get('http://localhost/action', { :query => req.params })
+```
+
+Server example (rails)
+
+```ruby
+request; # ActionController::Request object
+
+begin
+  access_key_id = request.query_parameters['access_key_id']
+  credentials   = Signauth::Credentials.new(access_key_id, lookup_secret(access_key_id))
+
+  req = Signauth::Request.new(
+          request.request_method,
+          request.domain,
+          request.path,
+          request.query_parameters)
+  req.authenticate(credentials)
+rescue => e
+  render :status => :unauthorized, :text => "401 UNAUTHORIZED: #{e.message}\n"
+end
+```
 
 ## Contributing
 

data/lib/signauth/request.rb

@@ -1,17 +1,18 @@
 module Signauth
   class Request
 
-    attr_accessor :method
-    attr_accessor :host
-    attr_accessor :path
-    attr_accessor :params
+    attr_reader :method
+    attr_reader :host
+    attr_reader :path
+    attr_reader :params
     
-    def initialize(signature_version = 1)
-      extend(Signature.const_get("Version#{signature_version}"))
-      @method = "GET"
-      @host   = ""
-      @path   = "/"
-      @params = {}
+    def initialize(method, host, path, params, signature_version = 1)
+      sig_version = params['signature_version'] ||= signature_version
+      extend(Signature.const_get("Version#{sig_version}"))
+      @method = method
+      @host   = host
+      @path   = path
+      @params = params.dup
     end
 
   end

data/lib/signauth/version.rb

@@ -1,3 +1,3 @@
 module Signauth
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signauth
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -82,7 +82,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -585195729
+      hash: -965159027
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -585195729
+      hash: -965159027
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24