jsonapi-resources 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f70ae71e6004b279c357d07b852d3be4eebc03d6
-  data.tar.gz: bc3fc2fae00f4e4d3a5c6d602bc42659181d7a02
+  metadata.gz: 3e063aecb3183d3a1862dc4fd88f0f06ddc921dd
+  data.tar.gz: 40b0476410fe269a08f16791f8b927d2aee02156
 SHA512:
-  metadata.gz: bfb971dee293f36ba1e4a78f6b5db0e9d7a4dbe4be1b38cd66fcb183aefb0935497472e3e1ea72a3ca41be551b96de887dd00c3a323814c8b16b1ad9b03a2e64
-  data.tar.gz: c2c3b13c7c58ee1a7b7a4e1c029477965a927413910944fb9f8837f5faec61af765198a1da618ee493431e12a7eea402b53e8368998f68344eb5eb36b7f1c7d3
+  metadata.gz: f4135619c0ad660679b93ea9dcde314991134824e0d01540705b4a3055e0acccfab76d74b0e49cf94d969d949063a51c50328165265b90b2057065ec34b13eb3
+  data.tar.gz: 335f3f2b30251c07b2286dbdcd176d3f199fd844d99f6c9619a0b54e598b66e0fe07b1386cddb1c18106b3e1d968e6a6a1f5eaabb11e3cc72d75d08bf54581ae

data/README.md

