workarea-api 4.4.6 → 4.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00c525420d6c4ab63135973b1b7ea57d27e320bea82221562a3b9a99989b5214
-  data.tar.gz: 2b09f58f764b07aefab15cdc8d598c5e0a3a2455f8cc53a2ce8b21cd140b06f3
+  metadata.gz: bb882700d49c189d82c8986183a1cba9750f01187f172fcc81988d27e2236ab1
+  data.tar.gz: 7de993c7945ed5934c9c3bdd9d1bb50d278876c915c5d46c01686100e520d1cb
 SHA512:
-  metadata.gz: 75028c2c55a861c6a0af16e4c8dc6f482cbfd7b9c4e554de21755390d9d655a29d9da272d64b53780117ec4cdafd57d678fa4b990dce94daed5e81612c58f71b
-  data.tar.gz: 51b2a101b9490e348b191fdd74a2ef1f28ce4a397f541967accb5c10c432dcc3602cfb6417c0524221ad808e74e81815009b79f42cca003e13f8658fd539a987
+  metadata.gz: 103ac8773fa6881af720616002bc3e1ff8bfbbb98d232de9527f4e2755de9299775254a6bedbd8201393812977dd7d9854c59120ca5ee2e277be4f158d3b3939
+  data.tar.gz: a9907fd80fa4797e28a6cfc460a5720fdf809510bb0dc8cfb8c4d97f974389d1a3900ee1ae11e6890f3afe8321d84f09547761fb0c4acff914226b12e77cb78e

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,105 @@
-Workarea Api 4.4.6 (2019-08-21)
+Workarea Api 4.5.4 (2020-08-19)
 --------------------------------------------------------------------------------
 
-*   Open Source!
+*   Handle non-persisted recommendation settings
 
+    This uses `find_or_initialize` to match our usage of
+    `Recommendation::Settings` elsewhere in the platform.
+
+    Fixes #19
+    Ben Crouse
+
+*   Add Documentation Test for Failed Checkout Update
+
+    This documents the scenario in which a checkout update fails to persist,
+    and thus the API returns a `422` error to signify its failure. It
+    depends on the code changes in workarea-commerce/workarea#481, and thus
+    we will need to bump the Workarea version to restrict its upgrade to
+    users of v3.5.17 and beyond.
+
+    API-14
+    Tom Scott
 
 
-Workarea Api 4.4.5 (2019-07-23)
+
+Workarea Api 4.5.3 (2020-03-26)
 --------------------------------------------------------------------------------
 
-*   Fix release task
+*   Update workarea gem dependencies to reflect reality
+
+    Ben Crouse
+
+*   Fix typo
+
+    Tom Scott
+
+*   Remove use of #many? on embedded relationship for Rails 6 upgrade
+
+    Matt Duffy
+
+*   Bump responders dependecy to 3.0.0
+
+    Matt Duffy
+
+
+
+Workarea Api 4.5.2 (2020-01-07)
+--------------------------------------------------------------------------------
+
+*   Fix Docs Generator Task Name
+
+    The task name `workarea:api:generate_docs` wasn't able to load the
+    environment like the rest of the `workarea:test` tasks because it wasn't
+    in the correct Rake namespace. This is due to a hack in core that
+    configures the Rake environment such that custom Rake tasks for testing
+    are possible. Change the task name to `workarea:test:api_docs` to take
+    advantage of this hack so the tests will run properly.
+
+    API-4
+    Tom Scott
+
+*   Add Rake Task For Generating API Documentation
+
+    The `workarea:api:docs` task will generate all API documentation for all
+    plugins without the need to set environment variables. Developers should
+    run this task and commit the results in `doc/api` in order to deploy API
+    documentation changes to a server.
+
+    API-4
+    Tom Scott
+
+*   Fix rakefile
 
     Curt Howard
 
 
 
-Workarea Api 4.4.4 (2019-07-23)
+Workarea Api 4.5.0 (2019-11-26)
 --------------------------------------------------------------------------------
 
