rest-api-generator 0.1.1 → 0.1.3

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,46 @@ 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: ""
-
-    API_CONTROLLER_DIR_PATH = "app/controllers"
-    API_TEST_DIR_PATH = "spec/requests"
+    class_option :father, type: :string, default: ""
+    hook_for :spec, in: "rest_api_generator:spec", default: "rspec"
 
     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
+
+      template controller_template, controller_path
+
+      # Routes
+      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 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 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/spec/rspec_generator.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "generators/rest_api_generator/helpers"
+
+module RestApiGenerator
+  module Spec
+    class RspecGenerator < Rails::Generators::NamedBase
+      include Helpers
+      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: ""
+
+      def create_service_file
+        template spec_controller_template, controller_test_path
+      end
+
+      private
+
+      def controller_test_path
+        "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller_spec.rb"
+      end
+
+      def spec_controller_template
+        if options["father"].present?
+          "rspec/resource_controller_spec.rb"
+        else
+          "rspec/nested_resource_controller_spec.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rest_api_generator/spec/rswag_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "generators/rest_api_generator/helpers"
+
+module RestApiGenerator
+  module Spec
+    class RswagGenerator < Rails::Generators::NamedBase
+      include Helpers
+      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: ""
+
+      def create_service_file
+        template spec_controller_template, controller_test_path
+      end
+
+      private
+
+      # Changes nested routes for rswag format
+      # Example: /cars/{car.id}/drivers/{id}
+      def nested_routes
+        return "" if options["father"].blank?
+
+        "#{options["father"].downcase.pluralize}/{#{options["father"].singularize.downcase}_id}/#{plural_name}"
+      end
+
+      def spec_routes
+        {
+          index: initial_route,
+          show: initial_route + "/{id}",
+          create: initial_route,
+          update: initial_route + "/{id}",
+          delete: initial_route + "/{id}",
+        }
+      end
+
+      def controller_test_path
+        "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_spec.rb"
+      end
+
+      def spec_controller_template
+        if options["father"].present?
+          "rswag/nested_resource_controller_spec.rb"
+        else
+          "rswag/resource_controller_spec.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rest_api_generator/spec/templates/rspec/nested_resource_controller_spec.rb.tt

@@ -0,0 +1,62 @@
+require "rails_helper"
+
+RSpec.describe "<%= class_name %>", type: :request do
+  let(:valid_attributes) { attributes_for(:<%= singular_table_name %>) }
+
+  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
+      let(:<%= options['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
+      it "creates a new <%= singular_name %>" do
+        expect do
+          post "<%= spec_routes[:create] %>",
+               params: { <%= singular_name %>: valid_attributes }
+        end.to change(<%= class_name %>, :count).by(1)
+      end
+    end
+  end
+
+  describe "PATCH /<%= plural_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.singularize %>)}
+
+    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['father'].downcase.singularize %>) { create(:<%= options['father'].downcase.singularize %>) }
+
+    it "deletes an <%= singular_name %>" do
+      <%= singular_table_name %> = create(:<%=singular_table_name %>, <%= options['father'].downcase.singularize %>: <%= options['father'].downcase.singularize %>)
+      expect do
+        delete "<%= spec_routes[:delete] %>"
+      end.to change(<%= class_name %>, :count).by(-1)
+    end
+  end
+
+end

data/lib/generators/rest_api_generator/{templates/rest_api_spec.rb.tt → spec/templates/rspec/resource_controller_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/generators/rest_api_generator/spec/templates/rswag/nested_resource_controller_spec.rb.tt

@@ -0,0 +1,116 @@
+require "rails_helper"
+
+RSpec.describe "<%= spec_routes[:index] %>", type: :request do
+  let(:resource) { create(:<%= singular_table_name %>, <%= options['father'].downcase.singularize %>: parent_resource) }
+  let(:parent_resource ) { create(:<%= options['father'].downcase.singularize %>) }
+
+  path "<%= spec_routes[:index] %>" do
+    parameter name: "<%= options['father'].downcase.singularize %>_id", in: :path, type: :string, description: "<%= options['father'].downcase.singularize %> id"
+    let(:<%= options['father'].downcase.singularize %>_id) { parent_resource.id }
+
+    get("list <%= plural_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    post("create <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+      response(201, "successful") do
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+  end
+
+  path "<%= spec_routes[:show] %>" do
+    parameter name: "id", in: :path, type: :string, description: "id"
+    parameter name: "<%= options['father'].downcase.singularize %>_id", in: :path, type: :string, description: "<%= options['father'].downcase.singularize %> id"
+
+    let(:id) { resource.id }
+    let(:<%= options['father'].downcase.singularize %>_id) { parent_resource.id }
+
+    get("show <%= singular_table_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+          }
+        }
+        end
+        run_test!
+      end
+    end
+
+
+    patch("update <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+
+      response(200, "successful") do
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    delete("delete plan") do
+      consumes "application/json"
+
+      response(204, "successful") do
+
+        run_test!
+      end
+    end
+  end
+end

data/lib/generators/rest_api_generator/spec/templates/rswag/resource_controller_spec.rb.tt

@@ -0,0 +1,111 @@
+require "rails_helper"
+
+RSpec.describe "<%= spec_routes[:index] %>", type: :request do
+  let(:resource) { create(:<%= singular_table_name %>) }
+
+  path "<%= spec_routes[:index] %>" do
+    get("list <%= plural_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    post("create <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+      response(201, "successful") do
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+  end
+
+  path "<%= spec_routes[:show] %>" do
+    parameter name: "id", in: :path, type: :string, description: "id"
+
+    get("show <%= singular_table_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+        let(:id) { resource.id }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+          }
+        }
+        end
+        run_test!
+      end
+    end
+
+
+    patch("update <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+
+      response(200, "successful") do
+        let(:id) { resource.id }
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    delete("delete plan") do
+      consumes "application/json"
+
+      response(204, "successful") do
+        let(:id) { resource.id }
+
+        run_test!
+      end
+    end
+  end
+end

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/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/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