power_api 1.0.0 → 2.0.0

data/spec/dummy/spec/helpers/power_api/application_helper_spec.rb

@@ -0,0 +1,171 @@
+require "spec_helper"
+
+describe PowerApi::ApplicationHelper do
+  describe "#serialize_resource" do
+    let(:resource) do
+      build(
+        :blog,
+        id: 1,
+        title: "T",
+        portfolio_id: 2,
+        body: "B",
+        created_at: "2022-01-28T20:30:00.000Z",
+        updated_at: "2022-01-28T20:40:00.000Z"
+      )
+    end
+
+    let(:options) { {} }
+
+    def data
+      helper.serialize_resource(resource, options)
+    end
+
+    let(:expected_serialized_data) do
+      <<~DATA.strip
+        {\"id\":1,\"title\":\"T\",\"body\":\"B\",\"createdAt\":\"2022-01-28T20:30:00.000Z\",\"updatedAt\":\"2022-01-28T20:40:00.000Z\",\"portfolioId\":2}
+      DATA
+    end
+
+    it { expect(data).to eq(expected_serialized_data) }
+
+    context "with fields option" do
+      let(:options) do
+        {
+          fields: [:id, :body]
+        }
+      end
+
+      let(:expected_serialized_data) do
+        <<~DATA.strip
+          {\"id\":1,\"body\":\"B\"}
+        DATA
+      end
+
+      it { expect(data).to eq(expected_serialized_data) }
+    end
+
+    context "with key_transform option" do
+      let(:options) do
+        {
+          key_transform: :unaltered
+        }
+      end
+
+      let(:expected_serialized_data) do
+        <<~DATA.strip
+          {\"id\":1,\"title\":\"T\",\"body\":\"B\",\"created_at\":\"2022-01-28T20:30:00.000Z\",\"updated_at\":\"2022-01-28T20:40:00.000Z\",\"portfolio_id\":2}
+        DATA
+      end
+
+      it { expect(data).to eq(expected_serialized_data) }
+    end
+
+    context "with include_root option" do
+      let(:options) do
+        {
+          include_root: true
+        }
+      end
+
+      let(:expected_serialized_data) do
+        <<~DATA.strip
+          {"blog":{"id":1,"title":"T","body":"B","createdAt":"2022-01-28T20:30:00.000Z","updatedAt":"2022-01-28T20:40:00.000Z","portfolioId":2}}
+        DATA
+      end
+
+      it { expect(data).to eq(expected_serialized_data) }
+    end
+
+    context "with collection resource" do
+      let(:options) do
+        {
+          include_root: false,
+          fields: [:body]
+        }
+      end
+
+      let(:resource) do
+        create_list(:blog, 2)
+      end
+
+      let(:expected_serialized_data) do
+        <<~DATA.strip
+          [{\"body\":\"MyText\"},{\"body\":\"MyText\"}]
+        DATA
+      end
+
+      it { expect(data).to eq(expected_serialized_data) }
+    end
+
+    context "with invalid resource" do
+      let(:resource) do
+        { invalid: "resource" }
+      end
+
+      it { expect { data }.to raise_error(PowerApi::InvalidSerializableResource, /Invalid Hash/) }
+    end
+
+    context "with hash output_format" do
+      let(:options) do
+        {
+          output_format: :hash
+        }
+      end
+
+      let(:expected_serialized_data) do
+        {
+          body: "B",
+          created_at: "2022-01-28 20:30:00.000000000 +0000",
+          id: 1,
+          portfolio_id: 2,
+          title: "T",
+          updated_at: "2022-01-28 20:40:00.000000000 +0000"
+        }
+      end
+
+      it { expect(data).to eq(expected_serialized_data) }
+
+      context "with key_transform option" do
+        before { options[:key_transform] = :camel_lower }
+
+        it { expect(data).to eq(expected_serialized_data) }
+      end
+    end
+
+    context "with invalid output option" do
+      let(:options) do
+        { output_format: "invalid" }
+      end
+
+      it { expect { data }.to raise_error(PowerApi::InvalidSerializerOutputFormat, /:json, :hash/) }
+    end
+
+    context "with meta option" do
+      let(:options) do
+        {
+          meta: { hola: "platanus" }
+        }
+      end
+
+      let(:expected_serialized_data) do
+        <<~DATA.strip
+          {\"id\":1,\"title\":\"T\",\"body\":\"B\",\"createdAt\":\"2022-01-28T20:30:00.000Z\",\"updatedAt\":\"2022-01-28T20:40:00.000Z\",\"portfolioId\":2}
+        DATA
+      end
+
+      it { expect(data).to eq(expected_serialized_data) }
+
+      context "with include_root option" do
+        before { options[:include_root] = true }
+
+        let(:expected_serialized_data) do
+          <<~DATA.strip
+            {\"blog\":{\"id\":1,\"title\":\"T\",\"body\":\"B\",\"createdAt\":\"2022-01-28T20:30:00.000Z\",\"updatedAt\":\"2022-01-28T20:40:00.000Z\",\"portfolioId\":2},\"meta\":{\"hola\":\"platanus\"}}
+          DATA
+        end
+
+        it { expect(data).to eq(expected_serialized_data) }
+      end
+    end
+  end
+end

data/spec/dummy/spec/lib/power_api/generator_helper/ams_helper_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe PowerApi::GeneratorHelper::AmsHelper, type: :generator do
 
   describe "#ams_serializers_path" do
     let(:expected_path) do
-      "app/serializers/api/v1/.gitkeep"
+      "app/serializers/api/exposed/v1/.gitkeep"
     end
 
     def perform
@@ -24,7 +24,17 @@ RSpec.describe PowerApi::GeneratorHelper::AmsHelper, type: :generator do
       let(:version_number) { "2" }
 
       let(:expected_path) do
-        "app/serializers/api/v2/.gitkeep"
+        "app/serializers/api/exposed/v2/.gitkeep"
+      end
+
+      it { expect(perform).to eq(expected_path) }
+    end
+
+    context "with no version" do
+      let(:version_number) { "" }
+
+      let(:expected_path) do
+        "app/serializers/api/internal/.gitkeep"
       end
 
       it { expect(perform).to eq(expected_path) }
@@ -32,25 +42,29 @@ RSpec.describe PowerApi::GeneratorHelper::AmsHelper, type: :generator do
   end
 
   describe "#ams_serializer_path" do
-    let(:expected_path) { "app/serializers/api/v1/blog_serializer.rb" }
+    let(:expected_path) { "app/serializers/api/exposed/v1/blog_serializer.rb" }
 
     def perform
       generators_helper.ams_serializer_path
     end
 
     it { expect(perform).to eq(expected_path) }
+
+    context "with no version" do
+      let(:version_number) { nil }
+
+      let(:expected_path) do
+        "app/serializers/api/internal/blog_serializer.rb"
+      end
+
+      it { expect(perform).to eq(expected_path) }
+    end
   end
 
   describe "ams_initializer_tpl" do
     let(:template) do
       <<~INITIALIZER
-        class ActiveModelSerializers::Adapter::JsonApi
-          def self.default_key_transform
-            :unaltered
-          end
-        end
-
-        ActiveModelSerializers.config.adapter = :json_api
+        ActiveModelSerializers.config.adapter = :json
       INITIALIZER
     end
 
@@ -64,11 +78,12 @@ RSpec.describe PowerApi::GeneratorHelper::AmsHelper, type: :generator do
   describe "ams_serializer_tpl" do
     let(:template) do
       <<~SERIALIZER
-        class Api::V1::BlogSerializer < ActiveModel::Serializer
+        class Api::Exposed::V1::BlogSerializer < ActiveModel::Serializer
           type :blog
 
           attributes(
-            :title,
+            :id,
+        :title,
         :body,
         :created_at,
         :updated_at,
@@ -83,5 +98,28 @@ RSpec.describe PowerApi::GeneratorHelper::AmsHelper, type: :generator do
     end
 
     it { expect(perform).to eq(template) }
+
+    context "with no version" do
+      let(:version_number) { nil }
+
+      let(:template) do
+        <<~SERIALIZER
+          class Api::Internal::BlogSerializer < ActiveModel::Serializer
+            type :blog
+
+            attributes(
+              :id,
+          :title,
+          :body,
+          :created_at,
+          :updated_at,
+          :portfolio_id
+          )
+          end
+        SERIALIZER
+      end
+
+      it { expect(perform).to eq(template) }
+    end
   end
 end

data/spec/dummy/spec/lib/power_api/generator_helper/api_helper_spec.rb

@@ -0,0 +1,115 @@
+RSpec.describe PowerApi::GeneratorHelper::ApiHelper, type: :generator do
+  describe "#version_number" do
+    def perform
+      generators_helper.version_number
+    end
+
+    it { expect(perform).to eq(1) }
+  end
+
+  describe "version_number=" do
+    context "with invalid version number" do
+      let(:version_number) { "A" }
+
+      it { expect { generators_helper }.to raise_error("invalid version number") }
+    end
+
+    context "with zero version number" do
+      let(:version_number) { 0 }
+
+      it { expect { generators_helper }.to raise_error("invalid version number") }
+    end
+
+    context "with nil version number" do
+      let(:version_number) { nil }
+
+      it { expect { generators_helper }.not_to raise_error }
+    end
+
+    context "with nil blank number" do
+      let(:version_number) { "" }
+
+      it { expect { generators_helper }.not_to raise_error }
+    end
+
+    context "with negative version number" do
+      let(:version_number) { -1 }
+
+      it { expect { generators_helper }.to raise_error("invalid version number") }
+    end
+  end
+
+  describe "#first_version?" do
+    def perform
+      generators_helper.first_version?
+    end
+
+    it { expect(perform).to eq(true) }
+
+    context "when version in not first version" do
+      let(:version_number) { "2" }
+
+      it { expect(perform).to eq(false) }
+    end
+  end
+
+  describe "#versioned_api?" do
+    def perform
+      generators_helper.versioned_api?
+    end
+
+    it { expect(perform).to eq(true) }
+
+    context "when version in not first version" do
+      let(:version_number) { "2" }
+
+      it { expect(perform).to eq(true) }
+    end
+
+    context "when nil version" do
+      let(:version_number) { nil }
+
+      it { expect(perform).to eq(false) }
+    end
+  end
+
+  describe "#api_file_path" do
+    def perform
+      generators_helper.api_file_path
+    end
+
+    it { expect(perform).to eq("api/exposed/v1") }
+
+    context "when version in not first version" do
+      let(:version_number) { "2" }
+
+      it { expect(perform).to eq("api/exposed/v2") }
+    end
+
+    context "when nil version" do
+      let(:version_number) { nil }
+
+      it { expect(perform).to eq("api/internal") }
+    end
+  end
+
+  describe "#api_class" do
+    def perform
+      generators_helper.api_class
+    end
+
+    it { expect(perform).to eq("Api::Exposed::V1") }
+
+    context "when version in not first version" do
+      let(:version_number) { "2" }
+
+      it { expect(perform).to eq("Api::Exposed::V2") }
+    end
+
+    context "when nil version" do
+      let(:version_number) { nil }
+
+      it { expect(perform).to eq("Api::Internal") }
+    end
+  end
+end

data/spec/dummy/spec/lib/power_api/generator_helper/controller_helper_spec.rb

@@ -1,46 +1,68 @@
-RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
-  describe "#api_base_controller_path" do
+describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
+  describe "#api_main_base_controller_path" do
     let(:expected_path) { "app/controllers/api/base_controller.rb" }
 
     def perform
-      generators_helper.api_base_controller_path
+      generators_helper.api_main_base_controller_path
     end
 
     it { expect(perform).to eq(expected_path) }
   end
 
-  describe "#resource_controller_path" do
-    let(:expected_path) { "app/controllers/api/v1/blogs_controller.rb" }
+  describe "#exposed_base_controller_path" do
+    let(:expected_path) { "app/controllers/api/exposed/base_controller.rb" }
 
     def perform
-      generators_helper.resource_controller_path
+      generators_helper.exposed_base_controller_path
     end
 
     it { expect(perform).to eq(expected_path) }
   end
 
-  describe "api_base_controller_tpl" do
-    let(:template) do
-      <<~CONTROLLER
-        class Api::BaseController < PowerApi::BaseController
-        end
-      CONTROLLER
+  describe "#internal_base_controller_path" do
+    let(:expected_path) { "app/controllers/api/internal/base_controller.rb" }
+
+    def perform
+      generators_helper.internal_base_controller_path
     end
 
+    it { expect(perform).to eq(expected_path) }
+  end
+
+  describe "#version_base_controller_path" do
+    let(:expected_path) { "app/controllers/api/exposed/v1/base_controller.rb" }
+
     def perform
-      generators_helper.api_base_controller_tpl
+      generators_helper.version_base_controller_path
     end
 
-    it { expect(perform).to eq(template) }
+    it { expect(perform).to eq(expected_path) }
+  end
+
+  describe "#resource_controller_path" do
+    let(:expected_path) { "app/controllers/api/exposed/v1/blogs_controller.rb" }
+
+    def perform
+      generators_helper.resource_controller_path
+    end
+
+    it { expect(perform).to eq(expected_path) }
+
+    context "without version" do
+      let(:version_number) { "" }
+      let(:expected_path) { "app/controllers/api/internal/blogs_controller.rb" }
+
+      it { expect(perform).to eq(expected_path) }
+    end
   end
 
-  describe "#base_controller_path" do
+  describe "#version_base_controller_path" do
     let(:expected_path) do
-      "app/controllers/api/v1/base_controller.rb"
+      "app/controllers/api/exposed/v1/base_controller.rb"
     end
 
     def perform
-      generators_helper.base_controller_path
+      generators_helper.version_base_controller_path
     end
 
     it { expect(perform).to eq(expected_path) }
@@ -49,17 +71,66 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
       let(:version_number) { "2" }
 
       let(:expected_path) do
-        "app/controllers/api/v2/base_controller.rb"
+        "app/controllers/api/exposed/v2/base_controller.rb"
       end
 
       it { expect(perform).to eq(expected_path) }
     end
   end
 
+  describe "api_main_base_controller_tpl" do
+    let(:template) do
+      <<~CONTROLLER
+        class Api::BaseController < PowerApi::BaseController
+        end
+      CONTROLLER
+    end
+
+    def perform
+      generators_helper.api_main_base_controller_tpl
+    end
+
+    it { expect(perform).to eq(template) }
+  end
+
+  describe "exposed_base_controller_tpl" do
+    let(:template) do
+      <<~CONTROLLER
+        class Api::Exposed::BaseController < Api::BaseController
+          skip_before_action :verify_authenticity_token
+        end
+      CONTROLLER
+    end
+
+    def perform
+      generators_helper.exposed_base_controller_tpl
+    end
+
+    it { expect(perform).to eq(template) }
+  end
+
+  describe "internal_base_controller_tpl" do
+    let(:template) do
+      <<~CONTROLLER
+        class Api::Internal::BaseController < Api::BaseController
+          before_action do
+            self.namespace_for_serializer = ::Api::Internal
+          end
+        end
+      CONTROLLER
+    end
+
+    def perform
+      generators_helper.internal_base_controller_tpl
+    end
+
+    it { expect(perform).to eq(template) }
+  end
+
   describe "resource_controller_tpl" do
     let(:template) do
       <<~CONTROLLER
-        class Api::V1::BlogsController < Api::V1::BaseController
+        class Api::Exposed::V1::BlogsController < Api::Exposed::V1::BaseController
         def index
         respond_with Blog.all
         end
@@ -70,7 +141,8 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
         respond_with Blog.create!(blog_params)
         end
         def update
-        respond_with blog.update!(blog_params)
+        blog.update!(blog_params)
+        respond_with blog
         end
         def destroy
         respond_with blog.destroy!
@@ -96,6 +168,13 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
 
     it { expect(perform).to eq(template) }
 
+    context "without version" do
+      let(:version_number) { nil }
+      let(:expected) { "class Api::Internal::BlogsController < Api::Internal::BaseController" }
+
+      it { expect(perform).to include(expected) }
+    end
+
     context "with specific attributes" do
       let(:resource_attributes) do
         [
@@ -207,7 +286,7 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
       let(:authenticated_resource) { "user" }
       let(:template) do
         <<~CONTROLLER
-          class Api::V1::BlogsController < Api::V1::BaseController
+          class Api::Exposed::V1::BlogsController < Api::Exposed::V1::BaseController
           acts_as_token_authentication_handler_for User, fallback: :exception
 
           def index
@@ -220,7 +299,8 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
           respond_with Blog.create!(blog_params)
           end
           def update
-          respond_with blog.update!(blog_params)
+          blog.update!(blog_params)
+          respond_with blog
           end
           def destroy
           respond_with blog.destroy!
@@ -241,6 +321,15 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
       end
 
       it { expect(perform).to eq(template) }
+
+      context "without version" do
+        let(:version_number) { nil }
+        let(:expected) do
+          "before_action :authenticate_user!"
+        end
+
+        it { expect(perform).to include(expected) }
+      end
     end
 
     context "with owned_by_authenticated_resource and authenticated_resource" do
@@ -249,7 +338,7 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
 
       let(:template) do
         <<~CONTROLLER
-          class Api::V1::BlogsController < Api::V1::BaseController
+          class Api::Exposed::V1::BlogsController < Api::Exposed::V1::BaseController
           acts_as_token_authentication_handler_for User, fallback: :exception
 
           def index
@@ -262,7 +351,8 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
           respond_with blogs.create!(blog_params)
           end
           def update
-          respond_with blog.update!(blog_params)
+          blog.update!(blog_params)
+          respond_with blog
           end
           def destroy
           respond_with blog.destroy!
@@ -299,7 +389,7 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
       let(:parent_resource_name) { "portfolio" }
       let(:template) do
         <<~CONTROLLER
-          class Api::V1::BlogsController < Api::V1::BaseController
+          class Api::Exposed::V1::BlogsController < Api::Exposed::V1::BaseController
           def index
           respond_with blogs
           end
@@ -310,7 +400,8 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
           respond_with blogs.create!(blog_params)
           end
           def update
-          respond_with blog.update!(blog_params)
+          blog.update!(blog_params)
+          respond_with blog
           end
           def destroy
           respond_with blog.destroy!
@@ -345,7 +436,7 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
       let(:owned_by_authenticated_resource) { true }
       let(:template) do
         <<~CONTROLLER
-          class Api::V1::BlogsController < Api::V1::BaseController
+          class Api::Exposed::V1::BlogsController < Api::Exposed::V1::BaseController
           acts_as_token_authentication_handler_for User, fallback: :exception
 
           def index
@@ -358,7 +449,8 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
           respond_with blogs.create!(blog_params)
           end
           def update
-          respond_with blog.update!(blog_params)
+          blog.update!(blog_params)
+          respond_with blog
           end
           def destroy
           respond_with blog.destroy!
@@ -388,19 +480,19 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
     end
   end
 
-  describe "#base_controller_tpl" do
+  describe "#version_base_controller_tpl" do
     let(:expected_tpl) do
       <<~CONTROLLER
-        class Api::V1::BaseController < Api::BaseController
+        class Api::Exposed::V1::BaseController < Api::Exposed::BaseController
           before_action do
-            self.namespace_for_serializer = ::Api::V1
+            self.namespace_for_serializer = ::Api::Exposed::V1
           end
         end
       CONTROLLER
     end
 
     def perform
-      generators_helper.base_controller_tpl
+      generators_helper.version_base_controller_tpl
     end
 
     it { expect(perform).to eq(expected_tpl) }
@@ -410,9 +502,9 @@ RSpec.describe PowerApi::GeneratorHelper::ControllerHelper, type: :generator do
 
       let(:expected_tpl) do
         <<~CONTROLLER
-          class Api::V2::BaseController < Api::BaseController
+          class Api::Exposed::V2::BaseController < Api::Exposed::BaseController
             before_action do
-              self.namespace_for_serializer = ::Api::V2
+              self.namespace_for_serializer = ::Api::Exposed::V2
             end
           end
         CONTROLLER