workarea-api 4.4.6

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

@@ -0,0 +1,101 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class ProductImagesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Product Images'
+
+        def product
+          @product ||= create_product
+        end
+
+        def base_64
+          'data:image/jpeg;base64,GEGseg42g3g...'
+        end
+
+        def url
+          'http://dreamatico.com/data_images/kitten/kitten-2.jpg'
+        end
+
+        def sample_attributes
+          { image_url: base_64 }
+        end
+
+        def create_image
+          product.images.create!(sample_attributes)
+        end
+
+        def test_and_document_index
+          description 'Listing product images'
+          route admin_api.product_images_path(':product_id')
+
+          2.times { create_image }
+
+          record_request do
+            get admin_api.product_images_path(product.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create_from_url
+          description 'Creating a product image from URL'
+          route admin_api.product_images_path(':product_id')
+
+          record_request do
+            VCR.use_cassette('product_image_from_url') do
+              post admin_api.product_images_path(product.id),
+                    params: { image: { image_url: url } },
+                    as: :json
+            end
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_create_from_base_64
+          description 'Creating a product image from Base64'
+          route admin_api.product_images_path(':product_id')
+
+          record_request do
+            post admin_api.product_images_path(product.id),
+                  params: { image: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a product image'
+          route admin_api.product_image_path(':product_id', ':id')
+
+          image = create_image
+
+          record_request do
+            patch admin_api.product_image_path(product.id, image.id),
+                    params: { image: { name: 'foo' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a product image'
+          route admin_api.product_image_path(':product_id', ':id')
+
+          image = create_image
+
+          record_request do
+            delete admin_api.product_image_path(product.id, image.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class ProductsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Products'
+
+        def sample_attributes
+          create_product.as_json.except('_id', 'slug', 'last_indexed_at')
+        end
+
+        def test_and_document_index
+          description 'Listing products'
+          route admin_api.products_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_product }
+
+          record_request do
+            get admin_api.products_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 product'
+          route admin_api.products_path
+
+          record_request do
+            post admin_api.products_path, params: sample_attributes, as: :json
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a product'
+          route admin_api.product_path(':id')
+
+          product = create_product
+
+          record_request do
+            get admin_api.product_path(product.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a product'
+          route admin_api.product_path(':id')
+
+          product = create_product
+
+          record_request do
+            patch admin_api.product_path(product.id),
+                    params: sample_attributes,
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting products'
+          route admin_api.bulk_products_path
+
+          record_request do
+            patch admin_api.bulk_products_path,
+                    params: { products: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a product'
+          route admin_api.product_path(':id')
+
+          product = create_product
+
+          record_request do
+            delete admin_api.product_path(product.id), as: :json
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class PromoCodeListsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Promo Code Lists'
+
+        def sample_attributes
+          create_code_list.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing promo code lists'
+          route admin_api.promo_code_lists_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_code_list }
+
+          record_request do
+            get admin_api.promo_code_lists_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 promo code list'
+          route admin_api.promo_code_lists_path
+
+          record_request do
+            post admin_api.promo_code_lists_path,
+                  params: { promo_code_list: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a promo code list'
+          route admin_api.promo_code_list_path(':id')
+
+          record_request do
+            get admin_api.promo_code_list_path(create_code_list.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a promo code list'
+          route admin_api.promo_code_list_path(':id')
+
+          record_request do
+            patch admin_api.promo_code_list_path(create_code_list.id),
+                    params: { promo_code_list: { name: 'foo' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting promo code lists'
+          route admin_api.bulk_promo_code_lists_path
+
+          record_request do
+            patch admin_api.bulk_promo_code_lists_path,
+                    params: { promo_code_lists: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a promo code list'
+          route admin_api.promo_code_list_path(':id')
+
+          record_request do
+            delete admin_api.promo_code_list_path(create_code_list.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class RecommendationSettingsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Recommendation Settings'
+
+        def test_and_document_show
+          description 'Showing recommendation settings'
+          route admin_api.product_recommendation_settings_path(':product_id')
+
+          record_request do
+            get admin_api.product_recommendation_settings_path(create_recommendations.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating recommendation settings'
+          route admin_api.product_recommendation_settings_path(':product_id')
+
+          record_request do
+            patch admin_api.product_recommendation_settings_path(create_recommendations.id),
+                  params: { recommendation_settings: { product_ids: ['foo'] } },
+                  as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,96 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class RedirectsDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Redirects'
+
+        def sample_attributes
+          @sample_attributes ||= create_redirect.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing redirects'
+          route admin_api.redirects_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_redirect(path: "/#{i}") }
+
+          record_request do
+            get admin_api.redirects_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 redirect'
+          route admin_api.redirects_path
+
+          record_request do
+            post admin_api.redirects_path,
+                  params: { redirect: sample_attributes.merge('path' => '/foo') },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a redirect'
+          route admin_api.redirect_path(':id')
+
+          record_request do
+            get admin_api.redirect_path(create_redirect.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a redirects'
+          route admin_api.redirect_path(':id')
+
+          record_request do
+            patch admin_api.redirect_path(create_redirect.id),
+                    params: { redirect: { path: '/foobar' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting redirects'
+          route admin_api.bulk_redirects_path
+
+          data = Array.new(3) do
+            count = Navigation::Redirect.count
+            sample_attributes.merge('path' => "/foo#{count}")
+          end
+
+          record_request do
+            patch admin_api.bulk_redirects_path, params: { redirects: data }, as: :json
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a redirect'
+          route admin_api.redirect_path(':id')
+
+          record_request do
+            delete admin_api.redirect_path(create_redirect.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class ReleaseChangesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Release Changes'
+
+        def test_and_document_create
+          description 'Adding changes to a release'
+          route admin_api.product_path(':id')
+          explanation "release_id can be sent with any patch request \
+            to resources that can be changed through releases"
+
+          record_request do
+            patch admin_api.product_path(create_product.id),
+                    params: {
+                      product: { name: 'foo' },
+                      release_id: create_release.id
+                    },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,93 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class ReleasesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Releases'
+
+        def sample_attributes
+          create_release.as_json.except('_id')
+        end
+
+        def test_and_document_index
+          description 'Listing releases'
+          route admin_api.releases_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_release }
+
+          record_request do
+            get admin_api.releases_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 release'
+          route admin_api.releases_path
+
+          record_request do
+            post admin_api.releases_path, params: sample_attributes, as: :json
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a release'
+          route admin_api.release_path(':id')
+
+          record_request do
+            get admin_api.release_path(create_release.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a release'
+          route admin_api.release_path(':id')
+
+          record_request do
+            patch admin_api.release_path(create_release.id),
+                    params: sample_attributes,
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_bulk_upsert
+          description 'Bulk upserting releases'
+          route admin_api.bulk_releases_path
+
+          record_request do
+            patch admin_api.bulk_releases_path,
+                    params: { releases: [sample_attributes] * 3 },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a release'
+          route admin_api.release_path(':id')
+
+          release = create_release
+
+          record_request do
+            delete admin_api.release_path(release.id), as: :json
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,92 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Admin
+      class SavedAddressesDocumentationTest < DocumentationTest
+        include Workarea::Admin::IntegrationTest
+
+        resource 'Saved Addresses'
+
+        def user
+          @user ||= create_user
+        end
+
+        def sample_attributes
+          {
+            first_name: 'Ben',
+            last_name: 'Crouse',
+            street: '22 S. 3rd St.',
+            city: 'Philadelphia',
+            region: 'PA',
+            postal_code: '19106',
+            country: 'US',
+            phone_number: '2159251800'
+          }
+        end
+
+        def create_saved_address
+          @count ||= 0
+          @count += 1
+
+          user.addresses.create!(
+            sample_attributes.merge(street: "#{@count} S 3rd St")
+          )
+        end
+
+        def test_and_document_index
+          description 'Listing saved address'
+          route admin_api.user_saved_addresses_path(':user_id')
+
+          2.times { create_saved_address }
+
+          record_request do
+            get admin_api.user_saved_addresses_path(user.id)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create
+          description 'Creating a saved address'
+          route admin_api.user_saved_addresses_path(':user_id')
+
+          record_request do
+            post admin_api.user_saved_addresses_path(user.id),
+                  params: { saved_address: sample_attributes },
+                  as: :json
+
+            assert_equal(201, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a saved address'
+          route admin_api.user_saved_address_path(':user_id', ':id')
+
+          saved_address = create_saved_address
+
+          record_request do
+            patch admin_api.user_saved_address_path(user.id, saved_address.id),
+                    params: { saved_address: { street: '1 Foobar Lane' } },
+                    as: :json
+
+            assert_equal(204, response.status)
+          end
+        end
+
+        def test_and_document_destroy
+          description 'Removing a saved address'
+          route admin_api.user_saved_address_path(':user_id', ':id')
+
+          saved_address = create_saved_address
+
+          record_request do
+            delete admin_api.user_saved_address_path(user.id, saved_address.id)
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end