jsonapi_for_rails 0.2.0.pre → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da54359b12e07d61046ce9a96b2b0c8edadb2af2
-  data.tar.gz: bef39399515bd6b7b6a10d5466d26d45c60807ec
+  metadata.gz: 69b79b4230ffd98fd6046ddcc70ef3469b39fafc
+  data.tar.gz: 66864910b74b564e07f9c18e25c346c665656d5a
 SHA512:
-  metadata.gz: 5e422031d14cea9d91d30591ceafb5616f868b6cd4471c34a705a7ae7837c9aabc4c74acb6627efaa78f7e311b7a6ec640d9b35fe2533ccd419fc1d1d1acf34a
-  data.tar.gz: 5750ba36ebe04753855d98914a1fa700f23db4da0541a97d7551b9821c89713a256264f2c9d34fc0400d8a4c67c7f49e47a32d7b187db4e0f933e41692bbe0ee
+  metadata.gz: 0b7a960d5e6778940a75a9be27c5af70424ea71264b0032c8fa5deded47db55670642b7c88fbf951abd451c003ec12cac29c65889fcf0fdf84b4753db14a946c
+  data.tar.gz: d9e63036c68538bdf502a677f7ca6452a3293abb5b060f29e165a5976d38d26e849f07dbf143a543e067a9a90953f53b76f7952e4a01ebffe8849a0cd7269887

data/README.md

@@ -34,7 +34,7 @@ $
 $ # Check the used version
 $ bin/rails console
 irb(main):001:0> JsonapiForRails::VERSION
-=> "0.2.0.pre"
+=> "0.2.0"
 irb(main):002:0> exit
 $
 ```
@@ -64,7 +64,10 @@ Then enable JSONAPI in a parent class of your API controllers.
 class ApplicationController < ActionController::Base # or ActionController::API
 
   # Enable JSONAPI
-  acts_as_jsonapi_resources
+  acts_as_jsonapi_resources(
+    # links:               false,
+    # content_negotiation: false
+  )
 
   # ...
 end
@@ -72,9 +75,11 @@ 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`
+* `links`: Setting this to `false` disables
+  [link generation](http://jsonapi.org/format/1.0/#document-links),
+  and speeds up your API. The default value is `true`.
+* `content_negotiation`: Setting this to `false` disables
+  [content negotiation](http://jsonapi.org/format/1.0/#content-negotiation). Again, this helps speed up your API, but at the expense of making your API non-JSONAPI-compliant, if only just). The default value is `true`. 
 
 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`. 
 
@@ -134,7 +139,7 @@ After populating your database and launching the built-in Rails server with the
 
 ```bash
 $ # Get the list of articles
-$ # (the returned HTTP response body is short and terse, but it is prettified here for legibility)
+$ # (the returned HTTP response body is short and terse, but is prettified here for legibility)
 $ curl 'http://localhost:3000/api/v1/articles'
 {
   "data": [
@@ -146,7 +151,10 @@ $ curl 'http://localhost:3000/api/v1/articles'
       "type": "articles",
       "id": "994552601"
     }
-  ]
+  ],
+  "links": {
+    "self": "/api/v1/articles"
+  }
 }
 $ # Get an article
 $ curl 'http://localhost:3000/api/v1/articles/618037523'
@@ -167,6 +175,9 @@ $ curl 'http://localhost:3000/api/v1/articles/618037523'
           "id": "1023487079"
         }
       }
+    },
+    "links": {
+      "self": "/api/v1/articles/618037523"
     }
   }
 }
@@ -186,6 +197,9 @@ $ curl 'http://localhost:3000/api/v1/articles/618037523?filter%5Barticles%5D=tit
           "id": "1023487079"
         }
       }
+    },
+    "links": {
+      "self": "/api/v1/articles/618037523"
     }
   },
   "include": [
@@ -197,6 +211,9 @@ $ curl 'http://localhost:3000/api/v1/articles/618037523?filter%5Barticles%5D=tit
           "name": "Jill T..."
         },
         "relationships": {
+        },
+        "links": {
+          "self": "/api/v1/authors/1023487079"
         }
       }
     }
