jsonapi_for_rails 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69b79b4230ffd98fd6046ddcc70ef3469b39fafc
-  data.tar.gz: 66864910b74b564e07f9c18e25c346c665656d5a
+  metadata.gz: 6afda53ef8dd36273d0b5365f89058551f62a7ef
+  data.tar.gz: fe345dd87616f5026a78093225a39097dff12c40
 SHA512:
-  metadata.gz: 0b7a960d5e6778940a75a9be27c5af70424ea71264b0032c8fa5deded47db55670642b7c88fbf951abd451c003ec12cac29c65889fcf0fdf84b4753db14a946c
-  data.tar.gz: d9e63036c68538bdf502a677f7ca6452a3293abb5b060f29e165a5976d38d26e849f07dbf143a543e067a9a90953f53b76f7952e4a01ebffe8849a0cd7269887
+  metadata.gz: 5b5f3aa2d2afa1dca312b61350aa9f962cc82f01cb34383b416f982ad078ca2793a8050782aa5646aeaade5a2a934222b1af2368530c894255595d45e81d580b
+  data.tar.gz: 4675588d3f5ac6b88528da09b31de0056f761c404477a7bb9ab6d22099a307fdf8ab0a25fc5774ebf25e365a71b348595c171a6533bf6a9a3aa6ca2676f0f667

checksums.yaml.gz.sig

