solidus_easypost 2.0.0 → 3.0.0

data/app/overrides/spree/admin/orders/_shipment/add_postage_label.html.erb.deface

@@ -0,0 +1,10 @@
+<!-- insert_bottom '[data-hook="stock-contents"] tbody' -->
+
+<% if shipment.selected_easy_post_rate_id && shipment.shipped? %>
+  <tr class="postage-label">
+    <td colspan="5">
+      <strong><%= t('spree.postage_label') %>:</strong>
+      <%= link_to_with_icon('external-link', t('spree.open_postage_label'), admin_shipment_postage_label_path(shipment)) %>
+    </td>
+  </tr>
+<% end %>

data/bin/rails

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 if %w[g generate].include? ARGV.first
   exec "#{__dir__}/rails-engine", *ARGV

data/bin/rails-engine

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
-
 # This command will automatically be run when you run "rails" with Rails gems
 # installed from the root of your application.
 

data/bin/rails-sandbox

@@ -1,12 +1,11 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 app_root = 'sandbox'
 
 unless File.exist? "#{app_root}/bin/rails"
   warn 'Creating the sandbox app...'
   Dir.chdir "#{__dir__}/.." do
-    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+    system "#{__dir__}/sandbox" or begin
       warn 'Automatic creation of the sandbox app failed'
       exit 1
     end

data/bin/sandbox

@@ -72,9 +72,11 @@ unbundled bundle exec rails generate spree:install \
   --user_class=Spree::User \
   --enforce_available_locales=true \
   --with-authentication=false \
+  --payment-method=none \
   $@
 
 unbundled bundle exec rails generate solidus:auth:install
+unbundled bundle exec rails generate ${extension_name}:install
 
 echo
 echo "🚀 Sandbox app successfully created for $extension_name!"

data/config/initializers/webhooks.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+if defined?(SolidusWebhooks)
+  SolidusWebhooks.config.register_webhook_handler :easypost_trackers, ->(payload) do
+    SolidusEasypost.configuration.webhook_handler_class.call(payload)
+  end
+end

data/config/locales/en.yml

@@ -1,5 +1,8 @@
-# Sample localization file for English. Add more files in this directory for other locales.
-# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
-
 en:
-  hello: Hello world
+  spree:
+    postage_label: 'Postage Label'
+    open_postage_label: 'Open'
+    admin:
+      postage_labels:
+        show:
+          no_postage_label: 'No postage label available for shipment %{shipment_number}.'

data/config/routes.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
 Spree::Core::Engine.routes.draw do
-  # Add your extension routes here
+  namespace :admin do
+    resources :shipments, only: [] do
+      resource :postage_label, only: :show
+    end
+  end
 end

data/db/migrate/20201025110912_add_tracker_id_to_cartons.rb

@@ -0,0 +1,6 @@
+class AddTrackerIdToCartons < ActiveRecord::Migration[5.2]
+  def change
+    add_column :spree_cartons, :easy_post_tracker_id, :string
+    add_index :spree_cartons, :easy_post_tracker_id
+  end
+end

data/lib/generators/solidus_easypost/install/install_generator.rb

@@ -3,14 +3,20 @@
 module SolidusEasypost
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
       class_option :auto_run_migrations, type: :boolean, default: false
 
+      def copy_initializer
+        template 'initializer.rb', 'config/initializers/solidus_easypost.rb'
+      end
+
       def add_migrations
         run 'bin/rails railties:install:migrations FROM=solidus_easypost'
       end
 
       def run_migrations
-        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]')) # rubocop:disable Metrics/LineLength
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask('Would you like to run the migrations now? [Y/n]'))
         if run_migrations
           run 'bin/rails db:migrate'
         else

