jsonapi-resources 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9857d701e9136cba9b504cc0439b43e939722565
-  data.tar.gz: 5696329e4c5865e17b7b3bb0f6a40d4840a06f16
+  metadata.gz: e3cc147ec7ed0dc456d04b86c715a7e9a13f47dd
+  data.tar.gz: 77d151a254fa986e93ba80fd06775ed0bd3753c1
 SHA512:
-  metadata.gz: 00981170f6a4d0743a298cc8478c9cf2e8d7cd07153a204fc878188a07aaeb79d3ed45529a2f3cc5a84dde326d2697b0faa880c619a9554e4689d0d60fb8f4c8
-  data.tar.gz: 8b42c9bdc12fc6b40aaec0e18b73d2871899047ce86ef77d8edf28e5775872337de9f83b4bc883d647fa4f563330a0987046c59ac4bf41f051d8f2f97a416e1e
+  metadata.gz: e3349452f04356593d52125551ed57049a91f2b89a66010587d562c12d1fd47ffab5896b8078434bd733a7a931c772478d8615afa30240e66b60b9a9f10ae14f
+  data.tar.gz: 4c75390e027e8af857d049f883836af04e6258ccd57209de458e0d63b809039684febc28720d3a3973e2a65c2068b70775f439b575e33a74b108a7da738bcc9c

data/lib/jsonapi-resources.rb

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

data/lib/jsonapi/configuration.rb

@@ -38,4 +38,4 @@ module JSONAPI
   def self.configure
     yield(@configuration)
   end
-end
+end

data/lib/jsonapi/error_codes.rb

@@ -15,5 +15,6 @@ module JSONAPI
   INVALID_SORT_PARAM = 114
 
   RECORD_NOT_FOUND = 404
+  UNSUPPORTED_MEDIA_TYPE = 415
   LOCKED = 423
 end

data/lib/jsonapi/exceptions.rb

@@ -30,6 +30,20 @@ module JSONAPI
       end
     end
 
+    class UnsupportedMediaTypeError < Error
+      attr_accessor :media_type
+      def initialize(media_type)
+        @media_type = media_type
+      end
+
+      def errors
+        [JSONAPI::Error.new(code: JSONAPI::UNSUPPORTED_MEDIA_TYPE,
+                             status: :unsupported_media_type,
+                             title: 'Unsupported media type',
+                             detail: "All requests that create or update resources must use the '#{JSONAPI::MEDIA_TYPE}' Content-Type. This request specified '#{media_type}.'")]
+      end
+    end
+
     class HasManyRelationExists < Error
       attr_accessor :id
       def initialize(id)

data/lib/jsonapi/mime_types.rb

@@ -0,0 +1,9 @@
+module JSONAPI
+  MEDIA_TYPE = "application/vnd.api+json"
+end
+
+Mime::Type.register JSONAPI::MEDIA_TYPE, :api_json
+
+ActionDispatch::ParamsParser::DEFAULT_PARSERS[Mime::Type.lookup(JSONAPI::MEDIA_TYPE)]=lambda do |body|
+  JSON.parse(body)
+end

data/lib/jsonapi/resource.rb

@@ -117,7 +117,7 @@ module JSONAPI
     def _save
       @model.save!
       @save_needed = false
-    rescue ActiveRecord::RecordInvalid => e
+    rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotSaved => e
       raise JSONAPI::Exceptions::ValidationErrors.new(e.record.errors.messages)
     end
 

data/lib/jsonapi/resource_controller.rb

@@ -13,7 +13,9 @@ module JSONAPI
   class ResourceController < ActionController::Base
     include ResourceFor
 
+    before_filter :ensure_correct_media_type, only: [:create, :update, :create_association, :update_association]
     before_filter :setup_request
