workarea-api-storefront 4.4.6

data/app/views/workarea/api/storefront/checkouts/steps/_addresses.json.jbuilder

@@ -0,0 +1,19 @@
+json.addresses do
+  json.complete step.complete?
+  json.email summary.email
+  json.problems summary.order.errors.full_messages
+
+  json.shipping_address do
+    if summary.shipping_address.present?
+      json.partial! 'workarea/api/storefront/shared/address', address: summary.shipping_address
+      json.problems summary.shipping_address.errors.full_messages
+    end
+  end
+
+  json.billing_address do
+    if summary.billing_address.present?
+      json.partial! 'workarea/api/storefront/shared/address', address: summary.billing_address
+      json.problems summary.billing_address.errors.full_messages
+    end
+  end
+end

data/app/views/workarea/api/storefront/checkouts/steps/_payment.json.jbuilder

@@ -0,0 +1,9 @@
+json.payment do
+  json.complete step.complete?
+  json.problems step.payment.errors.full_messages
+
+  json.tenders summary.payment.tenders do |tender|
+    json.partial! "workarea/api/storefront/orders/tenders/#{tender.slug}", tender: tender
+    json.problems tender.errors.full_messages
+  end
+end

data/app/views/workarea/api/storefront/checkouts/steps/_shipping.json.jbuilder

@@ -0,0 +1,9 @@
+json.shipping do
+  json.complete summary.shipping_service.present? && step.complete?
+  json.problems summary.shipping.errors.full_messages
+
+  json.shipping_service summary.shipping_service
+  json.shipping_total cart.shipping_total
+
+  json.partial! 'workarea/api/storefront/checkouts/shipping_options', cart: cart
+end

data/app/views/workarea/api/storefront/content_blocks/_block.json.jbuilder

@@ -0,0 +1,7 @@
+json.id block.id
+json.type block.type_id
+json.area block.area
+json.data block_data_with_urls(block)
+json.hidden_breakpoints block.hidden_breakpoints
+json.position block.position
+json.html render_block_to_string(block)

data/app/views/workarea/api/storefront/email_signups/create.json.jbuilder

@@ -0,0 +1,2 @@
+json.id @signup.id
+json.email @signup.email

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

@@ -0,0 +1,4 @@
+json.title @email_signup.title
+json.content_blocks @email_signup.content.blocks do |block|
+  json.partial! 'workarea/api/storefront/content_blocks/block', block: block
+end

data/app/views/workarea/api/storefront/facets/_range.json.jbuilder

@@ -0,0 +1,8 @@
+json.type facet.type
+json.name facet.name
+json.display_name facet.display_name
+
+json.results facet.results do |range, count|
+  json.range range
+  json.count count
+end

data/app/views/workarea/api/storefront/facets/_terms.json.jbuilder

@@ -0,0 +1,8 @@
+json.type facet.type
+json.name facet.name
+json.display_name facet.display_name
+
+json.results facet.results do |name, count|
+  json.name name
+  json.count count
+end

data/app/views/workarea/api/storefront/fulfillments/_fulfillment.json.jbuilder

@@ -0,0 +1,18 @@
+json.status order.try(:fulfillment_status)
+
+json.packages order.packages do |package|
+  json.tracking_number package.tracking_number
+  json.tracking_link package.tracking_link
+
+  json.items package.items do |item|
+    json.partial! 'workarea/api/storefront/orders/item', item: item
+  end
+end
+
+json.pending_items order.pending_items do |item|
+  json.partial! 'workarea/api/storefront/orders/item', item: item
+end
+
+json.canceled_items order.canceled_items do |item|
+  json.partial! 'workarea/api/storefront/orders/item', item: item
+end

data/app/views/workarea/api/storefront/menus/_menu.json.jbuilder

@@ -0,0 +1,11 @@
+json.cache! menu.cache_key, expires_in: 1.hour do
+  json.id menu.id
+  json.name menu.name
+  json.position menu.position
+  json.url menu_path(menu)
+  json.taxon_url menu.taxon.url.presence || storefront_api_url_for(menu.taxon)
+
+  json.content_blocks menu.content.blocks do |block|
+    json.partial! 'workarea/api/storefront/content_blocks/block', block: block
+  end
+end

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

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

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

@@ -0,0 +1 @@
+json.partial! 'workarea/api/storefront/menus/menu', menu: @menu

data/app/views/workarea/api/storefront/orders/_item.json.jbuilder

@@ -0,0 +1,26 @@
+json.id item.id
+json.product_id item.product_id
+json.sku item.sku
+json.quantity item.quantity
+json.product_url product_url(item.product, sku: item.sku)
+json.options item.details
+json.customizations item.customizations
+
+json.product_image do
+  json.partial! 'workarea/api/storefront/products/image_urls', image: item.image
+end
+
+json.pricing do
+  json.price_adjustments item.price_adjustments do |adjustment|
+    json.description adjustment.description
+    json.discount adjustment.discount?
+    json.amount adjustment.amount
+  end
+
+  json.total_price item.total_price
+  json.on_sale item.on_sale?
+  json.original_unit_price item.original_unit_price
+  json.original_price item.original_price
+  json.customized item.customized?
+  json.customizations_unit_price item.customizations_unit_price
+end

data/app/views/workarea/api/storefront/orders/_order.json.jbuilder

@@ -0,0 +1,42 @@
+json.id order.id
+json.url order_url(order)
+json.user_id order.user_id
+json.email order.email
+json.placed_at order.placed_at
+json.canceled_at order.canceled_at
+json.promo_codes order.promo_codes
+json.requires_shipping order.requires_shipping?
+
+json.items order.items do |item|
+  json.partial! 'workarea/api/storefront/orders/item', item: item
+end
+
+json.pricing do
+  json.price_adjustments order.total_adjustments do |adjustment|
+    json.description adjustment.description.titleize
+    json.amount adjustment.amount
+  end
+
+  json.shipping_total order.shipping_total
+  json.tax_total order.tax_total
+  json.subtotal_price order.subtotal_price
+  json.total_price order.total_price
+  json.paid_amount order.try(:paid_amount) || 0
+end
+
+json.shipping_service order.shipping_service
+json.shipping_address do
+  if order.shipping_address.present?
+    json.partial! 'workarea/api/storefront/shared/address', address: order.shipping_address
+  end
+end
+
+json.billing_address do
+  if order.billing_address.present?
+    json.partial! 'workarea/api/storefront/shared/address', address: order.billing_address
+  end
+end
+
+json.tenders order.tenders do |tender|
+  json.partial! "workarea/api/storefront/orders/tenders/#{tender.slug}", tender: tender
+end

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

@@ -0,0 +1,4 @@
+json.user_id current_user.id
+json.orders @orders do |order|
+  json.partial! 'workarea/api/storefront/orders/order', order: order
+end

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

@@ -0,0 +1,7 @@
+json.order do
+  json.partial! 'workarea/api/storefront/orders/order', order: @order
+end
+
+json.fulfillment do
+  json.partial! 'workarea/api/storefront/fulfillments/fulfillment', order: @order
+end

data/app/views/workarea/api/storefront/orders/tenders/_credit_card.json.jbuilder

@@ -0,0 +1,6 @@
+json.type 'credit_card'
+json.amount tender.amount
+json.issuer tender.issuer
+json.display_number tender.display_number
+json.month tender.month
+json.year tender.year

data/app/views/workarea/api/storefront/orders/tenders/_store_credit.json.jbuilder

@@ -0,0 +1,2 @@
+json.type 'store_credit'
+json.amount tender.amount

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

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

data/app/views/workarea/api/storefront/products/_image_urls.json.jbuilder

@@ -0,0 +1,5 @@
+processors = Dragonfly.app(:workarea).processors.items
+json.urls processors.except(*Workarea.config.api_product_image_jobs_blacklist) do |name, _value|
+  json.type name
+  json.url product_image_url(image, name)
+end

data/app/views/workarea/api/storefront/products/_product.json.jbuilder

@@ -0,0 +1,41 @@
+json.cache! product.cache_key, expires_in: 1.hour do
+  json.id product.id
+
+  json.name product.name
+  json.description product.description
+  json.slug product.slug
+
+  json.browser_title product.browser_title
+  json.meta_description product.meta_description
+
+  json.template product.template
+  json.customizations product.customizations
+  json.details product.details
+  json.digital product.digital?
+  json.filters product.filters
+  json.purchasable product.purchasable?
+  json.inventory_status product.inventory_status
+
+  json.variants product.variants do |variant|
+    json.id variant.id
+    json.name variant.name
+    json.sku variant.sku
+    json.details variant.details
+  end
+
+  json.sell_min_price json.sell_min_price
+  json.sell_max_price product.sell_max_price
+  json.on_sale product.on_sale?
+  json.original_min_price product.original_min_price
+  json.original_max_price product.original_max_price
+
+  json.images product.images do |image|
+    json.id image.id
+    json.option image.option
+    json.position image.position
+    json.primary image == product.primary_image
+    json.partial! 'workarea/api/storefront/products/image_urls', image: image
+  end
+
+  json.append_partials('api.storefront.product_details', product: product)
+end

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

@@ -0,0 +1,9 @@
+json.cache! @product.cache_key, expires_in: 1.hour do
+  json.product do
+    json.partial! 'workarea/api/storefront/products/product', product: @product
+  end
+
+  json.recommendations @product.recommendations do |product|
+    json.partial! 'workarea/api/storefront/products/product', product: product
+  end
+end

data/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/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/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/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/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/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/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/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/app/views/workarea/api/storefront/searches/index.json.jbuilder

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

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