data/lib/generators/solidus_easypost/install/templates/initializer.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+EasyPost.api_key = 'YOUR_API_KEY_HERE'
+
+SolidusEasypost.configure do |config|
+  # Purchase labels from EasyPost when shipping shipments in Solidus?
+  # config.purchase_labels = true
+
+  # Create a tracker in EasyPost and receive webhooks for all cartons?
+  # config.track_all_cartons = false
+
+  # A class that responds to `#compute`, accepting an `EasyPost::Rate`
+  # instance and returning the cost for that rate.
+  # config.shipping_rate_calculator_class = 'SolidusEasypost::ShippingRateCalculator'
+
+  # A class that responds to `#shipping_method_for`, accepting an
+  # `EasyPost::Rate` instance and returning the shipping method for
+  # that rate.
+  # config.shipping_method_selector_class = 'SolidusEasypost::ShippingMethodSelector'
+
+  # A class that responds to '#compute', accepting a `SolidusEasypost::ReturnAuthorization`
+  # instance or a `Spree::Stock::Package` instance and returing the `SolidusEasypost::ParcelDimension` object.
+  # The `SolidusEasypost::Calculator::BaseDimensionCalculator` class can be extended to have a common
+  # functionality.
+  # config.parcel_dimension_calculator_class = 'SolidusEasypost::Calculator::WeightDimensionCalculator'
+end

data/lib/solidus_easypost/address_builder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class AddressBuilder
+    class << self
+      def from_address(address)
+        attributes = {
+          street1: address.address1,
+          street2: address.address2,
+          city: address.city,
+          zip: address.zipcode,
+          phone: address.phone
+        }
+
+        attributes[:company] = address.company if address.respond_to?(:company)
+        attributes[:name] = if address.respond_to?(:name)
+                              address.name
+                            elsif respond_to?(:full_name)
+                              address.full_name
+                            end
+        attributes[:state] = address.state ? address.state.abbr : address.state_name
+        attributes[:country] = address.country&.iso
+
+        ::EasyPost::Address.create attributes
+      end
+
+      def from_stock_location(stock_location)
+        attributes = {
+          street1: stock_location.address1,
+          street2: stock_location.address2,
+          city: stock_location.city,
+          zip: stock_location.zipcode,
+          phone: stock_location.phone,
+          name: stock_location.name,
+          company: stock_location.name
+        }
+
+        attributes[:state] = stock_location.state ? stock_location.state.abbr : stock_location.state_name
+        attributes[:country] = stock_location.country&.iso
+
+        ::EasyPost::Address.create attributes
+      end
+    end
+  end
+end

data/lib/solidus_easypost/calculator/base_dimension_calculator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  module Calculator
+    class BaseDimensionCalculator
+      def compute(resource)
+        case resource
+        when ::SolidusEasypost::ReturnAuthorization
+          compute_for_return_authorization(resource)
+        when ::Spree::Stock::Package
+          compute_for_package(resource)
+        else
+          raise SolidusEasypost::Errors::UnknownPartialResourceError
+        end
+      end
+
+      protected
+
+      def compute_for_return_authorization(return_authorization)
+        raise NotImplementedError
+      end
+
+      def compute_for_package(package)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/solidus_easypost/calculator/weight_dimension_calculator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  module Calculator
+    class WeightDimensionCalculator < BaseDimensionCalculator
+      protected
+
+      def compute_for_return_authorization(return_authorization)
+        total_weight = return_authorization.inventory_units.joins(:variant).sum(:weight)
+        SolidusEasypost::ParcelDimension.new(weight: total_weight)
+      end
+
+      def compute_for_package(package)
+        total_weight = package.contents.sum do |item|
+          item.quantity * item.variant.weight
+        end
+
+        SolidusEasypost::ParcelDimension.new(weight: total_weight)
+      end
+    end
+  end
+end

data/lib/solidus_easypost/configuration.rb

@@ -2,10 +2,33 @@
 
 module SolidusEasypost
   class Configuration
-    attr_reader :purchase_labels
+    attr_accessor :purchase_labels, :track_all_cartons
+    attr_writer :shipping_rate_calculator_class, :shipping_method_selector_class, :parcel_dimension_calculator_class,
+      :webhook_handler_class
 
     def initialize
-      @purchase_labels = true
+      self.purchase_labels = true
+      self.track_all_cartons = false
+    end
+
+    def shipping_rate_calculator_class
+      @shipping_rate_calculator_class ||= 'SolidusEasypost::ShippingRateCalculator'
+      @shipping_rate_calculator_class.constantize
+    end
+
+    def shipping_method_selector_class
+      @shipping_method_selector_class ||= 'SolidusEasypost::ShippingMethodSelector'
+      @shipping_method_selector_class.constantize
+    end
+
+    def parcel_dimension_calculator_class
+      @parcel_dimension_calculator_class ||= 'SolidusEasypost::Calculator::WeightDimensionCalculator'
+      @parcel_dimension_calculator_class.constantize
+    end
+
+    def webhook_handler_class
+      @webhook_handler_class ||= 'SolidusEasypost::TrackerWebhookHandler'
+      @webhook_handler_class.constantize
     end
   end
 end

