public_uid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 032aafb0e5f3992c4ea4197a2eb9e78585d60eee
+  data.tar.gz: d39558dc338f02cd9355fc618660f4cfcd70c57a
+SHA512:
+  metadata.gz: 42e863949ee643c5d3b88315b7d7cac6a1d93b870c00f79f47be4a78300d7a8b2ffd45046525bad14bd50433d3cb5ccc6fd743b98ca206b5c974f7c4210af380
+  data.tar.gz: 72cb950c7a4b950fa1c6cb7ff070cdecbd5b34e855dceafc1b41a91094efad682db57b3fb63d87002fc75e8bdf612a60b1adca9bda2c0673f9603644de17d79f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tomas Valent
+
+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,144 @@
+# PublicUid
+
+Generates random string (or random number) to represent public unique
+record identifier.
+
+### `public_uid` vs `record.id`
+
+Let say you're building social network or business dashboard.
+
+If you publicly display your *record ids* as an unique identificator for
+accessing your records (as a part of HTML url or in JSON) it's easy to
+ estimate how many records (users, clients, messages, orders,...) you have
+in the database. Marketing of rival companies may use this information
+against you.
+
+This is bad: 
+
+    http://eq8.eu/orders/12/edit
+    http://eq8.eu/orders/12-order-for-mouse-and-keyboard/edit
+
+However if you generate random unique identifier and use that as a public
+identifier, you won't have to worry about that.
+
+This is how it should be: 
+
+    http://eq8.eu/orders/8395820/edit
+    http://eq8.eu/orders/abaoeule/edit
+    http://eq8.eu/orders/aZc3/edit
+
+So keep `record.id` for your internal relationships and show `public_id`
+to the world :smile:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'public_uid'
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Create database column for public unique id
+
+```ruby
+class AddPublicUidToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :public_uid, :string
+  end
+end
+```
+
+Tell your model to generate the public identifier
+
+```ruby
+class User < ActiveRecord::Base
+  generate_public_uid
+end
+```
+
+This will automatically generate 7 digit random unique number for 
+column `public_uid`. 
+
+
+```irb
+u = User.new
+u.public_uid  #=> nil
+u.save!       #=> true
+u.public_uid  #=> 9392049
+```
+
+If you want to use different column just specify column option:
+
+```ruby
+class User < ActiveRecord::Base
+  generate_public_uid column: :guid
+end
+```
+
+```irb
+u = User.new
+u.guid  #=> nil
+u.save! #=> true
+u.guid  #=> 8392049
+```
+
+If you want to generate random string you can use built-in string
+generator:
+
+```ruby
+class User < ActiveRecord::Base
+  generate_public_uid generator: PublicUid::Generators::RangeString.new
+end
+```
+
+```irb
+u = User.new
+u.public_uid  #=> nil
+u.save!       #=> true
+u.public_uid  #=> "azuberdc"
+```
+
+### Customizing generated string
+
+```ruby
+class User < ActiveRecord::Base
+  UID_RANGE = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+  generate_public_uid generator: PublicUid::Generators::RangeString.new(4, UID_RANGE)
+end
+```
+
+```irb
+u = User.new
+u.public_uid  #=> nil
+u.save!       #=> true
+u.public_uid  #=> "aZ3e"
+```
+
+### Customizing randomized number 
+
+```ruby
+class User < ActiveRecord::Base
+  UID_RANGE = 1_000..4_000
+  generate_public_uid generator: PublicUid::Generators::NumberRandom.new(UID_RANGE)
+end
+```
+
+```irb
+u = User.new
+u.public_uid  #=> nil
+u.save!       #=> true
+u.public_uid  #=> 2398
+```
+
+## 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,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/public_uid.rb

@@ -0,0 +1,29 @@
+require "public_uid/version"
+require "public_uid/set_public_uid"
+require "public_uid/generators/number_random"
+require "public_uid/generators/range_string"
+
+module PublicUid
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def generate_uid
+    pub_uid = SetPublicUid.new(record: self, column: self.class.public_uid_column)
+    pub_uid.generate self.class.public_uid_generator
+    pub_uid.set
+  end
+
+  module ClassMethods
+    attr_reader :public_uid_column
+    attr_reader :public_uid_generator
+
+    def generate_public_uid(options={})
+      @public_uid_column    = options[:column]    || :public_uid
+      @public_uid_generator = options[:generator] || Generators::NumberRandom.new
+      before_create :generate_uid, unless: @public_uid_column
+    end
+  end
+
+end

data/lib/public_uid/generators/number_random.rb

@@ -0,0 +1,13 @@
+module PublicUid
+  module Generators
+    class NumberRandom
+      def initialize(scale = 1_000_000..9_999_999)
+        @scale = scale
+      end
+
+      def generate(randomizer = Random.new())
+        randomizer.rand(@scale)
+      end
+    end
+  end
+end

data/lib/public_uid/generators/range_string.rb

