jsonapi_for_rails 0.1.7 → 0.2.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06227ce867a3b98abeac078d6dd809d9da6791a9
-  data.tar.gz: ff84fc17fff124f48a269c128f8aece931363b94
+  metadata.gz: da54359b12e07d61046ce9a96b2b0c8edadb2af2
+  data.tar.gz: bef39399515bd6b7b6a10d5466d26d45c60807ec
 SHA512:
-  metadata.gz: 5cb2103dea40467f6ded25d379c2c41a1696258e3630659c225b005f553480c015f07e0beb37149760ffe99422334d21050656d605d3e7b76bcf21a39f6585e9
-  data.tar.gz: 97c37f8bc2bf07732c0c254f1231594a1ea595202ec0191f42a8eff97c2fc975f6f8e12c1f704b09fe4cb855042e1807ab8ca949af8a0d6a4b8d7a3dc5b5d76b
+  metadata.gz: 5e422031d14cea9d91d30591ceafb5616f868b6cd4471c34a705a7ae7837c9aabc4c74acb6627efaa78f7e311b7a6ec640d9b35fe2533ccd419fc1d1d1acf34a
+  data.tar.gz: 5750ba36ebe04753855d98914a1fa700f23db4da0541a97d7551b9821c89713a256264f2c9d34fc0400d8a4c67c7f49e47a32d7b187db4e0f933e41692bbe0ee

data/README.md

@@ -34,7 +34,7 @@ $
 $ # Check the used version
 $ bin/rails console
 irb(main):001:0> JsonapiForRails::VERSION
-=> "0.1.7"
+=> "0.2.0.pre"
 irb(main):002:0> exit
 $
 ```
@@ -70,6 +70,12 @@ class ApplicationController < ActionController::Base # or ActionController::API
 end
 ```
 
+`acts_as_jsonapi_resources` accepts the following keyword arguments:
+
+* `content_negotiation`: Set this to `false` to disable
+  [content negotiation](http://jsonapi.org/format/1.0/#content-negotiation).
+  Default value is `true`. Usage example: `acts_as_jsonapi_resources content_negotiation: false`
+
 If only some of your controllers are JSONAPI controllers, then create a parent controller for only those controllers, and enable JSONAPI inside that controller rather than `ApplicationController`. 
 
 ```bash
@@ -128,7 +134,7 @@ After populating your database and launching the built-in Rails server with the
 
 ```bash
 $ # Get the list of articles
-$ # (the response body is prettified when the Rails environment is 'development' or 'test')
+$ # (the returned HTTP response body is short and terse, but it is prettified here for legibility)
 $ curl 'http://localhost:3000/api/v1/articles'
 {
   "data": [
@@ -142,7 +148,6 @@ $ curl 'http://localhost:3000/api/v1/articles'
     }
   ]
 }
-$
 $ # Get an article
 $ curl 'http://localhost:3000/api/v1/articles/618037523'
 {
@@ -165,7 +170,6 @@ $ curl 'http://localhost:3000/api/v1/articles/618037523'
     }
   }
 }
