rest-api-generator 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3e06c4a9026a2a814873ee73588d2192c5962d366f35bf6dfd4277208887abd
-  data.tar.gz: e4efc771085f7fafb99399ddaa899ff72edf90865d5bd03f39644e686b841c48
+  metadata.gz: a3c84db27490fa76b76096f10ba351092bfb42479890a2a279d725f579c4edb7
+  data.tar.gz: 25e537cd496a09eb3b5755fadf4d04bbcaad38c941bf54af60e230ed7a1ccd13
 SHA512:
-  metadata.gz: 633346498caa5fa13db9077962e5a26d1015764f60c96aac91ba75f712f483cba833a16323c19a84f20f91d93c1fbf02ecd2028f59998f4388b151cd41b02db9
-  data.tar.gz: 6584c32a008736381fb3b5658cbf21b69efb4587a570d78143a4658ef3c98c4e72049b05e8ebee8453bed60ff6bc559d3a37ca24026d97e5f17537d1ee41a58c
+  metadata.gz: a0f07b832a6373ed5197f114a0bdc54c6a6c2088d712e3641b8d55d717a5d5b019bba3427907b73495ac6a97de2bfbdd68ee48de267651808cf3d6adbe9f2547
+  data.tar.gz: 565c3cc7797794a6c59008990e58727173c5fa472ef8a8a188cb2a2ba60789cf03994ba8feaff7d8d5dfcf3443333412ece5dbb926f5a44156fa71ad240531b0

data/Gemfile

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

data/Gemfile.lock

@@ -1,107 +1,255 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.1)
-      railties (>= 5.0.0)
+    rest-api-generator (0.1.3)
+      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)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    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)
+    json-schema (3.0.0)
+      addressable (>= 2.8)
+    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)
+    public_suffix (5.0.1)
+    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)
+    rswag (2.8.0)
+      rswag-api (= 2.8.0)
+      rswag-specs (= 2.8.0)
+      rswag-ui (= 2.8.0)
+    rswag-api (2.8.0)
+      railties (>= 3.1, < 7.1)
+    rswag-specs (2.8.0)
+      activesupport (>= 3.1, < 7.1)
+      json-schema (>= 2.2, < 4.0)
+      railties (>= 3.1, < 7.1)
+      rspec-core (>= 2.14)
+    rswag-ui (2.8.0)
+      actionpack (>= 3.1, < 7.1)
+      railties (>= 3.1, < 7.1)
+    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)
+  rswag
+  rswag-specs
+  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,31 @@ 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)
+- :goal_net: [Modular error handler](#modular-error-handler)
+- :memo: [Automated documentation](#specsdocs)
+- [Resource ordering](#ordering)
+- [Resource filter](#filtering)
+
+## Next Features
+
+- 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 +78,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 +94,97 @@ 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            |
+| 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
@@ -118,9 +223,70 @@ class CarsController < ApplicationController
     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
+```
+
+### 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

@@ -4,8 +4,12 @@ module RestApiGenerator
   module Helpers
     attr_accessor :options, :attributes
 
+    API_CONTROLLER_DIR_PATH = "app/controllers"
+    API_TEST_DIR_PATH = "spec/requests"
+
     private
 
+    # Columns handlers
     def model_columns_for_attributes
       class_name.singularize.constantize.columns.reject do |column|
         column.name.to_s =~ /^(id|user_id|created_at|updated_at)$/
@@ -17,5 +21,73 @@ module RestApiGenerator
         Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
       end
     end
+
+    # Namespace scope
+
+    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
+
+    # Paths handlers
+    def controller_path
+      "#{API_CONTROLLER_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller.rb"
+    end
+
+    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 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
+      return "/#{plural_name}" if options["father"].blank? && options["scope"].blank?
+
+      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