rest-api-generator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f141a24ca9cc9e364aec03cdcf46eb3e2bee8cb36cbc120b8034c8ca7fad52
-  data.tar.gz: 6f6410abc9657e49c10cd9a9654a0e59360128aa1990a7acdbde26485ce9806f
+  metadata.gz: f3e06c4a9026a2a814873ee73588d2192c5962d366f35bf6dfd4277208887abd
+  data.tar.gz: e4efc771085f7fafb99399ddaa899ff72edf90865d5bd03f39644e686b841c48
 SHA512:
-  metadata.gz: 5130c55d992d388cb807642b0680983ef9fbf023d930d4182ff4af257c7209edb9dead5d4322d0d32a8eedc4b1d9e05a084d04c7735ac471c27ff34c4f984a63
-  data.tar.gz: 4172cf89cbff2f8ddc5216f174066fa1ccac17f7462b697103be6e624b0acd94c3114e84e96b4891dd6a6aa9151dfcb078030f6cbe23f84ed605c90f8eba6e98
+  metadata.gz: 633346498caa5fa13db9077962e5a26d1015764f60c96aac91ba75f712f483cba833a16323c19a84f20f91d93c1fbf02ecd2028f59998f4388b151cd41b02db9
+  data.tar.gz: 6584c32a008736381fb3b5658cbf21b69efb4587a570d78143a4658ef3c98c4e72049b05e8ebee8453bed60ff6bc559d3a37ca24026d97e5f17537d1ee41a58c

data/Gemfile.lock

@@ -1,30 +1,31 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.0)
+    rest-api-generator (0.1.1)
       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)
+    actionpack (6.1.6)
+      actionview (= 6.1.6)
+      activesupport (= 6.1.6)
+      rack (~> 2.0, >= 2.0.9)
       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)
+    actionview (6.1.6)
+      activesupport (= 6.1.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (7.0.2.4)
+    activesupport (6.1.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.10)
@@ -33,32 +34,31 @@ GEM
     erubi (1.10.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.17.0)
+    loofah (2.18.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)
+    minitest (5.16.1)
+    nokogiri (1.13.6-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)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (7.0.2.4)
-      actionpack (= 7.0.2.4)
-      activesupport (= 7.0.2.4)
+    railties (6.1.6)
+      actionpack (= 6.1.6)
+      activesupport (= 6.1.6)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
-      zeitwerk (~> 2.5)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.3.1)
@@ -92,7 +92,7 @@ GEM
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   x86_64-linux

data/README.md

@@ -1,24 +1,29 @@
-# RestApiGenerator
+# rest-api-generator
 
-This gem works as a scaffold to generate an endpoint, it generates:
+This gem helps you to build a Ruby on Rails REST API faster, using a scaffold-like generator that follows the best
+practices.
 
-<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>
+## How it works?
+
+The gems use vanilla Rails generators n 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:
+
+- We use an error module to centralize error handling, rescuing from a custom and some of ActiveRecord exceptions.
+  The inspiration for this strategy was
+  this [article](https://medium.com/rails-ember-beyond/error-handling-in-rails-the-modular-way-9afcddd2fe1b.)
 
-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
+- For tests, we use RSpec and FactoryBot.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rest-api-generator'
+group :development do
+  gem 'rest-api-generator'
+end
 ```
 
 And then execute:
@@ -30,92 +35,107 @@ Or install it yourself as:
     $ gem install rest-api-generator
 
 ## Requirements
-You need to have installed in your application rspec and factory bot
+
+1. You need to have installed RSpec and FactoryBot in your application.
 
 <ul>
-  <li>Rspec: https://github.com/rspec/rspec-rails</li>
+  <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
+2. Include in ApplicationController the error handler module:
+
+```ruby
+
+class ApplicationController < ActionController::API
+  include RestApiGenerator::ErrorHandler
+end
+```
+
+This error handler will rescue from: `ActiveRecord::RecordNotFound`
+, `ActiveRecord::ActiveRecordError`, `ActiveRecord::RecordInvalid`, `ActiveModel::ValidationError`
+, `RestApiGenerator::CustomError`.
 
 ## 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
+### Generate Resource
 
-************************************************************************************
-#### Endpoint
-It will genrate a controller CarsController that has the methods
+```bash
+$ rails g rest-api-generator:resource table_name attributes
+```
 
-##### Create
-saves instance of generated model to database and return json of instance with status ok
+This command will create:
 
-##### Update
-updates instance of generated modelfrom database and return json of instance with status ok
+- **Model and Migration**: Using rails default model generator
+- **Controller**: A controller with index,show,create,update and destroy methods.
+- **Specs for the created controller**
+- **Factory bot factory for created model**
+- **Routes**: with rails resources
 
-##### Delete
-deletes instance of generated model from database 
+### Example
 
-##### Show
-returns JSON instance of generated model from database with status ok
+```bash
+$ rails g rest-api-generator:resource car name:string color:string
+```
 
-##### Index
-returns JSON instance of generated model from database with status ok
+Will generate following controller and the other files:
 
+```ruby
 
-create and update will have permitted params defined by the attributes defined in the command (except if the attribute is type reference)
-************************************************************************************
-### Spec
+class CarsController < ApplicationController
+  before_action :set_car, only: %i[show update destroy]
 
-##### Create
-checks if instance was saved in database
+  def index
+    @car = Car.all
+    render json: @car, status: :ok
+  end
 
-##### Update
-checks if instance was updated in database ok
+  def show
+    render json: @car, status: :ok
+  end
 
-##### Delete
-checks if instance was deleted from database
+  def create
+    @car = Car.create!(car_params)
+    render json: @car, status: :created
+  end
 
-##### Show
-check if status ok
+  def update
+    @car = Car.update!(car_params)
+    render json: @car, status: :ok
+  end
 
-##### Index
-check if status ok 
+  def destroy
+    @car.destroy!
+  end
 
-************************************************************************************
-### Factory
-The factory will be generated with it's custom generator, defined in the instalation of the factory-bot
+  private
 
-************************************************************************************
-### Routes
-the routes generated are the basic resources routes:
-    table_name: resources
+  def set_car
+    @car = Car.find(params[:id])
+  end
 
-************************************************************************************
-### 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
+  def car_params
+    params.require(:car).permit(:name, :color)
+  end
+end
 
-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.
+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).
+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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/SwitchDreams/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/SwitchDreams/rest-api-generator/blob/main/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/lib/generators/rest_api_generator/templates/child_api_controller.rb.tt

@@ -1,6 +1,6 @@
 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_<%= singular_name %>, only: %i[show update destroy]
 
   def index
     @<%= plural_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>

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

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

data/lib/rest_api_generator/version.rb

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

data/rest-api-generator.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/rest_api_generator/version"
+require_relative "lib/rest_api_generator"
+
+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"]
+
+  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"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-05 00:00:00.000000000 Z
+date: 2022-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,19 +24,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-description: Generates rest api in SwitchDreams default faster with rest-api-generator
+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:
 - 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
@@ -53,6 +50,7 @@ files:
 - lib/rest_api_generator/error_handler.rb
 - lib/rest_api_generator/helpers/render.rb
 - lib/rest_api_generator/version.rb
+- rest-api-generator.gemspec
 - sig/rest_api_generator.rbs
 homepage: https://github.com/SwitchDreams/rest-api-generator
 licenses:
@@ -78,8 +76,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
-summary: Build a rails rest api in minutes
+summary: Build a Ruby on Rails REST API faster
 test_files: []

data/.rspec

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

data/.rubocop.yml

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

@@ -1,84 +0,0 @@
-# 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/LICENSE.txt

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