JsonapiObjectMapper

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/jsonapi_object_mapper. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'jsonapi-object-mapper'

And then execute:

$ bundle

Or install it yourself as:

$ gem install jsonapi-object-mapper

Usage

require "jsonapi_object_mapper"

class Photo < JsonAPIObjectMapper::Deserializer::Resource
  attribute :image
end

class User < JsonAPIObjectMapper::Deserializer::Resource
  # Embedding with another Resource class, will deserialize the `included` resource with the given class
  has_one :photo, embed_with: Photo

  # By default the value will be assigned whatever in located in the `included` selection. 
 # Other wise basic relationship resources will be added.
  has_one :friend

  # This will accept the default value
  attribute :last_name

  # You can transform the setting value
  attribute :first_name do |attr_value|
    attr_value.upcase
  end

  # You can mass assign attributes using the `attributes` method instead if blocks don't matter

  attributes :ssn, :passport, :more_person_info
end


User.call_collection(json_payload) #=> [<#User:123>, <#User:432>]
user = User.call(json_payload) #=> <#User:123>

user.first_name #=> "Foo"
user.last_name  #=> "Bar"

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/georgekaraszi@gmail.com/jsonapi_object_mapper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the JsonapiObjectMapper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.