workarea-api 4.4.6 → 4.5.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (333) 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 +87 -7
  8. data/Gemfile +1 -2
  9. data/README.md +23 -16
  10. data/Rakefile +16 -6
  11. data/admin/LICENSE +52 -0
  12. data/admin/README.md +4 -7
  13. data/admin/app/controllers/workarea/api/admin/categories_controller.rb +6 -0
  14. data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb +6 -0
  15. data/admin/app/controllers/workarea/api/admin/content_controller.rb +6 -0
  16. data/admin/app/controllers/workarea/api/admin/discounts_controller.rb +7 -0
  17. data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb +20 -4
  18. data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb +6 -1
  19. data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb +7 -0
  20. data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb +7 -0
  21. data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb +7 -0
  22. data/admin/app/controllers/workarea/api/admin/orders_controller.rb +19 -1
  23. data/admin/app/controllers/workarea/api/admin/pages_controller.rb +7 -0
  24. data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb +7 -0
  25. data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb +7 -0
  26. data/admin/app/controllers/workarea/api/admin/payments_controller.rb +7 -0
  27. data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb +7 -0
  28. data/admin/app/controllers/workarea/api/admin/products_controller.rb +11 -4
  29. data/admin/app/controllers/workarea/api/admin/promo_code_lists_controller.rb +7 -0
  30. data/admin/app/controllers/workarea/api/admin/recommendation_settings_controller.rb +1 -1
  31. data/admin/app/controllers/workarea/api/admin/redirects_controller.rb +7 -0
  32. data/admin/app/controllers/workarea/api/admin/releases_controller.rb +7 -0
  33. data/admin/app/controllers/workarea/api/admin/shipping_services_controller.rb +7 -0
  34. data/admin/app/controllers/workarea/api/admin/shippings_controller.rb +7 -0
  35. data/admin/app/controllers/workarea/api/admin/swagger_controller.rb +33 -0
  36. data/admin/app/controllers/workarea/api/admin/tax_categories_controller.rb +2 -0
  37. data/admin/app/controllers/workarea/api/admin/users_controller.rb +28 -14
  38. data/admin/app/models/workarea/api/admin/date_filtering.rb +27 -0
  39. data/admin/lib/workarea/api/admin/engine.rb +11 -0
  40. data/admin/test/documentation/workarea/api/admin/email_signups_documentation_test.rb +14 -2
  41. data/admin/test/documentation/workarea/api/admin/global_functionality_documentation_test.rb +140 -0
  42. data/admin/test/documentation/workarea/api/admin/orders_documentation_test.rb +13 -6
  43. data/admin/test/documentation/workarea/api/admin/users_documentation_test.rb +14 -2
  44. data/admin/test/dummy/config/initializers/session_store.rb +3 -1
  45. data/admin/test/integration/workarea/api/admin/categories_integration_test.rb +32 -0
  46. data/admin/test/integration/workarea/api/admin/content_assets_integration_test.rb +32 -0
  47. data/admin/test/integration/workarea/api/admin/content_integration_test.rb +32 -0
  48. data/admin/test/integration/workarea/api/admin/discounts_integration_test.rb +32 -0
  49. data/admin/test/integration/workarea/api/admin/email_signups_integration_test.rb +38 -1
  50. data/admin/test/integration/workarea/api/admin/fulfillments_integration_test.rb +22 -0
  51. data/admin/test/integration/workarea/api/admin/inventory_skus_integration_test.rb +32 -0
  52. data/admin/test/integration/workarea/api/admin/navigation_menus_integration_test.rb +32 -0
  53. data/admin/test/integration/workarea/api/admin/navigation_taxons_integration_test.rb +32 -0
  54. data/admin/test/integration/workarea/api/admin/orders_integration_test.rb +41 -2
  55. data/admin/test/integration/workarea/api/admin/pages_integration_test.rb +32 -0
  56. data/admin/test/integration/workarea/api/admin/payment_profiles_integration_test.rb +32 -0
  57. data/admin/test/integration/workarea/api/admin/payment_transactions_integration_test.rb +32 -0
  58. data/admin/test/integration/workarea/api/admin/payments_integration_test.rb +32 -0
  59. data/admin/test/integration/workarea/api/admin/pricing_skus_integration_test.rb +32 -0
  60. data/admin/test/integration/workarea/api/admin/products_integration_test.rb +35 -0
  61. data/admin/test/integration/workarea/api/admin/promo_code_lists_integration_test.rb +31 -0
  62. data/admin/test/integration/workarea/api/admin/recommendation_settings_integration_test.rb +14 -0
  63. data/admin/test/integration/workarea/api/admin/redirects_integration_test.rb +31 -0
  64. data/admin/test/integration/workarea/api/admin/releases_integration_test.rb +31 -0
  65. data/admin/test/integration/workarea/api/admin/shipping_services_integration_test.rb +31 -0
  66. data/admin/test/integration/workarea/api/admin/shippings_integration_test.rb +31 -0
  67. data/admin/test/integration/workarea/api/admin/tax_categories_integration_test.rb +31 -0
  68. data/admin/test/integration/workarea/api/admin/users_integration_test.rb +44 -1
  69. data/admin/workarea-api-admin.gemspec +7 -6
  70. data/app/views/workarea/api/docs/nav.haml +12 -0
  71. data/doc/api/admin/categories/bulk_upserting_categories.json +8 -4
  72. data/doc/api/admin/categories/creating_a_category.json +11 -8
  73. data/doc/api/admin/categories/listing_categories.json +8 -5
  74. data/doc/api/admin/categories/removing_a_category.json +8 -4
  75. data/doc/api/admin/categories/showing_a_category.json +10 -7
  76. data/doc/api/admin/categories/updating_a_category.json +9 -5
  77. data/doc/api/admin/category_product_rules/creating_a_category_product_rule.json +11 -8
  78. data/doc/api/admin/category_product_rules/listing_category_product_rules.json +10 -7
  79. data/doc/api/admin/category_product_rules/removing_a_category_product_rule.json +8 -4
  80. data/doc/api/admin/category_product_rules/updating_a_category_product_rule.json +8 -4
  81. data/doc/api/admin/content/bulk_upserting_content.json +8 -4
  82. data/doc/api/admin/content/creating_content.json +11 -8
  83. data/doc/api/admin/content/listing_content.json +8 -5
  84. data/doc/api/admin/content/showing_content.json +10 -7
  85. data/doc/api/admin/content/updating_content.json +8 -4
  86. data/doc/api/admin/content_assets/bulk_upserting_content_assets.json +8 -4
  87. data/doc/api/admin/content_assets/creating_a_content_asset.json +11 -8
  88. data/doc/api/admin/content_assets/listing_content_assets.json +8 -5
  89. data/doc/api/admin/content_assets/removing_a_content_asset.json +8 -4
  90. data/doc/api/admin/content_assets/showing_a_content_asset.json +10 -7
  91. data/doc/api/admin/content_assets/updating_a_content_asset.json +9 -5
  92. data/doc/api/admin/discounts/creating_a_discount.json +11 -8
  93. data/doc/api/admin/discounts/listing_discounts.json +8 -5
  94. data/doc/api/admin/discounts/removing_a_discount.json +8 -4
  95. data/doc/api/admin/discounts/showing_a_discount.json +10 -7
  96. data/doc/api/admin/discounts/updating_discounts.json +8 -4
  97. data/doc/api/admin/email_signups/listing_email_signups.json +7 -4
  98. data/doc/api/admin/email_signups/showing_an_email_signup.json +10 -12
  99. data/doc/api/admin/email_signups/showing_an_email_signup_by_email.json +47 -0
  100. data/doc/api/admin/email_signups/showing_an_email_signup_by_id.json +47 -0
  101. data/doc/api/admin/fulfillment/listing_fulfillments.json +7 -4
  102. data/doc/api/admin/fulfillment/marking_items_as_canceled.json +9 -6
  103. data/doc/api/admin/fulfillment/marking_items_as_shipped.json +9 -6
  104. data/doc/api/admin/fulfillment/showing_fulfillment.json +7 -4
  105. data/doc/api/admin/global_functionality/dealing_with_locales.json +86 -0
  106. data/doc/api/admin/global_functionality/filtering_by_created_at_time_stamp.json +56 -0
  107. data/doc/api/admin/global_functionality/filtering_by_updated_time_stamp.json +56 -0
  108. data/doc/api/admin/global_functionality/paging_results.json +51 -0
  109. data/doc/api/admin/global_functionality/retrieving_addtional_pages_of_results.json +51 -0
  110. data/doc/api/admin/global_functionality/sorting_results.json +56 -0
  111. data/doc/api/admin/index.json +653 -578
  112. data/doc/api/admin/inventory_skus/bulk_upserting_inventory_skus.json +8 -4
  113. data/doc/api/admin/inventory_skus/creating_an_inventory_sku.json +9 -6
  114. data/doc/api/admin/inventory_skus/listing_inventory_skus.json +7 -4
  115. data/doc/api/admin/inventory_skus/removing_an_inventory_sku.json +6 -2
  116. data/doc/api/admin/inventory_skus/showing_an_inventory_sku.json +7 -4
  117. data/doc/api/admin/inventory_skus/updating_an_inventory_sku.json +6 -2
  118. data/doc/api/admin/navigation_menus/creating_a_menu.json +11 -8
  119. data/doc/api/admin/navigation_menus/listing_menus.json +8 -5
  120. data/doc/api/admin/navigation_menus/removing_a_navigation_menu.json +8 -4
  121. data/doc/api/admin/navigation_menus/showing_a_navigation_menu.json +10 -7
  122. data/doc/api/admin/navigation_menus/updating_a_navigation_menus.json +8 -4
  123. data/doc/api/admin/navigation_taxonomy/bulk_upserting_navigation_taxons.json +8 -4
  124. data/doc/api/admin/navigation_taxonomy/creating_a_taxon.json +10 -7
  125. data/doc/api/admin/navigation_taxonomy/listing_taxons.json +7 -4
  126. data/doc/api/admin/navigation_taxonomy/removing_a_navigation_taxon.json +8 -4
  127. data/doc/api/admin/navigation_taxonomy/showing_a_navigation_taxon.json +9 -6
  128. data/doc/api/admin/navigation_taxonomy/updating_a_navigation_taxons.json +8 -4
  129. data/doc/api/admin/orders/listing_orders.json +8 -5
  130. data/doc/api/admin/orders/showing_an_order.json +8 -5
  131. data/doc/api/admin/orders/viewing_orders_by_date_range.json +17 -9
  132. data/doc/api/admin/pages/bulk_upserting_pages.json +8 -4
  133. data/doc/api/admin/pages/creating_a_page.json +11 -8
  134. data/doc/api/admin/pages/listing_pages.json +8 -5
  135. data/doc/api/admin/pages/removing_a_page.json +8 -4
  136. data/doc/api/admin/pages/showing_a_page.json +10 -7
  137. data/doc/api/admin/pages/updating_a_page.json +9 -5
  138. data/doc/api/admin/payment_profiles/bulk_upserting_payment_profiles.json +8 -4
  139. data/doc/api/admin/payment_profiles/creating_a_payment_profile.json +10 -7
  140. data/doc/api/admin/payment_profiles/listing_payment_profiles.json +7 -4
  141. data/doc/api/admin/payment_profiles/removing_a_payment_profile.json +8 -4
  142. data/doc/api/admin/payment_profiles/showing_a_payment_profile.json +9 -6
  143. data/doc/api/admin/payment_profiles/updating_a_payment_profiles.json +8 -4
  144. data/doc/api/admin/payment_transactions/listing_payment_transactions.json +7 -4
  145. data/doc/api/admin/payment_transactions/showing_a_payment_transaction.json +9 -6
  146. data/doc/api/admin/payments/listing_payments.json +7 -4
  147. data/doc/api/admin/payments/showing_an_payment.json +7 -4
  148. data/doc/api/admin/prices/creating_a_pricing_sku_price.json +8 -5
  149. data/doc/api/admin/prices/listing_pricing_sku_prices.json +8 -5
  150. data/doc/api/admin/prices/removing_a_pricing_sku_price.json +8 -4
  151. data/doc/api/admin/prices/updating_a_pricing_sku_price.json +8 -4
  152. data/doc/api/admin/pricing_skus/bulk_upserting_pricing_skus.json +8 -4
  153. data/doc/api/admin/pricing_skus/creating_an_pricing_sku.json +10 -7
  154. data/doc/api/admin/pricing_skus/listing_pricing_skus.json +8 -5
  155. data/doc/api/admin/pricing_skus/removing_an_pricing_sku.json +6 -2
  156. data/doc/api/admin/pricing_skus/showing_an_pricing_sku.json +8 -5
  157. data/doc/api/admin/pricing_skus/updating_an_pricing_sku.json +6 -2
  158. data/doc/api/admin/product_images/creating_a_product_image_from_base64.json +11 -8
  159. data/doc/api/admin/product_images/creating_a_product_image_from_url.json +11 -8
  160. data/doc/api/admin/product_images/listing_product_images.json +10 -7
  161. data/doc/api/admin/product_images/removing_a_product_image.json +8 -4
  162. data/doc/api/admin/product_images/updating_a_product_image.json +8 -4
  163. data/doc/api/admin/products/bulk_upserting_products.json +8 -4
  164. data/doc/api/admin/products/creating_a_product.json +11 -8
  165. data/doc/api/admin/products/listing_products.json +8 -5
  166. data/doc/api/admin/products/removing_a_product.json +8 -4
  167. data/doc/api/admin/products/showing_a_product.json +10 -7
  168. data/doc/api/admin/products/updating_a_product.json +9 -5
  169. data/doc/api/admin/promo_code_lists/bulk_upserting_promo_code_lists.json +8 -4
  170. data/doc/api/admin/promo_code_lists/creating_a_promo_code_list.json +10 -7
  171. data/doc/api/admin/promo_code_lists/listing_promo_code_lists.json +7 -4
  172. data/doc/api/admin/promo_code_lists/removing_a_promo_code_list.json +8 -4
  173. data/doc/api/admin/promo_code_lists/showing_a_promo_code_list.json +9 -6
  174. data/doc/api/admin/promo_code_lists/updating_a_promo_code_list.json +8 -4
  175. data/doc/api/admin/recommendation_settings/showing_recommendation_settings.json +9 -6
  176. data/doc/api/admin/recommendation_settings/updating_recommendation_settings.json +8 -4
  177. data/doc/api/admin/redirects/bulk_upserting_redirects.json +8 -4
  178. data/doc/api/admin/redirects/creating_a_redirect.json +10 -7
  179. data/doc/api/admin/redirects/listing_redirects.json +7 -4
  180. data/doc/api/admin/redirects/removing_a_redirect.json +8 -4
  181. data/doc/api/admin/redirects/showing_a_redirect.json +9 -6
  182. data/doc/api/admin/redirects/updating_a_redirects.json +8 -4
  183. data/doc/api/admin/release_changes/adding_changes_to_a_release.json +11 -7
  184. data/doc/api/admin/releases/bulk_upserting_releases.json +8 -4
  185. data/doc/api/admin/releases/creating_a_release.json +11 -8
  186. data/doc/api/admin/releases/listing_releases.json +8 -5
  187. data/doc/api/admin/releases/removing_a_release.json +8 -4
  188. data/doc/api/admin/releases/showing_a_release.json +10 -7
  189. data/doc/api/admin/releases/updating_a_release.json +9 -5
  190. data/doc/api/admin/saved_addresses/creating_a_saved_address.json +10 -7
  191. data/doc/api/admin/saved_addresses/listing_saved_address.json +9 -6
  192. data/doc/api/admin/saved_addresses/removing_a_saved_address.json +8 -4
  193. data/doc/api/admin/saved_addresses/updating_a_saved_address.json +8 -4
  194. data/doc/api/admin/saved_credit_cards/creating_a_saved_credit_card.json +11 -8
  195. data/doc/api/admin/saved_credit_cards/listing_saved_credit_cards.json +9 -6
  196. data/doc/api/admin/saved_credit_cards/removing_a_saved_credit_card.json +8 -4
  197. data/doc/api/admin/saved_credit_cards/updating_a_saved_credit_card.json +8 -4
  198. data/doc/api/admin/shipping/listing_shipments.json +7 -4
  199. data/doc/api/admin/shipping/showing_a_shipment.json +9 -6
  200. data/doc/api/admin/shipping_rates/creating_a_shipping_rate.json +10 -7
  201. data/doc/api/admin/shipping_rates/listing_shipping_rates.json +9 -6
  202. data/doc/api/admin/shipping_rates/removing_a_shipping_rate.json +8 -4
  203. data/doc/api/admin/shipping_rates/updating_a_shipping_rate.json +8 -4
  204. data/doc/api/admin/shipping_services/bulk_upserting_shipping_services.json +8 -4
  205. data/doc/api/admin/shipping_services/creating_a_shipping_service.json +10 -7
  206. data/doc/api/admin/shipping_services/listing_shipping_services.json +7 -4
  207. data/doc/api/admin/shipping_services/removing_a_shipping_service.json +8 -4
  208. data/doc/api/admin/shipping_services/showing_a_shipping_service.json +9 -6
  209. data/doc/api/admin/shipping_services/updating_a_shipping_service.json +9 -5
  210. data/doc/api/admin/tax_categories/bulk_upserting_tax_categories.json +8 -4
  211. data/doc/api/admin/tax_categories/creating_a_tax_category.json +10 -7
  212. data/doc/api/admin/tax_categories/listing_tax_categories.json +7 -4
  213. data/doc/api/admin/tax_categories/removing_a_tax_category.json +8 -4
  214. data/doc/api/admin/tax_categories/showing_a_tax_category.json +9 -6
  215. data/doc/api/admin/tax_categories/updating_a_tax_categories.json +8 -4
  216. data/doc/api/admin/tax_rates/creating_a_tax_rate.json +12 -9
  217. data/doc/api/admin/tax_rates/listing_tax_rates.json +10 -7
  218. data/doc/api/admin/tax_rates/removing_a_tax_rate.json +8 -4
  219. data/doc/api/admin/tax_rates/updating_a_tax_rate.json +8 -4
  220. data/doc/api/admin/users/bulk_upserting_users.json +8 -4
  221. data/doc/api/admin/users/creating_a_user.json +11 -8
  222. data/doc/api/admin/users/listing_users.json +8 -5
  223. data/doc/api/admin/users/removing_a_user.json +8 -4
  224. data/doc/api/admin/users/showing_a_user.json +10 -12
  225. data/doc/api/admin/users/showing_a_user_by_email.json +47 -0
  226. data/doc/api/admin/users/showing_a_user_by_id.json +47 -0
  227. data/doc/api/admin/users/updating_a_user.json +9 -5
  228. data/doc/api/admin/variants/creating_a_product_variant.json +11 -8
  229. data/doc/api/admin/variants/listing_product_variants.json +10 -7
  230. data/doc/api/admin/variants/removing_a_product_variant.json +8 -4
  231. data/doc/api/admin/variants/updating_a_product_variant.json +8 -4
  232. data/doc/api/storefront/accounts/creating_an_account.json +7 -6
  233. data/doc/api/storefront/accounts/getting_account_details.json +9 -8
  234. data/doc/api/storefront/accounts/updating_an_account.json +9 -8
  235. data/doc/api/storefront/analytics/saving_a_category_view.json +18 -5
  236. data/doc/api/storefront/analytics/saving_a_product_view.json +18 -5
  237. data/doc/api/storefront/analytics/saving_a_search.json +18 -5
  238. data/doc/api/storefront/assets/showing_an_asset.json +9 -8
  239. data/doc/api/storefront/authentication/creating_an_authentication_token.json +9 -8
  240. data/doc/api/storefront/authentication/refreshing_an_authentication_token.json +9 -8
  241. data/doc/api/storefront/authentication/using_an_authentication_token.json +9 -8
  242. data/doc/api/storefront/cart/adding_a_promo_code.json +10 -9
  243. data/doc/api/storefront/cart/adding_an_item.json +10 -9
  244. data/doc/api/storefront/cart/creating_a_new_cart_for_a_user.json +9 -8
  245. data/doc/api/storefront/cart/creating_a_new_guest_cart.json +7 -6
  246. data/doc/api/storefront/cart/delete_an_item.json +10 -9
  247. data/doc/api/storefront/cart/listing_user_s_carts.json +9 -8
  248. data/doc/api/storefront/cart/showing_cart.json +10 -9
  249. data/doc/api/storefront/cart/updating_an_item.json +10 -9
  250. data/doc/api/storefront/categories/showing_a_category.json +8 -7
  251. data/doc/api/storefront/categories/showing_a_listing_of_categories.json +8 -7
  252. data/doc/api/storefront/checkout/completing_a_checkout.json +9 -8
  253. data/doc/api/storefront/checkout/showing_a_checkout.json +10 -9
  254. data/doc/api/storefront/checkout/updating_a_checkout.json +9 -8
  255. data/doc/api/storefront/contacts/creating_a_contact.json +7 -6
  256. data/doc/api/storefront/email_signups/creating_an_email_signup.json +7 -6
  257. data/doc/api/storefront/email_signups/showing_an_email_signup_content.json +7 -6
  258. data/doc/api/storefront/index.json +263 -258
  259. data/doc/api/storefront/menus/listing_menus.json +8 -7
  260. data/doc/api/storefront/menus/showing_a_menu.json +10 -9
  261. data/doc/api/storefront/orders/listing_the_user_s_orders.json +9 -8
  262. data/doc/api/storefront/orders/showing_an_order.json +10 -9
  263. data/doc/api/storefront/pages/showing_a_page.json +8 -7
  264. data/doc/api/storefront/password_resets/sending_a_forgot_password_email.json +8 -6
  265. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_a_session_id.json +11 -11
  266. data/doc/api/storefront/personalized_recommendations/showing_recommendations_with_authentication.json +9 -8
  267. data/doc/api/storefront/products/showing_a_product.json +8 -7
  268. data/doc/api/storefront/products/showing_a_product_with_a_specific_sku_selected.json +8 -7
  269. data/doc/api/storefront/recent_views/showing_recent_views_from_authentication.json +10 -9
  270. data/doc/api/storefront/recent_views/showing_recent_views_with_a_session_id.json +11 -11
  271. data/doc/api/storefront/recent_views/updating_recent_views_with_a_session_id.json +6 -4
  272. data/doc/api/storefront/recent_views/updating_recent_views_with_authentication.json +8 -6
  273. data/doc/api/storefront/saved_addresses/creating_a_saved_address.json +8 -7
  274. data/doc/api/storefront/saved_addresses/deleting_a_saved_address.json +8 -6
  275. data/doc/api/storefront/saved_addresses/listing_the_user_s_saved_addresses.json +9 -8
  276. data/doc/api/storefront/saved_addresses/showing_a_saved_address.json +9 -8
  277. data/doc/api/storefront/saved_addresses/updating_a_saved_address.json +9 -8
  278. data/doc/api/storefront/saved_credit_cards/creating_a_saved_credit_card.json +8 -7
  279. data/doc/api/storefront/saved_credit_cards/deleting_a_saved_credit_card.json +8 -6
  280. data/doc/api/storefront/saved_credit_cards/listing_the_user_s_saved_credit_cards.json +9 -8
  281. data/doc/api/storefront/saved_credit_cards/showing_a_saved_credit_card.json +9 -8
  282. data/doc/api/storefront/saved_credit_cards/updating_a_saved_credit_card.json +9 -8
  283. data/doc/api/storefront/searches/showing_search_autocomplete_suggestions.json +9 -8
  284. data/doc/api/storefront/searches/showing_search_results.json +8 -7
  285. data/doc/api/storefront/segmentation/specifying_session_count_for_segmentation.json +93 -0
  286. data/doc/api/storefront/segmentation/using_session_ids_for_segmenting_non_authenticated_users.json +93 -0
  287. data/doc/api/storefront/system_content/showing_system_content.json +8 -7
  288. data/doc/api/storefront/system_content/showing_the_home_page.json +8 -7
  289. data/doc/api/storefront/taxons/showing_a_taxon.json +10 -9
  290. data/doc/api/storefront/validation_errors/checkout_validation_errors.json +9 -8
  291. data/doc/api/storefront/validation_errors/general_validation_errors.json +4 -3
  292. data/lib/tasks/docs.rake +20 -0
  293. data/lib/workarea/api/documentation_test.rb +10 -1
  294. data/lib/workarea/api/version.rb +1 -1
  295. data/storefront/LICENSE +52 -0
  296. data/storefront/README.md +4 -7
  297. data/storefront/app/controllers/workarea/api/storefront/analytics_controller.rb +31 -19
  298. data/storefront/app/controllers/workarea/api/storefront/application_controller.rb +15 -2
  299. data/storefront/app/controllers/workarea/api/storefront/authentication.rb +6 -9
  300. data/storefront/app/controllers/workarea/api/storefront/categories_controller.rb +3 -1
  301. data/storefront/app/controllers/workarea/api/storefront/checkouts_controller.rb +0 -1
  302. data/storefront/app/controllers/workarea/api/storefront/menus_controller.rb +3 -1
  303. data/storefront/app/controllers/workarea/api/storefront/pages_controller.rb +3 -1
  304. data/storefront/app/controllers/workarea/api/storefront/products_controller.rb +3 -1
  305. data/storefront/app/controllers/workarea/api/storefront/recent_views_controller.rb +13 -26
  306. data/storefront/app/controllers/workarea/api/storefront/recommendations_controller.rb +2 -8
  307. data/storefront/app/controllers/workarea/api/storefront/searches_controller.rb +0 -12
  308. data/storefront/app/views/workarea/api/storefront/categories/show.json.jbuilder +1 -1
  309. data/storefront/app/views/workarea/api/storefront/email_signups/show.json.jbuilder +1 -1
  310. data/storefront/app/views/workarea/api/storefront/menus/_menu.json.jbuilder +1 -1
  311. data/storefront/app/views/workarea/api/storefront/pages/show.json.jbuilder +1 -1
  312. data/storefront/app/views/workarea/api/storefront/recent_views/show.json.jbuilder +0 -1
  313. data/storefront/app/views/workarea/api/storefront/searches/show.json.jbuilder +1 -1
  314. data/storefront/app/views/workarea/api/storefront/system_content/show.json.jbuilder +1 -1
  315. data/storefront/config/initializers/config.rb +19 -0
  316. data/storefront/lib/workarea/api/storefront.rb +1 -0
  317. data/storefront/lib/workarea/api/storefront/visit.decorator +52 -0
  318. data/storefront/test/documentation/workarea/api/storefront/checkouts_documentation_test.rb +21 -0
  319. data/storefront/test/documentation/workarea/api/storefront/segmentation_documentation_test.rb +104 -0
  320. data/storefront/test/documentation/workarea/api/storefront/validation_documentation_test.rb +1 -1
  321. data/storefront/test/dummy/config/initializers/session_store.rb +3 -1
  322. data/storefront/test/integration/workarea/api/storefront/analytics_integration_test.rb +12 -7
  323. data/storefront/test/integration/workarea/api/storefront/recent_views_integration_test.rb +38 -33
  324. data/storefront/test/integration/workarea/api/storefront/recommendations_integration_test.rb +1 -1
  325. data/storefront/test/integration/workarea/api/storefront/searches_integration_test.rb +0 -36
  326. data/storefront/test/integration/workarea/api/storefront/segments_integration_test.rb +218 -0
  327. data/storefront/workarea-api-storefront.gemspec +8 -7
  328. data/workarea-api.gemspec +4 -4
  329. metadata +38 -17
  330. data/doc/api/storefront/analytics/saving_a_search_abandonment.json +0 -38
  331. data/doc/api/storefront/analytics/saving_filters.json +0 -38
  332. data/storefront/app/controllers/workarea/api/storefront/user_activity.rb +0 -36
  333. data/storefront/app/view_models/workarea/api/storefront/search_suggestion_view_model.rb +0 -21
@@ -1,3 +1,5 @@
1
1
  # Be sure to restart your server when you modify this file.
2
2
 
3
- Rails.application.config.session_store :cookie_store, key: '_dummy_session'
3
+ Rails.application.config.session_store :cookie_store,
4
+ key: '_dummy_session',
5
+ expire_after: 30.minutes
@@ -20,6 +20,38 @@ module Workarea
20
20
  assert_equal(3, result.length)
21
21
  assert_equal(categories.second, Catalog::Category.new(result.first))
22
22
  assert_equal(categories.first, Catalog::Category.new(result.second))
23
+
24
+ travel_to 1.week.from_now
25
+
26
+ get admin_api.categories_path(
27
+ updated_at_starts_at: 5.days.ago,
28
+ updated_at_ends_at: 4.days.ago
29
+ )
30
+ result = JSON.parse(response.body)['categories']
31
+
32
+ assert_equal(0, result.length)
33
+
34
+ get admin_api.categories_path(
35
+ created_at_starts_at: 5.days.ago,
36
+ created_at_ends_at: 4.days.ago
37
+ )
38
+ result = JSON.parse(response.body)['categories']
39
+
40
+ assert_equal(0, result.length)
41
+
42
+ get admin_api.categories_path(
43
+ updated_at_starts_at: 8.days.ago,
44
+ updated_at_ends_at: 6.days.ago
45
+ )
46
+ result = JSON.parse(response.body)['categories']
47
+ assert_equal(3, result.length)
48
+
49
+ get admin_api.categories_path(
50
+ created_at_starts_at: 8.days.ago,
51
+ created_at_ends_at: 6.days.ago
52
+ )
53
+ result = JSON.parse(response.body)['categories']
54
+ assert_equal(3, result.length)
23
55
  end
