workarea-api-storefront 4.4.6

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

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

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class SystemContentDocumentationTest < DocumentationTest
+        resource 'System Content'
+
+        def test_and_document_show_home_page
+          description 'Showing the home page'
+          route storefront_api.system_content_path('home_page')
+          explanation <<-EOS
+            This endpoint returns everything you'll need to render the home
+            page.
+          EOS
+
+          content = Content.for('Home Page')
+          content.blocks.create!(
+            area: :default,
+            type: :text,
+            data: { text: 'Summer is here!' }
+          )
+          content.blocks.create!(
+            area: :default,
+            type: :text,
+            data: { text: 'Get 20% off all swimwear' }
+          )
+
+          record_request do
+            get storefront_api.system_content_path('home_page')
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_show
+          description 'Showing system content'
+          route storefront_api.system_content_path(':name')
+          explanation <<-EOS
+            System content is content for an area of site not configured by the
+            CMS. Examples would be content for the cart page, content for
+            checkout, site layout content, etc. The home page is also an example
+            of system content and shown in a separate example.
+          EOS
+
+          content = Content.for('Layout')
+          content.blocks.create!(
+            area: :header_promo,
+            type: :text,
+            data: { text: 'Don\'t miss our sizzling summer deals!' }
+          )
+          content.blocks.create!(
+            area: :footer_navigation,
+            type: :text,
+            data: { text: 'Be the first to received our exclusive discounts' }
+          )
+
+          record_request do
+            get storefront_api.system_content_path('layout')
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class TaxonsDocumentationTest < DocumentationTest
+        resource 'Taxons'
+
+        setup :set_taxons
+
+        def set_taxons
+          @taxon = create_taxon(
+            name: 'Mens',
+            url: 'http://example.com/pages/mens'
+          )
+
+          @taxon.children.create!(name: 'Sale')
+        end
+
+        def test_and_document_show
+          description 'Showing a taxon'
+          route storefront_api.taxon_path(':id')
+          explanation <<-EOS
+            This endpoint will show details on a particular node (or taxon) of
+            the site taxonomy, along with its children.
+          EOS
+
+          record_request do
+            get storefront_api.taxon_path(@taxon)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class ValidationDocumentationTest < DocumentationTest
+        include OrdersTest
+
+        resource 'Validation Errors'
+
+        def test_showing_validation_errors
+          description 'General validation errors'
+          route storefront_api.account_path
+          explanation <<-EOS
+            This demonstrates API responses when invalid data is submitted.
+          EOS
+
+          record_request do
+            post storefront_api.account_path,
+              as: :json,
+              params: { email: 'bob@', password: '' }
+
+            assert_equal(422, response.status)
+          end
+        end
+
+        def test_checkout_validation_errors
+          description 'Checkout validation errors'
+          route storefront_api.checkout_path(':id')
+          explanation <<-EOS
+            Due to the more complex nature of checkout updates and data,
+            checkout validation errors are returned inline with the resource
+            they are coming from as shown below. Note the response status can be
+            200 OK, due to some data being persisted properly.
+          EOS
+
+          product = create_product(
+            id: 'VINTEE',
+            name: 'Vintage Tee',
+            variants: [
+              { sku: 'VT001', regular: 5.to_m },
+              { sku: 'VT002', regular: 6.to_m }
+            ]
+          )
+
+          order = create_order(email: 'sbaker@workarea.com')
+          add_item(order, product_id: product.id, sku: 'VT001', quantity: 2)
+
+          record_request do
+            patch storefront_api.checkout_path(order),
+              as: :json,
+              params: {
+                email: 'susanb@',
+                shipping_address: {
+                  first_name: '',
+                  last_name: 'Baker',
+                  street: '350 Fifth Avenue',
+                  city: 'New York',
+                  region: 'NY',
+                  country: 'US',
+                  postal_code: '10118'
+                },
+                billing_address: {
+                  first_name: 'Susan',
+                  last_name: 'Baker',
+                  street: '',
+                  city: 'New York',
+                  region: 'NY',
+                  country: 'US',
+                  postal_code: '10118'
+                }
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,4 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/mailers/application_mailer.rb

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/test/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run