obfuscate_id 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd7d195e3e48bc52a6a503768fa97a6e3a1e2ecf
+  data.tar.gz: 06c755b17b92e191a58ee54c20e9660a04330ebd
+SHA512:
+  metadata.gz: c414a598a21e07bdb67aa85e0a5d07808124cabf44ab6a7f91198a5a2579f74f6620a79c86edbf6e2b40bd705cc76342780b3b13dcd03d851524be4d4d2aedae
+  data.tar.gz: 44df8d341bea9f1a482e8488a50095402c0e50ccd2d0033e605557fce1a41bb8ca6cd04def070698a86ac432b59a46ae180bed2e33b8aa09032ee0f3ae0ab895

data/README.md

@@ -81,3 +81,32 @@ ActiveRecord reverses this obfuscated id back to the plain id before building th
 * 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)`.
 
+## Development
+
+To run the tests, first clone the repo and run bundler:
+
+    git clone git@github.com:namick/obfuscate_id.git
+    cd obfuscate_id
+    bundle install
+
+Change to the dummy rails app and load the test database
+
+    cd spec/dummy
+    bundle exec rake db:test:load
+    cd -
+
+Run the tests
+
+    bundle exec rspec spec
+
+Or have Guard run them continuously
+
+    bundle exec guard
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/obfuscate_id.rb

@@ -1,7 +1,8 @@
 module ObfuscateId
 
   def obfuscate_id(options = {})
-    require 'obfuscate_id/scatter_swap'
+    require 'scatter_swap'
+
     extend ClassMethods 
     include InstanceMethods
     cattr_accessor :obfuscate_id_spin
@@ -19,16 +20,27 @@ module ObfuscateId
 
   module ClassMethods
     def find(*args)
-      if has_obfuscated_id?
-        args[0] = ObfuscateId.show(args[0], self.obfuscate_id_spin)
+      scope = args.slice!(0)
+      options = args.slice!(0) || {}
+      if has_obfuscated_id? && !options[:no_obfuscated_id]
+        if scope.is_a?(Array)
+          scope.map! {|a| deobfuscate_id(a).to_i}
+        else
+          scope = deobfuscate_id(scope)
+        end
       end
-      super(*args)
+      options.delete(:no_obfuscated_id)
+      super(scope, options)
     end
 
     def has_obfuscated_id?
       true
     end
 
+    def deobfuscate_id(obfuscated_id)
+      ObfuscateId.show(obfuscated_id, self.obfuscate_id_spin)
+    end
+
     # Generate a default spin from the Model name
     # This makes it easy to drop obfuscate_id onto any model
     # and produce different obfuscated ids for different models
@@ -47,14 +59,15 @@ module ObfuscateId
       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
+    # As ActiveRecord::Persistence#reload uses self.id
+    # reload without deobfuscating
+    def reload(options = nil)
+      options = (options || {}).merge(:no_obfuscated_id => true)
+      super(options)
+    end
+
+    def deobfuscate_id(obfuscated_id)
+      self.class.deobfuscate_id(obfuscated_id)
     end
   end
 end

data/lib/obfuscate_id/version.rb

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

metadata

@@ -1,126 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: obfuscate_id
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Nathan Amick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: scatter_swap
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.15
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.15
 - !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'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   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'
 - !ruby/object:Gem::Dependency
   name: capybara
   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'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   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'
 - !ruby/object:Gem::Dependency
   name: guard-spork
   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'
 - !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
@@ -130,36 +129,34 @@ executables: []
 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.rb
+- lib/tasks/obfuscate_id_tasks.rake
 - MIT-LICENSE
 - Rakefile
 - README.md
-homepage: 
+homepage: https://github.com/namick/obfuscate_id
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Mask ActiveRecord IDs
 test_files: []
+has_rdoc: 

data/lib/obfuscate_id/run_scatter_swap.rb

@@ -1,93 +0,0 @@
-require './scatter_swap.rb'
-
-# This file isn't really part of the library, its pretty much spike code.. 
-# 
-# While developing this, I used this file to visualize what was going on with the numbers
-#
-# You can uncomment various methods at the bottom and then run it like this:
-#
-# watch -n1 ruby run_scatter_swap.rb
-# 
-# tweak the code a bit and see instant visual changes in the generated numbers
-
-def visualize_scatter_and_unscatter
-  # change this number to experiment with different values
-  rotations = 99
-
-  original = ScatterSwap.arrayify(123456789)
-  scattered = []
-  unscattered = []
-  puts original.join
-  puts "rotate!(#{rotations})"
-  10.times do
-    puts original.rotate!(rotations).join + "->" + scattered.push(original.pop).join
-  end
-  puts "scattered"
-  puts scattered.join
-  10.times do
-    puts unscattered.push(scattered.pop).join + "->" + unscattered.rotate!(rotations * -1).join
-  end
-
-  puts unscattered.join
-end
-
-
-def visualize_swapper_map
-  puts "swapper map"
-  10.times do |index|
-    key = 1
-    puts ScatterSwap.swapper_map(index).join.to_s
-  end
-end
-
-def visualize_hash
-  puts "hash"
-  40.times do |integer|
-    output = "|"
-    3.times do |index|
-      output += " #{(integer + (123456789 * index)).to_s.rjust(5, ' ')}"
-      output += " => #{hashed = ScatterSwap.hash(integer + (123456789 * index) ) }"
-      output += " => #{ScatterSwap.reverse_hash(hashed) } |"
-    end
-    puts output
-  end
-end
-
-
-def visualize_scatter
-  puts "original      scattered     unscattered"
-  20.times do |integer|
-    output = ""
-    2.times do |index|
-      original = ScatterSwap.arrayify(integer + (123456789 * index))
-      scattered = ScatterSwap.scatter(original.clone)
-      unscattered = ScatterSwap.unscatter(scattered.clone)
-      output += "#{original.join}" 
-      output += " => #{scattered.join}"
-      output += " => #{unscattered.join}    |    "
-    end
-    puts output
-  end
-end
-
-
-# find hash for lots of spins
-def visualize_spin
-  2000.times do |original|
-    hashed_values = []
-    9000000000.times do |spin|
-      hashed =  ScatterSwap.hash(original, spin)
-      if hashed_values.include? hashed
-        puts "collision: #{original} - #{spin} - #{hashed}"
-        break
-      end
-      hashed_values.push hashed
-    end
-  end
-end
-
-#visualize_spin
-#visualize_hash
-#visualize_scatter_and_unscatter
-#visualize_scatter
-#visualize_swapper_map

data/lib/obfuscate_id/scatter_swap.rb

@@ -1,138 +0,0 @@
-class ScatterSwap
-  # This is the hashing function behind ObfuscateId.
-  # https://github.com/namick/obfuscate_id
-  #
-  # Designing a hash function is a bit of a black art and
-  # being that I don't have math background, I must resort
-  # to this simplistic swaping and scattering of array elements.
-  #
-  # After writing this and reading/learning some elemental hashing techniques,
-  # I realize this library is what is known as a Minimal perfect hash function:
-  # http://en.wikipedia.org/wiki/Perfect_hash_function#Minimal_perfect_hash_function
-  #
-  # I welcome all improvements :-)
-  #
-  # If you have some comments or suggestions, please contact me on github
-  # https://github.com/namick
-  #
-  # - nathan amick
-  # 
-  #
-  # This library is built for integers that can be expressed with 10 digits:
-  # It zero pads smaller numbers... so the number one is expressed with:
-  # 0000000001
-  # The biggest number it can deal with is:
-  # 9999999999
-  #
-  # Since we are working with a limited sequential set of input integers, 10 billion,
-  # this algorithm will suffice for simple id obfuscation for many web apps.
-  # The largest value that Ruby on Rails default id, Mysql INT type, is just over 2 billion (2147483647)
-  # which is the same as 2 to the power of 31 minus 1, but considerably less than 10 billion.
-  #
-  # ScatterSwap is an integer hash function designed to have:
-  # - zero collisions ( http://en.wikipedia.org/wiki/Perfect_hash_function )
-  # - achieve avalanche ( http://en.wikipedia.org/wiki/Avalanche_effect )
-  # - reversable
-  #
-  # We do that by combining two distinct strategies.
-  #
-  # 1. Scattering - whereby we take the whole number, slice it up into 10 digits
-  # and rearange their places, yet retaining the same 10 digits.  This allows
-  # us to preserve the sum of all the digits, regardless of order.  This sum acts
-  # as a key to reverse this scattering effect.
-  # 
-  # 2. Swapping - when dealing with many sequential numbers that we don't want
-  # to look similar, scattering wont do us much good because so many of the
-  # digits are the same; it deoesn't help to scatter 9 zeros around, so we need
-  # to swap out each of those zeros for something else.. something different
-  # for each place in the 10 digit array; for this, we need a map so that we
-  # can reverse it.
-
-  # Convience class method pointing to the instance method
-  def self.hash(plain_integer, spin = 0)
-    new(plain_integer, spin).hash
-  end
-
-  # Convience class method pointing to the instance method
-  def self.reverse_hash(hashed_integer, spin = 0)
-    new(hashed_integer, spin).reverse_hash
-  end
-
-  def initialize(original_integer, spin = 0)
-    @original_integer = original_integer
-    @spin = spin
-    zero_pad  = original_integer.to_s.rjust(10, '0')
-    @working_array = zero_pad.split("").collect {|d| d.to_i}
-  end
-
-  attr_accessor :working_array
-
-  # obfuscates an integer up to 10 digits in length
-  def hash
-    swap
-    scatter
-    completed_string
-  end
-
-  # de-obfuscates an integer
-  def reverse_hash
-    unscatter
-    unswap
-    completed_string
-  end
-
-  def completed_string
-    @working_array.join
-  end
-
-  # We want a unique map for each place in the original number
-  def swapper_map(index)
-    array = (0..9).to_a
-    10.times.collect.with_index do |i|
-      array.rotate!(index + i ^ spin).pop
-    end
-  end
-
-  # Using a unique map for each of the ten places,
-  # we swap out one number for another
-  def swap
-    @working_array = @working_array.collect.with_index do |digit, index|
-      swapper_map(index)[digit]
-    end
-  end
-
-  # Reverse swap
-  def unswap
-    @working_array = @working_array.collect.with_index do |digit, index|
-      swapper_map(index).rindex(digit)
-    end
-  end
-
-  # Rearrange the order of each digit in a reversable way by using the 
-  # sum of the digits (which doesn't change regardless of order)
-  # as a key to record how they were scattered
-  def scatter
-    sum_of_digits = @working_array.inject(:+).to_i
-    @working_array = 10.times.collect do 
-      @working_array.rotate!(spin ^ sum_of_digits).pop
-    end
-  end
-
-  # Reverse the scatter
-  def unscatter
-    scattered_array = @working_array
-    sum_of_digits = scattered_array.inject(:+).to_i
-    @working_array = []
-    @working_array.tap do |unscatter| 
-      10.times do
-        unscatter.push scattered_array.pop
-        unscatter.rotate! (sum_of_digits ^ spin) * -1
-      end
-    end
-  end
-
-  # Add some spice so that different apps can have differently mapped hashes
-  def spin
-    @spin || 0
-  end
-end