croods 0.2.5 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0900ac5dbe8afc94b575ee6e36071c7ca3d153c99e3fbd741e09824fe2d4334
-  data.tar.gz: 6d2e2dd3fa58485c3bdf64c4f78615505cb9197a41efa3e362b6f15b5a807369
+  metadata.gz: 47184f50917d2e0f8d4c16826c1d056b783813bfc6c54a0831bc8fb333155ba8
+  data.tar.gz: 38f8082f8019604ac318d7308b87c5bf167eb85b2b3c85b1e58795a46e2a4895
 SHA512:
-  metadata.gz: 50b61038f5c2fa00e737f620ae92d3a38aa2ab1128005fe53202bce881a47c673f0fc20a4d1968d4dafab4431a24ca41d13c34680f758aaf6e1c0d3a6566baa1
-  data.tar.gz: 5fe444a426181006daff456b818201a647f1dec094f55c7627bcee5e47f5cd84a0a7d7f63dc7cbccf161188c2fb52fa8549d2fa2467eca29ac459c617281ec80
+  metadata.gz: 7bac77110662f6d9cbf664c3d59bb02a82f7a486cafc36a1ffa0e392772aff15ef78085b5e5f1f1ff60dd8a3235dba5e6a4c10cabb76ee70ce3364f5a1eaecbe
+  data.tar.gz: b7f08e87e4e51aa32067b805853f5fef004d4f8bd3b0163f63fec3abb7f797806cadf58da24b28a77709b8fb9b2c988aa7e606764ee702afd03a5aecf968e94a

data/README.md

@@ -4,9 +4,11 @@
 ![](https://ruby-gem-downloads-badge.herokuapp.com/croods?type=total)
 
 # Croods
-Short description and motivation.
+
+A framework for creating CRUDs in Rails APIs. https://croods-rails.netlify.app
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -14,19 +16,23 @@ gem 'croods'
 ```
 
 And then execute:
+
 ```bash
 $ bundle
 ```
 
 ## Usage
+
 ### Resource
+
 Resource is a generic abstraction for any object your app needs to represent. Instead of `app/models/` and `app/controllers/`, with croods we have `app/resources/`.
 
 ### Creating a resource
+
 To add a `Project` resource to your app, start by generating a migration:
-```rails g migration CreateProjects```
+`rails g migration CreateProjects`
 
-``` ruby
+```ruby
 # It's crucial to write really solid migrations
 # croods will use your database schema to build your resources.
 class CreateProjects < ActiveRecord::Migration[5.2]
@@ -38,8 +44,10 @@ class CreateProjects < ActiveRecord::Migration[5.2]
   end
 end
 ```
+
 Then create the module and the main file `app/resources/projects/resource.rb`:
-```ruby 
+
+```ruby
 module Projects
   class Resource < ApplicationResource
   end
@@ -47,12 +55,15 @@ end
 ```
 
 Last step is to initialize your resource in `config/initializers/croods.rb`:
+
 ```ruby
 Croods.initialize_for(:users, :projects)
 ```
 
 ### Skip actions
-Croods creates five basic endpoints for your resource. If you don't want one, you need to skip it's action:
+
+Croods creates five basic endpoints for your resource. If you don't want one, you need to skip its action:
+
 ```ruby
 module Projects
   class Resource < ApplicationResource
@@ -60,8 +71,11 @@ module Projects
   end
 end
 ```
+
 ### Skip attributes
+
 By default, every single attribute in your table is exposed in your endpoints. If you don't want this, let croods know:
+
 ```ruby
 module Projects
   class Resource < ApplicationResource
@@ -71,7 +85,9 @@ end
 ```
 
 ### Extend model
+
 Croods creates a model for your resource. It looks at your database and automatically infers your model's `belongs_to` associations. But if you need to add code to your model just use `extend_model`.
+
 ```ruby
 module Projects
   class Resource < ApplicationResource
@@ -83,6 +99,7 @@ end
 ```
 
 Protip: you can create a Model module and `extend_model { include Projects::Model }`.
+
 ```ruby
 module Projects
   module Model
@@ -94,9 +111,12 @@ module Projects
   end
 end
 ```
+
 ### Authentication
+
 Croods uses [devise_token_auth](https://github.com/lynndylanhurley/devise_token_auth) under the hood.
 To customize which devise modules are loaded, you can pass them as arguments to `use_for_authentication!`
+
 ```ruby
 use_for_authentication!(
   :database_authenticatable,
@@ -110,16 +130,15 @@ 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:
-```
-cd todos/
-bin/setup
-```
+- Clone the repository
+- Install bundler `gem install bundler`
+- Install gems `bin/bundle`
 
-To run specs use:
-```bin/rspec```
+To run both Croods-rails' and the example's specs use:
+`bin/rspec`
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/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

@@ -5,16 +5,25 @@ module Croods
     module JsonSchema
       module Definition
         TYPES = {
-          datetime: 'string',
-          date: 'string',
-          text: 'string',
-          json: 'object',
-          float: 'number'
+          datetime: ['string'],
+          date: ['string'],
+          text: ['string'],
+          json: %w[object array],
+          jsonb: %w[object array],
+          float: ['number']
         }.freeze
 
         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)
@@ -30,13 +39,18 @@ module Croods
 
           def types(attribute)
             types = []
-            types << type(attribute.type)
-            types << 'null' if attribute.null
+            converted_types(attribute.type).each do |converted_type|
+              types << converted_type
+            end
+            null = (
+              attribute.null || attribute.default || attribute.default_function
+            )
+            types << 'null' if null
             types
           end
 
-          def type(type)
-            TYPES[type] || type.to_s
+          def converted_types(type)
+            TYPES[type] || [type.to_s]
           end
         end
       end

data/lib/croods/resource/policy.rb

@@ -26,7 +26,7 @@ module Croods
       end
 
       def policy_scope_name(action)
-        "#{model_name}#{action.to_s.camelize}Scope"
+        "#{model_name}#{action.to_s.titleize.gsub(/\ /, '')}Scope"
       end
 
       def create_policy!

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.5'
+  VERSION = '0.2.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.10
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: committee
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: schema_associations
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement