rest-api-generator 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b15131fc7fcedabae2098ef8f2e5e255683acda454d022304ea855ac9ce0a98a
-  data.tar.gz: 413967d92aca8c5c65075a8dfd5d0159be5c00b29a918b5bc3a39275217b3b6b
+  metadata.gz: a42f65c1630afe3db2bc1acb7c66272b9703e61ac761d509b0561e6c9369d7df
+  data.tar.gz: 898e903b7b81efa687f272a18ec7179f42ac566da404b1f046002b74345c9f77
 SHA512:
-  metadata.gz: 439eb464b272818413629d6ca448c1e976603d97543600f521ff9386ba47e514c4a380b367c087a75a96cdeb5a501d707b365ca5d52d35a4cd3adf08fbddf9ec
-  data.tar.gz: 79ec324210477f42878cadebaf87566083c6db14251de20206a2cb2a98f2fd9bcbaba969170ecc3cfcee5dae89a51a37381aeaddb29fe30c7fd4d817d769f2de
+  metadata.gz: 83e49d124a05cee3c742a69d5d2b1f798014e331c2a662a2bd7b0b19cb99ca45d66bdd290fa996e0c7e969d302fc9ecd49e9c69554836fe582d55adbb06f8f66
+  data.tar.gz: 14bd2117229d7cc2cb6b17371f7d0767720e3b6051ddcfc5fa6fb95aec438c29db25800ec5d44505284e4c56ba817e36666fa9118262228d5ab6086d740b0016

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.2.0)
+    rest-api-generator (0.3.0)
       anyway_config (>= 2.0.0)
       pagy
       rails (>= 5.0)

data/README.md

@@ -3,6 +3,11 @@
 This gem helps you to build a Ruby on Rails REST API faster, using a scaffold-like generator that follows the best
 practices.
 