@@ -145,13 +145,13 @@ end
 
 The system will lookup a value formatter named `DateWithTimezoneValueFormatter` and will use this when serializing and updating the attribute. See the [Value Formatters](#value-formatters) section for more details.
 
-#### Key
+#### Primary Key
 
-The primary key of the resource defaults to `id`, which can be changed using the `key` method.
+Resources are always represented using a key of `id`. If the underlying model does not use `id` as the primary key you can use the `primary_key` method to tell the resource which field on the model to use as the primary key. Note: this doesn't have to be the actual primary key of the model. For example you may wish to use integers internally and a different scheme publicly.
 
 ```ruby
 class CurrencyResource < JSONAPI::Resource
-  key :code
+  primary_key :code
   attributes :code, :name
 
   has_many :expense_entries
@@ -199,8 +199,7 @@ end
 
 The association methods support the following options:
  * `class_name` - a string specifying the underlying class for the related resource
- * `primary_key` - the primary key to the related resource, if different than `id`
- * `key` - the key in the resource that identifies the related resource, if different than `<resource_name>_id`
+ * `foreign_key` - the method on the resource used to fetch the related resource. Defaults to `<resource_name>_id` for has_one and `<resource_name>_ids` for has_many relationships.
  * `acts_as_set` - allows the entire set of related records to be replaced in one operation. Defaults to false if not set.
 
 Examples:

data/lib/jsonapi-resources.rb

@@ -1,4 +1,5 @@
 require 'jsonapi/resource'
 require 'jsonapi/resources/version'
 require 'jsonapi/configuration'
-require 'jsonapi/formatter'
+require 'jsonapi/formatter'
+require 'jsonapi/routing_ext'

data/lib/jsonapi/association.rb

@@ -1,13 +1,24 @@
 module JSONAPI
   class Association
-    attr_reader :primary_key, :acts_as_set, :type, :key, :options, :name, :class_name
+    attr_reader :acts_as_set, :foreign_key, :type, :options, :name, :class_name
 
     def initialize(name, options={})
-      @name          = name.to_s
-      @options       = options
-      @key           = options[:key] ? options[:key].to_sym : nil
-      @primary_key   = options.fetch(:primary_key, 'id').to_sym
-      @acts_as_set   = options.fetch(:acts_as_set, false) == true
+      @name                = name.to_s
+      @options             = options
+      @acts_as_set         = options.fetch(:acts_as_set, false) == true
+      @key                 = options[:key] ? options[:key].to_sym : nil
+
+      if @key.nil?
+        @foreign_key  = options[:foreign_key ] ? options[:foreign_key ].to_sym : nil
+      else
+        # :nocov:
+        warn '[DEPRECATION] `key` is deprecated in associations.  Please use `foreign_key` instead.'
+        # :nocov:
+      end
+    end
+
+    def primary_key
+      @primary_key ||= Resource.resource_for(@name)._primary_key
     end
 
     class HasOne < Association
@@ -15,7 +26,7 @@ module JSONAPI
         super
         @class_name = options.fetch(:class_name, name.to_s.capitalize)
         @type = class_name.underscore.pluralize.to_sym
-        @key ||= "#{name}_id".to_sym
+        @foreign_key ||= @key.nil? ? "#{name}_id".to_sym : @key
       end
     end
 
@@ -24,7 +35,7 @@ module JSONAPI
         super
         @class_name = options.fetch(:class_name, name.to_s.capitalize.singularize)
         @type = class_name.underscore.pluralize.to_sym
-        @key ||= "#{name.to_s.singularize}_ids".to_sym
+        @foreign_key  ||= @key.nil? ? "#{name.to_s.singularize}_ids".to_sym : @key
       end
     end
   end

data/lib/jsonapi/formatter.rb

@@ -9,6 +9,7 @@ module JSONAPI
         arg
       end
 
+      # :nocov:
       if RUBY_VERSION >= '2.0'
         def formatter_for(format)
           formatter_class_name = "#{format.to_s.camelize}Formatter"
@@ -20,6 +21,7 @@ module JSONAPI
           formatter_class_name.safe_constantize if formatter_class_name
         end
       end
+      # :nocov:
     end
   end
 

data/lib/jsonapi/request.rb

@@ -298,31 +298,31 @@ module JSONAPI
     def parse_replace_operation(params)
       object_params_raw = params.require(format_key(@resource_klass._type))
 
-      keys = params[@resource_klass._key]
+      keys = params[@resource_klass._primary_key]
       if object_params_raw.is_a?(Array)
         if keys.count != object_params_raw.count
           raise JSONAPI::Exceptions::CountMismatch
         end
 
         object_params_raw.each do |object_params|
-          if object_params[@resource_klass._key].nil?
+          if object_params[@resource_klass._primary_key].nil?
             raise JSONAPI::Exceptions::MissingKey.new
           end
 
-          if !keys.include?(object_params[@resource_klass._key])
-            raise JSONAPI::Exceptions::KeyNotIncludedInURL.new(object_params[@resource_klass._key])
+          if !keys.include?(object_params[@resource_klass._primary_key])
+            raise JSONAPI::Exceptions::KeyNotIncludedInURL.new(object_params[@resource_klass._primary_key])
           end
           @operations.push JSONAPI::ReplaceFieldsOperation.new(@resource_klass,
-                                                               object_params[@resource_klass._key],
+                                                               object_params[@resource_klass._primary_key],
                                                                parse_params(object_params, @resource_klass.updateable_fields(@context)))
         end
       else
-        if !object_params_raw[@resource_klass._key].nil? && keys != object_params_raw[@resource_klass._key]
-          raise JSONAPI::Exceptions::KeyNotIncludedInURL.new(object_params_raw[@resource_klass._key])
+        if !object_params_raw[@resource_klass._primary_key].nil? && keys != object_params_raw[@resource_klass._primary_key]
+          raise JSONAPI::Exceptions::KeyNotIncludedInURL.new(object_params_raw[@resource_klass._primary_key])
         end
 
         @operations.push JSONAPI::ReplaceFieldsOperation.new(@resource_klass,
-                                                               params[@resource_klass._key],
+                                                               params[@resource_klass._primary_key],
                                                                parse_params(object_params_raw, @resource_klass.updateable_fields(@context)))
       end
 
@@ -333,7 +333,7 @@ module JSONAPI
     end
 
     def parse_remove_operation(params)
-      keys = parse_key_array(params.permit(@resource_klass._key)[@resource_klass._key])
+      keys = parse_key_array(params.permit(@resource_klass._primary_key)[@resource_klass._primary_key])
 
       keys.each do |key|
         @operations.push JSONAPI::RemoveResourceOperation.new(@resource_klass, key)

data/lib/jsonapi/resource.rb

@@ -20,6 +20,10 @@ module JSONAPI
       @model.destroy
     end
 
+    def id
+      model.send(self.class._primary_key)
+    end
+
     def create_has_many_link(association_type, association_key_value)
       association = self.class._associations[association_type]
       related_resource = self.class.resource_for(association.type).find_by_key(association_key_value, @context)
@@ -36,16 +40,16 @@ module JSONAPI
     def replace_has_many_links(association_type, association_key_values)
       association = self.class._associations[association_type]
 
-      @model.send("#{association.key}=", association_key_values)
+      send("#{association.foreign_key}=", association_key_values)
     end
 
     def create_has_one_link(association_type, association_key_value)
       association = self.class._associations[association_type]
 
       # ToDo: Add option to skip relations that already exist instead of returning an error?
-      relation = @model.send("#{association.key}")
+      relation = @model.send("#{association.foreign_key}")
       if relation.nil?
-        @model.send("#{association.key}=", association_key_value)
+        send("#{association.foreign_key}=", association_key_value)
       else
         raise JSONAPI::Exceptions::HasOneRelationExists.new
       end
@@ -54,7 +58,7 @@ module JSONAPI
     def replace_has_one_link(association_type, association_key_value)
       association = self.class._associations[association_type]
 
-      @model.send("#{association.key}=", association_key_value)
+      send("#{association.foreign_key}=", association_key_value)
     end
 
     def remove_has_many_link(association_type, key)
@@ -66,12 +70,18 @@ module JSONAPI
     def remove_has_one_link(association_type)
       association = self.class._associations[association_type]
 
-      @model.send("#{association.key}=", nil)
+      send("#{association.foreign_key}=", nil)
     end
 
     def replace_fields(field_data)
       field_data[:attributes].each do |attribute, value|
-        send "#{attribute}=", value
+        begin
+          send "#{attribute}=", value
+        rescue ArgumentError
+          # :nocov: Will be thrown if an enum value isn't allowed for an enum. Currently not tested as enums are a rails 4.1 and higher feature
+          raise JSONAPI::Exceptions::InvalidFieldValue.new(attribute, value)
+          # :nocov:
+        end
       end
 
       field_data[:has_one].each do |association_type, value|
@@ -184,7 +194,14 @@ module JSONAPI
       end
 
       def key(key)
-        @_key = key.to_sym
+        # :nocov:
+        warn '[DEPRECATION] `key` is deprecated.  Please use `primary_key` instead.'
+        @_primary_key = key.to_sym
+        # :nocov:
+      end
+
+      def primary_key(key)
+        @_primary_key = key.to_sym
       end
 
       # Override in your resource to filter the updateable keys
@@ -212,7 +229,7 @@ module JSONAPI
               includes.push(filter)
               where_filters["#{filter}.#{_associations[filter].primary_key}"] = value
             else
-              where_filters["#{_associations[filter].key}"] = value
+              where_filters["#{_associations[filter].foreign_key}"] = value
             end
           else
             where_filters[filter] = value
@@ -228,7 +245,7 @@ module JSONAPI
       end
 
       def find_by_key(key, context = nil)
-        model = _model_class.where({_key => key}).first
+        model = _model_class.where({_primary_key => key}).first
         if model.nil?
           raise JSONAPI::Exceptions::RecordNotFound.new(key)
         end
@@ -305,15 +322,22 @@ module JSONAPI
       end
 
       def _key
-        @_key ||= :id
+        # :nocov:
+        warn '[DEPRECATION] `_key` is deprecated.  Please use `_primary_key` instead.'
+        _primary_key
+        # :nocov:
+      end
+
+      def _primary_key
+        @_primary_key ||= :id
       end
 
       def _as_parent_key
-        @_as_parent_key ||= "#{_type.to_s.singularize}_#{_key}"
+        @_as_parent_key ||= "#{_type.to_s.singularize}_#{_primary_key}"
       end
 
       def _allowed_filters
-        !@_allowed_filters.nil? ? @_allowed_filters : Set.new([_key])
+        !@_allowed_filters.nil? ? @_allowed_filters : Set.new([_primary_key])
       end
 
       def _resource_name_from_type(type)
@@ -325,15 +349,17 @@ module JSONAPI
         return class_name
       end
 
+      # :nocov:
       if RUBY_VERSION >= '2.0'
         def _model_class
-          @model ||= Object.const_get(_model_name)
+          @model ||= Object.const_get(_model_name.to_s)
         end
       else
         def _model_class
           @model ||= _model_name.to_s.safe_constantize
         end
       end
+      # :nocov:
 
       def _allowed_filter?(filter)
         _allowed_filters.include?(filter)
@@ -347,29 +373,27 @@ module JSONAPI
         attrs.each do |attr|
           @_associations[attr] = klass.new(attr, options)
 
-          if @_associations[attr].is_a?(JSONAPI::Association::HasOne)
-            key = @_associations[attr].key
+          foreign_key = @_associations[attr].foreign_key
+
+          define_method foreign_key do
+            @model.method(foreign_key).call
+          end unless method_defined?(foreign_key)
 
-            define_method key do
-              @model.method(key).call
-            end unless method_defined?(key)
+          define_method "#{foreign_key}=" do |value|
+            @model.method("#{foreign_key}=").call(value)
+          end unless method_defined?("#{foreign_key}=")
 
-            define_method "_#{attr}_resource" do
+          if @_associations[attr].is_a?(JSONAPI::Association::HasOne)
+            define_method attr do
               type_name = self.class._associations[attr].type
               resource_class = self.class.resource_for(type_name)
               if resource_class
                 associated_model = @model.send attr
                 return resource_class.new(associated_model, @context)
               end
-            end unless method_defined?("_#{attr}_resource")
+            end unless method_defined?(attr)
           elsif @_associations[attr].is_a?(JSONAPI::Association::HasMany)
-            key = @_associations[attr].key
-
-            define_method key do
-              @model.method(key).call
-            end unless method_defined?(key)
-
-            define_method "_#{attr}_resources" do
+            define_method attr do
               type_name = self.class._associations[attr].type
               resource_class = self.class.resource_for(type_name)
               resources = []
@@ -380,7 +404,7 @@ module JSONAPI
                 end
               end
               return resources
-            end unless method_defined?("_#{attr}_resources")
+            end unless method_defined?(attr)
           end
         end
       end

data/lib/jsonapi/resource_controller.rb

@@ -27,7 +27,7 @@ module JSONAPI
     end
 
     def show
-      keys = parse_key_array(params[resource_klass._key])
+      keys = parse_key_array(params[resource_klass._primary_key])
 
       if keys.length > 1
         resources = []
@@ -56,9 +56,11 @@ module JSONAPI
       parent_resource = resource_klass.find_by_key(parent_key, context)
 
       association = resource_klass._association(association_type)
-      render json: { association_type => parent_resource.send(association.key)}
+      render json: { association_type => parent_resource.send(association.foreign_key)}
     rescue => e
+      # :nocov:
       handle_exceptions(e)
+      # :nocov:
     end
 
     def create
@@ -91,6 +93,7 @@ module JSONAPI
     end
 
     private
+    # :nocov:
     if RUBY_VERSION >= '2.0'
       def resource_klass
         @resource_klass ||= Object.const_get resource_klass_name
@@ -100,6 +103,7 @@ module JSONAPI
         @resource_klass ||= resource_klass_name.safe_constantize
       end
     end
+    # :nocov:
 
     def resource_klass_name
       @resource_klass_name ||= "#{self.class.name.demodulize.sub(/Controller$/, '').singularize}Resource"
@@ -112,7 +116,9 @@ module JSONAPI
       })
       render_errors(@request.errors) unless @request.errors.empty?
     rescue => e
+      # :nocov:
       handle_exceptions(e)
+      # :nocov:
     end
 
     def parse_key_array(raw)
@@ -187,7 +193,9 @@ module JSONAPI
         when JSONAPI::Exceptions::Error
           render_errors(e.errors)
         else # raise all other exceptions
+          # :nocov:
           raise e
+          # :nocov:
       end
     end
   end

data/lib/jsonapi/resource_for.rb

@@ -5,6 +5,7 @@ module JSONAPI
     end
 
     module ClassMethods
+      # :nocov:
       if RUBY_VERSION >= '2.0'
         def resource_for(type)
           resource_name = JSONAPI::Resource._resource_name_from_type(type)
@@ -18,6 +19,7 @@ module JSONAPI
           resource_name.safe_constantize if resource_name
         end
       end
+      # :nocov:
     end
   end
 end

data/lib/jsonapi/resource_serializer.rb

@@ -91,16 +91,17 @@ module JSONAPI
     # The fields options controls both fields and included links references.
     def process_primary(source, requested_associations)
       if source.respond_to?(:to_ary)
-        source.each do |object|
-          id = object.send(object.class._key)
+        source.each do |resource|
+          id = resource.id
           if already_serialized?(@primary_class_name, id)
             set_primary(@primary_class_name, id)
           end
 
-          add_linked_object(@primary_class_name, id, object_hash(object,  requested_associations), true)
+          add_linked_object(@primary_class_name, id, object_hash(resource,  requested_associations), true)
         end
       else
-        id = source.send(source.class._key)
+        resource = source
+        id = resource.id
         # ToDo: See if this is actually needed
         # if already_serialized?(@primary_class_name, id)
         #   set_primary(@primary_class_name, id)
@@ -151,10 +152,10 @@ module JSONAPI
       included_associations = source.fetchable_fields & associations.keys
       associations.each_with_object({}) do |(name, association), hash|
         if included_associations.include? name
-          key = association.key
+          foreign_key = association.foreign_key
 
           if field_set.include?(name)
-            hash[format_key(name)] = source.send(key)
+            hash[format_key(name)] = source.send(foreign_key)
           end
 
           ia = requested_associations.is_a?(Hash) ? requested_associations[name] : nil
@@ -169,9 +170,9 @@ module JSONAPI
           # through the associations.
           if include_linked_object || include_linked_children
             if association.is_a?(JSONAPI::Association::HasOne)
-              resource = source.send("_#{name}_resource")
+              resource = source.send(name)
               if resource
-                id = resource.send(association.primary_key)
+                id = resource.id
                 associations_only = already_serialized?(type, id)
                 if include_linked_object && !associations_only
                   add_linked_object(type, id, object_hash(resource, ia[:include_related]))
@@ -180,9 +181,9 @@ module JSONAPI
                 end
               end
             elsif association.is_a?(JSONAPI::Association::HasMany)
-              resources = source.send("_#{name}_resources")
+              resources = source.send(name)
               resources.each do |resource|
-                id = resource.send(association.primary_key)
+                id = resource.id
                 associations_only = already_serialized?(type, id)
                 if include_linked_object && !associations_only
                   add_linked_object(type, id, object_hash(resource, ia[:include_related]))

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.0.7"
+    VERSION = "0.0.8"
   end
 end

data/lib/jsonapi/routing_ext.rb

@@ -7,6 +7,7 @@ module ActionDispatch
           options = resources.extract_options!.dup
 
           res = JSONAPI::Resource.resource_for(resource_type)
+
           resource resource_type, options.merge(res.routing_resource_options) do
             @scope[:jsonapi_resource] = resource_type
 
@@ -29,6 +30,10 @@ module ActionDispatch
           options = resources.extract_options!.dup
 
           res = JSONAPI::Resource.resource_for(resource_type)
+
+          # Route using the primary_key. Can be overridden using routing_resource_options
+          options.merge!(param: res._primary_key)
+
           resources resource_type, options.merge(res.routing_resource_options) do
             @scope[:jsonapi_resource] = resource_type
 

data/test/controllers/controller_test.rb

@@ -1001,7 +1001,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
 
   def test_expense_entries_show_fields_type_many
     get :show, {id: 1, include: 'isoCurrency,employee', 'fields' => {'expenseEntries' => 'transactionDate',
-                                                                     'isoCurrencies' => 'code,name'}}
+                                                                     'isoCurrencies' => 'id,name'}}
     assert_response :success
     assert json_response['expenseEntries'].is_a?(Hash)
     assert json_response['expenseEntries'].has_key?('transactionDate')
@@ -1009,7 +1009,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
     refute json_response['expenseEntries'].has_key?('links')
     assert_equal 1, json_response['linked']['isoCurrencies'].size
     assert_equal 1, json_response['linked']['people'].size
-    assert json_response['linked']['isoCurrencies'][0].has_key?('code')
+    assert json_response['linked']['isoCurrencies'][0].has_key?('id')
     assert json_response['linked']['isoCurrencies'][0].has_key?('name')
     refute json_response['linked']['isoCurrencies'][0].has_key?('countryName')
   end

data/test/fixtures/active_record.rb

@@ -398,17 +398,15 @@ class PostResource < JSONAPI::Resource
 end
 
 class IsoCurrencyResource < JSONAPI::Resource
-  key :code
-  attributes :code, :name, :country_name, :minor_unit
-
-  routing_options :param => :code
+  primary_key :code
+  attributes :id, :name, :country_name, :minor_unit
 end
 
 class ExpenseEntryResource < JSONAPI::Resource
   attributes :id, :cost
   attribute :transaction_date, format: :date
 
-  has_one :iso_currency, key: 'currency_code', primary_key: 'code'
+  has_one :iso_currency, foreign_key: 'currency_code'
   has_one :employee, class_name: 'Person'
 end
 
@@ -416,6 +414,9 @@ class BreedResource < JSONAPI::Resource
   attribute :id, format_misspelled: :does_not_exist
   attribute :name, format: :title
 
+  # This is unneeded, just here for testing
+  routing_options :param => :id
+
   def self.find(attrs, context = nil)
     breeds = []
     $breed_data.breeds.values.each do |breed|

data/test/helpers/hash_helpers.rb

@@ -1,5 +1,6 @@
 module Helpers
   module HashHelpers
+    # :nocov:
     def assert_hash_contains(exp, act, msg = nil)
       msg = message(msg, '') { diff exp, act }
       assert(matches_hash?(exp, act), msg)
@@ -9,5 +10,6 @@ module Helpers
       msg = message(msg, '') { diff exp, act }
       assert(matches_hash?(exp, act, {exact: true}), msg)
     end
+    # :nocov:
   end
-end
+end

data/test/integration/routes/routes_test.rb

@@ -111,6 +111,12 @@ class RoutesTest < ActionDispatch::IntegrationTest
                    {action: 'show', controller: 'api/v3/posts', id: '1'})
   end
 
+  #primary_key
+  def test_routing_primary_key_jsonapi_resources
+    assert_routing({path: '/iso_currencies/USD', method: :get},
+                   {action: 'show', controller: 'iso_currencies', code: 'USD'})
+  end
+
   # ToDo: Refute routing
   # def test_routing_v3_posts_delete
   #   assert_routing({ path: '/api/v3/posts/1', method: :delete },

data/test/unit/serializer/serializer_test.rb

@@ -507,7 +507,7 @@ class SerializerTest < MiniTest::Unit::TestCase
         },
         linked: {
           isoCurrencies: [{
-                            code: 'USD',
+                            id: 'USD',
                             countryName: 'United States',
                             name: 'United States Dollar',
                             minorUnit: 'cent'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler