obscured_id 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: b844e043dfcd403fc938c32fe00a303af7cc4675
+  metadata.gz: 949561664eb81ca9dd7602998beb39fe4ea223f8
+SHA512: 
+  data.tar.gz: 56c1c9cb003de86b46b69d0149979fd11dcaa30742c2dd02fb5a977402451a5af9b00d380c59533c1001d322e1d1bb7756d81287ffd4bad8e7f0a4149d5ecdf8
+  metadata.gz: 441375951f64c52885ce37168cc8dedb2bf71a0716f17e6d607c1dfb702cf82d5cc0a425521454ddbb9304dd6636782879b59e483cf9acdc0c907ff1b2969798

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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.md

@@ -0,0 +1,109 @@
+# obscured_id
+
+This gem provides a has_ helper to populate a field with an obscured version of a model id.
+
+## Why Obscure an ID?
+
+
+## Installing
+
+1. Add to your Gemfile:
+
+        gem 'obscured_id'
+
+1. Install the gem:
+
+        bundle install
+
+1. Generate the default initializer:
+
+        rails generate obscured_id:initializer
+
+1. Generate and run a migation for the model you wish to have an obscured id:
+
+        rails generate obscured_id:migration MODEL_NAME
+        rake db:migrate
+
+1. Add the obscured_id declaration to your model:
+  			
+        has_obscured_id
+
+1. Populate your database with the obscured id:
+				
+        rake obscured_id:populate[MODEL_NAME]
+
+## Configuration
+
+The following options can be configured with a Rails initializer:
+
+- `obscured_id_secret_token`: This is the secret token used when generating the obscured id. It is strongly recommended you run the obscured_id:initializer generator to set this, otherwise the default is nil.
+- `obscured_id_field`: This is the field in which you wish to store the obscured id. Default is "obscured_id"
+- `record_obscured_ids`: If set to false, the obscured_id will not automatically be set. Default is true.
+
+## Usage
+
+### Generators
+
+#### obscured_id:initializer
+
+This creates an initializer with a random secret key for obscuring the model's id. While it is possible to run this plugin without a secret key, it's not recommended.
+
+####  obscured_id:migration MODEL_NAME (--field=FIELD_NAME)
+
+This creates a migration for a model with the name. The field option lets you override the default field name "obscured_id". If you override the field name, be sure to set the field option in your configuration or `has_obscured_id` declaration.
+
+### Rake Tasks
+
+#### rake obscured_id:populate[MODEL_NAME]
+
+This will populate a model with an obscured id without recording timestamps. NOTE: that this will populate your model's obscured ID field regardless of your record_obscured_ids configuration or auto option in the `has_obscured_id` declaration.
+
+### Has Declaration
+
+When added to your model definition, `has_obscured_id` declaration configures your model to be obscure id capable, adding the methods described below.
+
+The following options are available:
+
+- `field`: This overides `obscured_id_field`.
+- `secret_token`: This overides `obscured_id_secret_token`.
+- `auto`: If set to false, the obscured_id will not automatically be set.
+
+#### Examples
+
+```ruby
+class ThingWithObscuredId < ActiveRecord::Base
+  has_obscured_id
+end
+
+class ThingWithConfiguredObscuredId < ActiveRecord::Base
+  has_obscured_id :field => :hidden_id, :secret_token => "ee71c598567e9d469738b7ec64213b8c", :auto => false
+end
+```
+
+#### Instance Methods
+
+- `set_obscured_id`: Force sets the instance's obscured ID.
+- `safe_set_obscured_id`: Sets an instance's obscured ID only if updating is turned on.
+
+#### Class Methods
+
+- `set_obscured_ids`: Force populates obscured ids for all records. Returns an array of integers, where the first is the count of succesful updates, and the second is the count of failed updates.
+
+## Notes
+
+You can turn updating off:
+
+        ActiveRecord::Base.record_obscured_ids = false
+
+And turn it back on:
+
+        ActiveRecord::Base.record_obscured_ids = true
+
+## Running Tests
+
+    $ bundle install
+    $ rspec spec
+
+## Credits
+
+Copyright (c) 2013 Larry Halff, released under the MIT license

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'ObscuredId'
+  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/generators/obscured_id/initializer_generator.rb

@@ -0,0 +1,10 @@
+module ObscuredId
+	module Generators
+		class InitializerGenerator < Rails::Generators::Base
+			desc "This generates an initializer file at config/initializers/obscured_d.rb which configures the obscured_id plugin with a random 32 character secret key."
+		  def create_initializer_file
+		    create_file  "config/initializers/obscured_id.rb", "#{Rails.application.class.parent_name}::Application.config.obscured_id_token = '#{SecureRandom.hex(32)}'"
+			end
+		end
+	end
+end

data/lib/generators/obscured_id/migration_generator.rb

@@ -0,0 +1,22 @@
+module ObscuredId
+	module Generators
+		class MigrationGenerator < Rails::Generators::Base
+			argument :table, :type => :string, :default => "", :banner => "NAME"
+			class_option :field, :type => :string, :default => "obscured_id", :banner => "FIELD_NAME"
+
+			desc "This generates a migration to add the obscured id field to a table. NAME is the table or model name. " +
+					 "The field option allows you to specify a custom field name for the obscured id. If you use a custom field name "+
+					 "be sure to specify this in your has_obscured_id declaration."
+
+		  def create_initializer_file
+		  	raise ArgumentError, "No model or table name specified." if table.empty?
+		  	Rails::Generators.invoke("migration", ["add_#{options.field}_to_#{table.classify}", "#{options.field}:string:index"])
+			end
+		end
+	end
+end
+
+
+
+
+     

data/lib/obscured_id/obscured_id.rb

@@ -0,0 +1,63 @@
+module ObscuredId
+  module HasObscuredId
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :obscured_id_secret_token, :obscured_id_field, :record_obscured_ids
+    end
+
+    # Specify this +has+ extension if you want to model a to have an obscured id. This requires a key 
+    # column for the obscured id, which is <tt>obscured_id</tt> by default.
+    module ClassMethods
+
+      # Configuration options are:
+      #
+      # * <tt>field</tt> - specifies the column name to use for the obscured id. Default is +obscured_id+.
+      # * <tt>secret_token</tt> - salt for the SHA1 digest. Default is +obscured_id_secret_token+ configuration option.
+      # * <tt>auto</tt> - Automatically update record with obscured id after save. Default it true.
+      def has_obscured_id(options = {})
+        self.obscured_id_secret_token = options[:secret_token] || ActiveRecord::Base.obscured_id_secret_token
+        self.obscured_id_field = options[:field] || ActiveRecord::Base.obscured_id_field
+        self.record_obscured_ids = options.has_key?(:auto) ? options[:auto] : true
+        
+        # Define the instance method set an obscured id for this model
+        define_method :set_obscured_id do
+          update_column( self.obscured_id_field, 
+                         OpenSSL::HMAC.hexdigest( OpenSSL::Digest.const_get(:SHA1).new, 
+                                                  self.obscured_id_secret_token.to_s, 
+                                                  "#{id}#{created_at.to_i}" ) ) 
+        end
+
+        define_method :safe_set_obscured_id do
+          set_obscured_id if ActiveRecord::Base.record_obscured_ids && self.record_obscured_ids
+        end
+
+        # Call set_obscured_id after create.
+        after_create :safe_set_obscured_id
+
+        # Reset all obscured ids
+        def self.set_obscured_ids
+          success = 0
+          fail = 0
+
+          begin
+            self.find_each do |record|
+              begin
+                record.set_obscured_id
+                success += 1
+              rescue
+                fail += 1
+              end
+            end
+          rescue
+            false
+          end
+
+          [success, fail]
+        end # set_obscure_ids
+
+      end # has_obscure_id
+
+    end # ClassMethods
+  end # HasObscuredId
+end # ObscuredId

data/lib/obscured_id/railtie.rb

@@ -0,0 +1,26 @@
+module ObscuredId
+  class Railtie < Rails::Railtie
+    railtie_name :obscured_id
+    
+    initializer "obscured_id" do
+      ActiveRecord::Base.send :include, ObscuredId::HasObscuredId
+      set_defaults_from_configuration
+    end
+
+    def set_defaults_from_configuration
+      ActiveRecord::Base.obscured_id_secret_token = (Rails.configuration.respond_to?(:obscured_id_secret_token) ? Rails.configuration.obscured_id_secret_token : nil)
+      ActiveRecord::Base.obscured_id_field = (Rails.configuration.respond_to?(:obscured_id_field) ? Rails.configuration.obscured_id_field : :obscured_id)
+      ActiveRecord::Base.record_obscured_ids = (Rails.configuration.respond_to?(:record_obscured_ids) ? Rails.configuration.record_obscured_ids : true)
+    end
+
+    rake_tasks do
+      load "tasks/obscured_id.rake"
+    end
+
+    generators do
+      require 'generators/obscured_id/initializer_generator.rb'
+      require 'generators/obscured_id/migration_generator.rb'
+    end
+
+  end
+end

data/lib/obscured_id/version.rb

@@ -0,0 +1,3 @@
+module ObscuredId
+  VERSION = "0.1.1"
+end

data/lib/obscured_id.rb

@@ -0,0 +1,5 @@
+require 'obscured_id/obscured_id'
+require 'obscured_id/railtie' if defined?(Rails)
+
+module ObscuredId
+end

data/lib/tasks/obscured_id.rake

@@ -0,0 +1,18 @@
+# desc "Explaining what the task does"
+namespace :obscured_id do
+	desc "Update table with obscured ids"
+  task :populate, [:class_name] => :environment do |t, args|
+  	klass = args[:class_name].classify.constantize
+  	
+  	if klass.respond_to?(:set_obscured_ids)
+	  	ActiveRecord::Base.record_timestamps = false
+	  	success, fail = klass.set_obscured_ids
+	  	ActiveRecord::Base.record_timestamps = true
+	  	puts "#{success} #{'record'.pluralize(success)} succesfully updated. #{fail} #{'updates'.pluralize(fail)} failed."
+	  else
+	  	puts "#{klass.name} does not appear to be has_obscured_id capable.\n\n"
+    end
+
+    STDOUT.flush
+  end
+end

data/spec/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in obscured_id.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+# gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'ruby-debug'

data/spec/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    obscured_id (0.0.1)
+      rails (~> 3.2.13)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    hike (1.2.2)
+    i18n (0.6.1)
+    journey (1.0.4)
+    jquery-rails (2.2.1)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.7.7)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    multi_json (1.7.3)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rspec-rails (2.13.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thor (0.18.1)
+    tilt (1.4.0)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jquery-rails
+  obscured_id!
+  rspec-rails
+  sqlite3

data/spec/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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/spec/README.md

@@ -0,0 +1,2 @@
+obscured_id
+===========

data/spec/README.rdoc

@@ -0,0 +1,3 @@
+= ObscuredId
+
+This project rocks and uses MIT-LICENSE.

data/spec/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'ObscuredId'
+  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