sigil 1.0.0

data/.document

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

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem "activesupport", ">= 3.0.0"
+gem "i18n"
+
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0)
+  bundler (~> 1.0.0)
+  i18n
+  jeweler (~> 1.5.1)
+  rcov
+  rspec (~> 2.1.0)

data/Rakefile

@@ -0,0 +1,51 @@
+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 = "sigil"
+  gem.homepage = "http://github.com/steveh/sigil"
+  gem.license = "MIT"
+  gem.summary = "Signs and verifies a set of parameters"
+  gem.description = "Signs and verifies a set of parameters"
+  gem.email = "steve@seven.net.nz"
+  gem.authors = ["Steve Hoeksema"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  gem.add_development_dependency 'rspec', '>= 2.1.0'
+  gem.add_development_dependency 'activesupport', '>= 3.0.0'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sigil #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/sigil.rb

@@ -0,0 +1,9 @@
+require "active_support/core_ext/hash"
+require "active_support/core_ext/object/conversions"
+require "openssl"
+
+module Sigil
+  class Error < StandardError; end
+end
+
+require "sigil/base"

data/lib/sigil/base.rb

@@ -0,0 +1,35 @@
+module Sigil
+  class Base
+    attr_reader :params, :key, :signature
+
+    def initialize(params, key)
+      raise Sigil::Error, "Params must be a Hash" unless params.kind_of?(Hash)
+      @params = params.to_options!
+      @key = key.to_s
+      @signature = nil
+    end
+
+    def to_query
+      @params.to_query
+    end
+
+    def signature
+      unless @signature
+        @signature = self.class.sign(self.to_query, @key).to_s
+      end
+      @signature
+    end
+
+    def self.sign(string, key)
+      hmacd = OpenSSL::HMAC.new(key, OpenSSL::Digest::SHA1.new)
+      hmacd.update(string)
+    end
+
+    def verify(provided_signature)
+      raise Sigil::Error, "Params not set" if params.empty?
+      raise Sigil::Error, "Signature not set" if provided_signature.blank?
+
+      signature == provided_signature
+    end
+  end
+end

data/sigil.gemspec

@@ -0,0 +1,71 @@
+# 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{sigil}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steve Hoeksema"]
+  s.date = %q{2010-12-08}
+  s.description = %q{Signs and verifies a set of parameters}
+  s.email = %q{steve@seven.net.nz}
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "VERSION",
+    "lib/sigil.rb",
+    "lib/sigil/base.rb",
+    "sigil.gemspec",
+    "spec/sigil/base_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/steveh/sigil}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Signs and verifies a set of parameters}
+  s.test_files = [
+    "spec/sigil/base_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.1.0"])
+      s.add_development_dependency(%q<activesupport>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.1.0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.1.0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+  end
+end
+

data/spec/sigil/base_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+describe Sigil::Base do
+
+  before :each do
+    @params = { :cutlery => "knife", "fruit" => :apple }
+    @key = "deadbeef"
+    @sigil = Sigil::Base.new(@params, @key)
+    @signature = "e8a8f0ba2d3be6ec3965e0d7b6f9daf690972f3a"
+  end
+
+  describe "initialization" do
+
+    it "should require params to be set and of type Hash" do
+      lambda { Sigil::Base.new(HashWithIndifferentAccess.new, "deadbeef") }.should_not raise_error
+      lambda { Sigil::Base.new("banana", "deadbeef") }.should raise_error
+    end
+
+    it "should convert the key to a string" do
+      sigil = Sigil::Base.new({}, 123)
+      sigil.send(:key).should == "123"
+    end
+
+    it "should symbolify params" do
+      @sigil.params.should == { :cutlery => "knife", :fruit => :apple }
+    end
+
+  end
+
+  describe "signature generation" do
+
+    it "should convert the params to a query string" do
+      @sigil.to_query.should == "cutlery=knife&fruit=apple"
+    end
+
+    it "should sign the query string with the provided key" do
+      @sigil.signature.should == @signature
+    end
+
+    it "should return the same signature when called more than once" do
+      @sigil.signature.should == @signature
+      @sigil.signature.should == @signature
+    end
+
+  end
+
+  describe "signing" do
+
+    it "should return the key as as HMAC object" do
+      Sigil::Base.sign("lorem ipsum", @key).should be_a_kind_of(OpenSSL::HMAC)
+    end
+
+    it "should sign a string with a key" do
+      Sigil::Base.sign("lorem ipsum", @key).to_s.should == "372b097876a405c2c5ceef96ca6eecea623ff649"
+    end
+
+  end
+
+  describe "input verification convenience methods" do
+
+    it "should verify against a provided signature" do
+      @sigil.verify(@signature).should == true
+    end
+
+    it "should verify against a wrong signature" do
+      @sigil.verify("abc").should == false
+    end
+
+    it "should raise an error if no params present" do
+      sigil = Sigil::Base.new({}, @key)
+      lambda { sigil.verify("abc") }.should raise_error(Sigil::Error, /Params not set/)
+    end
+
+    it "should raise an error if no signature specified" do
+      sigil = Sigil::Base.new(@params, @key)
+      lambda { sigil.verify("") }.should raise_error(Sigil::Error, /Signature not set/)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'sigil'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification 
+name: sigil
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Steve Hoeksema
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-08 00:00:00 +13:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+description: Signs and verifies a set of parameters
+email: steve@seven.net.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- VERSION
+- lib/sigil.rb
+- lib/sigil/base.rb
+- sigil.gemspec
+- spec/sigil/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/steveh/sigil
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1382831699325218252
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Signs and verifies a set of parameters
+test_files: 
+- spec/sigil/base_spec.rb
+- spec/spec_helper.rb