croods 0.2.7 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d384b5ea86ec6b48095b9772afb47414627799144627547722b6322aae58d73
-  data.tar.gz: e58a394c1e3c9bd4b6787c092a09d1bb6582e313151baaedcb9ec0aee8c72735
+  metadata.gz: b9fa939ee66088adb051cc63ee6f9cfc1206da7674dd6f2c48c524ea0ca8b931
+  data.tar.gz: 9e9722e961a8b24760106965a385a5aad1a89d9b85369243d3497c2c3fc33784
 SHA512:
-  metadata.gz: 369cc10370be1f7e010d07a858143d929292633752286529b72c7f5558195146a350e5071585adb6a35d6c2edb1bf2a4915ab87f293001fc5669f90a0f46e77c
-  data.tar.gz: ffaec510b409f9cd1d93337aa9939af86d685f4d144cc9e6a06b8fe259a0fabbe1d60fb9628d90ea53ebcf5d313d02d8a3d09b49d548d8aac86abcb56710673b
+  metadata.gz: 65565603371e3e5d46d3c8f412af157bd4e50ca2c1f6afc57a3577f4dd77f294bd63624c7f02585973214ff978d7312367d520916f7497c4f29f49f582b28f1b
+  data.tar.gz: 3d0f2872653a07a3edb49cdb3cc368e34eb153826a5066099ed250400000613ea128bbbf5dac4cc3563fffe87f67b94ac82d2854a8a30004010d4f6d200b9be5

data/README.md

@@ -130,15 +130,13 @@ use_for_authentication!(
 ## Contributing
 
 You can manually check your changes in the dummy Rails app under `/todos`.
+Use it to run integration tests since it doesn't have an UI.
 
-To set it up:
+- Clone the repository
+- Install bundler `gem install bundler`
+- Install gems `bin/bundle`
 
-```
-cd todos/
-bin/setup
-```
-
-To run specs use:
+To run both Croods-rails' and the example's specs use:
 `bin/rspec`
 
 ## License

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,28 @@ 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 sort(list)
+        if list.respond_to? resource.sort_by
+          list.public_send(resource.sort_by, params[:order_by], params[:order])
+        else
+          list.order(resource.sort_by)
+        end
+      end
+
       def collection
-        resource
-          .apply_filters(policy_scope(model), params)
-          .order(resource.sort_by)
+        list = resource.apply_filters(policy_scope(model), params)
+        list = sort(list)
+        list = paginate_collection(list) if page_param.present?
+
+        list
       end
     end
   end

data/lib/croods/controller/member.rb

@@ -29,7 +29,7 @@ module Croods
           .merge(
             params
               .require(resource.resource_name)
-              .permit(resource.request_attributes.keys)
+              .permit!
           )
       end
 

data/lib/croods/policy/scope.rb

@@ -38,6 +38,8 @@ module Croods
         associations = scope.reflect_on_all_associations(:belongs_to)
 
         associations.each do |association|
+          next if association.options[:optional]
+
           model = association.class_name.constantize
           expanded_path = path + [association]
           association_path = reflection_path(model, target, expanded_path)

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/authorization.rb

@@ -8,10 +8,23 @@ module Croods
 
         on = [on] if on&.is_a?(Symbol)
 
-        actions.each do |action|
-          next if on && !on.include?(action.name)
+        authorization_roles << { roles: roles, on: on }
+      end
+
+      def authorization_roles
+        @authorization_roles ||= []
+      end
+
+      def apply_authorization_roles!
+        authorization_roles.each do |authorization|
+          (actions + additional_actions).each do |action|
+            on = authorization[:on]
+            roles = authorization[:roles]
+
+            next if on && !on.include?(action.name)
 
-          action.roles = roles
+            action.roles = roles
+          end
         end
       end
 

data/lib/croods/resource/json_schema/definition.rb

@@ -15,7 +15,15 @@ module Croods
 
         class << self
           def schema(attribute)
-            { type: types(attribute) }.merge(format(attribute))
+            { type: types(attribute) }
+              .merge(format(attribute))
+              .merge(items(attribute))
+          end
+
+          def items(attribute)
+            return {} unless %i[json jsonb].include?(attribute.type)
+
+            { items: { type: %w[string number object] } }
           end
 
           def format(attribute)

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

@@ -33,6 +33,18 @@ module Croods
               filters
             end
 
+            def properties(resource)
+              properties = {}
+
+              params = resource.pagination_params + resource.order_params
+
+              params.each do |attribute|
+                properties[attribute.name] = definition(attribute)
+              end
+
+              properties.merge(filters(resource))
+            end
+
             def definition(attribute)
               definition = Definition.schema(attribute)
 
@@ -42,13 +54,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/resource/sorting.rb

@@ -3,10 +3,26 @@
 module Croods
   module Resource
     module Sorting
+      def order_by_attribute
+        @order_by_attribute ||= Croods::Attribute.new(
+          'order_by', :string, null: true
+        )
+      end
+
+      def order_attribute
+        @order_attribute ||= Croods::Attribute.new(
+          'order', :string, null: true
+        )
+      end
+
+      def order_params
+        @order_params ||= [order_by_attribute, order_attribute]
+      end
+
       def sort_by(attribute = nil)
         return @sort_by ||= :created_at unless attribute
 
-        @sort_by = attribute
+        @sort_by ||= attribute
       end
     end
   end

data/lib/croods/routes.rb

@@ -10,6 +10,7 @@ module ActionDispatch
           resource.create_model!
           resource.create_policy!
           resource.create_controller!
+          resource.apply_authorization_roles!
           create_resource_routes!(resource)
         end
 

data/lib/croods/version.rb

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

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-10-14 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