rest-api-generator 0.1.1 → 0.1.3

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.3"
 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,8 @@
 # frozen_string_literal: true
 
+$LOAD_PATH.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"
@@ -22,14 +23,20 @@ Gem::Specification.new do |spec|
   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"]
+    "Gemfile", "Gemfile.lock"]
   spec.bindir = "exe"
   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 "database_cleaner"
+  spec.add_development_dependency "rspec-rails", "~> 6.0.0"
+  spec.add_development_dependency "rswag"
+  spec.add_development_dependency "rswag-specs"
 end

metadata

@@ -1,29 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-07 00:00:00.000000000 Z
+date: 2023-01-06 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: 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'
+- !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: rswag
+  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: rswag-specs
+  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:
@@ -41,14 +111,26 @@ files:
 - lib/generators/rest_api_generator/USAGE
 - lib/generators/rest_api_generator/helpers.rb
 - lib/generators/rest_api_generator/resource_generator.rb
+- lib/generators/rest_api_generator/spec/rspec_generator.rb
+- lib/generators/rest_api_generator/spec/rswag_generator.rb
+- lib/generators/rest_api_generator/spec/templates/rspec/nested_resource_controller_spec.rb.tt
+- lib/generators/rest_api_generator/spec/templates/rspec/resource_controller_spec.rb.tt
+- lib/generators/rest_api_generator/spec/templates/rswag/nested_resource_controller_spec.rb.tt
+- lib/generators/rest_api_generator/spec/templates/rswag/resource_controller_spec.rb.tt
 - 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 +158,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

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

@@ -1,59 +0,0 @@
-require 'rails_helper'
-
-RSpec.describe "<%=class_name %>", type: :request do
-  let(:valid_attributes) { attributes_for(:<%= singular_table_name %>) }
-
-  describe "POST /<%= plural_name%>" do
-    context "with valid parameters" do
-      it "creates a new <%=singular_name %>" do
-        <%= options['scope'].downcase %> = create(:<%= options['scope'].downcase %>)
-        expect do
-          post "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%= plural_name %>",
-               params: { <%= singular_name %>: valid_attributes }
-        end.to change(<%= class_name %>, :count).by(1)
-      end
-    end
-  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 %>)}
-
-    it "updates an <%=singular_name %>" do
-        patch "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%=plural_name %>/#{<%= singular_name %>.id}",
-            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 %>)}
-
-    it "deletes an <%=singular_name %>" do
-      <%= singular_table_name %> = create(:<%=singular_table_name %>, <%= options['scope'].downcase %>: <%= options['scope'].downcase %>)
-      expect do
-        delete "/<%= options['scope'].downcase.pluralize %>/#{<%= options['scope'].downcase %>.id}/<%=plural_name %>/#{<%= singular_name %>.id}"
-      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