power_api 0.1.0

data/lib/generators/power_api/version/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Creates new API version
+
+Example:
+    rails generate power_api:version 1

data/lib/generators/power_api/version/version_generator.rb

@@ -0,0 +1,54 @@
+class PowerApi::VersionGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def modify_routes
+    insert_into_file(
+      helper.routes_path,
+      after: helper.routes_line_to_inject_new_version
+    ) do
+      helper.version_route_tpl
+    end
+
+    helper.format_ruby_file(helper.routes_path)
+  end
+
+  def add_base_controller
+    create_file(
+      helper.base_controller_path,
+      helper.base_controller_tpl
+    )
+  end
+
+  def add_serializers_directory
+    create_file(helper.ams_serializers_path)
+  end
+
+  def add_swagger_related
+    create_file(helper.swagger_schemas_path)
+
+    create_file(
+      helper.swagger_version_definition_path,
+      helper.swagger_definition_tpl
+    )
+
+    insert_into_file(
+      helper.rswag_ui_initializer_path,
+      after: helper.rswag_ui_configure_line
+    ) do
+      helper.rswag_ui_swagger_endpoint
+    end
+
+    insert_into_file(
+      helper.swagger_helper_path,
+      after: helper.swagger_helper_api_definition_line
+    ) do
+      helper.swagger_helper_api_definition
+    end
+  end
+
+  private
+
+  def helper
+    @helper ||= PowerApi::GeneratorHelpers.new(version_number: file_name)
+  end
+end

data/lib/power_api.rb

@@ -0,0 +1,35 @@
+require "active_model_serializers"
+require "api-pagination"
+require "kaminari"
+require "ransack"
+require "responders"
+require "rswag/api"
+require "rswag/ui"
+require "simple_token_authentication"
+require "versionist"
+
+require "power_api/engine"
+
+module PowerApi
+  extend self
+
+  # You can add, in this module, your own configuration options as in the example below...
+  #
+  # attr_writer :my_option
+  #
+  # def my_option
+  #   return "Default Value" unless @my_option
+  #   @my_option
+  # end
+  #
+  # Then, you can customize the default behaviour (typically in a Rails initializer) like this:
+  #
+  # PowerApi.setup do |config|
+  #   config.root_url = "Another value"
+  # end
+
+  def setup
+    yield self
+    require "power_api"
+  end
+end

data/lib/power_api/engine.rb

@@ -0,0 +1,28 @@
+module PowerApi
+  module GeneratorHelper; end
+
+  class Engine < ::Rails::Engine
+    isolate_namespace PowerApi
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_bot, dir: "spec/factories"
+    end
+
+    initializer "initialize" do
+      require_relative "./errors"
+      require_relative "./generator_helper/active_record_resource"
+      require_relative "./generator_helper/version_helper"
+      require_relative "./generator_helper/resource_helper"
+      require_relative "./generator_helper/swagger_helper"
+      require_relative "./generator_helper/ams_helper"
+      require_relative "./generator_helper/controller_helper"
+      require_relative "./generator_helper/routes_helper"
+      require_relative "./generator_helper/pagination_helper"
+      require_relative "./generator_helper/simple_token_auth_helper"
+      require_relative "./generator_helper/rubocop_helper"
+      require_relative "./generator_helper/template_builder_helper"
+      require_relative "./generator_helpers"
+    end
+  end
+end

data/lib/power_api/errors.rb

@@ -0,0 +1,4 @@
+module PowerApi
+  class GeneratorError < StandardError; end
+  class InvalidVersion < StandardError; end
+end

data/lib/power_api/generator_helper/active_record_resource.rb

@@ -0,0 +1,192 @@
+# rubocop:disable Metrics/ModuleLength
+module PowerApi::GeneratorHelper::ActiveRecordResource
+  extend ActiveSupport::Concern
+
+  included do
+    attr_reader :resource_attributes
+  end
+
+  def resource_name=(value)
+    @resource_name = value
+
+    if !resource_class
+      raise PowerApi::GeneratorError.new(
+        "Invalid resource name. Must be the snake_case representation of a ruby class"
+      )
+    end
+
+    if !resource_is_active_record_model?
+      raise PowerApi::GeneratorError.new("resource is not an active record model")
+    end
+  end
+
+  def resource_attributes=(collection)
+    attributes = format_attributes(collection)
+    raise PowerApi::GeneratorError.new("at least one attribute must be added") if attributes.none?
+
+    @resource_attributes = attributes
+  end
+
+  def id
+    "#{snake_case}_id"
+  end
+
+  def upcase
+    snake_case.upcase
+  end
+
+  def upcase_plural
+    plural.upcase
+  end
+
+  def camel
+    resource_name.camelize
+  end
+
+  def camel_plural
+    camel.pluralize
+  end
+
+  def plural
+    snake_case.pluralize
+  end
+
+  def snake_case
+    resource_name.underscore
+  end
+
+  def titleized
+    resource_name.titleize
+  end
+
+  def plural_titleized
+    plural.titleize
+  end
+
+  def path
+    "app/models/#{snake_case}.rb"
+  end
+
+  def class_definition_line
+    "class #{camel} < ApplicationRecord\n"
+  end
+
+  def attributes_names
+    extract_attrs_names(resource_attributes)
+  end
+
+  def required_attributes_names
+    extract_attrs_names(required_resource_attributes)
+  end
+
+  def permitted_attributes_names
+    extract_attrs_names(permitted_attributes)
+  end
+
+  def permitted_attributes
+    resource_attributes.reject do |attr|
+      [:created_at, :updated_at].include?(attr[:name])
+    end
+  end
+
+  def required_resource_attributes
+    permitted_attributes.select { |attr| attr[:required] }
+  end
+
+  def optional_resource_attributes
+    permitted_attributes.reject { |attr| attr[:required] }
+  end
+
+  def attributes_symbols_text_list
+    attrs_to_symobls_text_list(attributes_names)
+  end
+
+  def permitted_attributes_symbols_text_list
+    attrs_to_symobls_text_list(permitted_attributes_names)
+  end
+
+  private
+
+  def resource_name
+    @resource_name
+  end
+
+  def extract_attrs_names(attrs)
+    attrs.map { |attr| attr[:name] }
+  end
+
+  def attrs_to_symobls_text_list(attrs)
+    attrs.map { |a| ":#{a}" }.join(",\n") + "\n"
+  end
+
+  def format_attributes(attrs)
+    columns = resource_class.columns.inject([]) do |memo, col|
+      col_name = col.name.to_sym
+      next memo if col_name == :id
+
+      memo << {
+        name: col_name,
+        type: col.type,
+        swagger_type: get_swagger_type(col.type),
+        required: required_attribute?(col_name),
+        example: get_attribute_example(col.type, col_name)
+      }
+
+      memo
+    end
+
+    return columns if attrs.blank?
+
+    attrs = attrs.map(&:to_sym)
+    columns.select { |col| attrs.include?(col[:name]) }
+  end
+
+  def get_swagger_type(data_type)
+    case data_type
+    when :integer
+      :integer
+    when :float, :decimal
+      :float
+    when :boolean
+      :boolean
+    else
+      :string
+    end
+  end
+
+  def get_attribute_example(data_type, col_name)
+    case data_type
+    when :date
+      "'1984-06-04'"
+    when :datetime
+      "'1984-06-04 09:00'"
+    when :integer
+      666
+    when :float, :decimal
+      6.66
+    when :boolean
+      true
+    else
+      "'Some #{col_name}'"
+    end
+  end
+
+  def required_attribute?(col_name)
+    validator_names = resource_class.validators_on(col_name).map do |validator|
+      validator.class.name
+    end
+
+    validator_names.include?("ActiveRecord::Validations::PresenceValidator")
+  end
+
+  def resource_class
+    resource_name.classify.constantize
+  rescue NameError
+    false
+  end
+
+  def resource_is_active_record_model?
+    !!ActiveRecord::Base.descendants.find { |model_class| model_class == resource_class }
+  end
+end
+# rubocop:enable Metrics/ModuleLength

data/lib/power_api/generator_helper/ams_helper.rb

