workarea-api 4.4.6 → 4.5.4

data/doc/api/storefront/validation_errors/general_validation_errors.json

@@ -21,8 +21,9 @@
         "Referrer-Policy": "strict-origin-when-cross-origin",
         "Content-Type": "application/json; charset=utf-8",
         "Cache-Control": "no-cache, no-store, must-revalidate",
-        "X-Request-Id": "624a232f-2a82-415e-89b1-e9a474ad6da1",
-        "X-Runtime": "0.006536",
+        "X-Request-Id": "ba73618c-7816-4930-b249-c07a150c0e9c",
+        "X-Runtime": "0.007253",
+        "X-Workarea-Segments": "",
         "Expires": "0",
         "Content-Length": "59"
       },
@@ -40,6 +41,6 @@
   "resource": "Validation Errors",
   "description": "General validation errors",
   "route": "/api/storefront/account",
-  "explanation": "            This demonstrates API responses when invalid data is submitted.\n",
+  "explanation": "<p>This demonstrates API responses when invalid data is submitted.</p>\n",
   "http_method": "POST"
 }

data/lib/tasks/docs.rake

@@ -0,0 +1,20 @@
+load 'rails/test_unit/testing.rake'
+
+namespace :workarea do
+  namespace :test do
+    desc 'Generate Workarea API Documentation'
+    task api_docs: :'workarea:prepare' do
+      roots = [Workarea::Core::Engine.root] +
+                Workarea::Plugin.installed.map(&:root) +
+                [Rails.root]
+
+      ENV['GENERATE_API_DOCS'] = 'true'
+
+      Rails::TestUnit::Runner.rake_run(
+        roots
+          .map { |r| FileList["#{r}/test/documentation/**/*_test.rb"] }
+          .reduce(&:+)
+      )
+    end
+  end
+end

data/lib/workarea/api/documentation_test.rb

@@ -10,7 +10,7 @@ end
 module Workarea
   module Api
     class DocumentationTest < Workarea::IntegrationTest
-      IGNORED_HEADERS = %w(Host Accept)
+      IGNORED_HEADERS = %w(Host Accept X-Workarea-Segments)
 
       class Example
         attr_accessor :resource, :http_method, :route, :description,
@@ -22,6 +22,12 @@ module Workarea
           @requests = []
         end
 
+        def explanation=(value)
+          @explanation = Redcarpet::Markdown
+            .new(Redcarpet::Render::HTML.new(hard_wrap: true))
+            .render(value.strip_heredoc)
+        end
+
         def file_name
           name = @description.presence || "#{@http_method} #{@route}"
           "#{name.systemize}.json"
@@ -103,6 +109,9 @@ module Workarea
             end
           end
 
+          results['resources'].sort_by! { |r| r['name'] }
+          results['resources'].each { |r| r['examples'].sort_by! { |e| e['description'] } }
+
           File.open(root.join('index.json'), 'w') do |file|
             file.write(JSON.pretty_generate(results))
           end

data/lib/workarea/api/version.rb

@@ -1,5 +1,5 @@
 module Workarea
   module Api
-    VERSION = '4.4.6'.freeze
+    VERSION = '4.5.4'.freeze
   end
 end

data/storefront/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/storefront/README.md

@@ -48,11 +48,8 @@ curl \
   "http://yourincredibleheadlesscommercesolution.biz/api/carts.json"
 ```
 
-## Copyright & Licensing
+License
+--------------------------------------------------------------------------------
+Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)
 
-Copyright Workarea 2017-2019. All rights reserved.
-
-For licensing, contact [sales@workarea.com][].
-
-[Workarea API]: https://homebase.weblinc.com/plugins/workarea-api-admin
-[sales@workarea.com]: mailto:sales@workarea.com
+[Workarea API]: https://github.com/workarea-commerce/workarea-api

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