jsonapi-resources 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51cd49198136e8a49dd3bb8138721babc499c0cf
-  data.tar.gz: 29ddb62840cb17c2e753cfb03ab5e5cfe9dcdbe0
+  metadata.gz: 54ace53b12009a3a05a2ecb95ad41de0521e11e1
+  data.tar.gz: 276a1910eebc42ffea72005edc6b837fb15a29ac
 SHA512:
-  metadata.gz: 276688390c5ae3d33ab1c40ea8a181ed8024c8c99cca514de6a941f52a64ace4b39b81b4aaba7222730b5d0604ec9e52a6cb48e0a49d61933df148daf0ecba3f
-  data.tar.gz: bd36f549771a05afb8efec6ef4337e3888a9b2d9ad153fd870cba852c06c353a32b42484e0eb9b84cbfbfa5c3a14dfcb3254b0d1c3c07099f0debe849524a583
+  metadata.gz: 2203b61b306a9c646482a156cdc3a073352ce91c683c837821342cf5c84f4910ce7e86e02938070176457362c63b275b27d70c5f08425e4244d462df21d49263
+  data.tar.gz: 27370f259cfc82e4fb3da10b5ea78e04462b563ac870e7ad0c46bdd7bca3fc5240989179cf02b7ef7464ca3787dce1edacb76512b6ff8bf59a3bbe343909ad7d

data/README.md

@@ -82,7 +82,7 @@ end
 
 ##### Fetchable Attributes
 
-By default all attributes are assumed to be fetchable. The list of fetchable attributes can be filtered by overriding the `fetchable` method.
+By default all attributes are assumed to be fetchable. The list of fetchable attributes can be filtered by overriding the `fetchable_fields` method.
 
 Here's an example that prevents guest users from seeing the `email` field:
 
@@ -92,11 +92,11 @@ class AuthorResource < JSONAPI::Resource
   model_name 'Person'
   has_many :posts
 
-  def fetchable(keys, context)
+  def fetchable_fields(context)
     if (context.current_user.guest)
-      super(keys - [:email])
+      super(context) - [:email]
     else
-      super(keys)
+      super(context)
     end
   end
 end
@@ -106,7 +106,7 @@ Context flows through from the controller and can be used to control the attribu
 
 ##### Creatable and Updateable Attributes
 
-By default all attributes are assumed to be updateble and creatable. To prevent some attributes from being accepted by the `update` or `create` methods, override the `self.updateable` and `self.creatable` methods on a resource.
+By default all attributes are assumed to be updateable and creatable. To prevent some attributes from being accepted by the `update` or `create` methods, override the `self.updateable_fields` and `self.createable_fields` methods on a resource.
 
 This example prevents `full_name` from being set:
 
@@ -120,17 +120,17 @@ class ContactResource < JSONAPI::Resource
     "#{@object.name_first}, #{@object.name_last}"
   end
 
-  def self.updateable(keys, context = nil)
-    super(keys - [:full_name])
+  def self.updateable_fields(context)
+    super - [:full_name]
   end
 
-  def self.createable(keys, context = nil)
-    super(keys - [:full_name])
+  def self.createable_fields(keys, context)
+    super - [:full_name]
   end
 end
 ```
 
-The `context` is not used by the `ResourceController`, but may be used if you override the controller methods.
+The `context` is not by default used by the `ResourceController`, but may be used if you override the controller methods. By using the context you have the option to determine the createable and updateable fields based on the user.
 
 ##### Attribute Formatting
 

data/lib/jsonapi/resource.rb

@@ -1,7 +1,6 @@
 require 'jsonapi/configuration'
 require 'jsonapi/resource_for'
 require 'jsonapi/association'
-require 'action_dispatch/routing/mapper'
 
 module JSONAPI
   class Resource
@@ -108,8 +107,8 @@ module JSONAPI
     end
 
     # Override this on a resource instance to override the fetchable keys
-    def fetchable(keys, context = nil)
-      keys
+    def fetchable_fields(context)
+      self.class.fields
     end
 
     class << self
@@ -184,16 +183,16 @@ module JSONAPI
 
       # Override in your resource to filter the updateable keys
       def updateable_fields(context)
-        fields
+        _updateable_associations | _attributes.keys
       end
 
       # Override in your resource to filter the createable keys
       def createable_fields(context)
-        fields
+        _updateable_associations | _attributes.keys
       end
 
       def fields
-        _updateable_associations | _attributes.keys
+        _associations.keys | _attributes.keys
       end
 
       # Override this method if you have more complex requirements than this basic find method provides

data/lib/jsonapi/resource_serializer.rb

@@ -124,12 +124,12 @@ module JSONAPI
 
     def attribute_hash(source)
       requested = requested_fields(source.class._type)
-      fields = source.class._attributes.keys.to_a
+      fields = source.fetchable_fields(@context) & source.class._attributes.keys.to_a
       unless requested.nil?
         fields = requested & fields
       end
 
-      source.fetchable(fields, @context).each_with_object({}) do |name, hash|
+      fields.each_with_object({}) do |name, hash|
         hash[format_key(name)] = format_value(source.send(name),
                                               source.class._attribute_options(name)[:format],
                                               source,
@@ -149,7 +149,7 @@ module JSONAPI
 
       field_set = Set.new(fields)
 
-      included_associations = source.fetchable(associations.keys, @context)
+      included_associations = source.fetchable_fields(@context) & associations.keys
       associations.each_with_object({}) do |(name, association), hash|
         if included_associations.include? name
           key = association.key

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/test/fixtures/active_record.rb

@@ -319,11 +319,11 @@ class AuthorResource < JSONAPI::Resource
     return resources
   end
 
-  def fetchable(keys, context = nil)
+  def fetchable_fields(context)
     if (@object.id % 2) == 1
-      super(keys - [:email])
+      super(context) - [:email]
     else
-      super(keys)
+      super(context)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-20 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler