power_api 1.0.0 → 2.0.0

data/lib/power_api/generator_helper/routes_helper.rb

@@ -1,9 +1,9 @@
-# rubocop:disable Layout/AlignArguments
+# rubocop:disable Layout/AlignParameters
 module PowerApi::GeneratorHelper::RoutesHelper
   extend ActiveSupport::Concern
 
   included do
-    include PowerApi::GeneratorHelper::VersionHelper
+    include PowerApi::GeneratorHelper::ApiHelper
     include PowerApi::GeneratorHelper::ResourceHelper
     include PowerApi::GeneratorHelper::TemplateBuilderHelper
   end
@@ -13,13 +13,19 @@ module PowerApi::GeneratorHelper::RoutesHelper
   end
 
   def routes_line_to_inject_new_version
-    return "routes.draw do\n" if first_version?
+    return routes_first_line if first_version?
 
     "'/api' do\n"
   end
 
-  def api_version_routes_line_regex
-    /Api::V#{version_number}[^\n]*/
+  def routes_first_line
+    "routes.draw do\n"
+  end
+
+  def api_current_route_namespace_line_regex
+    return /#{version_class}[^\n]*/ if versioned_api?
+
+    /namespace :internal[^\n]*/
   end
 
   def parent_resource_routes_line_regex
@@ -32,6 +38,15 @@ module PowerApi::GeneratorHelper::RoutesHelper
     new_version_route_tpl
   end
 
+  def internal_route_tpl
+    concat_tpl_statements(
+      "namespace :api, defaults: { format: :json } do",
+        "namespace :internal do",
+        "end",
+      "end\n"
+    )
+  end
+
   def resource_route_tpl(actions: [], is_parent: false)
     res = (is_parent ? parent_resource : resource).plural
     line = "resources :#{res}"
@@ -83,9 +98,9 @@ module PowerApi::GeneratorHelper::RoutesHelper
   end
 
   def api_version_params
-    "module: 'Api::V#{version_number}', \
+    "module: '#{version_class}', \
 path: { value: 'v#{version_number}' }, \
 defaults: { format: 'json' }"
   end
 end
-# rubocop:enable Layout/AlignArguments
+# rubocop:enable Layout/AlignParameters

data/lib/power_api/generator_helper/rspec_controller_helper.rb

@@ -0,0 +1,306 @@
+# rubocop:disable Metrics/ModuleLength
+# rubocop:disable Metrics/MethodLength
+# rubocop:disable Layout/AlignParameters
+module PowerApi::GeneratorHelper::RspecControllerHelper
+  extend ActiveSupport::Concern
+
+  included do
+    include PowerApi::GeneratorHelper::ApiHelper
+    include PowerApi::GeneratorHelper::ResourceHelper
+    include PowerApi::GeneratorHelper::TemplateBuilderHelper
+  end
+
+  def resource_spec_path
+    "spec/requests/#{api_file_path}/#{resource.plural}_spec.rb"
+  end
+
+  def resource_spec_tpl
+    concat_tpl_statements(
+      "require 'rails_helper'\n",
+      concat_tpl_statements(
+        spec_initial_describe_line,
+        spec_authenticated_resource_tpl,
+        spec_let_parent_resource_tpl,
+        spec_index_tpl,
+        spec_create_tpl,
+        spec_show_tpl,
+        spec_update_tpl,
+        spec_destroy_tpl,
+        "end\n"
+      )
+    )
+  end
+
+  private
+
+  def spec_initial_describe_line
+    "RSpec.describe '#{api_class}::#{resource.camel_plural}Controllers', type: :request do"
+  end
+
+  def spec_authenticated_resource_tpl
+    return unless authenticated_resource?
+
+    res_name = authenticated_resource.snake_case
+    "let(:#{res_name}) { create(:#{res_name}) }"
+  end
+
+  def spec_let_parent_resource_tpl
+    return unless parent_resource?
+
+    concat_tpl_statements(
+      "let(:#{parent_resource.snake_case}) { create(:#{parent_resource.snake_case}) }",
+      "let(:#{parent_resource.id}) { #{parent_resource.snake_case}.id }\n"
+    )
+  end
+
+  def spec_index_tpl
+    return unless index?
+
+    concat_tpl_statements(
+      "describe 'GET /index' do",
+        "let!(:#{resource.plural}) { #{spec_index_creation_list_tpl} }",
+        "let(:collection) { JSON.parse(response.body)['#{resource.plural}'] }",
+        "let(:params) { {} }\n",
+        spec_perform_tpl,
+        with_authorized_resource_context,
+        perform_block_tpl,
+        "it { expect(collection.count).to eq(5) }",
+        "it { expect(response.status).to eq(200) }",
+        if authenticated_resource?
+          "end\n"
+        end,
+        unauthorized_spec_tpl,
+        "end\n"
+    )
+  end
+
+  def spec_create_tpl
+    return unless create?
+
+    concat_tpl_statements(
+      "describe 'POST /create' do",
+      "let(:params) do",
+        "{",
+          "#{resource.snake_case}: {#{resource_parameters}",
+          "}",
+        "}",
+      "end\n",
+      let_resource_attrs,
+      spec_perform_tpl(http_verb: 'post'),
+      with_authorized_resource_context,
+      perform_block_tpl,
+      "it { expect(attributes).to include(params[:#{resource.snake_case}]) }",
+      "it { expect(response.status).to eq(201) }",
+      spec_invalid_attrs_test_tpl,
+      if authenticated_resource?
+        "end\n"
+      end,
+      unauthorized_spec_tpl,
+      "end\n"
+    )
+  end
+
+  def spec_show_tpl
+    return unless show?
+
+    concat_tpl_statements(
+      "describe 'GET /show' do",
+      spec_let_existent_resource_tpl,
+      "let(:#{resource.snake_case}_id) { #{resource.snake_case}.id.to_s }\n",
+      let_resource_attrs,
+      spec_perform_tpl(http_verb: 'get', params: false, single_resource: true),
+      with_authorized_resource_context,
+      perform_block_tpl,
+      "it { expect(response.status).to eq(200) }",
+      "context 'with resource not found' do",
+      "let(:#{resource.snake_case}_id) { '666' }",
+      "it { expect(response.status).to eq(404) }",
+      "end",
+      if authenticated_resource?
+        "end\n"
+      end,
+      unauthorized_spec_tpl,
+      "end\n"
+    )
+  end
+
+  def spec_update_tpl
+    return unless update?
+
+    concat_tpl_statements(
+      "describe 'PUT /update' do",
+      spec_let_existent_resource_tpl,
+      "let(:#{resource.snake_case}_id) { #{resource.snake_case}.id.to_s }\n",
+      "let(:params) do",
+        "{",
+          "#{resource.snake_case}: {#{resource_parameters}",
+          "}",
+        "}",
+      "end\n",
+      let_resource_attrs,
+      spec_perform_tpl(http_verb: 'put', params: true, single_resource: true),
+      with_authorized_resource_context,
+      perform_block_tpl,
+      "it { expect(attributes).to include(params[:#{resource.snake_case}]) }",
+      "it { expect(response.status).to eq(200) }",
+      spec_invalid_attrs_test_tpl,
+      "context 'with resource not found' do",
+      "let(:#{resource.snake_case}_id) { '666' }",
+      "it { expect(response.status).to eq(404) }",
+      "end",
+      if authenticated_resource?
+        "end\n"
+      end,
+      unauthorized_spec_tpl,
+      "end\n"
+    )
+  end
+
+  def spec_destroy_tpl
+    return unless destroy?
+
+    concat_tpl_statements(
+      "describe 'DELETE /destroy' do",
+      spec_let_existent_resource_tpl,
+      "let(:#{resource.snake_case}_id) { #{resource.snake_case}.id.to_s }\n",
+      spec_perform_tpl(http_verb: 'get', params: false, single_resource: true),
+      with_authorized_resource_context,
+      perform_block_tpl,
+      "it { expect(response.status).to eq(200) }",
+      "context 'with resource not found' do",
+      "let(:#{resource.snake_case}_id) { '666' }",
+      "it { expect(response.status).to eq(404) }",
+      "end",
+      if authenticated_resource?
+        "end\n"
+      end,
+      unauthorized_spec_tpl,
+      "end\n"
+    )
+  end
+
+  def spec_let_existent_resource_tpl
+    statement = ["let(:#{resource.snake_case}) { create(:#{resource.snake_case}"]
+    load_owner_resource_factory_option(statement)
+    statement.join(', ') + ') }'
+  end
+
+  def spec_invalid_attrs_test_tpl
+    return if resource.required_resource_attributes.blank?
+
+    concat_tpl_statements(
+      "context 'with invalid attributes' do",
+        "let(:params) do",
+          "{",
+            "#{resource.snake_case}: {#{invalid_resource_params}}",
+          "}",
+        "end\n",
+        "it { expect(response.status).to eq(400) }",
+      "end\n"
+    )
+  end
+
+  def with_authorized_resource_context
+    if authenticated_resource?
+      "context 'with authorized #{authenticated_resource.snake_case}' do"
+    end
+  end
+
+  def let_resource_attrs
+    concat_tpl_statements(
+      "let(:attributes) do",
+        "JSON.parse(response.body)['#{resource.snake_case}'].symbolize_keys",
+      "end"
+    )
+  end
+
+  def perform_block_tpl(auth: true)
+    concat_tpl_statements(
+      "before do",
+        if auth && authenticated_resource?
+          "sign_in(#{authenticated_resource.snake_case})"
+        end,
+        "perform",
+      "end\n"
+    )
+  end
+
+  def spec_perform_tpl(http_verb: 'get', params: true, single_resource: false)
+    body = "#{http_verb} '/#{spec_collection_path(single_resource)}"
+    body += "/' + #{resource.snake_case}_id" if single_resource
+    body += "'" unless single_resource
+    body += ", params: params" if params
+
+    concat_tpl_statements(
+      "def perform",
+      body,
+      "end\n"
+    )
+  end
+
+  def spec_collection_path(single_resource)
+    path = ["api"]
+    path << (versioned_api? ? "v#{version_number}" : "internal")
+
+    if parent_resource? && !single_resource
+      path << parent_resource.plural
+      path << "' + #{parent_resource.snake_case}.id.to_s + '"
+    end
+
+    path << resource.plural
+    path.join("/")
+  end
+
+  def spec_index_creation_list_tpl
+    statement = ["create_list(:#{resource.snake_case}, 5"]
+    load_owner_resource_factory_option(statement)
+    statement.join(', ') + ')'
+  end
+
+  def load_owner_resource_factory_option(statement)
+    if parent_resource?
+      statement << "#{parent_resource.snake_case}: #{parent_resource.snake_case}"
+    end
+
+    if owned_by_authenticated_resource?
+      statement << "#{authenticated_resource.snake_case}: #{authenticated_resource.snake_case}"
+    end
+  end
+
+  def unauthorized_spec_tpl
+    return unless authenticated_resource?
+
+    authenticated_resource_name = authenticated_resource.snake_case
+    concat_tpl_statements(
+      "context 'with unauthenticated #{authenticated_resource_name}' do",
+        "before { perform }\n",
+        "it { expect(response.status).to eq(401) }",
+      "end\n"
+    )
+  end
+
+  def resource_parameters
+    attrs = if resource.required_resource_attributes.any?
+              resource.required_resource_attributes
+            else
+              resource.optional_resource_attributes
+            end
+
+    for_each_attribute(attrs) do |attr|
+      "#{attr[:name]}: #{attr[:example]},"
+    end
+  end
+
+  def for_each_attribute(attributes)
+    attributes.inject("") do |memo, attr|
+      next memo if parent_resource && attr[:name] == parent_resource.id.to_sym
+
+      memo += "\n"
+      memo += yield(attr)
+      memo
+    end.delete_suffix(",")
+  end
+end
+# rubocop:enable Metrics/ModuleLength
+# rubocop:enable Metrics/MethodLength
+# rubocop:enable Layout/AlignParameters

data/lib/power_api/generator_helper/swagger_helper.rb

@@ -1,11 +1,11 @@
 # rubocop:disable Metrics/ModuleLength
 # rubocop:disable Metrics/MethodLength
-# rubocop:disable Layout/AlignArguments
+# rubocop:disable Layout/AlignParameters
 module PowerApi::GeneratorHelper::SwaggerHelper
   extend ActiveSupport::Concern
 
   included do
-    include PowerApi::GeneratorHelper::VersionHelper
+    include PowerApi::GeneratorHelper::ApiHelper
     include PowerApi::GeneratorHelper::ResourceHelper
     include PowerApi::GeneratorHelper::SimpleTokenAuthHelper
     include PowerApi::GeneratorHelper::TemplateBuilderHelper
@@ -118,44 +118,32 @@ module PowerApi::GeneratorHelper::SwaggerHelper
     <<~SCHEMA
       #{swagger_model_definition_const} = {
         type: :object,
-        properties: {
-          id: { type: :string, example: '1' },
-          type: { type: :string, example: '#{resource.snake_case}' },
-          attributes: {
-            type: :object,
-            properties: {#{get_swagger_schema_attributes_definitions}
-            },
-            required: [#{get_swagger_schema_attributes_names}
-            ]
-          }
+        properties: {#{get_swagger_schema_attributes_definitions}
         },
-        required: [
-          :id,
-          :type,
-          :attributes
+        required: [#{get_swagger_schema_attributes_names}
         ]
       }
 
       #{swagger_collection_definition_const} = {
         type: "object",
         properties: {
-          data: {
+          #{resource.plural}: {
             type: "array",
             items: { "$ref" => "#/definitions/#{resource.snake_case}" }
           }
         },
         required: [
-          :data
+          :#{resource.plural}
         ]
       }
 
       #{swagger_resource_definition_const} = {
         type: "object",
         properties: {
-          data: { "$ref" => "#/definitions/#{resource.snake_case}" }
+          #{resource.snake_case}: { "$ref" => "#/definitions/#{resource.snake_case}" }
         },
         required: [
-          :data
+          :#{resource.snake_case}
         ]
       }
     SCHEMA
