power_api 1.0.0 → 2.0.0

data/app/helpers/power_api/application_helper.rb

@@ -1,4 +1,61 @@
 module PowerApi
   module ApplicationHelper
+    VALID_SERIALIZER_OUTPUT_FORMATS = %i{json hash}
+
+    def serialize_resource(resource, options = {})
+      load_default_serializer_options(options)
+      serializable = ActiveModelSerializers::SerializableResource.new(resource, options)
+      serialized_data = serializable.serializable_hash
+      render_serialized_data(serialized_data, options)
+    rescue NoMethodError => e
+      if e.message.include?("undefined method `serializable_hash'")
+        raise ::PowerApi::InvalidSerializableResource.new(
+          "Invalid #{resource.class} resource given. Must be ActiveRecord instance or collection"
+        )
+      else
+        raise e
+      end
+    end
+
+    private
+
+    def render_serialized_data(serialized_data, options)
+      output_format = options.delete(:output_format)
+      serialized_data = serialized_data[:root] if options[:root] == :root
+      return serialized_data if output_format == :hash
+
+      serialized_data.to_json
+    end
+
+    def load_default_serializer_options(options)
+      options[:namespace] ||= "Api::Internal"
+      options[:key_transform] ||= :camel_lower
+      options[:include_root] ||= false
+      options[:output_format] = format_serializer_output_format!(options[:output_format])
+      options[:key_transform] = :unaltered if options[:output_format] == :hash
+
+      load_root_option(options)
+      options
+    end
+
+    def load_root_option(options)
+      return if !!options.delete(:include_root)
+
+      options[:root] = :root
+    end
+
+    def format_serializer_output_format!(output_format)
+      return :json if output_format.blank?
+
+      output_format = output_format.to_s.to_sym
+
+      if !VALID_SERIALIZER_OUTPUT_FORMATS.include?(output_format)
+        raise ::PowerApi::InvalidSerializerOutputFormat.new(
+          "Only #{VALID_SERIALIZER_OUTPUT_FORMATS} values are allowed."
+        )
+      end
+
+      output_format
+    end
   end
 end

data/bin/clean_test_app

