croods 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0900ac5dbe8afc94b575ee6e36071c7ca3d153c99e3fbd741e09824fe2d4334
-  data.tar.gz: 6d2e2dd3fa58485c3bdf64c4f78615505cb9197a41efa3e362b6f15b5a807369
+  metadata.gz: da70e6c23805cc55c8a4d7db9e97adc567a4bcd436fb0296600238e9826955c7
+  data.tar.gz: 43415c1a16fdefeaa51fc4dd5cf4b7c93121c8f16fbefefee5966af4ac714766
 SHA512:
-  metadata.gz: 50b61038f5c2fa00e737f620ae92d3a38aa2ab1128005fe53202bce881a47c673f0fc20a4d1968d4dafab4431a24ca41d13c34680f758aaf6e1c0d3a6566baa1
-  data.tar.gz: 5fe444a426181006daff456b818201a647f1dec094f55c7627bcee5e47f5cd84a0a7d7f63dc7cbccf161188c2fb52fa8549d2fa2467eca29ac459c617281ec80
+  metadata.gz: 3ea56e2741d2559944657daeeb73ef18cee25a381da09e50fe5f430cc4ae008015ec241e60cf96b7c931cc998fce5333fdd7f13e9e978d6f4ca890ece42554b7
+  data.tar.gz: da63eb7581f72c974162b6c905d438ba7afa2b8f18b1c5d319d675e8821c7a3aae4fbb3a420f46f4c09b8548911a53fd2d1b3915b7609859fdac6be82c6ac2b2

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,
@@ -112,14 +132,15 @@ use_for_authentication!(
 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/version.rb

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

metadata

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