workarea-ship_station 1.0.0

data/config/routes.rb

@@ -0,0 +1,13 @@
+Workarea::Storefront::Engine.routes.draw do
+  post :ship_station_webhook, as: :ship_station_webhook, controller: 'ship_station_webhook', action: 'event'
+end
+
+Workarea::Admin::Engine.routes.draw do
+  resources :orders, only: [] do
+    member do
+      get :hold_date
+      patch :save_hold_date
+      patch :clear_hold_date
+    end
+  end
+end

data/lib/workarea/ship_station.rb

@@ -0,0 +1,39 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+
+require 'workarea/ship_station/engine'
+require 'workarea/ship_station/version'
+
+require 'workarea/ship_station/bogus_gateway'
+require 'workarea/ship_station/gateway'
+require 'workarea/ship_station/response'
+
+module Workarea
+  module ShipStation
+    def self.credentials
+      (Rails.application.secrets.ship_station || {}).deep_symbolize_keys
+    end
+
+    def self.config
+      Workarea.config.ship_station
+    end
+
+    def self.api_key
+      credentials[:api_key]
+    end
+
+
+    def self.api_secret
+      credentials[:api_secret]
+    end
+
+    def self.gateway(rest_endpoint = "")
+      if credentials.present?
+        ShipStation::Gateway.new(api_key: api_key, api_secret: api_secret, rest_endpoint: rest_endpoint)
+      else
+        ShipStation::BogusGateway.new
+      end
+    end
+  end
+end

data/lib/workarea/ship_station/bogus_gateway.rb

