shixian-obfuscate_id 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15717dfa4ebf50eb21ef397773901bcbd9c5e74fabe86310c91228608b4b488e
+  data.tar.gz: 5f63523142b284c2526e649fbe38d5188f02042657711d33d44d0ad4ee05597a
+SHA512:
+  metadata.gz: 2bb8d1b5f753e780314d858d6c44e4d94563929d98af8b81066e322a790f49cd3871a00fc452ef68b490e34d27cbcdd3e74c34b9908f8bda46e173e4ee0e597e
+  data.tar.gz: 3323ef77de6b948c028317e2d9c8c0e6e5a20452444ee0aac086e16224c9d3d9ee9ff7cf71765f1ff974da50f6fce5d59f81a1b84911e64a8e5169092b97f31f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Nathan Amick
+
+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,112 @@
+# 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)
+
+**Make your ActiveRecord ids non-obvious**
+
+![cat with sunglasses](http://i.imgur.com/kYOtUll.jpg)
+
+
+obfuscate_id turns a URL like this:
+
+    http://example.com/users/3
+
+into something like:
+
+    http://example.com/users/2356513904
+
+Sequential ActiveRecord ids become non-sequential, random looking, numeric ids.
+
+    # post 7000
+    http://example.com/posts/5270192353
+    # post 7001
+    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
+
+* Extremely 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 database changes or migrations are needed.  The record is still stored in the database with its original id.
+* Fast, no heavy calculation.
+
+
+## Installation
+
+Add the gem to your Gemfile.
+
+    gem "obfuscate_id"
+
+Run bundler.
+
+    bundle install
+
+## Usage
+
+In your model, add a single line.
+
+    class Post < ActiveRecord::Base
+      obfuscate_id
+    end
+
+## Customization
+
+If you want your obfuscated ids to be different than some other website using the same plugin, you can throw a random number (spin) at obfuscate_id to make it hash out unique ids for your app.
+
+    class Post < ActiveRecord::Base
+      obfuscate_id :spin => 89238723
+    end
+
+## How it works
+
+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.
+
+Plain record ids are switched to the obfuscated id in the model's `to_param` method.
+
+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.  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)`.
+
+## Versions
+
+This is tested with Rails 4.2.0.  For other versions of Rails, please see [the releases](https://github.com/namick/obfuscate_id/releases).
+
+If you are trying to get it to work with a different version of rails that is not tested, let me know in [the issues](https://github.com/namick/obfuscate_id/issues)
+
+## 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
+
+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/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ObfuscateId'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/obfuscate_id/version.rb

@@ -0,0 +1,3 @@
+module ObfuscateId
+  VERSION = "0.2.0"
+end

data/lib/obfuscate_id.rb

@@ -0,0 +1,85 @@
+module ObfuscateId
+  def obfuscate_id(options = {})
+    require 'scatter_swap'
+
+    extend ClassMethods
+    include InstanceMethods
+    cattr_accessor :obfuscate_id_spin
+    self.obfuscate_id_spin = (options[:spin] || obfuscate_id_default_spin)
+  end
+
+  def self.hide(id, spin)
+    ScatterSwap.hash(id, spin)
+  end
+
+  def self.show(id, spin)
+    ScatterSwap.reverse_hash(id, spin)
+  end
+
+  module ClassMethods
+    def find(*args)
+      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(scope)
+    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
+    def obfuscate_id_default_spin
+      alphabet = Array("a".."z")
+      number = name.split("").collect do |char|
+        alphabet.index(char)
+      end
+
+      number.shift(12).join.to_i
+    end
+  end
+
+  module InstanceMethods
+    def to_param
+      ObfuscateId.hide(self.id, self.class.obfuscate_id_spin)
+    end
+
+    # Override ActiveRecord::Persistence#reload
+    # passing in an options flag with { no_obfuscated_id: true }
+    def reload(options = nil)
+      options = (options || {}).merge(no_obfuscated_id: true)
+
+      clear_aggregation_cache
+      clear_association_cache
+
+      fresh_object =
+        if options && options[:lock]
+          self.class.unscoped { self.class.lock(options[:lock]).find(id, options) }
+        else
+          self.class.unscoped { self.class.find(id, options) }
+        end
+
+      @attributes = fresh_object.instance_variable_get('@attributes')
+      @new_record = false
+      self
+    end
+
+    def deobfuscate_id(obfuscated_id)
+      self.class.deobfuscate_id(obfuscated_id)
+    end
+  end
+end
+
+ActiveRecord::Base.extend ObfuscateId

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: shixian-obfuscate_id
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nathan Amick
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scatter_swap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make your ActiveRecord IDs non-obvious
+email:
+- github@nathanamick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/obfuscate_id.rb
+- lib/obfuscate_id/version.rb
+homepage: https://github.com/shixiancom/obfuscate_id
+licenses:
+- MIT
+- GPL-2
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Mask ActiveRecord IDs
+test_files: []