workarea-api 4.4.7 → 4.5.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (330) hide show
  1. checksums.yaml +4 -4
  2. data/.eslintrc.json +35 -0
  3. data/.github/workflows/ci.yml +35 -0
  4. data/.gitignore +1 -0
  5. data/.rubocop.yml +2 -0
  6. data/.stylelintrc.json +8 -0
  7. data/CHANGELOG.md +97 -7
  8. data/Gemfile +1 -2
  9. data/README.md +14 -1
  10. data/Rakefile +18 -8
  11. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
  12. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
  13. data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
  14. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
  15. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
  16. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
  17. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
  18. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
  19. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
  20. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
  21. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
  22. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
  23. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
  24. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
  25. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
  26. data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
  27. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
  28. data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +1 -1
  29. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  31. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  33. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  34. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  35. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  36. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  37. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  38. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  39. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  40. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  41. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  42. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  43. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  44. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  45. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  47. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  48. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  49. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  50. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  51. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  52. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  53. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  55. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  58. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  59. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  60. data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +14 -0
  61. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  63. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  65. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  66. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  67. data/admin/workarea-api-admin.gemspec +2 -2
  68. data/app/views/workarea/api/docs/nav.haml +12 -0
  69. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  70. data/doc/api/admin/categories/creating_a_category.json +11 -8
  71. data/doc/api/admin/categories/listing_categories.json +8 -5
  72. data/doc/api/admin/categories/removing_a_category.json +8 -4
  73. data/doc/api/admin/categories/showing_a_category.json +10 -7
  74. data/doc/api/admin/categories/updating_a_category.json +9 -5
  75. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  76. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  77. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  78. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  79. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  80. data/doc/api/admin/content/creating_content.json +11 -8
  81. data/doc/api/admin/content/listing_content.json +8 -5
  82. data/doc/api/admin/content/showing_content.json +10 -7
  83. data/doc/api/admin/content/updating_content.json +8 -4
  84. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  85. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  86. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  87. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  88. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  89. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  90. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  91. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  92. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  93. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  94. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  95. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  96. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  97. data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json +47 -0
  98. data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json +47 -0
  99. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  100. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  101. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  102. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  103. data/doc/api/admin/global_functionality/dealing_with_locales.json +86 -0
  104. data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json +56 -0
  105. data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json +56 -0
  106. data/doc/api/admin/global_functionality/paging_results.json +51 -0
  107. data/doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json +51 -0
  108. data/doc/api/admin/global_functionality/sorting_results.json +56 -0
  109. data/doc/api/admin/index.json +653 -578
  110. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  111. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  112. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  113. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  114. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  115. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  116. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  117. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  118. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  119. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  120. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  121. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  122. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  123. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  124. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  125. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  126. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  127. data/doc/api/admin/orders/listing_orders.json +8 -5
  128. data/doc/api/admin/orders/showing_an_order.json +8 -5
  129. data/doc/api/admin/orders/viewing_orders_by_date_range.json +17 -9
  130. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  131. data/doc/api/admin/pages/creating_a_page.json +11 -8
  132. data/doc/api/admin/pages/listing_pages.json +8 -5
  133. data/doc/api/admin/pages/removing_a_page.json +8 -4
  134. data/doc/api/admin/pages/showing_a_page.json +10 -7
  135. data/doc/api/admin/pages/updating_a_page.json +9 -5
  136. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  137. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  138. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  139. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  140. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  141. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  142. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  143. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  144. data/doc/api/admin/payments/listing_payments.json +7 -4
  145. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  146. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  147. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  148. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  149. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  150. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  151. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  152. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  153. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  154. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  155. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  156. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  157. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  158. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  159. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  160. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  161. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  162. data/doc/api/admin/products/creating_a_product.json +11 -8
  163. data/doc/api/admin/products/listing_products.json +8 -5
  164. data/doc/api/admin/products/removing_a_product.json +8 -4
  165. data/doc/api/admin/products/showing_a_product.json +10 -7
  166. data/doc/api/admin/products/updating_a_product.json +9 -5
  167. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  168. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  169. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  170. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  171. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  172. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  173. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  174. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  175. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  176. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  177. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  178. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  179. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  180. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  181. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +10 -6
  182. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  183. data/doc/api/admin/releases/creating_a_release.json +11 -8
  184. data/doc/api/admin/releases/listing_releases.json +8 -5
  185. data/doc/api/admin/releases/removing_a_release.json +8 -4
  186. data/doc/api/admin/releases/showing_a_release.json +10 -7
  187. data/doc/api/admin/releases/updating_a_release.json +9 -5
  188. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  189. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  190. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  191. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  192. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  193. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  194. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  195. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  196. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  197. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  198. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  199. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  200. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  201. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  202. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  203. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  204. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  205. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  206. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +10 -7
  207. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  208. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  209. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  210. data/doc/api/admin/tax_categories/listing_tax_categories.json +8 -5
  211. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  212. data/doc/api/admin/tax_categories/showing_a_tax_category.json +10 -7
  213. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  214. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  215. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  216. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  217. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  218. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  219. data/doc/api/admin/users/creating_a_user.json +11 -8
  220. data/doc/api/admin/users/listing_users.json +8 -5
  221. data/doc/api/admin/users/removing_a_user.json +8 -4
  222. data/doc/api/admin/users/showing_a_user.json +10 -12
  223. data/doc/api/admin/users/showing_a_user_by_email.json +47 -0
  224. data/doc/api/admin/users/showing_a_user_by_id.json +47 -0
  225. data/doc/api/admin/users/updating_a_user.json +9 -5
  226. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  227. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  228. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  229. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  230. data/doc/api/storefront/accounts/creating_an_account.json +8 -7
  231. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  232. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  233. data/doc/api/storefront/analytics/saving_a_category_view.json +19 -6
  234. data/doc/api/storefront/analytics/saving_a_product_view.json +19 -6
  235. data/doc/api/storefront/analytics/saving_a_search.json +19 -6
  236. data/doc/api/storefront/assets/showing_an_asset.json +10 -9
  237. data/doc/api/storefront/authentication/creating_an_authentication_token.json +10 -9
  238. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +10 -9
  239. data/doc/api/storefront/authentication/using_an_authentication_token.json +11 -10
  240. data/doc/api/storefront/cart/adding_a_promo_code.json +11 -10
  241. data/doc/api/storefront/cart/adding_an_item.json +11 -10
  242. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +10 -9
  243. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +8 -7
  244. data/doc/api/storefront/cart/delete_an_item.json +11 -10
  245. data/doc/api/storefront/cart/listing_user_s_carts.json +10 -9
  246. data/doc/api/storefront/cart/showing_cart.json +11 -10
  247. data/doc/api/storefront/cart/updating_an_item.json +11 -10
  248. data/doc/api/storefront/categories/showing_a_category.json +9 -8
  249. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +9 -8
  250. data/doc/api/storefront/checkout/completing_a_checkout.json +11 -10
  251. data/doc/api/storefront/checkout/failure_to_update_a_checkout.json +52 -0
  252. data/doc/api/storefront/checkout/showing_a_checkout.json +11 -10
  253. data/doc/api/storefront/checkout/updating_a_checkout.json +10 -9
  254. data/doc/api/storefront/contacts/creating_a_contact.json +8 -7
  255. data/doc/api/storefront/email_signups/creating_an_email_signup.json +8 -7
  256. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +8 -7
  257. data/doc/api/storefront/index.json +269 -257
  258. data/doc/api/storefront/menus/listing_menus.json +9 -8
  259. data/doc/api/storefront/menus/showing_a_menu.json +11 -10
  260. data/doc/api/storefront/orders/listing_the_user_s_orders.json +10 -9
  261. data/doc/api/storefront/orders/showing_an_order.json +11 -10
  262. data/doc/api/storefront/pages/showing_a_page.json +9 -8
  263. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +9 -7
  264. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +11 -11
  265. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +11 -10
  266. data/doc/api/storefront/products/showing_a_product.json +9 -8
  267. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +9 -8
  268. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +11 -10
  269. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +12 -12
  270. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +7 -5
  271. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +9 -7
  272. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  273. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  274. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +10 -9
  275. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  276. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  277. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +9 -8
  278. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  279. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +10 -9
  280. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  281. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +10 -9
  282. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +10 -9
  283. data/doc/api/storefront/searches/showing_search_results.json +9 -8
  284. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  285. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  286. data/doc/api/storefront/system_content/showing_system_content.json +9 -8
  287. data/doc/api/storefront/system_content/showing_the_home_page.json +9 -8
  288. data/doc/api/storefront/taxons/showing_a_taxon.json +11 -10
  289. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +12 -11
  290. data/doc/api/storefront/validation_errors/general_validation_errors.json +5 -4
  291. data/lib/tasks/docs.rake +20 -0
  292. data/lib/workarea/api/documentation_test.rb +10 -1
  293. data/lib/workarea/api/version.rb +1 -1
  294. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  295. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  296. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  297. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  298. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  299. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  300. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  301. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  302. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  303. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  304. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  305. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  306. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  307. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  308. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  309. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  310. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  311. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  312. data/storefront/config/initializers/config.rb +19 -0
  313. data/storefront/lib/workarea/api/storefront.rb +1 -0
  314. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  315. data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +21 -0
  316. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  317. data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +1 -1
  318. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  319. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  320. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  321. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  322. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  323. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  324. data/storefront/workarea-api-storefront.gemspec +2 -2
  325. data/workarea-api.gemspec +1 -1
  326. metadata +32 -13
  327. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  328. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  329. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  330. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
@@ -18,34 +18,35 @@
18
18
  "X-Download-Options": "noopen",
19
19
  "X-Permitted-Cross-Domain-Policies": "none",
20
20
  "Referrer-Policy": "strict-origin-when-cross-origin",
21
- "Date": "Thu, 22 Aug 2019 17:02:10 GMT",
21
+ "Date": "Wed, 19 Aug 2020 13:55:29 GMT",
22
22
  "Content-Type": "application/json; charset=utf-8",
23
23
  "Access-Control-Allow-Origin": "*",
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 19 Aug 2020 13:55:29 GMT",
28
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
29
- "ETag": "W/\"68a6afbf1d116813312ea2a8cb13646d\"",
30
- "X-Request-Id": "335b1d1a-a625-4d60-b1d5-774f0d1d5b7b",
31
- "X-Runtime": "0.009750",
30
+ "X-Request-Id": "b0eb5722-8d04-4656-9d95-9aedaebebf17",
31
+ "X-Runtime": "0.013856",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "534"
34
35
  },
35
36
  "request_method": "GET",
36
- "request_path": "/api/storefront/taxons/5d5eca92d4322a04dfbf6f44",
37
+ "request_path": "/api/storefront/taxons/5f3d2f510218236e938cf11a",
37
38
  "request_body": null,
