solidus_shipstation 1.0.0

data/lib/solidus_shipstation/api/threshold_verifier.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolidusShipstation
+  module Api
+    class ThresholdVerifier
+      class << self
+        def call(shipment)
+          return false unless shipment.order.completed?
+
+          !!(shipment_requires_creation?(shipment) || shipment_requires_update?(shipment))
+        end
+
+        private
+
+        def shipment_requires_creation?(shipment)
+          shipment.shipstation_synced_at.nil? &&
+            Time.zone.now - shipment.order.updated_at < SolidusShipstation.config.api_sync_threshold
+        end
+
+        def shipment_requires_update?(shipment)
+          shipment.shipstation_synced_at &&
+            shipment.shipstation_synced_at < shipment.order.updated_at &&
+            Time.zone.now - shipment.order.updated_at < SolidusShipstation.config.api_sync_threshold
+        end
+      end
+    end
+  end
+end

data/lib/solidus_shipstation/configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SolidusShipstation
+  class Configuration
+    attr_accessor(
+      :username,
+      :password,
+      :weight_units,
+      :ssl_encrypted,
+      :capture_at_notification,
+      :export_canceled_shipments,
+      :api_batch_size,
+      :api_sync_threshold,
+      :api_shipment_serializer,
+      :api_key,
+      :api_secret,
+      :api_shipment_matcher,
+      :error_handler,
+    )
+
+    def initialize
+      @api_batch_size = 100
+      @api_sync_threshold = 7.days
+      @error_handler = ->(_error, _extra = {}) {
+        Rails.logger.error "#{error.inspect} (#{extra.inspect})"
+      }
+      @api_shipment_matcher = proc do |shipstation_order, shipments|
+        shipments.find { |shipment| shipment.number == shipstation_order['orderNumber'] }
+      end
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias config configuration
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/solidus_shipstation/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'solidus_core'
+require 'solidus_support'
+
+module SolidusShipstation
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_shipstation'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/solidus_shipstation/errors.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SolidusShipstation
+  class Error < StandardError; end
+
+  class OrderNotPaidError < Error
+    def initialize(order, *args)
+      super("Order #{order.number} is not paid and capture_at_notification is false", *args)
+    end
+  end
+
+  class ShipmentNotFoundError < Error
+    def initialize(shipment_number, *args)
+      super("Could not find shipment with number #{shipment_number}", *args)
+    end
+  end
+
+  class PaymentError < Error
+    def initialize(payment, *args)
+      super("Could not process payment #{payment.id}", *args)
+    end
+  end
+end

data/lib/solidus_shipstation/shipment_notice.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module SolidusShipstation
+  class ShipmentNotice
+    attr_reader :shipment_number, :shipment_tracking
+
+    class << self
+      def from_payload(params)
+        new(
+          shipment_number: params[:order_number],
+          shipment_tracking: params[:tracking_number],
+        )
+      end
+    end
+
+    def initialize(shipment_number:, shipment_tracking:)
+      @shipment_number = shipment_number
+      @shipment_tracking = shipment_tracking
+    end
+
+    def apply
+      unless shipment
+        raise ShipmentNotFoundError, shipment
+      end
+
+      process_payment
+      ship_shipment
+
+      shipment
+    end
+
+    private
+
+    def shipment
+      @shipment ||= ::Spree::Shipment.find_by(number: shipment_number)
+    end
+
+    def process_payment
+      return if shipment.order.paid?
+
+      unless SolidusShipstation.configuration.capture_at_notification
+        raise OrderNotPaidError, shipment.order
+      end
+
+      shipment.order.payments.pending.each do |payment|
+        payment.capture!
+      rescue ::Spree::Core::GatewayError
+        raise PaymentError, payment
+      end
+    end
+
+    def ship_shipment
+      shipment.update!(tracking: shipment_tracking)
+      shipment.ship! if shipment.can_ship?
+      shipment.order.recalculate
+    end
+  end
+end

data/lib/solidus_shipstation/testing_support/factories.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+end

