jsonapi_for_rails 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9cfc12b29fbd2b7976e2f8afdd25efd52b8f1e3
-  data.tar.gz: 4a677ebb54f964c8e339b56dfe2c03d886f669b9
+  metadata.gz: ab53c32125f8532906979ab579f4a60532a47b63
+  data.tar.gz: ef207d433646246f46a7dbeb2b4810cab9ea8f9e
 SHA512:
-  metadata.gz: 9ded9261047e1a2f118251b7003ee0113722c3ef9086d9228d8d1a4943c75633ea509e91519f987c6ea93e664e86beadc55c53c8f86e61bf1b9af2546f6f9628
-  data.tar.gz: b5b734f5214dbde8371c756974a335e92deba05bf18888687b8a7701eac471b16e99190c863151022fe7b7f46ebbf5634b6d8ed056824b2469cf2c84c4b5b06a
+  metadata.gz: 21223af6d72a1bd0e7704894745e41c7bf23c52bb5c0c2a4954ee187006e76de3ef24f1c02719d2057110267abdee2a910f10b4af07a2af9b5a61ce76714257f
+  data.tar.gz: 8b42752921a41e1c8f403158de7407eb7e25bb4a76e6ed0e41ba8a81bcb4b29b5ce7eab4c7e254973997102de739bbae6e2d13c4c3515dc2f46ddc58530db55e

data/README.md