@@ -0,0 +1,297 @@
+module Workarea
+  module ShipStation
+    class BogusGateway
+      def initialize(options = {})
+      end
+
+      def create_order(order)
+        Response.new(response(create_order_body))
+      end
+
+      def get_shipping(attrs = {})
+         Response.new(response(get_shipments_body))
+      end
+
+      def get_shipping(attrs = {})
+         Response.new(response(get_shipments_body))
+      end
+
+      def hold_order(attrs = {})
+        Response.new(response(hold_body))
+      end
+
+      def clear_hold_order(attrs = {})
+        Response.new(response(hold_body))
+      end
+
+      private
+
+      def response(body, status = 200)
+        response = Faraday.new do |builder|
+          builder.adapter :test do |stub|
+            stub.get("/orders/createorder") { |env| [ status, {}, body.to_json ] }
+          end
+        end
+        response.get("/orders/createorder")
+      end
+
+      def create_order_body
+        {
+          orderId: 5017358,
+          orderNumber: "1234",
+          orderKey: "1234",
+          orderDate: "2019-10-04T06 57 17.5930000",
+          createDate: "2019-10-04T06 57 18.9030000",
+          modifyDate: "2019-10-04T06 57 18.9030000",
+          paymentDate: "2019-10-04T06 57 17.5930000",
+          shipByDate: nil,
+          orderStatus: "awaiting_shipment",
+          customerId: nil,
+          customerUsername: "jyucis@weblinc.com",
+          customerEmail: "jyucis@weblinc.com",
+          billTo: {
+            name: "Jeff Yucis",
+            company: "",
+            street1: "35 Letitia Ln",
+            street2: "",
+            street3: nil,
+            city: "Media",
+            state: "PA",
+            postalCode: "19063-5838",
+            country: "US",
+            phone: "3027507743",
+            residential: nil,
+            addressVerified: nil
+          },
+          shipTo: {
+            name: "Jeff Yucis",
+            company: "",
+            street1: "35 LETITIA LN",
+            street2: "",
+            street3: nil,
+            city: "MEDIA",
+            state: "PA",
+            postalCode: "19063-4019",
+            country: "US",
+            phone: "3027507743",
+            residential: true,
+            addressVerified: "Address validated successfully"
+          },
+          items: [
+            {
+              orderItemId: 7804579,
+              lineItemKey: "5d974f5e987b4750710c04fc",
+              sku: "396342674-8",
+              name: "Sleek Wooden Table",
+              imageUrl: "/product_images/sleek-wooden-table/5d89164b987b47002578378f/detail.jpg?c=1569265227",
+              weight: nil,
+              quantity: 1,
+              unitPrice: 8.0,
+              taxAmount: 0.0,
+              shippingAmount: nil,
+              warehouseLocation: nil,
+              options: [
+                { name: "Size", value: "Extra Small" },
+                { name: "Color", value: "Maroon" }
+              ],
+              productId: nil,
+              fulfillmentSku: nil,
+              adjustment: false,
+              upc: nil,
+              createDate: "2019-10-04T06 57 18.903",
+              modifyDate: "2019-10-04T06 57 18.903"
+            }
+          ],
+          orderTotal: 15.0,
+          amountPaid: 15.0,
+          taxAmount: 0.0,
+          shippingAmount: 7.0,
+          customerNotes: nil,
+          internalNotes: nil,
+          gift: false,
+          giftMessage: nil,
+          paymentMethod: "credit_card",
+          requestedShippingService: "Ground",
+          carrierCode: nil,
+          serviceCode: nil,
+          packageCode: nil,
+          confirmation: "none",
+          shipDate: nil,
+          holdUntilDate: nil,
+          weight: { value: 0.0, units: "ounces", WeightUnits: 1 },
+          dimensions: nil,
+          insuranceOptions: {
+            provider: nil, insureShipment: false, insuredValue: 0.0
+          },
+          internationalOptions: {
+            contents: nil, customsItems: nil, nonDelivery: nil
+          },
+          advancedOptions: {
+            warehouseId: 113059,
+            nonMachinable: false,
+            saturdayDelivery: false,
+            containsAlcohol: false,
+            mergedOrSplit: false,
+            mergedIds: [],
+            parentId: nil,
+            storeId: 62810,
+            customField1: nil,
+            customField2: nil,
+            customField3: nil,
+            source: nil,
+            billToParty: nil,
+            billToAccount: nil,
+            billToPostalCode: nil,
+            billToCountryCode: nil,
+            billToMyOtherAccount: nil
+          },
+          tagIds: nil,
+          userId: nil,
+          externallyFulfilled: false,
+          externallyFulfilledBy: nil,
+          labelMessages: nil
+        }
+      end
+
+      def get_shipments_body
+        {
+          page: 1,
+          pages: 0,
+          shipments: [
+            {
+              advancedOptions: {
+              billToAccount: nil,
+              billToCountryCode: nil,
+              billToParty: "4",
+              billToPostalCode: nil,
+              storeId: 62810
+            },
+              batchNumber: nil,
+              carrierCode: "stamps_com",
+              confirmation: "delivery",
+              createDate: "2019-09-30T13:37:05.7230000",
+              customerEmail: "jyucis@workarea.com",
+              dimensions: {
+                height: 4.0,
+                length: 4.0,
+                units: "inches",
+                width: 4.0
+              },
+              formData: nil,
+              insuranceCost: 0.0,
+              insuranceOptions: {
+                insureShipment: false,
+                insuredValue: 0.0,
+                provider: nil
+              },
+              isReturnLabel: false,
+              labelData: nil,
+              marketplaceNotified: true,
+              notifyErrorMessage: nil,
+              orderId: 4599538,
+              orderKey: "1234",
+              orderNumber: "1234",
+              packageCode: "package",
+              serviceCode: "usps_first_class_mail",
+              shipDate: "2019-09-30",
+              shipTo: {
+                addressVerified: nil,
+                city: "PENNSVILLE",
+                company: "",
+                country: "US",
+                name: "Jeffrey Yucis",
+                phone: "3027507743",
+                postalCode: "08070-2726",
+                residential: nil,
+                state: "NJ",
+                street1: "29 FORT MOTT RD APT 2",
+                street2: "",
+                street3: nil
+              },
+              shipmentCost: 2.66,
+              shipmentId: 1384210,
+              shipmentItems: [
+                {
+                  adjustment: false,
+                  createDate: "2019-09-27T13:18:49.153",
+                  fulfillmentSku: nil,
+                  imageUrl: "/product_images/gorgeous-wool-wallet/5d89163b987b4700257835a5/detail.jpg?c=1569265211",
+                  lineItemKey: "5d8e6e75987b4701f4bc308f",
+                  modifyDate: "2019-09-27T13:18:49.153",
+                  name: "Gorgeous Wool Wallet",
+                  options: [
+                    {
+                      name: "Size",
+                      value: "Medium"
+                    },
+                    {
+                      name: "Color",
+                      value: "White"
+                    }
+                  ],
+                  orderItemId: 7169563,
+                  productId: 2022076,
+                  quantity: 1,
+                  shippingAmount: nil,
+                  sku: "534286467-4",
+                  taxAmount: 0.0,
+                  unitPrice: 48.45,
+                  upc: nil,
+                  warehouseLocation: nil,
+                  weight: nil
+                },
+                {
+                  adjustment: false,
+                  createDate: "2019-09-27T13:18:49.153",
+                  fulfillmentSku: nil,
+                  imageUrl: "/product_images/gorgeous-linen-wallet/5d891632987b47002578349b/detail.jpg?c=1569265202",
+                  lineItemKey: "5d8e6e80987b4701f4bc3111",
+                  modifyDate: "2019-09-27T13:18:49.153",
+                  name: "Gorgeous Linen Wallet",
+                  options: [
+                    {
+                      name: "Size",
+                      value: "Medium"
+                    },
+                    {
+                      name: "Color",
+                      value: "Cyan"
+                    }
+                  ],
+                  orderItemId: 7169562,
+                  productId: 2022077,
+                  quantity: 2,
+                  shippingAmount: nil,
+                  sku: "680422763-8",
+                  taxAmount: 0.0,
+                  unitPrice: 45.2,
+                  upc: nil,
+                  warehouseLocation: nil,
+                  weight: nil
+                }
+              ],
+              trackingNumber: "9400111699000508143346",
+              userId: "a1f5b238-01d3-4a59-bd9b-010cd67d0e34",
+              voidDate: nil,
+              voided: false,
+              warehouseId: 113059,
+              weight: {
+                weightUnits: 1,
+                units: "ounces",
+                value: 3.0
+              }
+            }
+          ],
+          total: 1
+        }
+      end
+
+      def hold_body
+        {
+          success: true,
+          message: "hold data set"
+        }
+      end
+    end
+  end
+end

