workarea-api-admin 4.4.6

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

@@ -0,0 +1,65 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class OrdersDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Orders'
+
+        def test_and_document_index
+          description 'Listing orders'
+          route admin_api.orders_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_placed_order(id: 1000 + i) }
+
+          record_request do
+            get admin_api.orders_path,
+                  params: { page: 1, sort_by: 'created_at', sort_direction: 'desc ' }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_filtered_index
+          description 'Viewing orders by date range'
+          route admin_api.orders_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)'
+          parameter :placed_at_greater_than, 'Start of a placed_at date range'
+          parameter :placed_at_less_than, 'End of a placed_at date range'
+
+          3.times { |i| create_placed_order(id: 1000 + i, placed_at: i.weeks.ago) }
+
+          record_request do
+            get admin_api.orders_path,
+                  params:
+                    { page: 1,
+                      sort_by: 'created_at',
+                      sort_direction: 'desc',
+                      placed_at_greater_than: 2.weeks.ago - 1.day,
+                      placed_at_less_than: 2.weeks.ago + 1.day }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing an order'
+          route admin_api.order_path(':id')
+
+          record_request do
+            get admin_api.order_path(create_placed_order.id)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PagesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Pages'
+
+        def sample_attributes
+          create_page.as_json.except('_id', 'slug')
+        end
+
+        def test_and_document_index
+          description 'Listing pages'
+          route admin_api.pages_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_page }
+
+          record_request do
+            get admin_api.pages_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 page'
+          route admin_api.pages_path
+
+          record_request do
+            post admin_api.pages_path, params: sample_attributes, as: :json
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a page'
+          route admin_api.page_path(':id')
+
+          record_request do
+            get admin_api.page_path(create_page.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a page'
+          route admin_api.page_path(':id')
+
+          record_request do
+            patch admin_api.page_path(create_page.id),
+                    params: sample_attributes,
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting pages'
+          route admin_api.bulk_pages_path
+
+          record_request do
+            patch admin_api.bulk_pages_path,
+                    params: { pages: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a page'
+          route admin_api.page_path(':id')
+
+          page = create_page
+
+          record_request do
+            delete admin_api.page_path(page.id), as: :json
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PaymentProfilesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Payment Profiles'
+
+        def sample_attributes
+          @sample_attributes ||= create_payment_profile.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing payment profiles'
+          route admin_api.payment_profiles_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_payment_profile(reference: i) }
+
+          record_request do
+            get admin_api.payment_profiles_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 payment profile'
+          route admin_api.payment_profiles_path
+
+          record_request do
+            data = sample_attributes.merge('reference' => Payment::Profile.count + 1)
+            post admin_api.payment_profiles_path,
+                  params: { payment_profile: data },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a payment profile'
+          route admin_api.payment_profile_path(':id')
+
+          record_request do
+            get admin_api.payment_profile_path(create_payment_profile.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a payment profiles'
+          route admin_api.payment_profile_path(':id')
+
+          record_request do
+            patch admin_api.payment_profile_path(create_payment_profile.id),
+                    params: { payment_profile: { store_credit: 29 } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting payment profiles'
+          route admin_api.bulk_payment_profiles_path
+
+          count = Payment::Profile.count + 1
+          data = Array.new(3) { sample_attributes.merge('reference' => count) }
+
+          record_request do
+            patch admin_api.bulk_payment_profiles_path,
+                    params: { payment_profiles: data },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a payment profile'
+          route admin_api.payment_profile_path(':id')
+
+          record_request do
+            delete admin_api.payment_profile_path(create_payment_profile.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PaymentTransactionsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Payment transactions'
+
+        def test_and_document_index
+          description 'Listing payment transactions'
+          route admin_api.payment_transactions_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_placed_order(id: 1000 + i) }
+
+          record_request do
+            get admin_api.payment_transactions_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 a payment transaction'
+          route admin_api.payment_transaction_path(':id')
+
+          create_placed_order
+
+          record_request do
+            get admin_api.payment_transaction_path(Payment::Transaction.first.id)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PaymentsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Payments'
+
+        def test_and_document_index
+          description 'Listing payments'
+          route admin_api.payments_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_placed_order(id: 1000 + i) }
+
+          record_request do
+            get admin_api.payments_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 payment'
+          route admin_api.payment_path(':id')
+
+          record_request do
+            get admin_api.payment_path(create_placed_order.id)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PricesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Prices'
+
+        def pricing_sku
+          @pricing_sku ||= create_pricing_sku
+        end
+
+        def sample_attributes
+          { regular: 15 }
+        end
+
+        def create_price
+          pricing_sku.prices.create!(sample_attributes)
+        end
+
+        def test_and_document_index
+          description 'Listing pricing sku prices'
+          route admin_api.pricing_sku_prices_path(':pricing_sku_id')
+          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_price }
+
+          record_request do
+            get admin_api.pricing_sku_prices_path(pricing_sku.id),
+                  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 pricing sku price'
+          route admin_api.pricing_sku_prices_path(':pricing_sku_id')
+
+          record_request do
+            post admin_api.pricing_sku_prices_path(pricing_sku.id),
+                  params: { price: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a pricing sku price'
+          route admin_api.pricing_sku_price_path(':pricing_sku_id', ':id')
+
+          price = create_price
+
+          record_request do
+            patch admin_api.pricing_sku_price_path(pricing_sku.id, price.id),
+                    params: { price: { regular: 15 } }
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a pricing sku price'
+          route admin_api.pricing_sku_price_path(':pricing_sku_id', ':id')
+
+          price = create_price
+
+          record_request do
+            delete admin_api.pricing_sku_price_path(pricing_sku.id, price.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PricingSkusDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Pricing SKUs'
+
+        def sample_attributes
+          @sample_attributes ||= create_pricing_sku.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing pricing SKUs'
+          route admin_api.pricing_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_pricing_sku(id: "SKU#{i}") }
+
+          record_request do
+            get admin_api.pricing_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 pricing SKU'
+          route admin_api.pricing_skus_path
+
+          record_request do
+            post admin_api.pricing_skus_path,
+                  params: { pricing_sku: sample_attributes.merge('_id' => 'SKU2') },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing an pricing SKU'
+          route admin_api.pricing_sku_path(':id')
+
+          record_request do
+            get admin_api.pricing_sku_path(create_pricing_sku.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating an pricing SKU'
+          route admin_api.pricing_sku_path(':id')
+
+          record_request do
+            patch admin_api.pricing_sku_path(create_pricing_sku.id),
+                    params: { pricing_sku: { discountable: false } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting pricing SKUs'
+          route admin_api.bulk_pricing_skus_path
+
+          record_request do
+            data = Array.new(3) { sample_attributes.merge('_id' => Pricing::Sku.count) }
+            patch admin_api.bulk_pricing_skus_path,
+                    params: { pricing_skus: data },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing an pricing SKU'
+          route admin_api.pricing_sku_path(':id')
+
+          record_request do
+            delete admin_api.pricing_sku_path(create_pricing_sku.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end