hashid 1.0.0

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitswitch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kelly Becker
+
+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 @@
+# HashId
+
+HashId lets you hide your database ids with on the spot generated hashes. The hases will be valid 100% of the time unless you change the salt this can also be used to create confirmation codes or tracking numbers.
+
+## Installing BitSwitch
+
+You can install HashId with [RubyGems](https://rubygems.org/gems/hashid).
+
+`gem install hashid` or `gem 'hashid'`
+
+## Contributing to BitSwitch
+ 
+* 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.
+
+## Todo
+
+* Write some documentation
+
+## Copyright
+
+Copyright (c) 2012 Kelly Becker. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hashid.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hashid/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "hashid"
+  gem.version       = KellyLSB::HashId::VERSION
+  gem.authors       = ["Kelly Becker"]
+  gem.email         = ["kellylsbkr@gmail.com"]
+  gem.description   = "With HashId you can hide your actual page ids with on the spot randomly generated hashes."
+  gem.summary       = "HashId lets you hide your databse ids with on the spot generated hashes."
+  gem.homepage      = "http://kellybecker.me"
+
+  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.require_paths = ["lib"]
+end

data/lib/hashid.rb

@@ -0,0 +1,177 @@
+class HashId
+	class Error < StandardError; end
+
+	def initialize(salt = nil)
+		@salt = salt || 'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'
+		
+		@letters = [
+			'P0MVLWNTZD',
+			'UE58X2VSCT',
+			'43Z0Y9AQLS',
+			'V5Q1P4E8L9',
+			'MOIRZCWXED',
+			'7NBYXCZU9R',
+			'G2S90I84MC',
+			'TQAMIWH4ZC',
+			'POERHBYA1F',
+			'XKO20UB3IL',
+			'Y0NTH78VSO',
+			'P4DE6VUZLK',
+			'9OKN2JLQGI',
+			'61UTFSN0BR',
+			'R7ZAHJVGE9',
+			'ADHIZ5WNUQ',
+			'Z9SPX2OQI5',
+			'V7YFEU4PTJ',
+			'YZVFD6UXNG',
+			'VH8UDLCE93',
+			'W0H5GMTFZK',
+			'GXE6CT2VOP',
+			'QH2FLZOM9V',
+			'MBGHIF78PU',
+			'MHS04FY8L7',
+			'E95IGRSMZ1',
+			'MN8AILRB95',
+			'S7JVO4EHCD',
+			'GT01ZPLVUA',
+			'9OKN2JLQGI',
+			'DUF24AGTSN',
+			'4ASPNFJ2BR',
+			'OR465YEXQV',
+			'DUF24AGTSN',
+			'M78PCRAGKS',
+			'D8LVQSKA7U'
+		]
+		
+		@indexes = [
+			[0,0],
+			[0,1],
+			[1,0],
+			[2,0],
+			[0,2],
+			[1,1],
+			[2,1],
+			[1,2]
+		]
+	end
+	
+	def self.generate_salt
+		'ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890'.split(//).shuffle.join('')
+	end
+	
+	def encrypt(string, len = 8)
+	
+		# Require a fixnum for the encryption process
+		raise Error, 'HashID.encrypt expected a Fixnum as its argument' unless string.is_a?(Fixnum)
+		
+		# Require a fixnum for the encryption process
+		raise Error, 'HashID.encrypt must have a length of no less then 6' unless string.is_a?(Fixnum)
+	
+		# Prep the string for encryption
+		string = string.to_s.rjust(len, '0')
+	
+		# Get the salt ids to use
+		saltids = Array.new
+		random = [*0..35].shuffle
+		3.times{saltids<<random.shift}
+		
+		# Get the letters cooresponding to the salts
+		salts = saltids.collect{|x|@letters[x]}
+		
+		# Go ahead and convert the numbers into the new format
+		i=2;string=string.split(//).collect{|x|i==2?i=0:i+=1;salts[i][x.to_i,1]}.join('')
+		
+		# Turn the salt ids into their letter forms
+		saltids.collect!{|x|@salt[x,1]}
+		
+		# Get the index id and the indexes
+		indexid = [*0..7].shuffle.first
+		injections = @indexes[indexid]
+		
+		# Inject the indexes and index id
+		string.insert(injections.first, saltids[0])
+		string.insert(string.length - injections.last, saltids[1])
+		string << saltids[2] + @salt[indexid,1]
+	end
+	
+	def decrypt(string)
+	
+		# Require a string for the decryption process
+		raise Error, 'HashID.decrypt expected a String as its argument' unless string.is_a?(String)
+	
+		# Prep the string for decryption
+		string = string.upcase.gsub(/[^A-Z0-9]+/, '').split(//)
+		
+		# Require no less then 8 characters
+		raise Error, 'A minimum of 8 characters is required for decryption' if string.length < 8
+		
+		begin
+			# Get the indexes and index id
+			indexid = @salt.index(string.pop)
+			injections = @indexes[indexid]
+			
+			# Go ahead and locate the salts
+			saltids = [string.pop]
+			saltids << string.slice!(string.length - 1 - injections.last)
+			saltids << string.slice!(injections.first)
+			
+			# Go ahead and reverse and determine the salt ids
+			saltids = saltids.reverse.collect{|x|@salt.index(x)}
+			
+			# Get the letters cooresponding to the salts
+			salts = saltids.collect{|x|@letters[x]}
+			
+			# Go ahead and convert the alphanumeric id back into numbers
+			i=2;string=string.collect{|x|i==2?i=0:i+=1;salts[i].index(x)}.join('')
+			
+			# Return the integer
+			return string.to_i
+		rescue
+			raise Error, 'The ID provided was not decryptable'
+		end
+	end
+end
+
+# Convert Fixnum to HashId (String)
+class Fixnum
+	def to_hashid(salt = nil)
+		HashId.new(salt).encrypt(self)
+	end
+end
+
+# Convert HashId (String) to Fixnum
+class String
+	def from_hashid(salt = nil)
+		HashId.new(salt).decrypt(self)
+	end
+end
+
+# Rails 3 Extension
+if defined? ActiveRecord::Base
+	module KellyLSB
+	module HashId
+		extend ActiveSupport::Concern
+
+		module ClassMethods
+			def hashid(salt)
+				send(:include, Module.new {
+					send(:define_method, :id) do |*args|
+						_id = read_attribute(:id)
+						return _id unless _id.respond_to?(:to_hashid)
+						_id.to_hashid(salt).parameterize
+					end
+				})
+
+				send(:extend, Module.new {
+					send(:define_method, :find_by_hashid) do |hashid|
+						hashid = hashid.from_hashid(salt) if hashid.is_a?(String)
+						find(hashid)
+					end
+				})
+			end
+		end
+	end
+	end
+
+	ActiveRecord::Base.send(:include, KellyLSB::HashId)
+end

data/lib/hashid/version.rb

@@ -0,0 +1,5 @@
+module KellyLSB
+module HashId
+  VERSION = "1.0.0"
+end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: hashid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kelly Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-23 00:00:00.000000000 Z
+dependencies: []
+description: With HashId you can hide your actual page ids with on the spot randomly
+  generated hashes.
+email:
+- kellylsbkr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hashid.gemspec
+- lib/hashid.rb
+- lib/hashid/version.rb
+homepage: http://kellybecker.me
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: HashId lets you hide your databse ids with on the spot generated hashes.
+test_files: []