jsonapi-resources 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c58427d88b5c0bbe33915d8039ac02a1f6ea260b
-  data.tar.gz: 62dcacd2190abc5bffe3a10cefe1bba9d50a56b7
+  metadata.gz: 5f77e572b55d7703ae7464eb2cc9d90c6d70a9c7
+  data.tar.gz: 0d7e83c12752c0956068b8e6087174518d27ef8d
 SHA512:
-  metadata.gz: 5ae8e6c9e4c87a8b5848110cd2acd98f98b6a1ab202edd83b62aabd9806df7880d4345a1678b551ed054706aaae14227261f07f9dce77161e3dbf260dcf1236c
-  data.tar.gz: 1d528f86653c12a040dbb52b1db0d0f8affbf7b11440ceb0a75e3eae17d70a219872cbbb34d7fcb7ad3d04ccd366921ba146f00023a7b0910a4e74ae5f40c86a
+  metadata.gz: 060bbad86c169a604f0a98f316023fa8d632fd3df406a35b37bf7c4db2d7d770b74c5172aa3270a70a04a091e5126a291f2517d586ee5a32d0f198372e353b27
+  data.tar.gz: 3c58a190c4d755d322c6643f00450a65308ee21c514ae1c89cd466f8e4adfa20976ab1fbd115c5dcb31d4c352ad5afae932fbf3ca0e030027cd32c75eae524f8

data/README.md

