rune 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Brett Buddin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+# Rune
+
+Rune was written to provide a simple authentication signature generator for APIs. 
+
+Imagine you have a super-awesome API. Each user of your API has a secret `auth_token` which they will use to sign requests before sending them to you. When the API receives these requests, it performs the same process on the request ata and compares the resulting signature to the signature that was given by the client. If they match—huzzah!—they have entry.
+
+The signature is generated using the following algorithm:
+
+* Alphabetize all POST fields
+* Concatinate the key and value of each POST field to eachother, concatinate each 
+  field name and value to the end of the URL
+* Using the string containing the URL, query string and POST fields, sign them using HMAC-SHA1 and the auth_token as the key.
+
+*I suggest providing this signature to your API via an HTTP header like "X-YOUR_API_NAME-Signature".*
+
+## Example Usage
+
+``` ruby
+rune = Rune.new(
+  'http://localhost/people',
+  'super_secret_auth_token',
+  {:person => {:name  => "Name", :age => "29"}, :other => "dude"}
+)
+
+rune.generate #=> "BVuqfY28b69Bnt2Kiaj2CObOec0="
+```

data/Rakefile

@@ -0,0 +1,11 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.pattern = FileList['spec/**/*_spec.rb']
+  end
+
+  task :test do
+    Rake::Task['spec'].invoke
+  end
+end

data/lib/rune.rb

@@ -0,0 +1,57 @@
+require 'openssl'
+require 'base64'
+
+class Rune
+  VERSION = Version = '0.1.1'
+
+  attr_accessor :url
+  attr_accessor :auth_token
+  attr_accessor :params
+
+  def initialize(url, auth_token, params = {})
+    @url = url
+    @auth_token = auth_token
+    @params = params
+  end
+  
+  # Generate the signature.
+  # 
+  # Returns the String signature.
+  def generate
+    data = flatten(stringify_keys(@params)).join
+    digest = OpenSSL::Digest::Digest.new("sha1")
+    Base64.encode64(OpenSSL::HMAC.digest(digest, @auth_token, "#{@url}#{data}")).strip
+  end
+
+  private
+
+  # Stringify the keys of a Hash.
+  # 
+  # Returns the Hash that has strings for keys.
+  def stringify_keys(hash)
+    hash.keys.each do |key|
+      hash[key.to_s] = hash.delete(key)
+    end
+
+    hash.values.select{ |v| v.is_a?(Hash) }.each do |h| 
+      stringify_keys(h)
+    end
+    hash
+  end
+  
+  # Recursively flatten the hash. Each level of the hash is sorted
+  # alphabetically based on key name.
+  #
+  # Returns an Array of the hash, flattened. Mind fuck.
+  def flatten(value)
+    if value.is_a?(Array)
+      value.flatten.map{ |v| flatten(v) }
+    elsif value.is_a?(Hash)
+      value.to_a.sort_by do |k| 
+        k[0].to_s
+      end.map { |v| flatten(v) }.flatten
+    else
+      value.to_s
+    end
+  end
+end

data/spec/rune_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Rune do
+  it "should generate a signature from instantiated Rune" do
+    rune = Rune.new(
+      'http://localhost/people',
+      'super_secret_auth_token',
+      {:person => {:name  => "Name", :age => "29"}, :other => "dude"}
+    )
+    rune.generate.should == 'BVuqfY28b69Bnt2Kiaj2CObOec0='
+  end
+
+  it "should generate the same signature for hashes with symbols and string keys" do
+    rune_with_symbols = Rune.new(
+      'http://localhost/people',
+      'super_secret_auth_token',
+      {:person => {:name  => "Name", :age => "29", :crazy => {:nested => "stuff"}}}
+    )
+    rune_with_strings = Rune.new(
+      'http://localhost/people',
+      'super_secret_auth_token',
+      {'person' => {'name'  => "Name", 'age' => "29", 'crazy' => {'nested' => "stuff"}}}
+    )
+
+    rune_with_symbols.generate.should == rune_with_symbols.generate
+  end
+
+  it "should generate the same signature for two orderings of parameters" do
+    rune = Rune.new(
+      'http://localhost/people',
+      'super_secret_auth_token',
+      {:other => "dude", :person => {:age => "29", :name  => "Name"}}
+    )
+    rune2 = Rune.new(
+      'http://localhost/people',
+      'super_secret_auth_token',
+      {"person" => {:name  => "Name", :age => "29"}, :other => "dude"}
+    )
+
+    rune.generate.should == rune2.generate
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../lib/rune'

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: rune
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Brett Buddin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-28 00:00:00.000000000Z
+dependencies: []
+description: Signature generation library for API authentication.
+email: brett@intraspirit.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/rune.rb
+- spec/rune_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/brettbuddin/rune
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Signature generation library for API authentication.
+test_files:
+- spec/rune_spec.rb
+- spec/spec_helper.rb