@@ -0,0 +1,14 @@
+module PublicUid
+  module Generators
+    class RangeString
+      def initialize(length=8, scale='a'..'z')
+        @scale  = scale
+        @length = length
+      end
+
+      def generate
+        @scale.to_a.shuffle[0,@length].join
+      end
+    end
+  end
+end

data/lib/public_uid/set_public_uid.rb

@@ -0,0 +1,37 @@
+module PublicUid
+  class SetPublicUid
+    attr_reader :new_uid
+
+    def initialize(options)
+      @record  = options[:record] || raise(NoRecordSpecified)
+      @column  = options[:column] || raise(NoPublicUidColumnSpecified)
+      @klass   = @record.class
+      @new_uid = nil
+      check_column_existance
+    end
+
+    def generate(generator)
+      begin
+        @new_uid= generator.generate
+      end while similar_uid_exist?
+    end
+
+    def set
+      @record.send("#{@column}=", @new_uid || raise(NewUidNotSetYet))
+    end
+    private
+
+    def similar_uid_exist?
+      @klass.where(public_uid: @new_uid).count > 0
+    end
+
+    def check_column_existance
+      raise PublicUidColumnDoesNotExist if @klass.column_names.include?(@column)
+    end
+
+    class NewUidNotSetYet < StandardError; end
+    class PublicUidColumnDoesNotExist < StandardError; end
+    class NoPublicUidColumnSpecified  < StandardError; end
+    class NoRecordSpecified           < StandardError; end
+  end
+end

data/lib/public_uid/version.rb

@@ -0,0 +1,3 @@
+module PublicUid
+  VERSION = "1.0.0"
+end

data/public_uid.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'public_uid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "public_uid"
+  spec.version       = PublicUid::VERSION
+  spec.authors       = ["Tomas Valent"]
+  spec.email         = ["equivalent@eq8.eu"]
+  spec.description   = %q{Automatic generates public unique identifier for model}
+  spec.summary       = %q{Automatic generates public UID column}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "activerecord", "~> 3.2"
+  spec.add_development_dependency "minitest", "~> 5"
+  spec.add_development_dependency "sqlite3"
+end

data/test/lib/generators/number_random_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+
+describe 'NumberRandom' do
+
+  describe "#generate" do
+    subject{ instance.generate }
+
+    context 'by default' do
+      let(:instance){ PublicUid::Generators::NumberRandom.new }
+      it 'generates 7 digits' do
+        subject.to_i.to_s.length.must_equal 7
+        subject.must_be_kind_of Integer
+      end
+    end
+
+    context 'when specifying number between 20 - 21' do
+      let(:instance){ PublicUid::Generators::NumberRandom.new(20..21) }
+      it 'generates 2 digits' do
+        subject.to_i.to_s.length.must_equal 2
+        subject.must_be_kind_of Integer
+      end
+
+      it 'generates string containing chars x,y,z' do
+        [20, 21].must_include subject
+      end
+    end
+  end
+end

data/test/lib/generators/range_string_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+describe 'RangeString' do
+
+  describe "#generate" do
+    subject{ instance.generate }
+
+    context 'by default' do
+      let(:instance){ PublicUid::Generators::RangeString.new }
+      it 'generates 8 chars string' do
+        subject.length.must_equal 8
+        subject.must_be_kind_of String
+      end
+
+      it 'generates downcase chars' do
+        subject.must_match(/^[a-z]*$/)
+      end
+    end
+
+    context 'when 10 chars x-y' do
+      let(:instance){ PublicUid::Generators::RangeString.new(3, ('x'..'z')) }
+      it 'generates 10 chars string' do
+        subject.length.must_equal 3
+      end
+
+      it 'generates string containing chars x,y,z' do
+        subject.must_match(/^[x-z]*$/)
+      end
+    end
+  end
+end

data/test/lib/set_public_uid_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class User < ActiveRecord::Base
+  self.table_name = 'users'
+end
+
+class DummyGenerator
+  def initialize
+    @counter = 0
+  end
+
+  def generate
+    if @counter > 1
+      'second try'
+    else
+      'first try'
+    end.tap { @counter = @counter + 1 }
+  end
+end
+
+describe 'PublicUid::SetPublicUid' do
+  let(:options) { {record: record, column: :public_uid} }
+  let(:instance){ PublicUid::SetPublicUid.new options }
+
+  let(:record){ User.new }
+
+  describe 'initialization' do
+    context 'when column not specified' do
+      let(:options) { {record: record} }
+      it{ ->{ instance }.must_raise(PublicUid::SetPublicUid::NoPublicUidColumnSpecified) }
+    end
+
+    context 'when record not specified' do
+      let(:options) { {column: :foo} }
+      it{ ->{ instance }.must_raise(PublicUid::SetPublicUid::NoRecordSpecified) }
+    end
+  end
+
+  describe "#generate" do
+    subject{ instance.new_uid }
+
+    it "should ask generator to generate random string" do
+      instance.generate(DummyGenerator.new)
+      subject.must_equal 'first try'
+    end
+
+    context 'when record match random' do
+      before{ User.create public_uid: 'first try' }
+      after { User.destroy_all }
+
+      it "should generate string once again" do
+        instance.generate(DummyGenerator.new)
+        subject.must_equal 'second try'
+      end
+    end
+  end
+
+  describe '#set' do
+    subject{ instance.new_uid }
+
+    context 'when @new id is not set' do
+      it{ ->{ instance.set }.must_raise(PublicUid::SetPublicUid::NewUidNotSetYet) }
+    end
+
+    context 'when @new id is set' do
+      before{ instance.instance_variable_set '@new_uid', '123' }
+
+      it 'must set new_uid for record pubilc_uid column' do
+        instance.set
+        subject.must_equal '123'
+      end
+    end
+  end
+
+end

