public_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a03f830869d3d96336db10de1b0dcb843e659a7b
+  data.tar.gz: a77f0073157f8c258533b88f5d5d343d937d06fd
+SHA512:
+  metadata.gz: 2659ed187c79cfa009b31ba62ccf019c46b2c917ed36c103346d6c1dc2471b05b7ef8592a0de4d4060aec2fabfaef935b9a15194d0fd479867316642e6cdfd32
+  data.tar.gz: 4f6bf6da9fcf0b7c366002f710379079e93694458cf66fb6f47531d744b219582981fc2dd5961616ce8bde4fc8e014861e413b2b1a3f7877647b28d53203cce0

data/lib/public_attributes.rb

@@ -0,0 +1,77 @@
+#
+# Provides a to_public instance method for filtering out sensative data.
+#
+# Public attributes are defined with the public_attributes class method, which
+# whitelists attributes that are ok to send to the client, JSON endpoints, etc.
+#
+
+require 'json'
+
+module PublicAttributes
+  @_public_attributes ||= {}
+
+  def self.included(klass)
+    @_public_attributes[klass.name] ||= []
+    klass.extend(ClassMethods)
+  end
+
+  def self.add(class_name, attr_list)
+    @_public_attributes[class_name].push(*attr_list)
+    @_public_attributes[class_name].uniq!
+  end
+
+  def self.for(klass)
+    self.instance_variable_get(:@_public_attributes)[klass.name]
+  end
+
+  def self.reset
+    self.instance_variable_set(:@_public_attributes, {})
+  end
+
+  module ClassMethods
+    def public_attributes(*attr_list)
+      PublicAttributes.add(name, attr_list)
+    end
+
+    def to_public
+      if defined?(ActiveRecord) && (self < ActiveRecord::Base)
+        where(nil).map do |instance|
+          instance.to_public
+        end
+      else
+        raise Error 'This method is only available for ActiveRecord classes. '\
+                    'Please re-implement if you\'d like to call to_public on '\
+                    'a custom collection.'
+      end
+    end
+  end
+
+  def to_public
+    hash = {}
+    all_public_attributes.each do |attr|
+      value = self.send(attr)
+      if value.respond_to? :to_public
+        hash[attr] = value.to_public
+      else
+        hash[attr] = value
+      end
+    end
+    return hash
+  end
+
+  def to_json
+    JSON.generate self.to_public
+  end
+
+private
+
+  def all_public_attributes
+    attributes = PublicAttributes.for(self.class)
+    if defined?(ActiveRecord) && self.is_a?(ActiveRecord::Base)
+      attributes += [:created_at, :updated_at]
+      attributes.push(:errors) unless self.errors.keys.empty?
+    end
+    return attributes
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: public_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nathan Hackley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple public vs private attribute filtering for Ruby objects.
+email: nathanhackley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/public_attributes.rb
+homepage: http://rubygems.org/gems/public_attributes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Public Attributes
+test_files: []