hmac_signature 0.0.2 → 0.0.3

data/README.md

@@ -1,29 +1,92 @@
-# HmacSignature
+HmacSignature
+=============
 
-TODO: Write a gem description
+Credit to Martyn Loughran and the 'signature' gem, which HmacSignature is based on.
 
-## Installation
+Examples
+--------
 
-Add this line to your application's Gemfile:
+Client example (Sending auth via query_string/post body)
 
-    gem 'hmac_signature'
+```ruby
+params       = {:some => 'parameters'}
+token        = HmacSignature::Token.new('my_key', 'my_secret')
+request      = HmacSignature::Strategy::Params::Request.new('POST', '/api/thing', params)
+auth_hash    = request.sign(token)
+query_params = params.merge(auth_hash)
 
-And then execute:
+HTTParty.post('http://myservice/api/thing', {
+  :query => query_params
+})
+```
 
-    $ bundle
+`query_params` looks like:
 
-Or install it yourself as:
+```ruby
+{
+  :some           => "parameters",
+  :auth_timestamp => 1273231888,
+  :auth_signature => "28b6bb0f242f71064916fad6ae463fe91f5adc302222dfc02c348ae1941eaf80",
+  :auth_version   => "1.0",
+  :auth_key       => "my_key"
+}
 
-    $ gem install hmac_signature
+```
 
-## Usage
+Client example (Sending auth via headers)
 
-TODO: Write usage instructions here
+```ruby
+params       = {:some => 'parameters'}
+token        = HmacSignature::Token.new('my_key', 'my_secret')
+request      = HmacSignature::Strategy::Headers::Request.new('POST', '/api/thing', params)
+auth_headers = request.sign(token)
 
-## Contributing
+HTTParty.post('http://myservice/api/thing', {
+  :query => params, 
+  :headers => auth_headers
+})
+```
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+`auth_headers` looks like:
+
+```ruby
+{
+  'X-Auth-Expires'   => 1273231888,
+  'X-Auth-Signature' => "28b6bb0f242f71064916fad6ae463fe91f5adc302222dfc02c348ae1941eaf80",
+  'X-Auth-Version'   => "1.0",
+  'X-Auth-Key'       => "my_key"
+}
+
+```
+
+Server example (sinatra)
+
+```ruby
+error HmacSignature::AuthenticationError do |controller|
+  error = controller.env["sinatra.error"]
+  halt 401, "401 UNAUTHORIZED: #{error.message}\n"
+end
+
+post '/api/thing' do
+  request = HmacSignature::Strategy::Params::Request.new('POST', env["REQUEST_PATH"], params)
+  # This will raise a HmacSignature::AuthenticationError if request does not authenticate
+  token = request.authenticate do |key|
+    HmacSignature::Token.new(key, lookup_secret(key))
+  end
+
+  # Do whatever you need to do
+end
+```
+
+Developing
+----------
+
+    bundle
+    bundle exec rspec spec/*_spec.rb
+
+Please see the travis status for a list of rubies tested against
+
+Copyright
+---------
+
+Copyright (c) 2013 Erik Lott. See LICENSE for details.

data/lib/hmac_signature/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hmac_signature
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: