croods 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47184f50917d2e0f8d4c16826c1d056b783813bfc6c54a0831bc8fb333155ba8
-  data.tar.gz: 38f8082f8019604ac318d7308b87c5bf167eb85b2b3c85b1e58795a46e2a4895
+  metadata.gz: abd8dafdfb10c2b936a894dcb6da1057c6bfe3646f6e6d5af0f58d59d0be7bab
+  data.tar.gz: 8da5a9b8c82bacefae7d736610d7ba4e0e3305ecf832a602dd61cff0edc1b53c
 SHA512:
-  metadata.gz: 7bac77110662f6d9cbf664c3d59bb02a82f7a486cafc36a1ffa0e392772aff15ef78085b5e5f1f1ff60dd8a3235dba5e6a4c10cabb76ee70ce3364f5a1eaecbe
-  data.tar.gz: b7f08e87e4e51aa32067b805853f5fef004d4f8bd3b0163f63fec3abb7f797806cadf58da24b28a77709b8fb9b2c988aa7e606764ee702afd03a5aecf968e94a
+  metadata.gz: deac1ff6c8763d738b8ccd20149632df9be2425690a1550d57172e3a922a1b685f484d848f39fa5f3a8a29b3bd596c4c8c27e6f7356dbd4d56d40ff0abf879a2
+  data.tar.gz: 7a7342dba26327dc7e1422b26adf56b08747a20a3062d1c1090b941c6d3cf4030f2953975fceb770fb1127cc15097e7398ee35ec0ca017c1a4a6b18ba3a78a4a

data/lib/croods.rb

@@ -4,6 +4,8 @@ require 'rack/cors'
 require 'committee'
 require 'devise'
 require 'devise_token_auth'
+require 'kaminari'
+require 'api-pagination'
 require 'pundit'
 require 'schema_associations'
 require 'schema_auto_foreign_keys'

data/lib/croods/controller/collection.rb

@@ -5,10 +5,22 @@ module Croods
     module Collection
       protected
 
+      def page_param
+        params[resource.page_attribute_name]
+      end
+
+      def paginate_collection(list)
+        paginate(list.send(resource.page_method_name, page_param))
+      end
+
       def collection
-        resource
+        list = resource
           .apply_filters(policy_scope(model), params)
           .order(resource.sort_by)
+
+        list = paginate_collection(list) if page_param.present?
+
+        list
       end
     end
   end

data/lib/croods/resource.rb

@@ -12,6 +12,7 @@ require_relative 'resource/json_schema'
 require_relative 'resource/authentication'
 require_relative 'resource/authorization'
 require_relative 'resource/filters'
+require_relative 'resource/pagination'
 require_relative 'resource/sorting'
 require_relative 'resource/services'
 
@@ -32,6 +33,7 @@ module Croods
       include Authentication
       include Authorization
       include Filters
+      include Pagination
       include Sorting
       include Services
     end

data/lib/croods/resource/json_schema/links/collection.rb

@@ -33,6 +33,16 @@ module Croods
               filters
             end
 
+            def properties(resource)
+              properties = {}
+
+              resource.pagination_params.each do |attribute|
+                properties[attribute.name] = definition(attribute)
+              end
+
+              properties.merge(filters(resource))
+            end
+
             def definition(attribute)
               definition = Definition.schema(attribute)
 
@@ -42,13 +52,16 @@ module Croods
             end
 
             def required(resource)
-              resource.filters.reject(&:null).map(&:name)
+              collection_properties = resource.filters +
+                                      resource.pagination_params
+
+              collection_properties.reject(&:null).map(&:name)
             end
 
             def schema(resource)
               {
                 additionalProperties: false,
-                properties: filters(resource),
+                properties: properties(resource),
                 required: required(resource),
                 type: ['object']
               }

data/lib/croods/resource/pagination.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Pagination
+      def page_attribute
+        @page_attribute ||= Croods::Attribute.new(
+          Kaminari.config.param_name, :string, null: true
+        )
+      end
+
+      def per_page_attribute
+        @per_page_attribute ||= Croods::Attribute.new(
+          'per_page', :string, null: true
+        )
+      end
+
+      def pagination_params
+        @pagination_params ||= [page_attribute, per_page_attribute]
+      end
+
+      def page_attribute_name
+        @page_attribute.name
+      end
+
+      def page_method_name
+        @page_method_name ||= Kaminari.config.page_method_name
+      end
+    end
+  end
+end

data/lib/croods/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Croods
-  VERSION = '0.2.10'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-22 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: api-pagination
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: committee
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -296,6 +324,7 @@ files:
 - lib/croods/resource/json_schema/required.rb
 - lib/croods/resource/model.rb
 - lib/croods/resource/names.rb
+- lib/croods/resource/pagination.rb
 - lib/croods/resource/paths.rb
 - lib/croods/resource/policy.rb
 - lib/croods/resource/services.rb