workarea-api-storefront 4.4.7 → 4.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12dfdfb465b6dfb5eb2a2cd28dff9ee8cf6fc494c4e95db0413a389018623ca6
-  data.tar.gz: 20e268c13c9fc5f3cfe2758ac3aa5120b2c2ca816e6cb43999f04bba113ec50a
+  metadata.gz: 9d4f3aa76d447bb1f67442740f792245c7a3af8fcec7d0bbbe3c4a24f7206135
+  data.tar.gz: a8c6dee0ad5e0646fba2b7ff9eb5005d1507fea4ea6d6bb60f0ba7f65795495f
 SHA512:
-  metadata.gz: f3a96efbc5c795bf35bc4d1d639a2f28e8131c6c862f724a380678d056c4ff6ede11ae75ddef23db777f1e62a0b28ff65e7f97ca2de4093f88e66eba8ac72e8a
-  data.tar.gz: 924ffec40bca797c3950b59389084444fece3d626ae986a7098f3c382e43795e2da739e29bf6cd9656d98b53e071a4b65f8d60edb410619d90b507e6604eebfb
+  metadata.gz: bce7042a21b33059dba4bf678da6b058472c551c05aaca7bef7945f8d912c8ce4f562605b072b4d5e5510ff069b52452b4474cbdcd522feac67655ad1b516a2e
+  data.tar.gz: e38a4237e5191c86e0e2346428f0848927704b9a5d1a514737f2049f61d4cf0582ef23ac170dfd07266c437c0302cac19841481946fc3c06c13cf86de427b8cc

data/app/controllers/workarea/api/storefront/analytics_controller.rb

@@ -1,38 +1,50 @@
 module Workarea
   module Api
     module Storefront
-      class AnalyticsController < ActionController::Metal
-        include ActionController::Head
-        include ActionController::Instrumentation
-
+      class AnalyticsController < Api::Storefront::ApplicationController
         def category_view
           Metrics::CategoryByDay.inc(key: { category_id: params[:category_id] }, views: 1)
+
+          if current_metrics_id.present?
+            Metrics::User.save_affinity(
+              id: current_metrics_id,
+              action: 'viewed',
+              category_ids: params[:category_id]
+            )
+          end
+
           head :ok
         end
 
         def product_view
           Metrics::ProductByDay.inc(key: { product_id: params[:product_id] }, views: 1)
+
+          if current_metrics_id.present?
+            Metrics::User.save_affinity(
+              id: current_metrics_id,
+              action: 'viewed',
+              product_ids: params[:product_id]
+            )
+          end
+
           head :ok
         end
 
         def search
-          Metrics::SearchByDay.save_search(params[:q], params[:total_results])
-          head :ok
-        end
+          query_string = QueryString.new(params[:q])
 
-        def search_abandonment
-          warn <<~eos
-DEPRECATION WARNING: Search abandonment tracking is deprecated and will be removed \
-in Workarea 3.5.
-          eos
-          head :ok
-        end
+          if query_string.present? && !query_string.short?
+            Metrics::SearchByDay.save_search(params[:q], params[:total_results])
+
+            if current_metrics_id.present?
+              Metrics::User.save_affinity(
+                id: current_metrics_id,
+                action: 'viewed',
+                search_ids: query_string.id
+              )
+            end
+          end
 
-        def filters
-          warn <<~eos
-DEPRECATION WARNING: Filter analytics tracking is deprecated and will be removed \
-in Workarea 3.5.
-          eos
           head :ok
         end
       end

data/app/controllers/workarea/api/storefront/application_controller.rb

@@ -2,15 +2,15 @@ module Workarea
   module Api
     module Storefront
       class ApplicationController < Workarea::ApplicationController
-        include Workarea::Storefront::HttpCaching
+        include HttpCaching
         include Api::Storefront::Authentication
-        include Api::Storefront::UserActivity
 
         respond_to :json
 
         before_action :set_json_format
         before_action :skip_session
         before_action { params.permit! }
+        around_action :apply_segments
         after_action :disable_cors_protection
 
         rescue_from Mongoid::Errors::DocumentNotFound, with: :handle_not_found
@@ -28,6 +28,19 @@ module Workarea
           request.session_options[:skip] = true
         end
 
+        def assert_current_metrics_id
+          if current_metrics_id.blank?
+            render(
+              json: {
+                problem: t('workarea.api.storefront.recent_views.missing_id')
+              },
+              status: :unprocessable_entity
+            )
+
+            return false
+          end
+        end
+
         private
 
         def set_json_format

data/app/controllers/workarea/api/storefront/authentication.rb

@@ -10,19 +10,16 @@ module Workarea
           helper_method :current_user
         end
 
-        def current_user
-          return @current_user if defined?(@current_user)
-
-          user = authenticate_with_http_token do |token, options|
-            User::AuthenticationToken.authenticate(token, options).try(:user)
-          end
+        def self.find_user(token, options)
+          User::AuthenticationToken.authenticate(token, options).try(:user)
+        end
 
-          @current_user = user || raise(InvalidError)
+        def current_user
+          current_visit.current_user || raise(InvalidError)
         end
 
         def authentication?
-          regex = ActionController::HttpAuthentication::Token::TOKEN_REGEX
-          request.authorization.to_s[regex].present?
+          current_visit.logged_in?
         end
       end
     end

data/app/controllers/workarea/api/storefront/categories_controller.rb

@@ -5,7 +5,7 @@ module Workarea
         before_action :cache_page
 
         def index
-          models = Catalog::Category.active.page(params[:page])
+          models = Catalog::Category.page(params[:page]).select(&:active?)
           @categories = Workarea::Storefront::CategoryViewModel.wrap(
             models,
             view_model_options
@@ -14,6 +14,8 @@ module Workarea
 
         def show
           model = Catalog::Category.find_by(slug: params[:id])
+          raise InvalidDisplay unless model.active?
+
           @category = Workarea::Storefront::CategoryViewModel.wrap(
             model,
             view_model_options

data/app/controllers/workarea/api/storefront/checkouts_controller.rb

@@ -96,7 +96,6 @@ module Workarea
           if authentication?
             current_order.touch_checkout!(
               ip_address: request.remote_ip,
-              user_activity_id: current_user.id,
               checkout_by_id: current_user.id,
               source: 'storefront_api'
             )

data/app/controllers/workarea/api/storefront/menus_controller.rb

@@ -10,7 +10,9 @@ module Workarea
         end
 
         def show
-          model = Navigation::Menu.active.find(params[:id])
+          model = Navigation::Menu.find(params[:id])
+          raise InvalidDisplay unless model.active?
+
           @menu = Workarea::Storefront::MenuViewModel.wrap(model, params)
         end
       end

data/app/controllers/workarea/api/storefront/pages_controller.rb

@@ -5,7 +5,9 @@ module Workarea
         before_action :cache_page
 
         def show
-          model = Content::Page.active.find_by(slug: params[:id])
+          model = Content::Page.find_by(slug: params[:id])
+          raise InvalidDisplay unless model.active?
+
           @page = Workarea::Storefront::PageViewModel.new(model, view_model_options)
         end
       end

data/app/controllers/workarea/api/storefront/products_controller.rb

@@ -5,7 +5,9 @@ module Workarea
         before_action :cache_page
 
         def show
-          model = Workarea::Catalog::Product.active.find_by(slug: params[:id])
+          model = Workarea::Catalog::Product.find_by(slug: params[:id])
+          raise InvalidDisplay unless model.active?
+
           @product = Workarea::Storefront::ProductViewModel.wrap(
             model,
             view_model_options

data/app/controllers/workarea/api/storefront/recent_views_controller.rb

@@ -2,39 +2,26 @@ module Workarea
   module Api
     module Storefront
       class RecentViewsController < Api::Storefront::ApplicationController
-        before_action :assert_current_user_activity_id
+        before_action :assert_current_metrics_id
 
         def show
-          if stale?(
-            etag: user_activity,
-            last_modified: user_activity.updated_at,
-            public: true
+          @recent_views = Workarea::Storefront::UserActivityViewModel.new(
+            current_metrics
           )
-            @recent_views = Workarea::Storefront::UserActivityViewModel.new(
-              user_activity
-            )
-          end
         end
 
         def update
-          if params[:product_id].present?
-            Recommendation::UserActivity.save_product(
-              current_user_activity_id,
-              params[:product_id]
-            )
-          end
-
-          if params[:category_id].present?
-            Recommendation::UserActivity.save_category(
-              current_user_activity_id,
-              params[:category_id]
-            )
-          end
+          product_ids = Array.wrap(params[:product_id])
+          category_ids = Array.wrap(params[:category_id])
+          search_ids = Array.wrap(params[:search])
 
-          if params[:search].present?
-            Recommendation::UserActivity.save_search(
-              current_user_activity_id,
-              params[:search]
+          if current_metrics_id.present?
+            Metrics::User.save_affinity(
+              id: current_metrics_id,
+              action: 'viewed',
+              product_ids: product_ids,
+              category_ids: category_ids,
+              search_ids: search_ids
             )
           end
 

data/app/controllers/workarea/api/storefront/recommendations_controller.rb

@@ -2,17 +2,11 @@ module Workarea
   module Api
     module Storefront
       class RecommendationsController < Api::Storefront::ApplicationController
-        before_action :assert_current_user_activity_id
+        before_action :assert_current_metrics_id
 
         def show
-          fresh_when(
-            etag: user_activity,
-            last_modified: user_activity.updated_at,
-            public: true
-          )
-
           @recommendations = Workarea::Storefront::PersonalizedRecommendationsViewModel.new(
-            user_activity,
+            current_metrics,
             view_model_options
           )
         end

data/app/controllers/workarea/api/storefront/searches_controller.rb

@@ -4,18 +4,6 @@ module Workarea
       class SearchesController < Api::Storefront::ApplicationController
         before_action :cache_page
 
-        def index
-          search_query = QueryString.new(params[:q]).sanitized
-
-          render(nothing: true) && (return) if search_query.blank?
-          autocomplete_params = params.permit(:q)
-          search = Search::SearchSuggestions.new(autocomplete_params)
-
-          @results = search.results.map do |result|
-            SearchSuggestionViewModel.new(result).to_h
-          end
-        end
-
         def show
           response = Search::StorefrontSearch.new(params.to_unsafe_h).response
           @search = Workarea::Storefront::SearchViewModel.new(

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

@@ -14,7 +14,7 @@ json.cache! @category.cache_key, expires_in: 1.hour do
     json.partial! 'workarea/api/storefront/taxons/taxon', taxon: taxon
   end
 
-  json.content_blocks @category.content.blocks do |block|
+  json.content_blocks @category.content.blocks.select(&:active?) do |block|
     json.partial! 'workarea/api/storefront/content_blocks/block', block: block
   end
 

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

@@ -1,4 +1,4 @@
 json.title @email_signup.title
-json.content_blocks @email_signup.content.blocks do |block|
+json.content_blocks @email_signup.content.blocks.select(&:active?) do |block|
   json.partial! 'workarea/api/storefront/content_blocks/block', block: block
 end

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

@@ -5,7 +5,7 @@ json.cache! menu.cache_key, expires_in: 1.hour do
   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.content_blocks menu.content.blocks.select(&:active?) do |block|
     json.partial! 'workarea/api/storefront/content_blocks/block', block: block
   end
 end

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

@@ -10,7 +10,7 @@ json.cache! @page.cache_key, expires_in: 1.hour do
     json.partial! 'workarea/api/storefront/taxons/taxon', taxon: taxon
   end
 
-  json.content_blocks @page.content.blocks do |block|
+  json.content_blocks @page.content.blocks.select(&:active?) do |block|
     json.partial! 'workarea/api/storefront/content_blocks/block', block: block
   end
 end

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

@@ -5,4 +5,3 @@ 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/searches/show.json.jbuilder

@@ -4,7 +4,7 @@ json.redirect @search.redirect
 json.sorts @search.sorts
 json.sort @search.sort
 
-json.content_blocks @search.content.blocks do |block|
+json.content_blocks @search.content.blocks.select(&:active?) do |block|
   json.partial! 'workarea/api/storefront/content_blocks/block', block: block
 end
 

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

@@ -6,7 +6,7 @@ json.cache! @content.cache_key, expires_in: 1.hour do
   json.browser_title @content.browser_title
   json.meta_description @content.meta_description
 
-  json.content_blocks @content.content.blocks do |block|
+  json.content_blocks @content.content.blocks.select(&:active?) do |block|
     json.partial! 'workarea/api/storefront/content_blocks/block', block: block
   end
 end

data/config/initializers/config.rb

@@ -1,2 +1,21 @@
 Workarea.config.api_product_image_jobs_blacklist ||= %i[convert encode rotate optim avatar thumb]
 Workarea.config.authentication_token_expiration ||= 1.week
+
+# Ok, this one's a doozy.
+#
+# To deliver segmentation in the storefront API, we need a way to change a
+# {Visit}'s definition of things like sessions, cookies, auth, etc.
+#
+# Since segments are determined first (before any other middleware), we need a
+# way to know whether this is an API request to for logic in {Visit}.
+#
+# Since this is before any other middleware (including Rails' routing), we don't
+# have a way to check the controller class or anything else application-related
+# for whether it's an API request or an ordinary request.
+#
+# The best thing I could come up with is this regex. This lambda provides a hook
+# for builds in case it doesn't work. They can provide their own logic here.
+#
+Workarea.config.is_api_visit = lambda do |request|
+  request.original_url =~ /:\/\/api\.|\/api\/./
+end

data/lib/workarea/api/storefront.rb

@@ -13,3 +13,4 @@ end
 
 require 'workarea/api/version'
 require 'workarea/api/storefront/engine'
+require 'workarea/api/storefront/visit.decorator'

data/lib/workarea/api/storefront/visit.decorator

@@ -0,0 +1,52 @@
+module Workarea
+  decorate Visit, with: 'storefront_api' do
+    def api?
+      return @api if defined?(@api)
+      @api = Workarea.config.is_api_visit.call(request)
+    end
+
+    def cookies
+      api? ? {} : super
+    end
+
+    def session
+      api? ? {} : super
+    end
+
+    def logged_in?
+      return super unless api?
+
+      regex = ActionController::HttpAuthentication::Token::TOKEN_REGEX
+      request.authorization.to_s[regex].present?
+    end
+
+    def current_email
+      return super unless api?
+      return request.params['email'] unless logged_in?
+      return @current_email if defined? @current_email
+
+      @current_email = current_user&.email
+    end
+
+    def current_user
+      token, options = ActionController::HttpAuthentication::Token.token_and_options(request)
+      @current_user ||= Api::Storefront::Authentication.find_user(token, options)
+    end
+
+    def sessions
+      api? ? request.params['sessions'].to_i : super
+    end
+
+    def current_metrics_id
+      return super unless api?
+
+      return @current_metrics_id if defined?(@current_metrics_id)
+      @current_metrics_id = current_email.presence || request.params['session_id']
+    end
+
+    def current_metrics_id=(value)
+      return super unless api?
+      # Unsupported in the API
+    end
+  end
+end

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

@@ -85,6 +85,27 @@ module Workarea
           end
         end
 
+        def test_and_document_update_failure
+          description 'Failure to update a checkout'
+          route storefront_api.checkout_path(':id')
+          explanation <<-EOS
+            This is an example of what occurs when you fail to send in the correct parameters for your checkout.
+          EOS
+
+          record_request do
+            patch storefront_api.checkout_path(@order),
+              as: :json,
+              params: {
+                email: 'susanb@workarea.com',
+                shipping_address: address.except(:first_name),
+                billing_address: address.except(:last_name),
+                shipping_service: 'Express'
+              }
+
+            assert_equal(422, response.status)
+          end
+        end
+
         def test_and_document_complete
           description 'Completing a checkout'
           route storefront_api.complete_checkout_path(':id')

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

@@ -0,0 +1,104 @@
+require 'test_helper'
+require 'workarea/api/documentation_test'
+
+module Workarea
+  module Api
+    module Storefront
+      class SegmentationDocumentationTest < DocumentationTest
+        resource 'Segmentation'
+
+        def test_and_document_session_count
+          description 'Specifying session count for segmentation'
+          route storefront_api.system_content_path('home_page')
+          explanation <<~EOS
+            Workarea supports segmenting users by number of sessions, e.g.
+            first-time vs returning visitors. To support this in the storefront
+            API, the client will be responsible for managing this since the API
+            is stateless (doesn't have cookies/session).
+
+            To get session-based segments functioning, you need to pass a
+            `sessions` parameter in each request. Workarea will use that as
+            the number of sessions for determing the segments for the response.
+            This works for all requests across the storefront API.
+
+            This example shows getting a home page with segmented content based
+            on the number of sessions.
+          EOS
+
+          first_time = Segment::FirstTimeVisitor.instance
+          returning = Segment::ReturningVisitor.instance
+
+          content = Content.for('Home Page')
+          content.blocks.create!(
+            type: 'text',
+            data: { text: 'Hello visitor!' },
+            active_segment_ids: [first_time.id]
+          )
+          content.blocks.create!(
+            type: 'text',
+            data: { text: 'Welcome back!' },
+            active_segment_ids: [returning.id]
+          )
+
+          record_request do
+            get storefront_api.system_content_path('home_page', sessions: 1)
+            assert_match(/Hello visitor!/, response.body)
+            assert(response.ok?)
+          end
+          record_request do
+            get storefront_api.system_content_path('home_page', sessions: 2)
+            assert_match(/Welcome back!/, response.body)
+            assert(response.ok?)
+          end
+        end
+
+        def test_and_document_session_ids
+          description 'Using session IDs for segmenting non-authenticated users'
+          route storefront_api.system_content_path('home_page')
+          explanation <<~EOS
+            Workarea supports segmenting users by number of orders, revenue, etc.
+            For this functionality to work for users without accounts, you'll
+            need to maintain and pass a `session_id` consistently throughout calls
+            to the API.
+
+            An instance of `Metrics::User` will be found or created for that
+            `session_id`, and data about the user will be tracked there.
+
+            Assuming use of the `session_id` consistently through checkout, this
+            example shows getting home page content for two different anonymous
+            users and getting segmented content back.
+          EOS
+
+          first_time = Segment::FirstTimeCustomer.instance
+          returning = Segment::ReturningCustomer.instance
+
+          Metrics::User.create!(id: 'session_1', orders: 1)
+          Metrics::User.create!(id: 'session_2', orders: 2)
+
+          content = Content.for('Home Page')
+          content.blocks.create!(
+            type: 'text',
+            data: { text: 'Thanks for your order!' },
+            active_segment_ids: [first_time.id]
+          )
+          content.blocks.create!(
+            type: 'text',
+            data: { text: 'Welcome back repeat customer!' },
+            active_segment_ids: [returning.id]
+          )
+
+          record_request do
+            get storefront_api.system_content_path('home_page', session_id: 'session_1')
+            assert_match(/Thanks/, response.body)
+            assert(response.ok?)
+          end
+          record_request do
+            get storefront_api.system_content_path('home_page', session_id: 'session_2')
+            assert_match(/Welcome back/, response.body)
+            assert(response.ok?)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -72,7 +72,7 @@ module Workarea
                 }
               }
 
-            assert_equal(200, response.status)
+            assert_equal(422, response.status)
           end
         end
       end

data/test/dummy/config/initializers/session_store.rb

@@ -1,3 +1,5 @@
 # Be sure to restart your server when you modify this file.
 
-Rails.application.config.session_store :cookie_store, key: '_dummy_session'
+Rails.application.config.session_store :cookie_store,
+                                       key: '_dummy_session',
+                                       expire_after: 30.minutes

data/test/integration/workarea/api/storefront/analytics_integration_test.rb

@@ -7,11 +7,19 @@ module Workarea
         def test_saving_category_view
           post storefront_api.analytics_category_view_path(category_id: 'foo')
           assert_equal(1, Metrics::CategoryByDay.first.views)
+
+          post storefront_api.analytics_category_view_path(category_id: 'foo', session_id: '1')
+          assert_equal(2, Metrics::CategoryByDay.first.views)
+          assert_equal(%w(foo), Metrics::User.find('1').viewed.category_ids)
         end
 
         def test_saving_product_view
           post storefront_api.analytics_product_view_path(product_id: 'foo')
           assert_equal(1, Metrics::ProductByDay.first.views)
+
+          post storefront_api.analytics_product_view_path(product_id: 'foo', session_id: '1')
+          assert_equal(2, Metrics::ProductByDay.first.views)
+          assert_equal(%w(foo), Metrics::User.find('1').viewed.product_ids)
         end
 
         def test_saving_search
@@ -21,14 +29,11 @@ module Workarea
           insights = Metrics::SearchByDay.first
           assert_equal(1, insights.searches)
           assert_equal(5, insights.total_results)
-        end
 
-        def test_saving_search_abandonment
-          # Saving abandonment is deprecated, and this will be removed in v3.5
-        end
-
-        def test_saving_filters
-          # Saving filters is deprecated, and this will be removed in v3.5
+          post storefront_api.analytics_search_path,
+            params: { q: 'foo', total_results: 5, session_id: '1' }
+          assert_equal(2, insights.reload.searches)
+          assert_equal(%w(foo), Metrics::User.find('1').viewed.search_ids)
         end
       end
     end

data/test/integration/workarea/api/storefront/recent_views_integration_test.rb

@@ -19,30 +19,38 @@ module Workarea
 
         def test_showing_recent_views_with_authentication
           user = create_user(first_name: 'Ben', last_name: 'Crouse')
-          set_current_user(user)
+          post storefront_api.authentication_tokens_path,
+            params: { email: user.email, password: user.password }
+          token = JSON.parse(response.body)['token']
 
-          activity = create_user_activity(
-            id: user.id,
+          Metrics::User.save_affinity(
+            id: user.email,
+            action: 'viewed',
             product_ids: [@product.id],
             category_ids: [@category.id],
-            searches: ['foo']
+            at: Time.current,
+            search_ids: %w(foo)
           )
 
-          get storefront_api.recent_views_path
+          get storefront_api.recent_views_path,
+            headers: { 'HTTP_AUTHORIZATION' => encode_credentials(token) }
 
           assert(response.ok?)
           result = JSON.parse(response.body)
 
-          assert_equal(activity.id, result['id'])
+          assert_equal(user.email, result['id'])
           assert_equal(@product.id, result['products'].first['id'])
           assert_equal(@category.id.to_s, result['categories'].first['id'])
-          assert_includes(result['searches'], 'foo')
         end
 
         def test_adding_recent_views_for_authentication
           user = create_user(first_name: 'Ben', last_name: 'Crouse')
-          set_current_user(user)
+          post storefront_api.authentication_tokens_path,
+            params: { email: user.email, password: user.password }
+          token = JSON.parse(response.body)['token']
+
           patch storefront_api.recent_views_path,
+            headers: { 'HTTP_AUTHORIZATION' => encode_credentials(token) },
             params: {
               product_id: @product.id,
               category_id: @category.id,
@@ -51,54 +59,51 @@ module Workarea
 
           assert(response.ok?)
 
-          user_activity = Recommendation::UserActivity.first
-          assert_equal(user.id.to_s, user_activity.id.to_s)
-          assert_includes(user_activity.product_ids, @product.id)
-          assert_includes(user_activity.category_ids, @category.id.to_s)
-          assert_includes(user_activity.searches, 'foo')
+          user_activity = Workarea::Storefront::UserActivityViewModel.wrap(
+            Metrics::User.first
+          )
+          assert_equal(user.email, user_activity.id)
+          assert_includes(user_activity.products, @product)
+          assert_includes(user_activity.categories, @category)
         end
 
         def test_showing_recent_views_with_session_id
-          activity = create_user_activity(
+          Metrics::User.save_affinity(
+            id: BSON::ObjectId.new.to_s,
+            action: 'viewed',
             product_ids: [@product.id],
             category_ids: [@category.id],
-            searches: ['bar']
+            search_ids: %w(foo)
           )
+          activity = Metrics::User.last
 
           get storefront_api.recent_views_path,
             params: { session_id: activity.id }
 
-          assert(response.ok?)
+          assert_response(:success)
           result = JSON.parse(response.body)
 
-          assert_equal(activity.id, result['id'])
-          assert_equal(@product.id, result['products'].first['id'])
+          assert_equal(activity.id.to_s, result['id'])
+          assert_equal(@product.id.to_s, result['products'].first['id'])
           assert_equal(@category.id.to_s, result['categories'].first['id'])
-          assert_includes(result['searches'], 'bar')
         end
 
         def test_adding_recent_views_for_session_id
-          activity = create_user_activity(
-            product_ids: [@product.id],
-            category_ids: [@category.id],
-            searches: ['bar']
-          )
-
           patch storefront_api.recent_views_path,
             params: {
-              session_id: activity.id,
+              session_id: BSON::ObjectId.new.to_s,
               product_id: @product.id,
               category_id: @category.id,
               search: 'bar'
             }
 
-          assert(response.ok?)
+          assert_response(:success)
 
-          user_activity = Recommendation::UserActivity.first
-          assert_equal(activity.id, user_activity.id)
-          assert_includes(user_activity.product_ids, @product.id)
-          assert_includes(user_activity.category_ids, @category.id.to_s)
-          assert_includes(user_activity.searches, 'bar')
+          user_activity = Workarea::Storefront::UserActivityViewModel.wrap(
+            Metrics::User.first
+          )
+          assert_includes(user_activity.products, @product)
+          assert_includes(user_activity.categories, @category)
         end
 
         def test_adding_without_id
@@ -110,7 +115,7 @@ module Workarea
             }
 
           refute(response.ok?)
-          assert_equal(0, Recommendation::UserActivity.count)
+          assert_equal(0, Metrics::User.count)
         end
       end
     end

data/test/integration/workarea/api/storefront/recommendations_integration_test.rb

@@ -23,7 +23,7 @@ module Workarea
         end
 
         def set_user_activity
-          @activity = create_user_activity
+          @activity = Metrics::User.create!
         end
 
         def test_showing_recommendations_with_authentication

data/test/integration/workarea/api/storefront/searches_integration_test.rb

@@ -4,42 +4,6 @@ module Workarea
   module Api
     module Storefront
       class SearchesIntegrationTest < IntegrationTest
-        def test_showing_search_autocomplete
-          create_product(name: 'Foo')
-          create_category(name: 'Foo Category')
-          create_page(name: 'Foo Page')
-
-          Metrics::SearchByDay.save_search('foo', 3)
-          travel_to 1.weeks.from_now
-          GenerateInsights.generate_all!
-          BulkIndexSearches.perform
-
-          get storefront_api.searches_path(q: 'foo')
-          results = JSON.parse(response.body)['results']
-          assert_equal(4, results.length)
-
-          search = results.detect { |r| r['type'] == 'Searches' }
-          assert(search.present?)
-          assert_equal('foo', search['value'])
-          assert_equal(storefront_api.search_path(q: 'foo'), search['url'])
-
-          product = results.detect { |r| r['type'] == 'Products' }
-          assert(product.present?)
-          assert_equal('Foo', product['value'])
-          assert_match(/product_images/, product['image'])
-          assert_equal(storefront_api.product_path('foo'), product['url'])
-
-          category = results.detect { |r| r['type'] == 'Categories' }
-          assert(category.present?)
-          assert_equal('Foo Category', category['value'])
-          assert_equal(storefront_api.category_path('foo-category'), category['url'])
-
-          page = results.detect { |r| r['type'] == 'Pages' }
-          assert(page.present?)
-          assert_equal('Foo Page', page['value'])
-          assert_equal(storefront_api.page_path('foo-page'), page['url'])
-        end
-
         def test_shows_search_results
           Search::Settings.current.update_attributes!(terms_facets: %w(Color Size))
           create_product(

data/test/integration/workarea/api/storefront/segments_integration_test.rb

@@ -0,0 +1,218 @@
+require 'test_helper'
+
+module Workarea
+  module Api
+    module Storefront
+      class SegmentsIntegrationTest < IntegrationTest
+        include AuthenticationTest
+
+        def test_sessions_functionality
+          first_time = Segment::FirstTimeVisitor.instance
+          returning = Segment::ReturningVisitor.instance
+
+          get storefront_api.system_content_path('home_page')
+          assert_equal(first_time.id.to_s, response.headers['X-Workarea-Segments'])
+
+          get storefront_api.system_content_path('home_page'), params: { sessions: 1 }
+          assert_equal(first_time.id.to_s, response.headers['X-Workarea-Segments'])
+
+          get storefront_api.system_content_path('home_page'), params: { sessions: 2 }
+          assert_equal(returning.id.to_s, response.headers['X-Workarea-Segments'])
+        end
+
+        def test_current_email_functionality
+          first_time = Segment::FirstTimeCustomer.instance
+          returning = Segment::ReturningCustomer.instance
+
+          Metrics::User.save_order(email: 'first-time@workarea.com', revenue: 1.to_m)
+          Metrics::User.save_order(email: 'returning@workarea.com', revenue: 1.to_m)
+          Metrics::User.save_order(email: 'returning@workarea.com', revenue: 1.to_m)
+
+          get storefront_api.system_content_path('home_page')
+          assert(response.headers['X-Workarea-Segments'].blank?)
+
+          get storefront_api.system_content_path('home_page'), params: { email: 'first-time@workarea.com' }
+          assert_equal(first_time.id.to_s, response.headers['X-Workarea-Segments'])
+
+          get storefront_api.system_content_path('home_page'), params: { email: 'returning@workarea.com' }
+          assert_equal(returning.id.to_s, response.headers['X-Workarea-Segments'])
+        end
+
+        def test_session_ids_for_metrics
+          first_time = Segment::FirstTimeCustomer.instance
+          returning = Segment::ReturningCustomer.instance
+
+          Metrics::User.create!(id: '1', orders: 1)
+          Metrics::User.create!(id: '2', orders: 2)
+
+          get storefront_api.system_content_path('home_page')
+          assert(response.headers['X-Workarea-Segments'].blank?)
+
+          get storefront_api.system_content_path('home_page'), params: { session_id: '1' }
+          assert_equal(first_time.id.to_s, response.headers['X-Workarea-Segments'])
+
+          get storefront_api.system_content_path('home_page'), params: { session_id: '2' }
+          assert_equal(returning.id.to_s, response.headers['X-Workarea-Segments'])
+        end
+
+        def test_products_active_by_segment
+          segment_one = create_segment(rules: [Segment::Rules::Sessions.new(minimum: 1, maximum: 1)])
+          segment_two = create_segment(rules: [Segment::Rules::Sessions.new(minimum: 2, maximum: 2)])
+          product_one = create_product(active: true, active_segment_ids: [segment_two.id])
+          product_two = create_product(active: true, active_segment_ids: [segment_one.id])
+
+          assert_raise InvalidDisplay do
+            get storefront_api.product_path(product_one), params: { sessions: 0 }
+            assert(response.not_found?)
+          end
+
+          assert_raise InvalidDisplay do
+            get storefront_api.product_path(product_two), params: { sessions: 0 }
+            assert(response.not_found?)
+          end
+
+          get storefront_api.search_path(q: '*'), params: { sessions: 0 }
+          assert(JSON.parse(response.body)['products'].empty?)
+
+          assert_raise InvalidDisplay do
+            get storefront_api.product_path(product_one), params: { sessions: 1 }
+            assert(response.not_found?)
+          end
+
+          get storefront_api.product_path(product_two), params: { sessions: 1 }
+          assert(response.ok?)
+
+          get storefront_api.search_path(q: '*'), params: { sessions: 1 }
+          products = JSON.parse(response.body)['products']
+          assert_equal([product_two.id], products.map { |p| p['id'] })
+
+          get storefront_api.product_path(product_one), params: { sessions: 2 }
+          assert(response.ok?)
+
+          assert_raise InvalidDisplay do
+            get storefront_api.product_path(product_two), params: { sessions: 2 }
+            assert(response.not_found?)
+          end
+
+          get storefront_api.search_path(q: '*'), params: { sessions: 2 }
+          products = JSON.parse(response.body)['products']
+          assert_equal([product_one.id], products.map { |p| p['id'] })
+
+          segment_one.rules.first.update!(minimum: 1, maximum: nil)
+          segment_two.rules.first.update!(minimum: 1, maximum: nil)
+
+          get storefront_api.product_path(product_one), params: { sessions: 1 }
+          assert(response.ok?)
+
+          get storefront_api.product_path(product_two), params: { sessions: 1 }
+          assert(response.ok?)
+
+          get storefront_api.search_path(q: '*'), params: { sessions: 1 }
+          products = JSON.parse(response.body)['products']
+          assert_equal(2, products.count)
+          assert_includes(products.map { |r| r['id'] }, product_one.id)
+          assert_includes(products.map { |r| r['id'] }, product_two.id)
+        end
+
+        def test_content_active_by_segment
+          segment_one = create_segment(rules: [Segment::Rules::Sessions.new(minimum: 1, maximum: 1)])
+          segment_two = create_segment(rules: [Segment::Rules::Sessions.new(minimum: 2, maximum: 2)])
+
+          content = Content.for('home_page')
+          foo = content.blocks.create!(
+            type: 'html',
+            data: { 'html' => '<p>Foo</p>' },
+            active_segment_ids: [segment_one.id]
+          )
+          bar = content.blocks.create!(
+            type: 'html',
+            data: { 'html' => '<p>Bar</p>' },
+            active_segment_ids: [segment_two.id]
+          )
+
+          get storefront_api.system_content_path('home_page'), params: { sessions: 1 }
+          content_blocks = JSON.parse(response.body)['content_blocks']
+          assert_equal([foo.id.to_s], content_blocks.map { |cb| cb['id'] })
+
+          get storefront_api.system_content_path('home_page'), params: { sessions: 2 }
+          content_blocks = JSON.parse(response.body)['content_blocks']
+          assert_equal([bar.id.to_s], content_blocks.map { |cb| cb['id'] })
+
+          segment_one.rules.first.update!(minimum: 1, maximum: nil)
+          segment_two.rules.first.update!(minimum: 1, maximum: nil)
+
+          get storefront_api.system_content_path('home_page'), params: { sessions: 1 }
+          content_blocks = JSON.parse(response.body)['content_blocks']
+          assert_equal([foo.id.to_s, bar.id.to_s], content_blocks.map { |cb| cb['id'] })
+        end
+
+        def test_logged_in_based_segments
+          logged_in = create_segment(rules: [Segment::Rules::LoggedIn.new(logged_in: true)])
+          logged_out = create_segment(rules: [Segment::Rules::LoggedIn.new(logged_in: false)])
+
+          get storefront_api.system_content_path('home_page')
+          assert_equal(logged_out.id.to_s, response.headers['X-Workarea-Segments'])
+
+          user = create_user
+          post storefront_api.authentication_tokens_path,
+            params: { email: user.email, password: user.password }
+
+          token = JSON.parse(response.body)['token']
+          get storefront_api.system_content_path('home_page'),
+            headers: { 'HTTP_AUTHORIZATION' => encode_credentials(token) }
+          assert_equal(logged_in.id.to_s, response.headers['X-Workarea-Segments'])
+        end
+
+        def test_http_caching_headers_for_segmented_content
+          Workarea.config.strip_http_caching_in_tests = false
+          segment = create_segment(rules: [Segment::Rules::Sessions.new(maximum: 999)])
+
+          get storefront_api.system_content_path('home_page')
+          refute_match(/private/, response.headers['Cache-Control'])
+          assert_match(/public/, response.headers['Cache-Control'])
+          assert(response.headers['X-Workarea-Segmented-Content'].blank?)
+
+          content = Content.for('home_page')
+          content.blocks.create!(
+            type: 'html',
+            data: { 'html' => '<p>Foo</p>' },
+            active_segment_ids: [segment.id]
+          )
+
+          get storefront_api.system_content_path('home_page')
+          assert_match(/private/, response.headers['Cache-Control'])
+          refute_match(/public/, response.headers['Cache-Control'])
+          assert_equal('true', response.headers['X-Workarea-Segmented-Content'])
+
+          product = create_product(active: true, active_segment_ids: [])
+          get storefront_api.product_path(product)
+          assert(response.ok?)
+          refute_match(/private/, response.headers['Cache-Control'])
+          assert_match(/public/, response.headers['Cache-Control'])
+          assert(response.headers['X-Workarea-Segmented-Content'].blank?)
+
+          product.update!(active_segment_ids: [segment.id])
+          get storefront_api.product_path(product)
+          assert(response.ok?)
+          assert_match(/private/, response.headers['Cache-Control'])
+          refute_match(/public/, response.headers['Cache-Control'])
+          assert_equal('true', response.headers['X-Workarea-Segmented-Content'])
+
+          category = create_category(active: true, active_segment_ids: [])
+          get storefront_api.category_path(category)
+          assert(response.ok?)
+          refute_match(/private/, response.headers['Cache-Control'])
+          assert_match(/public/, response.headers['Cache-Control'])
+          assert(response.headers['X-Workarea-Segmented-Content'].blank?)
+
+          category.update!(product_ids: [product.id])
+          get storefront_api.category_path(category)
+          assert(response.ok?)
+          assert_match(/private/, response.headers['Cache-Control'])
+          refute_match(/public/, response.headers['Cache-Control'])
+          assert_equal('true', response.headers['X-Workarea-Segmented-Content'])
+        end
+      end
+    end
+  end
+end

data/workarea-api-storefront.gemspec

@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'workarea', '~> 3.x', '>= 3.2.x'
-  s.add_dependency 'responders', '~> 2.4.0'
+  s.add_dependency 'workarea', '~> 3.x', '>= 3.5.x'
+  s.add_dependency 'responders', '~> 3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workarea-api-storefront
 version: !ruby/object:Gem::Version
-  version: 4.4.7
+  version: 4.5.5
 platform: ruby
 authors:
 - Ben Crouse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: workarea
@@ -19,7 +19,7 @@ dependencies:
         version: 3.x
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.x
+        version: 3.5.x
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,21 @@ dependencies:
         version: 3.x
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.x
+        version: 3.5.x
 - !ruby/object:Gem::Dependency
   name: responders
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.0.0
 description: This provides a storefront JSON REST API for the Workarea Commerce Platform.
   Useful for building apps, kiosks, etc.
 email:
@@ -81,7 +81,6 @@ files:
 - app/controllers/workarea/api/storefront/searches_controller.rb
 - app/controllers/workarea/api/storefront/system_content_controller.rb
 - app/controllers/workarea/api/storefront/taxons_controller.rb
-- app/controllers/workarea/api/storefront/user_activity.rb
 - app/controllers/workarea/storefront/application_controller.decorator
 - app/helpers/workarea/api/storefront/application_helper.rb
 - app/helpers/workarea/api/storefront/checkouts_helper.rb
@@ -89,7 +88,6 @@ files:
 - app/models/workarea/catalog/category.decorator
 - app/models/workarea/user.decorator
 - app/models/workarea/user/authentication_token.rb
-- app/view_models/workarea/api/storefront/search_suggestion_view_model.rb
 - app/views/workarea/api/storefront/accounts/_account.json.jbuilder
 - app/views/workarea/api/storefront/accounts/create.json.jbuilder
 - app/views/workarea/api/storefront/accounts/show.json.jbuilder
@@ -149,6 +147,7 @@ files:
 - config/routes.rb
 - lib/workarea/api/storefront.rb
 - lib/workarea/api/storefront/engine.rb
+- lib/workarea/api/storefront/visit.decorator
 - test/documentation/workarea/api/storefront/accounts_documentation_test.rb
 - test/documentation/workarea/api/storefront/analytics_documentation_test.rb
 - test/documentation/workarea/api/storefront/assets_documentation_test.rb
@@ -169,6 +168,7 @@ files:
 - test/documentation/workarea/api/storefront/saved_addresses_documentation_test.rb
 - test/documentation/workarea/api/storefront/saved_credit_cards_documentation_test.rb
 - test/documentation/workarea/api/storefront/searches_documentation_test.rb
+- test/documentation/workarea/api/storefront/segmentation_documentation_test.rb
 - test/documentation/workarea/api/storefront/system_content_documentation_test.rb
 - test/documentation/workarea/api/storefront/taxons_documentation_test.rb
 - test/documentation/workarea/api/storefront/validation_documentation_test.rb
@@ -246,6 +246,7 @@ files:
 - test/integration/workarea/api/storefront/saved_addresses_integration_test.rb
 - test/integration/workarea/api/storefront/saved_credit_cards_integration_test.rb
 - test/integration/workarea/api/storefront/searches_integration_test.rb
+- test/integration/workarea/api/storefront/segments_integration_test.rb
 - test/integration/workarea/api/storefront/system_content_integration_test.rb
 - test/integration/workarea/api/storefront/taxons_integration_test.rb
 - test/integration/workarea/api/storefront/user_carts_integration_test.rb
@@ -273,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Storefront JSON REST API for the Workarea Commerce Platform

data/app/controllers/workarea/api/storefront/user_activity.rb

@@ -1,36 +0,0 @@
-module Workarea
-  module Api
-    module Storefront
-      module UserActivity
-        extend ActiveSupport::Concern
-
-        def user_activity
-          @user_activity ||= Recommendation::UserActivity.find_or_initialize_by(
-            id: current_user_activity_id
-          )
-        end
-
-        def current_user_activity_id
-          if authentication?
-            current_user.id
-          else
-            params[:session_id]
-          end
-        end
-
-        def assert_current_user_activity_id
-          if current_user_activity_id.blank?
-            render(
-              json: {
-                problem: t('workarea.api.storefront.recent_views.missing_id')
-              },
-              status: :unprocessable_entity
-            )
-
-            return false
-          end
-        end
-      end
-    end
-  end
-end

data/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb

@@ -1,21 +0,0 @@
-module Workarea
-  module Api
-    module Storefront
-      class SearchSuggestionViewModel < Workarea::Storefront::SearchSuggestionViewModel
-        def url
-          helpers = Api::Storefront::Engine.routes.url_helpers
-
-          if suggestion_type == 'product'
-            helpers.product_path(product)
-          elsif suggestion_type == 'search'
-            helpers.search_path(q: name)
-          elsif suggestion_type == 'category'
-            helpers.category_path(source['slug'])
-          elsif suggestion_type == 'page'
-            helpers.page_path(source['slug'])
-          end
-        end
-      end
-    end
-  end
-end