attribute_ext 1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.project

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>attribute_ext</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>com.aptana.ide.core.unifiedBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>com.aptana.ruby.core.rubynature</nature>
+		<nature>com.aptana.projects.webnature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,187 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.

data/README.md

@@ -0,0 +1,98 @@
+
+AttributeExt
+============
+
+Copyright (C) 2011 Jan Graichen
+
+AttributeExt provides additional access control for rails model attributes.
+It contains two modules one to protect attributes from mass assignment and one
+to hide attributes when serializing models.
+
+Changelog
+---------
+
+Sep 1, 2011
+
+HiddenAttributes works on included model when serializing to json by hooking 
+into serializable_hash now. Therefore it is possible to hide attributes when
+serializing to hash via serializable_hash method too. 
+But by default rules will not be checked on serializable_hash, you have to 
+add `:on_hash => true` to hide_attributes to enabled it for this rule.
+
+Update: SafeAttributes works now with Rails 3.1 mass_assignment_authorizer that 
+provides a role and pass this role to if and unless blocks as second
+parameter. Not tested but should also work with old mass_assignment_authorizer.
+
+
+AttributeExt::HiddenAttributes
+------------------------------
+
+Hides attributes when converting model to XML or JSON. Attributes can be 
+dynamically hidden using if or unless Procs.
+
+Examples:
+
+Only shows API access key when user has API access.
+
+	class User < ActiveRecord::Base
+	  hide_attributes :api_access_key, :unless => Proc.new { |user| user.api_access? }
+	end
+  
+Always hide password hash and password salt. Hide email if user do not want to 
+show his email.
+  
+	class User < ActiveRecord::Base
+	  hide_attributes :password_hash, :password_salt
+	  hide_attributes :email, :if => Proc.new { |user| user.hide_email? }
+	end
+
+
+Additional options are available in if and unless blocks:
+
+Only hide email when serialzing to json.
+
+	class User < ActiveRecord::Base
+	  hide_attributes :email, :if => Proc.new { |user, format| format == :json }
+	end
+	
+Hide user_id if associated user model will be included. This rule will also
+apply when calling serializable_hash.
+
+	class Event < ActiveRecord::Base
+	  belongs_to :user
+	  hide_attributes :user_id, :on_hash => true, :if => Proc.new { |event, format, opts| opts[:include].include?(:user) }
+	end
+
+
+AttributeExt::SafeAttributes
+----------------------------
+
+Protects attributes from mass assignment using rails mass assignment authorizer.
+Also support Proc blocks.
+
+Examples:
+
+Never allow mass assignment for attribute.
+
+	class User < ActiveRecord::Base
+	  safe_attributes :attribute
+	end
+
+Attributes 'login', 'admin' and 'status' can only be mass assigned if current 
+user is an admin.
+
+	class User < ActiveRecord::Base
+	  safe_attributes :login, :admin, :status, :if => Proc.new { User.current.admin? }
+	end
+  
+Message text can not be mass assigned when post is locked.
+
+	class Message < ActiveRecord::Base
+	  safe_attributes :text, :unless => Proc.new { |msg| msg.locked? }
+	end
+  
+License
+-------
+
+AttributeExt is licensed under the Apache License, Version 2.0. 
+See LICENSE for more information.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'rake'
+require 'bundler/gem_tasks'

data/attribute_ext.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "attribute_ext"
+  s.version     = "1.0"
+  s.authors     = ["Jan Graichen"]
+  s.email       = ["jan.graichen@altimos.de"]
+  s.homepage    = "https://github.com/jgraichen/attribute_ext"
+  s.summary     = %q{AttributeExt provides additional access control for rails model attributes.}
+  s.description = %q{AttributeExt provides additional access control for rails model attributes.}
+
+  s.rubyforge_project = "attribute_ext"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/init.rb

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

data/lib/attribute_ext/hidden_attributes.rb

@@ -0,0 +1,79 @@
+module AttributeExt
+  module HiddenAttributes
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.alias_method_chain :to_xml, :hidden_attrs
+      base.alias_method_chain :as_json, :hidden_attrs
+      base.alias_method_chain :serializable_hash, :hidden_attrs
+    end
+  
+    module ClassMethods
+      def hide_attributes(*attrs)
+        @hidden_attributes ||= []
+        if attrs.empty?
+          @hidden_attributes
+        else
+          options = attrs.last.is_a?(Hash) ? attrs.pop : {}
+          @hidden_attributes << [attrs, options]
+        end
+      end
+    end
+  
+    def to_xml_with_hidden_attrs(options = nil, &block)
+      options ||= {}
+      options[:except] = [] unless options[:except].is_a?(Array)
+      options[:except] += hidden_attribute_names(:xml, options)
+      
+      to_xml_without_hidden_attrs(options)
+    end
+  
+    def as_json_with_hidden_attrs(options = nil, &block)
+      options ||= {}
+      options[:except] = [] unless options[:except].is_a?(Array)
+      options[:except] += hidden_attribute_names(:json, options)
+      options[:hidden_attributes_json_export] = true
+            
+      as_json_without_hidden_attrs(options)
+    end
+  
+    def serializable_hash_with_hidden_attrs(options = nil)
+      options ||= {}
+      options[:except] = [] unless options[:except].is_a?(Array)
+      if options[:hidden_attributes_json_export]
+        options[:except] += hidden_attribute_names(:json, options)
+      else
+        options[:except] += hidden_attribute_names(:hash, options)
+      end
+      
+      serializable_hash_without_hidden_attrs(options)
+    end
+  
+    private
+    
+    def hidden_attribute_names(format, options)
+      names = []
+  
+      self.class.hide_attributes.collect do |attrs, opts|
+        if (format != :hash or opts[:on_hash]) &&  # only apply rules on hashs when wanted
+            (opts[:if].nil? or hidden_attr_call_block(opts[:if], format, options)) &&       # if block
+            (opts[:unless].nil? or !hidden_attr_call_block(opts[:unless], format, options)) # unless block
+          names += attrs.collect(&:to_s)
+        end
+      end
+      names.uniq
+    end
+    
+    def hidden_attr_call_block(block, format, opts)
+      case block.arity
+      when 0
+        return block.call
+      when 1
+        return block.call(self)
+      when 2
+        return block.call(self, format)
+      else
+        return block.call(self, format, opts)
+      end
+    end
+  end
+end

data/lib/attribute_ext/safe_attributes.rb

@@ -0,0 +1,49 @@
+module AttributeExt
+  module SafeAttributes
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def safe_attributes(*attrs)
+        @safe_attributes ||= []
+        if attrs.empty?
+          @safe_attributes
+        else
+          options = attrs.last.is_a?(Hash) ? attrs.pop : {}
+          @safe_attributes << [attrs, options]
+        end
+      end
+    end
+
+    def safe_attribute_names(role = :default)
+      names = []
+      self.class.safe_attributes.collect do |attrs, options|
+        if (options[:if].nil? || safe_attrs_call_block(options[:if], role)) &&        # if
+            (options[:unless].nil? || !safe_attrs_call_block(options[:unless], role)) # unless
+          names += attrs.collect(&:to_s)
+        end
+      end
+      names.uniq
+    end
+    
+    def safe_attrs_call_block(block, role)
+      case block.arity
+      when 0
+        return block.call
+      when 1
+        return block.call(self)
+      else
+        return block.call(self, role)
+      end
+    end
+
+    def mass_assignment_authorizer(role = nil)
+      if role.nil?
+        super + safe_attribute_names(:default)
+      else
+        super(role) + safe_attribute_names(role)
+      end
+    end
+  end
+end

data/lib/attribute_ext.rb

@@ -0,0 +1,6 @@
+
+require 'attribute_ext/hidden_attributes'
+require 'attribute_ext/safe_attributes'
+
+ActiveRecord::Base.send :include, AttributeExt::HiddenAttributes
+ActiveRecord::Base.send :include, AttributeExt::SafeAttributes

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: attribute_ext
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-16 00:00:00 Z
+dependencies: []
+
+description: AttributeExt provides additional access control for rails model attributes.
+email: 
+- jan.graichen@altimos.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .project
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- attribute_ext.gemspec
+- init.rb
+- lib/attribute_ext.rb
+- lib/attribute_ext/hidden_attributes.rb
+- lib/attribute_ext/safe_attributes.rb
+homepage: https://github.com/jgraichen/attribute_ext
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: attribute_ext
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: AttributeExt provides additional access control for rails model attributes.
+test_files: []
+