url_hash 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"
+
+# openssl, digest, base64 come from the standard library
+
+# 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.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tom Coleman
+
+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.rdoc

@@ -0,0 +1,61 @@
+= url_hash
+
+A simple little library for converting integers to X-character hashes, suitable for uses in urls.
+Hashes may or may not be encrypted, depending on usage.
+
+Sample uses (inside Rails projects):
+1. Shortening urls for commonly used models. Add something like this to the bottom of your routes.rb:
+  match ':hash', :constraints => {:hash => /.{8}/},
+    :to => redirect { |params| "/models/#{UrlHash.from_hash(params[:hash])}" }
+  
+And something like this to your model
+  class Model ...
+    def hash
+      save! if new_record?
+      UrlHash.to_hash(self.id)
+    end
+  end
+  
+Notes:
+* You probably don't need to encrypt in this case, unless your ids are private somehow.
+* It'd probably be better to use a metal to do this, rather than the route, as we don't need any environmental stuff, take this code as pointer in the right direction.
+
+2. A Short URL service. We store a map from hashes to urls in the database. Something like:
+  class ShortUrl < ActiveRecord::Base
+    validates_presence_of :url
+    validates_uniqueness_of :url
+  
+    def self.find_by_hash(hash, opts = {})
+      # use conditions rather than a find so that we don't throw an exception
+      find :first, {:conditions => {:id => UrlHash.from_hash(hash)}}.merge(opts)
+    end
+  
+    def hash
+      save! if new_record?
+      UrlHash.to_hash(self.id)
+    end
+  end
+
+And something like (in routes.rb)
+  match ':hash', :constraints => {:hash => /.{8}/},
+    :to => redirect { |params| ShortUrl.find_by_hash(params[:hash]).url }
+
+Notes:
+* You will want to use find_or_create_by_url to create the short_urls and, you'll want an index on url.
+* If you have any kind of security based on URLs being difficult to guess, you'll want to use encryption
+
+== Contributing to url_hash
+ 
+* 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 Tom Coleman. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+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 = "url_hash"
+  gem.homepage = "http://github.com/tmeasday/url_hash"
+  gem.license = "MIT"
+  gem.summary = %Q{Create url-embeddable hashes from integers}
+  gem.description = %Q{Create url-embeddable hashes from integers, for use in short-url services or simple to shorten resource accesses.}
+  gem.email = "tom@thesnail.org"
+  gem.authors = ["Tom Coleman"]
+  # 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', '> 1.2.3'
+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
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "url_hash #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/url_hash.rb

