rest-api-generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3e06c4a9026a2a814873ee73588d2192c5962d366f35bf6dfd4277208887abd
-  data.tar.gz: e4efc771085f7fafb99399ddaa899ff72edf90865d5bd03f39644e686b841c48
+  metadata.gz: cf4062a70bed1e9006d96375d4110b3918f3bf5d074304c4619abfa4fe33eb03
+  data.tar.gz: ba52d11b288dd8004e68327a8db4aabac8bef8be93eea85382f3bf349406ea39
 SHA512:
-  metadata.gz: 633346498caa5fa13db9077962e5a26d1015764f60c96aac91ba75f712f483cba833a16323c19a84f20f91d93c1fbf02ecd2028f59998f4388b151cd41b02db9
-  data.tar.gz: 6584c32a008736381fb3b5658cbf21b69efb4587a570d78143a4658ef3c98c4e72049b05e8ebee8453bed60ff6bc559d3a37ca24026d97e5f17537d1ee41a58c
+  metadata.gz: a1ef3d60ca714e5edf5db7cdcf6b0287ef22c2123c907070cb3b6608ca159ceba200642a8b45894cb88e0fab73d5abaeb728e19a05c9e2760cd0e17ccb155732
+  data.tar.gz: 9849fa88d3b3a9f5a070c7f4a4ca29fc3deb8447adb80260004aa68076cd0a27db9cbeb5d214aed2505df4a1c1a48e26378dc41b6626159eb635d1a7d2c0218e

data/Gemfile

@@ -9,4 +9,4 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 1.21"
+gem "switchcop"

data/Gemfile.lock

@@ -1,107 +1,234 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.1)
-      railties (>= 5.0.0)
+    rest-api-generator (0.1.2)
+      rails (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.6)
-      actionview (= 6.1.6)
-      activesupport (= 6.1.6)
-      rack (~> 2.0, >= 2.0.9)
+    actioncable (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.4)
+      actionpack (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activesupport (= 7.0.4)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.6)
-      activesupport (= 6.1.6)
+    actiontext (7.0.4)
+      actionpack (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.6)
+    activejob (7.0.4)
+      activesupport (= 7.0.4)
+      globalid (>= 0.3.6)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activestorage (7.0.4)
+      actionpack (= 7.0.4)
+      activejob (= 7.0.4)
+      activerecord (= 7.0.4)
+      activesupport (= 7.0.4)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+    ammeter (1.1.5)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
+    database_cleaner (2.0.1)
+      database_cleaner-active_record (~> 2.0.0)
+    database_cleaner-active_record (2.0.1)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    date (3.3.3)
     diff-lcs (1.5.0)
-    erubi (1.10.0)
-    i18n (1.10.0)
+    erubi (1.12.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.18.0)
+    json (2.6.3)
+    loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    mail (2.8.0)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
     method_source (1.0.0)
-    minitest (5.16.1)
-    nokogiri (1.13.6-x86_64-linux)
+    mini_mime (1.1.2)
+    minitest (5.16.3)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.8)
+    nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
-    racc (1.6.0)
+    racc (1.6.2)
     rack (2.2.4)
     rack-test (2.0.2)
       rack (>= 1.3)