-*   Suppress Flash Message and Release Cookie headers from examples
+*   Integrate segmentation into the storefront API
+
+    API-3
+    Ben Crouse
+
+*   Documentation presentation improvements
+
+    * Alphabetize the navigation
+    * Allow markdown for explanations
+    Ben Crouse
+
+*   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
+
+    Fixes Insight-Related Issues from v3.5.x
+    Curt Howard
+
+*   Initial commit on master
 
-    API-226
     Curt Howard
 
 

data/Gemfile

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

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
@@ -18,14 +19,10 @@ separate APIs for different purposes:
 
 ## Getting Started
 
-To begin using the Workarea API, add the following to your **Gemfile** in
-the https://gems.weblinc.com `source` block:
+To begin using the Workarea API, add the following to your **Gemfile**:
 
 ```ruby
-source 'https://gems.weblinc.com' do
-  # ... all your other unquestionably fantastic Workarea gems ...
-  gem 'weblinc-api'
-end
+  gem 'workarea-api'
 ```
 
 Next, mount the API engines into **config/routes.rb**.
@@ -36,7 +33,8 @@ You can either use a path prefix:
 Rails.application.routes.draw do
   # ...all your other absolutely fabulous Workarea routes...
   mount Workarea::Api::Engine => '/api', as: :api
-  # ...except this one. make sure it's last.
+
+# ...except this one. Make sure it's last to correctly handle errors and redirects.
   mount Workarea::Storefront::Engine => '/', as: :storefront
 end
 ```
@@ -63,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...
@@ -95,13 +105,10 @@ describe how each controller and action is to be documented. Look in the
 aforementioned link to see some examples of documentation built using
 the documentation tests.
 
-## Copyright & Licensing
-
-Copyright WebLinc 2017-2019. All rights reserved.
-
-For licensing, contact [sales@workarea.com][]
+License
+--------------------------------------------------------------------------------
+Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)
 
-[Admin API]: https://homebase.weblinc.com/plugins/workarea-api-admin
-[Storefront API]: https://homebase.weblinc.com/plugins/workarea-api-storefront
-[documentation tests]: https://stash.tools.weblinc.com/projects/WL/repos/workarea-api/browse/test/documentation/workarea/api
-[sales@workarea.com]: mailto:sales@workarea.com
+[Admin API]: https://github.com/workarea-commerce/workarea-api/tree/master/admin
+[Storefront API]: https://github.com/workarea-commerce/workarea-api/tree/master/storefront
+[documentation tests]: https://github.com/workarea-commerce/workarea-api/blob/master/storefront/test/documentation/workarea/api/storefront/products_documentation_test.rb

data/Rakefile

@@ -5,11 +5,16 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
+require 'rails'
+require "action_view/railtie"
+
+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 +76,21 @@ 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"'
 
   #
   # 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 doc/ &&
+  #  git commit -am "Update documentation" &&
+  #  git push origin HEAD
+  #COMMAND
 
   #
   # Build gem files
@@ -107,7 +117,7 @@ task :release do
   system "gem push workarea-api-#{Workarea::Api::VERSION}.gem --host #{host}"
   system 'Tagging git...'
   system "git tag -a v#{Workarea::Api::VERSION} -m 'Tagging #{Workarea::Api::VERSION}'"
-  system 'git push --tags'
+  system 'git push origin HEAD --follow-tags'
 
   #
   # Clean up

data/admin/LICENSE

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

data/admin/README.md

@@ -67,14 +67,11 @@ https://youruser@example.com:Password!1@yourtotallyamazingstore.com/api/swagger.
 Point your Swagger client to this endpoint to be able to use and browse
 the Swagger documentation for our API.
 
-## Copyright & Licensing
+License
+--------------------------------------------------------------------------------
+Workarea Commerce Platform is released under the [Business Software License](https://github.com/workarea-commerce/workarea/blob/master/LICENSE)
 
-Copyright Workarea 2017-2019. All rights reserved.
-
-For licensing, contact [sales@workarea.com][].
-
-[Workarea API]: https://homebase.weblinc.com/plugins/workarea-api-admin
-[sales@workarea.com]: mailto:sales@workarea.com
+[Workarea API]: https://github.com/workarea-commerce/workarea-api
 [HTTP Basic Authentication]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#Basic_authentication_scheme
 [OpenAPI]: https://swagger.io/resources/open-api/
 [Swagger]: https://swagger.io

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])