encrypted_id 1.0.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p194@encrypted_id"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.15.8 (stable)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,15 @@
+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 'rspec', '~> 2.8.0'
+  gem 'bundler', '~> 1.2.0'
+  gem 'jeweler', '~> 1.8.4'
+  gem 'sqlite3'
+end
+
+gem 'activerecord', '>= 3.0.0'

data/Gemfile.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.3)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sqlite3 (1.3.6)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0)
+  bundler (~> 1.2.0)
+  jeweler (~> 1.8.4)
+  rspec (~> 2.8.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Nils Caspar
+
+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,48 @@
+# encrypted_id
+
+Sometimes you don't want your users to see the actual ID of your databases entries. This gem allows you to hide the ID.
+
+encrypted_id turns a URL like this:
+
+    http://www.example.com/users/15
+
+into something like:
+
+    http://www.example.com/users/1e8644f924812bec506b116ff14368c8
+
+encrypted_id uses AES-256 (CBC) with a configurable key (per model) to do so.
+
+## Installation
+
+Add the gem to your Gemfile:
+
+    gem 'encrypted_id'
+
+Run bundler:
+
+    bundle install
+
+## Usage
+
+In your model, add the following line:
+
+    class User < ActiveRecord::Base
+      encrypted_id key: '5gA6lgr5g3GOg7EOQ1caYQ'
+    end
+
+Replace the "key" with a random value (should be different for every model).
+
+## Contributing to encrypted_id
+ 
+* 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) 2012 Nils Caspar. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,34 @@
+# 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 = "encrypted_id"
+  gem.homepage = "http://github.com/pencil/encrypted_id"
+  gem.license = "MIT"
+  gem.summary = "Allows you to encrypt the ID of your ActiveRecord model."
+  gem.description = "Sometimes you don't want your users to see the actual ID of your databases entries. This gem allows you to hide the ID."
+  gem.email = "ncaspar@me.com"
+  gem.authors = ["Nils Caspar"]
+  # dependencies defined in Gemfile
+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
+
+task :default => :spec

data/VERSION

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

data/lib/encrypted_id.rb

@@ -0,0 +1,58 @@
+require 'openssl'
+require 'active_record'
+
+module EncryptedId
+
+  CIPHER_NAME = 'aes-256-cbc'
+  CIPHER_IV = ['1e5673b2572af26a8364a50af84c7d2a'].pack('H*')
+
+  def encrypted_id(options = {})
+    extend ClassMethods
+    include InstanceMethods
+    cattr_accessor :encrypted_id_key
+    self.encrypted_id_key = Digest::SHA256.digest(options[:key] || encrypted_id_default_key)
+  end
+
+  def self.decrypt(key, id)
+    c = OpenSSL::Cipher::Cipher.new(CIPHER_NAME).decrypt
+    c.iv = CIPHER_IV
+    c.key = key
+    c.update([id].pack('H*')) + c.final
+  end
+
+  def self.encrypt(key, id)
+    c = OpenSSL::Cipher::Cipher.new(CIPHER_NAME).encrypt
+    c.iv = CIPHER_IV
+    c.key = key
+    (c.update("#{id}") + c.final).unpack('H*')[0]
+  end
+
+  module ClassMethods
+    def find(*args)
+      if has_encrypted_id?
+        begin
+          args[0] = EncryptedId.decrypt(encrypted_id_key, "#{args[0]}")
+        rescue OpenSSL::Cipher::CipherError
+          raise ActiveRecord::RecordNotFound.new("Could not decrypt ID #{args[0]}")
+        end
+      end
+      super(*args)
+    end
+
+    def has_encrypted_id?
+      true
+    end
+
+    def encrypted_id_default_key
+      name
+    end
+  end
+
+  module InstanceMethods
+    def to_param
+      EncryptedId.encrypt(self.class.encrypted_id_key, self.id)
+    end
+  end
+end
+
+ActiveRecord::Base.extend EncryptedId

data/spec/encrypted_id_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'EncryptedId' do
+  describe 'in the User model' do
+    before(:each) do
+      @user = User.new
+    end
+
+    it 'should give us the encrypted ID via to_param' do
+      @user.id = 15
+      @user.to_param.should == '1e8644f924812bec506b116ff14368c8'
+    end
+
+    it 'should be possible to find an entry by the encrypred id' do
+      @user.id = 8
+      @user.save!
+      User.find('da9f98cd7c3eb2b0f0e88cc8daeb222c').id.should == 8
+    end
+
+    it 'should throw an exception if we try to find an entry by the real ID' do
+      @user.id = 1
+      @user.save!
+      expect { User.find 1 }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+
+  describe 'in the Animal model' do
+    before(:each) do
+      @animal = Animal.new
+    end
+
+    it 'should give us the encrypted ID via to_param' do
+      @animal.id = 15
+      @animal.to_param.should == '2f71ba22a8e6975db0f13b7e3db6d9cd'
+    end
+
+    it 'should be possible to find an entry by the encrypred id' do
+      @animal.id = 8
+      @animal.save!
+      Animal.find('6916a1adba452d3fffde6e444ae1ad3a').id.should == 8
+    end
+
+    it 'should throw an exception if we try to find an entry by the real ID' do
+      @animal.id = 1
+      @animal.save!
+      expect { Animal.find 1 }.to raise_error(ActiveRecord::RecordNotFound)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'encrypted_id'
+
+# 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|
+  c = ActiveRecord::Base.establish_connection(
+    :adapter => 'sqlite3',
+    :database => 'spec/test.sqlite3'
+  )
+  [:users, :animals].each do |table|
+    ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS '#{table}'")
+    ActiveRecord::Base.connection.create_table(table) do |t|
+      t.timestamps
+    end
+  end
+end

data/spec/support/models/animal.rb

@@ -0,0 +1,3 @@
+class Animal < ActiveRecord::Base
+  encrypted_id :key => 'lbI3iFyKO9zsK1U8ppG5at'
+end

data/spec/support/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  encrypted_id :key => '5gA6lgr5g3GOg7EOQ1caYQ'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: encrypted_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nils Caspar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sometimes you don't want your users to see the actual ID of your databases
+  entries. This gem allows you to hide the ID.
+email: ncaspar@me.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rspec
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/encrypted_id.rb
+- spec/encrypted_id_spec.rb
+- spec/spec_helper.rb
+- spec/support/models/animal.rb
+- spec/support/models/user.rb
+homepage: http://github.com/pencil/encrypted_id
+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: -4444389274485543368
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Allows you to encrypt the ID of your ActiveRecord model.
+test_files: []