url_encrypt 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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/Manifest

@@ -0,0 +1,12 @@
+MIT-LICENSE
+Manifest
+README
+Rakefile
+init.rb
+install.rb
+lib/url_encrypt.rb
+tasks/url_encrypt_tasks.rake
+test/test_helper.rb
+test/url_encrypt_test.rb
+uninstall.rb
+url_encrypt.gemspec

data/README

@@ -0,0 +1,35 @@
+UrlEncrypt
+=================================================================================================================
+
+This plugin provides the ability to encrypt a column of the database table which you can safely expose in the URL.
+Provides handy method to make DB calls (Rails way of calling ya know !)
+
+After Installation you can put the encryptor key in your environment.rb file:
+
+UrlEncrypt.encryptors("abcdefghijklmnop", "mnbkjhkhkhkhkhkjhkjh") -> so that KEY and IV for Cipher encryption are different
+
+OR
+
+UrlEncrypt.encryptors("abcdefghijklmnop") -> so that KEY and IV for Cipher encryption are same
+
+OR 
+
+NOTHING -> so that plugin takes care of hanving its own
+
+
+Example
+=======
+class Book < ActiveRecord::Base
+  column :id, :integer
+  column :title, :string
+  
+  encrypted :with => :title
+end
+
+Ypu have handy methods:
+
+Book.find_by_encrypted_title('encrypted string')
+
+Book.find_by_encrypted_title('encrypted string', :conditions => ["any other condition can go here"])
+
+Copyright (c) 2008 (Amit Kumar), released under the MIT license

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rubygems'
+require 'echoe'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the url_encrypt plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the url_encrypt plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UrlEncrypt'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Echoe.new('url_encrypt', '0.1.0') do |p|
+  p.description     = "Encrypt your URLs"
+  p.url             = "http://github.com/toamitkumar/url_encrypt"
+  p.author          = "Amit Kumar"
+  p.email           = "toamitkumar@gmail.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1,4 @@
+require 'url_encrypt'
+require 'activerecord'
+
+ActiveRecord::Base.send(:include, UrlEncrypt)

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/url_encrypt.rb

@@ -0,0 +1,111 @@
+require 'openssl'
+require 'uri'
+require 'base64'
+require 'rubygems'
+require 'activerecord'
+
+module UrlEncrypt
+  def self.cipher
+    @@cipher ||= OpenSSL::Cipher::Cipher.new('RC2')
+  end
+  
+  def self.encryptors key, iv=nil
+    @@key ||= key
+    @@iv ||= (iv || key)
+  end
+  
+  def self.key
+    @@key ||= "abcdefghijklmnop"
+  end
+  
+  def self.iv
+    @@iv ||= @@key
+  end
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    def self.extended(base)
+      class << base
+        self.instance_eval do
+          attr_accessor :encryptable_attribute
+        end
+      end
+    end
+
+    def encrypted(options={})
+      self.encryptable_attribute = options[:with].to_s if options[:with]
+      include InstanceMethods
+    end
+  end
+  
+  module InstanceMethods
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  	
+    def _encrypted_attribute
+      @_encrypted_attribute ||= self.encrypt(self.send(self.class.encryptable_attribute))
+    end
+
+    def _encrypted_attribute= (encrypted_attribute)
+      @_encrypted_attribute = encrypted_attribute
+    end
+
+    def to_param
+      self.class.encryptable_attribute ? self._encrypted_attribute : id.to_s
+    end
+
+    def encrypt(attribute_val)
+      UrlEncrypt.cipher.encrypt
+      UrlEncrypt.cipher.key, UrlEncrypt.cipher.iv = UrlEncrypt.key, UrlEncrypt.iv
+      URI.encode((UrlEncrypt.cipher.update(attribute_val.to_s) + UrlEncrypt.cipher.final).unpack("H*").to_s)
+    end
+
+    module ClassMethods
+      def method_missing(method_id, *args)
+        if match = /^find_(all_by|by)_encrypted_([_a-zA-Z]\w*)$/.match(method_id.to_s)          
+          finder = determine_finder(match)
+          attribute_names = extract_attribute_names_from_match(match)
+          super unless all_attributes_exists?(attribute_names)
+
+          self.class_eval %{
+            def self.#{method_id}(*args)
+              encrypted_str = args[0]
+              raise(ActiveRecord::RecordNotFound) if encrypted_str.nil?
+              decrypted_str = decrypt(encrypted_str)              
+              
+              args[0] = decrypted_str
+
+              options = args.extract_options!
+              attributes = construct_attributes_from_arguments([:#{attribute_names.join(',:')}], args)
+              finder_options = { :conditions => attributes }
+              validate_find_options(options)
+              set_readonly_option!(options)
+
+              if options[:conditions]
+                with_scope(:find => finder_options) do
+                  ActiveSupport::Deprecation.silence { self.send(:#{finder}, options) }
+                end
+              else
+                ActiveSupport::Deprecation.silence { self.send(:#{finder}, options.merge(finder_options)) }
+              end
+            end
+          }, __FILE__, __LINE__
+          self.send(method_id, *args)
+        else
+          super
+        end
+      end
+      
+      protected
+        def decrypt(encrypted_str)
+          UrlEncrypt.cipher.decrypt
+          UrlEncrypt.cipher.key, UrlEncrypt.cipher.iv = UrlEncrypt.key, UrlEncrypt.iv
+          UrlEncrypt.cipher.update(URI.decode(encrypted_str).to_a.pack("H*")) + UrlEncrypt.cipher.final
+        end
+    end
+  end
+end

data/tasks/url_encrypt_tasks.rake

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

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'test/unit'
+require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
+require 'rubygems'
+require 'activerecord'
+require 'mocha'

data/test/url_encrypt_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), "/test_helper")
+
+ActiveRecord::Base.class_eval do
+  alias_method :save, :valid?
+
+  def self.columns() @columns ||= []; end
+  
+  def self.column(name, sql_type = nil, default = nil, null = true)
+    columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, default, sql_type, null)
+  end
+end
+
+class Article < ActiveRecord::Base
+  column :id, :integer
+  column :title, :string
+  column :body, :text
+end
+
+class Book < ActiveRecord::Base
+  column :id, :integer
+  column :title, :string
+  
+  encrypted :with => :title
+end
+
+class UrlEncryptTest < Test::Unit::TestCase
+  
+  def test_should_not_encrypt_when_not_declared
+    article = Article.new(:title => "some title")
+    article.id = '654765498479'
+    assert_equal article.to_param, "654765498479"
+  end
+  
+  def test_should_encrypt_column_when_declared
+    book = Book.new
+    book.title = "some title"
+    
+    assert_equal book.to_param, "2ccc216a3fd804c52c152a1659f03ebd"
+  end
+  
+  def test_should_get_record_on_find_by_encrypted_column    
+    book = Book.new(:title => "some title")    
+    Book.expects(:find_initial).returns(book)
+
+    assert_equal Book.respond_to?(:find_by_encrypted_title), false
+    assert_equal Book.find_by_encrypted_title('2ccc216a3fd804c52c152a1659f03ebd'), book
+    assert_equal Book.respond_to?(:find_by_encrypted_title), true
+  end
+
+  def test_should_get_all_records_on_find_all_by_encrypted_column    
+    book = Book.new(:title => "some title")    
+    Book.expects(:find_every).returns(book)
+
+    assert_equal Book.respond_to?(:find_all_by_encrypted_title), false
+    assert_equal Book.find_all_by_encrypted_title('2ccc216a3fd804c52c152a1659f03ebd'), book
+    assert_equal Book.respond_to?(:find_all_by_encrypted_title), true
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

data/url_encrypt.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{url_encrypt}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Amit Kumar"]
+  s.date = %q{2010-05-02}
+  s.description = %q{Encrypt your URLs}
+  s.email = %q{toamitkumar@gmail.com}
+  s.extra_rdoc_files = ["README", "lib/url_encrypt.rb", "tasks/url_encrypt_tasks.rake"]
+  s.files = ["MIT-LICENSE", "README", "Rakefile", "init.rb", "install.rb", "lib/url_encrypt.rb", "tasks/url_encrypt_tasks.rake", "test/test_helper.rb", "test/url_encrypt_test.rb", "uninstall.rb", "Manifest", "url_encrypt.gemspec"]
+  s.homepage = %q{http://github.com/toamitkumar/url_encrypt}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Url_encrypt", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{url_encrypt}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Encrypt your URLs}
+  s.test_files = ["test/url_encrypt_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: url_encrypt
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Amit Kumar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-02 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Encrypt your URLs
+email: toamitkumar@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- lib/url_encrypt.rb
+- tasks/url_encrypt_tasks.rake
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- install.rb
+- lib/url_encrypt.rb
+- tasks/url_encrypt_tasks.rake
+- test/test_helper.rb
+- test/url_encrypt_test.rb
+- uninstall.rb
+- Manifest
+- url_encrypt.gemspec
+has_rdoc: true
+homepage: http://github.com/toamitkumar/url_encrypt
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Url_encrypt
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: url_encrypt
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Encrypt your URLs
+test_files: 
+- test/url_encrypt_test.rb
+- test/test_helper.rb