data/lib/solidus_shipstation/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SolidusShipstation
+  VERSION = '1.0.0'
+end

data/solidus_shipstation.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/solidus_shipstation/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'solidus_shipstation'
+  spec.version = SolidusShipstation::VERSION
+  spec.authors = ['Stephen Puiszis']
+  spec.email = 'steve@tablexi.com'
+
+  spec.summary = 'Solidus/ShipStation Integration'
+  spec.description = 'Integrates ShipStation API with Solidus. Supports exporting shipments and importing tracking numbers'
+  spec.homepage = 'https://github.com/solidusio-contrib/solidus_shipstation'
+  spec.license = 'BSD-3-Clause'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_shipstation'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_shipstation/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'httparty', '~> 0.18'
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 4']
+  spec.add_dependency 'solidus_support', '~> 0.5'
+
+  spec.add_development_dependency 'rails-controller-testing'
+  spec.add_development_dependency 'rspec-xsd'
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.5'
+  spec.add_development_dependency 'webmock'
+end

data/spec/controllers/spree/shipstation_controller_spec.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+RSpec.describe Spree::ShipstationController do
+  render_views
+
+  describe '#export' do
+    context 'when the authentication is invalid' do
+      it 'returns an error error' do
+        get :export, params: { format: 'xml' }
+
+        expect(response.status).to eq(401)
+      end
+    end
+
+    context 'when the authentication is valid' do
+      it 'responds with 200 OK' do
+        stub_shipstation_auth
+        create(:order_ready_to_ship)
+
+        get :export,
+          params: {
+            start_date: 1.day.ago.strftime('%m/%d/%Y %H:%M'),
+            end_date: 1.day.from_now.strftime('%m/%d/%Y %H:%M'),
+            format: 'xml'
+          }
+
+        expect(response.status).to eq(200)
+      end
+
+      it 'generates ShipStation-compliant XML' do
+        stub_shipstation_auth
+        create(:order_ready_to_ship)
+
+        get :export, params: {
+          start_date: 1.day.ago.strftime('%m/%d/%Y %H:%M'),
+          end_date: 1.day.from_now.strftime('%m/%d/%Y %H:%M'),
+          format: 'xml'
+        }
+
+        expect(response.body).to pass_validation('spec/fixtures/shipstation_xml_schema.xsd')
+      end
+    end
+  end
+
+  describe '#shipnotify' do
+    context 'when the authentication is valid' do
+      context 'when the shipment can be found' do
+        it 'responds with 200 OK' do
+          stub_shipstation_auth
+          shipment = create(:order_ready_to_ship).shipments.first
+
+          post :shipnotify, params: {
+            order_number: shipment.number,
+            tracking_number: '123456',
+            format: 'xml',
+          }
+          shipment.reload
+
+          expect(response.status).to eq(200)
+        end
+
+        it 'updates the shipment' do
+          stub_shipstation_auth
+          shipment = create(:order_ready_to_ship).shipments.first
+
+          post :shipnotify, params: {
+            order_number: shipment.number,
+            tracking_number: '123456',
+            format: 'xml',
+          }
+          shipment.reload
+
+          expect(shipment).to have_attributes(
+            tracking: '123456',
+            state: 'shipped',
+            shipped_at: an_instance_of(ActiveSupport::TimeWithZone),
+          )
+        end
+      end
+
+      context 'when the shipment cannot be found' do
+        it 'responds with 400 Bad Request' do
+          stub_shipstation_auth
+          shipment = create(:order_ready_to_ship).shipments.first
+
+          post :shipnotify, params: {
+            order_number: 'ABC123',
+            tracking_number: '123456',
+            format: 'xml',
+          }
+          shipment.reload
+
+          expect(response.status).to eq(400)
+        end
+      end
+    end
+  end
+
+  def stub_shipstation_auth(username = 'mario', password = 'lemieux')
+    stub_configuration(username: username, password: password)
+    request.headers['Authorization'] = ActionController::HttpAuthentication::Basic.encode_credentials(username, password)
+  end
+end

data/spec/fixtures/shipstation_xml_schema.xsd

@@ -0,0 +1,171 @@
+<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
+  <xs:element name="Orders">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="Order" maxOccurs="unbounded" minOccurs="0">
+          <xs:complexType>
+            <xs:all>
+              <xs:element type="String50" name="OrderID" minOccurs="0"/>
+              <xs:element type="String50" name="OrderNumber"/>
+              <xs:element type="DateTime" name="OrderDate"/>
+              <xs:element type="String50" name="OrderStatus"/>
+              <xs:element type="DateTime" name="LastModified"/>
+              <xs:element type="String100" name="ShippingMethod" minOccurs="0"/>
+              <xs:element type="String50" name="PaymentMethod" minOccurs="0"/>
+              <xs:element type="xs:float" name="OrderTotal"/>
+              <xs:element type="xs:float" name="TaxAmount" minOccurs="0"/>
+              <xs:element type="xs:float" name="ShippingAmount" minOccurs="0"/>
+              <xs:element type="String1000" name="CustomerNotes" minOccurs="0"/>
+              <xs:element type="String1000" name="InternalNotes" minOccurs="0"/>
+              <xs:element type="xs:boolean" name="Gift" minOccurs="0"/>
+              <xs:element type="String1000" name="GiftMessage" minOccurs="0"/>
+              <xs:element type="String100" name="CustomField1" minOccurs="0"/>
+              <xs:element type="String100" name="CustomField2" minOccurs="0"/>
+              <xs:element type="String100" name="CustomField3" minOccurs="0"/>
+              <xs:element type="String100" name="RequestedWarehouse" minOccurs="0"/>
+              <xs:element type="String50" name="Source" minOccurs="0" />
+              <xs:element name="Customer">
+                <xs:complexType>
+                  <xs:all>
+                    <xs:element type="String100" name="CustomerCode"/>
+                    <xs:element name="BillTo">
+                      <xs:complexType>
+                        <xs:all>
+                           <xs:element type="String100" name="Name"/>
+                           <xs:element type="String100" name="Company" minOccurs="0"/>
+                           <xs:element type="String50" name="Phone" minOccurs="0"/>
+                           <xs:element type="Email" name="Email" minOccurs="0"/>
+                            <xs:element type="String200" name="Address1" minOccurs="0"/>
+                           <xs:element type="String200" name="Address2" minOccurs="0"/>
+                           <xs:element type="String100" name="City" minOccurs="0"/>
+                           <xs:element type="String100" name="State" minOccurs="0"/>
+                           <xs:element type="String50" name="PostalCode" minOccurs="0"/>
+<xs:element type="StringExactly2" name="Country" minOccurs="0"/>
+                        </xs:all>
+                      </xs:complexType>
+                    </xs:element>
+                    <xs:element name="ShipTo">
+                      <xs:complexType>
+                        <xs:all>
+                          <xs:element type="String100" name="Name"/>
+                          <xs:element type="String100" name="Company" minOccurs="0"/>
+                          <xs:element type="String200" name="Address1"/>
+                          <xs:element type="String200" name="Address2" minOccurs="0"/>
+                          <xs:element type="String100" name="City"/>
+                          <xs:element type="String100" name="State" minOccurs="0"/>
+                          <xs:element type="String50" name="PostalCode" minOccurs="1"/>
+                          <xs:element type="StringExactly2" name="Country"/>
+                          <xs:element type="String50" name="Phone" minOccurs="0"/>
+                        </xs:all>
+                      </xs:complexType>
+                    </xs:element>
+                  </xs:all>
+                </xs:complexType>
+              </xs:element>
+              <xs:element name="Items">
+                <xs:complexType>
+                  <xs:sequence>
+                    <xs:element name="Item" maxOccurs="unbounded" minOccurs="0">
+                      <xs:complexType>
+                        <xs:all>
+                          <xs:element type="String50" name="LineItemID" minOccurs="0"/>
+                          <xs:element type="String100" name="SKU"/>
+                          <xs:element type="String200" name="Name"/>
+                          <xs:element type="xs:boolean" name="Adjustment" minOccurs="0"/>
+                          <xs:element type="xs:anyURI" name="ImageUrl" minOccurs="0"/>
+                          <xs:element type="xs:float" name="Weight" minOccurs="0"/>
+                          <xs:element name="WeightUnits" minOccurs="0">
+                            <xs:simpleType>
+                              <xs:restriction base="xs:string">
+                                <xs:pattern value="|pound|pounds|lb|lbs|gram|grams|gm|oz|ounces|Pound|Pounds|Lb|Lbs|Gram|Grams|Gm|Oz|Ounces|POUND|POUNDS|LB|LBS|GRAM|GRAMS|GM|OZ|OUNCES"/>
+                              </xs:restriction>
+                            </xs:simpleType>
+                          </xs:element>
+                          <xs:element name="Dimensions" minOccurs="0">
+                            <xs:complexType>
+                              <xs:all>
+                                <xs:element name="DimensionUnits" minOccurs="0">
+                                  <xs:simpleType>
+                                    <xs:restriction base="xs:string">
+                                      <xs:pattern value="|inch|inches|in|centimeter|centimeters|cm|INCH|INCHES|IN|CENTIMETER|CENTIMETERS|CM"/>
+                                    </xs:restriction>
+                                  </xs:simpleType>
+                                </xs:element>
+                                <xs:element type="xs:float" name="Length"/>
+                                <xs:element type="xs:float" name="Width"/>
+                                <xs:element type="xs:float" name="Height"/>
+                              </xs:all>
+                            </xs:complexType>
+                          </xs:element>
+                          <xs:element type="xs:int" name="Quantity"/>
+                          <xs:element type="xs:float" name="UnitPrice"/>
+                          <xs:element type="String100" name="Location" minOccurs="0"/>
+                          <xs:element name="Options" minOccurs="0">
+                            <xs:complexType>
+                              <xs:sequence>
+                                <xs:element name="Option" maxOccurs="100" minOccurs="0">
+                                  <xs:complexType>
+                                    <xs:all>
+                                      <xs:element type="String100" name="Name"/>
+                                      <xs:element type="String100" name="Value"/>
+                                      <xs:element type="xs:float" name="Weight" minOccurs="0"/>
+                                    </xs:all>
+                                  </xs:complexType>
+                                </xs:element>
+                              </xs:sequence>
+                            </xs:complexType>
+                          </xs:element>
+                        </xs:all>
+                      </xs:complexType>
+                    </xs:element>
+                  </xs:sequence>
+                </xs:complexType>
+              </xs:element>
+            </xs:all>
+          </xs:complexType>
+        </xs:element>
+      </xs:sequence>
+      <xs:attribute type="xs:short" name="pages"/>
+    </xs:complexType>
+  </xs:element>
+  <xs:simpleType name="DateTime">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="[0-9][0-9]?/[0-9][0-9]?/[0-9][0-9][0-9]?[0-9]? [0-9][0-9]?:[0-9][0-9]?:?[0-9]?[0-9]?. ?[aApP]?[mM]?"/>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="Email">
+    <xs:restriction base="xs:string">
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="StringExactly2">
+    <xs:restriction base="xs:string">
+      <xs:minLength value="2"/>
+      <xs:maxLength value="2"/>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="String30">
+    <xs:restriction base="xs:string">
+      <xs:maxLength value="30"/>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="String50">
+    <xs:restriction base="xs:string">
+      <xs:maxLength value="50"/>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="String100">
+    <xs:restriction base="xs:string">
+      <xs:maxLength value="100"/>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="String200">
+    <xs:restriction base="xs:string">
+      <xs:maxLength value="200"/>
+    </xs:restriction>
+  </xs:simpleType>
+  <xs:simpleType name="String1000">
+    <xs:restriction base="xs:string">
+      <xs:maxLength value="1000"/>
+    </xs:restriction>
+  </xs:simpleType>
+</xs:schema>