hideous 0.0.3

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+# Specify your gem's dependencies in hideous.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Morton Jonuschat
+
+MIT License
+
+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,29 @@
+# Hideous
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hideous'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hideous
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hideous.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hideous/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Morton Jonuschat"]
+  gem.email         = ["yabawock@gmail.com"]
+  gem.description   = %q{Hide/Obfuscate ActiveRecord IDs in a url using a modified Knuth hash}
+  gem.summary       = %q{A simple Rails plugin to obfuscate ActiveRecord IDs a bit}
+  gem.homepage      = "https://github.com/yabawock/hideous"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hideous"
+  gem.require_paths = ["lib"]
+  gem.version       = Hideous::VERSION
+end

data/lib/hideous.rb

@@ -0,0 +1,60 @@
+require "hideous/version"
+
+module Hideous
+
+  def obfuscate_id(options = {})
+    require 'hideous/xor_knuth_hash'
+    extend ClassMethods
+    include InstanceMethods
+    cattr_accessor :hideous_prime
+    cattr_accessor :hideous_prime_inverse
+    cattr_accessor :hideous_rndxor
+    self.hideous_prime = (options[:prime] || hideous_default_prime)
+    self.hideous_prime_inverse = (options[:prime_inverse] || hideous_default_prime_inverse)
+    self.hideous_rndxor = (options[:rndxor] || hideous_default_rndxor)
+  end
+
+  def self.hide(id, hideous_prime, hideous_prime_inverse, hideous_rndxor)
+    XorKnuthHash.hash(id, hideous_prime, hideous_prime_inverse, hideous_rndxor)
+  end
+
+  def self.show(id, hideous_prime, hideous_prime_inverse, hideous_rndxor)
+    XorKnuthHash.reverse_hash(id, hideous_prime, hideous_prime_inverse, hideous_rndxor)
+  end
+
+
+  module ClassMethods
+    def find(*args)
+      if has_obfuscated_id?
+        args[0] = Hideous.show(args[0], self.hideous_prime, self.hideous_prime_inverse, self.hideous_rndxor)
+      end
+      super(*args)
+    end
+
+    def has_obfuscated_id?
+      true
+    end
+
+    def hideous_default_prime
+      413_158_511
+    end
+
+    def hideous_default_prime_inverse
+      1_711_444_623
+    end
+
+    def hideous_default_rndxor
+      652_109_907
+    end
+  end
+
+  module InstanceMethods
+    def to_param
+      Hideous.hide(self.id, self.hideous_prime, self.hideous_prime_inverse, self.hideous_rndxor)
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.extend Hideous

data/lib/hideous/version.rb

@@ -0,0 +1,3 @@
+module Hideous
+  VERSION = "0.0.3"
+end

data/lib/hideous/xor_knuth_hash.rb

@@ -0,0 +1,59 @@
+class XorKnuthHash
+  MAXID = 2147483647
+  # Convience class method pointing to the instance method
+  def self.hash(record_id, prime, prime_inverse, rndxor)
+    new(record_id, prime, prime_inverse, rndxor).hash
+  end
+
+  # Convience class method pointing to the instance method
+  def self.reverse_hash(hash, prime, prime_inverse, rndxor)
+    new(hash, prime, prime_inverse, rndxor).reverse_hash
+  end
+
+  def self.calculate_prime_inverse(prime)
+    self.modinv(prime, MAXID+1)
+  end
+
+  def initialize(id_or_hash, prime, prime_inverse, rndxor)
+    @id_or_hash = id_or_hash
+    @prime = prime
+    @prime_inverse = prime_inverse
+    @rndxor = rndxor
+  end
+
+  # obfuscates an integer
+  def hash
+    (((@id_or_hash * @prime) & MAXID) ^ @rndxor).to_s(16)
+  end
+
+  # de-obfuscates an integer
+  def reverse_hash
+    ((@id_or_hash.to_i(16) ^ @rndxor) * @prime_inverse) & MAXID
+  end
+
+  private
+
+  # Modular inverse
+  # Returns x so that ax ≡ 1 (mod m)
+  def self.modinv(a, m)
+    x, y, g = egcd(a, m)
+    if g==1
+      return x%m
+    else
+      return nil
+    end
+  end
+
+  # Extended great common divisor
+  # Returns x, y and gcd(a,b) so that ax + by = gcd(a,b)
+  def self.egcd(a, b)
+    x, x1, y, y1 = 1, 0, 0, 1
+    while b!=0
+      q = a/b
+      x, x1 = x1, x-q*x1
+      y, y1 = y1, y-q*y1
+      a, b  =  b, a-q*b
+    end
+    return x, y, a
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: hideous
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Morton Jonuschat
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies: []
+description: Hide/Obfuscate ActiveRecord IDs in a url using a modified Knuth hash
+email:
+- yabawock@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hideous.gemspec
+- lib/hideous.rb
+- lib/hideous/version.rb
+- lib/hideous/xor_knuth_hash.rb
+homepage: https://github.com/yabawock/hideous
+licenses: []
+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: -488321943809870856
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -488321943809870856
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple Rails plugin to obfuscate ActiveRecord IDs a bit
+test_files: []