croods 0.2.2 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4a3ece0f2c1db0e1f5c9f85c0abd1c5148bae4b47b9f65d7ff4e94e4ab0791d
-  data.tar.gz: 588d9db567ccbe5ceb229a29605507436690d31e9ea47a3603db9fa9bcb45f1c
+  metadata.gz: 1d384b5ea86ec6b48095b9772afb47414627799144627547722b6322aae58d73
+  data.tar.gz: e58a394c1e3c9bd4b6787c092a09d1bb6582e313151baaedcb9ec0aee8c72735
 SHA512:
-  metadata.gz: 0e0dae287641c6fd8a404c9f22ade7cf1300534c1f5d64c6062f3bc7eb5d796384f419562595e3ef8e433d4b8cc0770d562aa7b1358beeb605653bff9a3d962a
-  data.tar.gz: 0c339cbf37dc393e8bed3a065bb05551ac74e0965c5d54cbccb134c924edca5ff4ffcf026da0e73e1c7650ce21bb4759b55fafffb6cc4911e0e7affee3be5c79
+  metadata.gz: 369cc10370be1f7e010d07a858143d929292633752286529b72c7f5558195146a350e5071585adb6a35d6c2edb1bf2a4915ab87f293001fc5669f90a0f46e77c
+  data.tar.gz: ffaec510b409f9cd1d93337aa9939af86d685f4d144cc9e6a06b8fe259a0fabbe1d60fb9628d90ea53ebcf5d313d02d8a3d09b49d548d8aac86abcb56710673b

data/README.md

@@ -1,19 +1,38 @@
 [![CircleCI](https://circleci.com/gh/SeasonedSoftware/croods-rails.svg?style=svg)](https://circleci.com/gh/SeasonedSoftware/croods-rails)
 [![Maintainability](https://api.codeclimate.com/v1/badges/5531c26549b427684578/maintainability)](https://codeclimate.com/github/SeasonedSoftware/croods-rails/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/5531c26549b427684578/test_coverage)](https://codeclimate.com/github/SeasonedSoftware/croods-rails/test_coverage)
+![](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
+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]
@@ -25,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
@@ -34,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
@@ -47,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
@@ -58,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
@@ -70,6 +99,7 @@ end
 ```
 
 Protip: you can create a Model module and `extend_model { include Projects::Model }`.
+
 ```ruby
 module Projects
   module Model
@@ -81,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,
@@ -93,37 +126,21 @@ use_for_authentication!(
   :validatable
 )
 ```
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'croods'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install croods
-```
-
 
 ## Contributing
 
 You can manually check your changes in the dummy Rails app under `/todos`.
 
 To set it up:
+
 ```
 cd todos/
 bin/setup
 ```
 
 To run specs use:
-```bin/rspec```
+`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/multi_tenancy.rb

@@ -14,7 +14,7 @@ module Croods
       def tenant_model
         return unless Croods.multi_tenancy?
 
-        Croods.multi_tenancy_by.to_s.titleize.constantize
+        Croods.multi_tenancy_by.to_s.camelize.constantize
       end
 
       def header_tenant

data/lib/croods/policy/scope.rb

@@ -37,16 +37,14 @@ module Croods
 
         associations = scope.reflect_on_all_associations(:belongs_to)
 
-        return path if associations.empty?
-
         associations.each do |association|
           model = association.class_name.constantize
           expanded_path = path + [association]
           association_path = reflection_path(model, target, expanded_path)
-          return association_path if association_path != path
+          return association_path unless association_path.empty?
         end
 
-        path
+        []
       end
 
       def joins(path)

data/lib/croods/resource/authentication.rb

@@ -24,6 +24,7 @@ module Croods
 
         request do
           add_attribute :password, :string, null: false
+          skip_attribute :admin
         end
       end
 

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

@@ -5,11 +5,12 @@ 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
@@ -18,21 +19,30 @@ module Croods
           end
 
           def format(attribute)
-            is_date = attribute.type == :datetime || attribute.type == :date
-            return {} unless is_date
-
-            { format: 'date-time' }
+            case attribute.type
+            when :datetime
+              { format: 'date-time' }
+            when :date
+              { format: 'date' }
+            else
+              {}
+            end
           end
 
           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/json_schema/links.rb

@@ -30,7 +30,7 @@ module Croods
           end
 
           def action_module(name)
-            "Croods::Resource::JsonSchema::Links::#{name.to_s.titleize}"
+            "Croods::Resource::JsonSchema::Links::#{name.to_s.camelize}"
               .constantize
           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.titleize}Scope"
+        "#{model_name}#{action.to_s.titleize.gsub(/\ /, '')}Scope"
       end
 
       def create_policy!

data/lib/croods/version.rb

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

metadata

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