workarea-api-storefront 4.4.6

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

@@ -0,0 +1,53 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class EmailSignupsDocumentationTest < DocumentationTest
+        resource 'Email Signups'
+
+        setup :set_content
+
+        def set_content
+          page = Workarea::Storefront::EmailSignupsViewModel.new
+          page.content.blocks.create!(
+            type: :text,
+            data: { text: 'Here is some administrated content' }
+          )
+        end
+
+        def test_and_document_show
+          description 'Showing an email signup content'
+          route storefront_api.email_signups_path
+          explanation <<-EOS
+            This endpoint will return all relevant data for showing an email
+            sign up form.
+          EOS
+
+          record_request do
+            get storefront_api.email_signups_path
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_create
+          description 'Creating an email signup'
+          route storefront_api.email_signups_path
+          explanation <<-EOS
+            Use this endpoint to create an email signup. This will usually be
+            forwarded to an Email Service Provider, but Workarea will keep a
+            record of it just in case.
+          EOS
+
+          record_request do
+            post storefront_api.email_signups_path,
+              as: :json,
+              params: { email: 'email@example.com' }
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/storefront/menus_documentation_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class MenusDocumentationTest < DocumentationTest
+        resource 'Menus'
+
+        setup :set_navigation_menu
+
+        def set_navigation_menu
+          @menus = ['Men', 'Women', 'Children'].map do |name|
+            first_level = create_taxon(
+              name: name,
+              url: "http://example.com/#{name.downcase}"
+            )
+
+            second_level = first_level.children.create!(name: 'Sale')
+
+            menu = create_menu(taxon: first_level)
+
+            content = Content.for(menu)
+            content.blocks.create!(
+              type: 'taxonomy',
+              data: { 'start' => second_level.id }
+            )
+
+            menu
+          end
+        end
+
+        def test_and_document_index
+          description 'Listing menus'
+          route storefront_api.menus_path
+          explanation <<-EOS
+            In the base HTML storefront, menus are used as the primary top-level
+            navigation entry points. Each menu has associated content (composed
+            of content blocks) that represent the navigation to be display when
+            that menu is selected (usually a hover or a click on a mobile
+            device). Each menu points at a particular spot in the taxonomy.
+          EOS
+
+          record_request do
+            get storefront_api.menus_path
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a menu'
+          route storefront_api.menu_path(':id')
+          explanation <<-EOS
+            This endpoint will return all the data used to render a menu. This
+            includes the corresponding content, as well a link to where the
+            menu points at in the taxonomy.
+          EOS
+
+          record_request do
+            get storefront_api.menu_path(@menus.first)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,127 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class OrdersDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Orders'
+
+        setup :set_user
+        setup :set_order
+
+        def set_user
+          @user = create_user(
+            email: 'sbaker@workarea.com',
+            first_name: 'Susan',
+            last_name: 'Baker'
+          )
+        end
+
+        def set_order
+          @order ||= begin
+            order = Order.new(user_id: @user.id, email: @user.email)
+
+            product = create_product(
+              name: 'Product One',
+              variants: [{ sku: 'PROD1', regular: 5.to_m }]
+            )
+            order.add_item(product_id: product.id, sku: 'PROD1', quantity: 2)
+
+            product = create_product(
+              name: 'Product Two',
+              variants: [{ sku: 'PROD2', regular: 10.to_m }]
+            )
+            order.add_item(product_id: product.id, sku: 'PROD2', quantity: 1)
+
+            product = create_product(
+              name: 'Product Three',
+              variants: [{ sku: 'PROD3', regular: 20.to_m }]
+            )
+            order.add_item(
+              product_id: product.id,
+              sku: 'PROD3',
+              quantity: 1,
+              customizations: { 'foo' => 'bar' }
+            )
+
+            address = {
+              first_name: 'Susan',
+              last_name: 'Baker',
+              street: '350 Fifth Avenue',
+              city: 'New York',
+              region: 'NY',
+              country: 'US',
+              postal_code: '10118',
+              phone_number: '6465552390'
+            }
+
+            complete_checkout(
+              order,
+              shipping_address: address,
+              billing_address: address,
+              shipping_service: create_shipping_service(name: 'Express').name,
+              credit_card: {
+                number: '4111111111111111',
+                month: '3',
+                year: Time.now.year + 2,
+                cvv: '123'
+              }
+            )
+
+            fulfillment = Fulfillment.find(order.id)
+            fulfillment.ship_items(
+              '1Z',
+              [{ 'id' => order.items.first.id, 'quantity' => 2 }]
+            )
+
+            fulfillment.cancel_items(
+              [{ 'id' => order.items.second.id, 'quantity' => 1 }]
+            )
+
+            order
+          end
+        end
+
+        def test_and_show_index_of_orders
+          description "Listing the user's orders"
+          route storefront_api.orders_path
+          explanation <<-EOS
+            This endpoints returns recently placed orders for a customer. Use it
+            for showing an order history for the customer.
+          EOS
+
+          auth = @user.authentication_tokens.create!
+
+          record_request do
+            get storefront_api.orders_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show_a_single_order
+          description 'Showing an order'
+          route storefront_api.order_path(':id')
+          explanation <<-EOS
+            This endpoint returns everything needed to render an order for a
+            customer's order history including order details and fulfillment
+            status.
+          EOS
+
+          auth = @user.authentication_tokens.create!
+
+          record_request do
+            get storefront_api.order_path(@order),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class PagesDocumentationTest < DocumentationTest
+        resource 'Pages'
+
+        setup :set_page
+        setup :set_taxonomy
+        setup :set_content
+
+        def set_page
+          @page = create_page(name: 'Summer Lookbook')
+        end
+
+        def set_taxonomy
+          first_level = create_taxon(
+            name: 'Women',
+            url: "#{Workarea.config.host}/women"
+          )
+
+          @taxon = first_level.children.create!(navigable: @page)
+        end
+
+        def set_content
+          content = Content.for(@page)
+          content.blocks.create!(
+            area: :default,
+            type: :text,
+            data: { text: 'Great new looks for summer' }
+          )
+          content.blocks.create!(
+            area: :default,
+            type: :image,
+            data: { image: asset.id.to_s, alt: 'splash' }
+          )
+          content.blocks.create!(
+            area: :default,
+            type: :text,
+            data: { text: 'Pool party fashion' }
+          )
+        end
+
+        def asset
+          @asset ||= create_asset(name: 'Splash')
+        end
+
+        def test_and_document_show
+          description 'Showing a page'
+          route storefront_api.page_path(':slug')
+          explanation <<-EOS
+            This endpoint will return all relevant data for showing a content
+            page.
+          EOS
+
+          record_request do
+            get storefront_api.page_path(@page)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/storefront/password_resets_documentation_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class PasswordResetsDocumentationTest < DocumentationTest
+        resource 'Password Resets'
+
+        def test_and_document_create
+          description 'Sending a forgot password email'
+          route storefront_api.password_resets_path
+          explanation <<-EOS
+            This will send a password reset email to the email address if there
+            is an account. The email will contain a link to the site where the
+            password reset can be completed.
+          EOS
+
+          record_request do
+            post storefront_api.password_resets_path,
+              as: :json,
+              params: { email: create_user.email }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class ProductsDocumentationTest < DocumentationTest
+        resource 'Products'
+
+        setup :set_product
+
+        def set_product
+          @product = create_product(
+            name: 'Nice Shirt',
+            filters:  { size: %w[Small Medium Large], color: 'Blue' },
+            variants: [{ sku: 'SKU1', details: { color: 'Blue' }, regular: 2.to_m },
+                       { sku: 'SKU2', details: { color: 'Red' }, regular: 3.to_m }],
+            details: { size: 'Small', color: 'Red' },
+            images: [{ image: product_image_file, option: 'Blue' }]
+          )
+
+          # for recommendations
+          create_product(
+            name: 'Fall Jacket',
+            filters:  { size: %w[Small Medium Large], color: 'Blue' },
+            variants: [{ sku: 'SKU1', details: { color: 'Blue' }, regular: 2.to_m }],
+            details: { size: 'Small' },
+            images: [{ image: product_image_file, option: 'Blue' }]
+          )
+        end
+
+        def test_and_document_show
+          description 'Showing a product'
+          route storefront_api.product_path(':slug')
+          explanation <<-EOS
+            This endpoint includes everything you need to render a product
+            detail page including, variants, images, and recommendations.
+          EOS
+
+          record_request do
+            get storefront_api.product_path(@product)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show_with_sku_param
+          description 'Showing a product with a specific SKU selected'
+          route storefront_api.product_path(':slug')
+          parameter 'sku', 'View products details specifically for this SKU'
+          explanation <<-EOS
+            This demonstrates how to get product details for a specific SKU.
+            This will result in pricing, inventory, and images to match the
+            storefront logic for that SKU.
+          EOS
+
+          record_request do
+            get storefront_api.product_path(@product, sku: 'SKU2')
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/storefront/recent_views_documentation_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class RecentViewsDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Recent views'
+
+        def test_and_document_updating_with_authentication
+          description 'Updating recent views with authentication'
+          route storefront_api.recent_views_path
+          explanation <<-EOS
+            Use this endpoint like this to keep a accurate list of recent
+            activity by the authenticated customer. Each of the three resources
+            being tracked (products, categories, searches) are optional.
+          EOS
+
+          user = create_user
+          auth = user.authentication_tokens.create!
+
+          record_request do
+            patch storefront_api.recent_views_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) },
+              as: :json,
+              params: {
+                product_id: '367A8BB9B5',
+                category_id: '596e739b021823358aabe9df',
+                search: 'shirts'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_updating_by_session_id
+          description 'Updating recent views with a session_id'
+          route storefront_api.recent_views_path
+          parameter 'session_id', 'A unique session_id you keep for an anonymous browser'
+          explanation <<-EOS
+            You can also use this endpoint to maintain a recent activity for an
+            anonymous browser. Use a consistent session_id to maintain
+            continuity.
+          EOS
+
+          record_request do
+            patch storefront_api.recent_views_path,
+              as: :json,
+              params: {
+                session_id: ':session_id',
+                product_id: '367A8BB9B5',
+                category_id: '596e739b021823358aabe9df',
+                search: 'shirts'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_showing_by_authentication
+          description 'Showing recent views from authentication'
+          route storefront_api.recent_views_path
+          explanation <<-EOS
+            Display recent views based on the currently authenticated customer.
+          EOS
+
+          user = create_user
+          auth = user.authentication_tokens.create!
+
+          product = create_product(name: 'Cool Shirt')
+          category = create_category(name: 'Shirts')
+          activity = create_user_activity(
+            product_ids: [product.id],
+            category_ids: [category.id],
+            searches: ['shirt']
+          )
+
+          record_request do
+            get storefront_api.recent_views_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_showing_by_session_id
+          description 'Showing recent views with a session_id'
+          route storefront_api.recent_views_path
+          parameter 'session_id', 'A unique session_id you keep for an anonymous browser'
+          explanation <<-EOS
+            Display recent views based on a session_id you've kept for an
+            anonymous browser (as opposed to displaying them based on
+            authentication).
+          EOS
+
+          product = create_product(name: 'Cool Shirt')
+          category = create_category(name: 'Shirts')
+          activity = create_user_activity(
+            product_ids: [product.id],
+            category_ids: [category.id],
+            searches: ['shirt']
+          )
+
+          record_request do
+            get storefront_api.recent_views_path,
+              params: { session_id: activity.id }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/documentation/workarea/api/storefront/recommendations_documentation_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class RecommendationsDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Personalized Recommendations'
+
+        setup :set_auth
+        setup :set_products
+        setup :set_user_activity
+
+        def set_auth
+          user = create_user
+          @auth = user.authentication_tokens.create!
+        end
+
+        def set_products
+          10.times { create_product }
+
+          top_products = Catalog::Product.sample(10).map { |p| { 'product_id' => p.id } }
+          create_top_products(results: top_products)
+        end
+
+        def set_user_activity
+          @activity = create_user_activity
+        end
+
+        def test_and_document_showing_by_authentication
+          description 'Showing recommendations with authentication'
+          route storefront_api.recommendations_path
+          explanation <<-EOS
+            Display personalized recommendations based on the currently
+            authenticated customer.
+          EOS
+
+          record_request do
+            get storefront_api.recommendations_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_showing_by_session_id
+          description 'Showing recommendations with a session ID'
+          route storefront_api.recommendations_path
+          parameter 'session_id', 'A unique session_id you keep for an anonymous browser'
+          explanation <<-EOS
+            Display personalized recommendations based on a session ID that
+            you've maintained for an anonymous browser (as opposed to
+            authentication).
+          EOS
+
+          record_request do
+            get storefront_api.recommendations_path,
+              params: { session_id: @activity.id }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end