workarea-api 4.4.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,21 @@
+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
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]
+
+
+gem 'workarea-api-admin', path: 'admin'
+gem 'workarea-api-storefront', path: 'storefront'
+
+gem 'workarea', '>= 3.4.0'

data/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/README.md

@@ -0,0 +1,107 @@
+# Workarea API
+
+**workarea-api** defines an HTTP API, using JSON as a data format, for
+programmatic access to your Workarea application. The Workarea API is
+used for many purposes, such as integration with external services, or
+providing an alternative user interface to your web store (like an
+on-premises kiosk or mobile application). As such, Workarea provides two
+separate APIs for different purposes:
+
+- The [Admin API][] is only available to admin users with the necessary
+  "API Access" permissions, and provides CRUD operations on all data models
+  in the application. It's primarily used for integration with external
+  service providers, such as an OMS or ERP.
+- The [Storefront API][] has a slightly more complex authentication
+  scheme, because it's used by end-users to browse and purchase items on
+  the storefront. This API is suitable for building alternative user
+  interfaces to Workarea
+
+## Getting Started
+
+To begin using the Workarea API, add the following to your **Gemfile** in
+the https://gems.weblinc.com `source` block:
+
+```ruby
+source 'https://gems.weblinc.com' do
+  # ... all your other unquestionably fantastic Workarea gems ...
+  gem 'weblinc-api'
+end
+```
+
+Next, mount the API engines into **config/routes.rb**.
+
+You can either use a path prefix:
+
+```ruby
+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.
+  mount Workarea::Storefront::Engine => '/', as: :storefront
+end
+```
+
+Or, a subdomain. To use a subdomain for your API, create a file at
+**app/routing_constraints/api_subdomain_constraint.rb** with the
+following contents:
+
+```ruby
+class ApiSubdomainConstraint
+  def self.matches?(request)
+    request.subdomain =~ /^api/
+  end
+end
+```
+
+Then, wrap your `mount` statement with a `constraints` block:
+
+```ruby
+constraints ApiSubdomainConstraint do
+  mount Workarea::Api::Engine => '/', as: :api
+end
+```
+
+That will allow clients to access your API at https://api.yourtotallyamazingstore.com
+
+## Configuration
+
+This plugin provides a number of options for configuring its usage...
+
+- **config.api_product_image_jobs_blacklist** configures the Dragonfly
+  processor jobs whose URLs are omitted from image JSON responses in the
+  Storefront API. Default is `:convert`, `:encode`, `:rotate`, `:optim`,
+  `:avatar`, and `:thumb`.
+- **config.authentication_token_expiration** sets how long Storefront API auth
+  tokens last before they are expired. Default is `1.week`
+- **config.max_api_bulk_data_size** configures the max amount of items which
+  may be included in a `Workarea::Api::Admin::BulkUpsert`
+- **config.api_admin_ignore_definitions** prevents certain models from
+  being considered when Swagger JSON is being generated
+
+## Documentation
+
+Documentation for API endpoints is available wherever the
+`Workarea::Api::Engine` has been mounted, at the relative path `/docs`.
+By default, this path is `/api/docs`. This documentation is loaded from
+the gem source by default, but if you customize API endpoints, you'll
+need to generate customized documentation with the following command:
+
+```bash
+GENERATE_API_DOCS=true bin/rails workarea:test
+```
+
+Documentation for the API is built using [documentation tests][], which
+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][]
+
+[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

data/Rakefile

@@ -0,0 +1,121 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake/testtask'
+require 'date'
+
+load 'rails/test_unit/testing.rake'
+load 'workarea/changelog.rake'
+
+GEMS = %w(admin storefront).freeze
+ROOT_DIR = Dir.pwd
+
+GEMS.each do |gem|
+  Rake::TestTask.new("#{gem}_test") do |t|
+    t.libs << "#{gem}/test"
+    t.pattern = "#{gem}/test/**/*_test.rb"
+    t.verbose = false
+    t.warning = false
+  end
+
+  task "#{gem}_test_ci" do
+    ENV['CI'] = 'true'
+    ENV['JUNIT_PATH'] = "#{gem}/test/reports"
+
+    $: << "#{gem}/test"
+
+    Rails::TestUnit::Runner.rake_run(["#{gem}/test/**/*_test.rb"])
+  end
+end
+
+Rake::Task['test'].clear
+desc 'Run tests for all gems'
+task :test do
+  require 'rails/test_unit/reporter'
+
+  $: << 'admin/test'
+  $: << 'storefront/test'
+  Rails::TestUnitReporter.executable = 'bin/rails test'
+
+  # Override this to print a command that we rerun the test on failure
+  Rails::TestUnitReporter.class_eval do
+    def format_rerun_snippet(result)
+      location, line = result.method(result.name).source_location
+      rel_path = relative_path_for(location)
+
+      GEMS.each do |gem|
+        if rel_path.include?(gem)
+          return "cd #{gem} && bin/rails test #{rel_path}:#{line}"
+        end
+      end
+
+      "#{executable} #{rel_path}:#{line}"
+    end
+  end
+
+  Rails::TestUnit::Runner.rake_run(GEMS.map { |g| "#{g}/test" })
+end
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/api/version'
+
+desc "Release version #{Workarea::Api::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #
+  # Updating changelog
+  #
+  #
+  #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'
+
+  #
+  # Build gem files
+  #
+  #
+  GEMS.each do |gem|
+    Dir.chdir("#{ROOT_DIR}/#{gem}")
+    system "gem build workarea-api-#{gem}.gemspec"
+  end
+
+  Dir.chdir(ROOT_DIR)
+  system 'gem build workarea-api.gemspec'
+
+  #
+  # Push gem files
+  #
+  #
+  puts 'Pushing gems...'
+  GEMS.each do |gem|
+    system "gem push #{gem}/workarea-api-#{gem}-#{Workarea::Api::VERSION}.gem"
+    system "gem push #{gem}/workarea-api-#{gem}-#{Workarea::Api::VERSION}.gem --host #{host}"
+  end
+  system "gem push workarea-api-#{Workarea::Api::VERSION}.gem"
+  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'
+
+  #
+  # Clean up
+  #
+  #
+  puts 'Cleaning up...'
+  GEMS.each do |gem|
+    system "rm #{gem}/workarea-api-#{gem}-#{Workarea::Api::VERSION}.gem"
+  end
+  system "rm workarea-api-#{Workarea::Api::VERSION}.gem"
+end

data/admin/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+Gemfile.lock
+.sass-cache/
+log/*.log
+pkg/
+test/dummy/public/system/dragonfly
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+**/.DS_Store
+docs/build

data/admin/README.md

@@ -0,0 +1,82 @@
+# Workarea Admin API
+
+Part of the [Workarea API][], the Admin API is used for programmatic
+access to your Workarea application's data model. It's designed to be
+"auto-extending", so that when you add or change fields in your Workarea
+models, those fields will be available for use in the API. This part of
+the Workarea API is primarily used for external services integration,
+such as with order management systems, enterprise resource planners, or
+email service providers, and provides detailed order and shipping information
+to such systems.
+
+## Overview
+
+- [Swagger][] integration with an implementation of the API in [OAS 2.0][OpenAPI]
+- Basic CRUD actions for core Workarea models
+- Bulk "Upsert" functionality for importing multiple records in the same
+  HTTP `PATCH` request.
+
+## Getting Started
+
+To use this plugin, install the **workarea-api** gem.
+
+For more information on the API as a whole, and to learn how to set up
+the API plugin, consult the [main README][Workarea API].
+
+## Authentication
+
+The Admin API secures itself using basic HTTP authentication. It authenticates
+with the same email address and password used to login to the admin. You will
+also need the API access permissions enabled for your account. This can be done
+in the permissions tab of the user edit page in the admin. You can also do this
+in the Rails console by enabling the `api_access` field on the user:
+
+To make requests to the Admin API, ensure your user has API access
+permissions. This can be changed in the "Permissions" tab of the "Edit
+User" page in the admin, or within the `rails console` using the
+following code:
+
+```ruby
+Workarea::User.find_by_email('user@workarea.com').update!(api_access: true)
+```
+
+(**NOTE:** Super-admins will automatically have this access)
+
+The Admin API uses [HTTP Basic Authentication][] to authorize client
+requests, with the format `email:password`. You can provide these
+details in an `Authorization` header, encoded in Base64...
+
+```http
+Authorization: Basic eW91cnVzZXJAZXhhbXBsZS5jb206UGFzc3dvcmQhMQ==\n
+```
+
+Or, in the URL, with requests made like:
+
+https://youruser@example.com:Password!1@yourtotallyamazingstore.com/api/orders.json
+
+Unlike the Storefront API, all Admin API endpoints are protected behind
+authentication.
+
+## Swagger
+
+Workarea's Admin API implements the [OpenAPI][] Specification for
+integration with [Swagger][] tools, IPaaS solutions like [Cenit][] or
+[Boomi][], and anything else that speaks OpenAPI. This can be accessed
+at your API's `/api/admin/swagger.json` endpoint, for example
+https://youruser@example.com:Password!1@yourtotallyamazingstore.com/api/swagger.json.
+Point your Swagger client to this endpoint to be able to use and browse
+the Swagger documentation for our API.
+
+## Copyright & Licensing
+
+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
+[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
+[Cenit]: https://cenit.io
+[Boomi]: https://boomi.com

data/admin/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+# Load the dummy app's rake tasks
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'

data/admin/app/assets/images/workarea/api/admin/icons/api.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><path d="M47.6 20.1c-7.5 1.2-13.2 7.6-13.2 15.4V41c0 1.4 1.1 2.5 2.5 2.5h26.4c1.4 0 2.5-1.1 2.5-2.5v-5.4c0-7.8-5.7-14.3-13.2-15.4V9.8c0-1.4-1.1-2.5-2.5-2.5s-2.5 1.1-2.5 2.5v10.3zM45.9 50.8c0-1.4-1.1-2.5-2.5-2.5s-2.5 1.1-2.5 2.5v5.8h-4.1c-1.4 0-2.5 1.1-2.5 2.5v5.4c0 7.8 5.7 14.3 13.2 15.4v10.4c0 1.4 1.1 2.5 2.5 2.5s2.5-1.1 2.5-2.5V79.9c7.5-1.2 13.2-7.6 13.2-15.4V59c0-1.4-1.1-2.5-2.5-2.5h-4.1v-5.8c0-1.4-1.1-2.5-2.5-2.5s-2.5 1.1-2.5 2.5v5.8h-8.2v-5.7z"/></svg>

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

@@ -0,0 +1,73 @@
+module Workarea
+  module Api
+    module Admin
+      class ApplicationController < Workarea::ApplicationController
+        include CurrentRelease
+        include ::Swagger::Blocks
+
+        respond_to :json
+
+        before_action :current_user # to force HTTP basic auth
+        before_action :set_json_format
+        before_action { params.permit! }
+        around_action :audit_log
+
+        rescue_from Mongoid::Errors::DocumentNotFound, with: :handle_not_found
+        rescue_from Mongoid::Errors::Validations, with: :handle_invalid
+        rescue_from Mongoid::Errors::UnknownAttribute, with: :handle_unknown_attribute
+
+        def current_user
+          return @current_user if defined?(@current_user)
+
+          if user = authenticate_with_http_basic { |u, p| Api::Admin.authenticate(u, p) }
+            @current_user = user
+          else
+            request_http_basic_authentication
+          end
+        end
+
+        def sort_field
+          params[:sort_by].presence || :created_at
+        end
+
+        def sort_direction
+          if params[:sort_direction].in?(%w(asc desc))
+            params[:sort_direction]
+          else
+            :desc
+          end
+        end
+
+        private
+
+        def current_release_id
+          params[:release_id]
+        end
+
+        def set_json_format
+          request.format = :json
+        end
+
+        def handle_not_found(e)
+          payload = { params: e.params, problem: e.problem }
+          render json: payload, status: :not_found
+        end
+
+        def handle_invalid(e)
+          payload = { problem: e.summary, document: e.document }
+          render json: payload, status: :unprocessable_entity
+        end
+
+        def handle_unknown_attribute(e)
+          render json: e.as_json.slice('problem'), status: :unprocessable_entity
+        end
+
+        def audit_log
+          Mongoid::AuditLog.record(current_user) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end