workarea-legacy_orders 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 841ffe9b077193a86f4755a8e998cc14c4a4ba2de5ad978edb0bb72deb543132
+  data.tar.gz: ee329f6ad586fec610232775deda33d2f98281aa8a66fb9c0d063371fa411d5a
+SHA512:
+  metadata.gz: e8b5c4c281f9423d079337de131fdba12bed00da7461075ada03fbe10ae1669cfa51af87159b715fd59058ad12a9f5f4a16b88e0352241d1de3db1b14acef342
+  data.tar.gz: 485da6e8964e4df4bff09b750cca381d0c2f289d8c0ba6aabd9100efec8c14ebd8b4d7969b1f987342f2aca35cbe25ffc36e18969e8c82acc76a5768111e8020

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

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,61 @@
+name: CI
+on:
+  push:
+    paths-ignore:
+      - '.github/**'
+      - '**.md'
+
+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: bin/rails app:workarea:test:admin
+
+  core_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: bin/rails app:workarea:test:core
+
+  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: bin/rails app:workarea:test:storefront
+
+  plugins_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: bin/rails app:workarea:test:plugins

data/.gitignore

@@ -0,0 +1,24 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/log/*.log
+test/dummy/node_modules/
+test/dummy/yarn-error.log
+test/dummy/tmp/
+.DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+pkg/
+test/dummy/tmp/
+test/dummy/public/
+log/*.log
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+node_modules
+yarn.lock
+yarn-error.log
+package-lock.json
+.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/.yardopts

@@ -0,0 +1 @@
+--files CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+Workarea Legacy Orders 2.0.0 (2020-02-21)
+--------------------------------------------------------------------------------
+
+*   Update system test to not use Money object for string comparison
+
+    LEGACYORDERS-4
+    Matt Duffy
+
+*   Add data structure to README
+
+    LEGACYORDERS-3
+    Matt Duffy
+
+*   Add data fields to models for allowing storing additional information
+
+    Matt Duffy
+
+*   Update storefront view with legacy ordre specific appoint points
+
+    LEGACYORDERS-2
+    Matt Duffy
+
+*   Add import/export behavior to legacy orders admin UI
+
+    Matt Duffy
+
+*   Improve legacy order integration
+
+    * Add admin UI and searchability
+    * Add legacy orders in user account summary
+    * Update views and view models to align with regular orders
+    * Include legacy orders in order lookup
+    * Improve seeds
+
+    LEGACYORDERS-1
+    Matt Duffy
+
+
+

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec
+
+gem 'workarea', github: 'workarea-commerce/workarea', branch: 'v3.5-stable'
+gem 'workarea-api', github: 'workarea-commerce/workarea-api'

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,188 @@
+WebLinc Legacy Orders
+================================================================================
+
+Workarea Commerce platform plugin that enables the importing of orders from outside sources. Useful during the migration process from another system where you wish to preserve order data for customers.
+
+Features
+--------------------------------------------------------------------------------
+
+* Display order history inline with Workarea order history for customers
+* Supports order lookup behavior for guest orders
+* Admin UI support for searching and browsing legacy orders
+* Admin UI support for importing and exporting legacy orders
+* Admin API Support for viewing legacy orders
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+    # ...
+    gem 'workarea-legacy_orders'
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+Data Structure
+--------------------------------------------------------------------------------
+
+Legacy orders are structured to be a simplistic representation of order data as compared to real Workarea order data. This more basic data structure alleviates the need to recreate or work around missing data when importing from outside sources. A legacy order has its own model, with embedded documents for items, tenders, and addresses.
+
+```ruby
+Workarea::LegacyOrder.create(
+  id: '012789',
+  email: 'customer@gmail.com',
+  customer_number: '0001031',
+  alternate_number: 'PO-85201',
+  placed_at: Time.parse('20/02/2020 20:20:20'),
+  status: 'shipped',
+  shipping_method: 'USPS Priority Mail',
+  shipping_total: 14.82.to_m,
+  tax_total: 8.94.to_m,
+  discount_total: -5.to_m,
+  total_price: 172.73.to_m,
+  data: {
+    tracking_number: '1Z0E85051951',
+    promo_codes: ['5OFF'],
+    token: 'b1946ac92492d2347c6235b4d2611184'
+  },
+  billing_address: {
+    first_name: 'Robert',
+    last_name: 'Clams',
+    street: '22 South 3rd St.',
+    street_2: 'Second Floor',
+    city: 'Philadelphia',
+    region: 'PA',
+    postal_code: '19106',
+    country: 'US'
+  },
+  shipping_address: {
+    first_name: 'Robert',
+    last_name: 'Clams',
+    street: '22 South 3rd St.',
+    street_2: 'Second Floor',
+    city: 'Philadelphia',
+    region: 'PA',
+    postal_code: '19106',
+    country: 'US'
+  },
+  items: [
+    {
+      name: 'Awesome T-Shirt',
+      sku: 'ATS001',
+      quantity: 1,
+      price: 24.99.to_m,
+      detail: {
+        'Color' => 'Black',
+        'Size' => 'Medium'
+      },
+      customizations: {
+       'custom text' => 'Clever Saying Goes Here'
+      },
+      status: 'pending'
+    },
+    {
+      name: 'Fancy Pants',
+      sku: 'FP1337',
+      product_id: '00815291',
+      quantity: 2,
+      price: 128.98.to_m,
+      details: { 'Size' => '30x30' },
+      status: 'shipped'
+    }
+  ],
+  tenders: [
+    {
+      type: 'gift card',
+      number: 'XXXXXXXX6681',
+      amount: 50.to_m
+    },
+    {
+      type: 'credit card',
+      number: 'XXXXXXXXXXXX1212',
+      amount: 122.73.to_m,
+      issuer: 'visa',
+      expiration_month: '11',
+      expiration_year: '2022',
+      data: { authorization_id: '1595263196681261473' }
+    }
+  ]
+)
+```
+
+### `Workarea::LegacyOrder`
+
+| Field |  |
+|--|--|
+|`_id` | To match a Workarea order, the ID of a    `LegacyOrder` represents the order number displayed across the site. |
+|`email` | *Required*. The email address associated to the order. |
+|`customer_number` | Used to store a reference to the customer that placed the order. When looking for legacy orders for a user, Workarea will look to match the user's ID with this number. |
+|`alternate_number` | Allows for the storage of other reference numbers other than ID. |
+|`placed_at` | *Required*. When the order was placed. |
+|`status` | The overall status of the order. |
+|`shipping_method` | The name of the shipping method that was used for the order. |
+|`shipping_total` | The total cost of shipping for the order. |
+|`tax_total` | *Required*. The total cost of tax for the order. |
+|`discount_total` | The total value of discounts for the order. |
+|`total_price` | *Required*. The total cost of the entire order, including tax, shipping, and discounts. |
+|`data` | A hash field that can be used to store other relevant data that you wish to preserve from orders imported to Workarea. |
+| `billing_address`| An embedded document of the order's billing address. See `Workarea::LegacyOrder::Address` below.|
+| `shipping_address`| An embedded document of the order's shipping address. See `Workarea::LegacyOrder::Address` below.|
+| `items`| An embedded collection of items for the order. See `Workarea::LegacyOrder::Item` below.|
+| `tenders`| An embedded collection of payment methods used for the order. See `Workarea::LegacyOrder::Tender` below.|
+
+### `Workarea::LegacyOrder::Item`
+
+| Field |  |
+|--|--|
+| `name` | *Required*. The display name for the item. Often this will be the name of the product. |
+| `sku` | *Required*. The unique identifier for the specific item. |
+| `product_id` | The ID of the product. |
+| `quantity` | *Required*. The quantity of this item that was purchased. |
+| `price` | *Required*. The total price of the item. |
+| `details` | A hash of options for the item. Often things like color and size. |
+| `customizations` | A hash of values specified by the customer when being ordered, e.g. engravings. |
+| `status` | The fulfillment status of the item. Can be any value, but suggested to be one of `pending`, `shipped`, or `canceled`. |
+| `data` | A hash field that can be used to store other relevant data that you wish to preserve from the item imported to Workarea. |
+
+### `Workarea::LegacyOrder::Tender`
+
+| Field |  |
+|--|--|
+| `type` | *Required*. The type of tender used, e.g. credit card, gift card, paypal, etc. |
+| `number` | A number associated to the payment method. For credit card this would be an obfuscated number with the last four digits. |
+| `amount` | *Required*. The amount charged to this tender. |
+| `issuer` | For credit cards, the issuer of the card. |
+| `expiration_month` | For credit cards, the month of expiration. |
+| `expiration_year` | For credit cards, the year of expiration. |
+| `data` | A hash field that can be used to store other relevant data that you wish to preserve from the tender imported to Workarea. |
+
+### `Workarea::LegacyOrder::Address`
+
+Legacy order address fields match fields for all other addresses in Workarea. The only exception is that legacy order addresses are not validated and allow for any number of fields to be blank if information is not available.
+
+* `first_name`
+* `last_name`
+* `street`
+* `street_2`
+* `city`
+* `company`
+* `region`
+* `postal_code`
+* `country`
+* `phone_number`
+* `phone_extension`
+
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea platform documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Shopify Migration is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,56 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Shopify Migration'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/legacy_orders/version'
+
+desc "Release version #{Workarea::LegacyOrders::VERSION} of the gem"
+task :release do
+  Rake::Task['workarea:changelog'].execute
+  system 'git add CHANGELOG.md'
+  system 'git commit -m "Update CHANGELOG"'
+
+  system "git tag -a v#{Workarea::LegacyOrders::VERSION} -m 'Tagging #{Workarea::LegacyOrders::VERSION}'"
+  system 'git push origin HEAD --follow-tags'
+
+  system "gem build workarea-legacy_orders.gemspec"
+  system "gem push workarea-legacy_orders-#{Workarea::LegacyOrders::VERSION}.gem"
+  system "rm workarea-legacy_orders-#{Workarea::LegacyOrders::VERSION}.gem"
+end
+
+desc 'Run the JavaScript tests'
+ENV['TEASPOON_RAILS_ENV'] = File.expand_path('../test/dummy/config/environment', __FILE__)
+task teaspoon: 'app:teaspoon'
+
+desc 'Start a server at http://localhost:3000/teaspoon for JavaScript tests'
+task :teaspoon_server do
+  Dir.chdir("test/dummy")
+  teaspoon_env = File.expand_path('../test/teaspoon_env.rb', __FILE__)
+  system "RAILS_ENV=test TEASPOON_ENV=#{teaspoon_env} rails s"
+end

data/app/controllers/workarea/admin/legacy_orders_controller.rb

@@ -0,0 +1,17 @@
+module Workarea
+  module Admin
+    class LegacyOrdersController < Admin::ApplicationController
+      def index
+        search = Search::AdminLegacyOrders.new(params)
+        @search = Admin::OrderSearchViewModel.new(search, view_model_options)
+      end
+
+      def show
+        @order = Admin::LegacyOrderViewModel.wrap(
+          LegacyOrder.find(params[:id]),
+          view_model_options
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+module Workarea
+  if Plugin.installed?("Workarea::Api")
+    module Api
+      module Admin
+        class LegacyOrdersController < Workarea::Api::Admin::ApplicationController
+          def index
+            @orders = LegacyOrder
+              .all
+              .order_by(sort_field => sort_direction)
+              .page(params[:page])
+
+            respond_with orders: @orders
+          end
+
+          def create
+            @order = LegacyOrder.create!(params[:order])
+            respond_with(
+              { order: @order },
+              status: :created,
+              location: legacy_order_path(@order.id)
+            )
+          end
+
+          def show
+            @order = LegacyOrder.find(params[:id])
+            respond_with order: @order
+          end
+
+          def update
+            @order = LegacyOrder.find(params[:id])
+            @order.update_attributes!(params[:order])
+            respond_with order: @order
+          end
+
+          private
+
+            def sort_field
+              params[:sort_by].presence || :placed_at
+            end
+        end
+      end
+    end
+  end
+end

data/app/controllers/workarea/storefront/orders_controller.decorator

@@ -0,0 +1,37 @@
+module Workarea
+  decorate Storefront::OrdersController, with: :legacy_orders do
+    def lookup
+      order = LegacyOrder.lookup(params[:order_id], params[:postal_code])
+
+      if order.present?
+        session[:legacy_lookup_order_id] = order.id
+        redirect_to order_path(order)
+      else
+        session[:legacy_lookup_order_id] = nil
+        super
+      end
+    end
+
+    def show
+      if legacy_lookup_order.present? &&
+        legacy_lookup_order.id.to_s.downcase == params[:id].to_s.downcase
+
+        @order = Storefront::LegacyOrderViewModel.wrap(
+          @legacy_lookup_order,
+          view_model_options
+        )
+
+        render 'workarea/storefront/legacy_orders/show'
+      else
+        super
+      end
+    end
+
+    private
+
+    def legacy_lookup_order
+      return nil unless session[:legacy_lookup_order_id].present?
+      @legacy_lookup_order ||= LegacyOrder.find(session[:legacy_lookup_order_id])
+    end
+  end
+end

data/app/controllers/workarea/storefront/users/orders_controller.decorator

@@ -0,0 +1,42 @@
+module Workarea
+  decorate Storefront::Users::OrdersController, with: 'legacy_orders' do
+    def index
+      super
+      @orders += legacy_orders
+    end
+
+    def show
+      model = LegacyOrder.find(params[:id]) rescue nil
+
+      if model.blank?
+        super
+        return
+      end
+
+      if model.email.downcase != current_user.email.downcase
+        render nothing: true, status: :forbidden and return
+      else
+        @order = Storefront::LegacyOrderViewModel.wrap(model)
+        render "workarea/storefront/users/legacy_orders/show"
+      end
+    end
+
+    private
+
+    def legacy_order_limit
+      Workarea.config.storefront_user_order_display_count - @orders.size
+    end
+
+    def legacy_order_models
+      return [] unless legacy_order_limit > 0
+
+      LegacyOrder
+        .for_email(current_user.email)
+        .limit(legacy_order_limit)
+    end
+
+    def legacy_orders
+      Storefront::LegacyOrderViewModel.wrap(legacy_order_models)
+    end
+  end
+end