24
56
 
25
57
  def test_creates_categories
@@ -20,6 +20,38 @@ module Workarea
20
20
  assert_equal(3, result.length)
21
21
  assert_equal(assets.second, Content::Asset.new(result.first))
22
22
  assert_equal(assets.first, Content::Asset.new(result.second))
23
+
24
+ travel_to 1.week.from_now
25
+
26
+ get admin_api.content_assets_path(
27
+ updated_at_starts_at: 5.days.ago,
28
+ updated_at_ends_at: 4.days.ago
29
+ )
30
+ result = JSON.parse(response.body)['assets']
31
+
32
+ assert_equal(0, result.length)
33
+
34
+ get admin_api.content_assets_path(
35
+ created_at_starts_at: 5.days.ago,
36
+ created_at_ends_at: 4.days.ago
37
+ )
38
+ result = JSON.parse(response.body)['assets']
39
+
40
+ assert_equal(0, result.length)
41
+
42
+ get admin_api.content_assets_path(
43
+ updated_at_starts_at: 8.days.ago,
44
+ updated_at_ends_at: 6.days.ago
45
+ )
46
+ result = JSON.parse(response.body)['assets']
47
+ assert_equal(3, result.length)
48
+
49
+ get admin_api.content_assets_path(
50
+ created_at_starts_at: 8.days.ago,
51
+ created_at_ends_at: 6.days.ago
52
+ )
53
+ result = JSON.parse(response.body)['assets']
54
+ assert_equal(3, result.length)
23
55
  end
24
56
 
25
57
  def test_creates_assets
@@ -20,6 +20,38 @@ module Workarea
20
20
  assert_equal(3, result.length)
21
21
  assert_equal(content.second, Content.new(result.first))
22
22
  assert_equal(content.first, Content.new(result.second))
23
+
24
+ travel_to 1.week.from_now
25
+
26
+ get admin_api.content_index_path(
27
+ updated_at_starts_at: 5.days.ago,
28
+ updated_at_ends_at: 4.days.ago
29
+ )
30
+ result = JSON.parse(response.body)['content']
31
+
32
+ assert_equal(0, result.length)
33
+
34
+ get admin_api.content_index_path(
35
+ created_at_starts_at: 5.days.ago,
36
+ created_at_ends_at: 4.days.ago
37
+ )
38
+ result = JSON.parse(response.body)['content']
39
+
40
+ assert_equal(0, result.length)
41
+
42
+ get admin_api.content_index_path(
43
+ updated_at_starts_at: 8.days.ago,
44
+ updated_at_ends_at: 6.days.ago
45
+ )
46
+ result = JSON.parse(response.body)['content']
47
+ assert_equal(3, result.length)
48
+
49
+ get admin_api.content_index_path(
50
+ created_at_starts_at: 8.days.ago,
51
+ created_at_ends_at: 6.days.ago
52
+ )
53
+ result = JSON.parse(response.body)['content']
54
+ assert_equal(3, result.length)
23
55
  end
24
56
 
25
57
  def test_creates_content
@@ -24,6 +24,38 @@ module Workarea
24
24
  assert_equal(3, result.length)
25
25
  assert_equal(discounts.second, Pricing::Discount::Product.new(result.first))
26
26
  assert_equal(discounts.first, Pricing::Discount::Product.new(result.second))
27
+
28
+ travel_to 1.week.from_now
29
+
30
+ get admin_api.discounts_path(
31
+ updated_at_starts_at: 5.days.ago,
32
+ updated_at_ends_at: 4.days.ago
33
+ )
34
+ result = JSON.parse(response.body)['discounts']
35
+
36
+ assert_equal(0, result.length)
37
+
38
+ get admin_api.discounts_path(
39
+ created_at_starts_at: 5.days.ago,
40
+ created_at_ends_at: 4.days.ago
41
+ )
42
+ result = JSON.parse(response.body)['discounts']
43
+
44
+ assert_equal(0, result.length)
45
+
46
+ get admin_api.discounts_path(
47
+ updated_at_starts_at: 8.days.ago,
48
+ updated_at_ends_at: 6.days.ago
49
+ )
50
+ result = JSON.parse(response.body)['discounts']
51
+ assert_equal(3, result.length)
52
+
53
+ get admin_api.discounts_path(
54
+ created_at_starts_at: 8.days.ago,
55
+ created_at_ends_at: 6.days.ago
56
+ )
57
+ result = JSON.parse(response.body)['discounts']
58
+ assert_equal(3, result.length)
27
59
  end
