workarea-api 4.4.7 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66487ef5fddeb4d49c9022e42da5c8863d2341c0d91cf06c96637738c600937e
-  data.tar.gz: d992bf2d32386be22d01daaa7637faa7e1fb490928ed35e3853abe801f37d3e8
+  metadata.gz: 5584353b8ca153718a79703b771bb98357ce80ed97ad9f19cbac97e2f8a52b34
+  data.tar.gz: a2407e362c05759fcdffb851a9ddfaddbb4ca82a0050b0570d787a0d33b92d1a
 SHA512:
-  metadata.gz: 738d90185757ce38e04eb3d714e7cce98378bc36f0b690b447f04a924a01d8f87e5cd9e0d8cc719d3e0bd9d639f7f3d0f454d92b8d649d8bab076f85d0c07cdc
-  data.tar.gz: 004b8eabf9b402fac90f08938fd389d8fd44e934d9be8965ab0540895f3ea791e94465a3baa19186a2b318218ec3f7f5360ff7c3244979604319e79d5fe536a1
+  metadata.gz: ac7d25b8c4a440778558f0771f01c0654d43b0c6f6603731508714f210696c9ea8d9b2d167e8035c1d040c0c91d3c5467f4c686ee69bc96c71e0449fb2f65bf2
+  data.tar.gz: cde57b9ea75e2d16e856fb8734006b216e02e1b26320a7b4e30a8316d7f6e4cbd269c7c63120f01f33ad1e9b7f8d6c8c13b6bcb4cd2b2532287bccc239f12b14

data/.eslintrc.json

