masked-identifier 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.txt

@@ -0,0 +1,53 @@
+= MaskedIdentifier
+#
+# MASKED IDENTIFIER DOCUMENTATION
+# ===============================
+#
+# Automatically adds a masked identifier to an ActiveRecord object on create.  Default assumes the
+# ActiveRecord object contains a property called 'masked_identifier', which should be added to your
+# database migration.  Don't forget to add an index on this column!
+#
+# Usage:
+# class User < ActiveRecord::Base
+#   has_masked_identifier
+# end
+#
+# Or, with optional settings:
+# class User < ActiveRecord::Base
+#   has_masked_identifier property: 'mid', attempts: 10, length: 8, charset: %w{ a b c d e }
+# end
+#
+# Optional (options hash):
+# property: override default property name with a custom name (default is 'masked_identifier')
+# attempts: number of attempts to try to find a unique code (default is 20)
+# length: number of characters to include in masked identifier code (default is 10)
+# charset: character set to use when generating codes (default includes a-z, A-Z, and 0-9)
+#
+# Possible Errors:
+# [YourActiveRecordObject]::InvalidProperty if property does not exist
+# See CodeGenerator for additional errors
+#
+#
+# CODE GENERATOR DOCUMENTATION
+# ============================
+#
+# Generates a unique code based on a property of an ActiveRecord object
+#
+# Usage:
+# code = CodeGenerator.unique_code(klass, property, options = {})
+#
+# Required parameters:
+# klass = the ActiveRecord object
+# property = the name of the property to check for uniqueness
+#
+# Optional (options hash):
+# length: number of characters to include in code (default = 10)
+# charset: character set to use when generating codes (default = a-zA-Z0-9)
+# attempts: number of attempts to find a unique code (default = 20)
+#
+# Possible Errors:
+# CodeGenerator::TooManyFailedAttempts if unable to find a unique code
+# CodeGenerator::InvalidAttemptsValue if value provided is not an Integer or < 1
+# CodeGenerator::InvalidCodeLength if value provided is not an Integer or < 1
+# CodeGenerator::InvalidCharset if value provided is not an Array with size >= 1
+#

data/Rakefile

@@ -0,0 +1,37 @@
+#!/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    = 'MaskedIdentifier'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_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/code-generator.rb

@@ -0,0 +1,51 @@
+# Generates a unique code based on a property of an ActiveRecord object
+#
+# Usage:
+# code = CodeGenerator.unique_code(klass, property, options = {})
+#
+# Required parameters:
+# klass = the ActiveRecord object
+# property = the name of the property to check for uniqueness
+#
+# Optional (options hash):
+# length: number of characters to include in code (default = 10)
+# charset: character set to use when generating codes (default = a-zA-Z0-9)
+# attempts: number of attempts to find a unique code (default = 20)
+#
+# Possible Errors:
+# CodeGenerator::TooManyFailedAttempts if unable to find a unique code
+# CodeGenerator::InvalidAttemptsValue if value provided is not an Integer or < 1
+# CodeGenerator::InvalidCodeLength if value provided is not an Integer or < 1
+# CodeGenerator::InvalidCharset if value provided is not an Array with size >= 1
+#
+class CodeGenerator
+  def self.unique_code(klass, property, options = {})
+    attempts = options[:attempts] || 20
+    raise InvalidAttemptsValue, 'Attempts value must be an integer >= 1' if !attempts.is_a?(Integer) || attempts <= 0
+
+    begin
+      i ||= 0; i += 1
+      raise TooManyFailedAttempts, 'Failed to find a unique code' if i > attempts
+      code = self.random_code length: options[:length], charset: options[:charset]
+    end until self.code_is_unique? klass, property, code
+    return code
+  end
+
+  private
+  def self.code_is_unique?(klass, property, code)
+    true if klass.class.send('find_by_' + property, code).nil?
+  end
+
+  def self.random_code(options = {})
+    length = options[:length] || 10
+    raise InvalidCodeLength, 'Code length must be an integer >= 1' if !length.is_a?(Integer) || length <= 0
+    charset = options[:charset] || %w{ 0 1 2 3 4 5 6 7 8 9 a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H J K L M N O P Q R T U V W X Y Z }
+    raise InvalidCharset, 'Charset must be an array with 1 or more values' if !charset.is_a?(Array) || charset.length < 1
+    (0...length).map { charset.to_a[rand(charset.size)] }.join
+  end
+
+  class TooManyFailedAttempts < StandardError; end
+  class InvalidAttemptsValue < ArgumentError; end
+  class InvalidCodeLength < ArgumentError; end
+  class InvalidCharset < ArgumentError; end
+end

data/lib/masked-identifier.rb

@@ -0,0 +1,56 @@
+# Automatically adds a masked identifier to an ActiveRecord object on create.  Default assumes the
+# ActiveRecord object contains a property called 'masked_identifier', which should be added to your
+# database migration.  Don't forget to add an index on this column!
+#
+# Usage:
+# class User < ActiveRecord::Base
+#   has_masked_identifier
+# end
+#
+# Or, with optional settings:
+# class User < ActiveRecord::Base
+#   has_masked_identifier property: 'mid', attempts: 10, length: 8, charset: %w{ a b c d e }
+# end
+#
+# Optional (options hash):
+# property: override default property name with a custom name (default is 'masked_identifier')
+# attempts: number of attempts to try to find a unique code (default is 20)
+# length: number of characters to include in masked identifier code (default is 10)
+# charset: character set to use when generating codes (default includes a-z, A-Z, and 0-9)
+#
+# Possible Errors:
+# [YourActiveRecordObject]::InvalidProperty if property does not exist
+# See CodeGenerator for additional errors
+#
+require 'code-generator'
+
+module MaskedIdentifier
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    attr_accessor :_masked_identifier_options
+
+    def has_masked_identifier(options = {})
+      options[:property] ||= 'masked_identifier'
+      self._masked_identifier_options = options
+      before_save :add_masked_identifier, on: :create
+      send :include, InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+    private
+    def add_masked_identifier
+      options = self.class._masked_identifier_options
+      property = options[:property]
+      raise InvalidProperty, "'#{self.to_s}' does not respond to '#{property}'" unless self.respond_to?(property)
+      self[property.to_sym] = CodeGenerator.unique_code(self, property, options)
+    end
+
+    class InvalidProperty < ArgumentError; end
+  end
+end
+
+ActiveRecord::Base.send(:include, MaskedIdentifier)

data/lib/tasks/masked-identifier_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :masked-identifier do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "masked-identifier"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,27 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,51 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Specifies the header that your server uses for sending files
+  # (comment out if your front-end server doesn't support this)
+  config.action_dispatch.x_sendfile_header = "X-Sendfile" # Use 'X-Accel-Redirect' for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end