When I see a method named parse with a payload as a parameter, I expect it to go through the payload and return a hash/object to better deal with the payload.
e.g.

Time <- Time.parse(string)
Hash <- JSON.parse(string)

It looks like this gem uses the parse to raise an exception if the payload is not a valid JSONAPI document.

Are there plans to add parsing functionality in this gem?

I'm trying to use the jsonapi-rails gem to deserialize the incoming params on an HTTP request, but it's not working as expected.

I tried 2 approaches:

Firstly I followed the instructions from the guides and tried using the default JSONAPI::Deserializable::Resource.call(json_hash) like this:

class AuthorsController < ApplicationController
  def create
    respond_with Author.create(author_params), class: AuthorSerializer
  end

  private

  def author_params
    JSONAPI::Deserializable::Resource.call(params)  
  end

but since the JSONAPI::Parser::Resource is expecting a hash an error is raised.

The second approach is using the deserializable_resource on the controller level:

class AuthorsController < ApplicationController
  deserializable_resource :author, only: :create
  
  def create
    respond_with Author.create(author_params), class: AuthorSerializer
  end

  private

  def author_params
    params.require(:author).permit(:name)
  end

When I try it like this I get ActionController::ParameterMissing: param is missing or the value is empty: author when inspecting the author_params. If I inspect the params they are looking like this:

ActionController::Parameters {"data"=>{"type"=>"authors", "attributes"=>{"name"=>"Author name"}}, "controller"=>"api/v1/authors", "action"=>"create"} permitted: false>

which means that the desiralization on the params didn't occur.

Any guidance would be helpful. I'm using ruby 2.3.1p112 and Rails 5.0.1

Perhaps I'm using this incorrectly. I would imagine JSONAPI.parse_response!(payload) returns a parsed response. If I open up IRB, this is what I see.

require 'jsonapi/parser'

#taken from specs
payload = {'data' => [{'type' => 'articles', 'id' => '1', 'attributes' => { 'title' => 'JSON API paints my bikeshed!' }, 'links' => { 'self' => 'http://example.com/articles/1' }, 'relationships' => {'author' => {'links' => {'self' => 'http://example.com/articles/1/relationships/author', 'related' => 'http://example.com/articles/1/author'}, 'data' => { 'type' => 'people', 'id' => '9' } }, 'journal' => {'data' => nil }, 'comments' => {'links' => {'self' => 'http://example.com/articles/1/relationships/comments', 'related' => 'http://example.com/articles/1/comments'}, 'data' => [{ 'type' => 'comments', 'id' => '5' }, { 'type' => 'comments', 'id' => '12' } ] } } } ], 'meta' => { 'count' => '13' } }


irb(main):005:0> JSONAPI.parse_response!(payload)
=> nil

Per the spec (http://jsonapi.org/format/#document-resource-objects):

Exception: The id member is not required when the resource object originates at the client and represents a new resource to be created on the server.

However, I get: JSONAPI::Parser::InvalidDocument (A resource identifier object MUST contain ["id", "type"] members.) creating a new resource via jsonapi-rails without the id attribute.

The resource parser currently ensure!s that data is the only top level key:

but the spec does not require this. There also appears to be a bunch of discussion around sideposting and the use of included to define resources for sideposting, eg json-api/json-api#1197, so I guess this will be required eventually.

Hi all, thanks for all the work on this project. Could you please respond if this project is alive? Thanks!

Hi. This test doesn't check the parsed data. Are you sure it works?