workarea-api-admin 4.4.6

data/lib/workarea/api/admin.rb

@@ -0,0 +1,21 @@
+require 'responders'
+require 'raddocs'
+require 'swagger/blocks'
+
+require 'workarea'
+require 'workarea/admin'
+
+module Workarea
+  module Api
+    module Admin
+      def self.authenticate(email, password)
+        user = User.find_for_login(email, password)
+        user.try(:api_access?) || user.try(:super_admin?) ? user : nil
+      end
+    end
+  end
+end
+
+require 'workarea/api/version'
+require 'workarea/api/admin/engine'
+require 'workarea/api/admin/swagger'

data/lib/workarea/api/admin/engine.rb

@@ -0,0 +1,14 @@
+module Workarea
+  module Api
+    module Admin
+      class Engine < ::Rails::Engine
+        include Workarea::Plugin
+        isolate_namespace Workarea::Api::Admin
+
+        config.after_initialize do
+          Workarea::Api::Admin::Swagger.generate!
+        end
+      end
+    end
+  end
+end

data/lib/workarea/api/admin/swagger.rb

@@ -0,0 +1,106 @@
+module Workarea
+  module Api
+    module Admin
+      module Swagger
+        extend self
+
+        def models
+          @models ||= begin
+            result = Mongoid.models.select { |k| k.name.starts_with?('Workarea') }
+
+            result.reject! do |klass|
+              Workarea.config.api_admin_ignore_definitions.any? { |d| klass.name =~ d }
+            end
+
+            result += result.flat_map(&:subclasses)
+            result += [Mongoid::DocumentPath::Node]
+            result
+          end
+        end
+
+        def klasses
+          models + Workarea::Api::Admin::ApplicationController.subclasses
+        end
+
+        def add_fields(klass, dsl)
+          klass.fields.each do |name, metadata|
+            next if name == '_type'
+            default_value = if metadata.default_val.is_a?(Proc)
+              nil
+            else
+              metadata.default_val
+            end
+
+            dsl.property name do
+              case metadata.type.to_s
+              when 'BSON::ObjectId'
+                key :type, :string
+              when 'Date'
+                key :type, :string
+                key :format, :date
+                key :default, default_value.as_json if default_value.present?
+              when 'Time'
+                key :type, :string
+                key :format, 'date-time'
+                key :default, default_value.as_json if default_value.present?
+              when 'Array'
+                key :type, :array
+                key :default, default_value.to_a if default_value.present?
+                items { key :type, :string }
+              when 'Hash'
+                key :type, :object
+                key :additionalProperties, true
+                key :default, default_value.to_h if default_value.present?
+              when 'Boolean', 'Mongoid::Boolean'
+                key :type, :boolean
+                key :default, !!default_value if default_value.present?
+              when 'Integer'
+                key :type, :integer
+                key :default, default_value.to_i if default_value.present?
+              else
+                key :type, :string
+                key :default, default_value.to_s if default_value.present?
+              end
+            end
+          end
+        end
+
+        def add_relations(klass, dsl)
+          klass.relations.values.select(&:embedded?).each do |metadata|
+            dsl.property metadata.name do
+              if metadata.many?
+                key :type, :array
+                items { key :'$ref', metadata.klass.name }
+              else
+                key :'$ref', metadata.klass.name
+              end
+            end
+          end
+        end
+
+        def add_validators(klass, dsl)
+          required_attributes = klass
+            .validators
+            .select { |v| v.is_a?(Mongoid::Validatable::PresenceValidator) }
+            .flat_map(&:attributes)
+            .select { |a| klass.fields.key?(a) }
+
+          dsl.key :required, required_attributes if required_attributes.any?
+        end
+
+        def generate!
+          models.each do |klass|
+            klass.include(::Swagger::Blocks)
+            klass.instance_eval do
+              swagger_schema klass.name do
+                Swagger.add_validators(klass, self)
+                Swagger.add_fields(klass, self)
+                Swagger.add_relations(klass, self)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/admin/categories_documentation_test.rb

