rails-api_controller_generator 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 011a416363c1bd330b5facd8c93cffd4583914f2
+  data.tar.gz: eed63327b3d82db1311d07d3ed573e1b9a295d9a
+SHA512:
+  metadata.gz: 4a74ca1e98a8f636b5230ba9a12def0931894e4f58fb2426d3be1976f7076b7c675dfa556892593e24340d1b1216f424d6753c98ddbf5f099d45a53cb60875df
+  data.tar.gz: 550fe850bca92b88984aa1304b878c3c722f511038a3a7bc0ed9bdde65dbf81ca44b7e9f713ea4afa609652ec8f5732064d7bfb028f40904a4f9a1c788779545

data/lib/generators/api_controller/api_controller_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators/resource_helpers'
+
+class ApiControllerGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  include ::Rails::Generators::ResourceHelpers
+
+  check_class_collision suffix: "Controller"
+
+  class_option :orm, banner: "NAME", type: :string, required: true,
+    desc: "ORM to generate the controller for"
+
+  def create_controller_file
+    template "controller.rb", File.join('app/controllers/api', controller_class_path, "#{controller_file_name}_controller.rb")
+  end
+
+  def add_routes_entry
+    insert_into_file "config/routes.rb", :after => "Rails.application.routes.draw do\n" do
+      <<CODE
+  namespace :api do
+    resources :#{controller_file_name}
+  end\n
+CODE
+    end
+  end
+
+  hook_for :test_framework
+end

data/lib/generators/api_controller/install/install_generator.rb

@@ -0,0 +1,17 @@
+module ApiController
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc 'Copies the required files for ApiControllerGenerator'
+      source_root ::File.expand_path('../templates', __FILE__)
+
+      def copy_base_controller
+        copy_file "base_controller.rb", "app/controllers/api/base_controller.rb"
+      end
+
+      def copy_rspec_helper_file
+        empty_directory 'spec/support'
+        copy_file "api_helper.rb", "spec/support/api_helper.rb"
+      end
+    end
+  end
+end

data/lib/generators/api_controller/install/templates/api_helper.rb

@@ -0,0 +1,9 @@
+module ApiHelper
+  def json(data)
+    JSON.parse(data, symbolize_names: true)
+  end
+end
+
+RSpec.configure do |config|
+  config.include ApiHelper, type: :request
+end

data/lib/generators/api_controller/install/templates/base_controller.rb

@@ -0,0 +1,55 @@
+class Api::BaseController < ApplicationController
+  protected
+  def send_success(data, status=200, options={})
+    obj = {json: data, status: status}
+    obj = obj.merge options
+    render obj
+  end
+
+  def send_error(data, status=422)
+    logger.error data.to_json
+    render json: data, status: status
+  end
+
+  def send_no_content(status=204)
+    head status
+  end
+
+  def send_not_found(message=nil)
+    if message.nil?
+      head 404, "content_type" => 'text/plain'
+    else
+      render json: {message: message}, status: 404
+    end
+  end
+
+  def send_forbidden(message=nil)
+    if message.nil?
+      head 403, "content_type" => 'text/plain'
+    else
+      render json: {message: message}, status: 403
+    end
+  end
+
+  def send_validation_errors(errors, message="Validation failed")
+    if errors.is_a? ActiveModel::Errors
+      all_error_objects = []
+      errors.keys.each do |field|
+        err_obj = {}
+        err_obj[:field] = field
+        err_obj[:message] = errors[field].join(", ")
+        all_error_objects << err_obj
+      end
+    else
+      all_error_objects = errors
+    end
+
+    logger.error all_error_objects.to_json
+
+    render json: {message: message, errors: all_error_objects}, status: 422
+  end
+
+  def default_serializer_options
+    {root: false}
+  end
+end

data/lib/generators/api_controller/templates/controller.rb

@@ -0,0 +1,60 @@
+<% module_namespacing do -%>
+class Api::<%= controller_class_name %>Controller < Api::BaseController
+  # list
+  def index
+    send_success(find_all)
+  end
+
+  # get
+  def show
+    send_success(find)
+  rescue ActiveRecord::RecordNotFound
+    send_not_found
+  end
+
+  # insert
+  def create
+    <%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+    <%= singular_table_name %>.save!
+    send_success(<%= singular_table_name %>, 201)
+  rescue ActiveRecord::RecordInvalid
+    send_error(<%= singular_table_name %>.errors)
+  rescue ActiveRecord::RecordNotFound => e
+    send_error(e.message)
+  end
+
+  # patch
+  def update
+    <%= singular_table_name %> = find
+    <%= singular_table_name %>.update!(<%= singular_table_name %>_params)
+    send_success(<%= singular_table_name %>)
+  rescue ActiveRecord::RecordNotFound
+    send_not_found
+  rescue ActiveRecord::RecordInvalid
+    send_error(<%= singular_table_name %>.errors)
+  end
+
+  # delete
+  def destroy
+    <%= singular_table_name %> = find
+    <%= singular_table_name %>.destroy
+    send_no_content
+  rescue ActiveRecord::RecordNotFound
+    send_not_found
+  end
+
+  private
+  def <%= "#{singular_table_name}_params" %>
+    params.require(:<%= singular_table_name %>).permit(
+      <%= (class_name.constantize.column_names - ['id', 'created_at', 'updated_at']).map { |name| ":#{name}" }.join(",\n\t\t\t") %>)
+  end
+
+  def find_all
+    <%= orm_class.all(class_name) %>
+  end
+
+  def find
+    <%= orm_class.find(class_name, "params[:id]") %>
+  end
+end
+<% end -%>

