workarea-api 4.4.6

data/admin/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/admin/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/admin/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/admin/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

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

@@ -0,0 +1,85 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class DiscountsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Discounts'
+        alias create_discount create_product_discount
+
+        def sample_attributes
+          create_discount
+            .as_json
+            .except('_id')
+            .merge('type' => 'product', 'promo_codes' => ['SALE'])
+        end
+
+        def test_and_document_index
+          description 'Listing discounts'
+          route admin_api.discounts_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_discount }
+
+          record_request do
+            get admin_api.discounts_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 discount'
+          route admin_api.discounts_path
+
+          record_request do
+            post admin_api.discounts_path,
+                  params: { discount: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a discount'
+          route admin_api.discount_path(':id')
+
+          record_request do
+            get admin_api.discount_path(create_discount.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating discounts'
+          route admin_api.discount_path(':id')
+
+          record_request do
+            patch admin_api.discount_path(create_discount.id),
+                    params: { discount: { name: 'foo' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a discount'
+          route admin_api.discount_path(':id')
+
+          record_request do
+            delete admin_api.discount_path(create_discount.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class EmailSignupsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Email Signups'
+
+        def test_and_document_index
+          description 'Listing email signups'
+          route admin_api.email_signups_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 { |i| create_email_signup(email: "#{i}@workarea.com") }
+
+          record_request do
+            get admin_api.email_signups_path,
+                  params: { page: 1, sort_by: 'created_at', sort_direction: 'desc' }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing an email signup'
+          route admin_api.email_signup_path(':id')
+
+          record_request do
+            get admin_api.email_signup_path(create_email_signup.id)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class FulfillmentDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Fulfillment'
+
+        def create_fulfillment(*args)
+          order = create_placed_order(*args)
+          Fulfillment.find(order.id)
+        end
+
+        def fulfillment
+          @fulfillment ||= create_fulfillment
+        end
+
+        def test_and_document_index
+          description 'Listing fulfillments'
+          route admin_api.fulfillments_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)'
+
+          create_fulfillment(id: '1')
+          create_fulfillment(id: '2')
+
+          record_request do
+            get admin_api.fulfillments_path
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing fulfillment'
+          route admin_api.fulfillment_path(':order_id')
+
+          record_request do
+            get admin_api.fulfillment_path(create_fulfillment.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_ship_items
+          description 'Marking items as shipped'
+          route admin_api.ship_items_fulfillment_path(':order_id')
+
+          record_request do
+            post admin_api.ship_items_fulfillment_path(fulfillment.id),
+                  params: {
+                    tracking_number: '1Z',
+                    items: [
+                      { id: fulfillment.items.first.order_item_id, quantity: 1 }
+                    ]
+                  },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_cancel_items
+          description 'Marking items as canceled'
+          route admin_api.cancel_items_fulfillment_path(':order_id')
+
+          record_request do
+            post admin_api.cancel_items_fulfillment_path(fulfillment.id),
+                  params: {
+                    items: [
+                      { id: fulfillment.items.first.order_item_id, quantity: 1 }
+                    ]
+                  },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class InventorySkusDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Inventory SKUs'
+
+        def sample_attributes
+          @sample_attributes ||= create_inventory.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing inventory SKUs'
+          route admin_api.inventory_skus_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 { |i| create_inventory(id: "SKU#{i}") }
+
+          record_request do
+            get admin_api.inventory_skus_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 an inventory SKU'
+          route admin_api.inventory_skus_path
+
+          record_request do
+            post admin_api.inventory_skus_path,
+                  params: { inventory_sku: sample_attributes.merge('_id' => 'SKU2') },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing an inventory SKU'
+          route admin_api.inventory_sku_path(':id')
+
+          record_request do
+            get admin_api.inventory_sku_path(create_inventory.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating an inventory SKU'
+          route admin_api.inventory_sku_path(':id')
+
+          record_request do
+            patch admin_api.inventory_sku_path(create_inventory.id),
+                    params: { inventory_sku: { policy: 'ignore' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting inventory SKUs'
+          route admin_api.bulk_inventory_skus_path
+
+          record_request do
+            data = Array.new(3) { sample_attributes.merge('_id' => Inventory::Sku.count) }
+            patch admin_api.bulk_inventory_skus_path,
+                    params: { inventory_skus: data },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing an inventory SKU'
+          route admin_api.inventory_sku_path(':id')
+
+          record_request do
+            delete admin_api.inventory_sku_path(create_inventory.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end