@@ -781,7 +781,15 @@ edit_contact GET    /contacts/:id/edit(.:format) contacts#edit
 ```
 
 To manually add in the nested routes you can use the `jsonapi_links`, `jsonapi_related_resources` and
-`jsonapi_related_resource` inside the block.
+`jsonapi_related_resource` inside the block. Or, you can add the default set of nested routes using the `jsonapi_relationships` method. For example:
+
+```ruby
+Rails.application.routes.draw do
+  jsonapi_resources :contacts do
+    jsonapi_relationships
+  end
+end
+```
 
 ###### `jsonapi_links`
 

data/lib/jsonapi/configuration.rb

@@ -9,7 +9,8 @@ module JSONAPI
                 :allowed_request_params,
                 :default_paginator,
                 :default_page_size,
-                :maximum_page_size
+                :maximum_page_size,
+                :use_text_errors
 
     def initialize
       #:underscored_key, :camelized_key, :dasherized_key, or custom
@@ -25,6 +26,7 @@ module JSONAPI
 
       self.default_page_size = 10
       self.maximum_page_size = 20
+      self.use_text_errors = false
     end
 
     def json_key_format=(format)
@@ -52,6 +54,10 @@ module JSONAPI
     def maximum_page_size=(maximum_page_size)
       @maximum_page_size = maximum_page_size
     end
+
+    def use_text_errors=(use_text_errors)
+      @use_text_errors = use_text_errors
+    end
   end
 
   class << self

data/lib/jsonapi/error.rb

@@ -8,10 +8,14 @@ module JSONAPI
       @detail         = options[:detail]
       @id             = options[:id]
       @href           = options[:href]
-      @code           = options[:code]
+      @code           = if JSONAPI.configuration.use_text_errors
+                          TEXT_ERRORS[options[:code]]
+                        else
+                          options[:code]
+                        end
       @path           = options[:path]
       @links          = options[:links]
       @status         = options[:status]
     end
   end
-end
+end

data/lib/jsonapi/error_codes.rb

@@ -23,4 +23,30 @@ module JSONAPI
   RECORD_NOT_FOUND = 404
   UNSUPPORTED_MEDIA_TYPE = 415
   LOCKED = 423
+
+  TEXT_ERRORS =
+    { VALIDATION_ERROR => 'VALIDATION_ERROR',
+      INVALID_RESOURCE => 'INVALID_RESOURCE',
+      FILTER_NOT_ALLOWED => 'FILTER_NOT_ALLOWED',
+      INVALID_FIELD_VALUE => 'INVALID_FIELD_VALUE',
+      INVALID_FIELD => 'INVALID_FIELD',
+      PARAM_NOT_ALLOWED => 'PARAM_NOT_ALLOWED',
+      PARAM_MISSING => 'PARAM_MISSING',
+      INVALID_FILTER_VALUE => 'INVALID_FILTER_VALUE',
+      COUNT_MISMATCH => 'COUNT_MISMATCH',
+      KEY_ORDER_MISMATCH => 'KEY_ORDER_MISMATCH',
+      KEY_NOT_INCLUDED_IN_URL => 'KEY_NOT_INCLUDED_IN_URL',
+      INVALID_INCLUDE => 'INVALID_INCLUDE',
+      RELATION_EXISTS => 'RELATION_EXISTS',
+      INVALID_SORT_CRITERIA => 'INVALID_SORT_CRITERIA',
+      INVALID_LINKS_OBJECT => 'INVALID_LINKS_OBJECT',
+      TYPE_MISMATCH => 'TYPE_MISMATCH',
+      INVALID_PAGE_OBJECT => 'INVALID_PAGE_OBJECT',
+      INVALID_PAGE_VALUE => 'INVALID_PAGE_VALUE',
+      INVALID_SORT_FORMAT => 'INVALID_SORT_FORMAT',
+      INVALID_FIELD_FORMAT => 'INVALID_FIELD_FORMAT',
+      FORBIDDEN => 'FORBIDDEN',
+      RECORD_NOT_FOUND => 'RECORD_NOT_FOUND',
+      UNSUPPORTED_MEDIA_TYPE => 'UNSUPPORTED_MEDIA_TYPE',
+      LOCKED => 'LOCKED' }
 end

data/lib/jsonapi/request.rb

@@ -233,7 +233,7 @@ module JSONAPI
       end
 
       {
-        type: raw['type'],
+        type: unformat_key(raw['type']).to_s,
         id: raw['id']
       }
     end
@@ -281,12 +281,12 @@ module JSONAPI
               # Since we do not yet support polymorphic associations we will raise an error if the type does not match the
               # association's type.
               # ToDo: Support Polymorphic associations
-              if links_object[:type] && (links_object[:type] != association.type.to_s)
+              if links_object[:type] && (links_object[:type].to_s != association.type.to_s)
                 raise JSONAPI::Exceptions::TypeMismatch.new(links_object[:type])
               end
 
               unless links_object[:id].nil?
-                association_resource = Resource.resource_for(@resource_klass.module_path + links_object[:type])
+                association_resource = Resource.resource_for(@resource_klass.module_path + unformat_key(links_object[:type]).to_s)
                 checked_has_one_associations[param] = association_resource.verify_key(links_object[:id], @context)
               else
                 checked_has_one_associations[param] = nil
@@ -309,12 +309,12 @@ module JSONAPI
               if links_object.length == 0
                 checked_has_many_associations[param] = []
               else
-                if links_object.length > 1 || !links_object.has_key?(association.type.to_s)
+                if links_object.length > 1 || !links_object.has_key?(format_key(association.type))
                   raise JSONAPI::Exceptions::TypeMismatch.new(links_object[:type])
                 end
 
                 links_object.each_pair do |type, keys|
-                  association_resource = Resource.resource_for(@resource_klass.module_path + type)
+                  association_resource = Resource.resource_for(@resource_klass.module_path + unformat_key(type).to_s)
                   checked_has_many_associations[param] = association_resource.verify_keys(keys, @context)
                 end
               end
@@ -400,7 +400,7 @@ module JSONAPI
       end
 
       type = data[:type]
-      if type.nil? || type != @resource_klass._type.to_s
+      if type.nil? || type != format_key(@resource_klass._type).to_s
         raise JSONAPI::Exceptions::ParameterMissing.new(:type)
       end
 

data/lib/jsonapi/resource_serializer.rb

@@ -114,23 +114,17 @@ module JSONAPI
 
         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)
-        # end
-
         add_included_object(@primary_class_name, id, object_hash(source,  requested_associations), true)
       end
     end
 
-    # Returns a serialized hash for the source model, with
+    # Returns a serialized hash for the source model
     def object_hash(source, requested_associations)
       obj_hash = attribute_hash(source)
       links = links_hash(source, requested_associations)
 
-      # ToDo: Do we format these required keys
-      obj_hash[format_key('type')] = format_value(source.class._type.to_s, :default, source)
-      obj_hash[format_key('id')] ||= format_value(source.id, :id, source)
+      obj_hash['type'] = format_key(source.class._type.to_s)
+      obj_hash['id'] ||= format_value(source.id, :id, source)
       obj_hash.merge!({links: links}) unless links.empty?
       return obj_hash
     end
@@ -250,7 +244,7 @@ module JSONAPI
       linkage = {}
       linkage_id = foreign_key_value(source, association)
       if linkage_id
-        linkage[:type] = format_route(association.type)
+        linkage[:type] = format_key(association.type)
         linkage[:id] = linkage_id
       else
         linkage = nil
@@ -262,7 +256,7 @@ module JSONAPI
       linkage = []
       linkage_ids = foreign_key_value(source, association)
       linkage_ids.each do |linkage_id|
-        linkage.append({type: format_route(association.type), id: linkage_id})
+        linkage.append({type: format_key(association.type), id: linkage_id})
       end
       linkage
     end

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

data/lib/jsonapi/routing_ext.rb

@@ -18,59 +18,58 @@ module ActionDispatch
         end
 
         def jsonapi_resource(*resources, &block)
-          resource_type = resources.first
-          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(resources.first))
+          @resource_type = resources.first
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
 
           options = resources.extract_options!.dup
-          options[:controller] ||= resource_type
+          options[:controller] ||= @resource_type
           options.merge!(res.routing_resource_options)
-          options[:path] = format_route(resource_type)
+          options[:path] = format_route(@resource_type)
 
-          resource resource_type, options do
-            @scope[:jsonapi_resource] = resource_type
+          resource @resource_type, options do
+            @scope[:jsonapi_resource] = @resource_type
 
             if block_given?
               yield
             else
-              res._associations.each do |association_name, association|
-                if association.is_a?(JSONAPI::Association::HasMany)
-                  jsonapi_links(association_name)
-                else
-                  jsonapi_link(association_name)
-                end
-              end
+              jsonapi_relationships
+            end
+          end
+        end
+
+        def jsonapi_relationships
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
+          res._associations.each do |association_name, association|
+            if association.is_a?(JSONAPI::Association::HasMany)
+              jsonapi_links(association_name)
+              jsonapi_related_resources(association_name)
+            else
+              jsonapi_link(association_name)
+              jsonapi_related_resource(association_name)
             end
           end
         end
 
         def jsonapi_resources(*resources, &block)
-          resource_type = resources.first
-          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(resources.first))
+          @resource_type = resources.first
+          res = JSONAPI::Resource.resource_for(resource_type_with_module_prefix(@resource_type))
 
           options = resources.extract_options!.dup
-          options[:controller] ||= resource_type
+          options[:controller] ||= @resource_type
           options.merge!(res.routing_resource_options)
 
           # Route using the primary_key. Can be overridden using routing_resource_options
           options[:param] ||= res._primary_key
 
-          options[:path] = format_route(resource_type)
+          options[:path] = format_route(@resource_type)
 
-          resources resource_type, options do
-            @scope[:jsonapi_resource] = resource_type
+          resources @resource_type, options do
+            @scope[:jsonapi_resource] = @resource_type
 
             if block_given?
               yield
             else
-              res._associations.each do |association_name, association|
-                if association.is_a?(JSONAPI::Association::HasMany)
-                  jsonapi_links(association_name)
-                  jsonapi_related_resources(association_name)
-                else
-                  jsonapi_link(association_name)
-                  jsonapi_related_resource(association_name)
-                end
-              end
+              jsonapi_relationships
             end
           end
         end

data/test/controllers/controller_test.rb

@@ -4,6 +4,10 @@ def set_content_type_header!
   @request.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
 end
 
+class ConfigControllerTest < ActionController::TestCase
+
+end
+
 class PostsControllerTest < ActionController::TestCase
   def test_index
     get :index
@@ -1388,6 +1392,14 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
     JSONAPI.configuration.json_key_format = :camelized_key
   end
 
+  def test_text_error
+    JSONAPI.configuration.use_text_errors = true
+    get :index, {sort: 'not_in_record'}
+    assert_response 400
+    assert_equal 'INVALID_SORT_FORMAT', json_response['errors'][0]['code']
+    JSONAPI.configuration.use_text_errors = false
+  end
+
   def test_expense_entries_index
     get :index
     assert_response :success
@@ -1636,6 +1648,28 @@ class PeopleControllerTest < ActionController::TestCase
     assert_response :success
   end
 
+  def test_update_link_with_dasherized_type
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    set_content_type_header!
+    put :update,
+        {
+          id: 3,
+          data: {
+            id: '3',
+            type: 'people',
+            links: {
+              'hair-cut' => {
+                linkage: {
+                  type: 'hair-cuts',
+                  id: '1'
+                }
+              }
+            }
+          }
+        }
+    assert_response :success
+  end
+
   def test_create_validations_missing_attribute
     set_content_type_header!
     post :create,
@@ -1693,37 +1727,46 @@ class PeopleControllerTest < ActionController::TestCase
   end
 
   def test_get_related_resource
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    JSONAPI.configuration.route_format = :underscored_key
     get :get_related_resource, {post_id: '2', association: 'author', :source=>'posts'}
     assert_response :success
-    assert_hash_equals json_response,
-                       {
-                         data: {
-                           id: '1',
-                           type: 'people',
-                           name: 'Joe Author',
-                           email: 'joe@xyz.fake',
-                           dateJoined: '2013-08-07 16:25:00 -0400',
-                           links: {
-                             self: 'http://test.host/people/1',
-                             comments: {
-                               self: 'http://test.host/people/1/links/comments',
-                               related: 'http://test.host/people/1/comments'
-                             },
-                             posts: {
-                               self: 'http://test.host/people/1/links/posts',
-                               related: 'http://test.host/people/1/posts'
-                             },
-                             preferences: {
-                               self: 'http://test.host/people/1/links/preferences',
-                               related: 'http://test.host/people/1/preferences',
-                               linkage: {
-                                 type: 'preferences',
-                                 id: '1'
-                               }
-                             }
-                           }
-                         }
-                       }
+    assert_hash_equals(
+      {
+        data: {
+         id: '1',
+         type: 'people',
+         name: 'Joe Author',
+         email: 'joe@xyz.fake',
+         "date-joined" => '2013-08-07 16:25:00 -0400',
+         links: {
+           self: 'http://test.host/people/1',
+           comments: {
+             self: 'http://test.host/people/1/links/comments',
+             related: 'http://test.host/people/1/comments'
+           },
+           posts: {
+             self: 'http://test.host/people/1/links/posts',
+             related: 'http://test.host/people/1/posts'
+           },
+           preferences: {
+             self: 'http://test.host/people/1/links/preferences',
+             related: 'http://test.host/people/1/preferences',
+             linkage: {
+               type: 'preferences',
+               id: '1'
+             }
+           },
+           "hair-cut" => {
+             "self" => "http://test.host/people/1/links/hair_cut",
+             "related" => "http://test.host/people/1/hair_cut",
+             "linkage" => nil
+            }
+         }
+        }
+      },
+      json_response
+    )
   end
 
   def test_get_related_resource_nil

data/test/fixtures/active_record.rb

@@ -12,6 +12,7 @@ ActiveRecord::Schema.define do
     t.string     :email
     t.datetime   :date_joined
     t.belongs_to :preferences
+    t.integer :hair_cut_id, index: true
     t.timestamps null: false
   end
 
@@ -113,6 +114,39 @@ ActiveRecord::Schema.define do
     t.integer    :author_id
     t.timestamps null: false
   end
+
+  create_table :customers, force: true do |t|
+    t.string   :name
+  end
+
+  create_table :purchase_orders, force: true do |t|
+    t.date     :order_date
+    t.date     :requested_delivery_date
+    t.date     :delivery_date
+    t.integer  :customer_id
+    t.string   :delivery_name
+    t.string   :delivery_address_1
+    t.string   :delivery_address_2
+    t.string   :delivery_city
+    t.string   :delivery_state
+    t.string   :delivery_postal_code
+    t.float    :delivery_fee
+    t.float    :tax
+    t.float    :total
+    t.timestamps null: false
+  end
+
+  create_table :line_items, force: true do |t|
+    t.integer  :purchase_order_id
+    t.string   :part_number
+    t.string   :quantity
+    t.float    :item_cost
+    t.timestamps null: false
+  end
+
+  create_table :hair_cuts, force: true do |t|
+    t.string :style
+  end
 end
 
 ### MODELS
@@ -121,6 +155,7 @@ class Person < ActiveRecord::Base
   has_many :comments, foreign_key: 'author_id'
   has_many :expense_entries, foreign_key: 'employee_id', dependent: :restrict_with_exception
   belongs_to :preferences
+  belongs_to :hair_cut
 
   ### Validations
   validates :name, presence: true
@@ -239,7 +274,15 @@ class BreedData
   def remove(id)
     @breeds.delete(id)
   end
+end
+
+class CustomerOrder < ActiveRecord::Base
+end
 
+class PurchaseOrder < ActiveRecord::Base
+end
+
+class LineItem < ActiveRecord::Base
 end
 
 ### PORO Data - don't do this in a production app
@@ -369,6 +412,28 @@ module Api
     class IsoCurrenciesController < JSONAPI::ResourceController
     end
   end
+
+  module V6
+    class CustomersController < JSONAPI::ResourceController
+    end
+
+    class PurchaseOrdersController < JSONAPI::ResourceController
+    end
+
+    class LineItemsController < JSONAPI::ResourceController
+    end
+  end
+
+  module V7
+    class CustomersController < JSONAPI::ResourceController
+    end
+
+    class PurchaseOrdersController < JSONAPI::ResourceController
+    end
+
+    class LineItemsController < JSONAPI::ResourceController
+    end
+  end
 end
 
 ### RESOURCES
@@ -380,6 +445,7 @@ class PersonResource < JSONAPI::Resource
   has_many :posts
 
   has_one :preferences
+  has_one :hair_cut
 
   filter :name
 
@@ -502,6 +568,11 @@ class PostResource < JSONAPI::Resource
   end
 end
 
+class HairCutResource < JSONAPI::Resource
+  attribute :style
+  has_many :people
+end
+
 class IsoCurrencyResource < JSONAPI::Resource
   primary_key :code
   attributes :name, :country_name, :minor_unit
@@ -644,6 +715,7 @@ module Api
     PreferencesResource = PreferencesResource.dup
     EmployeeResource = EmployeeResource.dup
     FriendResource = FriendResource.dup
+    HairCutResource = HairCutResource.dup
   end
 end
 
@@ -721,6 +793,48 @@ module Api
   end
 end
 
+module Api
+  module V6
+    class CustomerResource < JSONAPI::Resource
+      attribute :name
+
+      has_many :purchase_orders
+    end
+
+    class PurchaseOrderResource < JSONAPI::Resource
+      attribute :order_date
+      attribute :requested_delivery_date
+      attribute :delivery_date
+      attribute :delivery_name
+      attribute :delivery_address_1
+      attribute :delivery_address_2
+      attribute :delivery_city
+      attribute :delivery_state
+      attribute :delivery_postal_code
+      attribute :delivery_fee
+      attribute :tax
+      attribute :total
+
+      has_one :customer
+      has_many :line_items
+    end
+
+    class LineItemResource < JSONAPI::Resource
+      attribute :part_number
+      attribute :quantity
+      attribute :item_cost
+
+      has_one :purchase_order
+    end
+  end
+
+  module V7
+    CustomerResource = V6::CustomerResource.dup
+    PurchaseOrderResource = V6::PurchaseOrderResource.dup
+    LineItemResource = V6::LineItemResource.dup
+  end
+end
+
 warn 'start testing Name Collisions'
 # The name collisions only emmit warnings. Exceptions would change the flow of the tests
 
@@ -755,4 +869,4 @@ jupiter = Planet.create(name: 'Jupiter', description: 'A gas giant.', planet_typ
 betax = Planet.create(name: 'Beta X', description: 'Newly discovered Planet X', planet_type_id: unknown.id)
 betay = Planet.create(name: 'Beta X', description: 'Newly discovered Planet Y', planet_type_id: unknown.id)
 betaz = Planet.create(name: 'Beta X', description: 'Newly discovered Planet Z', planet_type_id: unknown.id)
-betaw = Planet.create(name: 'Beta W', description: 'Newly discovered Planet W')
+betaw = Planet.create(name: 'Beta W', description: 'Newly discovered Planet W')

data/test/fixtures/customers.yml

@@ -0,0 +1,7 @@
+xyz_corp:
+  id: 1
+  name: XYZ Corporation
+
+abc_corp:
+  id: 2
+  name: ABC Corporation

data/test/fixtures/hair_cuts.yml

@@ -0,0 +1,3 @@
+mohawk:
+  id: 1
+  style: mohawk

data/test/fixtures/line_items.yml

@@ -0,0 +1,11 @@
+po_1_li_1:
+  purchase_order_id: 1
+  part_number: 556324
+  quantity: 1
+  item_cost: 45.67
+
+po_1_li_2:
+  purchase_order_id: 1
+  part_number: 79324231A
+  quantity: 3
+  item_cost: 19.99

data/test/fixtures/purchase_orders.yml

@@ -0,0 +1,11 @@
+po_1:
+  id: 1
+  requested_delivery_date:
+  delivery_date: nil
+  customer_id: 1
+
+po_2:
+  id: 2
+  requested_delivery_date:
+  delivery_date: nil
+  customer_id: 1

data/test/integration/requests/request_test.rb

@@ -5,6 +5,7 @@ class RequestTest < ActionDispatch::IntegrationTest
 
   def setup
     JSONAPI.configuration.json_key_format = :underscored_key
+    JSONAPI.configuration.route_format = :underscored_route
   end
 
   def after_teardown
@@ -451,4 +452,116 @@ class RequestTest < ActionDispatch::IntegrationTest
                        })
   end
 
+  def test_flow_self_formatted_route_1
+    JSONAPI.configuration.route_format = :dasherized_route
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    get '/api/v6/purchase-orders'
+    assert_equal 200, status
+    po_1 = json_response['data'][0]
+    assert_equal 'purchase-orders', json_response['data'][0]['type']
+
+    get po_1['links']['self']
+    assert_equal 200, status
+    assert_hash_equals po_1, json_response['data']
+  end
+
+  def test_flow_self_formatted_route_2
+    JSONAPI.configuration.route_format = :underscored_route
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    get '/api/v7/purchase_orders'
+    assert_equal 200, status
+    assert_equal 'purchase-orders', json_response['data'][0]['type']
+
+    po_1 = json_response['data'][0]
+
+    get po_1['links']['self']
+    assert_equal 200, status
+    assert_hash_equals po_1, json_response['data']
+  end
+
+  def test_flow_self_formatted_route_3
+    JSONAPI.configuration.route_format = :underscored_route
+    JSONAPI.configuration.json_key_format = :underscored_key
+    get '/api/v7/purchase_orders'
+    assert_equal 200, status
+    assert_equal 'purchase_orders', json_response['data'][0]['type']
+
+    po_1 = json_response['data'][0]
+
+    get po_1['links']['self']
+    assert_equal 200, status
+    assert_hash_equals po_1, json_response['data']
+  end
+
+  def test_post_formatted_keys
+    JSONAPI.configuration.route_format = :dasherized_route
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    post '/api/v6/purchase-orders',
+         {
+           'data' => {
+             'delivery-name' => 'ASDFG Corp',
+             'type' => 'purchase-orders'
+           }
+         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 201, status
+  end
+
+  def test_post_formatted_keys_different_route_key_1
+    JSONAPI.configuration.route_format = :dasherized_route
+    JSONAPI.configuration.json_key_format = :underscored_key
+    post '/api/v6/purchase-orders',
+         {
+           'data' => {
+             'delivery_name' => 'ASDFG Corp',
+             'type' => 'purchase_orders'
+           }
+         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 201, status
+  end
+
+  def test_post_formatted_keys_different_route_key_2
+    JSONAPI.configuration.route_format = :underscored_route
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    post '/api/v7/purchase_orders',
+         {
+           'data' => {
+             'delivery-name' => 'ASDFG Corp',
+             'type' => 'purchase-orders'
+           }
+         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 201, status
+  end
+
+  def test_post_formatted_keys_wrong_format
+    JSONAPI.configuration.route_format = :dasherized_route
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    post '/api/v6/purchase-orders',
+         {
+           'data' => {
+             'delivery_name' => 'ASDFG Corp',
+             'type' => 'purchase-orders'
+           }
+         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 400, status
+  end
+
+  def test_patch_formatted_dasherized
+    JSONAPI.configuration.route_format = :dasherized_route
+    JSONAPI.configuration.json_key_format = :dasherized_key
+    patch '/api/v6/purchase-orders/1',
+         {
+           'data' => {
+             'id' => '1',
+             'delivery-name' => 'ASDFG Corp',
+             'type' => 'purchase-orders'
+           }
+         }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 200, status
+  end
+
 end

data/test/test_helper.rb

@@ -66,7 +66,9 @@ TestApp.routes.draw do
   jsonapi_resources :people
   jsonapi_resources :comments
   jsonapi_resources :tags
-  jsonapi_resources :posts
+  jsonapi_resources :posts do
+    jsonapi_relationships
+  end
   jsonapi_resources :sections
   jsonapi_resources :iso_currencies
   jsonapi_resources :expense_entries
@@ -144,6 +146,20 @@ TestApp.routes.draw do
 
     end
     JSONAPI.configuration.route_format = :underscored_route
+
+    JSONAPI.configuration.route_format = :dasherized_route
+    namespace :v6 do
+      jsonapi_resources :customers
+      jsonapi_resources :purchase_orders
+      jsonapi_resources :line_items
+    end
+    JSONAPI.configuration.route_format = :underscored_route
+
+    namespace :v7 do
+      jsonapi_resources :customers
+      jsonapi_resources :purchase_orders
+      jsonapi_resources :line_items
+    end
   end
 end
 

data/test/unit/serializer/serializer_test.rb

@@ -10,6 +10,7 @@ class SerializerTest < ActionDispatch::IntegrationTest
     @expense_entry = ExpenseEntry.find(1)
 
     JSONAPI.configuration.json_key_format = :camelized_key
+    JSONAPI.configuration.route_format = :camelized_route
   end
 
   def after_teardown
@@ -130,6 +131,10 @@ class SerializerTest < ActionDispatch::IntegrationTest
   end
 
   def test_serializer_include
+    serialized = JSONAPI::ResourceSerializer.new(
+      PostResource,
+      include: [:author]
+    ).serialize_to_hash(PostResource.new(@post))
 
     assert_hash_equals(
       {
@@ -188,16 +193,26 @@ class SerializerTest < ActionDispatch::IntegrationTest
                  type: 'preferences',
                  id: '1'
                }
+             },
+             hairCut: {
+               self: "/people/1/links/hairCut",
+               related: "/people/1/hairCut",
+               linkage: nil
              }
             }
           }
         ]
       },
-      JSONAPI::ResourceSerializer.new(PostResource, include: [:author]).serialize_to_hash(
-        PostResource.new(@post)))
+      serialized
+    )
   end
 
   def test_serializer_key_format
+    serialized = JSONAPI::ResourceSerializer.new(
+      PostResource,
+      include: [:author],
+      key_formatter: UnderscoredKeyFormatter
+    ).serialize_to_hash(PostResource.new(@post))
 
     assert_hash_equals(
       {
@@ -256,14 +271,17 @@ class SerializerTest < ActionDispatch::IntegrationTest
                   type: 'preferences',
                   id: '1'
                 }
+              },
+              hair_cut: {
+                self: '/people/1/links/hairCut',
+                related: '/people/1/hairCut',
+                linkage: nil
               }
             }
           }
         ]
       },
-      JSONAPI::ResourceSerializer.new(PostResource,
-                                      include: [:author],
-                                      key_formatter: UnderscoredKeyFormatter).serialize_to_hash(PostResource.new(@post))
+      serialized
     )
   end
 
@@ -564,6 +582,10 @@ class SerializerTest < ActionDispatch::IntegrationTest
   end
 
   def test_serializer_different_foreign_key
+    serialized = JSONAPI::ResourceSerializer.new(
+      PersonResource,
+      include: ['comments']
+    ).serialize_to_hash(PersonResource.new(@fred))
 
     assert_hash_equals(
       {
@@ -591,6 +613,11 @@ class SerializerTest < ActionDispatch::IntegrationTest
               self: "/people/2/links/preferences",
               related: "/people/2/preferences",
               linkage: nil
+            },
+            hairCut: {
+              self: "/people/2/links/hairCut",
+              related: "/people/2/hairCut",
+              linkage: nil
             }
           }
         },
@@ -653,7 +680,7 @@ class SerializerTest < ActionDispatch::IntegrationTest
           }
         ]
       },
-      JSONAPI::ResourceSerializer.new(PersonResource, include: ['comments']).serialize_to_hash(PersonResource.new(@fred))
+      serialized
     )
   end
 
@@ -1057,26 +1084,29 @@ class SerializerTest < ActionDispatch::IntegrationTest
   end
 
   def test_serializer_camelized_with_value_formatters
+    # JSONAPI.configuration.json_key_format = :camelized_key
+    # JSONAPI.configuration.route_format = :camelized_route
+
     assert_hash_equals(
       {
         data: {
-          type: 'expense_entries',
+          type: 'expenseEntries',
           id: '1',
           transactionDate: '04/15/2014',
           cost: 12.05,
           links: {
-            self: '/expense_entries/1',
+            self: '/expenseEntries/1',
             isoCurrency: {
-              self: '/expense_entries/1/links/iso_currency',
-              related: '/expense_entries/1/iso_currency',
+              self: '/expenseEntries/1/links/isoCurrency',
+              related: '/expenseEntries/1/isoCurrency',
               linkage: {
-                type: 'iso_currencies',
+                type: 'isoCurrencies',
                 id: 'USD'
               }
             },
             employee: {
-              self: '/expense_entries/1/links/employee',
-              related: '/expense_entries/1/employee',
+              self: '/expenseEntries/1/links/employee',
+              related: '/expenseEntries/1/employee',
               linkage: {
                 type: 'people',
                 id: '3'
@@ -1086,13 +1116,13 @@ class SerializerTest < ActionDispatch::IntegrationTest
         },
         included: [
           {
-            type: 'iso_currencies',
+            type: 'isoCurrencies',
             id: 'USD',
             countryName: 'United States',
             name: 'United States Dollar',
             minorUnit: 'cent',
             links: {
-              self: '/iso_currencies/USD'
+              self: '/isoCurrencies/USD'
             }
           },
           {
@@ -1108,7 +1138,7 @@ class SerializerTest < ActionDispatch::IntegrationTest
         ]
       },
       JSONAPI::ResourceSerializer.new(ExpenseEntryResource,
-                                      include: ['iso_currency', 'employee'],
+                                      include: ['isoCurrency', 'employee'],
                                       fields: {people: [:id, :name, :email, :date_joined]}).serialize_to_hash(
         ExpenseEntryResource.new(@expense_entry))
     )
@@ -1128,8 +1158,8 @@ class SerializerTest < ActionDispatch::IntegrationTest
           links: {
             self: '/planets/8',
             planetType: {
-              self: '/planets/8/links/planet_type',
-              related: '/planets/8/planet_type',
+              self: '/planets/8/links/planetType',
+              related: '/planets/8/planetType',
               linkage: nil
             },
             tags: {
@@ -1165,10 +1195,10 @@ class SerializerTest < ActionDispatch::IntegrationTest
           links: {
             self: '/planets/7',
             planetType: {
-              self: '/planets/7/links/planet_type',
-              related: '/planets/7/planet_type',
+              self: '/planets/7/links/planetType',
+              related: '/planets/7/planetType',
               linkage: {
-                type: 'planet_types',
+                type: 'planetTypes',
                 id: '5'
               }
             },
@@ -1190,8 +1220,8 @@ class SerializerTest < ActionDispatch::IntegrationTest
           links: {
             self: '/planets/8',
             planetType: {
-              self: '/planets/8/links/planet_type',
-              related: '/planets/8/planet_type',
+              self: '/planets/8/links/planetType',
+              related: '/planets/8/planetType',
               linkage: nil
             },
             tags: {
@@ -1207,11 +1237,11 @@ class SerializerTest < ActionDispatch::IntegrationTest
       ],
       included: [
         {
-          type: 'planet_types',
+          type: 'planetTypes',
           id: '5',
           name: 'unknown',
           links: {
-            self: '/planet_types/5'
+            self: '/planetTypes/5'
           }
         }
       ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -152,13 +152,17 @@ files:
 - test/fixtures/books.yml
 - test/fixtures/comments.yml
 - test/fixtures/comments_tags.yml
+- test/fixtures/customers.yml
 - test/fixtures/expense_entries.yml
 - test/fixtures/facts.yml
+- test/fixtures/hair_cuts.yml
 - test/fixtures/iso_currencies.yml
+- test/fixtures/line_items.yml
 - test/fixtures/people.yml
 - test/fixtures/posts.yml
 - test/fixtures/posts_tags.yml
 - test/fixtures/preferences.yml
+- test/fixtures/purchase_orders.yml
 - test/fixtures/sections.yml
 - test/fixtures/tags.yml
 - test/helpers/functional_helpers.rb
@@ -204,13 +208,17 @@ test_files:
 - test/fixtures/books.yml
 - test/fixtures/comments.yml
 - test/fixtures/comments_tags.yml
+- test/fixtures/customers.yml
 - test/fixtures/expense_entries.yml
 - test/fixtures/facts.yml
+- test/fixtures/hair_cuts.yml
 - test/fixtures/iso_currencies.yml
+- test/fixtures/line_items.yml
 - test/fixtures/people.yml
 - test/fixtures/posts.yml
 - test/fixtures/posts_tags.yml
 - test/fixtures/preferences.yml
+- test/fixtures/purchase_orders.yml
 - test/fixtures/sections.yml
 - test/fixtures/tags.yml
 - test/helpers/functional_helpers.rb