38
39
  "request_content_type": null,
39
40
  "response_status": 200,
40
41
  "response_status_text": "OK",
41
- "response_body": "{\n \"taxon\": {\n \"id\": \"5d5eca92d4322a04dfbf6f44\",\n \"url\": \"/api/storefront/taxons/5d5eca92d4322a04dfbf6f44\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": \"http://example.com/pages/mens\",\n \"parent_id\": \"5d5eca92d4322a04dfbf6f45\",\n \"parent_ids\": [\n \"5d5eca92d4322a04dfbf6f45\"\n ],\n \"position\": 0\n },\n \"children\": [\n {\n \"id\": \"5d5eca92d4322a04dfbf6f46\",\n \"url\": \"/api/storefront/taxons/5d5eca92d4322a04dfbf6f46\",\n \"name\": \"Sale\",\n \"depth\": 2,\n \"navigable_url\": null,\n \"parent_id\": \"5d5eca92d4322a04dfbf6f44\",\n \"parent_ids\": [\n \"5d5eca92d4322a04dfbf6f45\",\n \"5d5eca92d4322a04dfbf6f44\"\n ],\n \"position\": 0\n }\n ]\n}",
42
+ "response_body": "{\n \"taxon\": {\n \"id\": \"5f3d2f510218236e938cf11a\",\n \"url\": \"/api/storefront/taxons/5f3d2f510218236e938cf11a\",\n \"name\": \"Mens\",\n \"depth\": 1,\n \"navigable_url\": \"http://example.com/pages/mens\",\n \"parent_id\": \"5f3d2f510218236e938cf11b\",\n \"parent_ids\": [\n \"5f3d2f510218236e938cf11b\"\n ],\n \"position\": 0\n },\n \"children\": [\n {\n \"id\": \"5f3d2f510218236e938cf11c\",\n \"url\": \"/api/storefront/taxons/5f3d2f510218236e938cf11c\",\n \"name\": \"Sale\",\n \"depth\": 2,\n \"navigable_url\": null,\n \"parent_id\": \"5f3d2f510218236e938cf11a\",\n \"parent_ids\": [\n \"5f3d2f510218236e938cf11b\",\n \"5f3d2f510218236e938cf11a\"\n ],\n \"position\": 0\n }\n ]\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5d5eca92d4322a04dfbf6f44\" -X GET "
44
+ "curl": "curl -g \"https://www.example.com/api/storefront/taxons/5f3d2f510218236e938cf11a\" -X GET "
44
45
  }