+## Get started
+
+:zap: **Quick Start**: [docs](https://rest-api-generator.switchdreams.com.br/quick-start)\
+:books: **Documentation**: [docs](https://rest-api-generator.switchdreams.com.br/)
+
 ## How it works?
 
 The gems use vanilla Rails generators in combination with our templates to create all the resources needed to build a
@@ -27,6 +32,7 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 - [Resource pagination](#pagination)
 - [Resource serialization](#serialization)
 - [Configurable](#configuration)
+- [Callbacks](#callbacks)
 
 ## Next Features
 
@@ -34,344 +40,6 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 - Select fields
 - User auth module
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-# Build a Ruby on Rails REST API faster
-gem 'rest-api-generator'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install rest-api-generator
-
-## Requirements
-
-1. You need to have installed RSpec and FactoryBot in your application.
-
-<ul>
-  <li>RSpec: https://github.com/rspec/rspec-rails</li>
-  <li>Factory bot: https://github.com/thoughtbot/factory_bot_rails</li>
-</ul>
-
-2. Include in ApplicationController the error handler module:
-
-```ruby
-
-class ApplicationController < ActionController::API
-  include RestApiGenerator::ErrorHandler
-end
-```
-
-This error handler will rescue from: `ActiveRecord::RecordNotFound`
-, `ActiveRecord::ActiveRecordError`, `ActiveRecord::RecordInvalid`, `ActiveModel::ValidationError`
-, `RestApiGenerator::CustomError`.
-
-## Usage
-
-### Generate Resource
-
-```bash
-$ rails g rest_api_generator:resource table_name attributes
-```
-
-This command will create:
-
-- **Model and Migration**: Using rails default model generator
-- **Controller**: A controller that implementes CRUD by inheritance of `RestApiGenerator::ResourceController`, or you
-  can use eject option for create a controller
-  that implements index, show, create, update and destroy methods.
-- **Specs for the created controller**
-- **Factory bot factory for created model**
-- **Routes**: with rails resources
-
-### Example
-
-```bash
-$ rails g rest_api_generator:resource car name:string color:string
-```
-
-Will generate following controller and the other files:
-
-```ruby
-# app/controllers/cars_controller.rb
-class CarsController < RestApiGenerator::ResourceController
-end
-```
-
-For a better experience you can override some methods from the
-[default controller](https://github.com/SwitchDreams/rest-api-generator/blob/main/lib/rest_api_generator/resource_controller.rb)
-
-### Options
-
-| Option | Goal                                                         | Default | Usage Example   |
-|--------|--------------------------------------------------------------|---------|-----------------|
-| father | Generate nested resource                                     | nil     | --father Users  |
-| scope  | Scope the resource for other route or namespace organization | nil     | --scope Api::V1 |
-| eject  | Eject the controller to high customization                   | false   | true            |
-| spec   | Choose the spec format. Current options: "rspec" or "rswag"  | rspec   | --spec rswag    |
-
-#### Scope
-
-In REST api one of the best practices is versioning the end-points, and you can achieve this using scope options,
-example:
-
-```bash
-# Command
-rails g rest_api_generator:resource car name:string color:string --scope Api::V1
-```
-
-```ruby
-# GET api/v1/cars
-module Api::V1
-  class CarsController < RestApiGenerator::ResourceController
-  end
-end
-```
-
-For this option you need to manually setup routes, for this example:
-
-```ruby
-# routes.rb
-namespace :api do
-  namespace :v1 do
-    resources :cars
-  end
-end
-```
-
-#### Nested resource
-
-In REST api sometimes we need to build a nested resource, for example when we need to get all devices from a user, for
-this we have nested resource option:
-
-```bash
-# Command
-rails g rest_api_generator:resource Devices name:string color:string users:references --scope Users
-```
-
-```ruby
-# GET users/:user_id/devices
-module Users
-  class DevicesController < RestApiGenerator::ChildResourceController
-  end
-end
-```
-
-For this option you need to manually setup routes, for this example:
-
-```ruby
-# routes.rb
-resources :users do
-  resources :devices, controller: 'users/devices'
-end
-```
-
-Considerations:
-
-- The children model needs to belongs_to parent model and parent model needs to have has_many children model
-
-#### Eject
-
-Or you can use the `eject` option for create the controller with the implemented methods:
-
-```bash
-rails g rest_api_generator:resource car name:string color:string --eject true
-```
-
-```ruby
-
-class CarsController < ApplicationController
-  before_action :set_car, only: %i[show update destroy]
-
-  def index
-    @car = Car.all
-    render json: @car, status: :ok
-  end
-
-  def show
-    render json: @car, status: :ok
-  end
-
-  def create
-    @car = Car.create!(car_params)
-    render json: @car, status: :created
-  end
-
-  def update
-    @car = Car.update!(car_params)
-    render json: @car, status: :ok
-  end
-
-  def destroy
-    @car.destroy!
-  end
-
-  private
-
-  def set_car
-    @car = Car.find(params[:id])
-  end
-
-  def car_params
-    params.require(:car).permit(:name, :color)
-  end
-end
-```
-
-#### Specs/Docs
-
-The default generated spec for this gem is using plain rspec, but you can choose rswag, for scaffold you specs and docs
-at the same time:
-
-For this you need to setup https://github.com/rswag/rswag and you the following flag when generating resources.
-
-```shell
-rails g rest_api_generator:resource Car name:string color:string --spec rswag
-```
-
-This spec options work as generators too, so you can call them individually:
-
-```shell
-# rest_api_generator:spec:rswag or rest_api_generator:spec:rspec
-rails g rest_api_generator:spec:rswag Car name:string color:string
-```
-
-#### Configuration for specs
-
-By default, the plain rspec and rswag specs are going to be generated in the _spec/requests_ and _spec/docs_
-directories, respectively. You can override using the (config options)[#configuration]]. :
-
-### Resource Features
-
-#### Modular Error Handler
-
-The error module will return a json in this following format when any active record or custom error raises.
-
-```json
-{
-  "status": 422,
-  "error": "",
-  "message": ""
-}
-```
-
-This is good to padronize the error handler in front-end too.
-
-#### Ordering
-
-For ordering use this format:
-
-- Ordering asc: `GET /cars?sort=+name or GET /cars?sort=name`
-- Ordering desc: `GET /card?sort=-name`
-
-By default, every resource column can be the key for ordering.
-
-#### Filtering
-
-For filter is needed to add some scopes in Model file, example:
-
-```ruby
-# app/models/car.rb
-
-class Car < ApplicationRecord
-  include RestApiGenerator::Filterable
-
-  filter_scope :filter_by_color, ->(color) { where(color: color) }
-  filter_scope :filter_by_name, ->(name) { where("name LIKE ?", "%#{name}%") }
-end
-```
-
-And It's done, you can filter your index end-point:
-
-- `GET /cars?color=blue or GET /cars?color=red&name=Ferrari`
-
-### Pagination
-
-For pagination, you need to create pagy initialializer file (pagy.rb) in the config directory of your project.
-Follow [pagy's example](https://ddnexus.github.io/pagy/quick-start/) for more information.
-
-Next, you should add some lines on top of the previously created pagy file:
-
-```ruby
-# config/initializers/pagy.rb
-require "pagy"
-require "pagy/extras/headers"
-```
-
-At last, change the pagination variable on RestApiGenerator initializer to true;
-
-```rb
-# config/initializers/rest_api_generator.rb 
-config.pagination = true # default: false
-```
-
-Note, if the parent controller is changed, it is necessary to include Pagy::Backend in the new parent.
-
-```rb
-# new_parent_controller.rb 
-class NewParentController < ActionController::Base
-  include Pagy::Backend
-end
-```
-
-### Serialization
-
-If you are working with [ams](https://github.com/rails-api/active_model_serializers), the serializer will work without
-any extra configuration.
-But if you need to customize you can override the serializer method in the controller:
-
-```ruby
-# Example with panko serializer: https://github.com/panko-serializer/panko_serializer
-class CarsController < RestApiGenerator::ResourceController
-
-  # serializer used in show, create, update.
-  def serializer(resource)
-    Panko::CarSerializer.new.serialize_to_json(resource)
-  end
-
-  # serializer used in index.
-  def index_serializer(resources)
-    Panko::ArraySerializer.new(resources, each_serializer: Panko::CarSerializer).to_json
-  end
-end
-```
-
-```ruby
-# Example with ams
-class CarsController < RestApiGenerator::ResourceController
-  def serializer(resource)
-    ActiveModelSerializers::SerializableResource.new(resource, each_serializer: Ams::CarSerializer).to_json
-  end
-end
-```
-
-The gem is tested with [panko serializer](https://github.com/panko-serializer/panko_serializer)
-and [ams](https://github.com/rails-api/active_model_serializers). But should works with any serializer, feel free to add
-tests for your favorite serializer.
-
-## Configuration
-
-You can override this gem configuration using the initializer or any other method
-from [anyway_config](https://github.com/palkan/anyway_config):
-
-```rb
-# config/initializers/rest_api_generator.rb 
-
-RestApiGenerator.configure do |config|
-  config.test_path = "custom_test_dir/requests" # default: spec/requests
-  config.docs_path = "custom_docs_dir/rswag" # default: spec/docs
-  config.parent_class = "ApplicationController" # default: RestApiGenerator::ResourceController
-  config.pagination = true # default: false
-end
-```
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can

data/app/controllers/rest_api_generator/child_resource_controller.rb

@@ -2,6 +2,7 @@
 
 module RestApiGenerator
   class ChildResourceController < RestApiGenerator.configuration.parent_controller.constantize
+    include ControllerCallbacks
     include Orderable
     include Serializable
 
@@ -74,11 +75,15 @@ module RestApiGenerator
 
     # Before actions
     def set_parent_resource
-      @parent_resource = parent_resource_class.find(parent_record_id)
+      run_callbacks :set_parent_resource do
+        @parent_resource = parent_resource_class.find(parent_record_id)
+      end
     end
 
     def set_resource
-      @resource = resources.find(record_id)
+      run_callbacks :set_resource do
+        @resource = resources.find(record_id)
+      end
     end
 
     # UsersController => User

data/app/controllers/rest_api_generator/resource_controller.rb

@@ -2,11 +2,11 @@
 
 module RestApiGenerator
   class ResourceController < RestApiGenerator.configuration.parent_controller.constantize
+    include ControllerCallbacks
     include Orderable
     include Serializable
 
     before_action :set_resource, only: [:show, :update, :destroy]
-
     def index
       @resources = resource_class.all
       @resources = @resources.filter_resource(params_for_filter) if resource_class.include?(Filterable)
@@ -63,7 +63,9 @@ module RestApiGenerator
     end
 
     def set_resource
-      @resource = resource_class.find(record_id)
+      run_callbacks :set_resource do
+        @resource = resource_class.find(record_id)
+      end
     end
 
     # UsersController => User

data/lib/rest_api_generator/controller_callbacks.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  module ControllerCallbacks
+    extend ActiveSupport::Concern
+    include ActiveSupport::Callbacks
+
+    included do
+      define_callbacks :set_resource
+      define_callbacks :set_parent_resource
+    end
+
+    module ClassMethods
+      # Code from rails source code
+      [:before, :after, :around].each do |callback|
+        define_method "#{callback}_set_resource" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:set_resource, callback, name, options)
+          end
+        end
+
+        define_method "#{callback}_set_parent_resource" do |*names, &blk|
+          _insert_callbacks(names, blk) do |name, options|
+            set_callback(:set_parent_resource, callback, name, options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rest_api_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RestApiGenerator
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/rest_api_generator.rb

@@ -9,6 +9,7 @@ require_relative "rest_api_generator/helpers/render"
 require_relative "rest_api_generator/filterable"
 require_relative "rest_api_generator/orderable"
 require_relative "rest_api_generator/serializable"
+require_relative "rest_api_generator/controller_callbacks"
 
 module RestApiGenerator
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-15 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -155,6 +155,7 @@ files:
 - lib/rest-api-generator.rb
 - lib/rest_api_generator.rb
 - lib/rest_api_generator/config.rb
+- lib/rest_api_generator/controller_callbacks.rb
 - lib/rest_api_generator/custom_error.rb
 - lib/rest_api_generator/error_handler.rb
 - lib/rest_api_generator/filterable.rb