data/lib/solidus_easypost/errors/unknown_partial_resource_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  module Errors
+    class UnknownPartialResourceError < StandardError
+      def message
+        'The passed resource must be a Spree::ReturnAuthorization or a Spree::Stock::Package!'
+      end
+    end
+  end
+end

data/lib/solidus_easypost/estimator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class Estimator
+    def shipping_rates(package, _frontend_only = true)
+      easypost_rates = ShipmentBuilder.from_package(package).rates.sort_by(&:rate)
+
+      shipping_rates = easypost_rates.map { |rate| build_shipping_rate(rate) }.compact
+      shipping_rates.min_by(&:cost)&.selected = true
+
+      shipping_rates
+    end
+
+    private
+
+    def build_shipping_rate(rate)
+      shipping_method = shipping_method_selector.shipping_method_for(rate)
+      return unless shipping_method.available_to_users?
+
+      ::Spree::ShippingRate.new(
+        name: "#{rate.carrier} #{rate.service}",
+        cost: shipping_rate_calculator.compute(rate),
+        easy_post_shipment_id: rate.shipment_id,
+        easy_post_rate_id: rate.id,
+        shipping_method: shipping_method,
+      )
+    end
+
+    def shipping_rate_calculator
+      @shipping_rate_calculator ||= SolidusEasypost.configuration.shipping_rate_calculator_class.new
+    end
+
+    def shipping_method_selector
+      @shipping_method_selector ||= SolidusEasypost.configuration.shipping_method_selector_class.new
+    end
+  end
+end

data/lib/solidus_easypost/parcel_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class ParcelBuilder
+    class << self
+      def from_package(package)
+        parcel_dimension = SolidusEasypost
+                           .configuration
+                           .parcel_dimension_calculator_class
+                           .new
+                           .compute(package)
+
+        ::EasyPost::Parcel.create(parcel_dimension.to_h)
+      end
+
+      def from_return_authorization(return_authorization)
+        parcel_dimension = SolidusEasypost
+                           .configuration
+                           .parcel_dimension_calculator_class
+                           .new
+                           .compute(return_authorization)
+
+        ::EasyPost::Parcel.create(parcel_dimension.to_h)
+      end
+    end
+  end
+end

data/lib/solidus_easypost/shipment_builder.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class ShipmentBuilder
+    class << self
+      def from_package(package)
+        ::EasyPost::Shipment.create(
+          to_address: AddressBuilder.from_address(package.order.ship_address),
+          from_address: AddressBuilder.from_stock_location(package.stock_location),
+          parcel: ParcelBuilder.from_package(package),
+        )
+      end
+
+      def from_shipment(shipment)
+        ::EasyPost::Shipment.create(
+          to_address: AddressBuilder.from_address(shipment.order.ship_address),
+          from_address: AddressBuilder.from_stock_location(shipment.stock_location),
+          parcel: ParcelBuilder.from_package(shipment.to_package),
+        )
+      end
+
+      def from_return_authorization(return_authorization)
+        ::EasyPost::Shipment.create(
+          from_address: AddressBuilder.from_stock_location(return_authorization.stock_location),
+          to_address: AddressBuilder.from_address(return_authorization.order.ship_address),
+          parcel: ParcelBuilder.from_return_authorization(return_authorization),
+          is_return: true
+        )
+      end
+    end
+  end
+end

data/lib/solidus_easypost/shipping_method_selector.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class ShippingMethodSelector
+    def shipping_method_for(rate)
+      ::Spree::ShippingMethod.find_or_create_by(
+        carrier: rate.carrier,
+        service_level: rate.service,
+      ) do |shipping_method|
+        shipping_method.name = "#{rate.carrier} #{rate.service}"
+        shipping_method.calculator = ::Spree::Calculator::Shipping::FlatRate.create
+        shipping_method.shipping_categories = [::Spree::ShippingCategory.first]
+        shipping_method.available_to_users = false
+      end
+    end
+  end
+end

data/lib/solidus_easypost/shipping_rate_calculator.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class ShippingRateCalculator
+    def compute(rate)
+      rate.rate
+    end
+  end
+end

data/lib/solidus_easypost/testing_support/factories/address_factory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :address do
+    address1 { '215 N 7th Ave' }
+    city { 'Manville' }
+    association(:state, name: 'New Jersey', abbr: 'NJ')
+    zipcode { '08835' }
+  end
+end

data/lib/solidus_easypost/testing_support/factories/product_factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :base_product do
+    weight { 10.0 }
+  end
+end

data/lib/solidus_easypost/testing_support/factories/shipment_factory.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :shipment do
+    transient do
+      inventory_units { 1 }
+    end
+
+    after(:create) do |shipment, e|
+      create_list(:inventory_unit, e.inventory_units, shipment: shipment)
+    end
+
+    trait :with_easypost do
+      transient do
+        easypost_shipment_id { 'sh_test' }
+        easypost_rate_id { 'rt_test' }
+      end
+
+      after(:create) do |shipment, evaluator|
+        create(
+          :shipping_rate,
+          shipment: shipment,
+          selected: true,
+          easy_post_shipment_id: evaluator.easypost_shipment_id,
+          easy_post_rate_id: evaluator.easypost_rate_id,
+        )
+      end
+    end
+  end
+end

data/lib/solidus_easypost/testing_support/factories/shipping_method_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :shipping_method do
+    admin_name { 'Stuff' }
+    available_to_users { true }
+  end
+end

data/lib/solidus_easypost/testing_support/factories/stock_location_factory.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :stock_location do
+    address1 { '131 S 8th Ave' }
+    city { 'Manville' }
+    association(:state, name: 'New Jersey', abbr: 'NJ')
+    zipcode { '08835' }
+  end
+end

data/lib/solidus_easypost/testing_support/factories/variant_factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.modify do
+  factory :variant do
+    weight { 10.0 }
+  end
+end

data/lib/solidus_easypost/testing_support/factories.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir["#{__dir__}/factories/**/*.rb"].sort.each { |f| require f }

data/lib/solidus_easypost/tracker_webhook_handler.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class TrackerWebhookHandler
+    def self.call(payload)
+      return unless payload['description'] == 'tracker.updated'
+
+      carton = ::Spree::Carton.find_by(easy_post_tracker_id: payload['result']['id'])
+      return unless carton
+
+      ::Spree::Event.fire 'solidus_easypost.tracker.updated', carton: carton, payload: payload
+    end
+  end
+end

data/lib/solidus_easypost/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidusEasypost
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/lib/solidus_easypost.rb

@@ -2,11 +2,22 @@
 
 require 'solidus_core'
 require 'solidus_support'
+require 'deface'
 require 'easypost'
 
 require 'solidus_easypost/version'
 require 'solidus_easypost/engine'
 require 'solidus_easypost/configuration'
+require 'solidus_easypost/address_builder'
+require 'solidus_easypost/parcel_builder'
+require 'solidus_easypost/shipment_builder'
+require 'solidus_easypost/estimator'
+require 'solidus_easypost/shipping_rate_calculator'
+require 'solidus_easypost/shipping_method_selector'
+require 'solidus_easypost/calculator/base_dimension_calculator'
+require 'solidus_easypost/calculator/weight_dimension_calculator'
+require 'solidus_easypost/tracker_webhook_handler'
+require 'solidus_easypost/errors/unknown_partial_resource_error'
 
 module SolidusEasypost
   class << self

data/solidus_easypost.gemspec

@@ -8,15 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors = ['Brendan Deere']
   spec.email = 'brendan@stembolt.com'
 
-  spec.summary = 'Easy post integration for Solidus'
-  spec.description = 'Easy post integration for Solidus'
+  spec.summary = 'EasyPost integration for Solidus stores.'
   spec.homepage = 'https://github.com/solidusio-contrib/solidus_easypost'
   spec.license = 'BSD-3-Clause'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_easypost'
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+  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.
@@ -28,11 +27,15 @@ Gem::Specification.new do |spec|
   spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'deface'
   spec.add_dependency 'easypost'
-  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 3']
+  spec.add_dependency 'solidus_core', ['>= 2.0.0', '< 4']
   spec.add_dependency 'solidus_support', '~> 0.5'
 
-  spec.add_development_dependency 'solidus_dev_support'
+  spec.add_development_dependency 'solidus_dev_support', '~> 2.1'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'webmock'
+  spec.metadata = {
+    'rubygems_mfa_required' => 'true'
+  }
 end