28
60
 
29
61
  def test_creates_discounts
@@ -18,13 +18,50 @@ module Workarea
18
18
  assert_equal(2, result.length)
19
19
  assert_equal(email_signups.second, Email::Signup.new(result.first))
20
20
  assert_equal(email_signups.first, Email::Signup.new(result.second))
21
+
22
+ travel_to 1.week.from_now
23
+
24
+ get admin_api.email_signups_path(
25
+ updated_at_starts_at: 5.days.ago,
26
+ updated_at_ends_at: 4.days.ago
27
+ )
28
+ result = JSON.parse(response.body)['email_signups']
29
+
30
+ assert_equal(0, result.length)
31
+
32
+ get admin_api.email_signups_path(
33
+ created_at_starts_at: 5.days.ago,
34
+ created_at_ends_at: 4.days.ago
35
+ )
36
+ result = JSON.parse(response.body)['email_signups']
37
+
38
+ assert_equal(0, result.length)
39
+
40
+ get admin_api.email_signups_path(
41
+ updated_at_starts_at: 8.days.ago,
42
+ updated_at_ends_at: 6.days.ago
43
+ )
44
+ result = JSON.parse(response.body)['email_signups']
45
+ assert_equal(2, result.length)
46
+
47
+ get admin_api.email_signups_path(
48
+ created_at_starts_at: 8.days.ago,
49
+ created_at_ends_at: 6.days.ago
50
+ )
51
+ result = JSON.parse(response.body)['email_signups']
52
+ assert_equal(2, result.length)
21
53
  end