data/lib/workarea/ship_station/engine.rb

@@ -0,0 +1,10 @@
+require 'workarea/ship_station'
+
+module Workarea
+  module ShipStation
+    class Engine < ::Rails::Engine
+      include Workarea::Plugin
+      isolate_namespace Workarea::ShipStation
+    end
+  end
+end

data/lib/workarea/ship_station/gateway.rb

@@ -0,0 +1,92 @@
+module Workarea
+  module ShipStation
+    class Gateway
+      attr_reader :options
+
+      def initialize(options = {})
+        requires!(options, :api_secret, :api_key)
+        @options = options
+      end
+
+      def create_order(order)
+        response = connection.post do |req|
+          req.url "orders/createorder"
+          req.body = order.to_json
+        end
+        ShipStation::Response.new(response)
+      end
+
+      def hold_order(attrs = {})
+        response = connection.post do |req|
+          req.url "orders/holduntil"
+          req.body = attrs.to_json
+        end
+        ShipStation::Response.new(response)
+      end
+
+      def clear_hold_order(attrs = {})
+        response = connection.post do |req|
+          req.url "orders/restorefromhold"
+          req.body = attrs.to_json
+        end
+        ShipStation::Response.new(response)
+      end
+
+      def get_shipping(attrs = {})
+        response = connection.get do |req|
+          req.url "shipments"
+          req.params = attrs
+        end
+
+        ShipStation::Response.new(response)
+      end
+
+      private
+
+        def connection
+          headers = {
+            "Content-Type"  => "application/json",
+            "Accept"        => "application/json",
+          }
+
+          request_timeouts = {
+            timeout: Workarea.config.ship_station[:api_timeout],
+            open_timeout: Workarea.config.ship_station[:open_timeout]
+          }
+
+          conn = Faraday.new(url: rest_endpoint, headers: headers, request: request_timeouts)
+          conn.basic_auth(api_key, api_secret)
+          conn
+        end
+
+        def api_key
+          options[:api_key]
+        end
+
+        def api_secret
+          options[:api_secret]
+        end
+
+        def test?
+          (options.has_key?(:test) ? options[:test] : true)
+        end
+
+        def rest_endpoint
+          options[:rest_endpoint].presence || "https://ssapi.shipstation.com"
+        end
+
+        def requires!(hash, *params)
+          params.each do |param|
+            if param.is_a?(Array)
+              raise ArgumentError.new("Missing required parameter: #{param.first}") unless hash.has_key?(param.first)
+
+              valid_options = param[1..-1]
+              raise ArgumentError.new("Parameter: #{param.first} must be one of #{valid_options.to_sentence(words_connector: 'or')}") unless valid_options.include?(hash[param.first])
+            else
+              raise ArgumentError.new("Missing required parameter: #{param}") unless hash.has_key?(param)
+            end
+          end
+        end
+    end
+  end
+end