solidus_easypost 1.0.3 → 3.0.0

data/app/models/solidus_easypost/parcel_dimension.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class ParcelDimension
+    def initialize(**params)
+      raise ArgumentError, 'The weight param is mandatory!' unless valid_value?(value: params[:weight])
+
+      @weight = params[:weight]
+      @width = params[:width]
+      @height = params[:height]
+      @depth = params[:depth]
+    end
+
+    def to_h
+      hash = {
+        weight: weight
+      }
+
+      hash[:width] = width if valid_value?(value: width)
+      hash[:height] = height if valid_value?(value: height)
+      hash[:length] = depth if valid_value?(value: depth)
+
+      hash
+    end
+
+    private
+
+    def valid_value?(value:)
+      value.present? && !value.zero?
+    end
+
+    attr_reader :width, :height, :depth, :weight
+  end
+end

data/app/models/solidus_easypost/return_authorization.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module SolidusEasypost
+  class ReturnAuthorization
+    extend Forwardable
+
+    attr_reader :return_authorization
+
+    def_delegators :@return_authorization, :stock_location, :order, :inventory_units
+
+    def initialize(return_authorization)
+      @return_authorization = return_authorization
+    end
+
+    def easypost_shipment
+      @easypost_shipment ||= ShipmentBuilder.from_return_authorization(self)
+    end
+
+    def return_label(rate)
+      easypost_shipment.buy(rate) unless easypost_shipment.postage_label
+
+      easypost_shipment.postage_label
+    end
+  end
+end

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/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "solidus_easypost"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+$LOAD_PATH.unshift(*Dir["#{__dir__}/../app/*"])
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+if %w[g generate].include? ARGV.first
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/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/solidus_easypost/engine', __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/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/sandbox

@@ -0,0 +1,86 @@
+#!/usr/bin/env bash
+
+set -e
+
+case "$DB" in
+postgres|postgresql)
+  RAILSDB="postgresql"
+  ;;
+mysql)
+  RAILSDB="mysql"
+  ;;
+sqlite|'')
+  RAILSDB="sqlite3"
+  ;;
+*)
+  echo "Invalid DB specified: $DB"
+  exit 1
+  ;;
+esac
+
+if [ ! -z $SOLIDUS_BRANCH ]
+then
+  BRANCH=$SOLIDUS_BRANCH
+else
+  BRANCH="master"
+fi
+
+extension_name="solidus_easypost"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox --database="$RAILSDB" \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  --skip-javascript
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
+gem 'solidus_auth_devise', '>= 2.1.0'
+gem 'rails-i18n'
+gem 'solidus_i18n'
+
+gem '$extension_name', path: '..'
+
+group :test, :development do
+  platforms :mri do
+    gem 'pry-byebug'
+  end
+end
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+
+unbundled bundle exec rake db:drop db:create
+
+unbundled bundle exec rails generate spree:install \
+  --auto-accept \
+  --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!"
+echo "🚀 Using $RAILSDB and Solidus $BRANCH"
+echo "🚀 Use 'export DB=[postgres|mysql|sqlite]' to control the DB adapter"
+echo "🚀 Use 'export SOLIDUS_BRANCH=<BRANCH-NAME>' to control the Solidus version"
+echo "🚀 This app is intended for test purposes."

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+bundle update
+bin/rake clobber

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

@@ -0,0 +1,8 @@
+en:
+  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

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

data/db/migrate/20140515024440_add_easy_post_fields_to_shipping_rate.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddEasyPostFieldsToShippingRate < SolidusSupport::Migration[4.2]
+  def change
+    add_column :spree_shipping_rates, :name, :string
+    add_column :spree_shipping_rates, :easy_post_shipment_id, :string
+    add_column :spree_shipping_rates, :easy_post_rate_id, :string
+  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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+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]'))
+        if run_migrations
+          run 'bin/rails db:migrate'
+        else
+          puts 'Skipping bin/rails db:migrate, don\'t forget to run it!' # rubocop:disable Rails/Output
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SolidusEasypost
+  class Configuration
+    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
+      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/engine.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+require 'solidus_easypost'
+
+module SolidusEasypost
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::Spree
+
+    engine_name 'solidus_easypost'
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    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