croods 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 650a72062d9460d74e7efa322db3df3ec47e972ed475674aac75f7b05daa6fe9
-  data.tar.gz: ecdca75bcdadcb9cf07fa97ce5cd5495fca20d29a47a6b40d5c18613aa005d54
+  metadata.gz: da70e6c23805cc55c8a4d7db9e97adc567a4bcd436fb0296600238e9826955c7
+  data.tar.gz: 43415c1a16fdefeaa51fc4dd5cf4b7c93121c8f16fbefefee5966af4ac714766
 SHA512:
-  metadata.gz: 927e71afb7f0cc1f3141dcf8e1c2616b9090008d3aa80c2da54d83a8a15ff554d67af02d73c6958680c8a97a9b0122593e48288ea4960943b7a2c74817cf2c38
-  data.tar.gz: f63bb7198a6268b4e3ee192689e094a7e58d3476d0b4206569a5a6ae14f713fce1f2f45ba9262594a970d347224a8e587f281b1ef4cd17d8563f5bf6f5a93757
+  metadata.gz: 3ea56e2741d2559944657daeeb73ef18cee25a381da09e50fe5f430cc4ae008015ec241e60cf96b7c931cc998fce5333fdd7f13e9e978d6f4ca890ece42554b7
+  data.tar.gz: da63eb7581f72c974162b6c905d438ba7afa2b8f18b1c5d319d675e8821c7a3aae4fbb3a420f46f4c09b8548911a53fd2d1b3915b7609859fdac6be82c6ac2b2

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

@@ -6,6 +6,7 @@ module Croods
       module Definition
         TYPES = {
           datetime: 'string',
+          date: 'string',
           text: 'string',
           json: 'object',
           float: 'number'
@@ -17,9 +18,14 @@ module Croods
           end
 
           def format(attribute)
-            return {} unless attribute.type == :datetime
-
-            { format: 'date-time' }
+            case attribute.type
+            when :datetime
+              { format: 'date-time' }
+            when :date
+              { format: 'date' }
+            else
+              {}
+            end
           end
 
           def types(attribute)

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

@@ -4,8 +4,6 @@ module Croods
   module Resource
     module JsonSchema
       module Definitions
-        TYPES = { datetime: 'string', text: 'string', json: 'object' }.freeze
-
         class << self
           def schema(resource)
             attributes(resource).merge(identity: identity(resource))

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.camelize}Scope"
       end
 
       def create_policy!

data/lib/croods/version.rb

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

metadata

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