random_unique_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a7b92c76f522b3336630120ac9d9b882eaef76c
+  data.tar.gz: b5664b1d2c1bbb5942c5a94fbc89e66b8eb7c61d
+SHA512:
+  metadata.gz: f7ccd53a8efdbc946946a1be8180bae4b5b62c1325591a129d5b1d1a9d636d2e8e2fffc5044230edb540cd05bd7b61deae7b5fc047663b9346cc42da3cc42647
+  data.tar.gz: 5115455385496f828995823603bc4a5caa92d14e7688c65a8e28173579d1805e3836aab7d77936453b03eea96ad02377cb53e41f898493906202e2043e10de8d

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+gemfile:
+  - gemfiles/rails_3_2.Gemfile
+  - gemfiles/rails_4_0.Gemfile

data/Gemfile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "coveralls", require: false
+gem "minitest"
+gem "minitest-reporters"
+gem "mocha"
+gem "rake"
+gem "simplecov"
+gem "shoulda"
+gem "sqlite3"
+gem "activesupport", "~> 4.0.0"
+gem "activerecord", "~> 4.0.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright © 2013, Watu
+
+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,48 @@
+# Random Unique ID
+
+[![Build Status](https://travis-ci.org/watu/random_unique_id.png?branch=master)](https://travis-ci.org/watu/random_unique_id)
+[![Coverage Status](https://coveralls.io/repos/watu/random_unique_id/badge.png?branch=master)](https://coveralls.io/r/watu/random_unique_id?branch=master)
+
+This gem will generate a random unique id for your active record records that you can use instead of their actual ID for
+all external interactions with users. The goal is for you to be able to hide how many records you have, for business
+purposes, but also to make IDs non-predictable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "random_unique_id"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install random_unique_id
+
+## Usage
+
+The usage is very simple. For each record where you want to have a random id generated, add the following line to the
+class:
+
+    has_random_unique_id
+
+For example:
+
+    class Post < ActiveRecord::Base
+      has_random_unique_id
+    end
+
+You need to also add a column, called `rid` of type string/varchar. It is recommended that you also add an index on that
+column.
+
+The method to_param will be overridden to return the rid instead of the id.
+
+## 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,12 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/gemfiles/rails_3_2.Gemfile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "coveralls", require: false
+gem "minitest", "~> 2.5.1"
+gem "minitest-reporters"
+gem "mocha"
+gem "rake"
+gem "simplecov"
+gem "shoulda"
+gem "sqlite3"
+gem "activesupport", "~> 3.2.0"
+gem "activerecord", "~> 3.2.0"

data/gemfiles/rails_4_0.Gemfile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "coveralls", require: false
+gem "minitest"
+gem "minitest-reporters"
+gem "mocha"
+gem "rake"
+gem "simplecov"
+gem "shoulda"
+gem "sqlite3"
+gem "activesupport", "~> 4.0.0"
+gem "activerecord", "~> 4.0.0"

data/lib/random_unique_id/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+module RandomUniqueId
+  VERSION = "0.1.0"
+end

data/lib/random_unique_id.rb

@@ -0,0 +1,76 @@
+# encoding: UTF-8
+# Copyright © 2011, 2012, 2013, Watu
+
+require "random_unique_id/version"
+require "securerandom"
+require "active_support"
+require "active_record"
+
+module RandomUniqueId
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def has_random_unique_id
+      validates :rid, presence: true, uniqueness: true
+      before_validation :generate_random_unique_id, if: Proc.new { |r| r.rid.blank? }
+      define_method(:to_param) { rid }
+    end
+
+    def belongs_to(*attrs)
+      define_rid_method = attrs[1].try(:delete, :rid)
+      super.tap do
+        if define_rid_method != false
+          rel_name = attrs[0]
+          rel = reflections[rel_name]
+
+          return if rel.options[:polymorphic] # If we don't know the class, we cannot find the record by rid.
+
+          class_name = rel.options[:class_name] || rel_name.to_s.classify
+          klass = class_name.constantize
+
+          if klass.attribute_names.include? "rid"
+            define_method("#{rel_name}_rid") do
+              self.send(rel_name).try(:rid)
+            end
+
+            define_method("#{rel_name}_rid=") do |rid|
+              record = klass.find_by_rid(rid)
+              self.send("#{rel_name}=", record)
+              record
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def generate_random_unique_id(n=5, field="rid")
+    # Find the topmost class before ActiveRecord::Base so that when we do queries, we don't end up with type=Whatever in the where clause.
+    klass = self.class
+    self.class.ancestors.each do |k|
+      if k == ActiveRecord::Base
+        break # we reached the bottom of this barrel
+      end
+      if k.is_a? Class
+        klass = k
+      end
+    end
+
+    begin
+      self.send("#{field}=", RandomUniqueId.generate_random_id(n))
+      n += 1
+    end while klass.unscoped.where(field => self.send(field)).exists?
+  end
+
+  def self.generate_random_id(n=10)
+    # IMPORTANT: don't ever generate dashes or underscores in the RIDs as they are likely to end up in the UI in Rails
+    # and they'll be converted to something else by jquery ujs or something like that.
+    generated_rid = ""
+    while generated_rid.length < n
+      generated_rid = (generated_rid + SecureRandom.urlsafe_base64(n * 3).downcase.gsub(/[^a-z0-9]/, ""))[0..(n-1)]
+    end
+    return generated_rid
+  end
+end
+
+ActiveRecord::Base.send(:include, RandomUniqueId)

data/random_unique_id.gemspec

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "random_unique_id/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "random_unique_id"
+  spec.version       = RandomUniqueId::VERSION
+  spec.authors       = ["J. Pablo Fernández"]
+  spec.email         = ["pupeno@watuapp.com"]
+  spec.description   = %q{Generate random but unique ids for your active record records.}
+  spec.summary       = %q{Generate random but unique ids for your active record records.}
+  spec.homepage      = "https://github.com/watu/random_unique_id"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "> 3.2.0"
+  spec.add_dependency "activerecord", "> 3.2.0"
+end

data/test/random_unique_id_test.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+# Copyright © 2011, 2012, 2013, Watu
+
+require_relative "test_helper"
+
+require "random_unique_id"
+
+ActiveRecord::Schema.define(version: 0) do
+  create_table :blogs do |t|
+    t.string :rid
+  end
+  add_index :blogs, :rid, unique: true
+
+  create_table :posts do |t|
+    t.string :rid
+    t.string :type
+    t.integer :blog_id
+  end
+  add_index :posts, :rid, unique: true
+end
+
+class Blog < ActiveRecord::Base
+  has_many :posts
+  has_random_unique_id
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :blog
+  has_random_unique_id
+end
+
+class TextPost < Post
+end
+
+class ImagePost < Post
+end
+
+
+class RandomUniqueIdTest < MiniTest::Unit::TestCase
+  context "With a record with random id" do
+    setup { @text_post = TextPost.create! }
+
+    should "generate a random id" do
+      assert @text_post.rid
+    end
+
+    should "return random id as param" do
+      assert_equal @text_post.rid, @text_post.to_param
+    end
+
+    should "resolve random id collision" do
+      # Mock RandomUniqueId to return a collision on the first call, and hopefully a non collision on the second, expecting n to grow by one.
+      RandomUniqueId.expects(:generate_random_id).with(5).returns(@text_post.rid)
+      new_rid = @text_post.rid + "i"
+      RandomUniqueId.expects(:generate_random_id).with(6).returns(new_rid)
+
+      new_record = TextPost.create! # No exception should be raised.
+      assert_equal new_rid, new_record.rid
+    end
+
+    should "resolve random id collision in different classes of the same table (due to STI)" do
+      # Mock RandomUniqueId to return a collision on the first call, and hopefully a non collision on the second, expecting n to grow by one.
+      RandomUniqueId.expects(:generate_random_id).with(5).returns(@text_post.rid)
+      new_rid = @text_post.rid + "i"
+      RandomUniqueId.expects(:generate_random_id).with(6).returns(new_rid)
+
+      new_record = ImagePost.create! # No exception should be raised.
+      assert_equal new_rid, new_record.rid
+    end
+
+    should "have automatic *_rid= and *_rid methods" do
+      blog = Blog.create!
+
+      @text_post.blog_rid = blog.rid
+      @text_post.save!
+
+      assert_equal blog, @text_post.blog
+      assert_equal blog.rid, @text_post.blog_rid
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+# Copyright © 2013, Watu
+
+require "rubygems"
+
+require "simplecov"
+SimpleCov.start do
+  add_filter "/test/"
+end
+
+require "minitest/autorun"
+require "minitest/reporters"
+MiniTest::Reporters.use!
+
+# This class is here only to trick shoulda into attaching itself to MiniTest due to: https://github.com/thoughtbot/shoulda-context/issues/38
+module ActiveSupport
+  class TestCase < MiniTest::Unit::TestCase
+  end
+end
+require "shoulda"
+require "shoulda-context"
+require "shoulda-matchers"
+
+require "mocha/setup"
+
+require "active_record"
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+ActiveRecord::Base.configurations = {"sqlite3" => {adapter: "sqlite3", database: ":memory:"}}
+ActiveRecord::Base.establish_connection("sqlite3")
+
+require "coveralls"
+Coveralls.wear!
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: random_unique_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- J. Pablo Fernández
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Generate random but unique ids for your active record records.
+email:
+- pupeno@watuapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_3_2.Gemfile
+- gemfiles/rails_4_0.Gemfile
+- lib/random_unique_id.rb
+- lib/random_unique_id/version.rb
+- random_unique_id.gemspec
+- test/random_unique_id_test.rb
+- test/test_helper.rb
+homepage: https://github.com/watu/random_unique_id
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Generate random but unique ids for your active record records.
+test_files:
+- test/random_unique_id_test.rb
+- test/test_helper.rb