croods 0.2.8 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c224eb3b5f12d9dec7be94dfa54f052ecdb147e2db3d4b258bc364423da7f935
-  data.tar.gz: 5543378384bb3d38987f93a49cbd2c31759fd098417ee56449987a36a0e649d0
+  metadata.gz: 63c99f117704edaa49eb759248b862eb75611b3cf97d0d539a70b946c94478fe
+  data.tar.gz: 377f6b1e1ba4619fb1004b31c9c23339fbaa47144f76dde57f58a6a09d4cf06e
 SHA512:
-  metadata.gz: 4694b6e09ff03c4110fc5031f2ddf51da0923330a3a58ee9f79b52cd36190a87e32a39787164c1db2b96fb5dc44605d7233df24274bb228e478daab004be697b
-  data.tar.gz: 6d20d856d3abcb11b71c4a511f43d6bbbed01aeaa110879af56c142cffae0ee26ea07473886254d9d9f9eed935118f4c28e93b8322c8ae1b9d80c9d64db87108
+  metadata.gz: 7e16d6d4fdbab8d49a19f24561dc8018c91244373c5bd89de7667147c3186f55c29f183c90beb9a92164ef76392a2be1315db3f4ac0f4d7ef7d513f6c43b65d7
+  data.tar.gz: a01538c937bec85378379476e9d7948dfc87af86f5d952980875dea965e4352e2f14a0a94eae92145ed7730157523b544f12fefc16e44f5607407abfd3a305f7

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,11 +4,16 @@ require 'rack/cors'
 require 'committee'
 require 'devise'
 require 'devise_token_auth'
+require 'kaminari'
+require 'api-pagination'
+require 'pg_search'
 require 'pundit'
 require 'schema_associations'
 require 'schema_auto_foreign_keys'
 require 'schema_validations'
 
+load 'pg_search/tasks.rb'
+
 module Croods
   cattr_accessor :namespaces, :json_schema, :multi_tenancy_by
 

data/lib/croods/controller/collection.rb

@@ -5,10 +5,43 @@ module Croods
     module Collection
       protected
 
+      def page_param
+        params[resource.page_attribute_name]
+      end
+
+      def search_param
+        params[resource.search_attribute_name]
+      end
+
+      def paginate_collection(list)
+        paginate(list.send(resource.page_method_name, page_param))
+      end
+
+      def search_collection(list)
+        return list unless search_param.present?
+
+        if resource.search_block.present?
+          list.instance_exec(search_param, &resource.search_block)
+        else
+          list.public_send resource.search_method_name, search_param
+        end
+      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 = search_collection(list) unless resource.skip_search?
+        list = sort(list)
+        list = paginate_collection(list) if page_param.present?
+
+        list
       end
     end
   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,7 +12,9 @@ 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/search'
 require_relative 'resource/services'
 
 module Croods
@@ -32,7 +34,9 @@ module Croods
       include Authentication
       include Authorization
       include Filters
+      include Pagination
       include Sorting
+      include Search
       include Services
     end
   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/links/collection.rb

@@ -33,6 +33,19 @@ module Croods
               filters
             end
 
+            def properties(resource)
+              properties = {}
+
+              params = resource.pagination_params + resource.order_params +
+                       resource.search_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 +55,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/model.rb

@@ -17,9 +17,20 @@ module Croods
         model_name.constantize
       end
 
+      def configure_search
+        return unless table_exists?
+
+        model.send(:include, PgSearch::Model)
+        model.send(:pg_search_scope,
+                   search_method_name,
+                   search_options)
+      end
+
       def create_model!
         Object.const_set(model_name, Class.new(Croods::Model))
 
+        configure_search unless model.resource.skip_search?
+
         model_blocks.each do |block|
           model.instance_eval(&block)
         end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Search
+      def search_attribute
+        return if skip_search?
+
+        @search_attribute ||= Croods::Attribute.new(
+          'query', :string, null: true
+        )
+      end
+
+      def search_params
+        return [] if skip_search?
+
+        @search_params ||= [search_attribute]
+      end
+
+      def search_attribute_name
+        return if skip_search?
+
+        @search_attribute.name
+      end
+
+      def search_method_name
+        @search_method_name ||= :search
+      end
+
+      def default_search_options
+        searchable = []
+
+        attributes.each do |key, value|
+          searchable << key if value.type.in? %i[string text]
+        end
+
+        {
+          against: searchable
+        }
+      end
+
+      def search_options
+        @search_options ||= default_search_options
+      end
+
+      def search_block
+        @search_block
+      end
+
+      def skip_search?
+        @skip_search
+      end
+
+      def skip_search
+        @skip_search ||= true
+      end
+
+      def search_by(name, options = {}, &block)
+        @search_method_name = name
+        @search_options = options
+        @search_block = block
+      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.8'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.2
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: api-pagination
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: committee
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,34 @@ 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: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: pg_search
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.4
 - !ruby/object:Gem::Dependency
   name: pundit
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +100,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.4.4
 - !ruby/object:Gem::Dependency
   name: schema_associations
   requirement: !ruby/object:Gem::Requirement
@@ -296,8 +338,10 @@ 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/search.rb
 - lib/croods/resource/services.rb
 - lib/croods/resource/sorting.rb
 - lib/croods/routes.rb