45
46
  ],
46
47
  "resource": "Taxons",
47
48
  "description": "Showing a taxon",
48
49
  "route": "/api/storefront/taxons/:id",
49
- "http_method": "GET",
50
- "explanation": " This endpoint will show details on a particular node (or taxon) of\n the site taxonomy, along with its children.\n"
50
+ "explanation": "<p>This endpoint will show details on a particular node (or taxon) of<br>\nthe site taxonomy, along with its children.</p>\n",
51
+ "http_method": "GET"
51
52
  }
@@ -24,28 +24,29 @@
24
24
  "Access-Control-Allow-Headers": "*",
25
25
  "Access-Control-Allow-Methods": "GET, POST, PATCH, PUT, DELETE, OPTIONS",
26
26
  "X-Requested-With": "",
27
- "Vary": "X-Requested-With, X-Flash-Messages",
28
- "ETag": "W/\"1c738b755ccc1b901b10d9fd9e7b24de\"",
27
+ "Vary": "X-Requested-With, X-Workarea-Segments",
28
+ "Last-Modified": "Wed, 19 Aug 2020 13:54:56 GMT",
29
29
  "Cache-Control": "no-cache, no-store, must-revalidate",
30
- "X-Request-Id": "df8c92ae-b1f8-48d9-9497-d49dd15b9f03",
31
- "X-Runtime": "0.491660",
30
+ "X-Request-Id": "042fc2df-60ed-489f-90c0-37926f3dea56",
31
+ "X-Runtime": "0.579544",
32
+ "X-Workarea-Segments": "",
32
33
  "Expires": "0",
33
34
  "Content-Length": "3271"
34
35
  },
35
36
  "request_method": "PATCH",
36
- "request_path": "/api/storefront/checkouts/B90394D2D5",
37
+ "request_path": "/api/storefront/checkouts/42F1747F29",
37
38
  "request_body": "{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}",
38
39
  "request_content_type": "application/json",