@@ -268,8 +285,12 @@ class ArticlesController < JsonapiResourcesController
 
   def index
     # These model-related utility methods are available inside all action methods.
-    jsonapi_model_class      # =>  Article
-    jsonapi_model_type       # => :articles
+    jsonapi_model_class # =>  Article
+    jsonapi_model_type  # => :articles
+
+    # @jsonapi_links indicates whether links should be included in response documents.
+    # It is available inside all action methods.
+    @jsonapi_links      # => true
 
     # ...
   end
@@ -310,7 +331,8 @@ 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.
+* [Content negotiation](http://jsonapi.org/format/1.0/#content-negotiation) is implemented and enabled by default, but can be disabled.
+* [Link generation](http://jsonapi.org/format/1.0/#document-links) is implemented and enabled by default, but can be disabled.
 * [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/lib/jsonapi_for_rails/controller/actions/object.rb

@@ -17,6 +17,16 @@ module JsonapiForRails::Controller
 							id:   record.id.to_s
 						}
 					end
+
+					# Links
+					if @jsonapi_links
+						@json[:links] = {
+							self: self.send(
+								"#{jsonapi_model_type}_path" # TODO: factor out
+							)
+						}
+					end
+
 					render_json @json
 				end
 
@@ -72,9 +82,30 @@ module JsonapiForRails::Controller
 				end
 
 				def show
+					# Attributes and relationships
 					@json = @jsonapi_record.to_jsonapi_hash(
-						@jsonapi_sparse_fieldsets[jsonapi_model_type]
+						 sparse_fieldset: @jsonapi_sparse_fieldsets[jsonapi_model_type]
 					)
+
+					# Links
+					if @jsonapi_links
+
+						# Current resource
+						@json[:data][:links] = {
+							self: self.send(
+								"#{jsonapi_model_type.to_s.singularize}_path", # TODO: factor out
+								@jsonapi_record.id
+							)
+						}
+
+						# Related resources
+						@json[:data][:relationships].each do |rel_name, rel|
+							rel[:links] = {
+								self: "#{@json[:data][:links][:self]}/relationships/#{rel_name}"
+							}
+						end
+					end
+
 					#$stderr.puts "#{@json}" 
 
 					# Include resources
@@ -98,9 +129,22 @@ module JsonapiForRails::Controller
 								r = klass.find_by_id r[:id]
 								next unless r
 
-								@json[:include] << r.to_jsonapi_hash(
-									@jsonapi_sparse_fieldsets[type]
+								# Attributes and relationships
+								r = r.to_jsonapi_hash(
+									sparse_fieldset: @jsonapi_sparse_fieldsets[type]
 								)
+
+								# Links
+								if @jsonapi_links
+									r[:links] = {
+										self: self.send(
+											"#{r[:data][:type].to_s.singularize}_path", # TODO: factor out
+											r[:data][:id]
+										)
+									}
+								end
+
+								@json[:include] << r
 							end
 						end
 					end

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

@@ -29,6 +29,18 @@ module JsonapiForRails::Controller
 					end
 					@json = {data: @json}
 
+					# Links
+					if @jsonapi_links
+						record_path = self.send(
+							"#{jsonapi_model_type.to_s.singularize}_path",
+							@jsonapi_record.id
+						)
+
+						@json[:links] = {
+							self: "#{record_path}/relationships/#{@jsonapi_relationship[:definition][:name]}"
+						}
+					end
+
 					render_json @json
 				end
 
@@ -52,6 +64,8 @@ module JsonapiForRails::Controller
 
 					@jsonapi_record.send :"#{@jsonapi_relationship[:definition][:name]}=", related
 					@jsonapi_record.save
+
+					#self.send :relationship_show
 				end
 
 				# POST for to-many relations only
@@ -75,6 +89,8 @@ module JsonapiForRails::Controller
 					records.each do |record|
 						@jsonapi_record.send(@jsonapi_relationship[:definition][:name]) << record
 					end
+
+					#self.send :relationship_show
 				end
 
 				# DELETE for to-many relations only
@@ -99,6 +115,8 @@ module JsonapiForRails::Controller
 						@jsonapi_record.send(@jsonapi_relationship[:definition][:name]).delete record
 					end
 				end
+
+				#self.send :relationship_show
 			end
 
 			def self.run_macros receiver

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

@@ -0,0 +1,29 @@
+module JsonapiForRails::Controller
+
+	module BeforeActions
+		module Links
+
+			def self.included receiver
+				receiver.send :include, InstanceMethods
+				run_macros receiver
+			end
+
+			def self.run_macros receiver
+				receiver.instance_exec do 
+					before_action :jsonapi_links
+					private :jsonapi_links
+				end
+			end
+
+			module InstanceMethods
+
+				# Enable links in returned documents
+				def jsonapi_links
+					@jsonapi_links = true
+				end
+
+			end
+		end
+	end
+
+end

data/lib/jsonapi_for_rails/controller.rb

@@ -1,5 +1,6 @@
 require "jsonapi_for_rails/controller/utils/model"
 require "jsonapi_for_rails/controller/utils/render"
+require "jsonapi_for_rails/controller/before_actions/links"
 require "jsonapi_for_rails/controller/before_actions/content_negotiation"
 require "jsonapi_for_rails/controller/before_actions/sparse_fieldsets"
 require "jsonapi_for_rails/controller/before_actions/include"
@@ -17,11 +18,12 @@ module JsonapiForRails::Controller
 	end
 
 	class_methods do
-		def acts_as_jsonapi_resources content_negotiation: true #, model: nil
+		def acts_as_jsonapi_resources links: true, 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::Links              if links
 			include JsonapiForRails::Controller::BeforeActions::ContentNegotiation if content_negotiation
 			include JsonapiForRails::Controller::BeforeActions::SparseFieldsets
 			include JsonapiForRails::Controller::BeforeActions::Include

data/lib/jsonapi_for_rails/model.rb

@@ -6,7 +6,7 @@ module JsonapiForRails::Model
 
 		# Define instance methods
 		class_exec do
-			def to_jsonapi_hash sparse_fieldset=nil
+			def to_jsonapi_hash sparse_fieldset: nil
 				#$stderr.puts "JsonapiForRails::Controller::Actions::Object#show called" 
 
 				# attributes

data/lib/jsonapi_for_rails/version.rb

@@ -1,4 +1,3 @@
 module JsonapiForRails
-  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
+  VERSION = '0.2.0'
 end

data/lib/jsonapi_for_rails.rb

@@ -1,13 +1,12 @@
 
-# TODO: content negotiation tests
+# TODO: README: add instructions for using sparse fieldsets for setting the 
+#               set of attributes to return (ignore binaries etc)
 # 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: included resource objects must not contain a relationship that links back to the primary object
 # TODO: do not support Client-Generated IDs?
 
 # TODO: README.md: double-check the installation instructions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_for_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre
+  version: 0.2.0
 platform: ruby
 authors:
 - Doga Armangil
@@ -31,7 +31,7 @@ cert_chain:
   DcNXARPdnPlz0VQedZo89pKjngah8Nur01/wD97Q18Mr/av3H4Bg1sTF+RZAplU3
   RX+xYPJjPMyjrD73KZ5UNtXo5jOP1T85SqXOl6ICfedTVgZMk9mzK8+PkP1croHi
   -----END CERTIFICATE-----
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,6 +84,7 @@ files:
 - lib/jsonapi_for_rails/controller/actions/relationship.rb
 - lib/jsonapi_for_rails/controller/before_actions/content_negotiation.rb
 - lib/jsonapi_for_rails/controller/before_actions/include.rb
+- lib/jsonapi_for_rails/controller/before_actions/links.rb
 - lib/jsonapi_for_rails/controller/before_actions/record.rb
 - lib/jsonapi_for_rails/controller/before_actions/relationship.rb
 - lib/jsonapi_for_rails/controller/before_actions/sparse_fieldsets.rb
@@ -107,9 +108,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1