obfuscate_id 0.0.1 → 0.0.3

data/README.md

@@ -1,10 +1,12 @@
-# ObfuscateId
+# obfuscate_id
+[![Build Status](https://secure.travis-ci.org/namick/obfuscate_id.png)](http://travis-ci.org/namick/obfuscate_id) [![Dependency Status](https://gemnasium.com/namick/obfuscate_id.png)](https://gemnasium.com/namick/obfuscate_id) [![Code Climate](https://codeclimate.com/github/namick/obfuscate_id.png)](https://codeclimate.com/github/namick/obfuscate_id)
 
-ObfuscateId is a simple Ruby on Rails plugin that hides your seqential Active Record ids.  Although having nothing to do with security, it can be used to make database record id information non-obvious.
+**Make your ActiveRecord ids non-obvious**
 
-For new websites, you may not want to give away information about how many people are signed up.  Every website has a third user, but that third user doesn't have to know he is the third user.
+![cat with sunglasses](http://i.imgur.com/kYOtUll.jpg)
 
-ObfuscateId turns a URL like this:
+
+obfuscate_id turns a URL like this:
 
     http://example.com/users/3
 
@@ -12,11 +14,7 @@ into something like:
 
     http://example.com/users/2356513904
     
-ObfuscateId mixes up the ids in a simple, reversable hashing algorithm so that it can then automatically revert the hashed number back to 3 for record lookup without having to store a hash or tag in the database.  No migrations needed.
-
-If you have the opposite problem, and your site is scaling well, you might not want to leak that you are getting 50 new posts a minute.
-
-ObfuscateId turns your sequential Active Record ids into non-sequential, random looking, numeric ids.
+Sequential ActiveRecord ids become non-sequential, random looking, numeric ids.
 
     # post 7000
     http://example.com/posts/5270192353
@@ -24,13 +22,21 @@ ObfuscateId turns your sequential Active Record ids into non-sequential, random
     http://example.com/posts/7107163820
     # post 7002
     http://example.com/posts/3296163828
+       
+## Why would you want this?
+
+If your site is scaling well, you might not want to leak that you are getting 50 new posts a minute.
+
+Or, for new websites, you may not want to give away how few people are signed up.
+
+Every website has a third user, but that third user doesn't have to know he is the third user.
 
 ## Features
 
 * Extreemly simple. A single line of code in the model turns it on.
 * Transforms normal seqential ids into random-looking ten digit numerical strings.
 * Gently masks resource ids while retaining a cleaner look than using an encrypted hash.
-* No migrations or database changes are needed.  The record is still stored in the database with its original id.
+* No database changes or migrations are needed.  The record is still stored in the database with its original id.
 * Fast, no heavy calculation.
 
 
@@ -44,7 +50,9 @@ Run bundler.
 
     bundle install
 
-Then, in your model, add a single line.  
+## Usage
+
+In your model, add a single line.  
 
     class Post < ActiveRecord::Base
       obfuscate_id
@@ -58,20 +66,18 @@ If you want your obfuscated ids to be different than some other website using th
       obfuscate_id :spin => 89238723
     end
 
-This is also useful for making different models in the same app have different obfuscated ids.
-
 ## How it works
 
-ObfuscateId pairs each number, from 0 to 9999999999, with one and only one number in that same range.  That other number is paired back to the first.  This is an example of a minimal perfect hash function.   Within a set of ten billion numbers, it simply maps every number to a different 10 digit number, and back again.
+obfuscate_id mixes up the ids in a simple, reversable hashing algorithm so that it can then automatically revert the hashed number back to the original id for record lookup without having to store a hash or tag in the database.
+
+Each number from 0 to 9,999,999,999 is paired with one and only one number in that same range.  That other number is paired back to the first.  This is an example of a minimal perfect hash function.   Within a set of ten billion numbers, it simply maps every number to a different 10 digit number, and back again.
 
-ObfuscateId switches the plain record id to the obfuscated id in the models `to_param` method.
+Plain record ids are switched to the obfuscated id in the model's `to_param` method.
 
-It then augments Active Record's `find` method on models that have have been initiated with the `obfuscate_id` method to quickly reverse this obfuscated id back to the plain id before building the database query. This means no migrations or changes to the database.
+ActiveRecord reverses this obfuscated id back to the plain id before building the database query. This means no migrations or changes to the database.  Yay!
 
 ## Limitations
 
-* This is not security.  ObfuscateId was created to lightly mask record id numbers for the casual user.  If you need to really secure your database ids (hint, you probably don't), you need to use real encryption like AES.
-* Works for up to ten billion database records.  ObfuscateId simply maps every integer below ten billion to some other number below ten billion.
+* This is not security.  obfuscate_id was created to lightly mask record id numbers for the casual user.  If you need to really secure your database ids (hint, you probably don't), you need to use real encryption like AES.
 * To properly generate obfuscated urls, make sure you trigger the model's `to_param` method by passing in the whole object rather than just the id; do this: `post_path(@post)` not this: `post_path(@post.id)`.
-* Rails uses the real id rather than `to_param` in some places.  A simple view-source on a form will often show the real id. This can be avoided by taking certain precautions. 
 

data/Rakefile

@@ -20,8 +20,10 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+Bundler::GemHelper.install_tasks
 
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
 
-Bundler::GemHelper.install_tasks
-
+task :default => :spec

data/lib/obfuscate_id.rb

@@ -8,19 +8,19 @@ module ObfuscateId
     self.obfuscate_id_spin = (options[:spin] || obfuscate_id_default_spin)
   end
 
-  def self.hide(id)
-    ScatterSwap.hash(id)
+  def self.hide(id, spin)
+    ScatterSwap.hash(id, spin)
   end
 
-  def self.show(id)
-    ScatterSwap.reverse_hash(id)
+  def self.show(id, spin)
+    ScatterSwap.reverse_hash(id, spin)
   end
 
 
   module ClassMethods
     def find(*args)
       if has_obfuscated_id?
-        args[0] = ObfuscateId.show(args[0])
+        args[0] = ObfuscateId.show(args[0], self.obfuscate_id_spin)
       end
       super(*args)
     end
@@ -44,9 +44,18 @@ module ObfuscateId
 
   module InstanceMethods
     def to_param
-      ObfuscateId.hide(self.id)
+      ObfuscateId.hide(self.id, self.class.obfuscate_id_spin)
     end
 
+    # Temporarily set the id to the parameterized version,
+    # as ActiveRecord::Persistence#reload uses self.id.
+    def reload(options=nil)
+      actual_id = self.id
+      self.id = to_param
+      super(options).tap do
+        self.id = actual_id
+      end
+    end
   end
 end
 

data/lib/obfuscate_id/version.rb

@@ -1,3 +1,3 @@
 module ObfuscateId
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obfuscate_id
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-12 00:00:00.000000000Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &9066640 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *9066640
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &9063100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9063100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &9061600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9061600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &9058580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9058580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &9057040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9057040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-spork
-  requirement: &9055460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +101,29 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *9055460
-description: ObfuscateId is a simple Ruby on Rails plugin that hides your seqential
-  Active Record ids.  Although having nothing to do with security, it can be used
-  to make database record id information non-obvious.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  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: Make your ActiveRecord IDs non-obvious
 email:
 - github@nathanamick.com
 executables: []
@@ -87,14 +131,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/tasks/obfuscate_id_tasks.rake
+- lib/obfuscate_id.rb
+- lib/obfuscate_id/version.rb
 - lib/obfuscate_id/scatter_swap.rb
 - lib/obfuscate_id/run_scatter_swap.rb
-- lib/obfuscate_id/version.rb
-- lib/obfuscate_id.rb
 - MIT-LICENSE
 - Rakefile
 - README.md
-homepage: ''
+homepage: 
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -106,22 +150,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -372583255443185690
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -372583255443185690
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: A simple Rails plugin that lightly masks seqential ActiveRecord ids
+summary: Mask ActiveRecord IDs
 test_files: []