39
- "response_status": 200,
40
- "response_status_text": "OK",
41
- "response_body": "{\n \"order\": {\n \"id\": \"B90394D2D5\",\n \"url\": \"http://www.example.com/api/storefront/orders/B90394D2D5\",\n \"user_id\": null,\n \"email\": \"susanb@\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5d5eca6ed4322a04dfbf6d7a\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1566493120\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1566493120\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1566493120\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1566493120\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1566493120\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n },\n \"checkout\": {\n \"url\": \"http://www.example.com/api/storefront/checkouts/B90394D2D5\",\n \"started_at\": \"2019-08-22T17:01:34.556Z\",\n \"shippable\": false,\n \"complete\": false,\n \"addresses\": {\n \"complete\": false,\n \"email\": \"susanb@\",\n \"problems\": [\n \"Email is invalid\"\n ],\n \"shipping_address\": {\n \"id\": \"5d5eca6fd4322a04dfbf6d81\",\n \"first_name\": \"\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"First name can't be blank\"\n ]\n },\n \"billing_address\": {\n \"id\": \"5d5eca6fd4322a04dfbf6d82\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"Street can't be blank\"\n ]\n }\n },\n \"shipping\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\n ],\n \"shipping_service\": null,\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"shipping_options\": [\n\n ]\n },\n \"payment\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\n ],\n \"tenders\": [\n\n ]\n }\n }\n}",
40
+ "response_status": 422,
41
+ "response_status_text": "Unprocessable Entity",
42
+ "response_body": "{\n \"order\": {\n \"id\": \"42F1747F29\",\n \"url\": \"http://www.example.com/api/storefront/orders/42F1747F29\",\n \"user_id\": null,\n \"email\": \"susanb@\",\n \"placed_at\": null,\n \"canceled_at\": null,\n \"promo_codes\": [\n\n ],\n \"requires_shipping\": true,\n \"items\": [\n {\n \"id\": \"5f3d2f300218236e938cee2b\",\n \"product_id\": \"VINTEE\",\n \"sku\": \"VT001\",\n \"quantity\": 2,\n \"product_url\": \"http://www.example.com/api/storefront/products/vintage-tee?sku=VT001\",\n \"options\": {\n },\n \"customizations\": {\n },\n \"product_image\": {\n \"urls\": [\n {\n \"type\": \"small\",\n \"url\": \"http://www.example.com/product_images/placeholder/small.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium.jpg?c=1597845226\"\n },\n {\n \"type\": \"small_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/small_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"medium_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/medium_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"large_thumb\",\n \"url\": \"http://www.example.com/product_images/placeholder/large_thumb.jpg?c=1597845226\"\n },\n {\n \"type\": \"detail\",\n \"url\": \"http://www.example.com/product_images/placeholder/detail.jpg?c=1597845226\"\n },\n {\n \"type\": \"zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"super_zoom\",\n \"url\": \"http://www.example.com/product_images/placeholder/super_zoom.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon.jpg?c=1597845226\"\n },\n {\n \"type\": \"favicon_ico\",\n \"url\": \"http://www.example.com/product_images/placeholder/favicon_ico.jpg?c=1597845226\"\n }\n ]\n },\n \"pricing\": {\n \"price_adjustments\": [\n {\n \"description\": \"Item Subtotal\",\n \"discount\": false,\n \"amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n }\n ],\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"on_sale\": false,\n \"original_unit_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"original_price\": {\n \"cents\": 500.0,\n \"currency_iso\": \"USD\"\n },\n \"customized\": false,\n \"customizations_unit_price\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n }\n }\n }\n ],\n \"pricing\": {\n \"price_adjustments\": [\n\n ],\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"tax_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"subtotal_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"total_price\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n },\n \"paid_amount\": {\n \"cents\": 1000.0,\n \"currency_iso\": \"USD\"\n }\n },\n \"shipping_service\": null,\n \"tenders\": [\n\n ]\n },\n \"checkout\": {\n \"url\": \"http://www.example.com/api/storefront/checkouts/42F1747F29\",\n \"started_at\": \"2020-08-19T13:54:56.210Z\",\n \"shippable\": false,\n \"complete\": false,\n \"addresses\": {\n \"complete\": false,\n \"email\": \"susanb@\",\n \"problems\": [\n \"Email is invalid\"\n ],\n \"shipping_address\": {\n \"id\": \"5f3d2f300218236e938cee32\",\n \"first_name\": \"\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"350 Fifth Avenue\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"First name can't be blank\"\n ]\n },\n \"billing_address\": {\n \"id\": \"5f3d2f300218236e938cee33\",\n \"first_name\": \"Susan\",\n \"last_name\": \"Baker\",\n \"company\": null,\n \"street\": \"\",\n \"street_2\": null,\n \"city\": \"New York\",\n \"country\": \"US\",\n \"region\": \"NY\",\n \"postal_code\": \"10118\",\n \"phone_number\": null,\n \"phone_extension\": null,\n \"problems\": [\n \"Street can't be blank\"\n ]\n }\n },\n \"shipping\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\n ],\n \"shipping_service\": null,\n \"shipping_total\": {\n \"cents\": 0.0,\n \"currency_iso\": \"USD\"\n },\n \"shipping_options\": [\n\n ]\n },\n \"payment\": {\n \"complete\": false,\n \"problems\": [\n \"Address is invalid\"\n ],\n \"tenders\": [\n\n ]\n }\n }\n}",
42
43
  "response_content_type": "application/json",
43
- "curl": "curl \"https://www.example.com/api/storefront/checkouts/B90394D2D5\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
44
+ "curl": "curl \"https://www.example.com/api/storefront/checkouts/42F1747F29\" -d '{\"email\":\"susanb@\",\"shipping_address\":{\"first_name\":\"\",\"last_name\":\"Baker\",\"street\":\"350 Fifth Avenue\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"},\"billing_address\":{\"first_name\":\"Susan\",\"last_name\":\"Baker\",\"street\":\"\",\"city\":\"New York\",\"region\":\"NY\",\"country\":\"US\",\"postal_code\":\"10118\"}}' -X PATCH \\\n\t-H \"Content-Type: application/json\""
44
45
  }
45
46
  ],
46
47
  "resource": "Validation Errors",
47
48
  "description": "Checkout validation errors",
48
49
  "route": "/api/storefront/checkouts/:id",
49
- "http_method": "PATCH",
50
- "explanation": " Due to the more complex nature of checkout updates and data,\n checkout validation errors are returned inline with the resource\n they are coming from as shown below. Note the response status can be\n 200 OK, due to some data being persisted properly.\n"
50
+ "explanation": "<p>Due to the more complex nature of checkout updates and data,<br>\ncheckout validation errors are returned inline with the resource<br>\nthey are coming from as shown below. Note the response status can be<br>\n200 OK, due to some data being persisted properly.</p>\n",
51
+ "http_method": "PATCH"
51
52
  }
@@ -21,8 +21,9 @@
21
21
  "Referrer-Policy": "strict-origin-when-cross-origin",
22
22
  "Content-Type": "application/json; charset=utf-8",
23
23
  "Cache-Control": "no-cache, no-store, must-revalidate",
24
- "X-Request-Id": "9cf31710-98e2-4a0e-a0e9-8c98d3044773",
25
- "X-Runtime": "0.008732",
24
+ "X-Request-Id": "08cd60aa-3701-4cba-b912-33cfa24b6354",
25
+ "X-Runtime": "0.008567",
26
+ "X-Workarea-Segments": "",
26
27
  "Expires": "0",
27
28
  "Content-Length": "59"
28
29
  },
@@ -40,6 +41,6 @@
40
41
  "resource": "Validation Errors",
41
42
  "description": "General validation errors",
42
43
  "route": "/api/storefront/account",
43
- "http_method": "POST",
44
- "explanation": " This demonstrates API responses when invalid data is submitted.\n"
44
+ "explanation": "<p>This demonstrates API responses when invalid data is submitted.</p>\n",
45
+ "http_method": "POST"
45
46
  }
@@ -0,0 +1,20 @@
1
+ load 'rails/test_unit/testing.rake'
2
+
3
+ namespace :workarea do
4
+ namespace :test do
5
+ desc 'Generate Workarea API Documentation'
6
+ task api_docs: :'workarea:prepare' do
7
+ roots = [Workarea::Core::Engine.root] +
8
+ Workarea::Plugin.installed.map(&:root) +
9
+ [Rails.root]
10
+
11
+ ENV['GENERATE_API_DOCS'] = 'true'
12
+
13
+ Rails::TestUnit::Runner.rake_run(
14
+ roots
15
+ .map { |r| FileList["#{r}/test/documentation/**/*_test.rb"] }
16
+ .reduce(&:+)
17
+ )
18
+ end
19
+ end
20
+ end
@@ -10,7 +10,7 @@ end
10
10
  module Workarea
11
11
  module Api
12
12
  class DocumentationTest < Workarea::IntegrationTest
13
- IGNORED_HEADERS = %w(Host Accept)
13
+ IGNORED_HEADERS = %w(Host Accept X-Workarea-Segments)
14
14
 
15
15
  class Example
16
16
  attr_accessor :resource, :http_method, :route, :description,
@@ -22,6 +22,12 @@ module Workarea
22
22
  @requests = []
23
23
  end
24
24
 
25
+ def explanation=(value)
26
+ @explanation = Redcarpet::Markdown
27
+ .new(Redcarpet::Render::HTML.new(hard_wrap: true))
28
+ .render(value.strip_heredoc)
29
+ end
30
+
25
31
  def file_name
26
32
  name = @description.presence || "#{@http_method} #{@route}"
27
33
  "#{name.systemize}.json"
@@ -103,6 +109,9 @@ module Workarea
103
109
  end
104
110
  end
105
111
 
112
+ results['resources'].sort_by! { |r| r['name'] }
113
+ results['resources'].each { |r| r['examples'].sort_by! { |e| e['description'] } }
114
+
106
115
  File.open(root.join('index.json'), 'w') do |file|
107
116
  file.write(JSON.pretty_generate(results))
108
117
  end
@@ -1,5 +1,5 @@
1
1
  module Workarea
2
2
  module Api
3
- VERSION = '4.4.7'.freeze
3
+ VERSION = '4.5.5'.freeze
4
4
  end
5
5
  end
@@ -1,38 +1,50 @@
1
1
  module Workarea
2
2
  module Api
3
3
  module Storefront
4
- class AnalyticsController < ActionController::Metal
5
- include ActionController::Head
6
- include ActionController::Instrumentation
7
-
4
+ class AnalyticsController < Api::Storefront::ApplicationController
8
5
  def category_view
9
6
  Metrics::CategoryByDay.inc(key: { category_id: params[:category_id] }, views: 1)
7
+
8
+ if current_metrics_id.present?
9
+ Metrics::User.save_affinity(
10
+ id: current_metrics_id,
11
+ action: 'viewed',
12
+ category_ids: params[:category_id]
13
+ )
14
+ end
15
+
10
16
  head :ok
11
17
  end
12
18
 
13
19
  def product_view
14
20
  Metrics::ProductByDay.inc(key: { product_id: params[:product_id] }, views: 1)