@@ -0,0 +1,35 @@
+{
+    "extends": "eslint:recommended",
+    "rules": {
+      "semi": ["error", "always"],
+      "eqeqeq": ["error", "always"]
+    },
+    "globals": {
+      "window": true,
+      "document": true,
+      "WORKAREA": true,
+      "$": true,
+      "jQuery": true,
+      "_": true,
+      "feature": true,
+      "JST": true,
+      "Turbolinks": true,
+      "I18n": true,
+      "Chart": true,
+      "Dropzone": true,
+      "strftime": true,
+      "Waypoint": true,
+      "wysihtml": true,
+      "LocalTime": true,
+      "describe": true,
+      "after": true,
+      "afterEach": true,
+      "before": true,
+      "beforeEach": true,
+      "it": true,
+      "expect": true,
+      "sinon": true,
+      "fixture": true,
+      "chai": true
+    }
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+on: [push]
+
+jobs:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: workarea-commerce/ci/bundler-audit@v1
+    - uses: workarea-commerce/ci/rubocop@v1
+    - uses: workarea-commerce/ci/eslint@v1
+      with:
+        args: '**/*.js'
+
+  admin_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: cd admin && bin/rails app:workarea:test
+
+  storefront_tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - uses: workarea-commerce/ci/test@v1
+      with:
+        command: cd storefront && bin/rails app:workarea:test

data/.gitignore

@@ -22,3 +22,4 @@ node_modules
 test/reports
 package.json
 yarn.lock
+.rubocop-http*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - https://raw.githubusercontent.com/workarea-commerce/workarea/master/.rubocop.yml

data/.stylelintrc.json

@@ -0,0 +1,8 @@
+{
+  "extends": "stylelint-config-recommended-scss",
+  "rules": {
+    "block-no-empty": null,
+    "no-descending-specificity": null,
+    "property-no-unknown": [true, { "ignoreProperties": ["mso-hide"] }]
+  }
+}

data/CHANGELOG.md

@@ -1,25 +1,29 @@
-Workarea Api 4.4.6 (2019-08-21)
+Workarea Api 4.5.0 (2019-11-26)
 --------------------------------------------------------------------------------
 
-*   Open Source!
-
+*   Integrate segmentation into the storefront API
 
+    API-3
+    Ben Crouse
 
-Workarea Api 4.4.5 (2019-07-23)
---------------------------------------------------------------------------------
+*   Documentation presentation improvements
 
-*   Fix release task
+    * Alphabetize the navigation
+    * Allow markdown for explanations
+    Ben Crouse
 
-    Curt Howard
+*   Remove search suggestions from storefront API
 
+    This has moved to a plugin, and will need to be implemented there.
+    Ben Crouse
 
+*   Replace Recommendation::UserActivity with Metrics::User
 
-Workarea Api 4.4.4 (2019-07-23)
---------------------------------------------------------------------------------
+    Fixes Insight-Related Issues from v3.5.x
+    Curt Howard
 
-*   Suppress Flash Message and Release Cookie headers from examples
+*   Initial commit on master
 
-    API-226
     Curt Howard
 
 

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # Declare your gem's dependencies in api.gemspec.
 # Bundler will treat runtime dependencies like base dependencies, and
@@ -18,4 +18,5 @@ gemspec
 gem 'workarea-api-admin', path: 'admin'
 gem 'workarea-api-storefront', path: 'storefront'
 
-gem 'workarea', '>= 3.4.0'
+#gem 'workarea', '>= 3.4.0'
+gem 'workarea', github: 'workarea-commerce/workarea'

data/README.md

@@ -1,4 +1,5 @@
 # Workarea API
+[![CI Status](https://github.com/workarea-commerce/workarea-api/workflows/CI/badge.svg)](https://github.com/workarea-commerce/workarea-api/actions)
 
 **workarea-api** defines an HTTP API, using JSON as a data format, for
 programmatic access to your Workarea application. The Workarea API is
@@ -60,6 +61,18 @@ end
 
 That will allow clients to access your API at https://api.yourtotallyamazingstore.com
 
+If you use a routing constraint for your API, be sure to add the
+following to **test/test_helper.rb** in your application to use the
+correct domain for API requests:
+
+```ruby
+class Workarea::IntegrationTest
+  setup do
+    host! host.gsub(/www/, 'api') if self.class.name.include?('Api::')
+  end
+end
+```
+
 ## Configuration
 
 This plugin provides a number of options for configuring its usage...

data/Rakefile

@@ -5,11 +5,14 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+require 'rails'
+require 'workarea/core'
 require 'rake/testtask'
 require 'date'
 
 load 'rails/test_unit/testing.rake'
 load 'workarea/changelog.rake'
+load Workarea::Core::Engine.root.join('lib', 'tasks', 'services.rake')
 
 GEMS = %w(admin storefront).freeze
 ROOT_DIR = Dir.pwd
@@ -71,16 +74,22 @@ task :release do
   # Updating changelog
   #
   #
-  #Rake::Task['workarea:changelog'].execute
-  #system 'git add CHANGELOG.md'
-  #system 'git commit -m "Update CHANGELOG"'
-  #system 'git push origin HEAD'
+  Rake::Task['workarea:changelog'].execute
+  system 'git add CHANGELOG.md'
+  system 'git commit -m "Update CHANGELOG"'
+  system 'git push origin HEAD'
 
   #
   # Build documentation
   #
   #
-  system 'GENERATE_API_DOCS=true bundle exec rake test && git add doc && git commit -am "Update documentation" && git push origin HEAD'
+  system <<~COMMAND
+    (cd admin && GENERATE_API_DOCS=true bin/rails test) &&
+    (cd storefront && GENERATE_API_DOCS=true bin/rails test) &&
+    git add docs/ &&
+    git commit -am "Update documentation" &&
+    git push origin HEAD
+  COMMAND
 
   #
   # Build gem files

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

@@ -35,6 +35,10 @@ module Workarea
               key :enum, %w(asc desc)
               key :default, 'desc'
             end
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
 
             response 200 do
               key :description, 'Categories'
@@ -97,6 +101,8 @@ module Workarea
         def index
           @categories = Catalog::Category
                           .all
+                          .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                          .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                           .order_by(sort_field => sort_direction)
                           .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/content_assets_controller.rb

@@ -35,6 +35,10 @@ module Workarea
               key :enum, %w(asc desc)
               key :default, 'desc'
             end
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
 
             response 200 do
               key :description, 'Content assets'
@@ -97,6 +101,8 @@ module Workarea
         def index
           @assets = Content::Asset
                       .all
+                      .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                      .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                       .order_by(sort_field => sort_direction)
                       .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/content_controller.rb

@@ -35,6 +35,10 @@ module Workarea
               key :enum, %w(asc desc)
               key :default, 'desc'
             end
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
 
             response 200 do
               key :description, 'Content'
@@ -97,6 +101,8 @@ module Workarea
         def index
           @content = Content
                         .all
+                        .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                        .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                         .order_by(sort_field => sort_direction)
                         .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/discounts_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Discounts'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @discounts = Pricing::Discount
                           .all
+                          .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                          .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                           .order_by(sort_field => sort_direction)
                           .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/email_signups_controller.rb

@@ -2,6 +2,8 @@ module Workarea
   module Api
     module Admin
       class EmailSignupsController < Admin::ApplicationController
+        before_action :find_email_signup, only: :show
+
         swagger_path '/email_signups' do
           operation :get do
             key :summary, 'All Email Signups'
@@ -34,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Email Signups'
               schema do
@@ -52,22 +59,24 @@ module Workarea
         def index
           @email_signups = Email::Signup
                             .all
+                            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                            .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                             .order_by(sort_field => sort_direction)
                             .page(params[:page])
 
           respond_with email_signups: @email_signups
         end
 
-        swagger_path '/email_signups/{id}' do
+        swagger_path '/email_signups/{id_or_email}' do
           operation :get do
-            key :summary, 'Find Email Signup by ID'
+            key :summary, 'Find Email Signup by ID or Email Address'
             key :description, 'Returns a single email signup'
             key :operationId, 'showEmailSignup'
 
             parameter do
               key :name, :id
               key :in, :path
-              key :description, 'ID of email signup to fetch'
+              key :description, 'ID or URI escaped email of email signup to fetch'
               key :required, true
               key :type, :string
             end
@@ -99,9 +108,16 @@ module Workarea
         end
 
         def show
-          @email_signup = Email::Signup.find(params[:id])
           respond_with email_signup: @email_signup
         end
+
+        private
+
+        def find_email_signup
+          @email_signup = Email::Signup.find(params[:id])
+        rescue Mongoid::Errors::DocumentNotFound
+          @email_signup = Email::Signup.find_by(email: URI.unescape(params[:id]))
+        end
       end
     end
   end

data/admin/app/controllers/workarea/api/admin/fulfillments_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Fulfillments'
               schema do
@@ -54,9 +59,9 @@ module Workarea
         def index
           @fulfillments = Fulfillment
                             .all
+                            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
                             .order_by(sort_field => sort_direction)
                             .page(params[:page])
-
           respond_with fulfillments: @fulfillments
         end
 

data/admin/app/controllers/workarea/api/admin/inventory_skus_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Inventory SKUs'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @inventory_skus = Inventory::Sku
                               .all
+                              .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                              .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                               .order_by(sort_field => sort_direction)
                               .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/navigation_menus_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Navigation Menus'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @navigation_menus = Navigation::Menu
                     .all
+                    .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                    .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                     .order_by(sort_field => sort_direction)
                     .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/navigation_taxons_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Navigation taxons'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @navigation_taxons = Navigation::Taxon
                     .all
+                    .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                    .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                     .order_by(sort_field => sort_direction)
                     .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/orders_controller.rb

@@ -47,6 +47,18 @@ module Workarea
               key :type, :string
               key :format, 'date-time'
             end
+            parameter do
+              key :name, :email
+              key :in, :query
+              key :description, 'Email address associated to the orders'
+              key :required, false
+              key :type, :integer
+            end
+
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
 
             response 200 do
               key :description, 'Orders'
@@ -66,6 +78,10 @@ module Workarea
         def index
           criteria = Order.all
 
+          if params[:email].present?
+            criteria = criteria.where(email: params[:email])
+          end
+
           if params[:placed_at_greater_than].present?
             # TODO Workarea v4, rename to placed_at_starts_at
             criteria = criteria.where(:placed_at.gte => params[:placed_at_greater_than])
@@ -73,11 +89,13 @@ module Workarea
 
           if params[:placed_at_less_than].present?
             # TODO Workarea v4, rename to placed_at_ends_at
-            criteria = criteria.where(:placed_at.lt => params[:placed_at_less_than])
+            criteria = criteria.where(:placed_at.lte => params[:placed_at_less_than])
           end
 
           @orders =
             criteria
+            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+            .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
             .order_by(sort_field => sort_direction)
             .page(params[:page].presence || 1)
 

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

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Pages'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @pages = Content::Page
                       .all
+                      .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                      .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                       .order_by(sort_field => sort_direction)
                       .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/payment_profiles_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Payment profiles'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @payment_profiles = Payment::Profile
                                 .all
+                                .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                                .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                                 .order_by(sort_field => sort_direction)
                                 .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/payment_transactions_controller.rb

@@ -34,6 +34,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Payment transactions'
               schema do
@@ -52,6 +57,8 @@ module Workarea
         def index
           @transactions = Payment::Transaction
                             .all
+                            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                            .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                             .order_by(sort_field => sort_direction)
                             .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/payments_controller.rb

@@ -34,6 +34,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Payments'
               schema do
@@ -52,6 +57,8 @@ module Workarea
         def index
           @payments = Payment
                         .all
+                        .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                        .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                         .order_by(sort_field => sort_direction)
                         .page(params[:page])
 

data/admin/app/controllers/workarea/api/admin/pricing_skus_controller.rb

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Pricing SKUs'
               schema do
@@ -97,6 +102,8 @@ module Workarea
         def index
           @pricing_skus = Pricing::Sku
                             .all
+                            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+                            .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
                             .order_by(sort_field => sort_direction)
                             .page(params[:page])
 

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

@@ -36,6 +36,11 @@ module Workarea
               key :default, 'desc'
             end
 
+            parameter :updated_at_starts_at
+            parameter :updated_at_ends_at
+            parameter :created_at_starts_at
+            parameter :created_at_ends_at
+
             response 200 do
               key :description, 'Products'
               schema do
@@ -95,10 +100,12 @@ module Workarea
         end
 
         def index
-          @products = Catalog::Product
-                        .all
-                        .order_by(sort_field => sort_direction)
-                        .page(params[:page])
+          @products =
+            Catalog::Product.all
+            .by_updated_at(starts_at: params[:updated_at_starts_at], ends_at: params[:updated_at_ends_at])
+            .by_created_at(starts_at: params[:created_at_starts_at], ends_at: params[:created_at_ends_at])
+            .order_by(sort_field => sort_direction)
+            .page(params[:page])
 
           respond_with products: @products
         end