workarea-api 4.4.6

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

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

@@ -0,0 +1,129 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class SavedAddressesDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Saved Addresses'
+
+        setup :set_user
+        setup :set_address
+
+        def set_user
+          @user = create_user(first_name: 'Susan', last_name: 'Baker')
+          @auth = @user.authentication_tokens.create!
+        end
+
+        def set_address
+          @address = @user.addresses.create!(
+            first_name: 'Susan',
+            last_name: 'Baker',
+            street: '350 Fifth Avenue',
+            city: 'New York',
+            region: 'NY',
+            country: 'US',
+            postal_code: '10118',
+            phone_number: '6465552390'
+          )
+        end
+
+        def test_and_show_index_of_addresses
+          @user.addresses.create!(
+            first_name: 'Susan',
+            last_name: 'Baker',
+            street: '4059 Mt Lee Dr.',
+            city: 'Hollywood',
+            region: 'CA',
+            country: 'US',
+            postal_code: '90068',
+            phone_number: '7545552390'
+          )
+
+          description "Listing the user's saved addresses"
+          route storefront_api.saved_addresses_path
+          explanation <<-EOS
+            List a customer's saved addresses. Useful for account management and
+            for using saved addresses in checkout.
+          EOS
+
+          record_request do
+            get storefront_api.saved_addresses_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show_a_single_address
+          description 'Showing a saved address'
+          route storefront_api.saved_address_path(':id')
+
+          record_request do
+            get storefront_api.saved_address_path(@address),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_creating_a_new_address
+          description 'Creating a saved address'
+          route storefront_api.saved_addresses_path
+
+          record_request do
+            post storefront_api.saved_addresses_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              as: :json,
+              params: {
+                first_name: 'Susan',
+                last_name: 'Baker',
+                street: '4059 Mt Lee Dr.',
+                city: 'Hollywood',
+                region: 'CA',
+                country: 'US',
+                postal_code: '90068',
+                phone_number: '7545552390'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_updating_an_address
+          description 'Updating a saved address'
+          route storefront_api.saved_address_path(':id')
+
+          record_request do
+            patch storefront_api.saved_address_path(@address),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              as: :json,
+              params: {
+                street: '4059 Mt Lee Dr.',
+                city: 'Hollywood',
+                region: 'CA',
+                postal_code: '90068',
+                phone_number: '7545552390'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_deleting_an_address
+          description 'Deleting a saved address'
+          route storefront_api.saved_address_path(':id')
+
+          record_request do
+            delete storefront_api.saved_address_path(@address),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,129 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class SavedCreditCardsDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Saved Credit Cards'
+
+        setup :set_user
+        setup :set_payment_profile
+        setup :set_credit_card
+
+        def set_user
+          @user = create_user(first_name: 'Susan', last_name: 'Baker')
+          @auth = @user.authentication_tokens.create!
+        end
+
+        def set_payment_profile
+          @payment_profile = Payment::Profile.lookup(
+            PaymentReference.new(@user)
+          )
+        end
+
+        def set_credit_card
+          @credit_card = @payment_profile.credit_cards.create!(
+            number: '4012888888881881',
+            first_name: 'Susan',
+            last_name: 'Baker',
+            month: '3',
+            year: (Time.now.year + 4).to_s,
+            cvv: '999'
+          )
+        end
+
+        def test_and_show_index_of_credit_cards
+          @payment_profile.credit_cards.create!(
+            number: '4111111111111111',
+            first_name: 'Susan',
+            last_name: 'Baker',
+            month: '7',
+            year: (Time.now.year + 5).to_s,
+            cvv: '999'
+          )
+
+          description 'Listing the user\'s saved credit cards'
+          route storefront_api.saved_credit_cards_path
+          explanation <<-EOS
+            List a customer's saved addresses. Useful for account management.
+            These addresses will be available to the customer in an
+            authenticated checkout.
+          EOS
+
+          record_request do
+            get storefront_api.saved_credit_cards_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show_a_single_credit_card
+          description 'Showing a saved credit card'
+          route storefront_api.saved_credit_card_path(':id')
+
+          record_request do
+            get storefront_api.saved_credit_card_path(@credit_card),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_creating_a_new_credit_card
+          description 'Creating a saved credit card'
+          route storefront_api.saved_credit_cards_path
+
+          record_request do
+            post storefront_api.saved_credit_cards_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              as: :json,
+              params: {
+                number: '4111111111111111',
+                first_name: 'Susan',
+                last_name: 'Baker',
+                month: '7',
+                year: (Time.now.year + 5).to_s,
+                cvv: '123'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_updating_an_credit_card
+          description 'Updating a saved credit card'
+          route storefront_api.saved_credit_card_path(':id')
+
+          record_request do
+            patch storefront_api.saved_credit_card_path(@credit_card),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              as: :json,
+              params: {
+                month: '7',
+                year: (Time.now.year + 5).to_s,
+                cvv: '123'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_deleting_an_credit_card
+          description 'Deleting a saved credit card'
+          route storefront_api.saved_credit_card_path(':id')
+
+          record_request do
+            delete storefront_api.saved_credit_card_path(@credit_card),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(204, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class SearchesDocumentationTest < DocumentationTest
+        resource 'Searches'
+
+        setup :set_content
+
+        def set_content
+          @content = Content.for('search')
+          @content.blocks.create!(
+            area: :results,
+            type: :text,
+            data: { text: 'Huzzah! Your search results are below!' }
+          )
+          @content.blocks.create!(
+            area: :no_results,
+            type: :text,
+            data: { text: 'Sorry, we can\'t find what you searched for!' }
+          )
+        end
+
+        def test_and_document_autocomplete
+          description 'Showing search autocomplete suggestions'
+          route storefront_api.searches_path
+          explanation <<-EOS
+            This list will be based on popular search terms and matching
+            products, categories, etc. Useful for showing a autocomplete
+            drop-down as a customer types in a search bar.
+          EOS
+
+          create_product(name: 'Red Product')
+          create_category(name: 'Red Category')
+          create_page(name: 'Page about Red Products')
+
+          Metrics::SearchByDay.save_search('red', 3)
+          travel_to 1.weeks.from_now
+          GenerateInsights.generate_all!
+          BulkIndexSearches.perform
+          travel_back
+
+          record_request do
+            get storefront_api.searches_path(q: 'red')
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing search results'
+          route storefront_api.search_path
+          parameter 'q', 'The search query string entered by the customer'
+          parameter 'sort', 'Sort by'
+          parameter 'page', 'Page number'
+          parameter ':facet_name', 'Each facet setup on search settings will have a corresponding parameter'
+          explanation <<-EOS
+            This endpoint returns everything you'll need to show search results
+            to customers. This includes products, filters, and any content
+            that's been setup by an administrator.
+          EOS
+
+          create_product(
+            id: 'PRODUCT1',
+            name: 'Pretty Nice Shirt',
+            filters:  { 'Size' => %w[Small Medium Large], 'Color' => 'Blue' },
+            variants: [{ sku: 'SKU', regular: 35.to_m }],
+            images: [{ image: product_image_file, option: 'Blue' }]
+          )
+
+          create_product(
+            id: 'PRODUCT2',
+            name: 'Great Pants',
+            filters:  { 'Size' => %w[Small Medium Large], 'Color' => 'Brown' },
+            variants: [{ sku: 'SKU', regular: 50.to_m }],
+            images: [{ image: product_image_file, option: 'Brown' }]
+          )
+
+          record_request do
+            get storefront_api.search_path(q: 'large', page: '1', sort: 'price_desc')
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end