john-hancock 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 AcademicWorks, inc.
+
+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.markdown

@@ -0,0 +1,43 @@
+# John Hancock: Sign your hashes using md5
+
+## Why
+
+  * Traditional usage: You need to sign reqests to an api
+  * Personal usage:  At AcademicWorks we allow bulk imports of data from external services via csv files.  Processing this data is expensive and often these imports include rows of data that we have seen before.  A row can be tranformaed into a hash by mapping headers to cells.   By saving the signature of these hashes we save ourselves a lot of unneeded computational cycles.
+
+## Usage
+
+  basic
+  
+    hash = {"foo" => "bar", "test" => "toon"}
+    hash.sign
+    => "2a9807b64b8068a8a2a665521ad9aeae"
+
+  signing with shared secret
+  
+    hash = {"foo" => "bar", "test" => "toon"}
+    hash.sign("ipsec")
+    => "d7321e9c8f961deb9e114dd476e420a0"
+
+  sign ignoring certain fields
+  
+    hash = {"foo" => "bar", "test" => "toon"}
+    hash.sign("ipsec", ["test"])
+    => "b2d1e2808552c9d421b2b6f617c71012"
+
+
+## Contributing to john-hancock
+ 
+  * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+  * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+  * Fork the project
+  * Start a feature/bugfix branch
+  * Commit and push until you are happy with your contribution
+  * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+  * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+  Copyright (c) 2011 AcademicWorks, inc. See LICENSE.txt for
+  further details.
+

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "john-hancock"
+  gem.homepage = "http://github.com/ascruggs/john-hancock"
+  gem.license = "MIT"
+  gem.summary = %Q{Sign any hash as one would sign an api request}
+  gem.description = %Q{Creating a signature from a hash has many uses.  You can use this for making authenticated requests to an api.  It can also be used to compare two hashes and see if their contents are equal}
+  gem.email = "aaorn@scrug.gs"
+  gem.authors = ["Aaron Scruggs"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/john-hancock.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{john-hancock}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Aaron Scruggs}]
+  s.date = %q{2011-10-02}
+  s.description = %q{Creating a signature from a hash has many uses.  You can use this for making authenticated requests to an api.  It can also be used to compare two hashes and see if their contents are equal}
+  s.email = %q{aaorn@scrug.gs}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "john-hancock.gemspec",
+    "lib/john-hancock.rb",
+    "test/helper.rb",
+    "test/test_john-hancock.rb"
+  ]
+  s.homepage = %q{http://github.com/ascruggs/john-hancock}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{Sign any hash as one would sign an api request}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/lib/john-hancock.rb

@@ -0,0 +1,24 @@
+require 'digest/md5'
+module JohnHancock
+
+  def sign(shared_secret = "", signature_keys = ["signature"])
+
+    hash_signature = self.clone
+
+    # Remove the "calculated_signature" entry
+    signature_keys.each do |signature_key|
+    	hash_signature.delete(signature_key.to_s)
+    	hash_signature.delete(signature_key.to_sym)
+    end
+
+    calculated_signature = hash_signature.collect { |k, v| "#{k}=#{v}" }
+    calculated_signature = calculated_signature.sort 
+    calculated_signature = calculated_signature.join
+
+    # Final calculated_signature to compare against
+    calculated_signature = Digest::MD5.hexdigest(shared_secret + calculated_signature)
+  end
+
+end
+
+Hash.send(:include,JohnHancock)

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'john-hancock'
+
+class Test::Unit::TestCase
+end

data/test/test_john-hancock.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestJohnHancock < Test::Unit::TestCase
+
+
+  should "sign hash" do
+    assert "2a9807b64b8068a8a2a665521ad9aeae", hash.sign
+  end
+
+  should "sign hash with shared secret" do
+  	assert "d7321e9c8f961deb9e114dd476e420a0", hash.sign("ipsec")
+  end
+
+  should "sign hash with shared secret and ignore fields" do
+  	assert "b2d1e2808552c9d421b2b6f617c71012", hash.sign("ipsec", ["test"])
+  end
+
+  private 
+
+  def hash
+  	{"foo" => "bar", "test" => "toon"}
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: john-hancock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Scruggs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70202797318700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70202797318700
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70202797318040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70202797318040
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70202797317220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70202797317220
+description: Creating a signature from a hash has many uses.  You can use this for
+  making authenticated requests to an api.  It can also be used to compare two hashes
+  and see if their contents are equal
+email: aaorn@scrug.gs
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- VERSION
+- john-hancock.gemspec
+- lib/john-hancock.rb
+- test/helper.rb
+- test/test_john-hancock.rb
+homepage: http://github.com/ascruggs/john-hancock
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2363658146600498815
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Sign any hash as one would sign an api request
+test_files: []