22
54
 
23
55
  def test_shows_email_signups
24
- email_signup = create_email_signup
56
+ email_signup = create_email_signup(email: 'test@workarea.com')
57
+
25
58
  get admin_api.email_signup_path(email_signup.id)
26
59
  result = JSON.parse(response.body)['email_signup']
27
60
  assert_equal(email_signup, Email::Signup.new(result))
61
+
62
+ get admin_api.email_signup_path(URI.escape(email_signup.email, '+@.'))
63
+ result = JSON.parse(response.body)['email_signup']
64
+ assert_equal(email_signup, Email::Signup.new(result))
28
65
  end
29
66
  end
30
67
  end
@@ -21,6 +21,28 @@ module Workarea
21
21
  assert_equal(fulfillments.first, Fulfillment.new(result.second))
22
22
  end
23
23
 
24
+ def test_lists_fulfillments_by_date
25
+ fulfillments = [create_fulfillment(id: '1'), create_fulfillment(id: '2')]
26
+ get admin_api.fulfillments_path(
27
+ updated_at_starts_at: 2.days.ago,
28
+ updated_at_ends_at: 1.day.ago
29
+ )
30
+ result = JSON.parse(response.body)['fulfillments']
31
+
32
+ assert_equal(0, result.length)
33
+
34
+ get admin_api.fulfillments_path(
35
+ updated_at_starts_at: 2.days.ago,
36
+ updated_at_ends_at: 1.day.from_now
37
+ )
38
+ result = JSON.parse(response.body)['fulfillments']
39
+
40
+ assert_equal(2, result.length)
41
+ assert_equal(fulfillments.second, Fulfillment.new(result.first))
42
+ assert_equal(fulfillments.first, Fulfillment.new(result.second))
43
+ end
44
+
45
+
24
46
  def test_shows_fulfillments
25
47
  fulfillment = create_fulfillment
26
48
  get admin_api.fulfillment_path(fulfillment.id)
@@ -20,6 +20,38 @@ module Workarea
20
20
  assert_equal(3, result.length)
21
21
  assert_equal(inventory_skus.second, Inventory::Sku.new(result.first))
22
22
  assert_equal(inventory_skus.first, Inventory::Sku.new(result.second))
23
+
24
+ travel_to 1.week.from_now
25
+
26
+ get admin_api.inventory_skus_path(
27
+ updated_at_starts_at: 5.days.ago,
28
+ updated_at_ends_at: 4.days.ago
29
+ )
30
+ result = JSON.parse(response.body)['inventory_skus']
31
+
32
+ assert_equal(0, result.length)
33
+
34
+ get admin_api.inventory_skus_path(
35
+ created_at_starts_at: 5.days.ago,
36
+ created_at_ends_at: 4.days.ago
37
+ )
38
+ result = JSON.parse(response.body)['inventory_skus']
39
+
40
+ assert_equal(0, result.length)
41
+
42
+ get admin_api.inventory_skus_path(
43
+ updated_at_starts_at: 8.days.ago,
44
+ updated_at_ends_at: 6.days.ago
45
+ )
46
+ result = JSON.parse(response.body)['inventory_skus']
47
+ assert_equal(3, result.length)
48
+
49
+ get admin_api.inventory_skus_path(
50
+ created_at_starts_at: 8.days.ago,
51
+ created_at_ends_at: 6.days.ago
52
+ )
53
+ result = JSON.parse(response.body)['inventory_skus']
54
+ assert_equal(3, result.length)
23
55
  end
24
56
 
25
57
  def test_creates_inventory_skus
@@ -17,6 +17,38 @@ module Workarea
17
17
  get admin_api.navigation_menus_path
18
18
  result = JSON.parse(response.body)['navigation_menus']
19
19
  assert_equal(3, result.length)
20
+
21
+ travel_to 1.week.from_now
22
+
23
+ get admin_api.navigation_menus_path(
24
+ updated_at_starts_at: 5.days.ago,
25
+ updated_at_ends_at: 4.days.ago
26
+ )
27
+ result = JSON.parse(response.body)['navigation_menus']
28
+
29
+ assert_equal(0, result.length)
30
+
31
+ get admin_api.navigation_menus_path(
32
+ created_at_starts_at: 5.days.ago,
33
+ created_at_ends_at: 4.days.ago
34
+ )
35
+ result = JSON.parse(response.body)['navigation_menus']
36
+
37
+ assert_equal(0, result.length)
38
+
39
+ get admin_api.navigation_menus_path(
40
+ updated_at_starts_at: 8.days.ago,
41
+ updated_at_ends_at: 6.days.ago
42
+ )
43
+ result = JSON.parse(response.body)['navigation_menus']
44
+ assert_equal(3, result.length)
45
+
46
+ get admin_api.navigation_menus_path(
47
+ created_at_starts_at: 8.days.ago,
48
+ created_at_ends_at: 6.days.ago
49
+ )
50
+ result = JSON.parse(response.body)['navigation_menus']
51
+ assert_equal(3, result.length)
20
52
  end
21
53
 
22
54
  def test_creates_menus
@@ -17,6 +17,38 @@ module Workarea
17
17
  get admin_api.navigation_taxons_path
18
18
  result = JSON.parse(response.body)['navigation_taxons']
19
19
  assert_equal(4, result.length)
20
+
21
+ travel_to 1.week.from_now
22
+
23
+ get admin_api.navigation_taxons_path(
24
+ updated_at_starts_at: 5.days.ago,
25
+ updated_at_ends_at: 4.days.ago
26
+ )
27
+ result = JSON.parse(response.body)['navigation_taxons']
28
+
29
+ assert_equal(0, result.length)
30
+
31
+ get admin_api.navigation_taxons_path(
32
+ created_at_starts_at: 5.days.ago,
33
+ created_at_ends_at: 4.days.ago
34
+ )
35
+ result = JSON.parse(response.body)['navigation_taxons']
36
+
37
+ assert_equal(0, result.length)
38
+
39
+ get admin_api.navigation_taxons_path(
40
+ updated_at_starts_at: 8.days.ago,
41
+ updated_at_ends_at: 6.days.ago
42
+ )
43
+ result = JSON.parse(response.body)['navigation_taxons']
44
+ assert_equal(4, result.length)
45
+
46
+ get admin_api.navigation_taxons_path(
47
+ created_at_starts_at: 8.days.ago,
48
+ created_at_ends_at: 6.days.ago
49
+ )
50
+ result = JSON.parse(response.body)['navigation_taxons']
51
+ assert_equal(4, result.length)
20
52
  end
21
53
 
22
54
  def test_creates_taxons
@@ -18,8 +18,8 @@ module Workarea
18
18
 
19
19
  def test_filters_orders
20
20
  orders = [
21
- create_order(placed_at: 1.week.ago),
22
- create_order(placed_at: 2.days.ago)
21
+ create_order(email: 'foo@workarea.com', placed_at: 1.week.ago),
22
+ create_order(email: 'bar@workarea.com', placed_at: 2.days.ago)
23
23
  ]
24
24
 
25
25
  get admin_api.orders_path(
@@ -31,6 +31,45 @@ module Workarea
31
31
 
32
32
  assert_equal(1, result.length)
33
33
  assert_equal(orders.second, Order.new(result.first))
34
+
35
+ get admin_api.orders_path(email: 'foo@workarea.com')
36
+
37
+ result = JSON.parse(response.body)['orders']
38
+
39
+ assert_equal(1, result.length)
40
+ assert_equal(orders.first, Order.new(result.first))
41
+
42
+ travel_to 1.week.from_now
43
+
44
+ get admin_api.orders_path(
45
+ updated_at_starts_at: 5.days.ago,
46
+ updated_at_ends_at: 4.days.ago
47
+ )
48
+ result = JSON.parse(response.body)['orders']
49
+
50
+ assert_equal(0, result.length)
51
+
52
+ get admin_api.orders_path(
53
+ created_at_starts_at: 5.days.ago,
54
+ created_at_ends_at: 4.days.ago
55
+ )
56
+ result = JSON.parse(response.body)['orders']
57
+
58
+ assert_equal(0, result.length)
59
+
60
+ get admin_api.orders_path(
61
+ updated_at_starts_at: 8.days.ago,
62
+ updated_at_ends_at: 6.days.ago
63
+ )
64
+ result = JSON.parse(response.body)['orders']
65
+ assert_equal(2, result.length)
66
+
67
+ get admin_api.orders_path(
68
+ created_at_starts_at: 8.days.ago,
69
+ created_at_ends_at: 6.days.ago
70
+ )
71
+ result = JSON.parse(response.body)['orders']
72
+ assert_equal(2, result.length)
34
73
  end
35
74
 
36
75
  def test_shows_orders
@@ -20,6 +20,38 @@ module Workarea
20
20
  assert_equal(3, result.length)
21
21
  assert_equal(pages.second, Content::Page.new(result.first))
22
22
  assert_equal(pages.first, Content::Page.new(result.second))
23
+
24
+ travel_to 1.week.from_now
25
+
26
+ get admin_api.pages_path(
27
+ updated_at_starts_at: 5.days.ago,
28
+ updated_at_ends_at: 4.days.ago
29
+ )
30
+ result = JSON.parse(response.body)['pages']
31
+
32
+ assert_equal(0, result.length)
33
+
34
+ get admin_api.pages_path(
35
+ created_at_starts_at: 5.days.ago,
36
+ created_at_ends_at: 4.days.ago
37
+ )
38
+ result = JSON.parse(response.body)['pages']
39
+
40
+ assert_equal(0, result.length)
41
+
42
+ get admin_api.pages_path(
43
+ updated_at_starts_at: 8.days.ago,
44
+ updated_at_ends_at: 6.days.ago
45
+ )
46
+ result = JSON.parse(response.body)['pages']
47
+ assert_equal(3, result.length)
48
+
49
+ get admin_api.pages_path(
50
+ created_at_starts_at: 8.days.ago,
51
+ created_at_ends_at: 6.days.ago
52
+ )
53
+ result = JSON.parse(response.body)['pages']
54
+ assert_equal(3, result.length)
23
55
  end
24
56
 
25
57
  def test_creates_pages