hide_attributes 0.1.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Laas Toom
+
+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

@@ -0,0 +1,50 @@
+= HideAttributes
+
+This plugin generates wrappers to `to_xml` and `to_json` methods to
+automatically exclude attributes such as passwords from output.
+
+
+== Example
+
+To auto-hide password fields from generated JSON output, add this to your model:
+
+  class User < ActiveRecord::Base
+
+    hide_attributes :password, :password_salt
+
+  end
+
+
+Then use as usual:
+
+  user = User.first
+
+  # Output user's JSON without hidden attributes present
+  user.to_json
+
+  # Temporarly override hiding and output all attributes
+  user.to_json :except => nil
+
+
+== INSTALL
+
+To install simply add it to your _Gemfile_
+
+  gem 'hide_attributes'
+
+And run bundle:
+
+  bundle install
+
+
+== Requirements
+
+Runtime requirements are:
+
+* ActiveRecord >=3.0
+
+== TODO
+
+* Write tests
+
+Copyright (c) 2011 Laas Toom, released under the MIT license

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the hide_attributes plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the hide_attributes plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HideAttributes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "hide_attributes"
+    gemspec.summary = "ActiveRecord to JSON or XML without sensitive data"
+    gemspec.description = "Autohides sensitive attributes (such as passwords) when rendering XML or JSON from ActiveRecord model"
+    gemspec.email = "laas.toom@gmail.com"
+    gemspec.homepage = "http://github.com/borgand/hide_attributes"
+    gemspec.authors = ["Laas Toom"]
+
+    gemspec.add_runtime_dependency("activerecord", ">= 3.0")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails',  'init')

data/install.rb

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

data/lib/hide_attributes.rb

@@ -0,0 +1,40 @@
+module HideAttributes #:nodoc:
+  module ClassMethods
+
+    # Macro to specify which attributes are to be hidden
+    #
+    #   hide_attributes :password, :password_salt
+    def hide_attributes(*arr)
+      @hidden_attributes = arr.flatten
+    end
+    attr_reader :hidden_attributes
+  end
+
+  # Merge +to_xml+ options with +:exclude => hidden_attributes+
+  def to_xml_with_hidden(opts=nil, &block)
+    merge_options_and_call(:to_xml_without_hidden, opts, &block)
+  end
+
+  # Merge +as_json+ with +:exclude => hidden_attributes+
+  def to_json_with_hidden(opts=nil)
+    merge_options_and_call(:to_json_without_hidden, opts)
+  end
+
+  # Hook up class methods and aliases
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.alias_method_chain :to_xml, :hidden
+    base.alias_method_chain :to_json, :hidden
+  end
+
+  private
+  # Merge options with +:exclude => hidden_attributes+ and call indicated formatter
+  def merge_options_and_call(formatter, opts=nil, &block)
+    opts ||= {}
+    send(formatter, {:except => self.class.hidden_attributes}.merge(opts), &block)
+  end
+end
+
+
+ActiveRecord::Base.send :include, HideAttributes
+

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'hide_attributes'
+

data/uninstall.rb

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: hide_attributes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
+platform: ruby
+authors: 
+- Laas Toom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-17 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Autohides sensitive attributes (such as passwords) when rendering XML or JSON from ActiveRecord model
+email: laas.toom@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/hide_attributes.rb
+- rails/init.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/borgand/hide_attributes
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord to JSON or XML without sensitive data
+test_files: []
+