21
+
22
+ if current_metrics_id.present?
23
+ Metrics::User.save_affinity(
24
+ id: current_metrics_id,
25
+ action: 'viewed',
26
+ product_ids: params[:product_id]
27
+ )
28
+ end
29
+
15
30
  head :ok
16
31
  end
17
32
 
18
33
  def search
19
- Metrics::SearchByDay.save_search(params[:q], params[:total_results])
20
- head :ok
21
- end
34
+ query_string = QueryString.new(params[:q])
22
35
 
23
- def search_abandonment
24
- warn <<~eos
25
- DEPRECATION WARNING: Search abandonment tracking is deprecated and will be removed \
26
- in Workarea 3.5.
27
- eos
28
- head :ok
29
- end
36
+ if query_string.present? && !query_string.short?
37
+ Metrics::SearchByDay.save_search(params[:q], params[:total_results])
38
+
39
+ if current_metrics_id.present?
40
+ Metrics::User.save_affinity(
41
+ id: current_metrics_id,
42
+ action: 'viewed',
43
+ search_ids: query_string.id
44
+ )
45
+ end
46
+ end
30
47
 
31
- def filters
32
- warn <<~eos
33
- DEPRECATION WARNING: Filter analytics tracking is deprecated and will be removed \
34
- in Workarea 3.5.
35
- eos
36
48
  head :ok
37
49
  end
38
50
  end
@@ -2,15 +2,15 @@ module Workarea
2
2
  module Api
3
3
  module Storefront
4
4
  class ApplicationController < Workarea::ApplicationController
5
- include Workarea::Storefront::HttpCaching
5
+ include HttpCaching
6
6
  include Api::Storefront::Authentication
7
- include Api::Storefront::UserActivity
8
7
 
9
8
  respond_to :json
10
9
 
11
10
  before_action :set_json_format
12
11
  before_action :skip_session
13
12
  before_action { params.permit! }
13
+ around_action :apply_segments
14
14
  after_action :disable_cors_protection
15
15
 
16
16
  rescue_from Mongoid::Errors::DocumentNotFound, with: :handle_not_found
@@ -28,6 +28,19 @@ module Workarea
28
28
  request.session_options[:skip] = true
29
29
  end
30
30
 
31
+ def assert_current_metrics_id
32
+ if current_metrics_id.blank?
33
+ render(
34
+ json: {
35
+ problem: t('workarea.api.storefront.recent_views.missing_id')
36
+ },
37
+ status: :unprocessable_entity
38
+ )
39
+
40
+ return false
41
+ end
42
+ end
43
+
31
44
  private
32
45
 
33
46
  def set_json_format
@@ -10,19 +10,16 @@ module Workarea
10
10
  helper_method :current_user
11
11
  end
12
12
 
13
- def current_user
14
- return @current_user if defined?(@current_user)
15
-
16
- user = authenticate_with_http_token do |token, options|
17
- User::AuthenticationToken.authenticate(token, options).try(:user)
18
- end
13
+ def self.find_user(token, options)
14
+ User::AuthenticationToken.authenticate(token, options).try(:user)
15
+ end
19
16
 
20
- @current_user = user || raise(InvalidError)
17
+ def current_user
18
+ current_visit.current_user || raise(InvalidError)
21
19
  end
22
20
 
23
21
  def authentication?
24
- regex = ActionController::HttpAuthentication::Token::TOKEN_REGEX
25
- request.authorization.to_s[regex].present?
22
+ current_visit.logged_in?
26
23
  end
27
24
  end
28
25
  end
@@ -5,7 +5,7 @@ module Workarea
5
5
  before_action :cache_page
6
6
 
7
7
  def index
