croods 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1b0dd2406b59f7c88e4488699e1681249f92da22dd31c2c71abe850755d8439
-  data.tar.gz: 203bf41a0d129e931037de59e07588c49c906ee0b8c0cc592db3e8ca04b8c8e6
+  metadata.gz: 650a72062d9460d74e7efa322db3df3ec47e972ed475674aac75f7b05daa6fe9
+  data.tar.gz: ecdca75bcdadcb9cf07fa97ce5cd5495fca20d29a47a6b40d5c18613aa005d54
 SHA512:
-  metadata.gz: c7bcb1d81082fdd67a1104c23460f6efc33139b4334ac64cbdd5ef34aa44a71a14a810e339f4be1eea66e0a4a3162843525db72201fb0b1e602d6c502eeb2b62
-  data.tar.gz: 6f003b69476c254f700d3dafbcc690f969e319452f52b97869c5a20d1b3c0a269acc572cb3ac3a1114fae6102fcbd10b53d0bbcffb74fd4401bb5f4c3a0496a9
+  metadata.gz: 927e71afb7f0cc1f3141dcf8e1c2616b9090008d3aa80c2da54d83a8a15ff554d67af02d73c6958680c8a97a9b0122593e48288ea4960943b7a2c74817cf2c38
+  data.tar.gz: f63bb7198a6268b4e3ee192689e094a7e58d3476d0b4206569a5a6ae14f713fce1f2f45ba9262594a970d347224a8e587f281b1ef4cd17d8563f5bf6f5a93757

data/README.md

@@ -1,9 +1,98 @@
+[![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)
+
 # Croods
 Short description and motivation.
 
 ## Usage
-How to use my plugin.
+### 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```
+
+``` 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]
+  def change
+    create_table :projects do |t|
+      t.string :name, null: false
+      t.timestamps
+    end
+  end
+end
+```
+Then create the module and the main file `app/resources/projects/resource.rb`:
+```ruby 
+module Projects
+  class Resource < ApplicationResource
+  end
+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:
+```ruby
+module Projects
+  class Resource < ApplicationResource
+    skip_actions :index, :create, :update, :show, :destroy
+  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
+    skip_attributes :created_at, :updated_at
+  end
+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
+    extend_model  do
+      before_create :do_somethig
+    end
+  end
+end
+```
+
+Protip: you can create a Model module and `extend_model { include Projects::Model }`.
+```ruby
+module Projects
+  module Model
+    extend ActiveSupport::Concern
 
+    included do
+      before_create :do_something
+    end
+  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,
+  :recoverable,
+  :rememberable,
+  :trackable,
+  :validatable
+)
+```
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -21,8 +110,20 @@ Or install it yourself as:
 $ gem install croods
 ```
 
+
 ## Contributing
-Contribution directions go here.
+
+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```
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

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

@@ -4,7 +4,12 @@ module Croods
   module Resource
     module JsonSchema
       module Definition
-        TYPES = { datetime: 'string', text: 'string', json: 'object' }.freeze
+        TYPES = {
+          datetime: 'string',
+          text: 'string',
+          json: 'object',
+          float: 'number'
+        }.freeze
 
         class << self
           def schema(attribute)

data/lib/croods/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: croods
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Daniel Weinmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: committee
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement