workarea-api 4.4.6

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

@@ -0,0 +1,121 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class CartsDocumentationTest < DocumentationTest
+        include AuthenticationTest
+        include OrdersTest
+
+        resource 'Cart'
+
+        setup :set_user, :set_product, :set_order
+
+        def set_user
+          @user = create_user(first_name: 'Susan', last_name: 'Baker')
+          @auth = @user.authentication_tokens.create!
+        end
+
+        def set_product
+          @product = create_product(
+            id: 'VINTEE',
+            name: 'Vintage Tee',
+            variants: [
+              { sku: 'VT001', regular: 5.to_m },
+              { sku: 'VT002', regular: 6.to_m }
+            ]
+          )
+
+          create_inventory(id: 'VT001', policy: 'standard', available: 2)
+        end
+
+        def set_order
+          @order = create_order(user_id: @user.id)
+          add_item(@order, product_id: @product.id, sku: 'VT001', quantity: 2)
+        end
+
+        def test_and_document_listing_carts
+          description "Listing user's carts"
+          route storefront_api.carts_path
+          explanation <<-EOS
+            You can get a listing of all of a user's open carts with this
+            endpoint. There will usually be one from the standard storefront,
+            but with the cart creation endpoint there is the potential to create
+            and manage multiple carts for a single user.
+          EOS
+
+          record_request do
+            get storefront_api.carts_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_creating_a_guest_cart
+          description 'Creating a new guest cart'
+          route storefront_api.carts_path
+          explanation <<-EOS
+            Use this endpoint to create a cart. This allows the possibility of
+            multiple carts for a user.
+          EOS
+
+          record_request do
+            post storefront_api.carts_path
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_creating_a_logged_in_cart
+          description 'Creating a new cart for a user'
+          route storefront_api.carts_path
+          explanation <<-EOS
+            Here's how to create a cart for a user. This endpoint allows the
+            possibility of multiple carts for a user.
+          EOS
+
+          record_request do
+            post storefront_api.carts_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_showing_a_cart
+          description 'Showing cart'
+          route storefront_api.cart_path(':id')
+          explanation <<-EOS
+            This will get details on a cart you've created with the cart
+            creation endpoint.
+          EOS
+
+          record_request do
+            get storefront_api.cart_path(@order),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_adding_a_promo_code
+          description 'Adding a promo code'
+          route storefront_api.add_promo_code_to_cart_path(':id')
+          explanation 'This endpoint will add promo codes to the cart'
+
+          create_order_total_discount(promo_codes: %w(10OFF))
+
+          record_request do
+            post storefront_api.add_promo_code_to_cart_path(@order),
+              as: :json,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              params: { promo_code: '10OFF' }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,90 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class CategoriesDocumentationTest < DocumentationTest
+        resource 'Categories'
+
+        setup :set_product
+        setup :set_category
+        setup :set_taxonomy
+        setup :set_content
+
+        def set_product
+          @product = create_product(
+            name: 'Sweet Shirt',
+            filters:  { size: %w[Small Medium Large], color: 'Blue' },
+            variants: [{ sku: 'SKU', details: { color: 'Blue' }, regular: 2.to_m }],
+            details: { size: 'Small', color: 'Red' },
+            images: [{ image: product_image_file, option: 'Blue' }]
+          )
+        end
+
+        def set_category
+          @category = create_category(
+            name: 'Shirts',
+            product_ids: [@product.id],
+            terms_facets: %w(Size Color)
+          )
+        end
+
+        def set_taxonomy
+          first_level = create_taxon(name: 'Mens')
+          @taxon = first_level.children.create!(navigable: @category)
+        end
+
+        def set_content
+          content = Content.for(@category)
+          content.blocks.build(
+            area: :above_results,
+            type: :text,
+            data: { text: 'text' }
+          )
+          content.blocks.build(
+            area: :below_results,
+            type: :text,
+            data: { text: 'text' }
+          )
+          content.save!
+        end
+
+        def test_and_document_index
+          description 'Showing a listing of categories'
+          route storefront_api.categories_path
+          parameter 'page', 'Page number'
+          explanation <<-EOS
+            This endpoint will give you a paginated list of all active
+            categories, that is, all categories that could be shown on the
+            storefront.
+          EOS
+
+          create_category(name: 'Pants')
+
+          record_request do
+            get storefront_api.categories_path(page: '1')
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing a category'
+          route storefront_api.category_path(':slug')
+          parameter 'sort', 'Sort by'
+          parameter 'page', 'Page number'
+          parameter ':facet_name', 'Each facet setup on the category will have a corresponding parameter'
+          explanation <<-EOS
+            This endpoint includes everything you need to render a category,
+            including any associated content, products, and filters.
+          EOS
+
+          record_request do
+            get storefront_api.category_path(@category, page: '1', sort: 'price_desc')
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class CheckoutsDocumentationTest < DocumentationTest
+        include OrdersTest
+
+        resource 'Checkout'
+
+        setup :set_product, :set_order, :set_checkout_data
+
+        def set_product
+          @product = create_product(
+            id: 'VINTEE',
+            name: 'Vintage Tee',
+            variants: [
+              { sku: 'VT001', regular: 5.to_m },
+              { sku: 'VT002', regular: 6.to_m }
+            ]
+          )
+
+          create_inventory(id: 'VT001', policy: 'standard', available: 2)
+        end
+
+        def set_order
+          @order = create_order(email: 'sbaker@workarea.com')
+          add_item(@order, product_id: @product.id, sku: 'VT001', quantity: 2)
+        end
+
+        def set_checkout_data
+          create_shipping_service(name: 'Standard', rates: [{ price: 5.to_m }])
+          create_shipping_service(name: 'Express', rates: [{ price: 10.to_m }])
+          create_shipping_service(name: 'Overnight', rates: [{ price: 20.to_m }])
+        end
+
+        def address
+          {
+            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_document_show
+          description 'Showing a checkout'
+          route storefront_api.checkout_path(':id')
+          explanation <<-EOS
+            This will give you overview of the state of checkout for the
+            associated order ID. It includes full order information, as well
+            as summary information for each step of checkout.
+          EOS
+
+          record_request do
+            get storefront_api.checkout_path(@order)
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_update
+          description 'Updating a checkout'
+          route storefront_api.checkout_path(':id')
+          explanation <<-EOS
+            Use this endpoint to make updates to checkout. This will typically
+            mean setting addresses and shipping options for the checkout.
+          EOS
+
+          record_request do
+            patch storefront_api.checkout_path(@order),
+              as: :json,
+              params: {
+                email: 'susanb@workarea.com',
+                shipping_address: address,
+                billing_address: address,
+                shipping_service: 'Express'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_complete
+          description 'Completing a checkout'
+          route storefront_api.complete_checkout_path(':id')
+          explanation <<-EOS
+            This endpoint completes checkout and places the order. Payment
+            tender information is required at this point, and should be included
+            with this request.
+          EOS
+
+          patch storefront_api.checkout_path(@order),
+            as: :json,
+            params: {
+              email: 'susanb@workarea.com',
+              shipping_address: address,
+              billing_address: address,
+              shipping_service: 'Express'
+            }
+
+          order = JSON.parse(response.body)['order']
+
+          record_request do
+            post storefront_api.complete_checkout_path(order['id']),
+              as: :json,
+              params: {
+                payment: 'new_card',
+                credit_card: {
+                  number: '4111111111111111',
+                  month: '3',
+                  year: Time.now.year + 2,
+                  cvv: '123'
+                }
+              }
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_reset
+          description 'Showing a checkout'
+          route storefront_api.reset_checkout_path(':id')
+          explanation <<-EOS
+            This endpoint resets the checkout by wiping all private information
+            from the order and it's associated models. Use it for handling
+            timeouts, logouts, and any other situation where you want to ensure
+            the safety of the customer's information.
+          EOS
+
+          record_request do
+            get storefront_api.reset_checkout_path(@order)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class ContactsDocumentationTest < DocumentationTest
+        resource 'Contacts'
+
+        setup :set_contact_params
+
+        def set_contact_params
+          @contact_params = {
+            name: 'Name',
+            email: 'email@example.com',
+            order_id: 'OrderID',
+            subject: :orders,
+            message: 'Message'
+          }
+        end
+
+        def test_and_document_create
+          description 'Creating a contact'
+          route storefront_api.contacts_path
+          explanation <<-EOS
+            This endpoints creates a customer service inquiry on behalf of the
+            customer, and will send an email to the address in
+            Workarea.config.email_to
+          EOS
+
+          record_request do
+            post storefront_api.contacts_path, params: @contact_params, as: :json
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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