@@ -0,0 +1,90 @@
+require 'openssl'
+require 'base64'
+
+module UrlHash
+  DEFAULT_HASH_LENGTH = 8
+  ALGORITHM = 'aes-256-cfb8'
+  
+  # convert an id (an integer) to a hash, a URL-compatible string.
+  # 
+  # for example. UrlHash.to_hash(1001) -> '+xDdeave3'
+  #
+  # options:
+  #   :hash_length => how many characters to use for the hash. Defaults to 8.
+  #     descreasing this increase the probability of a collision
+  #   :key, :iv => provide these two options if you want to encrypt the hash.
+  #     otherwise, it will relatively trivial for users to predict your hashes,
+  #     and to work out ids based on them. Decide for yourself if this is a problem.
+  #     It is recommended to generate them using Digest::SHA2.hexdigest.
+  def self.to_hash(id, options = {})
+    options = {:hash_length => DEFAULT_HASH_LENGTH}.merge(options)
+    
+    # buffers use all 256 bytes, hashes just 64, thus we can only use 3/4 the numbers
+    #   -> 256 ** buffer_length <= 64 ** hash_length
+    buffer_length = (3 * options[:hash_length] / 4).floor
+    
+    buffer = int_to_buffer(id, buffer_length)
+    
+    if (options.has_key? :key and options.has_key? :iv) 
+      # encrypt the buffer
+      buffer = self.encrypt(buffer, true, options)
+    end
+    
+    # use -'s instead of + as we like that better
+    Base64.encode64(buffer).tr("+", "-").strip
+  end
+  
+  # convert an hash, as produced by to_hash, back into the original integer
+  # 
+  # for example. UrlHash.to_hash('+xDdeave3') -> 1001
+  #
+  # options:
+  #   :key, :iv => provide these again if you are encrypting hashes
+  def self.from_hash(hash, options = {})
+    buffer = Base64.decode64(hash.tr("-", "+"))
+    
+    if (options.has_key? :key and options.has_key? :iv) 
+      # encrypt the buffer
+      buffer = self.encrypt(buffer, false, options)
+    end
+    
+    buffer_to_int(buffer)
+  end
+  
+private
+  def self.encrypt(buffer, forward, options)
+    c = OpenSSL::Cipher::Cipher.new(ALGORITHM)
+    forward ? c.encrypt : c.decrypt
+    c.key = options[:key]
+    c.iv = options[:iv]
+
+    e = c.update(buffer)
+    e << c.final
+  
+    e
+  end
+  
+  # turn a integer into a string representation.
+  # we need to ensure that we use put the non-zero stuff on the
+  # the MSB side so that it randomizes the string properly:
+  # see : http://www.columbia.edu/~ariel/ssleay/fip81/fip81.html#td2
+  def self.int_to_buffer(int, size)
+    "".tap do |buf|
+      size.times do
+        buf << (int & 0xff)
+        int /= 0x100
+      end
+    end
+  end
+
+  def self.buffer_to_int(buffer)
+    int = 0
+    multiplier = 1
+    buffer.each_byte do |b|
+      int += multiplier * b
+      multiplier *= 0x100
+    end
+    
+    int
+  end
+end

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 'url_hash'
+
+class Test::Unit::TestCase
+end

data/test/test_url_hash.rb

@@ -0,0 +1,28 @@
+require 'helper'
+require 'digest'
+
+class TestUrlHash < Test::Unit::TestCase
+  context "UrlHash" do
+    should "convert between integers and buffers" do
+      assert_equal 1001, UrlHash.buffer_to_int(UrlHash.int_to_buffer(1001, 8))
+      assert_equal 1001, UrlHash.buffer_to_int(UrlHash.int_to_buffer(1001, 10))
+    end
+    
+    should "convert between integers and hashes without encryption" do
+      assert_equal 1001, UrlHash.from_hash(UrlHash.to_hash(1001))
+    end
+    
+    should "correctly set the hash length" do
+      assert_equal 8, UrlHash.to_hash(1001, :hash_length => 8).length
+      assert_equal 12, UrlHash.to_hash(1001, :hash_length => 12).length
+    end
+    
+    should "convert between integers and hashes with encryption" do
+      options = {
+        :key => Digest::SHA2.hexdigest('test key'), 
+        :iv => Digest::SHA2.hexdigest('test initial value')
+      }
+      assert_equal 1001, UrlHash.from_hash(UrlHash.to_hash(1001, options), options)
+    end
+  end
+end

data/url_hash.gemspec

@@ -0,0 +1,63 @@
+# 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{url_hash}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Coleman"]
+  s.date = %q{2011-04-27}
+  s.description = %q{Create url-embeddable hashes from integers, for use in short-url services or simple to shorten resource accesses.}
+  s.email = %q{tom@thesnail.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/url_hash.rb",
+    "test/helper.rb",
+    "test/test_url_hash.rb",
+    "url_hash.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tmeasday/url_hash}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Create url-embeddable hashes from integers}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_url_hash.rb"
+  ]
+
+  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.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification 
+name: url_hash
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-27 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+description: Create url-embeddable hashes from integers, for use in short-url services or simple to shorten resource accesses.
+email: tom@thesnail.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/url_hash.rb
+- test/helper.rb
+- test/test_url_hash.rb
+- url_hash.gemspec
+has_rdoc: true
+homepage: http://github.com/tmeasday/url_hash
+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: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Create url-embeddable hashes from integers
+test_files: 
+- test/helper.rb
+- test/test_url_hash.rb