workarea-ship_station 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dab40a2886377073b6804cf0c61bb5a17340e4a1b873b40b8faf608c95b1b32d
+  data.tar.gz: 4855ac55cbcbd188a59b4f592bab181af4d1f3f9c2c88e3ffc85776b1f1c99f8
+SHA512:
+  metadata.gz: f647bcf5a621619b560b23a925d90774b42cb3bdb1c8ddd13624e849e29061e1b236153865accc5e2a745c99537e69cad906e4d019ab84a0664f72ad52462778
+  data.tar.gz: 627dee053fb03fd07316dd6e2dd1d395b023dcfbb2f23de70de9ba2de4d16f8ad2fcb15d798943c7d5947ebffb2ee456b05d34bbcf0c73b257b8e116d0a6654f

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+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
+
+  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,19 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.ruby-version
+.DS_Store
+.byebug_history
+.bundle/
+.sass-cache/
+Gemfile.lock
+test/dummy/public/
+node_modules
+coverage/
+package.json
+yarn.lock
+.rubocop-http*

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+Workarea Ship Station 1.0.0 (2019-10-30)
+--------------------------------------------------------------------------------
+
+*   Integrate ShipStation
+
+    Send orders to shipstation on order place and
+    receive fulfillment date via webhook
+
+    SHIPSTATION-1
+    Jeff Yucis
+
+
+

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in ship_station.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', github: 'workarea-commerce/workarea', branch: 'v3.4-stable'

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,89 @@
+Workarea Ship Station
+================================================================================
+
+ShipStation plugin for the Workarea platform.
+
+Overview
+--------------------------------------------------------------------------------
+
+ShipStation integration for the Workarea Commerce Platform. This plugin handles
+sending orders via the ShipStation API as well as receiving fulfillment updates
+from webhooks.
+
+This integration supports the following features:
+
+  * API integration to send orders to from Workarea to ShipStation
+  * Webhook endpoints to receive fulfillment data from ShipStation
+  * Administration controls for setting and removing on hold status
+  * Configuration options for ship by date
+
+Workarea admins with access to the orders screen will have the option to set an order on hold until a specified date.
+An admin can set a specific hold untill date as well as release orders from on hold that have been placed on hold from the Workarea admin.
+
+
+Configuration
+--------------------------------------------------------------------------------
+
+ShipStation API credentials are required to send orders and receive fulfillments.
+You can get your API credentials by logging into your ShipStation account and going
+to settings, then clicking "API settings" under the "Account" tab.
+
+Generate API keys if there are none present and add them to your host apps secrets file:
+
+```
+  ship_station:
+    api_key: YOUR-API-KEY
+    api_secret: YOUR-API-SECRET
+```
+
+**Fulfillment Notification**
+
+Workarea receives fulfillment notifications via ShipStation webhooks.
+
+Documentation on setting up ShipStation Webhooks can be found [here](https://help.shipstation.com/hc/en-us/articles/360025856252-ShipStation-Webhooks#UUID-1a4971f4-8fb5-f4a5-c399-f36cff610435_UUID-9336531a-ef72-7c0f-6fbb-598f8f144cf3)
+
+When setting up your integration in ShipStation set the following values:
+
+  * Name Description: Can be anything you want, for example "Workarea Fulfillment notification"
+  * Select "On Items Shipped" from the drop down.
+  * Select "All Stores" from the second dropdown.
+  * Send Url: Put "https://YOURDOMAINHERE/ship_station_webhook" - Be sure to change replace YOURDOMAINHERE with your actual domain.
+
+Workarea supports the "On Items Shipped" action only.
+
+**Be sure to create a webhook for each domain your Workarea app supports if you have a multisite setup**
+
+You can add an optional ship by date lead time via a configuration value.
+This value will be added to the current date and sent to ShipStation when an order is placed. This date will show as the "Ship By" date in the orders admin screen in ShipStation.
+
+```ruby
+  config.ship_station.ship_by_date_lead_days = 5
+```
+
+
+Getting Started
+--------------------------------------------------------------------------------
+
+This gem contains a Rails engine that must be mounted onto a host Rails application.
+
+Then add the gem to your application's Gemfile specifying the source:
+
+    # ...
+    gem 'workarea-ship_station'
+    # ...
+
+Update your application's bundle.
+
+    cd path/to/application
+    bundle
+
+
+Workarea Platform Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea platform documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Ship Station is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,57 @@
+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    = 'Ship Station'
+  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/ship_station/version'
+
+desc "Release version #{Workarea::ShipStation::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 push origin HEAD'
+
+  system "git tag -a v#{Workarea::ShipStation::VERSION} -m 'Tagging #{Workarea::ShipStation::VERSION}'"
+  system 'git push --tags'
+
+  system "gem build workarea-ship_station.gemspec"
+  system "gem push workarea-ship_station-#{Workarea::ShipStation::VERSION}.gem"
+  system "rm workarea-ship_station-#{Workarea::ShipStation::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/orders_controller.decorator

@@ -0,0 +1,50 @@
+module Workarea
+  decorate Admin::OrdersController, with: :ship_station do
+
+    def save_hold_date
+      response = Workarea::ShipStation.gateway.hold_order(ship_station_hold_attrs)
+
+      if response.success?
+        @order.update_attributes!(ship_station_on_hold_until: params[:hold_until])
+
+        flash[:success] = t('workarea.admin.orders.placed_on_hold_success')
+        redirect_to order_path(@order)
+      else
+        flash[:error] = t('workarea.admin.orders.placed_on_hold_error')
+        render :select_hold_date
+      end
+    end
+
+    def clear_hold_date
+      response = Workarea::ShipStation.gateway.clear_hold_order(ship_station_clear_hold_attrs)
+
+      if response.success?
+        @order.update_attributes!(ship_station_on_hold_until: nil)
+
+        flash[:success] = t('workarea.admin.orders.clear_on_hold_success')
+        redirect_to order_path(@order)
+      else
+        flash[:error] =  t('workarea.admin.orders.clear_on_hold_error')
+        render :select_hold_date
+      end
+    end
+
+    def select_hold_date
+    end
+
+    private
+
+    def ship_station_hold_attrs
+      {
+        orderId: @order.ship_station_order_id,
+        holdUntilDate: params[:hold_until]
+      }
+    end
+
+    def ship_station_clear_hold_attrs
+      {
+        orderId: @order.ship_station_order_id
+      }
+    end
+  end
+end