workarea-api 4.4.6

data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder

@@ -0,0 +1,8 @@
+json.id @recent_views.id
+json.categories @recent_views.categories do |category|
+  json.partial! 'workarea/api/storefront/categories/category', category: category
+end
+json.products @recent_views.products do |product|
+  json.partial! 'workarea/api/storefront/products/product', product: product
+end
+json.searches @recent_views.searches

data/storefront/app/views/workarea/api/storefront/recommendations/show.json.jbuilder

@@ -0,0 +1,3 @@
+json.products @recommendations.products do |product|
+  json.partial! 'workarea/api/storefront/products/product', product: product
+end

data/storefront/app/views/workarea/api/storefront/saved_addresses/_saved_address.json.jbuilder

@@ -0,0 +1,2 @@
+json.url saved_address_url(address)
+json.partial! 'workarea/api/storefront/shared/address', address: address

data/storefront/app/views/workarea/api/storefront/saved_addresses/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.user_id current_user.id
+json.addresses @addresses do |address|
+  json.partial! 'workarea/api/storefront/saved_addresses/saved_address', address: address
+end

data/storefront/app/views/workarea/api/storefront/saved_addresses/show.json.jbuilder

@@ -0,0 +1,2 @@
+json.user_id current_user.id
+json.partial! 'workarea/api/storefront/saved_addresses/saved_address', address: @address

data/storefront/app/views/workarea/api/storefront/saved_credit_cards/_card.json.jbuilder

@@ -0,0 +1,9 @@
+json.id card.id
+json.url saved_credit_card_url(card)
+json.default card.default?
+json.issuer card.issuer
+json.display_number card.display_number
+json.month card.month
+json.year card.year
+json.first_name card.first_name
+json.last_name card.last_name

data/storefront/app/views/workarea/api/storefront/saved_credit_cards/index.json.jbuilder

@@ -0,0 +1,4 @@
+json.user_id current_user.id
+json.credit_cards @credit_cards do |credit_card|
+  json.partial! 'workarea/api/storefront/saved_credit_cards/card', card: credit_card
+end

data/storefront/app/views/workarea/api/storefront/saved_credit_cards/show.json.jbuilder

@@ -0,0 +1,2 @@
+json.user_id current_user.id
+json.partial! 'workarea/api/storefront/saved_credit_cards/card', card: @credit_card

data/storefront/app/views/workarea/api/storefront/searches/index.json.jbuilder

@@ -0,0 +1 @@
+json.results @results

data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder

@@ -0,0 +1,19 @@
+json.query_string @search.query_string
+json.message @search.message
+json.redirect @search.redirect
+json.sorts @search.sorts
+json.sort @search.sort
+
+json.content_blocks @search.content.blocks do |block|
+  json.partial! 'workarea/api/storefront/content_blocks/block', block: block
+end
+
+json.partial! 'workarea/api/storefront/shared/pagination', model: @search
+
+json.facets @search.facets do |facet|
+  json.partial! "workarea/api/storefront/facets/#{facet.type}", facet: facet
+end
+
+json.products @search.products do |product|
+  json.partial! 'workarea/api/storefront/products/product', product: product
+end

data/storefront/app/views/workarea/api/storefront/shared/_address.json.jbuilder

@@ -0,0 +1,12 @@
+json.id address.id
+json.first_name address.first_name
+json.last_name address.last_name
+json.company address.company
+json.street address.street
+json.street_2 address.street_2
+json.city address.city
+json.country address.country.try(:alpha2)
+json.region address.region
+json.postal_code address.postal_code
+json.phone_number address.phone_number
+json.phone_extension address.phone_extension

data/storefront/app/views/workarea/api/storefront/shared/_pagination.json.jbuilder

@@ -0,0 +1,11 @@
+json.first_page model.first_page?
+json.second_page model.second_page?
+json.last_page model.last_page?
+
+json.page model.page
+json.next_page model.next_page
+json.prev_page model.prev_page
+json.per_page model.per_page
+
+json.total_results model.total
+json.total_pages model.total_pages

data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder

@@ -0,0 +1,12 @@
+json.cache! @content.cache_key, expires_in: 1.hour do
+  json.id @content.id
+  json.name @content.name
+  json.url system_content_url(@content.name)
+
+  json.browser_title @content.browser_title
+  json.meta_description @content.meta_description
+
+  json.content_blocks @content.content.blocks do |block|
+    json.partial! 'workarea/api/storefront/content_blocks/block', block: block
+  end
+end

data/storefront/app/views/workarea/api/storefront/taxons/_taxon.json.jbuilder

@@ -0,0 +1,10 @@
+json.cache! taxon.cache_key, expires_in: 1.day do
+  json.id taxon.id
+  json.url taxon_path(taxon)
+  json.name taxon.name
+  json.depth taxon.depth
+  json.navigable_url taxon.url.presence || storefront_api_url_for(taxon)
+  json.parent_id taxon.parent_id
+  json.parent_ids taxon.parent_ids
+  json.position taxon.position
+end

data/storefront/app/views/workarea/api/storefront/taxons/show.json.jbuilder

@@ -0,0 +1,7 @@
+json.taxon do
+  json.partial! 'workarea/api/storefront/taxons/taxon', taxon: @taxon
+end
+
+json.children @taxon.children.select(&:active?) do |child|
+  json.partial! 'workarea/api/storefront/taxons/taxon', taxon: child
+end

data/storefront/app/workers/workarea/remove_authentication_tokens_on_password_changes.rb

@@ -0,0 +1,19 @@
+module Workarea
+  class RemoveAuthenticationTokensOnPasswordChanges
+    include Sidekiq::Worker
+    include Sidekiq::CallbacksWorker
+
+    sidekiq_options(
+      enqueue_on: {
+        User => [:save],
+        ignore_if: -> { new_record? || changes['password_digest'].blank? },
+        with: -> { [id] }
+      },
+      unique: :until_executing
+    )
+
+    def perform(id)
+      User.find(id).authentication_tokens.destroy_all
+    end
+  end
+end

data/storefront/bin/rails

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/workarea/api/storefront/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'action_mailer/railtie'
+require 'rails/test_unit/railtie'
+require 'sprockets/railtie'
+
+require 'rails/engine/commands'

data/storefront/config/initializers/config.rb

@@ -0,0 +1,2 @@
+Workarea.config.api_product_image_jobs_blacklist ||= %i[convert encode rotate optim avatar thumb]
+Workarea.config.authentication_token_expiration ||= 1.week

data/storefront/config/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  workarea:
+    api:
+      storefront:
+        authentication_tokens:
+          error: Could not find a matching email and password
+          login_locked: This account has been locked for too many login attempts
+        recent_views:
+          missing_id: Recent views endpoints require either authentication or passing in a session_id in the parameters.
+        passwords:
+          error: Could not find a matching email and password
+        recommendations:
+          missing_id: Recommendation endpoints require either authentication or passing in a session_id in the parameters.

data/storefront/config/routes.rb

@@ -0,0 +1,41 @@
+Workarea::Api::Storefront::Engine.routes.draw do
+  resource :account, except: [:new, :edit, :destroy]
+
+  post 'analytics/category_view/:category_id', to: 'analytics#category_view', as: :analytics_category_view
+  post 'analytics/product_view/:product_id', to: 'analytics#product_view', as: :analytics_product_view
+  post 'analytics/search', to: 'analytics#search', as: :analytics_search
+  post 'analytics/search_abandonment', to: 'analytics#search_abandonment', as: :analytics_search_abandonment
+  post 'analytics/filters', to: 'analytics#filters', as: :analytics_filters
+
+  resource :authentication_tokens, only: [:create, :update]
+  resources :assets, only: :show
+  resources :categories, only: [:index, :show]
+  resources :contacts, only: :create
+  resources :orders, only: [:index, :show]
+  resources :pages, only: :show
+  resource :recent_views, only: [:show, :update]
+  resources :saved_addresses, except: [:new, :edit]
+  resources :saved_credit_cards, except: [:new, :edit]
+  resource :search, only: :show
+  resources :searches, only: :index
+  resources :system_content, only: :show
+  resources :menus, only: [:index, :show]
+  resource :email_signups, only: [:show, :create]
+  resources :password_resets, only: :create
+  resources :products, only: :show
+  resource :recommendations, only: :show
+  resources :taxons, only: :show
+
+  resources :carts, only: [:index, :show, :create] do
+    resources :items, only: [:create, :update, :destroy], controller: :cart_items
+    member { post 'add_promo_code', as: :add_promo_code_to }
+  end
+
+  resources :checkouts, only: [:show, :update] do
+    member do
+      get 'start'
+      get 'reset'
+      post 'complete'
+    end
+  end
+end

data/storefront/lib/workarea/api/storefront/engine.rb

@@ -0,0 +1,10 @@
+module Workarea
+  module Api
+    module Storefront
+      class Engine < ::Rails::Engine
+        include Workarea::Plugin
+        isolate_namespace Workarea::Api::Storefront
+      end
+    end
+  end
+end

data/storefront/lib/workarea/api/storefront.rb

@@ -0,0 +1,15 @@
+require 'responders'
+require 'raddocs'
+
+require 'workarea'
+require 'workarea/storefront'
+
+module Workarea
+  module Api
+    module Storefront
+    end
+  end
+end
+
+require 'workarea/api/version'
+require 'workarea/api/storefront/engine'

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

@@ -0,0 +1,70 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class AccountsDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Accounts'
+
+        def test_showing_an_account
+          description 'Getting account details'
+          route storefront_api.account_path
+
+          user = create_user
+          auth = user.authentication_tokens.create!
+
+          record_request do
+            get storefront_api.account_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_creating_an_account
+          description 'Creating an account'
+          route storefront_api.account_path
+          explanation <<-EOS
+            This endpoint does three things: it creates an account, it creates
+            an authentication token, and it sends an account creation email to
+            the customer.
+          EOS
+
+          record_request do
+            post storefront_api.account_path,
+              as: :json,
+              params: {
+                email: 'bob@workarea.com',
+                password: 'areallysecurepassword'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_updating_an_account
+          description 'Updating an account'
+          route storefront_api.account_path
+
+          user = create_user
+          auth = user.authentication_tokens.create!
+
+          record_request do
+            get storefront_api.account_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) },
+              as: :json,
+              params: {
+                email: 'billy@workarea.com',
+                password: 'adifferentbutstillreallysecurepassword'
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class AnalyticsDocumentationTest < DocumentationTest
+        resource 'Analytics'
+
+        def test_and_document_saving_a_category_view
+          description 'saving a category view'
+          route storefront_api.analytics_category_view_path(category_id: ':category_id')
+          explanation 'saving a category view will be reflected in admin reports'
+
+          record_request do
+            post storefront_api.analytics_category_view_path(category_id: '12345')
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_saving_a_product_view
+          description 'saving a product view'
+          route storefront_api.analytics_product_view_path(product_id: ':product_id')
+          explanation 'saving a product view will be reflected in admin reports'
+
+          record_request do
+            post storefront_api.analytics_product_view_path(product_id: '12345')
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_saving_a_search
+          description 'Saving a search'
+          route storefront_api.analytics_search_path
+          explanation <<-EOS
+            Saving a search will be reflected in admin reports. This is intended
+            to be called once per search performed by a customer.
+          EOS
+
+          record_request do
+            post storefront_api.analytics_search_path,
+                  as: :json,
+                  params: { q: 'foo', total_results: 5 }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class AssetsDocumentationTest < DocumentationTest
+        resource 'Assets'
+
+        setup :set_asset
+
+        def set_asset
+          @asset = create_asset(name: 'Summer Sale Callout')
+        end
+
+        def test_and_document_showing_assets
+          description 'Showing an asset'
+          route storefront_api.asset_path(':id')
+          explanation <<-EOS
+            Use this endpoint to look up assets stored in Workarea. Often times
+            these will be referenced in content blocks.
+          EOS
+
+          record_request do
+            get storefront_api.asset_path(@asset)
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class AuthenticationDocumentationTest < DocumentationTest
+        include AuthenticationTest
+
+        resource 'Authentication'
+
+        setup :set_user
+
+        def set_user
+          @user = create_user(password: 'p@assword!')
+        end
+
+        def distance_of_time_in_words(*args)
+          ApplicationController.helpers.distance_of_time_in_words(*args)
+        end
+
+        def test_creating_an_authentication_token
+          description 'Creating an authentication token'
+          route storefront_api.authentication_tokens_path
+          explanation <<-EOS
+            Creating an authentication token is the first step in user
+            authentication. You will use this token to authenticate requests on
+            behalf of the user going forward. To get a token you can use to
+            authenticate an account, use this endpoint. You'll need the email
+            and password from the user, and we'll issue a token that can be used
+            to authenticate further requests for that customer. This token will
+            expire after #{distance_of_time_in_words(Workarea.config.authentication_token_expiration)}.
+            Tokens are also invalidated when a user changes their password. See
+            the "using an authentication token" example for how to use an
+            authentication token.
+          EOS
+
+          record_request do
+            post storefront_api.authentication_tokens_path,
+              params: { email: @user.email, password: 'p@assword!' },
+              as: :json
+
+            assert(response.ok?)
+          end
+        end
+
+        def test_using_an_authentication_token
+          description 'Using an authentication token'
+          route storefront_api.account_path
+          explanation <<-EOS
+            After obtaining an authentication token you can use it to request
+            authenticated endpoints by including it in the Authorization header
+            on the request, as demonstrated in this example.
+          EOS
+
+          auth = @user.authentication_tokens.create!
+
+          record_request do
+            get storefront_api.account_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) }
+
+            assert(response.ok?)
+          end
+        end
+
+        def test_refreshing_an_authentication_token
+          description 'Refreshing an authentication token'
+          route storefront_api.authentication_tokens_path
+          explanation <<-EOS
+            Refreshing an authentication token extends its expiration so that it
+            can continue to be used.
+          EOS
+
+          auth = @user.authentication_tokens.create!
+
+          record_request do
+            patch storefront_api.authentication_tokens_path,
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(auth.token) }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class CartItemsDocumentationTest < 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)
+        end
+
+        def test_and_document_adding_an_item
+          description 'Adding an item'
+          route storefront_api.cart_items_path(':cart_id')
+          explanation <<-EOS
+            Adds an item to the cart. Use the create a cart endpoint to get a
+            cart_id to use with this endpoint.
+          EOS
+
+          record_request do
+            post storefront_api.cart_items_path(@order),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              as: :json,
+              params: {
+                product_id: @product.id,
+                sku: @product.skus.first,
+                quantity: 2
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_updating_an_item
+          add_item(@order, product_id: @product.id, sku: 'VT001', quantity: 2)
+
+          description 'Updating an item'
+          route storefront_api.cart_item_path(':cart_id', ':id')
+          explanation <<-EOS
+            Updates an item in the cart. Use the create a cart endpoint to get a
+            cart ID to use with this endpoint, and use the adding an item
+            endpoint to get an ID for an item.
+          EOS
+
+          record_request do
+            patch storefront_api.cart_item_path(@order, @order.items.first),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) },
+              as: :json,
+              params: {
+                sku: @product.skus.last,
+                quantity: 3
+              }
+
+            assert_equal(200, response.status)
+          end
+        end
+
+        def test_and_document_deleting_an_item
+          add_item(@order, product_id: @product.id, sku: 'VT001', quantity: 2)
+
+          description 'Delete an item'
+          route storefront_api.cart_item_path(':cart_id', ':id')
+          explanation <<-EOS
+            Removes an item in the cart. Use the create a cart endpoint to get a
+            cart ID to use with this endpoint, and use the adding an item
+            endpoint to get an ID for an item.
+          EOS
+
+          record_request do
+            delete storefront_api.cart_item_path(@order, @order.items.first),
+              headers: { 'HTTP_AUTHORIZATION' => encode_credentials(@auth.token) }
+
+            assert_equal(200, response.status)
+          end
+        end
+      end
+    end
+  end
+end