restpack_serializer 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33de851fe3b900b57c1cd36c7146dd6d7e799ee5
-  data.tar.gz: fc2674844a0ad0a839cab52e2182c0661611a763
+  metadata.gz: ec99f158a9e7825b3134792a1ea5ba5efb2a961f
+  data.tar.gz: a33b39771c550f179826c344af688f5d9e84392b
 SHA512:
-  metadata.gz: 94794f6281fbd6c7efe7d36ab39439d462ba0200605c1c488dee9522311e4fc5a917e7b660eab673e41d96339ec35a3d9eb67fac87b48dcfb908d8a9705dff9e
-  data.tar.gz: 7bec627210c72d263d706a53391e48db1721dc9a6ea754a2e31043fa036e5f8cbdd629896d0b42a72062230a9ce2b8d838c2ff85b1ee89902ba79be3068d9203
+  metadata.gz: 6412ccee09177e52299f3b8bfbfcdefc5f541f18bb3e5ab95ef126ecb178fd8a7f8304e3ceda94c838d30904056727b9e9413b3175e7cfc437a8eb33214aacf7
+  data.tar.gz: 8c2f759aa5ca1fcf1fa4d927e4fb6c156fdabb0a66a1fbc4bce6f9683d944a861d1b2b79107ae9ca8a23e633a6953dc72f25a67cc7c3dbe35f23f7042262a44b

data/lib/restpack_serializer/serializable.rb

@@ -37,6 +37,7 @@ module RestPack
         return model.map { |item| as_json(item, context) }
       end
 
+      apply_whitelist_and_blacklist(context)
       @model, @context = model, context
 
       data = {}
@@ -72,6 +73,41 @@ module RestPack
       data.merge!(custom) if custom
     end
 
+    def apply_whitelist_and_blacklist(context)
+      blacklist = context[:attribute_blacklist]
+      whitelist = context[:attribute_whitelist]
+
+      if blacklist.present? && whitelist.present?
+        raise ArgumentError.new "the context can't define both an `attribute_whitelist` and an `attribute_blacklist`"
+      end
+
+      if blacklist.present?
+        blacklist = csv_to_symbol_array(blacklist)
+        self.class.serializable_attributes.each do |key, value|
+          if blacklist.include? key
+            context[value[:include_method_name]] = false
+          end
+        end
+      end
+
+      if whitelist.present?
+        whitelist = csv_to_symbol_array(whitelist)
+        self.class.serializable_attributes.each do |key, value|
+          unless whitelist.include? key
+            context[value[:include_method_name]] = false
+          end
+        end
+      end
+    end
+
+    def csv_to_symbol_array(maybe_csv)
+      if maybe_csv.is_a? String
+        maybe_csv.split(',').map {|a| a.strip.to_sym}
+      else
+        maybe_csv
+      end
+    end
+
     def add_links(model, data)
       self.class.associations.each do |association|
         data[:links] ||= {}

data/lib/restpack_serializer/version.rb

@@ -1,5 +1,5 @@
 module RestPack
   module Serializer
-    VERSION = '0.6.6'
+    VERSION = '0.6.7'
   end
 end

data/spec/serializable/serializer_spec.rb

@@ -198,6 +198,44 @@ describe RestPack::Serializer do
           ]
         }
       end
+
+      it "excludes a blacklist of attributes if specified as an array" do
+        serializer.as_json(person, { attribute_blacklist: [:name, :description] }).should == {
+          id: '123',
+          href: '/people/123',
+          custom_key: 'custom value for model id 123'
+        }
+      end
+
+      it "excludes a blacklist of attributes if specified as a string" do
+        serializer.as_json(person, { attribute_blacklist: 'name, description' }).should == {
+          id: '123',
+          href: '/people/123',
+          custom_key: 'custom value for model id 123'
+        }
+      end
+
+      it "includes a whitelist of attributes if specified as an array" do
+        serializer.as_json(person, { attribute_whitelist: [:name, :description] }).should == {
+          name: 'Gavin',
+          description: 'This is person #123',
+          custom_key: 'custom value for model id 123'
+        }
+      end
+
+      it "includes a whitelist of attributes if specified as a string" do
+        serializer.as_json(person, { attribute_whitelist: 'name, description' }).should == {
+          name: 'Gavin',
+          description: 'This is person #123',
+          custom_key: 'custom value for model id 123'
+        }
+      end
+
+      it "raises an exception if both the whitelist and blacklist are provided" do
+        expect do
+          serializer.as_json(person, { attribute_whitelist: [:name], attribute_blacklist: [:id] })
+        end.to raise_error(ArgumentError, "the context can't define both an `attribute_whitelist` and an `attribute_blacklist`")
+      end
     end
 
     context "links" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restpack_serializer
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors:
 - Gavin Joyce
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport