workarea-ship_station 1.0.0

data/app/controllers/workarea/storefront/ship_station_webhook_controller.rb

@@ -0,0 +1,52 @@
+module Workarea
+  module Storefront
+    class ShipStationWebhookController < Storefront::ApplicationController
+      skip_before_action :verify_authenticity_token
+
+      def event
+        body = JSON.parse(request.body.read)
+
+        # return a bad response if the resource url in the
+        # body is not shipstation.
+        uri =  URI(body["resource_url"])
+        return unsuccessful_response unless !!uri.host.match(/.shipstation.com/)
+
+        begin
+          ShipStation::Webhook.process(body)
+          successful_response
+
+        rescue Mongoid::Errors::DocumentNotFound => error
+          not_found_response(params: error.params, problem: error.problem)
+        rescue ShipStation::Webhook::Error::NotFound, ShipStation::Webhook::Error::UnhandledWebhook => error
+          not_found_response(error: "UnhandledWebhook: #{error}")
+        end
+      end
+
+      private
+
+        def verify_signature
+          request_valid = ShipStation::WebhookRequestSignature.valid?(
+            request_signature: request.headers['X-Flow-Signature'],
+            request_body: request.raw_post
+          )
+          unsuccessful_response unless request_valid
+        end
+
+        def successful_response
+          render json: { status: 200 }
+        end
+
+        def unsuccessful_response
+          head :bad_request
+        end
+
+        def error_response(payload)
+          render json: payload, status: :unprocessable_entity
+        end
+
+        def not_found_response(payload)
+          render json: payload, status: :not_found
+        end
+    end
+  end
+end

data/app/models/workarea/order.decorator

@@ -0,0 +1,25 @@
+module Workarea
+  decorate Order, with: :ship_station do
+    decorated do
+      field :ship_station_order_id, type: String
+      field :ship_station_exported_at, type: Time
+      field :ship_station_on_hold_until, type: Time
+
+      index({ ship_station_order_id: 1}, { background: true })
+    end
+
+    def ship_station_exported?
+      !!ship_station_exported_at
+    end
+
+    def ship_station_on_hold?
+      !!ship_station_on_hold_until
+    end
+
+    def set_ship_station_exported_at!
+      update!(
+        ship_station_exported_at: Time.current
+      )
+    end
+  end
+end

data/app/services/workarea/ship_station/order.rb

@@ -0,0 +1,161 @@
+module Workarea
+  module ShipStation
+    class Order
+      module ProductImageUrl
+        include Workarea::ApplicationHelper
+        include Workarea::I18n::DefaultUrlOptions
+        include ActionView::Helpers::AssetUrlHelper
+        include Core::Engine.routes.url_helpers
+        extend self
+
+        def mounted_core
+          self
+        end
+      end
+
+      attr_reader :order
+
+      def initialize(order_id)
+        wa_order = Workarea::Order.find(order_id)
+        @order = Workarea::Storefront::OrderViewModel.new(wa_order)
+      end
+
+      def to_h
+        {
+          orderNumber: order.id,
+          orderKey: order.id,
+          orderDate: order.placed_at,
+          paymentDate: order.placed_at,
+          orderStatus: 'awaiting_shipment',
+          customerUsername: order.email,
+          customerEmail: order.email,
+          billTo: address(order.billing_address),
+          shipTo: address(order.shipping_address),
+          items: items,
+          amountPaid: order.total_price.to_s,
+          taxAmount: order.tax_total.to_s,
+          shippingAmount: order.shipping_total.to_s,
+          paymentMethod: payment_methods,
+          requestedShippingService: shipping_service_name,
+          serviceCode: shipping_service_code,
+          shipByDate: ship_by_date
+        }
+      end
+
+      private
+
+      def ship_by_date
+        return unless Workarea::ShipStation.config.ship_by_date_lead_days.present?
+
+        Time.current + Workarea::ShipStation.config.ship_by_date_lead_days.days
+      end
+
+      def shipping
+        @shipping = Workarea::Shipping.find_by_order(order.id)
+      end
+
+      def shipping_service_code
+        return unless shipping.present?
+        shipping.shipping_service.service_code
+      end
+
+      def shipping_service_name
+        return unless shipping.present?
+        shipping.shipping_service.name
+      end
+
+      def payment
+        @payment = Workarea::Payment.find(order.id)
+      end
+
+      def address(obj)
+        return unless  obj.present?
+        {
+          name: obj.first_name + ' ' + obj.last_name,
+          company: obj.company,
+          street1: obj.street,
+          street2: obj.street_2,
+          city: obj.city,
+          state: obj.region,
+          postalCode: obj.postal_code,
+          country: obj.country.alpha2,
+          phone: obj.phone_number
+        }
+      end
+
+      def items
+        order_items = order.items.map do |order_item|
+
+          hash = {
+            lineItemKey: order_item.id,
+            sku: order_item.sku,
+            name: order_item.product_name,
+            imageUrl: ProductImageUrl.product_image_url(order_item.image, :detail),
+            quantity: order_item.quantity,
+            unitPrice: order_item.original_unit_price.to_f,
+            taxAmount: item_tax(order_item).to_f,
+            options: item_options(order_item),
+            adjustment: false
+          }
+
+          item_shipping_sku = shipping_sku(order_item.sku)
+          if item_shipping_sku.present?
+            weight_data = {
+                weight: {
+                  value: item_shipping_sku.weight,
+                  units: item_shipping_sku.weight_units.to_s
+                }
+            }
+
+            hash.merge!(weight_data)
+          end
+
+          hash
+        end
+
+        order_items + discount_items
+      end
+
+      def shipping_sku(sku)
+        return unless shipping.present?
+        Workarea::Shipping::Sku.find(sku) rescue nil
+      end
+
+      def item_tax(order_item)
+        return unless shipping.present?
+        item = shipping.price_adjustments.adjusting('tax').detect { |pa| pa["data"]["order_item_id"].to_s == order_item.id.to_s }
+        return 0 unless item.present?
+        item.amount.to_f
+      end
+
+      def item_options(order_item)
+        order_item.details.map { |k, v| { name: k, value: v } }
+      end
+
+      def payment_methods
+        payment.tenders.map(&:slug).join(',')
+      end
+
+      def discount_items
+        discounts = order.price_adjustments.select { |p| p.discount? }
+        return [] unless discounts.present?
+
+        discounts.map do |d|
+          {
+            lineItemKey: nil,
+            sku: "DISCOUNT CODE",
+            name: d.description,
+            imageUrl: nil,
+            weight: {
+              value: 0,
+              units: "ounces"
+            },
+            quantity: 1,
+            unitPrice: d.amount.to_f,
+            adjustment: true
+          }
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/ship_station/webhook.rb