data/test/models/custom_public_uid_column_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class CustomPublicUidColumnModel < ActiveRecord::Base
+  self.table_name = "users"
+  include PublicUid
+  generate_public_uid column: :custom_uid
+end
+
+describe 'CustomPublicUidColumnModel' do
+  let(:user){CustomPublicUidColumnModel.new}
+
+  describe '#custom_uid' do
+    subject{ user.custom_uid }
+
+    context 'in new record' do
+      it{ subject.must_be_nil }
+    end
+
+    context 'after save' do
+      before do
+        user.save
+        user.reload
+      end
+      it{ subject.wont_be_nil }
+      it 'by default should generate 7 digit number string' do
+        subject.to_i.to_s.length.must_equal(7)
+      end
+    end
+  end
+end

data/test/models/model_with_custom_generator_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class ModelWithCustomGererator < ActiveRecord::Base
+  self.table_name = "users"
+  include PublicUid
+
+  gener_range = ('a'..'z').to_a+('A'..'Z').to_a
+
+  generate_public_uid generator: PublicUid::Generators::RangeString.
+                                   new(10, gener_range)
+end
+
+describe 'ModelWithCustomGererator' do
+  let(:user){ModelWithCustomGererator.new}
+
+  describe '#public_uid' do
+    subject{ user.public_uid }
+
+    context 'in new record' do
+      it{ subject.must_be_nil }
+    end
+
+    context 'after save' do
+      before do
+        user.save
+        user.reload
+      end
+
+      it 'should generate 10 chars' do
+        subject.must_be_kind_of String
+        subject.length.must_equal(10)
+      end
+
+      it 'string including up & down case' do
+        subject.must_match(/^[a-zA-Z]+$/)
+      end
+
+    end
+  end
+end

data/test/models/model_with_generator_defaults_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+class ModelWithGeneratorDefaults < ActiveRecord::Base
+  self.table_name =  "users"
+  include PublicUid
+  generate_public_uid
+end
+
+describe 'ModelWithGeneratorDefaults' do
+  let(:user){ModelWithGeneratorDefaults.new}
+
+  describe '#public_uid' do
+    subject{ user.public_uid }
+
+    context 'in new record' do
+      it{ subject.must_be_nil }
+    end
+
+    context 'after save' do
+      before do
+        user.save
+        user.reload
+      end
+      it{ subject.wont_be_nil }
+      it 'by default should generate 7 digit number string' do
+        subject.to_i.to_s.length.must_equal(7)
+      end
+    end
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+require 'public_uid'
+require 'minitest/autorun'
+require 'active_record'
+
+class Minitest::Spec
+  class << self
+    alias :context :describe
+  end
+end
+
+ActiveRecord::Base::establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.connection.execute(%{CREATE TABLE users  (id INTEGER PRIMARY KEY, public_uid VARCHAR, custom_uid INTEGER);})
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: public_uid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tomas Valent
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5'
+- !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'
+description: Automatic generates public unique identifier for model
+email:
+- equivalent@eq8.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/public_uid.rb
+- lib/public_uid/generators/number_random.rb
+- lib/public_uid/generators/range_string.rb
+- lib/public_uid/set_public_uid.rb
+- lib/public_uid/version.rb
+- public_uid.gemspec
+- test/lib/generators/number_random_test.rb
+- test/lib/generators/range_string_test.rb
+- test/lib/set_public_uid_test.rb
+- test/models/custom_public_uid_column_test.rb
+- test/models/model_with_custom_generator_test.rb
+- test/models/model_with_generator_defaults_test.rb
+- test/test_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Automatic generates public UID column
+test_files:
+- test/lib/generators/number_random_test.rb
+- test/lib/generators/range_string_test.rb
+- test/lib/set_public_uid_test.rb
+- test/models/custom_public_uid_column_test.rb
+- test/models/model_with_custom_generator_test.rb
+- test/models/model_with_generator_defaults_test.rb
+- test/test_helper.rb