+    rails (7.0.4)
+      actioncable (= 7.0.4)
+      actionmailbox (= 7.0.4)
+      actionmailer (= 7.0.4)
+      actionpack (= 7.0.4)
+      actiontext (= 7.0.4)
+      actionview (= 7.0.4)
+      activejob (= 7.0.4)
+      activemodel (= 7.0.4)
+      activerecord (= 7.0.4)
+      activestorage (= 7.0.4)
+      activesupport (= 7.0.4)
+      bundler (>= 1.15.0)
+      railties (= 7.0.4)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (6.1.6)
-      actionpack (= 6.1.6)
-      activesupport (= 6.1.6)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.1)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.28.2)
+      rspec-support (~> 3.12.0)
+    rspec-rails (6.0.1)
+      actionpack (>= 6.1)
+      activesupport (>= 6.1)
+      railties (>= 6.1)
+      rspec-core (~> 3.11)
+      rspec-expectations (~> 3.11)
+      rspec-mocks (~> 3.11)
+      rspec-support (~> 3.11)
+    rspec-support (3.12.0)
+    rubocop (1.40.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.17.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    rubocop-shopify (2.10.1)
+      rubocop (~> 1.35)
     ruby-progressbar (1.11.0)
+    sqlite3 (1.5.4-x86_64-linux)
+    switchcop (0.1.2)
+      rubocop (~> 1.40.0)
+      rubocop-performance (~> 1.15.1)
+      rubocop-rails (~> 2.17.3)
+      rubocop-rspec (~> 2.16.0)
+      rubocop-shopify (~> 2.10.1)
     thor (1.2.1)
-    tzinfo (2.0.4)
+    timeout (0.3.1)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
-    zeitwerk (2.6.0)
+    unicode-display_width (2.3.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  ammeter (~> 1.1.5)
+  database_cleaner
   rake (~> 13.0)
   rest-api-generator!
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rspec-rails (~> 6.0.0)
+  sqlite3
+  switchcop
 
 BUNDLED WITH
    2.3.3

data/README.md

@@ -5,7 +5,7 @@ practices.
 
 ## How it works?
 
-The gems use vanilla Rails generators n combination with our templates to create all the resources needed to build a
+The gems use vanilla Rails generators in combination with our templates to create all the resources needed to build a
 REST API.
 
 Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices, the controllers are built with:
@@ -16,14 +16,32 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 
 - For tests, we use RSpec and FactoryBot.
 
+## Current Features
+
+- [Automatic rest api crud generation](#example)
+- [Nested Resource](#nested-resource)
+- [Modular error handler](#modular-error-handler)
+- [Resource ordering](#ordering)
+- [Resource filter](#filtering)
+
+## Next Features
+
+- Generate nested resource end-points 🚧
+- Automated documentation 🚧 https://github.com/SwitchDreams/rest-api-generator/issues/12
+- Serialization https://github.com/SwitchDreams/rest-api-generator/issues/14
+  https://github.com/SwitchDreams/rest-api-generator/issues/11
+- Pagination https://github.com/SwitchDreams/rest-api-generator/issues/15
+- Integration with AVO
+- Select fields
+- User auth module
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-group :development do
-  gem 'rest-api-generator'
-end
+# Build a Ruby on Rails REST API faster
+gem 'rest-api-generator'
 ```
 
 And then execute:
@@ -61,13 +79,15 @@ This error handler will rescue from: `ActiveRecord::RecordNotFound`
 ### Generate Resource
 
 ```bash
-$ rails g rest-api-generator:resource table_name attributes
+$ rails g rest_api_generator:resource table_name attributes
 ```
 
 This command will create:
 
 - **Model and Migration**: Using rails default model generator
-- **Controller**: A controller with index,show,create,update and destroy methods.
+- **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
@@ -75,11 +95,96 @@ This command will create:
 ### Example
 
 ```bash
-$ rails g rest-api-generator:resource car name:string color:string
+$ 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            |
+
+#### 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
@@ -118,9 +223,52 @@ class CarsController < ApplicationController
     params.require(:car).permit(:name, :color)
   end
 end
+```
+
+### 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`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: [:spec, :rubocop]

data/lib/generators/rest_api_generator/helpers.rb

@@ -17,5 +17,35 @@ module RestApiGenerator
         Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
       end
     end
+
+    def option_to_path(option)
+      option.downcase.split("::").join("/")
+    end
+
+    def scope_route_path
+      return "" if options["scope"].blank?
+
+      option_to_path(options["scope"])
+    end
+
+    def nested_routes
+      return "" if options["father"].blank?
+
+      "#{options["father"].downcase.pluralize}/\#{#{options["father"].singularize.downcase}.id}/#{plural_name}"
+    end
+
+    def initial_route
+      scope_route_path + "/" + nested_routes
+    end
+
+    def spec_routes
+      {
+        index: initial_route,
+        show: initial_route + "\#{#{singular_name}.id}",
+        create: initial_route,
+        update: initial_route + "\#{#{singular_name}.id}",
+        delete: initial_route + "\#{#{singular_name}.id}",
+      }
+    end
   end
 end

data/lib/generators/rest_api_generator/resource_generator.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "rails/generators"
+require "rails/generators/active_model"
+require "rails/generators/rails/model/model_generator"
 require "generators/rest_api_generator/helpers"
 module RestApiGenerator
   class ResourceGenerator < Rails::Generators::NamedBase
@@ -8,31 +10,89 @@ module RestApiGenerator
     source_root File.expand_path("templates", __dir__)
 
     argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+    class_option :eject, type: :boolean, default: false
     class_option :scope, type: :string, default: ""
+    class_option :father, type: :string, default: ""
 
     API_CONTROLLER_DIR_PATH = "app/controllers"
     API_TEST_DIR_PATH = "spec/requests"
 
     def create_service_file
-      Rails::Generators.invoke("model", [file_name, build_model_attributes])
-      if options["scope"].empty?
-        controller_path = "#{API_CONTROLLER_DIR_PATH}/#{file_name.pluralize}_controller.rb"
-        controller_test_path = "#{API_TEST_DIR_PATH}/#{file_name.pluralize}_controller_spec.rb"
-        template "rest_api_controller.rb", controller_path
-        template "rest_api_spec.rb", controller_test_path
-        routes_string = "resources :#{file_name.pluralize}"
-        route routes_string
+      create_model_files
+
+      # Create controller and specs
+      controller_path = "#{API_CONTROLLER_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller.rb"
+      controller_test_path = "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller_spec.rb"
+
+      template controller_template, controller_path
+      template spec_controller_template, controller_test_path
+
+      if options["scope"].blank? && options["father"].blank?
+        route "resources :#{file_name.pluralize}"
       else
-        scope_path = options["scope"].pluralize
-        controller_path = "#{API_CONTROLLER_DIR_PATH}/#{scope_path}/#{file_name.pluralize}_controller.rb"
-        controller_test_path = "#{API_TEST_DIR_PATH}/#{scope_path}/#{file_name.pluralize}_controller_spec.rb"
-        template "child_api_controller.rb", controller_path
-        template "child_api_spec.rb", controller_test_path
+        log("You need to manually setup routes files for nested or scoped resource")
       end
     end
 
     private
 
+    def scope_path
+      return "" if options["scope"].blank? && options["father"].blank?
+
+      if options["scope"].present? && options["father"].present?
+        "/" + option_to_path(options["scope"]) + "/" + option_to_path(options["father"])
+      else
+        "/" + option_to_path(options["scope"]) + option_to_path(options["father"])
+      end
+    end
+
+    def scope_namespacing(&block)
+      content = capture(&block)
+      content = wrap_with_scope(content) if options["scope"].present? || options["father"].present?
+      concat(content)
+    end
+
+    def module_namespace
+      if options["scope"].present? && options["father"].present?
+        options["scope"] + "::" + options["father"]
+      else
+        options["scope"] + options["father"]
+      end
+    end
+
+    def wrap_with_scope(content)
+      content = indent(content).chomp
+      "module #{module_namespace}\n#{content}\nend\n"
+    end
+
+    def controller_template
+      if options["eject"]
+        if options["father"].present?
+          "child_api_controller.rb"
+        else
+          "rest_api_controller.rb"
+        end
+      elsif options["father"].present?
+        "implicit_child_resource_controller.rb"
+      else
+        "implicit_resource_controller.rb"
+      end
+    end
+
+    def spec_controller_template
+      if options["father"].present?
+        "child_api_spec.rb"
+      else
+        "rest_api_spec.rb"
+      end
+    end
+
+    def create_model_files
+      g = Rails::Generators::ModelGenerator.new([file_name, build_model_attributes])
+      g.destination_root = destination_root
+      g.invoke_all
+    end
+
     def build_model_attributes
       model_attributes = []
       attributes.each do |attribute|

data/lib/generators/rest_api_generator/templates/child_api_controller.rb.tt

@@ -1,9 +1,10 @@
+<% scope_namespacing do -%>
 class <%= class_name.pluralize %>Controller < ApplicationController
-  before_action :set_<%= options['scope'].downcase %>
-  before_action :set_<%= singular_name %>, only: %i[show update destroy]
+  before_action :set_<%= options['father'].downcase.singularize %>
+  before_action :set_<%= singular_name %>, only: %i[ show update destroy ]
 
   def index
-    @<%= plural_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>
+    @<%= plural_name %> = @<%= options['father'].downcase.singularize %>.<%= plural_name %>
     render json: @<%= plural_name %>, status: :ok
   end
 
@@ -12,7 +13,7 @@ class <%= class_name.pluralize %>Controller < ApplicationController
   end
 
   def create
-    @<%= singular_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>.create!(<%= singular_name %>_params)
+    @<%= singular_name %> = @<%= options['father'].downcase.singularize %>.<%= plural_name %>.create!(<%= singular_name %>_params)
     render json: @<%= singular_name %>, status: :created
   end
 
@@ -25,18 +26,18 @@ class <%= class_name.pluralize %>Controller < ApplicationController
     @<%= singular_name %>.destroy!
   end
 
-
   private
 
-  def set_<%= options['scope'].downcase %>
-    @<%= options['scope'].downcase %> = <%= options['scope'] %>.find(params[:<%= options['scope'].downcase %>_id])
+  def set_<%= options['father'].downcase.singularize %>
+    @<%= options['father'].downcase %> = <%= options['father'] %>.find(params[:<%= options['father'].downcase.singularize %>_id])
   end
 
   def set_<%= singular_name %>
-    @<%= singular_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>.find(params[:id])
+    @<%= singular_name %> = @<%= options['father'].downcase.singularize %>.<%= plural_name %>.find(params[:id])
   end
 
   def <%= singular_name %>_params
     params.require(:<%= singular_name %>).permit(<%= attributes.map { |a| ':' + a.name }.join(', ') %>)
   end
-end
+end
+<% end -%>

data/lib/generators/rest_api_generator/templates/child_api_spec.rb.tt

@@ -1,14 +1,36 @@
-require 'rails_helper'
+require "rails_helper"
 
-RSpec.describe "<%=class_name %>", type: :request do
+RSpec.describe "<%= class_name %>", type: :request do
   let(:valid_attributes) { attributes_for(:<%= singular_table_name %>) }
 
-  describe "POST /<%= plural_name%>" do
+  describe "GET /<%= plural_name %>" do
+    let(:<%= options['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
+    let(:<%= singular_table_name %>) { create(:<%=singular_table_name %>, <%= options['father'].downcase %>: <%= options['father'].downcase %>) }
+
+    it "renders a successful response" do
+      get "<%= spec_routes[:index] %>"
+      expect(response).to be_successful
+    end
+  end
+
+
+   describe "GET /<%= singular_name %>" do
+     let(:<%= options['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
+     let(:<%= singular_table_name %>) { create(:<%=singular_table_name %>, <%= options['father'].downcase.singularize %>: <%= options['father'].downcase %>)}
+
+     it "gets an <%= singular_name %>" do
+       get "<%= spec_routes[:show] %>"
+       expect(response).to be_successful
+     end
+   end
+
+
+  describe "POST /<%= plural_name %>" do
     context "with valid parameters" do
-      it "creates a new <%=singular_name %>" do
-        <%= options['scope'].downcase %> = create(:<%= options['scope'].downcase %>)
+      let(:<%= options['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
+      it "creates a new <%= singular_name %>" do
         expect do
-          post "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%= plural_name %>",
+          post "<%= spec_routes[:create] %>",
                params: { <%= singular_name %>: valid_attributes }
         end.to change(<%= class_name %>, :count).by(1)
       end
@@ -16,44 +38,25 @@ RSpec.describe "<%=class_name %>", type: :request do
   end
 
   describe "PATCH /<%= plural_name %>" do
-    let(:<%= options['scope'].downcase %>) {create(:<%= options['scope'].downcase %>)}
-    let(:<%= singular_table_name %>) { create(:<%=singular_table_name %>, <%= options['scope'].downcase %>: <%= options['scope'].downcase %>)}
+    let(:<%= options['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
+    let(:<%= singular_table_name %>) { create(:<%=singular_table_name %>, <%= options['father'].downcase.singularize %>: <%= options['father'].downcase.singularize %>)}
 
-    it "updates an <%=singular_name %>" do
-        patch "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%=plural_name %>/#{<%= singular_name %>.id}",
+    it "updates an <%= singular_name %>" do
+        patch "<%= spec_routes[:update] %>",
             params: { <%= singular_name %>: valid_attributes }
         expect(response).to have_http_status(:success)
     end
   end
 
   describe "DELETE /<%= singular_name %>" do
-    let(:<%= options['scope'].downcase %>) {create(:<%= options['scope'].downcase %>)}
+    let(:<%= options['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
 
-    it "deletes an <%=singular_name %>" do
-      <%= singular_table_name %> = create(:<%=singular_table_name %>, <%= options['scope'].downcase %>: <%= options['scope'].downcase %>)
+    it "deletes an <%= singular_name %>" do
+      <%= singular_table_name %> = create(:<%=singular_table_name %>, <%= options['father'].downcase.singularize %>: <%= options['father'].downcase.singularize %>)
       expect do
-        delete "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%=plural_name %>/#{<%= singular_name %>.id}"
+        delete "<%= spec_routes[:delete] %>"
       end.to change(<%= class_name %>, :count).by(-1)
     end
   end
 
-  describe "GET/ <%= singular_name %>" do
-    let(:<%= options['scope'].downcase %>) {create(:<%= options['scope'].downcase %>)}
-    let(:<%= singular_table_name %>) { create(:<%=singular_table_name %>, <%= options['scope'].downcase %>: <%= options['scope'].downcase %>)}
-
-    it "gets an <%=singular_name %>" do
-      get "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%= plural_name %>/#{<%= singular_name %>.id}"
-      expect(response).to be_successful
-    end
-  end
-
-  describe "GET /<%= plural_name %>" do
-    let(:<%= options['scope'].downcase %>) {create(:<%= options['scope'].downcase %>)}
-    let(:<%= singular_table_name %>) { create(:<%=singular_table_name %>, <%= options['scope'].downcase %>: <%= options['scope'].downcase %>) }
-
-    it "renders a successful response" do
-      get "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%= plural_name %>"
-      expect(response).to be_successful
-    end
-  end
-end
+end

data/lib/generators/rest_api_generator/templates/implicit_child_resource_controller.rb.tt

@@ -0,0 +1,4 @@
+<% scope_namespacing do -%>
+class <%= class_name.pluralize %>Controller < RestApiGenerator::ChildResourceController
+end
+<% end -%>

data/lib/generators/rest_api_generator/templates/implicit_resource_controller.rb.tt

@@ -0,0 +1,4 @@
+<% scope_namespacing do -%>
+class <%= class_name.pluralize %>Controller < RestApiGenerator::ResourceController
+end
+<% end -%>

data/lib/generators/rest_api_generator/templates/rest_api_controller.rb.tt

@@ -1,3 +1,4 @@
+<% scope_namespacing do -%>
 class <%= class_name.pluralize %>Controller < ApplicationController
   before_action :set_<%= singular_name %>, only: %i[show update destroy]
 
@@ -34,3 +35,4 @@ class <%= class_name.pluralize %>Controller < ApplicationController
     params.require(:<%= singular_name %>).permit(<%= attributes.map { |a| ':' + a.name }.join(', ') %>)
   end
 end
+<% end -%>

data/lib/generators/rest_api_generator/templates/rest_api_spec.rb.tt

@@ -7,14 +7,14 @@ RSpec.describe "<%= class_name %>", type: :request do
   describe "GET /<%= plural_name %>" do
     it "returns http success" do
       create(:<%= singular_table_name %>)
-      get "/<%= plural_name %>"
+      get "<%= spec_routes[:index] %>"
       expect(response).to have_http_status(:success)
     end
   end
 
   describe "GET /<%= plural_name %>/:id" do
     it "returns http success" do
-      get "/<%= plural_name %>/#{<%= singular_name %>.id}"
+      get "<%= spec_routes[:show] %>"
       expect(response).to have_http_status(:success)
     end
   end
@@ -22,7 +22,7 @@ RSpec.describe "<%= class_name %>", type: :request do
   describe "POST /<%= plural_name %>" do
     it "creates a new item" do
       expect do
-        post "/<%= plural_name %>",
+        post "<%= spec_routes[:create] %>",
              params: { <%= singular_name %>: valid_attributes }
       end.to change(<%= class_name %>, :count).by(1)
     end
@@ -30,7 +30,7 @@ RSpec.describe "<%= class_name %>", type: :request do
 
   describe "PATCH /<%= plural_name %>/:id" do
     it "return http success" do
-      patch "/<%= plural_name %>/#{<%= singular_name %>.id}",
+      patch "<%= spec_routes[:update] %>",
             params: { <%= singular_name %>: valid_attributes }
       expect(response).to have_http_status(:success)
     end
@@ -40,7 +40,7 @@ RSpec.describe "<%= class_name %>", type: :request do
     it "deletes an <%= plural_name %>" do
       item = create(:<%= singular_name %>)
       expect do
-        delete "/<%= plural_name %>/#{item.id}"
+        delete "<%= spec_routes[:delete] %>"
       end.to change(<%= class_name %>, :count).by(-1)
     end
   end

data/lib/rest-api-generator.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + "/rest_api_generator"

data/lib/rest_api_generator/application_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "action_controller"
+
+module RestApiGenerator
+  class ApplicationController < ActionController::Base
+  end
+end

data/lib/rest_api_generator/child_resource_controller.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  class ChildResourceController < RestApiGenerator.parent_controller.constantize
+    include Orderable
+
+    before_action :set_parent_resource
+    before_action :set_resource, only: [:show, :update, :destroy]
+
+    def index
+      @resources = resources
+      @resources = @resources.filter_resource(params_for_filter) if resource_class.include?(Filterable)
+      @resources = @resources.order(ordering_params(params[:sort])) if params[:sort]
+      render json: @resources, status: :ok
+    end
+
+    def show
+      render json: @resource, status: :ok
+    end
+
+    def create
+      @resource = resources.create!(resource_created_params)
+      render json: @resource, status: :created
+    end
+
+    def update
+      @resource.update!(resource_updated_params)
+      render json: @resource, status: :ok
+    end
+
+    def destroy
+      @resource.destroy!
+    end
+
+    private
+
+    def resources
+      @parent_resource.send(resource_class.to_s.downcase.pluralize)
+    end
+
+    def parent_resource_class
+      parent_resource_by_controller_name
+    end
+
+    def resource_class
+      resource_by_controller_name
+    end
+
+    # Params
+    def resource_created_params
+      resource_params
+    end
+
+    def resource_updated_params
+      resource_params
+    end
+
+    def resource_params
+      params.require(resource_class.model_name.singular.to_sym).permit(resource_attributes)
+    end
+
+    def resource_attributes
+      resource_class.attribute_names.map(&:to_sym)
+    end
+
+    def params_for_filter
+      params.slice(*resource_class.filter_scopes)
+    end
+
+    # Before actions
+    def set_parent_resource
+      @parent_resource = parent_resource_class.find(parent_record_id)
+    end
+
+    def set_resource
+      @resource = resources.find(record_id)
+    end
+
+    # UsersController => User
+    def resource_by_controller_name(controller_name = self.class.to_s)
+      controller_name.split(Regexp.union(["Controller", "::"]))[-1].singularize.constantize
+    end
+
+    # Users::DevicesController => User
+    def parent_resource_by_controller_name(controller_name = self.class.to_s)
+      controller_name.split(Regexp.union(["Controller", "::"]))[-2].singularize.constantize
+    end
+
+    def parent_record_id
+      params.dig("#{parent_resource_class.to_s.downcase.singularize}_id")
+    end
+
+    def record_id
+      params.permit(:id)[:id]
+    end
+  end
+end

data/lib/rest_api_generator/filterable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module RestApiGenerator
+  module Filterable
+    extend ActiveSupport::Concern
+
+    included do
+      @filter_scopes ||= []
+    end
+
+    module ClassMethods
+      attr_reader :filter_scopes
+
+      def filter_scope(name, *args)
+        scope name, *args
+        @filter_scopes << name.to_s.gsub("filter_by_", "").to_sym
+      end
+
+      def filter_resource(params)
+        results = where(nil)
+        params.each do |key, value|
+          results = results.public_send("filter_by_#{key}", value) if value.present?
+        end
+        results
+      end
+    end
+  end
+end

data/lib/rest_api_generator/helpers/render.rb

@@ -7,7 +7,7 @@ module RestApiGenerator
         {
           status: status,
           error: error,
-          message: message
+          message: message,
         }.as_json
       end
     end

data/lib/rest_api_generator/orderable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/concern"
+
+module RestApiGenerator
+  module Orderable
+    extend ActiveSupport::Concern
+
+    SORT_ORDER = { " " => :asc, "+" => :asc, "-" => :desc }
+
+    # Returns params for order in active record order syntax
+    # GET /api/v1/transactions?sort=-amount
+    #
+    # ordering_params(params) # => { amount: :desc }
+    def ordering_params(order_params)
+      ordering = {}
+      if order_params
+        sorted_params = order_params.split(",")
+        sorted_params.each do |attr|
+          sort_sign = /\A[ +-]/.match?(attr) ? attr.slice!(0) : "+"
+          if resource_class.attribute_names.include?(attr)
+            ordering[attr] = SORT_ORDER[sort_sign]
+          end
+        end
+      end
+      ordering
+    end
+  end
+end

data/lib/rest_api_generator/resource_controller.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  class ResourceController < RestApiGenerator.parent_controller.constantize
+    include Orderable
+
+    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)
+      @resources = @resources.order(ordering_params(params[:sort])) if params[:sort]
+      render json: @resources, status: :ok
+    end
+
+    def show
+      render json: @resource, status: :ok
+    end
+
+    def create
+      @resource = resource_class.create!(resource_created_params)
+      render json: @resource, status: :created
+    end
+
+    def update
+      @resource.update!(resource_updated_params)
+      render json: @resource, status: :ok
+    end
+
+    def destroy
+      @resource.destroy!
+    end
+
+    private
+
+    def params_for_filter
+      params.slice(*resource_class.filter_scopes)
+    end
+
+    def resource_class
+      resource_by_controller_name
+    end
+
+    def resource_created_params
+      resource_params
+    end
+
+    def resource_updated_params
+      resource_params
+    end
+
+    def resource_params
+      params.require(resource_class.model_name.singular.to_sym).permit(resource_attributes)
+    end
+
+    def resource_attributes
+      resource_class.attribute_names.map(&:to_sym)
+    end
+
+    def set_resource
+      @resource = resource_class.find(record_id)
+    end
+
+    # UsersController => User
+    def resource_by_controller_name(controller_name = self.class.to_s)
+      controller_name.split(Regexp.union(["Controller", "::"]))[-1].singularize.constantize
+    end
+
+    def record_id
+      params.permit(:id)[:id]
+    end
+  end
+end

data/lib/rest_api_generator/version.rb

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

data/lib/rest_api_generator.rb

@@ -1,11 +1,21 @@
 # frozen_string_literal: true
 
+require "rails"
 require_relative "rest_api_generator/version"
+require_relative "rest_api_generator/application_controller"
 require_relative "rest_api_generator/error_handler"
 require_relative "rest_api_generator/custom_error"
 require_relative "rest_api_generator/helpers/render"
+require_relative "rest_api_generator/filterable"
+require_relative "rest_api_generator/orderable"
 
 module RestApiGenerator
   class Error < StandardError; end
-  # Your code goes here...
+
+  def self.parent_controller
+    "RestApiGenerator::ApplicationController"
+  end
 end
+
+require_relative "rest_api_generator/resource_controller"
+require_relative "rest_api_generator/child_resource_controller"

data/rest-api-generator.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+$:.push File.expand_path("../lib", __FILE__)
 
 require_relative "lib/rest_api_generator/version"
-require_relative "lib/rest_api_generator"
 
 Gem::Specification.new do |spec|
   spec.name = "rest-api-generator"
@@ -27,9 +27,15 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency("railties", ">= 5.0.0")
-
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
   spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.add_dependency "rails", ">= 5.0"
+
+  spec.add_development_dependency 'ammeter', '~> 1.1.5'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+
 end

metadata

@@ -1,29 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2022-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem helps you to build a Ruby on Rails REST API faster, using a
   scaffold-like generator that follows the best practices.
 email:
@@ -43,12 +99,20 @@ files:
 - lib/generators/rest_api_generator/resource_generator.rb
 - lib/generators/rest_api_generator/templates/child_api_controller.rb.tt
 - lib/generators/rest_api_generator/templates/child_api_spec.rb.tt
+- lib/generators/rest_api_generator/templates/implicit_child_resource_controller.rb.tt
+- lib/generators/rest_api_generator/templates/implicit_resource_controller.rb.tt
 - lib/generators/rest_api_generator/templates/rest_api_controller.rb.tt
 - lib/generators/rest_api_generator/templates/rest_api_spec.rb.tt
+- lib/rest-api-generator.rb
 - lib/rest_api_generator.rb
+- lib/rest_api_generator/application_controller.rb
+- lib/rest_api_generator/child_resource_controller.rb
 - lib/rest_api_generator/custom_error.rb
 - lib/rest_api_generator/error_handler.rb
+- lib/rest_api_generator/filterable.rb
 - lib/rest_api_generator/helpers/render.rb
+- lib/rest_api_generator/orderable.rb
+- lib/rest_api_generator/resource_controller.rb
 - lib/rest_api_generator/version.rb
 - rest-api-generator.gemspec
 - sig/rest_api_generator.rbs
@@ -76,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Build a Ruby on Rails REST API faster