json_api_toolbox 0.7.2 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79da90324606331c68b49af3debae0e39e9fa4b0
-  data.tar.gz: a966e83e52ceea214541ae4fcc326c0087a8a3f8
+  metadata.gz: 1ff5b802b738effc049540070f3a5848a44fec21
+  data.tar.gz: 82b1ef0fd90a974257dcd53a07eacb61b1bd8314
 SHA512:
-  metadata.gz: c21e5ca55dd7b9ecad49b186c0016e4befbfd676fd059a4f85396cf36cd6a4817d2b34be06c3ffc9bc05a72c36f4b5a32605819adc693590359fcf9d2ad55800
-  data.tar.gz: c93f4f8ceaaec843ad384ddf1a781b5245b6091a497af6386a123b12ae9d934f6d4f8ac317712855bd7c61910e53c0c4ca9cdafa6197270c5587828aaeb90aa8
+  metadata.gz: a1a12a825d8952735be272a44f28decc8ea3a62e7ad69d927dc642e2093de1be621d5a86d576abcf537bea430c1049672b6e975bb6971bb3602ae4bfb8057f2e
+  data.tar.gz: 5baafad9b4756f550ee173ab4f8f30b5b74e5a674d01c6db17af39ca809ea7744672fa4e27f0a456a19f1d5785599786f21997ea4dc6de84cad6003b9c1d50a2

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.8.0] - 2017-12-15
+### Added
+- Added Module Paginable with pagination links and meta
+
 ## [0.7.0] - 2017-12-11
 ### Added
 - Added Enum Serializable

data/README.md

@@ -51,6 +51,26 @@ new Hash, the key must be 'Hash' and the value must be your Serializable.
 render_object(QuotaGap.all, class: { Hash: SerializableQuotaGap })
 ```
 
+#Paginable
+
+To render a collection with a json api pagination, you will need to send a Hash
+that contains two keys called 'links' and 'meta', and its values must be Hashs.
+
+```ruby
+class MyController
+  include JsonApiToolbox::Paginable
+
+  def index
+    collection = MyModel
+                 .all
+                 .paginate(page: params[:page],
+                           per_page: params[:per_page])
+    render_object(collection, links: pagination(collection),
+                              meta: pagination_meta(collection))
+  end
+end
+```
+
 ##ShareExamplesForControllers
 
 it_behaves_like 'a http method'

data/json_api_toolbox.gemspec

@@ -19,9 +19,12 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'actionpack', '>= 4.0'
+  spec.add_dependency 'activerecord', '>= 4.0'
   spec.add_dependency 'activesupport', '>= 4.0'
   spec.add_dependency 'jsonapi-serializable', '>= 0.3.0'
   spec.add_dependency 'rspec', '~> 3.0'
+  spec.add_dependency 'will_paginate', '>= 3.1'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'json'

data/lib/json_api_toolbox/paginable.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module JsonApiToolbox
+  module Paginable
+    def pagination_meta(collection_resource)
+      {
+        'current-page': collection_resource.current_page,
+        'next-page': collection_resource.next_page,
+        'prev-page': collection_resource.previous_page,
+        'total-pages': collection_resource.total_pages,
+        'total-count': collection_resource.total_entries
+      }
+    end
+
+    def pagination(collection_resource)
+      {
+        first: 1,
+        last:  collection_resource.total_pages,
+        prev: collection_resource.previous_page,
+        next: collection_resource.next_page
+      }.reduce({}, &method(:page_links))
+    end
+
+    def page_links(paginations, entry)
+      link, page = entry
+      if page
+        paginations.merge(create_page_link(link, page))
+      else
+        paginations
+      end
+    end
+
+    def create_page_link(link, page)
+      link_path = collection_resource_path(page: page,
+                                           per_page: params[:per_page])
+      { link => link_path }
+    end
+
+    def collection_resource_path(options)
+      path_method = "#{controller_name.pluralize.underscore}_path"
+      public_send(path_method, options)
+    end
+  end
+end

data/lib/json_api_toolbox/version.rb

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

data/lib/json_api_toolbox.rb

@@ -5,6 +5,7 @@ require 'renderizable'
 require 'enums'
 require 'postable'
 require 'jsonapi/serializable'
+require 'json_api_toolbox/paginable'
 
 require_relative 'json_api_toolbox/spec_support/shared_examples_for_controllers'
 require_relative 'json_api_toolbox/serializables/serializable_enum_option'

data/lib/renderizable.rb

@@ -8,7 +8,7 @@ module JsonApiToolbox
       else
         renderization =
           { jsonapi: object, include: includes_params }.merge(options)
-        render(renderization.merge(build_meta_data(object)))
+        render(build_meta_data(object).merge(renderization))
       end
     end
 

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: json_api_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Adriano Bacha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +183,7 @@ files:
 - json_api_toolbox.gemspec
 - lib/enums.rb
 - lib/json_api_toolbox.rb
+- lib/json_api_toolbox/paginable.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