JSON API query parser

To be used for ruby projects that make use of JSON API

Installation

$ gem install json_api_query_parser

Or in the gemfile of the rails project

gem 'json_api_query_parser'

Usage

Require the gem 'json_api_query_parser' into your application and use the 'parseRequest' method to convert the request.url to an easy usable Hash.

require('json_api_query_parser')
JsonApiQueryParser.parseRequest("movies/5?include=actors,actors.agency&fields[movies]=title,year&fields[actors]=name&page[limit]=20")

Return data information

The Hash returned by the JsonApiQueryParser.parseRequest will always be the same structure.

{
  :resourceType=>"movies", 
  :identifier=>"5", 
  :queryData=>{
    :include=>["actors", "actors.agency"], 
    :fields=>{:movies=>["title", "year"], :actors=>["name"]},
    :page=>{"limit"=>"20"}
  }
}