8
- models = Catalog::Category.active.page(params[:page])
8
+ models = Catalog::Category.page(params[:page]).select(&:active?)
9
9
  @categories = Workarea::Storefront::CategoryViewModel.wrap(
10
10
  models,
11
11
  view_model_options
@@ -14,6 +14,8 @@ module Workarea
14
14
 
15
15
  def show
16
16
  model = Catalog::Category.find_by(slug: params[:id])
17
+ raise InvalidDisplay unless model.active?
18
+
17
19
  @category = Workarea::Storefront::CategoryViewModel.wrap(
18
20
  model,
19
21
  view_model_options
@@ -96,7 +96,6 @@ module Workarea
96
96
  if authentication?
97
97
  current_order.touch_checkout!(
98
98
  ip_address: request.remote_ip,
99
- user_activity_id: current_user.id,
100
99
  checkout_by_id: current_user.id,
101
100
  source: 'storefront_api'
102
101
  )
@@ -10,7 +10,9 @@ module Workarea
10
10
  end
11
11
 
12
12
  def show
13
- model = Navigation::Menu.active.find(params[:id])
13
+ model = Navigation::Menu.find(params[:id])
14
+ raise InvalidDisplay unless model.active?
15
+
14
16
  @menu = Workarea::Storefront::MenuViewModel.wrap(model, params)
15
17
  end
16
18
  end
@@ -5,7 +5,9 @@ module Workarea
5
5
  before_action :cache_page
6
6
 
7
7
  def show
8
- model = Content::Page.active.find_by(slug: params[:id])
8
+ model = Content::Page.find_by(slug: params[:id])
9
+ raise InvalidDisplay unless model.active?
10
+
9
11
  @page = Workarea::Storefront::PageViewModel.new(model, view_model_options)
10
12
  end
11
13
  end
@@ -5,7 +5,9 @@ module Workarea
5
5
  before_action :cache_page
6
6
 
7
7
  def show
8
- model = Workarea::Catalog::Product.active.find_by(slug: params[:id])
8
+ model = Workarea::Catalog::Product.find_by(slug: params[:id])
9
+ raise InvalidDisplay unless model.active?
10
+
9
11
  @product = Workarea::Storefront::ProductViewModel.wrap(
10
12
  model,
11
13
  view_model_options
@@ -2,39 +2,26 @@ module Workarea
2
2
  module Api
3
3
  module Storefront
4
4
  class RecentViewsController < Api::Storefront::ApplicationController
5
- before_action :assert_current_user_activity_id
5
+ before_action :assert_current_metrics_id
6
6
 
7
7
  def show
8
- if stale?(
9
- etag: user_activity,
10
- last_modified: user_activity.updated_at,
11
- public: true
8
+ @recent_views = Workarea::Storefront::UserActivityViewModel.new(
9
+ current_metrics
12
10
  )
13
- @recent_views = Workarea::Storefront::UserActivityViewModel.new(
14
- user_activity
15
- )
16
- end
17
11
  end
18
12
 
19
13
  def update
20
- if params[:product_id].present?
21
- Recommendation::UserActivity.save_product(
22
- current_user_activity_id,
23
- params[:product_id]
24
- )
25
- end
26
-
27
- if params[:category_id].present?
28
- Recommendation::UserActivity.save_category(
29
- current_user_activity_id,
30
- params[:category_id]
31
- )
32
- end
14
+ product_ids = Array.wrap(params[:product_id])
15
+ category_ids = Array.wrap(params[:category_id])
16
+ search_ids = Array.wrap(params[:search])
33
17
 
34
- if params[:search].present?
35
- Recommendation::UserActivity.save_search(
36
- current_user_activity_id,
37
- params[:search]
18
+ if current_metrics_id.present?
19
+ Metrics::User.save_affinity(
20
+ id: current_metrics_id,
21
+ action: 'viewed',
22
+ product_ids: product_ids,
23
+ category_ids: category_ids,
24
+ search_ids: search_ids
38
25
  )
39
26
  end
40
27
 
@@ -2,17 +2,11 @@ module Workarea
2
2
  module Api
3
3
  module Storefront
4
4
  class RecommendationsController < Api::Storefront::ApplicationController
5
- before_action :assert_current_user_activity_id
5
+ before_action :assert_current_metrics_id
6
6
 
7
7
  def show
8
- fresh_when(
9
- etag: user_activity,
10
- last_modified: user_activity.updated_at,
11
- public: true
12
- )
13
-
14
8
  @recommendations = Workarea::Storefront::PersonalizedRecommendationsViewModel.new(
15
- user_activity,
9
+ current_metrics,
16
10
  view_model_options
17
11
  )
18
12
  end
@@ -4,18 +4,6 @@ module Workarea
4
4
  class SearchesController < Api::Storefront::ApplicationController
5
5
  before_action :cache_page
6
6
 
7
- def index
8
- search_query = QueryString.new(params[:q]).sanitized
9
-
10
- render(nothing: true) && (return) if search_query.blank?
11
- autocomplete_params = params.permit(:q)
12
- search = Search::SearchSuggestions.new(autocomplete_params)
13
-
14
- @results = search.results.map do |result|
15
- SearchSuggestionViewModel.new(result).to_h
16
- end
17
- end
18
-
19
7
  def show
20
8
  response = Search::StorefrontSearch.new(params.to_unsafe_h).response
21
9
  @search = Workarea::Storefront::SearchViewModel.new(