obscurify_attribute 0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--backtrace

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.2-p290@obscurify_attribute

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+Initial release.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    obscurify_attribute (0.1.0)
+      activemodel (~> 3.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    metaclass (0.0.1)
+    mocha (0.10.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.0.3)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  obscurify_attribute!
+  rspec (~> 2.6)

data/README.md

@@ -0,0 +1,34 @@
+# Obscurify Attribute
+
+Obscures all sensitive attributes from showing up in the errors object for Active Records/Resources
+
+## Install
+
+Add the following line to your Gemfile
+
+    gem 'obscurify_attribute'
+
+## Usage
+
+Add the following line into your ActiveRecord (or ActiveResource) model:
+
+    class Payment < ActiveRecord::Base
+        include ObscurifyAttribute::Validations
+
+        # if credit_card is one of the sensitive attributes, but it should not be shown to the user...
+        obscurify :credit_card, :payment_information, :message => "foo bar"
+    end
+
+:message is optional. It defaults to the same messages that were reported for the original attribute.
+If specified, the new message will overwrite the reported array. All messages are uniqued to avoid duplicates
+(since you can specify the same target attribute name for multiple source attributes)!
+
+
+ObscurifyAttribute will iterate over the errors object and mask sensitive fields with a different
+(user-specified) name so that they dont show up in the UI.
+
+## Known issues
+
+## Contribute & Dev environment
+
+Usual fork & pull request.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec

data/lib/obscurify_attribute.rb

@@ -0,0 +1,2 @@
+require File.expand_path('obscurify_attribute/validations', File.dirname(__FILE__))
+# require File.expand_path('obscurify_attribute/railtie', File.dirname(__FILE__))

data/lib/obscurify_attribute/validations.rb

@@ -0,0 +1,46 @@
+module ObscurifyAttribute
+  module Validations
+    def self.included(base)
+      base.__send__(:extend, ::ObscurifyAttribute::Validations::ClassMethods)
+      base.__send__(:include, ::ObscurifyAttribute::Validations::InstanceMethods)
+      base.alias_method_chain(:errors, :obscured)
+    end
+
+    module ClassMethods
+      attr_reader :sensitive_attrs
+
+      def obscurify(*args)
+        options = args.extract_options!
+        args.reject!(&:blank?)
+        options.symbolize_keys!
+        options.assert_valid_keys(:message)
+        to_name = args.pop
+        raise(ArgumentError, "Should specify a second (target) attribute name") if args.empty?
+        args.inject(sensitive_attrs) do |h, attr|
+          h[attr] = {:to => to_name}.merge(options)
+          h
+        end
+      end
+
+      def sensitive_attrs
+        @sensitive_attrs ||= {}
+      end
+    end
+
+    module InstanceMethods
+      def errors_with_obscured
+        errors_without_obscured.tap do |result|
+          if !self.class.sensitive_attrs.empty? && !(result.keys & self.class.sensitive_attrs.keys).empty?
+            self.class.sensitive_attrs.each do |old_name, options|
+              new_name = options[:to]
+              messages = options.has_key?(:message) ? Array.wrap(options[:message]) : result[old_name]
+              messages.each { |error| result.add(new_name, error) }
+              result[old_name].clear
+              result[new_name].uniq!
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/obscurify_attribute/version.rb

@@ -0,0 +1,3 @@
+module ObscurifyAttribute
+  VERSION = "0.2.0"
+end

data/obscurify_attribute.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "obscurify_attribute/version"
+
+Gem::Specification.new do |s|
+  s.name        = "obscurify_attribute"
+  s.version     = ObscurifyAttribute::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Vijay R Aravamudhan"]
+  s.email       = ["avijayr@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Obscures all sensitive attributes from showing up in the errors objects for Active Records/Resources}
+  s.description = %q{Obscures all sensitive attributes from showing up in the errors objects for Active Records/Resources}
+  s.homepage    = "https://github.com/vraravam/obscurify_attribute"
+
+  s.add_dependency "activemodel", "~> 3.1"
+
+  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "mocha"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/obscurify_attribute/validations_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe "ObscurifyAttribute::Validations" do
+  it "should respond to obscurify" do
+    ObscurifyAttributeItem.respond_to?(:obscurify).should be_true
+  end
+
+  it "should only allow :message as a valid key for the options hash" do
+    lambda {
+      ObscurifyAttributeItem.obscurify :first_name, :name, :messages => "blah"
+    }.should raise_error(ArgumentError, "Unknown key: messages")
+  end
+
+  it "should not allow only a single attribute name (leaving the target name blank)" do
+    lambda {
+      ObscurifyAttributeItem.obscurify :first_name
+    }.should raise_error(ArgumentError, "Should specify a second (target) attribute name")
+  end
+
+  it "should discard blank attribute names" do
+    lambda {
+      ObscurifyAttributeItem.obscurify :first_name, "", "  "
+    }.should raise_error(ArgumentError, "Should specify a second (target) attribute name")
+  end
+
+  it "should allow a single attribute to be obscured" do
+    ObscurifyAttributeItem.obscurify :first_name, :name
+
+    obs = ObscurifyAttributeItem.new
+    obs.should_not be_valid
+    obs.errors[:first_name].should == []
+    obs.errors[:name].should == ["can't be blank"]
+  end
+
+  it "should allow multiple attributes to be obscured to different targets" do
+    ObscurifyAttributeItem.obscurify :first_name, :fName
+    ObscurifyAttributeItem.obscurify :last_name, :lName
+
+    obs = ObscurifyAttributeItem.new
+    obs.should_not be_valid
+    obs.errors[:first_name].should == []
+    obs.errors[:fName].should == ["can't be blank"]
+    obs.errors[:last_name].should == []
+    obs.errors[:lName].should == ["can't be blank"]
+  end
+
+  it "should allow multiple attributes to be obscured to the same target" do
+    ObscurifyAttributeItem.obscurify :first_name, :name
+    ObscurifyAttributeItem.obscurify :last_name, :name
+
+    obs = ObscurifyAttributeItem.new
+    obs.should_not be_valid
+    obs.errors[:first_name].should == []
+    obs.errors[:last_name].should == []
+    obs.errors[:name].should == ["can't be blank"]
+  end
+
+  it "should uniq the errors on the target attribute" do
+    ObscurifyAttributeItem.obscurify :first_name, :last_name, :name
+
+    obs = ObscurifyAttributeItem.new
+    obs.should_not be_valid
+    obs.errors[:first_name].should == []
+    obs.errors[:last_name].should == []
+    obs.errors[:name].should == ["can't be blank"]
+  end
+
+  it "should handle a custom message" do
+    ObscurifyAttributeItem.obscurify :first_name, :fName, :message => "foo"
+    ObscurifyAttributeItem.obscurify :last_name, :lName, :message => "bar"
+
+    obs = ObscurifyAttributeItem.new
+    obs.should_not be_valid
+    obs.errors[:first_name].should == []
+    obs.errors[:fName].should == ["foo"]
+    obs.errors[:last_name].should == []
+    obs.errors[:lName].should == ["bar"]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+ENV["RAILS_ENV"] = "test"
+
+require 'rubygems'
+require 'bundler/setup'
+require 'active_model'
+require 'active_model/validations'
+require 'obscurify_attribute'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.before(:each) do
+    class ObscurifyAttributeItem
+      include ::ActiveModel::Validations
+      include ::ObscurifyAttribute::Validations
+
+      attr_accessor :first_name, :last_name
+
+      validates_presence_of :first_name
+      validates_presence_of :last_name
+    end
+  end
+
+  config.after(:each) do
+    Object.send(:remove_const, :ObscurifyAttributeItem)
+  end
+end
+
+def putsh(stuff)
+  puts "#{ERB::Util.h(stuff)}<br/>"
+end
+
+def ph(stuff)
+  putsh stuff.inspect
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: obscurify_attribute
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Vijay R Aravamudhan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &2169890940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2169890940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2169890180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2169890180
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2169889640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169889640
+description: Obscures all sensitive attributes from showing up in the errors objects
+  for Active Records/Resources
+email:
+- avijayr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- db/.gitkeep
+- lib/obscurify_attribute.rb
+- lib/obscurify_attribute/validations.rb
+- lib/obscurify_attribute/version.rb
+- obscurify_attribute.gemspec
+- spec/obscurify_attribute/validations_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vraravam/obscurify_attribute
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Obscures all sensitive attributes from showing up in the errors objects for
+  Active Records/Resources
+test_files: []