+    after_filter :setup_response
 
     def index
       render json: JSONAPI::ResourceSerializer.new(resource_klass).serialize_to_hash(
@@ -107,6 +109,16 @@ module JSONAPI
       @resource_klass_name ||= "#{self.class.name.sub(/Controller$/, '').singularize}Resource"
     end
 
+    def ensure_correct_media_type
+      unless request.content_type == JSONAPI::MEDIA_TYPE
+        raise JSONAPI::Exceptions::UnsupportedMediaTypeError.new(request.content_type)
+      end
+    rescue => e
+      # :nocov:
+      handle_exceptions(e)
+      # :nocov:
+    end
+
     def setup_request
       @request = JSONAPI::Request.new(params, {
         context: context,
@@ -119,6 +131,12 @@ module JSONAPI
       # :nocov:
     end
 
+    def setup_response
+      if response.body.size > 0
+        response.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
+      end
+    end
+
     def parse_key_array(raw)
       keys = raw.nil? || raw.empty? ? [] : raw.split(',')
       resource_klass.verify_keys(keys, context)

data/lib/jsonapi/resources/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Resources
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/test/controllers/controller_test.rb

@@ -1,6 +1,10 @@
 require File.expand_path('../../test_helper', __FILE__)
 require File.expand_path('../../fixtures/active_record', __FILE__)
 
+def set_content_type_header!
+  @request.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
+end
+
 class PostsControllerTest < ActionController::TestCase
   def test_index
     get :index
@@ -262,6 +266,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_simple
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -281,6 +286,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_link_to_missing_object
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -298,6 +304,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_extra_param
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -315,6 +322,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_with_invalid_data
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -338,6 +346,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_multiple
+    set_content_type_header!
     post :create,
          {
            posts: [
@@ -367,6 +376,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_multiple_wrong_case
+    set_content_type_header!
     post :create,
          {
            posts: [
@@ -392,6 +402,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_simple_missing_posts
+    set_content_type_header!
     post :create,
          {
            posts_spelled_wrong: {
@@ -408,6 +419,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_simple_unpermitted_attributes
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -424,6 +436,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_with_links
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -445,6 +458,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_with_links_include_and_fields
+    set_content_type_header!
     post :create,
          {
            posts: {
@@ -471,6 +485,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_with_links
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -495,6 +510,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_remove_links
+    set_content_type_header!
     put :update,
         {
           id: 3,
@@ -517,6 +533,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_one
+    set_content_type_header!
     ruby = Section.find_by(name: 'ruby')
     post_object = Post.find(3)
     assert_not_equal ruby.id, post_object.section_id
@@ -529,6 +546,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_one_singular_param
+    set_content_type_header!
     ruby = Section.find_by(name: 'ruby')
     post_object = Post.find(3)
 
@@ -538,6 +556,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_one_singular_param_relation_nil
+    set_content_type_header!
     ruby = Section.find_by(name: 'ruby')
     post_object = Post.find(3)
     post_object.section_id = nil
@@ -551,6 +570,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_relationship_has_one_singular_param_relation_nil
+    set_content_type_header!
     ruby = Section.find_by(name: 'ruby')
     post_object = Post.find(3)
     post_object.section_id = nil
@@ -564,6 +584,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_relationship_has_one_singular_param_relation_not_nil
+    set_content_type_header!
     ruby = Section.find_by(name: 'ruby')
     js = Section.find_by(name: 'javascript')
     post_object = Post.find(3)
@@ -579,6 +600,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_many_join_table_single
+    set_content_type_header!
     put :update_association, {post_id: 3, association: 'tags', tags: []}
     assert_response :no_content
 
@@ -601,6 +623,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_many_join_table
+    set_content_type_header!
     put :update_association, {post_id: 3, association: 'tags', tags: [2, 3]}
 
     assert_response :no_content
@@ -610,6 +633,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_relationship_has_many_join_table
+    set_content_type_header!
     put :update_association, {post_id: 3, association: 'tags', tags: [2, 3]}
 
     assert_response :no_content
@@ -626,6 +650,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_relationship_has_many_missing_tags
+    set_content_type_header!
     post :create_association, {post_id: 3, association: 'tags'}
 
     assert_response :bad_request
@@ -633,6 +658,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_relationship_has_many_join_table_record_exists
+    set_content_type_header!
     put :update_association, {post_id: 3, association: 'tags', tags: [2, 3]}
 
     assert_response :no_content
@@ -647,6 +673,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_one_mismatch_params
+    set_content_type_header!
     post :create_association, {post_id: 3, association: 'section', authors: 1}
 
     assert_response :bad_request
@@ -654,6 +681,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_relationship_has_many_missing_tags
+    set_content_type_header!
     put :update_association, {post_id: 3, association: 'tags'}
 
     assert_response :bad_request
@@ -661,6 +689,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_delete_relationship_has_one
+    set_content_type_header!
     ruby = Section.find_by(name: 'ruby')
 
     post :create_association, {post_id: 9, association: 'section', sections: ruby.id}
@@ -675,6 +704,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_delete_relationship_has_many
+    set_content_type_header!
     put :update_association, {post_id: 9, association: 'tags', tags: [2, 3]}
     assert_response :no_content
     p = Post.find(9)
@@ -688,6 +718,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_delete_relationship_has_many_does_not_exist
+    set_content_type_header!
     put :update_association, {post_id: 9, association: 'tags', tags: [2, 3]}
     assert_response :no_content
     p = Post.find(9)
@@ -701,6 +732,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_mismatched_keys
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -721,6 +753,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_extra_param
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -741,6 +774,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_extra_param_in_links
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -761,6 +795,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_missing_param
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -780,6 +815,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_multiple
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -820,6 +856,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_multiple_missing_keys
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -847,6 +884,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_mismatch_keys
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -876,6 +914,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_multiple_count_mismatch
+    set_content_type_header!
     javascript = Section.find_by(name: 'javascript')
 
     put :update,
@@ -905,6 +944,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_unpermitted_attributes
+    set_content_type_header!
     put :update,
         {
           id: 3,
@@ -923,6 +963,7 @@ class PostsControllerTest < ActionController::TestCase
   end
 
   def test_update_bad_attributes
+    set_content_type_header!
     put :update,
         {
           id: 3,
@@ -1086,6 +1127,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
   end
 
   def test_create_expense_entries_underscored
+    set_content_type_header!
     JSONAPI.configuration.json_key_format = :underscored_key
 
     post :create,
@@ -1113,6 +1155,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
   end
 
   def test_create_expense_entries_camelized_key
+    set_content_type_header!
     JSONAPI.configuration.json_key_format = :camelized_key
 
     post :create,
@@ -1140,6 +1183,7 @@ class ExpenseEntriesControllerTest < ActionController::TestCase
   end
 
   def test_create_expense_entries_dasherized_key
+    set_content_type_header!
     JSONAPI.configuration.json_key_format = :dasherized_key
 
     post :create,
@@ -1287,6 +1331,7 @@ end
 
 class PeopleControllerTest < ActionController::TestCase
   def test_create_validations
+    set_content_type_header!
     post :create,
          {
            people: {
@@ -1300,6 +1345,7 @@ class PeopleControllerTest < ActionController::TestCase
   end
 
   def test_create_validations_missing_attribute
+    set_content_type_header!
     post :create,
          {
            people: {
@@ -1316,6 +1362,7 @@ class PeopleControllerTest < ActionController::TestCase
   end
 
   def test_update_validations_missing_attribute
+    set_content_type_header!
     put :update,
         {
           id: 3,
@@ -1404,6 +1451,7 @@ class BreedsControllerTest < ActionController::TestCase
   end
 
   def test_poro_create_simple
+    set_content_type_header!
     post :create,
          {
            breeds: {
@@ -1417,6 +1465,7 @@ class BreedsControllerTest < ActionController::TestCase
   end
 
   def test_poro_create_update
+    set_content_type_header!
     post :create,
          {
            breeds: {
@@ -1500,6 +1549,7 @@ class Api::V1::PostsControllerTest < ActionController::TestCase
   end
 
   def test_create_simple_namespaced
+    set_content_type_header!
     post :create,
          {
            posts: {

data/test/integration/requests/request_test.rb

@@ -45,6 +45,21 @@ class RequestTest < ActionDispatch::IntegrationTest
     assert_equal 'USD', json_response['isoCurrency']
   end
 
+  def test_put_single_without_content_type
+    put '/posts/3',
+        {
+          'posts' => {
+            'id' => '3',
+            'title' => 'A great new Post',
+            'links' => {
+              'tags' => [3, 4]
+            }
+          }
+        }.to_json, "CONTENT_TYPE" => "application/json"
+
+    assert_equal 415, status
+  end
+
   def test_put_single
     put '/posts/3',
         {
@@ -55,13 +70,97 @@ class RequestTest < ActionDispatch::IntegrationTest
               'tags' => [3, 4]
             }
           }
-        }
+        }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
     assert_equal 200, status
   end
 
+  def test_post_single_without_content_type
+    post '/posts',
+      {
+        'posts' => {
+          'title' => 'A great new Post',
+          'links' => {
+            'tags' => [3, 4]
+          }
+        }
+      }.to_json, "CONTENT_TYPE" => "application/json"
+
+    assert_equal 415, status
+  end
+
+  def test_post_single
+    post '/posts',
+      {
+        'posts' => {
+          'title' => 'A great new Post',
+          'body' => 'JSONAPIResources is the greatest thing since unsliced bread.',
+          'links' => {
+            'author' => '3'
+          }
+        }
+      }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 201, status
+  end
+
+  def test_create_association_without_content_type
+    ruby = Section.find_by(name: 'ruby')
+    put '/posts/3/links/section', { 'sections' => ruby.id.to_s }.to_json
+
+    assert_equal 415, status
+  end
+
+  def test_create_association
+    ruby = Section.find_by(name: 'ruby')
+    put '/posts/3/links/section', { 'sections' => ruby.id.to_s }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_equal 204, status
+  end
+
+  def test_index_content_type
+    get '/posts'
+    assert_match JSONAPI::MEDIA_TYPE, headers['Content-Type']
+  end
+
+  def test_get_content_type
+    get '/posts/3'
+    assert_match JSONAPI::MEDIA_TYPE, headers['Content-Type']
+  end
+
+  def test_put_content_type
+    put '/posts/3',
+        {
+          'posts' => {
+            'id' => '3',
+            'title' => 'A great new Post',
+            'links' => {
+              'tags' => [3, 4]
+            }
+          }
+        }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_match JSONAPI::MEDIA_TYPE, headers['Content-Type']
+  end
+
+  def test_post_correct_content_type
+    post '/posts',
+      {
+       'posts' => {
+         'title' => 'A great new Post',
+         'links' => {
+           'author' => '3'
+         }
+       }
+     }.to_json, "CONTENT_TYPE" => JSONAPI::MEDIA_TYPE
+
+    assert_match JSONAPI::MEDIA_TYPE, headers['Content-Type']
+  end
+
   def test_destroy_single
     delete '/posts/7'
     assert_equal 204, status
+    assert_nil headers['Content-Type']
   end
 
   def test_destroy_multiple

data/test/test_helper.rb

@@ -14,6 +14,7 @@ require 'rails/all'
 require 'jsonapi/routing_ext'
 require 'jsonapi/configuration'
 require 'jsonapi/formatter'
+require 'jsonapi/mime_types'
 
 require File.expand_path('../helpers/value_matchers', __FILE__)
 require File.expand_path('../helpers/hash_helpers', __FILE__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-resources
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dan Gebhardt
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,6 +134,7 @@ files:
 - lib/jsonapi/error_codes.rb
 - lib/jsonapi/exceptions.rb
 - lib/jsonapi/formatter.rb
+- lib/jsonapi/mime_types.rb
 - lib/jsonapi/operation.rb
 - lib/jsonapi/operation_result.rb
 - lib/jsonapi/operations_processor.rb
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easily support JSON API in Rails.