-$
 $ # Get only the title and author of an article, include the author's name
 $ curl 'http://localhost:3000/api/v1/articles/618037523?filter%5Barticles%5D=title,author;include=author;filter%5Bauthors%5D=name'
 {
@@ -274,7 +278,8 @@ class ArticlesController < JsonapiResourcesController
     # @jsonapi_record contains the current database record.
     # It is available inside all action methods (including all relationship
     # methods) except :index and :create.
-    @jsonapi_record.to_jsonapi_hash # => {data: {...}}
+    @jsonapi_record.to_jsonapi_hash        # => {data:   {...}}
+    @jsonapi_record.to_jsonapi_errors_hash # => {errors: [...]}
 
     # ...
   end
@@ -305,6 +310,7 @@ The internal architecture is sound. Test coverage is currently being bulked up u
 
 Feature support roundup:
 
+* [Content negotiation](http://jsonapi.org/format/1.0/#content-negotiation) is not implemented.
 * [Inclusion of related resources](http://jsonapi.org/format/1.0/#fetching-includes) is currently only implemented for requests that return a single resource, and relationship paths are not supported. 
 * [Sparse fieldsets](http://jsonapi.org/format/1.0/#fetching-sparse-fieldsets) is currently only implemented for requests that return a single resource. 
 * [Sorting](http://jsonapi.org/format/1.0/#fetching-sorting) is currently not implemented.

data/Rakefile

@@ -1,3 +1,5 @@
+# Rakefile format: http://rake.rubyforge.org/files/doc/rakefile_rdoc.html
+
 begin
   require 'bundler/setup'
 rescue LoadError

data/lib/jsonapi_for_rails/controller/actions/object.rb

@@ -22,8 +22,9 @@ module JsonapiForRails::Controller
 
 				# implements Create and Update operations
 				def create
+
+					# attributes
 					begin
-						# attributes
 						attrs = received_attributes
 						if attrs
 							if @jsonapi_record
@@ -31,38 +32,42 @@ module JsonapiForRails::Controller
 								@jsonapi_record.update! attrs
 							else
 								# create
-								@jsonapi_record = jsonapi_model_class.create! attrs
-							end
-						end
-
-						# relationships
-						received_relationships.each do |relationship|
-							# to-one
-							if relationship[:definition][:type] == :to_one
-								@jsonapi_record.send :"#{relationship[:definition][:name]}=", relationship[:params][:data]
-								next
-							end
-
-							# to-many
-							@jsonapi_record.send(relationship[:definition][:name]).send :clear # initialize the relation
-							
-							relationship[:params][:data].each do |item|
-								object = relationship[:receiver][:class].find_by_id item[:id]
-								@jsonapi_record.send(relationship[:definition][:name]).send :<<, object
+								@jsonapi_record = jsonapi_model_class.new attrs
+								@jsonapi_record.save!
 							end
 						end
 					rescue NameError => e
-
-						# error when creating record			
-						render_error 500, "Model class not found."
+						render_errors 500, "Model class not found."
 						return
 					rescue 
-						# error when creating relationship?
-						@jsonapi_record.destroy if @jsonapi_record 
-
-						render_error 500, "Record could not be created."
+						render_errors 500, @jsonapi_record.to_jsonapi_errors_hash
 						return
 					end
+
+					# relationships
+					received_relationships.each do |relationship|
+						begin
+								# to-one
+								if relationship[:definition][:type] == :to_one
+									@jsonapi_record.send :"#{relationship[:definition][:name]}=", relationship[:params][:data]
+									next
+								end
+
+								# to-many
+								@jsonapi_record.send(relationship[:definition][:name]).send :clear # initialize the relation
+								
+								relationship[:params][:data].each do |item|
+									object = relationship[:receiver][:class].find_by_id item[:id]
+									@jsonapi_record.send(relationship[:definition][:name]).send :<<, object
+								end
+
+						rescue 
+							# Should not happen
+							render_errors 500, "Relationship could not be created."
+							return
+						end
+					end
+
 					show
 				end
 
@@ -108,7 +113,7 @@ module JsonapiForRails::Controller
 				end
 
 				def destroy
-					render_error 500, "Not implemented."
+					render_errors 500, "Not implemented."
 				end
 
 				# private

data/lib/jsonapi_for_rails/controller/actions/relationship.rb

@@ -35,7 +35,7 @@ module JsonapiForRails::Controller
 				# PATCH
 				def relationship_update
 					if @jsonapi_relationship[:definition][:type] == :to_many
-						render_error 403, 'Replacing all members of a to-many relationship is forbidden.'
+						render_errors 403, 'Replacing all members of a to-many relationship is forbidden.'
 						return
 					end
 
@@ -45,7 +45,7 @@ module JsonapiForRails::Controller
 							@jsonapi_relationship[:params][:data][:id]
 						)
 						unless related
-							render_error 403, 'Record not found.'
+							render_errors 403, 'Record not found.'
 							return
 						end
 					end
@@ -57,7 +57,7 @@ module JsonapiForRails::Controller
 				# POST for to-many relations only
 				def relationship_add
 					unless @jsonapi_relationship[:definition][:type] == :to_many
-						render_error 403, 'Operation allowed for to-many relationships only.'
+						render_errors 403, 'Operation allowed for to-many relationships only.'
 						return
 					end
 					
@@ -66,7 +66,7 @@ module JsonapiForRails::Controller
 							record[:id]
 						)
 						unless record
-							render_error 403, "Non-existing record #{record.inspect}."
+							render_errors 403, "Non-existing record #{record.inspect}."
 							return
 						end
 						record
@@ -80,7 +80,7 @@ module JsonapiForRails::Controller
 				# DELETE for to-many relations only
 				def relationship_remove
 					unless @jsonapi_relationship[:definition][:type] == :to_many
-						render_error 403, 'Operation allowed for to-many relationships only.'
+						render_errors 403, 'Operation allowed for to-many relationships only.'
 						return
 					end
 					
@@ -89,7 +89,7 @@ module JsonapiForRails::Controller
 							record[:id]
 						)
 						unless record
-							render_error 403, "Non-existing record #{record.inspect}."
+							render_errors 403, "Non-existing record #{record.inspect}."
 							return
 						end
 						record

data/lib/jsonapi_for_rails/controller/before_actions/content_negotiation.rb

@@ -11,17 +11,62 @@ module JsonapiForRails::Controller
 
 			def self.run_macros receiver
 				receiver.instance_exec do 
-					before_action :content_negotiation
-					private :content_negotiation
+					before_action :jsonapi_content_negotiation, only: [
+						:create, 
+						:update,
+						
+						:relationship_update,
+						:relationship_add,
+						:relationship_remove
+					]
+
+					private :jsonapi_content_negotiation
 				end
 			end
 
 			module InstanceMethods
-				def content_negotiation
-					#$stderr.puts "#{request.headers}" 
-					# TODO: content negotiation
-					return 
-					render_error 401, "Bad request."
+				def jsonapi_content_negotiation
+					jsonapi = ::JsonapiForRails::Controller::Utils::Render::JSONAPI
+
+					# Verify request's Content-Type header #######################
+					content_type = request.headers['Content-Type']
+					if content_type.nil? or content_type.strip != jsonapi[:content_type]
+						# TODO: DEPRECATION WARNING: `:nothing` option is deprecated and will be removed in Rails 5.1. Use `head` method to respond with empty response body. 
+						render status: :unsupported_media_type, nothing: true # 415
+						return
+					end
+
+					# Verify request's Accept header #############################
+					loop do
+						# Request must have Accept header
+						accept = request.headers['Accept']
+						break unless accept
+
+						# Accept header's media ranges must match the JSONAPI media type
+						acceptable = false
+						jsonapi[:media_ranges].each do |media_range|
+							index = accept.index media_range
+							next unless index
+
+							acceptable = true
+
+							# Generic media range match?
+							next unless media_range == jsonapi[:content_type]
+
+							# JSONAPI media type match
+							if accept[(index+media_range.size)..-1] =~ /^\s*;/
+								# Media type parameter detected
+								acceptable = false
+								break
+							end
+						end
+						break unless acceptable
+
+						return
+					end
+
+					# TODO: DEPRECATION WARNING: `:nothing` option is deprecated and will be removed in Rails 5.1. Use `head` method to respond with empty response body. 
+					render :not_acceptable, nothing: true # 406
 				end
 
 			end

data/lib/jsonapi_for_rails/controller/before_actions/record.rb

@@ -38,7 +38,7 @@ module JsonapiForRails::Controller
 					end
 					#$stderr.puts "@jsonapi_record: #{@jsonapi_record.inspect}" 
 					return if @jsonapi_record
-					render_error 401, "Bad request."
+					render_errors 401, "Bad request."
 				end
 
 			end

data/lib/jsonapi_for_rails/controller/before_actions/relationship.rb

@@ -26,7 +26,7 @@ module JsonapiForRails::Controller
 					@jsonapi_relationship = received_relationships.first
 					return if @jsonapi_relationship
 
-					render_error 401, "Bad request."
+					render_errors 401, "Bad request."
 				end
 			end
 		end

data/lib/jsonapi_for_rails/controller/utils/render.rb

@@ -11,50 +11,69 @@ module JsonapiForRails::Controller
 
 			JSONAPI = {
 				specification: 'http://jsonapi.org/format/',
-				content_type: 'application/vnd.api+json'
+				content_type: 'application/vnd.api+json',
+				media_range: [
+					'*/*',
+					'application/*',
+					'application/vnd.api+json'
+				]
 			}.freeze
 
 			def self.run_macros receiver
 				receiver.instance_exec do 
-					private :render_json, :render_error
+					private :render_json, :render_errors
 				end
 			end
 
 			module InstanceMethods
 				def render_json object
-					unless object
-						render_error 500, 'No message specified.'
-						return
-					end
-
+					# Status code
 					@jsonapi_status = 200
-					@jsonapi_json = ['development', 'test'].include?(Rails.env) ? JSON.pretty_generate(object) : JSON.generate(object)
-					@jsonapi_content_type = JSONAPI[:content_type]
 
+					# Generate json
+					@jsonapi_json = JSON.generate(object)
+
+					# Render
 					render(
 						plain:        @jsonapi_json,
-						#json:         @jsonapi_json, 
-						status:       @jsonapi_status, 
-						content_type: @jsonapi_content_type
+						status:       @jsonapi_status
 					)
+
+					# Set content type
+					@jsonapi_content_type = JSONAPI[:content_type]
+					response.headers['Content-Type'] = @jsonapi_content_type
 				end
 
-				def render_error status, title
+				def render_errors status, argument
+					# Status code
 					@jsonapi_status = status
-					object = {
-						errors: [
-							{title: title}
-						]
-					}
-					@jsonapi_json = ['development', 'test'].include?(Rails.env) ? JSON.pretty_generate(object) : JSON.generate(object)
-					@jsonapi_content_type = JSONAPI[:content_type]
 
+					# Generate json
+					if argument.kind_of? Hash
+						message = argument
+					elsif argument.kind_of? Array
+						message = {
+							errors: argument
+						}
+					else
+						message = {
+							errors: [
+								{detail: argument.to_s}
+							]
+						}
+					end
+
+					@jsonapi_json = JSON.generate(message)
+
+					# Render
 					render(
 						plain:        @jsonapi_json,
-						#json:         @jsonapi_json, 
-						status:       @jsonapi_status, 
-						content_type: @jsonapi_content_type
+						status:       @jsonapi_status
 					)
+
+					# Set content type
+					@jsonapi_content_type = JSONAPI[:content_type]
+					response.headers['Content-Type'] = @jsonapi_content_type
 				end
 			end
 

data/lib/jsonapi_for_rails/controller.rb

@@ -17,12 +17,12 @@ module JsonapiForRails::Controller
 	end
 
 	class_methods do
-		def acts_as_jsonapi_resources model: nil
+		def acts_as_jsonapi_resources content_negotiation: true #, model: nil
 			#$stderr.puts "JsonapiForRails::Controller macro called from #{self}:\n  acts_as_jsonapi_resources(model: #{model or 'nil'})" 
 
 			include JsonapiForRails::Controller::Utils::Model
 			include JsonapiForRails::Controller::Utils::Render
-			include JsonapiForRails::Controller::BeforeActions::ContentNegotiation
+			include JsonapiForRails::Controller::BeforeActions::ContentNegotiation if content_negotiation
 			include JsonapiForRails::Controller::BeforeActions::SparseFieldsets
 			include JsonapiForRails::Controller::BeforeActions::Include
 			include JsonapiForRails::Controller::BeforeActions::Record

data/lib/jsonapi_for_rails/model.rb

@@ -25,6 +25,7 @@ module JsonapiForRails::Model
 					if sparse_fieldset
 						next unless sparse_fieldset.find{|f| association.name == f}
 					end
+
 					relationship = {}
 					relationships[association.name] = relationship
 
@@ -47,7 +48,6 @@ module JsonapiForRails::Model
 
 					# to-one relationship
 					elsif [
-
 						ActiveRecord::Reflection::HasOneReflection, 
 						ActiveRecord::Reflection::BelongsToReflection
 						].include? association.class
@@ -66,25 +66,35 @@ module JsonapiForRails::Model
 
 				# message
 				{
-=begin
-					meta: {
-						generated_by_class: "#{self.class}"
-					},
-=end
 					data: {
-						type:       jsonapi_model_type,
-						id:         self.id.to_s,
-
-						attributes: attrs,
-
+						type:          jsonapi_model_type,
+						id:            self.id.to_s,
+						attributes:    attrs,
 						relationships: relationships
 					}
 				}
 
 			end
 
+			def to_jsonapi_errors_hash
+				{
+					errors: errors.messages.to_a.reduce([]){ |result, key_value|
+						attribute = key_value.first
+						messages  = key_value.last
+						result + messages.map{ |message|
+							{
+								detail:     message,
+								source: {
+									pointer: "/data/attributes/#{attribute}",
+								}
+							}
+						}
+					}
+				}
+			end
+
 			def jsonapi_model_type
-				"#{self.class}".underscore.pluralize.to_sym
+				self.class.to_s.underscore.pluralize.to_sym
 			end
 
 			private :jsonapi_model_type

data/lib/jsonapi_for_rails/version.rb

@@ -1,3 +1,4 @@
 module JsonapiForRails
-  VERSION = '0.1.7'
+  VERSION = '0.2.0.pre'
+  # implement content negotiation (http://jsonapi.org/format/1.0/#content-negotiation), add content_negotiation keyword argument to acts_as_jasonapi_resources
 end

data/lib/jsonapi_for_rails.rb

@@ -1,11 +1,14 @@
-# TODO: JSONAPI: adding optional members to documents ('jsonapi', 'meta')
-# TODO: JSONAPI: return conformant HTTP status codes
-# TODO: JSONAPI: conformant and rich 'errors' member
-# TODO: JSONAPI: content negotiation
-# TODO: JSONAPI: apply sparse fieldsets _after_ including related resources
-# TODO: JSONAPI: should included resources list their relationships (which links to primary object)?
-# TODO: JSONAPI: do not support Client-Generated IDs?
-# TODO: JSONAPI: Location header
+
+# TODO: content negotiation tests
+# TODO: apply sparse fieldsets _after_ including related resources
+# TODO: Location header
+# TODO: add 'links' to documents 
+# TODO: return conformant HTTP status codes
+# TODO: options for 'acts_as_jsonapi_resources'? example: {content_negotiation: false}
+# TODO: adding optional members to documents ('jsonapi', 'meta')
+# TODO: conformant and rich 'errors' member
+# TODO: should included resources list their relationships (which links to primary object)?
+# TODO: do not support Client-Generated IDs?
 
 # TODO: README.md: double-check the installation instructions
 # TODO: README.md: describe @jsonapi_include ?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_for_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0.pre
 platform: ruby
 authors:
 - Doga Armangil
@@ -31,7 +31,7 @@ cert_chain:
   DcNXARPdnPlz0VQedZo89pKjngah8Nur01/wD97Q18Mr/av3H4Bg1sTF+RZAplU3
   RX+xYPJjPMyjrD73KZ5UNtXo5jOP1T85SqXOl6ICfedTVgZMk9mzK8+PkP1croHi
   -----END CERTIFICATE-----
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -95,12 +95,7 @@ files:
 homepage: https://github.com/doga/jsonapi_for_rails
 licenses:
 - MIT
-metadata:
-  code: https://github.com/doga/jsonapi_for_rails
-  docs: https://github.com/doga/jsonapi_for_rails#jsonapiforrails
-  wiki: ''
-  mail: ''
-  bugs: https://github.com/doga/jsonapi_for_rails/issues
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -112,9 +107,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1