rest-api-generator 0.1.0 → 0.1.2

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_<%= 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,5 +1,6 @@
+<% scope_namespacing do -%>
 class <%= class_name.pluralize %>Controller < ApplicationController
-  before_action :set_<%= singular_name %>, only: %i[ show update destroy ]
+  before_action :set_<%= singular_name %>, only: %i[show update destroy]
 
   def index
     @<%= singular_name %> = <%= class_name %>.all
@@ -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.0"
+  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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+$:.push File.expand_path("../lib", __FILE__)
+
+require_relative "lib/rest_api_generator/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rest-api-generator"
+  spec.version = RestApiGenerator::VERSION
+  spec.authors = ["PedroAugustoRamalhoDuarte"]
+  spec.email = ["pedro_aduarte@aluno.unb.br"]
+
+  spec.summary = "Build a Ruby on Rails REST API faster"
+  spec.description = "This gem helps you to build a Ruby on Rails REST API faster, using a scaffold-like generator that follows the best practices."
+  spec.homepage = "https://github.com/SwitchDreams/rest-api-generator"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/SwitchDreams/rest-api-generator"
+  spec.metadata["changelog_uri"] = "https://github.com/SwitchDreams/rest-api-generator"
+
+  spec.files = Dir["{bin,sig,lib,public}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "rest-api-generator.gemspec",
+                   "Gemfile", "Gemfile.lock"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # 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