data/lib/generators/rspec/api_controller_generator.rb

@@ -0,0 +1,14 @@
+module Rspec
+  module Generators
+    class ApiControllerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates an API controller spec in spec/api"
+
+      def generate_spec
+        empty_directory 'spec/api'
+        template "api_spec.rb", "spec/api/#{file_name.pluralize}_api_spec.rb"
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/api_spec.rb

@@ -0,0 +1,127 @@
+require 'rails_helper'
+
+RSpec.describe "<%= class_name.pluralize %> API", type: :request do
+  before :each do
+    host! "example.com"
+  end
+
+  xcontext "list" do
+    it 'returns the list of all records' do
+      create_<%= file_name %>
+      get endpoint_url
+
+      result = json(response.body)
+      expect(response.status).to eq(200)
+      expect(result.count).to eq(1)
+      # TODO: assert returned data
+      expect(result.first[:attribute_1]).to eq('value_1')
+    end
+
+    it "returns an empty array if no records are found" do
+      get endpoint_url
+
+      result = json(response.body)
+      expect(response.status).to eq(200)
+      expect(result).to eq([])
+    end
+  end
+
+  xcontext "get" do
+    it 'returns a record by id' do
+      # TODO: persist a record
+      <%= file_name %> = create_<%= file_name %>
+      get endpoint_url_with_id(<%= file_name %>.id)
+
+      result = json(response.body)
+      expect(response.status).to eq(200)
+      # TODO: assert returned data
+      expect(result[:attribute_1]).to eq('value_1')
+    end
+
+    it "returns 404 response if record not found" do
+      get endpoint_url_with_id(123)
+
+      expect(response.status).to eq(404)
+    end
+  end
+
+  xcontext "insert" do
+    it "returns 201 response if successful" do
+      # TODO: set data for the request
+      data = { attribute_1: 'value_1' }
+      post endpoint_url, params: { <%= file_name %>: data }
+
+      result = json(response.body)
+      expect(response.status).to eq(201)
+      expect(result[:id]).to_not be_nil
+    end
+
+    it "returns 422 response if failed to create" do
+      # TODO: set some invalid data for the request
+      data = {attribute_1: ''}
+      post endpoint_url, params: { <%= file_name %>: data }
+
+      result = json(response.body)
+      expect(result).to_not be_empty
+      expect(response.status).to eq(422)
+    end
+  end
+
+  xcontext "patch" do
+    it "returns 200 response if successful"  do
+      <%= file_name %> = create_<%= file_name %>
+      # TODO: set updated data for the request
+      data = {attribute_1: 'updated_value_1'}
+      patch endpoint_url_with_id(<%= file_name %>.id), params: { <%= file_name %>: data }
+
+      expect(response.status).to eq(200)
+      # TODO: assert updated data
+      expect(<%= file_name %>.reload.attribute_1).to eq('updated_value_1')
+    end
+
+    it "returns 422 response if failed to update" do
+      <%= file_name %> = create_<%= file_name %>
+      # TODO: set some invalid data for the request
+      data = {attribute_1: ''}
+      patch endpoint_url_with_id(<%= file_name %>.id), params: { <%= file_name %>: data }
+
+      expect(response.status).to eq(422)
+    end
+
+    it "returns 404 response if record not found" do
+      patch endpoint_url_with_id(123), params: { <%= file_name %>: {} }
+      expect(response.status).to eq(404)
+    end
+  end
+
+  xcontext "delete" do
+    it "returns 204 response if successful"  do
+      <%= file_name %> = create_<%= file_name %>
+      delete endpoint_url_with_id(<%= file_name %>.id)
+
+      expect(response.status).to eq(204)
+      all_<%= file_name.pluralize %> = <%= class_name %>.all
+      expect(all_<%= file_name.pluralize %>.count).to eq(0)
+    end
+
+    it "returns 404 response if record not found" do
+      delete endpoint_url_with_id(123)
+      expect(response.status).to eq(404)
+    end
+  end
+
+  private
+  def create_<%= file_name %>
+    raise NotImplementedError
+    # TODO:
+    # <%= class_name %>.create!(attribute_1: 'value_1')
+  end
+
+  def endpoint_url
+    "/api/<%= file_name.pluralize %>"
+  end
+
+  def endpoint_url_with_id(id)
+    "/api/<%= file_name.pluralize %>/#{id}"
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: rails-api_controller_generator
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Chanaka Sandaruwan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies: []
+description: Generates API controllers with endpoints for basic crud operations for
+  a model.
+email: chanakasan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/api_controller/api_controller_generator.rb
+- lib/generators/api_controller/install/install_generator.rb
+- lib/generators/api_controller/install/templates/api_helper.rb
+- lib/generators/api_controller/install/templates/base_controller.rb
+- lib/generators/api_controller/templates/controller.rb
+- lib/generators/rspec/api_controller_generator.rb
+- lib/generators/rspec/templates/api_spec.rb
+homepage: https://github.com/chanakasan/rails-api_controller_generator
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.3
+signing_key: 
+specification_version: 4
+summary: Generates API controllers with endpoints for basic crud operations.
+test_files: []