@@ -268,7 +256,7 @@ swagger_doc: 'v#{version_number}/swagger.json' do"
         "response '200', '#{resource.plural_titleized} retrieved' do",
           "schema('$ref' => '#/definitions/#{resource.plural}_collection')\n",
           "run_test! do |response|",
-            "expect(JSON.parse(response.body)['data'].count).to eq(expected_collection_count)",
+            "expect(JSON.parse(response.body)['#{resource.plural}'].count).to eq(expected_collection_count)",
           "end",
         "end\n",
         spec_tpl_invalid_credentials,
@@ -452,7 +440,7 @@ swagger_doc: 'v#{version_number}/swagger.json' do"
   def get_swagger_schema_attributes_definitions
     for_each_schema_attribute(resource.resource_attributes) do |attr|
       opts = ["example: #{attr[:example]}"]
-      opts << "'x-nullable': true" unless attr[:required]
+      opts << "'x-nullable': true" unless attr[:required] || attr[:name] == :id
       opts
 
       "#{attr[:name]}: { type: :#{attr[:swagger_type]}, #{opts.join(', ')} },"
@@ -460,7 +448,9 @@ swagger_doc: 'v#{version_number}/swagger.json' do"
   end
 
   def get_swagger_schema_attributes_names
-    for_each_schema_attribute(resource.required_resource_attributes) do |attr|
+    for_each_schema_attribute(
+      resource.required_resource_attributes(include_id: true)
+    ) do |attr|
       ":#{attr[:name]},"
     end
   end
@@ -475,4 +465,4 @@ swagger_doc: 'v#{version_number}/swagger.json' do"
 end
 # rubocop:enable Metrics/ModuleLength
 # rubocop:enable Metrics/MethodLength
-# rubocop:enable Layout/AlignArguments
+# rubocop:enable Layout/AlignParameters

data/lib/power_api/generator_helpers.rb

@@ -2,8 +2,9 @@ module PowerApi
   class GeneratorHelpers
     include GeneratorHelper::ControllerActionsHelper
     include GeneratorHelper::ResourceHelper