@@ -0,0 +1,27 @@
+module Workarea
+  module ShipStation
+    class Webhook
+      class Error < RuntimeError; end
+      class Error::NotFound < RuntimeError; end
+      class Error::UnhandledWebhook < RuntimeError; end
+
+      def self.process(attrs)
+        resource = attrs["resource_type"]
+        begin
+          klass = "Workarea::ShipStation::Webhook::#{resource.downcase.classify}".constantize
+        rescue NameError => _error
+          raise Error::UnhandledWebhook, "no class defined to handle #{resource}"
+        end
+        klass.new(attrs).process
+      end
+
+      attr_reader :attrs
+
+      def initialize(attrs)
+        @attrs = attrs
+      end
+
+      def process; end
+    end
+  end
+end

data/app/services/workarea/ship_station/webhook/item_ship_notify.rb

@@ -0,0 +1,33 @@
+module Workarea
+  module ShipStation
+    class Webhook
+      class ItemShipNotify < Webhook
+        class ShipStationItemShipNotifyError < StandardError; end
+
+        def process
+          uri = URI(attrs["resource_url"])
+          rest_endpoint = "https://" + uri.host
+          query_hash = Rack::Utils.parse_query(uri.query)
+
+          response = gateway(rest_endpoint).get_shipping(query_hash)
+
+          raise ShipStationItemShipNotifyError, response.body["ExceptionMessage"] unless response.success?
+
+          response.body["shipments"].each do |shipment|
+            fulfillment = Workarea::Fulfillment.find(shipment["orderKey"])
+            tracking_number = shipment["trackingNumber"]
+            items = shipment["shipmentItems"].map { |item| { id: item["lineItemKey"], quantity: item["quantity"] } }
+
+            fulfillment.ship_items(tracking_number, items)
+          end
+        end
+
+        private
+
+          def gateway(rest_endpoint)
+            Workarea::ShipStation.gateway(rest_endpoint)
+          end
+      end
+    end
+  end
+end

data/app/views/workarea/admin/orders/_ship_station.html.haml

@@ -0,0 +1,12 @@
+%li
+  %strong= t('workarea.admin.orders.attributes.checkout.ship_station_exported_at')
+  - if @order.ship_station_exported?
+    = local_time_ago(@order.ship_station_exported_at)
+  - else
+    "-"
+%li
+  %strong= t('workarea.admin.orders.attributes.checkout.ship_station_order_id')
+  = @order.ship_station_order_id.presence || "-"
+%li
+  %strong= t('workarea.admin.orders.attributes.checkout.ship_station_on_hold_until')
+  = @order.ship_station_on_hold_until.presence || "-"

data/app/views/workarea/admin/orders/_ship_station_bar_actions.html.haml