@@ -0,0 +1,106 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class CategoriesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Categories'
+
+        def sample_attributes
+          create_category(
+            product_rules: [{ name: 'search', operator: 'equals', value: '*' }]
+          ).as_json.except('_id', 'slug')
+        end
+
+        def test_and_document_index
+          description 'Listing categories'
+          route admin_api.categories_path
+          parameter :page, 'Current page'
+          parameter :sort_by, 'Field on which to sort (see responses for possible values)'
+          parameter :sort_direction, 'Direction to sort (asc or desc)'
+
+          2.times do
+            create_category(
+              product_rules: [{ name: 'search', operator: 'equals', value: '*' }]
+            )
+          end
+
+          record_request do
+            get admin_api.categories_path,
+                  params: { page: 1, sort_by: 'created_at', sort_direction: 'desc' }
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create
+          description 'Creating a category'
+          route admin_api.categories_path
+
+          record_request do
+            post admin_api.categories_path, params: sample_attributes, as: :json
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a category'
+          route admin_api.category_path(':id')
+
+          category = create_category(
+            product_rules: [{ name: 'search', operator: 'equals', value: '*' }]
+          )
+
+          record_request do
+            get admin_api.category_path(category.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a category'
+          route admin_api.category_path(':id')
+
+          category = create_category(
+            product_rules: [{ name: 'search', operator: 'equals', value: '*' }]
+          )
+
+          record_request do
+            patch admin_api.category_path(category.id),
+                    params: sample_attributes,
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting categories'
+          route admin_api.bulk_categories_path
+
+          record_request do
+            patch admin_api.bulk_categories_path,
+                    params: { categories: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a category'
+          route admin_api.category_path(':id')
+
+          category = create_category
+
+          record_request do
+            delete admin_api.category_path(category.id), as: :json
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/admin/category_product_rules_documentation_test.rb

@@ -0,0 +1,78 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class CategoryProductRulesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Category Product Rules'
+
+        def category
+          @category ||= create_category
+        end
+
+        def sample_attributes
+          { name: 'search', operator: 'equals', value: '*' }
+        end
+
+        def create_rule
+          category.product_rules.create!(sample_attributes)
+        end
+
+        def test_and_document_index
+          description 'Listing category product rules'
+          route admin_api.category_product_rules_path(':category_id')
+
+          2.times { create_rule }
+
+          record_request do
+            get admin_api.category_product_rules_path(category.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create
+          description 'Creating a category product rule'
+          route admin_api.category_product_rules_path(':category_id')
+
+          record_request do
+            post admin_api.category_product_rules_path(category.id),
+              params: { product_rule: sample_attributes },
+              as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a category product rule'
+          route admin_api.category_product_rule_path(':category_id', ':id')
+
+          rule = create_rule
+
+          record_request do
+            patch admin_api.category_product_rule_path(category.id, rule.id),
+                    params: { product_rule: { value: 'foo' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a category product rule'
+          route admin_api.category_product_rule_path(':category_id', ':id')
+
+          rule = create_rule
+
+          record_request do
+            delete admin_api.category_product_rule_path(category.id, rule.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/admin/content_assets_documentation_test.rb

@@ -0,0 +1,94 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class ContentAssetsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Content Assets'
+
+        def sample_attributes
+          create_asset.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing content assets'
+          route admin_api.content_assets_path
+          parameter :page, 'Current page'
+          parameter :sort_by, 'Field on which to sort (see responses for possible values)'
+          parameter :sort_direction, 'Direction to sort (asc or desc)'
+
+          2.times { create_asset }
+
+          record_request do
+            get admin_api.content_assets_path,
+                  params: { page: 1, sort_by: 'created_at', sort_direction: 'desc' }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create
+          description 'Creating a content asset'
+          route admin_api.content_assets_path
+
+          record_request do
+            post admin_api.content_assets_path,
+                  params: { asset: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a content asset'
+          route admin_api.content_asset_path(':id')
+
+          record_request do
+            get admin_api.content_asset_path(create_asset.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a content asset'
+          route admin_api.content_asset_path(':id')
+
+          record_request do
+            patch admin_api.content_asset_path(create_asset.id),
+                    params: { asset: sample_attributes },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting content assets'
+          route admin_api.bulk_content_assets_path
+
+          record_request do
+            patch admin_api.bulk_content_assets_path,
+                    params: { assets: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a content asset'
+          route admin_api.content_asset_path(':id')
+
+          record_request do
+            delete admin_api.content_asset_path(create_asset.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/admin/content_documentation_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class ContentDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Content'
+
+        def sample_attributes
+          create_content
+            .as_json
+            .except('_id', 'slug', 'last_indexed_at')
+        end
+
+        def test_and_document_index
+          description 'Listing content'
+          route admin_api.content_index_path
+          parameter :page, 'Current page'
+          parameter :sort_by, 'Field on which to sort (see responses for possible values)'
+          parameter :sort_direction, 'Direction to sort (asc or desc)'
+
+          2.times { create_content }
+
+          record_request do
+            get admin_api.content_index_path,
+                  params: { page: 1, sort_by: 'created_at', sort_direction: 'desc' },
+                  as: :json
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create
+          description 'Creating content'
+          route admin_api.content_index_path
+
+          record_request do
+            post admin_api.content_index_path,
+                  params: { content: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing content'
+          route admin_api.content_path(':id')
+
+          record_request do
+            get admin_api.content_path(create_content.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating content'
+          route admin_api.content_path(':id')
+
+          record_request do
+            patch admin_api.content_path(create_content.id),
+                    params: { content: { browser_title: 'foo' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting content'
+          route admin_api.bulk_content_index_path
+
+          record_request do
+            patch admin_api.bulk_content_index_path,
+                    params: { content: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end