hot_like_sauce 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+
+gem "activerecord", ">= 3.2.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "sqlite3", "~> 1.3.5"
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.3)
+      activesupport (= 3.2.3)
+      builder (~> 3.0.0)
+    activerecord (3.2.3)
+      activemodel (= 3.2.3)
+      activesupport (= 3.2.3)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.0)
+    multi_json (1.3.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sqlite3 (1.3.5)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.2.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  sqlite3 (~> 1.3.5)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Justin Derrek Van Eaton
+
+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,65 @@
+# hot-like-sauce
+
+This is some sweet code for ActiveRecord (rails) that will allow you to obscure database fields. The data will always be obscured in the database, but can be read as plaintext or obscured. This is useful for admin views where you can display obscured data for people who shouldn't be seeing it.
+
+## Usage
+
+```ruby
+gem 'hot_like_sauce'
+```
+
+```ruby
+class Post < ActiveRecord::Base
+  attr_obscurable :body
+end
+```
+
+By default, when you read the value you get the original plain text.
+
+```ruby
+p = Post.create(:body => "readable text")
+p.body
+#=> "readable text"
+
+Post.obscure_read_on_fields!(:body)
+p.body
+#=> "էu??+]?S???^Vx????gzq?'?"
+```
+
+You can configure this on a per field basis by default
+
+```ruby
+class Post < ActiveRecord::Base
+  attr_obscurable :body, :obscure_on_read => true
+end
+
+p = Post.create(:body => "readable text")
+p.body
+#=> "էu??+]?S???^Vx????gzq?'?"
+```
+
+`Post.obscure_read_on_fields!` can be called with no arguments to set all attr_obscurable fields. The inverse method is `Post.unobscure_read_on_fields!`
+
+## Configuration
+
+```ruby
+HotLikeSauce.secret_key = "this-should-be-long-and-random"
+
+HotLikeSauce.crypto_method = "aes-256-cbc" # default's to aes-256-cbc
+```
+
+## Contributing to hot-like-sauce
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Justin Derrek Van Eaton. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "hot_like_sauce"
+  gem.homepage = "http://github.com/jstin/hot_like_sauce"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails gem for obscuring database fields}
+  gem.description = %Q{Rails gem for obscuring database fields. Uses OpenSSL.}
+  gem.email = "jvaneaton@tangogroup.com"
+  gem.authors = ["Justin Derrek Van Eaton"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hot_like_sauce #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/hot_like_sauce.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "hot_like_sauce"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Derrek Van Eaton"]
+  s.date = "2012-05-03"
+  s.description = "Rails gem for obscuring database fields. Uses OpenSSL."
+  s.email = "jvaneaton@tangogroup.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "hot_like_sauce.gemspec",
+    "lib/hot_like_sauce.rb",
+    "spec/.DS_Store",
+    "spec/hot_like_sauce_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/schema.rb"
+  ]
+  s.homepage = "http://github.com/jstin/hot_like_sauce"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Rails gem for obscuring database fields"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.2.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<sqlite3>, ["~> 1.3.5"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.2.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<sqlite3>, ["~> 1.3.5"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.2.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<sqlite3>, ["~> 1.3.5"])
+  end
+end
+

data/lib/hot_like_sauce.rb

@@ -0,0 +1,120 @@
+require 'openssl'
+require 'active_record'
+
+module HotLikeSauce
+
+  def self.secret_key
+    @secret_key ||= "please_init_this_somewhere_before_using"
+  end
+
+  def self.secret_key=(val)
+    @secret_key = val
+  end
+
+  def self.crypto_method
+    @crypto_method ||= "aes-256-cbc"
+  end
+
+  def self.crypto_method=(val)
+    @crypto_method = val
+  end
+
+  module ARMethods
+
+    def inherited(child_class)
+      child_class.send :extend,  HotLikeSauce::ClassMethods
+      child_class.send :include, HotLikeSauce::InstanceMethods
+    end
+
+  end
+
+  module ClassMethods
+
+    def obscured_fields
+      @obscured_fields ||= []
+    end
+
+    def obscured_fields=(val)
+      @obscured_fields = val
+    end
+
+    def unobscured_read_fields
+      @unobscured_read_fields ||= []
+    end
+
+    def unobscured_read_fields=(val)
+      @unobscured_read_fields = val
+    end
+
+    def attr_obscurable(*args)
+      fields = args.map {|arg| arg if arg.is_a?(Symbol)}.compact
+      options = args.map {|arg| arg if arg.is_a?(Hash)}.compact.first
+      options ||= {}
+
+      fields.each do |field|
+
+        type = self.columns_hash[field.to_s].type
+        raise "#{field} must be a string or text field" unless type == :string || type == :text
+        self.obscured_fields = (self.obscured_fields << field).uniq
+        self.unobscured_read_fields = (self.unobscured_read_fields << field).uniq unless options[:obscure_on_read] == true
+
+        define_method field do
+          super()
+          value = read_attribute(field)
+          self.class.unobscured_read_fields.include?(field) ? _unobscure(value) : value
+        end
+
+        define_method "#{field}=" do |value|
+          super(value)
+          write_attribute(field, _obscure(value))
+        end
+
+      end
+
+    end
+
+    def obscure_read_on_fields!(*fields_array)
+      if fields_array.empty?
+        self.unobscured_read_fields = []
+      else
+        self.unobscured_read_fields -= fields_array
+      end
+    end
+
+    def unobscure_read_on_fields!(*fields_array)
+      if fields_array.empty?
+        self.unobscured_read_fields = self.obscured_fields
+      else
+        self.unobscured_read_fields += self.obscured_fields & fields_array
+      end
+    end
+
+  end
+
+  module InstanceMethods
+
+  private
+
+    def _obscure(value)
+      _crypt :encrypt, HotLikeSauce::secret_key, value
+    end
+
+    def _unobscure(value)
+      _crypt :decrypt, HotLikeSauce::secret_key, value
+    end
+
+    def _crypt(method, key, value)
+      cipher = OpenSSL::Cipher::Cipher.new(HotLikeSauce::crypto_method)
+      cipher.send(method)
+      cipher.pkcs5_keyivgen(key)
+      result = cipher.update(value)
+      result << cipher.final
+      result.force_encoding('UTF-8')
+    end
+
+  end
+
+end
+
+
+ActiveRecord::Base.send :extend,  HotLikeSauce::ARMethods

