rest-api-generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5f141a24ca9cc9e364aec03cdcf46eb3e2bee8cb36cbc120b8034c8ca7fad52
+  data.tar.gz: 6f6410abc9657e49c10cd9a9654a0e59360128aa1990a7acdbde26485ce9806f
+SHA512:
+  metadata.gz: 5130c55d992d388cb807642b0680983ef9fbf023d930d4182ff4af257c7209edb9dead5d4322d0d32a8eedc4b1d9e05a084d04c7735ac471c27ff34c4f984a63
+  data.tar.gz: 4172cf89cbff2f8ddc5216f174066fa1ccac17f7462b697103be6e624b0acd94c3114e84e96b4891dd6a6aa9151dfcb078030f6cbe23f84ed605c90f8eba6e98

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 17
+
+Metrics/AbcSize:
+  Max: 25

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at pedro_aduarte@aluno.unb.br. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rest-api-generator.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    rest-api-generator (0.1.0)
+      railties (>= 5.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.2.4)
+      actionview (= 7.0.2.4)
+      activesupport (= 7.0.2.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 (7.0.2.4)
+      activesupport (= 7.0.2.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.2.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.17.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nokogiri (1.13.5-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.2.4)
+      actionpack (= 7.0.2.4)
+      activesupport (= 7.0.2.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)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rest-api-generator!
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 PedroAugustoRamalhoDuarte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# RestApiGenerator
+
+This gem works as a scaffold to generate an endpoint, it generates:
+
+<ul>
+    <li> Model </li>
+    <li> Migration </li>
+    <li> Routes (resource) </li>
+    <li> Controller </li>
+    <li> Spec test of controller </li>
+    <li> Factory bot </li>
+</ul>
+
+the commnad its simmilar to the model generator "rails g model model_name attributes", in fact it invokes this generator to genrate the model and migration file
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rest-api-generator'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rest-api-generator
+
+## Requirements
+You need to have installed in your application rspec and factory bot
+
+<ul>
+  <li>Rspec: https://github.com/rspec/rspec-rails</li>
+  <li>Factory bot: https://github.com/thoughtbot/factory_bot_rails</li>
+</ul>
+
+then inside your folder app/spec create a new folder called "requests", that's where your tests will be generated
+
+## Usage
+### Run command
+   $ rails g generator table_name attributes
+
+************************************************************************************
+#### Model
+this will generate a table and a migration with the table name and it's attribute, it invokes the model generator
+
+************************************************************************************
+#### Endpoint
+It will genrate a controller CarsController that has the methods
+
+##### Create
+saves instance of generated model to database and return json of instance with status ok
+
+##### Update
+updates instance of generated modelfrom database and return json of instance with status ok
+
+##### Delete
+deletes instance of generated model from database 
+
+##### Show
+returns JSON instance of generated model from database with status ok
+
+##### Index
+returns JSON instance of generated model from database with status ok
+
+
+create and update will have permitted params defined by the attributes defined in the command (except if the attribute is type reference)
+************************************************************************************
+### Spec
+
+##### Create
+checks if instance was saved in database
+
+##### Update
+checks if instance was updated in database ok
+
+##### Delete
+checks if instance was deleted from database
+
+##### Show
+check if status ok
+
+##### Index
+check if status ok 
+
+************************************************************************************
+### Factory
+The factory will be generated with it's custom generator, defined in the instalation of the factory-bot
+
+************************************************************************************
+### Routes
+the routes generated are the basic resources routes:
+    table_name: resources
+
+************************************************************************************
+### Scope
+It's possible to add flag in the command to generate an endpoint with a parent
+   $ rails g generator table_name attributes --scope father_name
+
+the only thing this won't genrate it's the nested routes, but it will generate all the previous files mentioned just liek a scaffold
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rest-api-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rest-api-generator/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rest::Api::Generator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rest-api-generator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rest_api_generator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/rest_api_generator/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate rest_api_generator:resource Tag name:string
+
+    This will create:
+        what/will/it/create

data/lib/generators/rest_api_generator/helpers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  module Helpers
+    attr_accessor :options, :attributes
+
+    private
+
+    def model_columns_for_attributes
+      class_name.singularize.constantize.columns.reject do |column|
+        column.name.to_s =~ /^(id|user_id|created_at|updated_at)$/
+      end
+    end
+
+    def editable_attributes
+      @editable_attributes ||= model_columns_for_attributes.map do |column|
+        Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+      end
+    end
+  end
+end

data/lib/generators/rest_api_generator/resource_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "generators/rest_api_generator/helpers"
+module RestApiGenerator
+  class ResourceGenerator < 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 :scope, 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
+      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
+      end
+    end
+
+    private
+
+    def build_model_attributes
+      model_attributes = []
+      attributes.each do |attribute|
+        model_attributes << "#{attribute.name}:#{attribute.type}"
+      end
+      model_attributes
+    end
+  end
+end

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

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

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

@@ -0,0 +1,59 @@
+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

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

@@ -0,0 +1,36 @@
+class <%= class_name.pluralize %>Controller < ApplicationController
+  before_action :set_<%= singular_name %>, only: %i[ show update destroy ]
+
+  def index
+    @<%= singular_name %> = <%= class_name %>.all
+    render json: @<%= singular_name %>, status: :ok
+  end
+
+  def show
+    render json: @<%= singular_name %>, status: :ok
+  end
+
+  def create
+    @<%= singular_name %> = <%= class_name %>.create!(<%= singular_name %>_params)
+    render json: @<%= singular_name %>, status: :created
+  end
+
+  def update
+    @<%= singular_name %> = <%= class_name %>.update!(<%= singular_name %>_params)
+    render json: @<%= singular_name %>, status: :ok
+  end
+
+  def destroy
+    @<%= singular_name %>.destroy!
+  end
+
+  private
+
+  def set_<%= singular_name %>
+    @<%= singular_name %> = <%= class_name %>.find(params[:id])
+  end
+
+  def <%= singular_name %>_params
+    params.require(:<%= singular_name %>).permit(<%= attributes.map { |a| ':' + a.name }.join(', ') %>)
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name %>", type: :request do
+  let(:<%= singular_table_name %>) { create(:<%= singular_table_name %>) }
+  let(:valid_attributes) { attributes_for(:<%= singular_table_name %>) }
+
+  describe "GET /<%= plural_name %>" do
+    it "returns http success" do
+      create(:<%= singular_table_name %>)
+      get "/<%= plural_name %>"
+      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}"
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe "POST /<%= plural_name %>" do
+    it "creates a new item" do
+      expect do
+        post "/<%= plural_name %>",
+             params: { <%= singular_name %>: valid_attributes }
+      end.to change(<%= class_name %>, :count).by(1)
+    end
+  end
+
+  describe "PATCH /<%= plural_name %>/:id" do
+    it "return http success" do
+      patch "/<%= plural_name %>/#{<%= singular_name %>.id}",
+            params: { <%= singular_name %>: valid_attributes }
+      expect(response).to have_http_status(:success)
+    end
+  end
+
+  describe "DELETE /<%= plural_name %>/:id" do
+    it "deletes an <%= plural_name %>" do
+      item = create(:<%= singular_name %>)
+      expect do
+        delete "/<%= plural_name %>/#{item.id}"
+      end.to change(<%= class_name %>, :count).by(-1)
+    end
+  end
+end

data/lib/rest_api_generator/custom_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  class CustomError < StandardError
+    attr_reader :status, :error, :message
+
+    def initialize(error: 422, status: :unprocessable_entity, message: "Something went wrong")
+      @error = error
+      @status = status
+      @message = message
+      super(msg: message)
+    end
+
+    def fetch_json
+      Helpers::Render.json(error, message, status)
+    end
+  end
+end

data/lib/rest_api_generator/error_handler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  module ErrorHandler
+    def self.included(clazz)
+      clazz.class_eval do
+        rescue_from ActiveRecord::RecordNotFound do |e|
+          respond(:record_not_found, 404, e.to_s)
+        end
+        rescue_from ActiveRecord::ActiveRecordError do |e|
+          respond(:active_record_error, 422, e.to_s)
+        end
+        rescue_from ActiveRecord::RecordInvalid do |e|
+          respond(:active_record_invalid, 422, e.to_s)
+        end
+        rescue_from ActiveModel::ValidationError do |e|
+          respond(:active_model_validation_error, 422, e.to_s)
+        end
+        rescue_from CustomError do |e|
+          respond(e.error, e.status, e.message)
+        end
+      end
+    end
+
+    private
+
+    def respond(error, status, message)
+      json = Helpers::Render.json(error, status, message)
+      render json: json, status: status
+    end
+  end
+end

data/lib/rest_api_generator/helpers/render.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  module Helpers
+    class Render
+      def self.json(error, status, message)
+        {
+          status: status,
+          error: error,
+          message: message
+        }.as_json
+      end
+    end
+  end
+end

data/lib/rest_api_generator/version.rb

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

data/lib/rest_api_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "rest_api_generator/version"
+require_relative "rest_api_generator/error_handler"
+require_relative "rest_api_generator/custom_error"
+require_relative "rest_api_generator/helpers/render"
+
+module RestApiGenerator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/rest_api_generator.rbs

@@ -0,0 +1,4 @@
+module RestApiGenerator
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: rest-api-generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PedroAugustoRamalhoDuarte
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: Generates rest api in SwitchDreams default faster with rest-api-generator
+email:
+- pedro_aduarte@aluno.unb.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- 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/templates/child_api_controller.rb.tt
+- lib/generators/rest_api_generator/templates/child_api_spec.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/custom_error.rb
+- lib/rest_api_generator/error_handler.rb
+- lib/rest_api_generator/helpers/render.rb
+- lib/rest_api_generator/version.rb
+- sig/rest_api_generator.rbs
+homepage: https://github.com/SwitchDreams/rest-api-generator
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/SwitchDreams/rest-api-generator
+  source_code_uri: https://github.com/SwitchDreams/rest-api-generator
+  changelog_uri: https://github.com/SwitchDreams/rest-api-generator
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Build a rails rest api in minutes
+test_files: []