jsonapi-utils 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6eff0a7e2d11caccf5abf5a536e44169a753848
-  data.tar.gz: 28548fd3c87c86c5812af6b98ab7211f85161cd0
+  metadata.gz: c5c764a38bce9c5b3858bb2cde1a345ca31f6a23
+  data.tar.gz: 8c12bdfdf4c949eda015c8a46534a1e1c3cf333b
 SHA512:
-  metadata.gz: b25decbe1f936d4f47699941abbc6967f52d390bd83f760a975cc2eca02004205c908d64de1be152bd692969a9f4233ff0f4269f7c3339fbd1aeb35c0df7bad3
-  data.tar.gz: 7ed12c4c431e2d4693e28e00b0cfe617dc17bb8088dd75946b04dc278d308227f0405e21be22b8218c7448a0e7d2f2d8b52b25da4ae8bede7431c5cb70ea993b
+  metadata.gz: 202613eae09e04c60f0ccb83c250c5c934667899af4a359c4e98fa146f05db16d9dd1185505081f023ab6edda8e07a8d30617c3ba2c84ba2bc6aa4a490c24485
+  data.tar.gz: fc7edd5cd32d6281ad6d639b5d0756c0a80b81ca6b3bcc622c8495015b627e967cbd476088da8e2acb2f215eea8b1bc3534cd36bc90b34e7bf623b0ff4d9739c

data/.travis.yml

@@ -1,4 +1,9 @@
 language: ruby
+sudo: false
+env:
+  - 'RAILS_VERSION=4.1.0'
+  - 'RAILS_VERSION=4.2.0'
 rvm:
-  - 2.2.2
+  - 2.2
 before_install: gem install bundler -v 1.10.4
+script: bundle exec rspec spec/controllers/{user,post}s_controller_spec.rb

data/README.md

@@ -2,16 +2,18 @@
 
 [![Code Climate](https://codeclimate.com/github/b2beauty/jsonapi-utils/badges/gpa.svg)](https://codeclimate.com/github/b2beauty/jsonapi-utils)
 [![Gem Version](https://badge.fury.io/rb/jsonapi-utils.svg)](https://badge.fury.io/rb/jsonapi-utils)
+[![Build Status](https://travis-ci.org/b2beauty/jsonapi-utils.svg?branch=master)](https://travis-ci.org/b2beauty/jsonapi-utils)
 
-`JSONAPI::Utils` works on top of the awesome [jsonapi-resources](https://github.com/cerebris/jsonapi-resources) gem bringing to your controllers a Rails way to render [JSON API](http://jsonapi.org)-compliant responses.
+Simple yet powerful way to have your Rails API compliant with [JSON API](http://jsonapi.org).
+
+JSONAPI::Utils (JU) was built on top of [JSONAPI::Resources](https://github.com/cerebris/jsonapi-resources) taking advantage of its resource-driven style and bringing a Rails way to build modern APIs with no or less learning curve.
 
 ## Installation
 
 Add these lines to your application's Gemfile:
 
 ```ruby
-gem 'jsonapi-resources', '~> 0.7.0'
-gem 'jsonapi-utils'
+gem 'jsonapi-utils', '~> 0.4.3'
 ```
 
 And then execute:
@@ -20,34 +22,53 @@ And then execute:
 $ bundle
 ```
 
-## Main Macros
-
-* `jsonapi_render`: it works like ActionController's `render` method, receiving model objects and
-rendering them into JSON API's data format.
+## Macros
 
-* `jsonapi_serialize`: in the backstage, it's the method that actually parsers model objects or hashes and builds JSON data.
-It can be called anywhere in controllers, concerns etc.
+### jsonapi_render
 
-## Options
+Validates the request and renders ActiveRecord/Hash objects into JSON API-compliant responses.
 
-Those macros accept the following options:
+Arguments:
 
-* `resource`: explicitly points the resource to be used in the serialization. By default, JSONAPI::Utils will
-select resources by inferencing from controller's name.
+  - `json`: ActiveRecord or Hash object to be rendered as JSON document;
+  - `status`: HTTP status code (Integer or Symbol). If ommited a status code will be automatically infered;
+  - `options`:
+    - `resource`: explicitly points the resource to be used in the serialization. By default, JU will select resources by inferencing from controller's name.
+    - `count`: explicitly points the total count of records for the request in order to build a proper pagination. By default, JU will count the total number of records.
+    - `model`: sets the model reference in cases when `json` is a Hash or a collection of Hashes.
 
 ```ruby
-# If in UsersController for some reason it needs to render a different resource:
-jsonapi_render json: Post.all, options: { resource: PostResource }
+# Single resource rendering
+jsonapi_render json: User.find(params[:id])
+
+# Collection rendering
+jsonapi_render json: User.all
+
+# Forcing a different resource
+jsonapi_render json: User.all, options: { resource: V2::UserResource }
+
+# Using a specific count
+jsonapi_render json: User.some_weird_scope, options: { count: User.some_weird_scope_count }
+
+# Hash rendering
+jsonapi_render json: { data: { id: 1, first_name: 'Tiago' } }, options: { model: User }
+
+# Collection of Hashes rendering
+jsonapi_render json: { data: [{ id: 1, first_name: 'Tiago' }, { id: 2, first_name: 'Doug' }] }, options: { model: User }
 ```
 
-* `count`: explicitly points the total count of records for the request, in order to build a proper pagination. By default, JSONAPI::Utils will
-count the total number of records for a given resource.
+### jsonapi_serialize
+
+In the backstage that's the method that actually parsers ActiveRecord/Hash objects and builds a new Hash compliant with JSON API. It can be called anywhere in controllers, concerns etc.
 
 ```ruby
-users = User.all
-jsonapi_render json: users, options: { count: users.count }
+collection = jsonapi_serialize(User.all)
+render json: do_some_magic_with(collection)
 ```
 
+Arguments:
+  - It receives a second optional argument with the same options for `jsonapi_render`.
+
 ## Usage
 
 Let's say we have a Rails app for a super simple blog.
@@ -342,7 +363,7 @@ Content-Type: application/vnd.api+json
 Request:
 
 ```
-GET /users?include=posts&fields[users]=full_name,posts&fields[posts]=title&page[number]=1&page[size]=1 HTTP/1.1
+GET /users?include=posts&fields[users]=first_name,last_name,posts&fields[posts]=title&sort=first_name,last_name&page[number]=1&page[size]=1 HTTP/1.1
 Accept: application/vnd.api+json
 ```
 
@@ -354,6 +375,26 @@ Content-Type: application/vnd.api+json
 
 {
   "data": [
+    {
+      "id": "2",
+      "type": "users",
+      "links": {
+        "self": "http://api.myblog.com/users/2"
+      },
+      "attributes": {
+        "first_name": "Douglas",
+        "last_name": "André"
+      },
+      "relationships": {
+        "posts": {
+          "links": {
+            "self": "http://api.myblog.com/users/2/relationships/posts",
+            "related": "http://api.myblog.com/users/2/posts"
+          },
+          "data": []
+        }
+      }
+    },
     {
       "id": "1",
       "type": "users",
@@ -361,7 +402,8 @@ Content-Type: application/vnd.api+json
         "self": "http://api.myblog.com/users/1"
       },
       "attributes": {
-        "full_name": "Tiago Guedes"
+        "first_name": "Tiago",
+        "last_name": "Guedes"
       },
       "relationships": {
         "posts": {
@@ -395,9 +437,8 @@ Content-Type: application/vnd.api+json
     "record_count": 2
   },
   "links": {
-    "first": "http://api.myblog.com/users?fields%5Bposts%5D=title&fields%5Busers%5D=full_name%2Cposts&include=posts&page%5Bnumber%5D=1&page%5Bsize%5D=1",
-    "next": "http://api.myblog.com/users?fields%5Bposts%5D=title&fields%5Busers%5D=full_name%2Cposts&include=posts&page%5Bnumber%5D=2&page%5Bsize%5D=1",
-    "last": "http://api.myblog.com/users?fields%5Bposts%5D=title&fields%5Busers%5D=full_name%2Cposts&include=posts&page%5Bnumber%5D=2&page%5Bsize%5D=1"
+    "first": "http://api.myblog.com/users?fields%5Bposts%5D=title&fields%5Busers%5D=first_name%2Clast_name%2Cposts&include=posts&page%5Blimit%5D=2&page%5Boffset%5D=0&sort=first_name%2Clast_name",
+    "last": "http://api.myblog.com/users?fields%5Bposts%5D=title&fields%5Busers%5D=first_name%2Clast_name%2Cposts&include=posts&page%5Blimit%5D=2&page%5Boffset%5D=0&sort=first_name%2Clast_name"
   }
 }
 ```

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |test|
+  test.pattern = 'spec/controllers/{user,post}s_controller.rb'
+end
 
-task :default => :spec
+task default: :spec

data/jsonapi-utils.gemspec

@@ -4,26 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jsonapi/utils/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "jsonapi-utils"
+  spec.name          = 'jsonapi-utils'
   spec.version       = JSONAPI::Utils::VERSION
-  spec.authors       = ["Tiago Guedes", "Douglas André"]
-  spec.email         = ["tiagopog@gmail.com", "douglas@beautydate.com.br"]
+  spec.authors       = ['Tiago Guedes', 'Douglas André']
+  spec.email         = ['tiagopog@gmail.com', 'douglas@beautydate.com.br']
 
   spec.summary       = %q{JSON::Utils is a simple way to get a full-featured JSON API serialization for your controller's responses.}
   spec.description   = %q{A Rails way to get your API's data serialized through JSON API's specs (http://jsosapi.org)}
-  spec.homepage      = "https://github.com/b2beauty/jsonapi-utils"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/b2beauty/jsonapi-utils'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'jsonapi-resources', '~> 0.7.0'
+
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rspec-rails', '~> 3.1'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'factory_girl', '~> 4.5'
   spec.add_development_dependency 'jsonapi-resources', '~> 0.7.0'
-  spec.add_development_dependency 'rails', '>= 4.0'
+  spec.add_development_dependency 'rails', '~> 4.2'
+  spec.add_development_dependency 'pry'
 end

data/lib/jsonapi/utils.rb

@@ -1,27 +1,28 @@
+require 'jsonapi-resources'
 require 'jsonapi/utils/version'
-require 'active_support/concern'
 require 'jsonapi/utils/exceptions'
 
 module JSONAPI
   module Utils
-    extend ::ActiveSupport::Concern
-
-    include do
-      helper_method :jsonapi_serialize
+    def self.included(base)
+      base.helper_method :jsonapi_serialize
     end
 
-    def jsonapi_render(options)
-      if options.has_key?(:json)
-        response = jsonapi_serialize(options[:json], options[:options] || {})
-        render json: response, status: options[:status] || :ok
+    def jsonapi_render(json:, status: nil, options: {})
+      setup_request
+
+      if @request.errors.present?
+        render_errors(@request.errors)
       else
-        raise ArgumentError.new('":json" key must be set to JSONAPI::Utils#jsonapi_render')
+        body = jsonapi_serialize(json, options)
+        render json: body, status: status || @_response_document.status
       end
     rescue => e
-      raise e unless e.class.name.starts_with?('JSONAPI::Exceptions')
       handle_exceptions(e)
     ensure
-      headers['Content-Type'] = JSONAPI::MEDIA_TYPE
+      if response.body.size > 0
+        response.headers['Content-Type'] = JSONAPI::MEDIA_TYPE
+      end
     end
 
     def jsonapi_render_errors(exception)
@@ -42,8 +43,7 @@ module JSONAPI
     end
 
     def jsonapi_render_not_found(exception)
-      setup_request
-      id = exception.message.match(/=(\d+)/)[1]
+      id = exception.message.match(/=([\w-]+)/).try(:[], 1) || '(no identifier)'
       jsonapi_render_errors(JSONAPI::Exceptions::RecordNotFound.new(id))
     end
 
@@ -53,12 +53,41 @@ module JSONAPI
 
     def jsonapi_serialize(records, options = {})
       setup_request
-      results = JSONAPI::OperationResults.new
+
+      if records.is_a?(Hash)
+        hash    = records.with_indifferent_access
+        records = hash_to_active_record(hash[:data], options[:model])
+      end
 
       fix_request_options(params, records)
+      build_response_document(records, options).contents
+    end
+
+    def filter_params
+      @_filter_params ||=
+        if params[:filter].is_a?(Hash)
+          params[:filter].keys.each_with_object({}) do |resource, hash|
+            hash[resource] = params[:filter][resource]
+          end
+        end
+    end
+
+    def sort_params
+      @_sort_params ||=
+        if params[:sort].present?
+          params[:sort].split(',').each_with_object({}) do |criteria, hash|
+            order, field = criteria.match(/(\-?)(\w+)/i)[1..2]
+            hash[field]  = order == '-' ? :desc : :asc
+          end
+        end
+    end
+
+    private
+
+    def build_response_document(records, options)
+      results = JSONAPI::OperationResults.new
 
       if records.respond_to?(:to_ary)
-        records = fix_when_hash(records, options) if needs_to_be_fixed?(records)
         @_records = build_collection(records, options)
         results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, @_records, result_options(records, options)))
       else
@@ -66,10 +95,9 @@ module JSONAPI
         results.add_result(JSONAPI::ResourceOperationResult.new(:ok, @_record))
       end
 
-      create_response_document(results).contents
+      @_response_document = create_response_document(results)
     end
 
-    private
 
     def fix_request_options(params, records)
       return if request.method !~ /get/i ||
@@ -79,10 +107,6 @@ module JSONAPI
       @request.send("setup_#{action}_action", params)
     end
 
-    def needs_to_be_fixed?(records)
-      records.is_a?(Array) && records.all? { |e| e.is_a?(Hash) }
-    end
-
     def result_options(records, options)
       {}.tap do |data|
         if JSONAPI.configuration.default_paginator != :none &&
@@ -147,13 +171,6 @@ module JSONAPI
         (options[:filter].nil? || options[:filter])
     end
 
-    def filter_params
-      @_filter_params ||=
-        params[:filter].keys.each_with_object({}) do |resource, hash|
-          hash[resource] = params[:filter][resource]
-        end
-    end
-
     def apply_pagination(records, options = {})
       return records unless apply_pagination?(options)
       pagination = set_pagination(options)
@@ -184,14 +201,6 @@ module JSONAPI
       end
     end
 
-    def sort_params
-      @_sort_params ||=
-        params[:sort].split(',').each_with_object({}) do |criteria, hash|
-          order, field = criteria.match(/(\-?)(\w+)/i)[1..2]
-          hash[field]  = order == '-' ? :desc : :asc
-        end
-    end
-
     def set_pagination(options)
       page_params = ActionController::Parameters.new(@request.params[:page])
       if JSONAPI.configuration.default_paginator == :paged
@@ -214,13 +223,17 @@ module JSONAPI
         (options[:paginate].nil? || options[:paginate])
     end
 
-    def fix_when_hash(records, options)
-      return [] unless options[:model]
-      records.map { |hash| options[:model].new(hash) }
+    def hash_to_active_record(data, model)
+      return data if model.nil?
+      coerced = [data].flatten.map { |hash| model.new(hash) }
+      data.is_a?(Array) ? coerced : coerced.first
     rescue ActiveRecord::UnknownAttributeError
-      ids = records.map { |e| e[:id] || e['id'] }
-      scope = options[:scope] ? options[:model].send(options[:scope]) : options[:model]
-      scope.where(id: ids)
+      if data.is_a?(Array)
+        ids = data.map { |e| e[:id] }
+        model.where(id: ids)
+      else
+        model.find_by(id: data[:id])
+      end
     end
 
     def count_records(records, options)

data/lib/jsonapi/utils/exceptions.rb

@@ -23,4 +23,3 @@ module JSONAPI::Utils::Exceptions
     end
   end
 end
-

data/lib/jsonapi/utils/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Utils
-    VERSION = '0.4.2'
+    VERSION = '0.4.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-utils
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Tiago Guedes
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: jsonapi-resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -43,16 +57,16 @@ dependencies:
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -97,18 +111,32 @@ dependencies:
         version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0'
 description: A Rails way to get your API's data serialized through JSON API's specs
   (http://jsosapi.org)
 email: