workarea-api 4.4.7 → 4.5.0

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