@@ -0,0 +1,7 @@
+- if @order.ship_station_order_id.present?
+  .grid__cell
+    %button.workflow-bar__button= link_to t('workarea.admin.orders.place_on_hold'), hold_date_order_path
+  - if @order.ship_station_on_hold?
+    .grid__cell
+      = form_tag clear_hold_date_order_path, method: :patch do
+        %button.workflow-bar__button{ type: :submit }= t('workarea.admin.orders.clear_on_hold')

data/app/views/workarea/admin/orders/hold_date.html.haml

@@ -0,0 +1,27 @@
+- @page_title = @order.name
+
+.view
+  .view__header
+    .grid.grid--middle.grid--right
+      .grid__cell.grid__cell--50
+        .view__heading
+          = link_to_index_for(@order)
+          %h1= t('workarea.admin.orders.order_hold', id: @order.name)
+      .grid__cell.grid__cell--25
+        = render_aux_navigation_for(@order)
+
+  .view__container.view__container--narrow
+    .grid
+      .grid__cell.grid__cell--80
+        %p= t('workarea.admin.orders.hold_until_note')
+
+        - if @order.ship_station_on_hold?
+          %strong= t('workarea.admin.orders.on_hold_until', date: @order.ship_station_on_hold_until.try(:to_s, :date_only))
+
+        = form_tag save_hold_date_order_path, method: 'patch' do
+          .property__name
+            = label_tag 'hold_until', t('workarea.admin.orders.hold_until_date'), class: 'property__name'
+            = datetime_picker_tag 'hold_until', @order.ship_station_on_hold_until.try(:to_s, :date_only), class: 'text-box text-box', data: { datepicker_field: { } }
+          .workflow-bar
+            .grid.grid--auto.grid--right.grid--middle
+              .grid__cell= button_tag t('workarea.admin.orders.place_on_hold'), value: 'place_on_hold', class: 'workflow-bar__button workflow-bar__button--create'

data/app/workers/workarea/ship_station/save_order.rb

@@ -0,0 +1,24 @@
+module Workarea
+  module ShipStation
+    class SaveOrder
+      class ShipStationSaveOrderError < StandardError; end
+      include Sidekiq::Worker
+      include Sidekiq::CallbacksWorker
+
+      sidekiq_options(
+        enqueue_on: { Workarea::Order => [:place] },
+        unique: :until_executing
+      )
+
+      def perform(id)
+        order = Workarea::Order.find(id)
+        shipstation_details = Workarea::ShipStation::Order.new(id).to_h
+        response = ShipStation.gateway.create_order(shipstation_details)
+
+        raise ShipStationSaveOrderError, response.body["ExceptionMessage"]  unless response.success?
+        order.ship_station_order_id = response.body["orderId"]
+        order.set_ship_station_exported_at!
+      end
+    end
+  end
+end

data/bin/rails

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/workarea/ship_station/engine', __dir__)
+APP_PATH = File.expand_path('../test/dummy/config/application', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+# require "action_cable/engine"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+require 'rails/engine/commands'

data/config/initializers/appends.rb

@@ -0,0 +1,9 @@
+Workarea.append_partials(
+  'admin.order_attributes',
+  'workarea/admin/orders/ship_station'
+)
+
+Workarea.append_partials(
+  'admin.order_show_workflow_bar_left',
+  'workarea/admin/orders/ship_station_bar_actions'
+)

data/config/initializers/workarea.rb

@@ -0,0 +1,11 @@
+Workarea.configure do |config|
+  config.ship_station = ActiveSupport::Configurable::Configuration.new
+  config.ship_station.api_timeout = 10
+  config.ship_station.open_timeout = 10
+
+  # setting this config value will set a ship_by_date for new orders.
+  # This value will be added to the current date and sent in the ship_by_date field.
+  #
+  # This value must be an integer.
+  config.ship_station.ship_by_date_lead_days = nil
+end

data/config/locales/en.yml

@@ -0,0 +1,20 @@
+en:
+  workarea:
+    admin:
+      orders:
+        attributes:
+          checkout:
+            ship_station_exported_at: Exported To ShipStation At
+            ship_station_order_id: ShipStation Order ID
+            ship_station_order_id: ShipStation Order ID
+            ship_station_on_hold_until: ShipStation Hold Until
+        clear_on_hold: Clear Order Hold
+        clear_on_hold_success: The order's hold has been cleared.
+        clear_on_hold_error: The order's hold could not be cleard. Please try again.
+        hold_until_date: Hold Until Date
+        hold_until_note: Setting a hold date will set this order's status to "on hold" in ShipStation.
+        on_hold_until: This order is currently on hold until %{date}
+        order_hold: Place %{id} on Hold
+        place_on_hold: Place Order on Hold
+        placed_on_hold_success: The order has been placed on hold.
+        placed_on_hold_error: The order could not be placed on hold. Please try again.