-    include GeneratorHelper::VersionHelper
+    include GeneratorHelper::ApiHelper
     include GeneratorHelper::SwaggerHelper
+    include GeneratorHelper::RspecControllerHelper
     include GeneratorHelper::AmsHelper
     include GeneratorHelper::ControllerHelper
     include GeneratorHelper::RoutesHelper

data/lib/power_api/version.rb

@@ -1,3 +1,3 @@
 module PowerApi
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/spec/dummy/app/controllers/api/base_controller.rb

@@ -0,0 +1,2 @@
+class Api::BaseController < PowerApi::BaseController
+end

data/spec/dummy/app/controllers/api/internal/base_controller.rb

@@ -0,0 +1,5 @@
+class Api::Internal::BaseController < Api::BaseController
+  before_action do
+    self.namespace_for_serializer = ::Api::Internal
+  end
+end

data/spec/dummy/app/controllers/api/internal/blogs_controller.rb

@@ -0,0 +1,36 @@
+class Api::Internal::BlogsController < Api::Internal::BaseController
+  def index
+    respond_with Blog.all
+  end
+
+  def show
+    respond_with blog
+  end
+
+  def create
+    respond_with Blog.create!(blog_params)
+  end
+
+  def update
+    blog.update!(blog_params)
+    respond_with blog
+  end
+
+  def destroy
+    respond_with blog.destroy!
+  end
+
+  private
+
+  def blog
+    @blog ||= Blog.find_by!(id: params[:id])
+  end
+
+  def blog_params
+    params.require(:blog).permit(
+      :title,
+      :body,
+      :portfolio_id
+    )
+  end
+end

data/spec/dummy/app/serializers/api/internal/blog_serializer.rb

@@ -0,0 +1,12 @@
+class Api::Internal::BlogSerializer < ActiveModel::Serializer
+  type :blog
+
+  attributes(
+    :id,
+    :title,
+    :body,
+    :created_at,
+    :updated_at,
+    :portfolio_id
+  )
+end

data/spec/dummy/config/initializers/active_model_serializers.rb

@@ -0,0 +1 @@
+ActiveModelSerializers.config.adapter = :json

data/spec/dummy/config/initializers/api_pagination.rb

@@ -0,0 +1,32 @@
+ApiPagination.configure do |config|
+  # If you have more than one gem included, you can choose a paginator.
+  config.paginator = :kaminari
+
+  # By default, this is set to 'Total'
+  config.total_header = 'X-Total'
+
+  # By default, this is set to 'Per-Page'
+  config.per_page_header = 'X-Per-Page'
+
+  # Optional: set this to add a header with the current page number.
+  config.page_header = 'X-Page'
+
+  # Optional: set this to add other response format. Useful with tools that define :jsonapi format
+  # config.response_formats = [:json, :xml, :jsonapi]
+  config.response_formats = [:jsonapi]
+
+  # Optional: what parameter should be used to set the page option
+  config.page_param do |params|
+    params[:page][:number] if params[:page].is_a?(ActionController::Parameters)
+  end
+
+  # Optional: what parameter should be used to set the per page option
+  config.per_page_param do |params|
+    params[:page][:size] if params[:page].is_a?(ActionController::Parameters)
+  end
+
+  # Optional: Include the total and last_page link header
+  # By default, this is set to true
+  # Note: When using kaminari, this prevents the count call to the database
+  config.include_total = true
+end

data/spec/dummy/config/routes.rb

@@ -1,11 +1,6 @@
 Rails.application.routes.draw do
-  mount Rswag::Api::Engine => '/api-docs'
-  mount Rswag::Ui::Engine => '/api-docs'
-  scope path: '/api' do
-    api_version(module: 'Api::V2', path: { value: 'v2' }, defaults: { format: 'json' }) do
-    end
-
-    api_version(module: 'Api::V1', path: { value: 'v1' }, defaults: { format: 'json' }) do
+  namespace :api, defaults: { format: :json } do
+    namespace :internal do
       resources :blogs
     end
   end