@@ -0,0 +1,43 @@
+module PowerApi::GeneratorHelper::AmsHelper
+  extend ActiveSupport::Concern
+
+  included do
+    include PowerApi::GeneratorHelper::VersionHelper
+    include PowerApi::GeneratorHelper::ResourceHelper
+  end
+
+  def ams_initializer_path
+    "config/initializers/active_model_serializers.rb"
+  end
+
+  def ams_serializer_path
+    "app/serializers/api/v#{version_number}/#{resource.snake_case}_serializer.rb"
+  end
+
+  def ams_serializers_path
+    "app/serializers/api/v#{version_number}/.gitkeep"
+  end
+
+  def ams_initializer_tpl
+    <<~INITIALIZER
+      class ActiveModelSerializers::Adapter::JsonApi
+        def self.default_key_transform
+          :unaltered
+        end
+      end
+
+      ActiveModelSerializers.config.adapter = :json_api
+    INITIALIZER
+  end
+
+  def ams_serializer_tpl
+    <<~SERIALIZER
+      class Api::V#{version_number}::#{resource.camel}Serializer < ActiveModel::Serializer
+        type :#{resource.snake_case}
+
+        attributes(
+          #{resource.attributes_symbols_text_list})
+      end
+    SERIALIZER
+  end
+end

data/lib/power_api/generator_helper/controller_helper.rb

@@ -0,0 +1,184 @@
+# rubocop:disable Metrics/ModuleLength
+module PowerApi::GeneratorHelper::ControllerHelper
+  extend ActiveSupport::Concern
+
+  included do
+    include PowerApi::GeneratorHelper::VersionHelper
+    include PowerApi::GeneratorHelper::ResourceHelper
+    include PowerApi::GeneratorHelper::PaginationHelper
+    include PowerApi::GeneratorHelper::SimpleTokenAuthHelper
+    include PowerApi::GeneratorHelper::TemplateBuilderHelper
+
+    attr_accessor :allow_filters
+  end
+
+  def api_base_controller_path
+    "app/controllers/api/base_controller.rb"
+  end
+
+  def base_controller_path
+    "app/controllers/api/v#{version_number}/base_controller.rb"
+  end
+
+  def resource_controller_path
+    "app/controllers/api/v#{version_number}/#{resource.plural}_controller.rb"
+  end
+
+  def api_base_controller_tpl
+    <<~CONTROLLER
+      class Api::BaseController < PowerApi::BaseController
+      end
+    CONTROLLER
+  end
+
+  def base_controller_tpl
+    <<~CONTROLLER
+      class Api::V#{version_number}::BaseController < Api::BaseController
+        before_action do
+          self.namespace_for_serializer = ::Api::V#{version_number}
+        end
+      end
+    CONTROLLER
+  end
+
+  def resource_controller_tpl
+    tpl_class(
+      ctrl_tpl_class_definition_line,
+      ctrl_tpl_acts_as_token_authentication_handler,
+      ctrl_tpl_index,
+      ctrl_tpl_show,
+      ctrl_tpl_create,
+      ctrl_tpl_update,
+      ctrl_tpl_destroy,
+      "private",
+      ctrl_tpl_resource,
+      ctrl_tpl_resources_from_authenticated_resource,
+      ctrl_tpl_find_parent_resource,
+      ctrl_tpl_permitted_params
+    )
+  end
+
+  private
+
+  def ctrl_tpl_class_definition_line
+    "Api::V#{version_number}::#{resource.camel_plural}Controller < \
+Api::V#{version_number}::BaseController"
+  end
+
+  def ctrl_tpl_acts_as_token_authentication_handler
+    return unless authenticated_resource?
+
+    "acts_as_token_authentication_handler_for #{authenticated_resource.camel}, \
+fallback: :exception\n"
+  end
+
+  def ctrl_tpl_index
+    concat_tpl_method("index", "respond_with #{ctrl_tpl_index_resources}")
+  end
+
+  def ctrl_tpl_show
+    concat_tpl_method("show", "respond_with #{resource.snake_case}")
+  end
+
+  def ctrl_tpl_create
+    concat_tpl_method("create", "respond_with #{ctrl_tpl_create_resource}")
+  end
+
+  def ctrl_tpl_update
+    concat_tpl_method(
+      "update",
+      "respond_with #{resource.snake_case}.update!(#{resource.snake_case}_params)"
+    )
+  end
+
+  def ctrl_tpl_destroy
+    concat_tpl_method("destroy", "respond_with #{resource.snake_case}.destroy!")
+  end
+
+  def ctrl_tpl_resource
+    concat_tpl_method(resource.snake_case, "@#{resource.snake_case} ||= #{ctrl_tpl_find_resource}")
+  end
+
+  def ctrl_tpl_permitted_params
+    concat_tpl_method(
+      "#{resource.snake_case}_params",
+      "params.require(:#{resource.snake_case}).permit(",
+      "#{resource.permitted_attributes_symbols_text_list})"
+    )
+  end
+
+  def ctrl_tpl_find_resource
+    find_statement = "find_by!(id: params[:id])"
+    resource_source = if owned_by_authenticated_resource?
+                        if parent_resource?
+                          "#{resource.camel}.where(#{parent_resource.snake_case}: \
+#{current_authenticated_resource}.#{parent_resource.plural})"
+                        else
+                          resource.plural
+                        end
+                      else
+                        resource.camel
+                      end
+
+    "#{resource_source}.#{find_statement}"
+  end
+
+  def ctrl_tpl_index_resources
+    return ctrl_tpl_index_collection unless use_paginator
+
+    "paginate(#{ctrl_tpl_index_collection})"
+  end
+
+  def ctrl_tpl_index_collection
+    collection = owned_resource? ? resource.plural : "#{resource.camel}.all"
+    return collection unless allow_filters
+
+    "filtered_collection(#{collection})"
+  end
+
+  def ctrl_tpl_create_resource
+    create_statement = "create!(#{resource.snake_case}_params)"
+
+    if owned_resource?
+      "#{resource.plural}.#{create_statement}"
+    else
+      "#{resource.camel}.#{create_statement}"
+    end
+  end
+
+  def ctrl_tpl_resources_from_authenticated_resource
+    return unless owned_resource?
+
+    resource_source = if owned_by_authenticated_resource? && !parent_resource?
+                        current_authenticated_resource
+                      else
+                        parent_resource.snake_case
+                      end
+
+    concat_tpl_method(
+      resource.plural,
+      "@#{resource.plural} ||= #{resource_source}.#{resource.plural}"
+    )
+  end
+
+  def ctrl_tpl_find_parent_resource
+    return unless parent_resource?
+
+    resource_source = if owned_by_authenticated_resource?
+                        "#{current_authenticated_resource}.#{parent_resource.plural}"
+                      else
+                        parent_resource.camel
+                      end
+
+    concat_tpl_method(
+      parent_resource.snake_case,
+      "@#{parent_resource.snake_case} ||= #{resource_source}.\
+find_by!(id: params[:#{parent_resource.id}])"
+    )
+  end
+
+  def owned_resource?
+    owned_by_authenticated_resource? || parent_resource?
+  end
+end
+# rubocop:enable Metrics/ModuleLength