@@ -1,6 +1,33 @@
 # JsonapiForRails
 A [Rails](http://rubyonrails.org/) 5+ plugin for providing a [JSONAPI v1.0](http://jsonapi.org/format/1.0/) API from your application with very little coding.
 
+## Installation
+
+### Official version
+
+```bash
+$ # Go to the root directory of your existing Rails application
+$ cd path/to/railsapp
+$
+$ # Update the gem file
+$ cat >> Gemfile
+gem 'jsonapi_for_rails'
+$
+$ # Install
+$ bundle install
+```
+
+### Edge version
+
+```bash
+$ cd path/to/railsapp
+$ cat >> Gemfile
+group :development do
+  gem 'jsonapi_for_rails', git: 'https://github.com/doga/jsonapi_for_rails.git'
+end
+$ bundle install
+```
+
 ## Usage
 
 ### 1. Set up one API controller per model
@@ -8,16 +35,15 @@ A [Rails](http://rubyonrails.org/) 5+ plugin for providing a [JSONAPI v1.0](http
 Generate a controller for each model that will be accessible from your API. Controller names need to be the plural version of your model names.
 
 ```bash
-$ # Go to the root directory of your existing Rails application
 $ cd path/to/railsapp
 $
 $ # Generate your models
-$ bin/rails generate model author
 $ bin/rails generate model article
+$ bin/rails generate model author
 $
 $ # Generate your API controllers
-$ bin/rails generate controller authors
 $ bin/rails generate controller articles
+$ bin/rails generate controller authors
 ```
 
 Then enable JSONAPI in a parent class of your API controllers. 
@@ -46,14 +72,14 @@ end
 ```
 
 ```ruby
-# app/controllers/authors_controller.rb
+# app/controllers/articles_controller.rb
 
 # Change the API controller's parent class
-class AuthorsController < JsonapiResourcesController
+class ArticlesController < JsonapiResourcesController
   # ...
 end
 
-# Do the same with ArticlesController
+# Do the same with AuthorsController
 ```
 
 ### 2. Configure your API controller routes
@@ -67,7 +93,7 @@ Rails.application.routes.draw do
   scope '/api/v1' do # Optional scoping
 
     [ # List your API controllers here
-      :authors, :articles
+      :articles, :authors
     ].each do |resources_name|
       resources resources_name do
         controller resources_name do
@@ -98,7 +124,7 @@ $ # Get an article
 $ curl 'http://localhost:3000/api/v1/articles/184578894'
 {"data":{"type":"articles","id":618037523,"attributes":{"title":"UK bank pay and bonuses in the spotlight as results season starts","content":"The pay deals handed to the bosses of Britain’s biggest banks will be in focus ...","created_at":"2016-02-22T16:57:43.401Z","updated_at":"2016-02-22T16:57:43.401Z"},"relationships":{"author":{"data":{"type":"authors","id":1023487079}}}}}
 $
-$ # Get only the title of an article, include the author name
+$ # Get only the title and author of an article, include the author's name
 $ curl 'http://localhost:3000/api/v1/articles/184578894?filter%5Barticles%5D=title,author;include=author;filter%5Bauthors%5D=name'
 {"data":{"type":"articles","id":618037523,"attributes":{"title":"UK bank pay and bonuses in the spotlight as results season starts"},"relationships":{"author":{"data":{"type":"authors","id":1023487079}}}},"include":[{"data":{"type":"authors","id":1023487079,"attributes":{"name":"..."},"relationships":{}}}]}
 
@@ -167,7 +193,6 @@ class ArticlesController < JsonapiResourcesController
 
   def index
     jsonapi_model_class      # =>  Article
-    jsonapi_model_class_name # => "Article"
     jsonapi_model_type       # => :articles
 
     # ...
@@ -180,7 +205,19 @@ class ArticlesController < JsonapiResourcesController
   end
 
   def relationship_show
-    @jsonapi_relationship # => {:definition=>{:name=>:author, :type=>:to_one, :receiver=>{:type=>:authors, :class=>Author}}
+    # @jsonapi_relationship is available in all relationship actions.
+    # @jsonapi_relationship[:definition] describes the current relationship.
+    @jsonapi_relationship # => {:definition=>{:name=>:author, :type=>:to_one, :receiver=>{:type=>:authors, :class=>Author}}}
+
+    # ...
+  end
+
+  def relationship_update
+    # @jsonapi_relationship[:params] contains the parsed request body.
+    # It is available for all relationship actions except relationship_show.
+    # @jsonapi_relationship[:params][:data] is a Hash for relationships 
+    # of type :to_one, and an Array for relationships of type :to_many.
+    @jsonapi_relationship # => {:definition=>{...}, :params=>{"data"=>{"type"=>"authors", "id"=>"234455384"}}}
 
     # ...
   end
@@ -196,34 +233,8 @@ end
 * [Deleting resources](http://jsonapi.org/format/1.0/#crud-deleting) is currently not implemented.
 * Test coverage is sparse.
 
-## Installation
-
-### Edge version
-
-```bash
-$ # Clone this repository
-$ git clone 'https://github.com/doga/jsonapi_for_rails.git'
-$
-$ # Update your Rails application's gem file
-$ cat >> path/to/Gemfile
-
-group :development do
-  gem 'jsonapi_for_rails', path: 'path/to/jsonapi_for_rails'
-  #gem 'jsonapi_for_rails', git: 'https://github.com/doga/jsonapi_for_rails.git'
-end
-```
-
-### Latest stable version
-
-```bash
-$ # Update your Rails application's gem file
-$ cat >> path/to/Gemfile
-
-gem 'jsonapi_for_rails'
-```
-
 ## Contributing
-If you find a bug in this project, have trouble following the documentation or have a question about the project – create an [issue](https://guides.github.com/activities/contributing-to-open-source/#contributing).
+If you find a bug in this project, have trouble following the documentation or have a question about the project – create an [issue](https://github.com/doga/jsonapi_for_rails/issues).
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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

@@ -170,6 +170,7 @@ module JsonapiForRails::Controller
 					end.compact
 				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
@@ -230,7 +231,7 @@ module JsonapiForRails::Controller
 									conformant = false
 									break
 								end
-								conformant = false unless received_params[:data][:type] == relationship[:receiver][:type]
+								conformant = false unless received_params[:data][:type].to_sym == relationship[:receiver][:type]
 
 								break
 							end

data/lib/jsonapi_for_rails/version.rb

@@ -1,3 +1,3 @@
 module JsonapiForRails
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/jsonapi_for_rails.rb

@@ -1,7 +1,19 @@
 
-# TODO: send pull request to add jsonapi_for_rails to JSON API implementations list (http://jsonapi.org/implementations/)
-# TODO: double-check the installation instructions in README.md
-# TODO: 'Contributing' section in README.md
+# TODO: JSONAPI: id of resource object is a string
+# 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: README.md: double-check the installation instructions
+# TODO: README.md: better describe @jsonapi_relationship (what can it contain besides 'definition'?)
+# TODO: README.md: describe @jsonapi_include?
+# TODO: README.md: describe @jsonapi_sparse_fieldsets?
+
 
 require "jsonapi_for_rails/version"
 require "jsonapi_for_rails/controller"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_for_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Doga Armangil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,8 +44,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Jsonapi for Rails empowers your JSON API (http://jsonapi.org/format/)
-  compliant Rails APIs. Implement your REST API with very little coding.
+description: Jsonapi for Rails empowers your JSON API compliant APIs. Requires with
+  very little coding. http://jsonapi.org/format/
 email:
 - doga.armangil@alumni.epfl.ch
 executables: []
@@ -91,5 +91,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A Rails plugin for providing JSON API compliant APIs with very little coding.
+summary: Jsonapi for Rails empowers your JSON API compliant APIs
 test_files: []