jsonapi-resources 0.7.0 → 0.7.1.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32e7bab3bce04e8ef68e0e58fd0274b128d7b68c
-  data.tar.gz: d12938d652c1ea0c692fea2c940354e673f75678
+  metadata.gz: cb58ea800ff6a685353e48ffca57603b1db612d8
+  data.tar.gz: 542b9ec812a94328f50204bbbef8743d593c2413
 SHA512:
-  metadata.gz: dd1e03599ab80a412cbe06e8d8d3231131a221f3406d82432c05d1b00c38b5002b3f1b30791c23328e613f12638f55ca35177439465ee1359dcb62f96a256057
-  data.tar.gz: 499fcf89189161652538b1716db928efe228b0db2e0d377012a0f98439463c1ef334cfc18b842a737f71e8c53aa9f2925932035cdbef3573726edcfb780d464b
+  metadata.gz: f2ad634e949bce4a5a0f1482dbd66392e97efba3f015a3eb9c3c87b8fe0b7ed0b8bb5e1a2f6dcde3bd228ad64b51de2cd6d12aed9586980e4cadf5aeb59d6acd
+  data.tar.gz: 7a4a9275358f79a011b2610e316cd5190beb23e375661ef0508fb65cd3c0b08c7d0bbf751ca0ef37d98a455f842e059feb5d39be70b70b63aa2dc53308bb24ae

data/README.md

