json_api_toolbox 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e89034246f639df9db8ed22e59a9c36c6106d6e
-  data.tar.gz: 3b6aa85aeb7d1c5b637f2dc1f23591ec0524bfd4
+  metadata.gz: d0559ff7f9c8bb8d2bab74981d15ec808a29efaf
+  data.tar.gz: '08d15e1d6f8b234f7af34d1864ea4429d429ed83'
 SHA512:
-  metadata.gz: 419b604717ac0006a07d65054f74449930858dca63d7ee3b2826d8dc0506bc3a5df62a9d7779d37d0bbc009ba743fbab3260cbc9d796ae738efe223d190c91e4
-  data.tar.gz: be81ed014c3e6a760ef749637ccf4c88c6b81d557de0ac0ae4640867f3620e2446e31c9c5da8b5e68b38fa6435b544c8a5ddec802dd4df4659491f105b777d3a
+  metadata.gz: 97eb5a10f3a1c0ffb66cdfd2fc79b74319b0b9a7442cf379f66aa63dabcc9e8d7783d30690b20bc47d3aee3dc0c806311be99b04e46b67044b846d8c1e765404
+  data.tar.gz: d54e00475644cebb4a7fe8283c963242c70d54cf8a4f975f373812eeaf40f62836a14d70310fbe71d87a64b8ac83c5c4ccf21405c1a77abb219bf65f0d32993f

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.7.0] - 2017-12-11
+### Added
+- Added Enum Serializable
+- Added Job Serializable
+- Added shared example "a json api response"
+- Added meta response count for all index routes

data/json_api_toolbox.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'activesupport', '>= 4.0'
-  spec.add_dependency 'jsonapi-rails', '>= 0.3.1'
+  spec.add_dependency 'jsonapi-serializable', '>= 0.3.0'
   spec.add_dependency 'rspec', '~> 3.0'
 
   spec.add_development_dependency 'bundler', '~> 1.15'

data/lib/json_api_toolbox/serializables/serializable_enum_option.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JsonApiToolbox
+  module Serializables
+    class SerializableEnumOption < JSONAPI::Serializable::Resource
+      type { @object[:type] }
+
+      id { @object[:id] }
+
+      attribute :description { @object[:description] }
+    end
+  end
+end

data/lib/json_api_toolbox/serializables/serializable_job.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module JsonApiToolbox
+  module Serializables
+    class SerializableJob < JSONAPI::Serializable::Resource
+      type :jobs
+
+      id { @object.job_id }
+
+      attribute(:queue_name) { @object.queue_name }
+    end
+  end
+end

data/lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rspec'
-
 module JsonApiToolbox
   module SpecSupport
     module SharedExamplesForControllers
@@ -62,6 +60,16 @@ module JsonApiToolbox
           expect(attributes).to match_array(relation_keys)
         end
       end
+
+      RSpec.shared_examples 'a json api response' do
+        let(:body) { JSON.parse(response.body) }
+        let(:data) { body['data'].first }
+
+        it { expect(body).to have_key('data') }
+        it { expect(data).to have_key('type') }
+        it { expect(data).to have_key('id') }
+        it { expect(data).to have_key('attributes') }
+      end
     end
   end
 end

data/lib/json_api_toolbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsonApiToolbox
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/json_api_toolbox.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 require 'active_support/inflector'
-require_relative 'json_api_toolbox/spec_support/shared_examples_for_controllers'
 require 'renderizable'
 require 'enums'
 require 'postable'
+require 'jsonapi/serializable'
+
+require_relative 'json_api_toolbox/spec_support/shared_examples_for_controllers'
+require_relative 'json_api_toolbox/serializables/serializable_enum_option'
+require_relative 'json_api_toolbox/serializables/serializable_job'
 
 module JsonApiToolbox; end

data/lib/renderizable.rb

@@ -6,7 +6,9 @@ module JsonApiToolbox
       if object.respond_to?(:errors) && object.errors.any?
         render({ jsonapi_errors: object.errors }.merge(options))
       else
-        render({ jsonapi: object, include: includes_params }.merge(options))
+        renderization =
+          { jsonapi: object, include: includes_params }.merge(options)
+        render(renderization, build_meta_data(object))
       end
     end
 
@@ -46,5 +48,11 @@ module JsonApiToolbox
         detail: message
       }
     end
+
+    def build_meta_data(objects)
+      if objects.respond_to?(:count)
+        { meta: { 'total-count' => objects.count } }
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2017-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: jsonapi-rails
+  name: jsonapi-serializable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -140,6 +141,8 @@ files:
 - json_api_toolbox.gemspec
 - lib/enums.rb
 - lib/json_api_toolbox.rb
+- lib/json_api_toolbox/serializables/serializable_enum_option.rb
+- lib/json_api_toolbox/serializables/serializable_job.rb
 - lib/json_api_toolbox/spec_support/shared_examples_for_controllers.rb
 - lib/json_api_toolbox/version.rb
 - lib/postable.rb