jsonapi-rb/jsonapi-rb

Efficiently produce and consume JSON API documents.

jsonapi-rb

Ruby gem for building and consuming JSON API documents.

Status

Resources

• Chat: gitter
• Twitter: @jsonapirb
• Docs: jsonapi-rb.org

Code

jsonapi-rb is simply a bundle of:

• jsonapi-serializable for serialization, and
• jsonapi-deserializable for deserialization.

For framework integrations, see:

• jsonapi-hanami for Hanami, and
• jsonapi-rails for Ruby on Rails.

Installation

# In Gemfile
gem 'jsonapi-rb'

then

$ bundle

or manually via

$ gem install jsonapi-rb

Usage and documentation

See jsonapi-rb.org/guides.

License

jsonapi-rb is released under the MIT License.

jsonapi-rb's Issues

Is this still being re-written?

Documentation on this page is still missing. I can't really get started without this...

http://jsonapi-rb.org/guides/deserialization/defining.html

Abandoned?

Just wondering if this has been abandoned or not. Not seeing a commit in about 2 years and there is still a fair bit of documentation missing.

Demo on website doesn't say what to import

class SerializablePost < JSONAPI::Serializable::Resource
  type 'posts'

  attributes :title, :body

  attribute :date do
    @object.created_at
  end

  belongs_to :author

  has_many :comments do
    data do
      @object.published_comments
    end

    link :related do
      @url_helpers.user_posts_url(@object.id)
    end

    meta do
      { count: @object.published_comments.count }
    end
  end

  link :self do
    @url_helpers.post_url(@object.id)
  end

  meta do
    { featured: true }
  end
end

What do I pass to require to get that class loaded into ruby? I can't figure it out.

Add minitest and rspec matchers

Really awesome project, good work!

Perhaps a new sub repo could include helper methods for testing with Minitest and RSpec or is that out of the scope for the project?

Error handling with alias

Is there a way to make the errors pointer match the alias used in the serializer ?

serializer :

     attribute :reply do
        @object.content
    end

response when there is an error :
{"errors":[{"title":"Invalid content","detail":"Nouveau commentaire est trop court (au moins 16 caractères)","source":{}}],"jsonapi":{"version":"1.0"}}

Idealy source should contain a pointer to reply.
How can the errors be correctly serialized ?

Bring in jsonapi-renderer bugfix

I'm encountering the following error:

#<NoMethodError: undefined method `merge!' for #<Set: {}> Did you mean?  merge>
jsonapi-renderer (0.1.1) lib/jsonapi/renderer/resources_processor.rb:51:in `traverse_resource'
jsonapi-renderer (0.1.1) lib/jsonapi/renderer/resources_processor.rb:43:in `traverse_queue'
jsonapi-renderer (0.1.1) lib/jsonapi/renderer/resources_processor.rb:29:in `traverse_resources'

This appears to be fixed here: jsonapi-rb/jsonapi-renderer@8fa349b

Can you bring this into the jsonapi-rb and jsonapi-rails master branches? I'm having trouble installing.

Bundler could not find compatible versions for gem "jsonapi-renderer":
  In Gemfile:
    jsonapi-renderer (~> 0.1.2)

    jsonapi-rails was resolved to 0.1.1, which depends on
      jsonapi-rb (= 0.1.1) was resolved to 0.1.1, which depends on
        jsonapi-serializable (= 0.1.1) was resolved to 0.1.1, which depends on
          jsonapi-renderer (= 0.1.1)