@@ -0,0 +1,2 @@
+git checkout spec/dummy/*.rb
+git status --porcelain | cut -c 3-10000000 | grep 'dummy' | xargs rm -rf

data/lib/generators/power_api/controller/controller_generator.rb

@@ -23,9 +23,10 @@ class PowerApi::ControllerGenerator < Rails::Generators::NamedBase
   class_option(
     :version_number,
     type: 'numeric',
-    default: 1,
+    default: nil,
     aliases: '-v',
-    desc: 'the API version number you want to add this controller'
+    desc: 'the API version number you want to add this controller. '\
+'Omitting this attribute will create a controller for the internal api.'
   )
 
   class_option(
@@ -95,29 +96,40 @@ class PowerApi::ControllerGenerator < Rails::Generators::NamedBase
   end
 
   def configure_swagger
-    create_file(
-      helper.swagger_resource_schema_path,
-      helper.swagger_schema_tpl
-    )
+    return unless helper.versioned_api?
+
+    create_swagger_schema
+    add_swagger_schema_to_definition
+    create_swagger_resource_spec
+  end
 
+  def add_rspec_tests
+    return if helper.versioned_api?
+
+    create_file(helper.resource_spec_path, helper.resource_spec_tpl)
+    helper.format_ruby_file(helper.resource_spec_path)
+  end
+
+  private
+
+  def create_swagger_schema
+    create_file(helper.swagger_resource_schema_path, helper.swagger_schema_tpl)
     helper.format_ruby_file(helper.swagger_resource_schema_path)
+  end
 
+  def add_swagger_schema_to_definition
     insert_into_file(
       helper.swagger_version_definition_path,
       helper.swagger_definition_entry,
       after: helper.swagger_definition_line_to_inject_schema
     )
+  end
 
-    create_file(
-      helper.swagger_resource_spec_path,
-      helper.swagger_resource_spec_tpl
-    )
-
+  def create_swagger_resource_spec
+    create_file(helper.swagger_resource_spec_path, helper.swagger_resource_spec_tpl)
     helper.format_ruby_file(helper.swagger_resource_spec_path)
   end
 
-  private
-
   def add_nested_route
     line_to_replace = helper.parent_resource_routes_line_regex
     nested_resource_line = helper.resource_route_tpl(
@@ -136,13 +148,13 @@ class PowerApi::ControllerGenerator < Rails::Generators::NamedBase
 
   def add_normal_route(actions:)
     actions_for_only_option = actions.sort == self.class.valid_actions.sort ? [] : actions
-    add_route(helper.api_version_routes_line_regex) do |match|
+    add_route(helper.api_current_route_namespace_line_regex) do |match|
       "#{match}\n#{helper.resource_route_tpl(actions: actions_for_only_option)}"
     end
   end
 
   def add_nested_parent_route
-    add_route(helper.api_version_routes_line_regex) do |match|
+    add_route(helper.api_current_route_namespace_line_regex) do |match|
       "#{match}\n#{helper.resource_route_tpl(is_parent: true)}"
     end
   end

data/lib/generators/power_api/exposed_api_config/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Configure exposed API in host app.
+
+Example:
+    rails generate power_api:exposed_api_config

data/lib/generators/power_api/exposed_api_config/exposed_api_config_generator.rb

@@ -0,0 +1,58 @@
+class PowerApi::ExposedApiConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  class_option(
+    :authenticated_resources,
+    type: 'array',
+    default: [],
+    desc: 'define which model or models will be token authenticatable'
+  )
+
+  def add_base_controller
+    create_file(
+      helper.exposed_base_controller_path,
+      helper.exposed_base_controller_tpl
+    )
+  end
+
+  def install_rswag
+    generate "rswag:ui:install"
+    generate "rswag:api:install"
+    generate "rswag:specs:install"
+
+    create_file(helper.rswag_ui_initializer_path, helper.rswag_ui_initializer_tpl, force: true)
+    create_file(helper.swagger_helper_path, helper.swagger_helper_tpl, force: true)
+    create_file(helper.spec_swagger_path)
+    create_file(helper.spec_integration_path)
+  end
+
+  def install_first_version
+    generate "power_api:version 1"
+  end
+
+  def install_simple_token_auth
+    create_file(
+      helper.simple_token_auth_initializer_path,
+      helper.simple_token_auth_initializer_tpl,
+      force: true
+    )
+
+    helper.authenticated_resources.each do |resource|
+      generate resource.authenticated_resource_migration
+
+      insert_into_file(
+        resource.path,
+        helper.simple_token_auth_method,
+        after: resource.class_definition_line
+      )
+    end
+  end
+
+  private
+
+  def helper
+    @helper ||= PowerApi::GeneratorHelpers.new(
+      authenticated_resources: options[:authenticated_resources]
+    )
+  end
+end

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

@@ -1,36 +1,14 @@
 class PowerApi::InstallGenerator < Rails::Generators::Base
   source_root File.expand_path('templates', __dir__)
 
-  class_option(
-    :authenticated_resources,
-    type: 'array',
-    default: [],
-    desc: 'define which model or models will be token authenticatable'
-  )
-
   def create_api_base_controller
-    create_file(helper.api_base_controller_path, helper.api_base_controller_tpl)
+    create_file(helper.api_main_base_controller_path, helper.api_main_base_controller_tpl)
   end
 
   def create_ams_initializer
     create_file(helper.ams_initializer_path, helper.ams_initializer_tpl)
   end
 
-  def install_rswag
-    generate "rswag:ui:install"
-    generate "rswag:api:install"
-    generate "rswag:specs:install"
-
-    create_file(helper.rswag_ui_initializer_path, helper.rswag_ui_initializer_tpl, force: true)
-    create_file(helper.swagger_helper_path, helper.swagger_helper_tpl, force: true)
-    create_file(helper.spec_swagger_path)
-    create_file(helper.spec_integration_path)
-  end
-
-  def install_first_version
-    generate "power_api:version 1"
-  end
-
   def install_api_pagination
     create_file(
       helper.api_pagination_initializer_path,
@@ -39,29 +17,9 @@ class PowerApi::InstallGenerator < Rails::Generators::Base
     )
   end
 
-  def install_simple_token_auth
-    create_file(
-      helper.simple_token_auth_initializer_path,
-      helper.simple_token_auth_initializer_tpl,
-      force: true
-    )
-
-    helper.authenticated_resources.each do |resource|
-      generate resource.authenticated_resource_migration
-
-      insert_into_file(
-        resource.path,
-        helper.simple_token_auth_method,
-        after: resource.class_definition_line
-      )
-    end
-  end
-
   private
 
   def helper
-    @helper ||= PowerApi::GeneratorHelpers.new(
-      authenticated_resources: options[:authenticated_resources]
-    )
+    @helper ||= PowerApi::GeneratorHelpers.new
   end
 end

data/lib/generators/power_api/internal_api_config/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Configure internal API in host app.
+
+Example:
+    rails generate power_api:internal_api_config

data/lib/generators/power_api/internal_api_config/internal_api_config_generator.rb

@@ -0,0 +1,31 @@
+class PowerApi::InternalApiConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def add_base_controller
+    create_file(
+      helper.internal_base_controller_path,
+      helper.internal_base_controller_tpl
+    )
+  end
+
+  def modify_routes
+    insert_into_file(
+      helper.routes_path,
+      after: helper.routes_first_line
+    ) do
+      helper.internal_route_tpl
+    end
+
+    helper.format_ruby_file(helper.routes_path)
+  end
+
+  def add_serializers_directory
+    create_file(helper.ams_serializers_path)
+  end
+
+  private
+
+  def helper
+    @helper ||= PowerApi::GeneratorHelpers.new
+  end
+end

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

@@ -14,8 +14,8 @@ class PowerApi::VersionGenerator < Rails::Generators::NamedBase
 
   def add_base_controller
     create_file(
-      helper.base_controller_path,
-      helper.base_controller_tpl
+      helper.version_base_controller_path,
+      helper.version_base_controller_tpl
     )
   end
 

data/lib/power_api/engine.rb

@@ -13,10 +13,11 @@ module PowerApi
       require_relative "./errors"
       require_relative "./generator_helper/controller_actions_helper"
       require_relative "./generator_helper/active_record_resource"
-      require_relative "./generator_helper/version_helper"
+      require_relative "./generator_helper/api_helper"
       require_relative "./generator_helper/resource_helper"
       require_relative "./generator_helper/swagger_helper"
       require_relative "./generator_helper/ams_helper"
+      require_relative "./generator_helper/rspec_controller_helper"
       require_relative "./generator_helper/controller_helper"
       require_relative "./generator_helper/routes_helper"
       require_relative "./generator_helper/pagination_helper"
@@ -25,5 +26,11 @@ module PowerApi
       require_relative "./generator_helper/template_builder_helper"
       require_relative "./generator_helpers"
     end
+
+    initializer 'local_helper.action_controller' do
+      ActiveSupport.on_load :action_controller do
+        ApplicationController.helper PowerApi::ApplicationHelper
+      end
+    end
   end
 end

data/lib/power_api/errors.rb

@@ -1,4 +1,6 @@
 module PowerApi
   class GeneratorError < StandardError; end
   class InvalidVersion < StandardError; end
+  class InvalidSerializerOutputFormat < StandardError; end
+  class InvalidSerializableResource < StandardError; end
 end

data/lib/power_api/generator_helper/active_record_resource.rb

@@ -22,7 +22,10 @@ module PowerApi::GeneratorHelper::ActiveRecordResource
 
   def resource_attributes=(collection)
     attributes = format_attributes(collection)
-    raise PowerApi::GeneratorError.new("at least one attribute must be added") if attributes.none?
+
+    if attributes.count == 1 && attributes.first[:name] == :id
+      raise PowerApi::GeneratorError.new("at least one attribute must be added")
+    end
 
     @resource_attributes = attributes
   end
@@ -85,12 +88,14 @@ module PowerApi::GeneratorHelper::ActiveRecordResource
 
   def permitted_attributes
     resource_attributes.reject do |attr|
-      [:created_at, :updated_at].include?(attr[:name])
+      [:created_at, :updated_at, :id].include?(attr[:name])
     end
   end
 
-  def required_resource_attributes
-    permitted_attributes.select { |attr| attr[:required] }
+  def required_resource_attributes(include_id: false)
+    resource_attributes.select do |attr|
+      attr[:required] || (include_id && attr[:name] == :id)
+    end
   end
 
   def optional_resource_attributes
@@ -122,7 +127,6 @@ module PowerApi::GeneratorHelper::ActiveRecordResource
   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,
@@ -137,7 +141,7 @@ module PowerApi::GeneratorHelper::ActiveRecordResource
 
     return columns if attrs.blank?
 
-    attrs = attrs.map(&:to_sym)
+    attrs = (attrs.map(&:to_sym) + [:id]).uniq
     columns.select { |col| attrs.include?(col[:name]) }
   end
 

data/lib/power_api/generator_helper/ams_helper.rb

@@ -2,7 +2,7 @@ module PowerApi::GeneratorHelper::AmsHelper
   extend ActiveSupport::Concern
 
   included do
-    include PowerApi::GeneratorHelper::VersionHelper
+    include PowerApi::GeneratorHelper::ApiHelper
     include PowerApi::GeneratorHelper::ResourceHelper
   end
 
@@ -11,28 +11,22 @@ module PowerApi::GeneratorHelper::AmsHelper
   end
 
   def ams_serializer_path
-    "app/serializers/api/v#{version_number}/#{resource.snake_case}_serializer.rb"
+    "app/serializers/#{api_file_path}/#{resource.snake_case}_serializer.rb"
   end
 
   def ams_serializers_path
-    "app/serializers/api/v#{version_number}/.gitkeep"
+    "app/serializers/#{api_file_path}/.gitkeep"
   end
 
   def ams_initializer_tpl
     <<~INITIALIZER
-      class ActiveModelSerializers::Adapter::JsonApi
-        def self.default_key_transform
-          :unaltered
-        end
-      end
-
-      ActiveModelSerializers.config.adapter = :json_api
+      ActiveModelSerializers.config.adapter = :json
     INITIALIZER
   end
 
   def ams_serializer_tpl
     <<~SERIALIZER
-      class Api::V#{version_number}::#{resource.camel}Serializer < ActiveModel::Serializer
+      class #{api_class}::#{resource.camel}Serializer < ActiveModel::Serializer
         type :#{resource.snake_case}
 
         attributes(

data/lib/power_api/generator_helper/api_helper.rb

@@ -0,0 +1,61 @@
+module PowerApi::GeneratorHelper::ApiHelper
+  extend ActiveSupport::Concern
+
+  included do
+    attr_reader :version_number
+  end
+
+  def version_number=(value)
+    if value.blank?
+      @version_number = nil
+      return
+    end
+
+    @version_number = value.to_s.to_i
+    raise PowerApi::GeneratorError.new("invalid version number") if version_number < 1
+  end
+
+  def first_version?
+    version_number.to_i == 1
+  end
+
+  def versioned_api?
+    !!version_number
+  end
+
+  def api_file_path
+    return version_file_path if versioned_api?
+
+    internal_file_path
+  end
+
+  def version_file_path
+    "#{exposed_file_path}/v#{version_number}"
+  end
+
+  def internal_file_path
+    "api/internal"
+  end
+
+  def exposed_file_path
+    "api/exposed"
+  end
+
+  def api_class
+    return version_class if versioned_api?
+
+    internal_class
+  end
+
+  def version_class
+    "#{exposed_class}::V#{version_number}"
+  end
+
+  def internal_class
+    "Api::Internal"
+  end
+
+  def exposed_class
+    "Api::Exposed"
+  end
+end

data/lib/power_api/generator_helper/controller_helper.rb

@@ -3,7 +3,7 @@ module PowerApi::GeneratorHelper::ControllerHelper
   extend ActiveSupport::Concern
 
   included do
-    include PowerApi::GeneratorHelper::VersionHelper
+    include PowerApi::GeneratorHelper::ApiHelper
     include PowerApi::GeneratorHelper::ResourceHelper
     include PowerApi::GeneratorHelper::PaginationHelper
     include PowerApi::GeneratorHelper::SimpleTokenAuthHelper
@@ -13,30 +13,56 @@ module PowerApi::GeneratorHelper::ControllerHelper
     attr_accessor :allow_filters
   end
 
-  def api_base_controller_path
+  def api_main_base_controller_path
     "app/controllers/api/base_controller.rb"
   end
 
-  def base_controller_path
-    "app/controllers/api/v#{version_number}/base_controller.rb"
+  def exposed_base_controller_path
+    "app/controllers/#{exposed_file_path}/base_controller.rb"
+  end
+
+  def internal_base_controller_path
+    "app/controllers/#{internal_file_path}/base_controller.rb"
+  end
+
+  def version_base_controller_path
+    "app/controllers/#{version_file_path}/base_controller.rb"
   end
 
   def resource_controller_path
-    "app/controllers/api/v#{version_number}/#{resource.plural}_controller.rb"
+    "app/controllers/#{api_file_path}/#{resource.plural}_controller.rb"
   end
 
-  def api_base_controller_tpl
+  def api_main_base_controller_tpl
     <<~CONTROLLER
       class Api::BaseController < PowerApi::BaseController
       end
     CONTROLLER
   end
 
-  def base_controller_tpl
+  def exposed_base_controller_tpl
+    <<~CONTROLLER
+      class #{exposed_class}::BaseController < Api::BaseController
+        skip_before_action :verify_authenticity_token
+      end
+    CONTROLLER
+  end
+
+  def internal_base_controller_tpl
     <<~CONTROLLER
-      class Api::V#{version_number}::BaseController < Api::BaseController
+      class #{internal_class}::BaseController < Api::BaseController
         before_action do
-          self.namespace_for_serializer = ::Api::V#{version_number}
+          self.namespace_for_serializer = ::#{internal_class}
+        end
+      end
+    CONTROLLER
+  end
+
+  def version_base_controller_tpl
+    <<~CONTROLLER
+      class #{version_class}::BaseController < #{exposed_class}::BaseController
+        before_action do
+          self.namespace_for_serializer = ::#{version_class}
         end
       end
     CONTROLLER
@@ -45,7 +71,7 @@ module PowerApi::GeneratorHelper::ControllerHelper
   def resource_controller_tpl
     tpl_class(
       ctrl_tpl_class_definition_line,
-      ctrl_tpl_acts_as_token_authentication_handler,
+      ctrl_tpl_authentication_code,
       ctrl_tpl_index,
       ctrl_tpl_show,
       ctrl_tpl_create,
@@ -62,15 +88,18 @@ module PowerApi::GeneratorHelper::ControllerHelper
   private
 
   def ctrl_tpl_class_definition_line
-    "Api::V#{version_number}::#{resource.camel_plural}Controller < \
-Api::V#{version_number}::BaseController"
+    "#{api_class}::#{resource.camel_plural}Controller < #{api_class}::BaseController"
   end
 
-  def ctrl_tpl_acts_as_token_authentication_handler
+  def ctrl_tpl_authentication_code
     return unless authenticated_resource?
 
-    "acts_as_token_authentication_handler_for #{authenticated_resource.camel}, \
+    if versioned_api?
+      return "acts_as_token_authentication_handler_for #{authenticated_resource.camel}, \
 fallback: :exception\n"
+    end
+
+    "before_action :authenticate_#{authenticated_resource.snake_case}!\n"
   end
 
   def ctrl_tpl_index
@@ -96,7 +125,8 @@ fallback: :exception\n"
 
     concat_tpl_method(
       "update",
-      "respond_with #{resource.snake_case}.update!(#{resource.snake_case}_params)"
+      "#{resource.snake_case}.update!(#{resource.snake_case}_params)",
+      "respond_with #{resource.snake_case}"
     )
   end