jsonapi_for_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e3b34eaf013306f4520bd8beb8ec87594b0dd32
-  data.tar.gz: 5d4a449ef838869e77ac51dc9ee070728595d644
+  metadata.gz: 8f4dd3218dadbf9a805eb8c2436a83167558657a
+  data.tar.gz: 3688d50e8ddea9629ac56428a59ba10018327f6e
 SHA512:
-  metadata.gz: a423f57386943e320ac84399d33d6bc7e685d6bb5ca25f81644b9e91e2a82732e94dfbaef602f0f584ef0e48c17d30db656d6036e8caba3bde9e10cccf218c8c
-  data.tar.gz: ab6ad71dcc6713779f5a6f40be815d18c2847a241af3011524b743f2a226881d044720891ce9c2fbf2d17a99ae8ad6f8465b82a318503329af7048e4a54313c5
+  metadata.gz: c684e85d591a7961b5bda7a34234fe76674670a0c2e06d45eda50c5c8103469cc3356a1cc489b6440b1e85344cb8010466b1ca7c38e29576f9d439b8acbe8e27
+  data.tar.gz: be0e92ba9720ca2692cf685e74bac9d041a9591bc554f89e56185d22c7e09fe8736447a9f6ae48215607591d253bee2640dc66ec0a3e00f64473aace84862e98

data/README.md

@@ -1,11 +1,25 @@
 # 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.
+A [Rails](http://rubyonrails.org/) 4+ plugin for providing [JSONAPI v1.0](http://jsonapi.org/format/1.0/) compliant APIs from your application with very little coding.
+
+* [Installation](#installation)
+* [Usage](#usage)
+  1. [Set up one API controller per model](#1-set-up-one-api-controller-per-model)
+  2. [Configure your API controller routes](#2-configure-your-api-controller-routes)
+  3. [Verify your setup](#3-verify-your-setup)
+* [Modifying the default API behaviour](#modifying-the-default-api-behaviour)
+  * [Client authentication](#client-authentication)
+  * [Access control](#access-control)
+  * [Overriding an API end-point](#overriding-an-api-end-point)
+* [Implementation status](#implementation-status)
+* [Contributing](#contributing)
+* [License](#license)
 
 ## Installation
 
-### Official version
-
 ```bash
+$ # Optional security step (do this once)
+$ gem cert --add <(curl -Ls https://raw.githubusercontent.com/doga/jsonapi_for_rails/master/certs/doga.pem)
+$
 $ # Go to the root directory of your existing Rails application
 $ cd path/to/railsapp
 $
@@ -14,18 +28,15 @@ $ 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
+$ # Optional security paramater: --trust-policy MediumSecurity
+$ bundle install --trust-policy MediumSecurity
+$
+$ # Check the used version
+$ bin/rails console
+irb(main):001:0> JsonapiForRails::VERSION
+=> "0.1.4"
+irb(main):002:0> exit
+$
 ```
 
 ## Usage
@@ -191,6 +202,7 @@ The `bin/rails routes` shell command shows you the end-points that *jsonapi_for_
 class ArticlesController < JsonapiResourcesController 
 
   def index
+    # These model-related utility methods are available inside all action methods.
     jsonapi_model_class      # =>  Article
     jsonapi_model_type       # => :articles
 
@@ -198,13 +210,16 @@ class ArticlesController < JsonapiResourcesController
   end
 
   def show
+    # @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: {...}}
 
     # ...
   end
 
   def relationship_show
-    # @jsonapi_relationship is available in all relationship actions.
+    # @jsonapi_relationship is available in all relationship action methods.
     # @jsonapi_relationship[:definition] describes the current relationship.
     @jsonapi_relationship # => {:definition=>{:name=>:author, :type=>:to_one, :receiver=>{:type=>:authors, :class=>Author}}}
 
@@ -213,9 +228,9 @@ class ArticlesController < JsonapiResourcesController
 
   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] behaves like a Hash for relationships of type :to_one,
-    # and as an Array for relationships of type :to_many.
+    # It is available for all relationship action methods except relationship_show.
+    # @jsonapi_relationship[:params][:data] behaves like a Hash for relationships
+    # of type :to_one, and as an Array for relationships of type :to_many.
     @jsonapi_relationship # => {:definition=>{...}, :params=>{"data"=>{"type"=>"authors", "id"=>"234455384"}}}
 
     # ...
@@ -225,15 +240,18 @@ end
 ```
 
 ## Implementation status
+The internal architecture is sound. Test coverage is currently being bulked up using *Rails 5 beta 2* (but the plugin should be compatible with *Rails 4+*). And missing features are being added. The intention is to release a 1.0 version around mid-2016.
+
+Feature support roundup:
+
 * [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.
 * [Pagination](http://jsonapi.org/format/1.0/#fetching-pagination) is currently not implemented.
 * [Deleting resources](http://jsonapi.org/format/1.0/#crud-deleting) is currently not implemented.
-* Test coverage is sparse.
 
 ## 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).
+Feel free to share your experience using this software. 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/Rakefile

@@ -14,11 +14,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -30,5 +25,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

data/certs/doga.pem

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDvDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBaMRYwFAYDVQQDDA1kb2dh
+LmFybWFuZ2lsMRYwFAYKCZImiZPyLGQBGRYGYWx1bW5pMRQwEgYKCZImiZPyLGQB
+GRYEZXBmbDESMBAGCgmSJomT8ixkARkWAmNoMB4XDTE2MDMwMTE4NTkxNVoXDTE3
+MDMwMTE4NTkxNVowWjEWMBQGA1UEAwwNZG9nYS5hcm1hbmdpbDEWMBQGCgmSJomT
+8ixkARkWBmFsdW1uaTEUMBIGCgmSJomT8ixkARkWBGVwZmwxEjAQBgoJkiaJk/Is
+ZAEZFgJjaDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAO/HdcvdL8y+
+xOpsRnBnu+994HesBTm99Wdu1OMQbEtw/4GaVgMgTYxC2BF7xbX+3GBjc/eqkLA+
+gWM/AUJn7TtWO4GeR19ijOJNyQxsHxcgpY6g3F+xeWHr19G1beyq+w7iBIhEdN/z
+KWx/DwwODbV6aTykrDN/O3k/35oxYV8XQMr+evS6o7JaXtyljhDPWf35hFlURuFq
+La9PtZhY1unxWnGCR+B6tWa24LaIFdeiBwf9pHwXfTwt2ZhZ5irvs83Ky0RXQaRv
+DwC+RTxGRQJJj7BixJahfAWrZWxuz1zTSmQp68AnyN8W4ADxqE3VNBCa6JaAaGOY
+auE8CdBGa7sCAwEAAaOBjDCBiTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+HQ4EFgQU7XakNR7mnqaRKNxVQp0VN6ALXJYwJwYDVR0RBCAwHoEcZG9nYS5hcm1h
+bmdpbEBhbHVtbmkuZXBmbC5jaDAnBgNVHRIEIDAegRxkb2dhLmFybWFuZ2lsQGFs
+dW1uaS5lcGZsLmNoMA0GCSqGSIb3DQEBBQUAA4IBAQCsvTAMTDeIpCVPNiZZA4Mf
+EY8w+8aqVj61/3PdOHLX5bWlTVh0nRn5bTWzFknYowN+GQIqoChbJRC/qRTxaVYj
+5rqO5NlAIIqfTDXqMlcd6UjyvoXDyx4eiJ2CEjuGRTj3vrCzu6spFWyQ+Ob7j8pt
+U6NxOu51DyU3Rn3cq95Ov2i8z9hGKgS7bKMNv2y4nVz9MRi3RCJLVUbU0m0roAWO
+DcNXARPdnPlz0VQedZo89pKjngah8Nur01/wD97Q18Mr/av3H4Bg1sTF+RZAplU3
+RX+xYPJjPMyjrD73KZ5UNtXo5jOP1T85SqXOl6ICfedTVgZMk9mzK8+PkP1croHi
+-----END CERTIFICATE-----

data/lib/jsonapi_for_rails/version.rb

@@ -1,5 +1,6 @@
 module JsonapiForRails
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
+  # 0.1.5: add digital signature
   # 0.1.4: gem now requires rails >= 4 instead of 5.0.0.beta2
   # 0.1.3: fix non-string id bug (http://jsonapi.org/format/1.0/#document-resource-object-identification)
   # 0.1.2: add ruby 2.0 dependency to gem

data/lib/jsonapi_for_rails.rb

@@ -1,4 +1,3 @@
-# BUG: convert ids to strings in received data 
 # TODO: JSONAPI: adding optional members to documents ('jsonapi', 'meta')
 # TODO: JSONAPI: return conformant HTTP status codes
 # TODO: JSONAPI: conformant and rich 'errors' member
@@ -9,8 +8,8 @@
 # TODO: JSONAPI: Location header
 
 # TODO: README.md: double-check the installation instructions
-# TODO: README.md: describe @jsonapi_include?
-# TODO: README.md: describe @jsonapi_sparse_fieldsets?
+# TODO: README.md: describe @jsonapi_include ?
+# TODO: README.md: describe @jsonapi_sparse_fieldsets ?
 
 
 require "jsonapi_for_rails/version"

metadata

@@ -1,14 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_for_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Doga Armangil
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2016-02-27 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDvDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBaMRYwFAYDVQQDDA1kb2dh
+  LmFybWFuZ2lsMRYwFAYKCZImiZPyLGQBGRYGYWx1bW5pMRQwEgYKCZImiZPyLGQB
+  GRYEZXBmbDESMBAGCgmSJomT8ixkARkWAmNoMB4XDTE2MDMwMTE4NTkxNVoXDTE3
+  MDMwMTE4NTkxNVowWjEWMBQGA1UEAwwNZG9nYS5hcm1hbmdpbDEWMBQGCgmSJomT
+  8ixkARkWBmFsdW1uaTEUMBIGCgmSJomT8ixkARkWBGVwZmwxEjAQBgoJkiaJk/Is
+  ZAEZFgJjaDCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAO/HdcvdL8y+
+  xOpsRnBnu+994HesBTm99Wdu1OMQbEtw/4GaVgMgTYxC2BF7xbX+3GBjc/eqkLA+
+  gWM/AUJn7TtWO4GeR19ijOJNyQxsHxcgpY6g3F+xeWHr19G1beyq+w7iBIhEdN/z
+  KWx/DwwODbV6aTykrDN/O3k/35oxYV8XQMr+evS6o7JaXtyljhDPWf35hFlURuFq
+  La9PtZhY1unxWnGCR+B6tWa24LaIFdeiBwf9pHwXfTwt2ZhZ5irvs83Ky0RXQaRv
+  DwC+RTxGRQJJj7BixJahfAWrZWxuz1zTSmQp68AnyN8W4ADxqE3VNBCa6JaAaGOY
+  auE8CdBGa7sCAwEAAaOBjDCBiTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQU7XakNR7mnqaRKNxVQp0VN6ALXJYwJwYDVR0RBCAwHoEcZG9nYS5hcm1h
+  bmdpbEBhbHVtbmkuZXBmbC5jaDAnBgNVHRIEIDAegRxkb2dhLmFybWFuZ2lsQGFs
+  dW1uaS5lcGZsLmNoMA0GCSqGSIb3DQEBBQUAA4IBAQCsvTAMTDeIpCVPNiZZA4Mf
+  EY8w+8aqVj61/3PdOHLX5bWlTVh0nRn5bTWzFknYowN+GQIqoChbJRC/qRTxaVYj
+  5rqO5NlAIIqfTDXqMlcd6UjyvoXDyx4eiJ2CEjuGRTj3vrCzu6spFWyQ+Ob7j8pt
+  U6NxOu51DyU3Rn3cq95Ov2i8z9hGKgS7bKMNv2y4nVz9MRi3RCJLVUbU0m0roAWO
+  DcNXARPdnPlz0VQedZo89pKjngah8Nur01/wD97Q18Mr/av3H4Bg1sTF+RZAplU3
+  RX+xYPJjPMyjrD73KZ5UNtXo5jOP1T85SqXOl6ICfedTVgZMk9mzK8+PkP1croHi
+  -----END CERTIFICATE-----
+date: 2016-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,16 +59,15 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Jsonapi for Rails empowers your JSON API compliant APIs. Requires with
-  very little coding. http://jsonapi.org/format/
+        version: '1.3'
+description: 
 email:
 - doga.armangil@alumni.epfl.ch
 executables: []
@@ -55,6 +77,7 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- certs/doga.pem
 - lib/jsonapi_for_rails.rb
 - lib/jsonapi_for_rails/controller.rb
 - lib/jsonapi_for_rails/controller/actions/object.rb
@@ -72,7 +95,12 @@ files:
 homepage: https://github.com/doga/jsonapi_for_rails
 licenses:
 - MIT
-metadata: {}
+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
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -92,5 +120,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Jsonapi for Rails empowers your JSON API compliant APIs
+summary: Jsonapi for Rails empowers your JSON API compliant APIs. Requires very little
+  coding. http://jsonapi.org/format/
 test_files: []