data/spec/hot_like_sauce_spec.rb

@@ -0,0 +1,129 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HotLikeSauce" do
+
+  describe "obscures text and strings" do
+
+    before :each do
+      Object.send(:remove_const, :Post) if defined?(Post)
+      Object.send(:remove_const, :Grape) if defined?(Grape)
+      class Post < ActiveRecord::Base
+        attr_obscurable :title
+      end
+
+      class Grape < ActiveRecord::Base
+        attr_obscurable :title, :contents
+      end
+    end
+
+    it "can obscure fields to the datatbase" do
+      p = Post.new
+      p.title = "raison brain"
+      p.save
+      p.reload
+      p.title.should == "raison brain"
+
+      Object.send(:remove_const, :Post)
+      class Post < ActiveRecord::Base
+
+      end
+
+      p = Post.find p.id
+      p.title.should_not == "raison brain"
+    end
+
+    it "can only obscure the fields specified" do
+      p = Post.new
+      p.body = "water is tasty and wonderful"
+      p.save
+
+      Object.send(:remove_const, :Post)
+      class Post < ActiveRecord::Base
+
+      end
+
+      p = Post.find p.id
+      p.body.should == "water is tasty and wonderful"
+    end
+
+    it "can obscure fields on read" do
+      p = Post.new
+      p.title = "we all belong"
+      p.save
+      p.reload
+
+      Post.obscure_read_on_fields!
+      p.title.should_not == "we all belong"
+
+      Post.unobscure_read_on_fields!
+
+      p.title.should == "we all belong"
+    end
+
+    it "can obscure fields on read by default" do
+      Object.send(:remove_const, :Post)
+      class Post < ActiveRecord::Base
+        attr_obscurable :title, :obscure_on_read => true
+      end
+
+      p = Post.new
+      p.title = "we all belong"
+      p.save
+      p.reload
+
+      p.title.should_not == "we all belong"
+    end
+
+    it "can obscure individual fields on read" do
+      p = Grape.new
+      p.title = "i'm the doctor dawg"
+      p.contents = "who are you to be yourself?"
+      p.save
+      p.reload
+
+      Post.obscure_read_on_fields!(:contents)
+      p.title.should == "i'm the doctor dawg"
+      p.reload
+      p.contents.should == "who are you to be yourself?"
+
+      Grape.obscure_read_on_fields!(:contents)
+      p.title.should == "i'm the doctor dawg"
+      p.contents.should_not == "who are you to be yourself?"
+
+      Grape.unobscure_read_on_fields!(:contents)
+      p.title.should == "i'm the doctor dawg"
+      p.contents.should == "who are you to be yourself?"
+    end
+
+    it "can obscure special charaters" do
+     g = Grape.create(:contents => "!@$%^&*()\n")
+     g.contents.should == "!@$%^&*()\n"
+    end
+
+  end
+
+  describe "validates proper fields" do
+
+    before :each do
+      Object.send(:remove_const, :Post) if defined?(Post)
+      Object.send(:remove_const, :Grape) if defined?(Grape)
+      class Post < ActiveRecord::Base
+        attr_obscurable :title
+      end
+
+      class Grape < ActiveRecord::Base
+        attr_obscurable :title
+      end
+    end
+
+    it "can not obscure integer fields" do
+      expect { Grape.attr_obscurable(:vineyard_id) }.should raise_exception
+    end
+
+    it "can not obscure datetime fields" do
+      expect { Grape.attr_obscurable(:created_at) }.should raise_exception
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'hot_like_sauce'
+
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => File.dirname(__FILE__) + "/test.sqlite")
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/support/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.text :body
+    t.timestamps
+  end
+
+  create_table :grapes, :force => true do |t|
+    t.integer :vineyard_id
+    t.string :title
+    t.text :contents
+    t.timestamps
+  end
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: hot_like_sauce
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Justin Derrek Van Eaton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70259113489420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70259113489420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70259115530380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70259115530380
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &70259115529400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *70259115529400
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70259115528620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70259115528620
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70259115526160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70259115526160
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70259115524400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70259115524400
+description: Rails gem for obscuring database fields. Uses OpenSSL.
+email: jvaneaton@tangogroup.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- hot_like_sauce.gemspec
+- lib/hot_like_sauce.rb
+- spec/.DS_Store
+- spec/hot_like_sauce_spec.rb
+- spec/spec_helper.rb
+- spec/support/schema.rb
+homepage: http://github.com/jstin/hot_like_sauce
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2965139016655371852
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Rails gem for obscuring database fields
+test_files: []