jsonapi.rb 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '078a4013116a56347b75f38cb951c7856634e759'
-  data.tar.gz: 880fbb7f75ccf7800c983a440c911011735318af
+  metadata.gz: 71f3acfa93d3beb62249295caf3eb1281bb3a26f
+  data.tar.gz: 55736764463a1fc310d5ec1a83d6f29dcb4c06ef
 SHA512:
-  metadata.gz: 2c6cc8f62b6177ef07ccf875afeb25bd683328a6427a6f3178fdabdb0b737b94712c576fda1ad11c1813eea44bd63747134d77c7c18cd1e1123ea17c622c5fa5
-  data.tar.gz: 64cd58a070442aeec8784885a0e6566c057e21e0445016f63c644d66c51c14942b1c5381ec5cdd3d155120849140cf183609b1130aee8f43ed57147bfcbf83b3
+  metadata.gz: 94ecad8c622c9d085b834855ab494eeffc25366c8ec107c74234e8874b5f3243635c6ac9f80b220fae689101735501c94c621fec6b5e3f82cf8f46a73a072f86
+  data.tar.gz: a0d360b993b759726a8f90ccefcca9d4ca2312a089a7d354fc96b1c8ac9bc722cbea507e8538f9a612aafd55c8bb83e9fefee07639500db11e52da96c4030e6f

data/.github/main.workflow

@@ -0,0 +1,56 @@
+workflow "Tests" {
+  on = "push"
+  resolves = [
+    "rspec-ruby2.3_rails4",
+    "rspec-ruby2.3_rails5",
+    "rspec-ruby2.6_rails4",
+    "rspec-ruby2.6_rails5"
+  ]
+}
+
+action "rspec-ruby2.3_rails4" {
+  uses = "docker://ruby:2.3-alpine"
+  env = {
+    RAILS_VERSION = "~> 4"
+  }
+  args = [
+    "sh", "-c",
+    "apk add -U git build-base sqlite-dev && rm Gemfile.lock && bundle install && rake"
+  ]
+}
+
+action "rspec-ruby2.3_rails5" {
+  uses = "docker://ruby:2.3-alpine"
+  needs = ["rspec-ruby2.3_rails4"]
+  env = {
+    RAILS_VERSION = "~> 5"
+  }
+  args = [
+    "sh", "-c",
+    "apk add -U git build-base sqlite-dev && rm Gemfile.lock && bundle install && rake"
+  ]
+}
+
+action "rspec-ruby2.6_rails4" {
+  uses = "docker://ruby:2.6-alpine"
+  needs = ["rspec-ruby2.3_rails5"]
+  env = {
+    RAILS_VERSION = "~> 4"
+  }
+  args = [
+    "sh", "-c",
+    "apk add -U git build-base sqlite-dev && rm Gemfile.lock && bundle install && rake"
+  ]
+}
+
+action "rspec-ruby2.6_rails5" {
+  uses = "docker://ruby:2.6-alpine"
+  needs = ["rspec-ruby2.6_rails4"]
+  env = {
+    RAILS_VERSION = "~> 5"
+  }
+  args = [
+    "sh", "-c",
+    "apk add -U git build-base sqlite-dev && rm Gemfile.lock && bundle install && rake"
+  ]
+}

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    jsonapi.rb (1.4.3)
+    jsonapi.rb (1.4.4)
       fast_jsonapi (~> 1.5)
       rack
       ransack

data/README.md

@@ -67,6 +67,16 @@ Or install it yourself as:
 
 ## Usage
 
+ * [Object serialization](#object-serialization)
+ * [Collection meta](#collection-meta)
+ * [Error handling](#error-handling)
+ * [Includes and sparse fields](#includes-and-sparse-fields)
+ * [Filtering and sorting](#filtering-and-sorting)
+   * [Sorting using expressions](#sorting-using-expressions)
+ * [Pagination](#pagination)
+
+---
+
 To enable the support for Rails, add this to an initializer:
 
 ```ruby
@@ -79,7 +89,7 @@ JSONAPI::Rails.install!
 This will register the mime type and the `jsonapi` and `jsonapi_errors`
 renderers.
 
-### Object Serialization
+### Object serialization
 
 The `jsonapi` renderer will try to guess and resolve the serializer class based
 on the object class, and if it is a collection, based on the first item in the
@@ -111,7 +121,26 @@ class CustomNamingController < ActionController::Base
 end
 ```
 
-#### Collection Meta
+To provide extra parameters to the serializer,
+implement the `jsonapi_serializer_params` method.
+
+Here's an example:
+```ruby
+class CustomSerializerParamsController < ActionController::Base
+
+  # ...
+
+  private
+
+  def jsonapi_serializer_params
+    {
+      first_name_upcase: params[:upcase].present?
+    }
+  end
+end
+```
+
+#### Collection meta
 
 To provide meta information for a collection, provide the `jsonapi_meta`
 controller method.

data/lib/jsonapi/rails.rb

@@ -4,6 +4,14 @@ require 'jsonapi/active_model_error_serializer'
 # Rails integration
 module JSONAPI
   module Rails
+    JSONAPI_METHODS_MAPPING = {
+      meta: :jsonapi_meta,
+      links: :jsonapi_pagination,
+      fields: :jsonapi_fields,
+      include: :jsonapi_include,
+      params: :jsonapi_serializer_params
+    }
+
     # Updates the mime types and registers the renderers
     #
     # @return [NilClass]
@@ -71,11 +79,10 @@ module JSONAPI
       ActionController::Renderers.add(:jsonapi) do |resource, options|
         self.content_type ||= Mime[:jsonapi]
 
-        options[:meta] ||= (
-          jsonapi_meta(resource) if respond_to?(:jsonapi_meta, true))
-        options[:links] ||= (
-          jsonapi_pagination(resource) if respond_to?(:jsonapi_pagination, true)
-        )
+        JSONAPI_METHODS_MAPPING.to_a[0..1].each do |opt, method_name|
+          next unless respond_to?(method_name, true)
+          options[opt] ||= send(method_name, resource)
+        end
 
         # If it's an empty collection, return it directly.
         many = JSONAPI::Rails.is_collection?(resource, options[:is_collection])
@@ -83,10 +90,9 @@ module JSONAPI
           return options.slice(:meta, :links).merge(data: []).to_json
         end
 
-        options[:fields] ||= (
-          jsonapi_fields if respond_to?(:jsonapi_fields, true))
-        options[:include] ||= (
-          jsonapi_include if respond_to?(:jsonapi_include, true))
+        JSONAPI_METHODS_MAPPING.to_a[2..-1].each do |opt, method_name|
+          options[opt] ||= send(method_name) if respond_to?(method_name, true)
+        end
 
         if respond_to?(:jsonapi_serializer_class, true)
           serializer_class = jsonapi_serializer_class(resource, many)

data/lib/jsonapi/version.rb

@@ -1,3 +1,3 @@
 module JSONAPI
-  VERSION = '1.4.3'
+  VERSION = '1.4.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi.rb
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Stas Suscov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2019-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fast_jsonapi
@@ -199,10 +199,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/main.workflow"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardstick.yml"
 - Gemfile
 - Gemfile.lock

data/.travis.yml

@@ -1,14 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-  - 2.3.7
-env:
-  - RAILS_VERSION='~> 5'
-  - RAILS_VERSION='~> 4'
-before_install:
-  - rm -f Gemfile.lock
-  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
-  - bundler --version || gem install bundler -v '< 2'