@@ -1 +1 @@
-��j�����q�W)T_6�C{���ڠ���r?�dWhL��0�ڒ�_�^&��wL�X��e�B�M�C&��k'�%���x܋$4J+5�k�a�����Z��3W�:a9�rR(� �!��5,o*��"�f[��
+�x�=�V�����9R�5�����S��9���`�w��d9\Ģ�L�%lv�5�;k!j鳝����8"]��8���j�{8�DВ��U^6O���q��F�p;�$�V"�МDb�‡D���{������Y��6~���ܷ��ɴ�Q+�c�p���K��Q;��A��uoRu����zԥ>%ё�/l�^�*��~�n��oM����ҍ���w��緦xC	��|��8��M�c�����mVb{F�EU�

data/lib/jsonapi_for_rails.rb

@@ -22,5 +22,6 @@ require "jsonapi_for_rails/model"
 ActionController::Metal.send :include, JsonapiForRails::Controller
 
 # Add 'to_jsonapi_hash' instance method to models
+# TODO: ApplicationRecord instead of ActiveRecord::Base
 ActiveRecord::Base.send      :include, JsonapiForRails::Model
 

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

@@ -27,7 +27,7 @@ module JsonapiForRails::Controller
 						}
 					end
 
-					render_json @json
+					jsonapi_render @json
 				end
 
 				# implements Create and Update operations
@@ -35,7 +35,7 @@ module JsonapiForRails::Controller
 
 					# attributes
 					begin
-						attrs = received_attributes
+						attrs = jsonapi_received_attributes
 						if attrs
 							if @jsonapi_record
 								# update
@@ -47,15 +47,15 @@ module JsonapiForRails::Controller
 							end
 						end
 					rescue NameError => e
-						render_errors 500, "Model class not found."
+						jsonapi_render_errors 500, "Model class not found."
 						return
 					rescue 
-						render_errors 500, @jsonapi_record.to_jsonapi_errors_hash
+						jsonapi_render_errors 500, @jsonapi_record.to_jsonapi_errors_hash
 						return
 					end
 
 					# relationships
-					received_relationships.each do |relationship|
+					jsonapi_received_relationships.each do |relationship|
 						begin
 								# to-one
 								if relationship[:definition][:type] == :to_one
@@ -73,7 +73,7 @@ module JsonapiForRails::Controller
 
 						rescue 
 							# Should not happen
-							render_errors 500, "Relationship could not be created."
+							jsonapi_render_errors 500, "Relationship could not be created."
 							return
 						end
 					end
@@ -149,7 +149,7 @@ module JsonapiForRails::Controller
 						end
 					end
 
-					render_json @json
+					jsonapi_render @json
 				end
 
 				def update
@@ -157,7 +157,7 @@ module JsonapiForRails::Controller
 				end
 
 				def destroy
-					render_errors 500, "Not implemented."
+					jsonapi_render_errors 500, "Not implemented."
 				end
 
 				# private
@@ -166,7 +166,7 @@ module JsonapiForRails::Controller
 				# Use this for creating/updating a database record.
 				# Note that relationships (has_one associations etc) are filtered out
 				# but are still available in the original params.
-				def received_attributes
+				def jsonapi_received_attributes
 					begin
 						params.require(
 							:data
@@ -192,9 +192,10 @@ module JsonapiForRails::Controller
 					end
 				end
 
-				def relationships
+				# Definitions of all relationships for current model
+				def jsonapi_relationships
 					jsonapi_model_class.reflect_on_all_associations.collect do |association|
-						type = nil
+						#type = nil
 
 						type = :to_one if [
 							ActiveRecord::Reflection::HasOneReflection, 
@@ -212,7 +213,7 @@ module JsonapiForRails::Controller
 							name: association.name,
 							type: type,
 							receiver: {
-								type: association.klass.to_s.underscore.pluralize.to_sym,
+								type:  association.klass.to_s.underscore.pluralize.to_sym,
 								class: association.klass.to_s.constantize
 							}
 						}
@@ -220,28 +221,40 @@ module JsonapiForRails::Controller
 				end
 
 				# TODO: define a separate method for relationship actions (i.e. when params[:relationship] != nil)
-				def received_relationships
-					rels = relationships
-					if params[:relationship] # only one relationship received for relationship action
+				def jsonapi_received_relationships
+					# Relationship definitions for current model
+					rels = jsonapi_relationships
+
+					# Consider only current relationship for relationship actions
+					# (params[:relationship] contains the relationship name)
+					if params[:relationship] 
+
 						rels.select! do |rel|
 							rel[:name].to_sym == params[:relationship].to_sym
 						end
+
+						# If no relationship is received, then return the definition only
 						if request.method == "GET"
-							# no relationship received, return definition only
 							return rels.collect do |rel|
 								{definition: rel}
 							end
 						end
+
 					end
+
 					rels.collect do |relationship|
 						begin
 							received_params = nil
+
+							# Relationship action
 							if params[:relationship]
 								received_params =  params.permit({
 									data: [
 										:type, :id
 									]
 								})
+
+							# Object action
 							else
 								received_params =  params.require( 
 									:data
@@ -268,7 +281,7 @@ module JsonapiForRails::Controller
 										break
 									end
 									received_params[:data].each do |item|
-										next if item[:type] == relationship[:receiver][:type]
+										next if item[:type].to_sym == relationship[:receiver][:type]
 										conformant = false
 										break
 									end
@@ -331,9 +344,9 @@ module JsonapiForRails::Controller
 
 			def self.run_macros receiver
 				receiver.instance_exec do 
-					private :received_attributes
-					private :relationships
-					private :received_relationships
+					private :jsonapi_received_attributes
+					private :jsonapi_relationships
+					private :jsonapi_received_relationships
 				end
 			end
 

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

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

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_errors 401, "Bad request."
+					jsonapi_render_errors 401, "Bad request."
 				end
 
 			end

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

@@ -22,11 +22,14 @@ module JsonapiForRails::Controller
 
 			module InstanceMethods
 				def jsonapi_require_relationship
-					#$stderr.puts "JsonapiForRails::Controller::RelationshipFromRequest#jsonapi_require_relationship called" 
-					@jsonapi_relationship = received_relationships.first
+					#$stderr.puts "@@@@@@@@@@@@@@ jsonapi_require_relationship" 
+					#log_request
+					#$stderr.puts "#{jsonapi_received_relationships.inspect}" 
+
+					@jsonapi_relationship = jsonapi_received_relationships.first
 					return if @jsonapi_relationship
 
-					render_errors 401, "Bad request."
+					jsonapi_render_errors 401, "Bad request."
 				end
 			end
 		end

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

@@ -21,12 +21,12 @@ module JsonapiForRails::Controller
 
 			def self.run_macros receiver
 				receiver.instance_exec do 
-					private :render_json, :render_errors
+					private :jsonapi_render, :jsonapi_render_errors
 				end
 			end
 
 			module InstanceMethods
-				def render_json object
+				def jsonapi_render object
 					# Status code
 					@jsonapi_status = 200
 
@@ -44,7 +44,7 @@ module JsonapiForRails::Controller
 					response.headers['Content-Type'] = @jsonapi_content_type
 				end
 
-				def render_errors status, argument
+				def jsonapi_render_errors status, argument
 					# Status code
 					@jsonapi_status = status
 

data/lib/jsonapi_for_rails/version.rb

@@ -1,3 +1,3 @@
 module JsonapiForRails
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_for_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Doga Armangil