@@ -34,6 +34,7 @@ backed by ActiveRecord models or by custom objects.
     * [Handling Exceptions] (#handling-exceptions)
     * [Action Callbacks] (#action-callbacks)
   * [Serializer] (#serializer)
+  * [Routing] (#routing)
 * [Configuration] (#configuration)
 * [Contributing] (#contributing)
 * [License] (#license)
@@ -114,7 +115,7 @@ generate routes for `index`, `show` and `show_relationship`.
 
 ###### Immutable for Readonly
 
-Some resources are read-only and are not to be modified through the API. Declaring a resource as immutable prevents 
+Some resources are read-only and are not to be modified through the API. Declaring a resource as immutable prevents
 creation of routes that allow modification of the resource.
 
 ###### Immutable Heterogeneous Collections
@@ -187,7 +188,7 @@ end
 ##### Fetchable Attributes
 
 By default all attributes are assumed to be fetchable. The list of fetchable attributes can be filtered by overriding
-the `self.fetchable_fields` method.
+the `fetchable_fields` method.
 
 Here's an example that prevents guest users from seeing the `email` field:
 
@@ -197,7 +198,7 @@ class AuthorResource < JSONAPI::Resource
   model_name 'Person'
   has_many :posts
 
-  def self.fetchable_fields(context)
+  def fetchable_fields
     if (context[:current_user].guest)
       super - [:email]
     else
@@ -365,7 +366,7 @@ end
 #### Model Hints
 
 Resource instances are created from model records. The determination of the correct resource type is performed using a
-simple rule based on the model's name. The name is used to find a resource in the same module (as the originating 
+simple rule based on the model's name. The name is used to find a resource in the same module (as the originating
 resource) that matches the name. This usually works quite well, however it can fail when model names do not match
 resource names. It can also fail when using namespaced models. In this case a `model_hint` can be created to map model
 names to resources. For example:
@@ -391,7 +392,7 @@ end
 ```
 
 Model hints inherit from parent resources, but are not global in scope. The `model_hint` method accepts `model` and
-`resource` named parameters. `model` takes an ActiveRecord class or class name (defaults to the model name), and 
+`resource` named parameters. `model` takes an ActiveRecord class or class name (defaults to the model name), and
 `resource` takes a resource type or a resource class (defaults to the current resource's type).
 
 #### Relationships
@@ -449,6 +450,7 @@ The relationship methods (`relationship`, `has_one`, and `has_many`) support the
  * `acts_as_set` - allows the entire set of related records to be replaced in one operation. Defaults to false if not set.
  * `polymorphic` - set to true to identify relationships that are polymorphic.
  * `relation_name` - the name of the relation to use on the model. A lambda may be provided which allows conditional selection of the relation based on the context.
+ * `always_include_linkage_data` - if set to true, the relationship includes linkage data. Defaults to false if not set.
 
 `to_one` relationships support the additional option:
  * `foreign_key_on` - defaults to `:self`. To indicate that the foreign key is on the related resource specify `:related`.
@@ -545,8 +547,8 @@ The default value is used as if it came from the request.
 ##### Applying Filters
 
 You may customize how a filter behaves by supplying a callable to the `:apply` option. This callable will be used to
-apply that filter. The callable is passed the `records`, which is an `ActiveRecord::Relation`, the `value`, and an 
-`_options` hash. It is expected to return an `ActiveRecord::Relation`. 
+apply that filter. The callable is passed the `records`, which is an `ActiveRecord::Relation`, the `value`, and an
+`_options` hash. It is expected to return an `ActiveRecord::Relation`.
 
 This example shows how you can implement different approaches for different filters.
 
@@ -580,7 +582,7 @@ end
 
 ##### Verifying Filters
 
-Because filters typically come straight from the request, it's prudent to verify their values. To do so, provide a 
+Because filters typically come straight from the request, it's prudent to verify their values. To do so, provide a
 callable to the `verify` option. This callable will be passed the `value` and the `context`. Verify should return the
 verified value, which may be modified.
 
@@ -599,7 +601,7 @@ verified value, which may be modified.
 
 Basic finding by filters is supported by resources. This is implemented in the `find` and `find_by_key` finder methods.
 Currently this is implemented for `ActiveRecord` based resources. The finder methods rely on the `records` method to get
-an `ActiveRecord::Relation` relation. It is therefore possible to override `records` to affect the three find related 
+an `ActiveRecord::Relation` relation. It is therefore possible to override `records` to affect the three find related
 methods.
 
 ###### Customizing base records for finder methods
@@ -641,7 +643,7 @@ end
 
 ```
 
-For example, you may want raise an error if the user is not authorized to view the related records. See the next
+For example, you may want to raise an error if the user is not authorized to view the related records. See the next
 section for additional details on raising errors.
 
 ```ruby
@@ -730,12 +732,12 @@ like to base the sorting on variables in your context.
 Example:
 
 ```ruby
-def self.apply_sort(records, order_options, context = {})  
+def self.apply_sort(records, order_options, context = {})
   if order_options.has?(:trending)
     records = records.order_by_trending_scope
     order_options - [:trending]
   end
-  
+
   super(records, order_options, context)
 end
 ```
@@ -921,7 +923,7 @@ end
 ```
 
 The `meta` method will be called for each resource instance. Override the `meta` method on a resource class to control
-the meta information for the resource. If a non empty hash is returned from `meta` this will be serialized. The `meta` 
+the meta information for the resource. If a non empty hash is returned from `meta` this will be serialized. The `meta`
 method is called with an `options` has. The `options` hash will contain the following:
 
  * `:serializer` -> the serializer instance
@@ -1041,6 +1043,10 @@ end
 
 Of course you are free to extend this as needed and override action handlers or other methods.
 
+A jsonapi-controller generator is avaliable
+```
+rails generate jsonapi:controller contact
+```
 
 ###### Context
 
@@ -1188,31 +1194,31 @@ Error codes are provided for each error object returned, based on the error. The
 
 ```ruby
 module JSONAPI
-  VALIDATION_ERROR = 100
-  INVALID_RESOURCE = 101
-  FILTER_NOT_ALLOWED = 102
-  INVALID_FIELD_VALUE = 103
-  INVALID_FIELD = 104
-  PARAM_NOT_ALLOWED = 105
-  PARAM_MISSING = 106
-  INVALID_FILTER_VALUE = 107
-  COUNT_MISMATCH = 108
-  KEY_ORDER_MISMATCH = 109
-  KEY_NOT_INCLUDED_IN_URL = 110
-  INVALID_INCLUDE = 112
-  RELATION_EXISTS = 113
-  INVALID_SORT_CRITERIA = 114
-  INVALID_LINKS_OBJECT = 115
-  TYPE_MISMATCH = 116
-  INVALID_PAGE_OBJECT = 117
-  INVALID_PAGE_VALUE = 118
-  INVALID_FIELD_FORMAT = 119
-  INVALID_FILTERS_SYNTAX = 120
-  SAVE_FAILED = 121
-  FORBIDDEN = 403
-  RECORD_NOT_FOUND = 404
-  UNSUPPORTED_MEDIA_TYPE = 415
-  LOCKED = 423
+  VALIDATION_ERROR = '100'
+  INVALID_RESOURCE = '101'
+  FILTER_NOT_ALLOWED = '102'
+  INVALID_FIELD_VALUE = '103'
+  INVALID_FIELD = '104'
+  PARAM_NOT_ALLOWED = '105'
+  PARAM_MISSING = '106'
+  INVALID_FILTER_VALUE = '107'
+  COUNT_MISMATCH = '108'
+  KEY_ORDER_MISMATCH = '109'
+  KEY_NOT_INCLUDED_IN_URL = '110'
+  INVALID_INCLUDE = '112'
+  RELATION_EXISTS = '113'
+  INVALID_SORT_CRITERIA = '114'
+  INVALID_LINKS_OBJECT = '115'
+  TYPE_MISMATCH = '116'
+  INVALID_PAGE_OBJECT = '117'
+  INVALID_PAGE_VALUE = '118'
+  INVALID_FIELD_FORMAT = '119'
+  INVALID_FILTERS_SYNTAX = '120'
+  SAVE_FAILED = '121'
+  FORBIDDEN = '403'
+  RECORD_NOT_FOUND = '404'
+  UNSUPPORTED_MEDIA_TYPE = '415'
+  LOCKED = '423'
 end
 ```
 
@@ -1368,7 +1374,158 @@ JSONAPI::ResourceSerializer.new(PostResource, include: include_resources,
 ).serialize_to_hash(PostResource.new(post, nil))
 ```
 
-#### Routing
+#### Formatting
+
+JR by default uses some simple rules to format (and unformat) an attribute for (de-)serialization. Strings and Integers are output to JSON
+as is, and all other values have `.to_s` applied to them. This outputs something in all cases, but it is certainly not
+correct for every situation.
+
+If you want to change the way an attribute is (de-)serialized you have a couple of ways. The simplest method is to create a
+getter (and setter) method on the resource which overrides the attribute and apply the (un-)formatting there. For example:
+
+```ruby
+class PersonResource < JSONAPI::Resource
+  attributes :name, :email, :last_login_time
+
+  # Setter example
+  def email=(new_email)
+    @model.email = new_email.downcase
+  end
+
+  # Getter example
+  def last_login_time
+    @model.last_login_time.in_time_zone(@context[:current_user].time_zone).to_s
+  end
+end
+```
+
+This is simple to implement for a one off situation, but not for example if you want to apply the same formatting rules
+to all DateTime fields in your system. Another issue is the attribute on the resource will always return a formatted
+response, whether you want it or not.
+
+##### Value Formatters
+
+To overcome the above limitations JR uses Value Formatters. Value Formatters allow you to control the way values are
+handled for an attribute. The `format` can be set per attribute as it is declared in the resource. For example:
+
+```ruby
+class PersonResource < JSONAPI::Resource
+  attributes :name, :email, :spoken_languages
+  attribute :last_login_time, format: :date_with_utc_timezone
+
+  # Getter/Setter for spoken_languages ...
+end
+```
+
+A Value formatter has a `format` and an `unformat` method. Here's the base ValueFormatter and DefaultValueFormatter for
+reference:
+
+```ruby
+module JSONAPI
+  class ValueFormatter < Formatter
+    class << self
+      def format(raw_value)
+        super(raw_value)
+      end
+
+      def unformat(value)
+        super(value)
+      end
+      ...
+    end
+  end
+end
+
+class DefaultValueFormatter < JSONAPI::ValueFormatter
+  class << self
+    def format(raw_value)
+      case raw_value
+        when String, Integer
+          return raw_value
+        else
+          return raw_value.to_s
+      end
+    end
+  end
+end
+```
+
+You can also create your own Value Formatter. Value Formatters must be named with the `format` name followed by
+`ValueFormatter`, i.e. `DateWithUTCTimezoneValueFormatter` and derive from `JSONAPI::ValueFormatter`. It is
+recommended that you create a directory for your formatters, called `formatters`.
+
+The `format` method is called by the `ResourceSerializer` as is serializing a resource. The format method takes the
+`raw_value` parameter. `raw_value` is the value as read from the model.
+
+The `unformat` method is called when processing the request. Each incoming attribute (except `links`) are run through
+the `unformat` method. The `unformat` method takes a `value`, which is the value as it comes in on the
+request. This allows you process the incoming value to alter its state before it is stored in the model.
+
+###### Use a Different Default Value Formatter
+
+Another way to handle formatting is to set a different default value formatter. This will affect all attributes that do
+not have a `format` set. You can do this by overriding the `default_attribute_options` method for a resource (or a base
+resource for a system wide change).
+
+```ruby
+  def default_attribute_options
+    {format: :my_default}
+  end
+```
+
+and
+
+```ruby
+class MyDefaultValueFormatter < JSONAPI::ValueFormatter
+  class << self
+    def format(raw_value)
+      case raw_value
+        when String, Integer
+          return raw_value
+        when DateTime
+          return raw_value.in_time_zone('UTC').to_s
+        else
+          return raw_value.to_s
+      end
+    end
+  end
+end
+```
+
+This way all DateTime values will be formatted to display in the UTC timezone.
+
+#### Key Format
+
+By default JR uses dasherized keys as per the
+[JSON API naming recommendations](http://jsonapi.org/recommendations/#naming).  This can be changed by specifying a
+different key formatter.
+
+For example, to use camel cased keys with an initial lowercase character (JSON's default) create an initializer and add
+the following:
+
+```ruby
+JSONAPI.configure do |config|
+  # built in key format options are :underscored_key, :camelized_key and :dasherized_key
+  config.json_key_format = :camelized_key
+end
+```
+
+This will cause the serializer to use the `CamelizedKeyFormatter`. You can also create your own `KeyFormatter`, for
+example:
+
+```ruby
+class UpperCamelizedKeyFormatter < JSONAPI::KeyFormatter
+  class << self
+    def format(key)
+      super.camelize(:upper)
+    end
+  end
+end
+```
+
+You would specify this in `JSONAPI.configure` as `:upper_camelized`.
+
+### Routing
 
 JR has a couple of helper methods available to assist you with setting up routes.
 
@@ -1535,157 +1692,6 @@ phone_number_contact GET    /phone-numbers/:phone_number_id/contact(.:format) co
 
 ```
 
-#### Formatting
-
-JR by default uses some simple rules to format (and unformat) an attribute for (de-)serialization. Strings and Integers are output to JSON
-as is, and all other values have `.to_s` applied to them. This outputs something in all cases, but it is certainly not
-correct for every situation.
-
-If you want to change the way an attribute is (de-)serialized you have a couple of ways. The simplest method is to create a
-getter (and setter) method on the resource which overrides the attribute and apply the (un-)formatting there. For example:
-
-```ruby
-class PersonResource < JSONAPI::Resource
-  attributes :name, :email, :last_login_time
-
-  # Setter example
-  def email=(new_email)
-    @model.email = new_email.downcase
-  end
-
-  # Getter example
-  def last_login_time
-    @model.last_login_time.in_time_zone(@context[:current_user].time_zone).to_s
-  end
-end
-```
-
-This is simple to implement for a one off situation, but not for example if you want to apply the same formatting rules
-to all DateTime fields in your system. Another issue is the attribute on the resource will always return a formatted
-response, whether you want it or not.
-
-##### Value Formatters
-
-To overcome the above limitations JR uses Value Formatters. Value Formatters allow you to control the way values are
-handled for an attribute. The `format` can be set per attribute as it is declared in the resource. For example:
-
-```ruby
-class PersonResource < JSONAPI::Resource
-  attributes :name, :email, :spoken_languages
-  attribute :last_login_time, format: :date_with_utc_timezone
-
-  # Getter/Setter for spoken_languages ...
-end
-```
-
-A Value formatter has a `format` and an `unformat` method. Here's the base ValueFormatter and DefaultValueFormatter for
-reference:
-
-```ruby
-module JSONAPI
-  class ValueFormatter < Formatter
-    class << self
-      def format(raw_value)
-        super(raw_value)
-      end
-
-      def unformat(value)
-        super(value)
-      end
-      ...
-    end
-  end
-end
-
-class DefaultValueFormatter < JSONAPI::ValueFormatter
-  class << self
-    def format(raw_value)
-      case raw_value
-        when String, Integer
-          return raw_value
-        else
-          return raw_value.to_s
-      end
-    end
-  end
-end
-```
-
-You can also create your own Value Formatter. Value Formatters must be named with the `format` name followed by
-`ValueFormatter`, i.e. `DateWithUTCTimezoneValueFormatter` and derive from `JSONAPI::ValueFormatter`. It is
-recommended that you create a directory for your formatters, called `formatters`.
-
-The `format` method is called by the `ResourceSerializer` as is serializing a resource. The format method takes the
-`raw_value` parameter. `raw_value` is the value as read from the model.
-
-The `unformat` method is called when processing the request. Each incoming attribute (except `links`) are run through
-the `unformat` method. The `unformat` method takes a `value`, which is the value as it comes in on the
-request. This allows you process the incoming value to alter its state before it is stored in the model.
-
-###### Use a Different Default Value Formatter
-
-Another way to handle formatting is to set a different default value formatter. This will affect all attributes that do
-not have a `format` set. You can do this by overriding the `default_attribute_options` method for a resource (or a base
-resource for a system wide change).
-
-```ruby
-  def default_attribute_options
-    {format: :my_default}
-  end
-```
-
-and
-
-```ruby
-class MyDefaultValueFormatter < JSONAPI::ValueFormatter
-  class << self
-    def format(raw_value)
-      case raw_value
-        when String, Integer
-          return raw_value
-        when DateTime
-          return raw_value.in_time_zone('UTC').to_s
-        else
-          return raw_value.to_s
-      end
-    end
-  end
-end
-```
-
-This way all DateTime values will be formatted to display in the UTC timezone.
-
-#### Key Format
-
-By default JR uses dasherized keys as per the
-[JSON API naming recommendations](http://jsonapi.org/recommendations/#naming).  This can be changed by specifying a
-different key formatter.
-
-For example, to use camel cased keys with an initial lowercase character (JSON's default) create an initializer and add
-the following:
-
-```ruby
-JSONAPI.configure do |config|
-  # built in key format options are :underscored_key, :camelized_key and :dasherized_key
-  config.json_key_format = :camelized_key
-end
-```
-
-This will cause the serializer to use the `CamelizedKeyFormatter`. You can also create your own `KeyFormatter`, for
-example:
-
-```ruby
-class UpperCamelizedKeyFormatter < JSONAPI::KeyFormatter
-  class << self
-    def format(key)
-      super.camelize(:upper)
-    end
-  end
-end
-```
-
-You would specify this in `JSONAPI.configure` as `:upper_camelized`.
-
 ## Configuration
 
 JR has a few configuration options. Some have already been mentioned above. To set configuration options create an