solidus_ship_compliant 1.0.0

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,6 @@
+Spree::CheckoutController.class_eval do
+  rescue_from SolidusShipCompliant::Error do |exception|
+    flash[:error] = exception.message
+    redirect_to checkout_state_path(:address)
+  end
+end

data/app/models/spree/calculator/ship_compliant_calculator.rb

@@ -0,0 +1,83 @@
+require_dependency 'spree/calculator'
+
+module Spree
+  class Calculator::ShipCompliantCalculator < Calculator
+    CACHE_EXPIRATION_DURATION = 10.minutes
+
+    def self.description
+      Spree.t(:ship_compliant_tax)
+    end
+
+    def compute_order(order)
+      raise 'Spree::ShipCompliant is designed to calculate taxes at the shipment and line-item levels.'
+    end
+
+    def compute_line_item(item)
+      if rate.included_in_price
+        raise Spree.t(:ship_compliant_alert)
+      else
+        round_to_two_places(tax_for_item(item))
+      end
+    end
+
+    def compute_shipment(shipment)
+      if rate.included_in_price
+        raise Spree.t(:ship_compliant_alert)
+      else
+        0
+      end
+    end
+
+    def compute_shipping_rate(shipping_rate)
+      if rate.included_in_price
+        raise Spree.t(:ship_compliant_alert)
+      else
+        0
+      end
+    end
+
+    private
+
+    def tax_for_item(item)
+      order = item.order
+      item_address = order.tax_address || order.shipping_address
+
+      return 0 unless item_address.present? && calculable.zone.include?(item_address)
+
+      rails_cache_key = cache_key(order, item, item_address)
+
+      Rails.cache.fetch(rails_cache_key, time_to_idle: CACHE_EXPIRATION_DURATION) do
+        transaction = Bevv::ShipCompliant.new(order).transaction_from_order
+        tax_for_current_item = cache_response(transaction, order, item_address, item)
+        tax_for_current_item
+      end
+    end
+
+    def rate
+      calculable
+    end
+
+    def round_to_two_places(amount)
+      BigDecimal(amount.to_s).round(2, BigDecimal::ROUND_HALF_UP)
+    end
+
+    def cache_response(response, order, address, line_item = nil)
+      res = nil
+      cart_items = response.shipment_sales_tax_rates[0][:product_sales_tax_rates][:product_sales_tax_rate]
+
+      return 0 unless response || cart_items
+
+      cart_items.each do |item|
+        next unless item[:@product_key] == line_item.variant.product_key
+        res = item[:@sales_tax_due]
+        Rails.cache.write(cache_key(order, line_item, address), res, expires_in: CACHE_EXPIRATION_DURATION)
+      end
+
+      res
+    end
+
+    def cache_key(order, item, address)
+      ['Spree::LineItem', order.id, item.id, address.state.id, address.zipcode, item.amount, :amount_to_collect]
+    end
+  end
+end

data/app/models/spree/ship_compliant.rb

@@ -0,0 +1,96 @@
+module Spree
+  class ShipCompliant
+    extend ActiveModel::Naming
+    attr_reader :order, :reimbursement, :shipment, :rates
+
+    SHIPPING_SERVICE = 'UPS'
+
+    def initialize(order = nil)
+      @order = order
+      @rates = []
+    end
+
+    def transaction_from_order
+      stock_location = order.shipments.first.try(:stock_location) || Spree::StockLocation.active.where('city IS NOT NULL and state_id IS NOT NULL').first
+      raise Spree.t(:ensure_one_valid_stock_location) unless stock_location
+
+      payload = {
+                  address_option: {
+                    ignore_street_level_errors: true,
+                    reject_if_address_suggested: 'false'
+                  },
+                  include_sales_tax_rates: true,
+                  sales_order: {
+                    bill_to: address_from_spree_address(order.bill_address),
+                    customer_key: SolidusShipCompliant::Config.partner_key,
+                    sales_order_key: order.number,
+                    purchase_date: DateTime.now,
+                    order_type: 'Internet',
+                    shipments: {
+                      shipment: {
+                        shipment_status: 'SentToFulfillment',
+                        discounts: nil,
+                        fulfillment_house: 'InHouse',
+                        handling: 0,
+                        insured_amount: 0,
+                        license_relationship: 'Default',
+                        packages: nil,
+                        ship_date: DateTime.now,
+                        shipping_service: SHIPPING_SERVICE,
+                        shipment_items: shipment_items,
+                        ship_to: address_from_spree_address(order.ship_address)
+                      }
+                    }
+                  }
+                }
+
+      begin
+        initialize_client
+        transaction = ::ShipCompliant::CheckCompliance.of_sales_order(payload)
+      rescue ::ShipCompliant::CheckComplianceResult
+      end
+
+      transaction
+    end
+
+    # Note that this method can take either a Spree::StockLocation (which has address
+    # attributes directly on it) or a Spree::Address object
+    def address_from_spree_address(address)
+      ::ShipCompliant::Address.new(
+        first_name: address.first_name,
+        last_name:  address.last_name,
+        country:    address.country.iso,
+        city:       address.city,
+        state:      address.try(:state).try(:abbr),
+        street1:    address.address1,
+        street2:    address.address2,
+        zip1:       address.zipcode.try(:[], 0...5)).address
+    end
+
+    def shipment_items
+      items = []
+
+      order.line_items.map do |item|
+        items << {
+                  shipment_item: {
+                    discounts: nil,
+                    brand_key: item.variant.brand_key,
+                    product_key: item.variant.product_key,
+                    product_quantity: item.quantity,
+                    product_unit_price: item.price.to_i
+                  }
+                }
+      end
+
+      items
+    end
+
+    def initialize_client
+      ::ShipCompliant.configure do |c|
+        c.partner_key = SolidusShipCompliant::Config.partner_key
+        c.username    = SolidusShipCompliant::Config.username
+        c.password    = SolidusShipCompliant::Config.password
+      end
+    end
+  end
+end

data/app/models/spree/taxon_decorator.rb

@@ -0,0 +1,11 @@
+Spree::Taxon.class_eval do
+  def brand_key
+    words = name.split(' ')
+
+    if words.count > 1
+      words.map(&:chr).join.upcase
+    else
+      name.chars.first(3).join.upcase
+    end
+  end
+end

data/app/models/spree/variant_decorator.rb

@@ -0,0 +1,73 @@
+Spree::Variant.class_eval do
+  delegate :bottle_size, :default_case, :default_wholesale_case_price,
+           :percent_alcohol, :varietal, :vintage, :volume_amount,
+           :volume_unit, to: :product
+
+  def brand_key
+    brand = product.taxons.joins(:taxonomy).find_by(spree_taxonomies: { name: 'Brand' })
+    brand.try(:brand_key)
+  end
+
+  def product_key
+    [sku, option_values_ids].compact.join('-')
+  end
+
+  ##
+  # Ship Compliant necessary attributes:
+  #
+  # bottle_size: 750ml
+  # default_case: 12
+  # default_wholesale_case_price: 670
+  # percent_alcohol: 5%
+  # varietal: 'Cabernet Sauvignon'
+  # vintage: 2003
+  # volume_amount: 750
+  # volume_unit: milliliter
+  ##
+
+  def bottle_size
+    product.option_types.find_by(presentation: 'Bottle Size').try(:presentation)
+  end
+
+  def default_case
+    product.property('default_case') || 1
+  end
+
+  def default_wholesale_case_price
+    product.property('default_wholesale_case_price')
+  end
+
+  def percent_alcohol
+    product.property('percent_alcohol')
+  end
+
+  def varietal
+    product.property('varietal')
+  end
+
+  def vintage
+    product.property('vintage')
+  end
+
+  def volume_amount
+    product.property('volume_amount')
+  end
+
+  def volume_unit
+    product.property('volume_unit')
+  end
+
+  private
+
+  def option_values_ids
+    values = option_values.includes(:option_type).sort_by do |option_value|
+      option_value.option_type.position
+    end
+
+    values.to_a.map! do |ov|
+      "#{ov.id}"
+    end
+
+    values.any? ? values.join('-') : nil
+  end
+end

data/app/overrides/spree/admin/shared/_configuration_menu/_add_ship_compliant_config_menu.html.erb.deface

@@ -0,0 +1,3 @@
+<!-- insert_bottom "[data-hook=admin_configurations_sidebar_menu]" -->
+
+<%= configurations_sidebar_menu_item Spree.t('admin.tab.ship_compliant'), edit_admin_ship_compliant_settings_path %>

data/app/views/spree/admin/shared/_ship_complaint_tabs.html.erb

@@ -0,0 +1,9 @@
+<% content_for :tabs do %>
+  <nav>
+    <ul class="tabs" data-hook="admin_settings_ship_complaint_tabs">
+      <% if can? :display, Spree::ShipCompliant %>
+        <%= settings_tab_item plural_resource_name(Spree::ShipCompliant), spree.edit_admin_ship_compliant_settings_path %>
+      <% end %>
+    </ul>
+  </nav>
+<% end %>

data/app/views/spree/admin/ship_compliant_settings/edit.html.erb

@@ -0,0 +1,30 @@
+<%= render partial: 'spree/admin/shared/configuration_menu' %>
+
+<% content_for :page_title do %>
+  <%= Spree.t(:ship_compliant_settings) %>
+<% end %>
+
+<%= form_tag admin_ship_compliant_settings_path, method: :put do %>
+  <div id="preferences" data-hook>
+    <div class="row">
+      <div class="col-md-6">
+        <fieldset class="no-border-bottom">
+          <% @preferences_ship_compliant.each do |name| %>
+            <div class="form-group">
+              <%= render "spree/admin/shared/preference_fields/#{@config.preference_type(name)}",
+                  name:  name.to_s,
+                  value: @config[name],
+                  label: t(name.to_s, scope: 'spree', default: name.to_s.humanize) %>
+            </div>
+          <% end %>
+        </fieldset>
+      </div>
+    </div>
+
+    <div class="form-buttons" data-hook="buttons">
+      <%= button Spree.t('actions.update'), 'refresh' %>
+      <span class="or"><%= Spree.t(:or) %></span>
+      <%= button_link_to Spree.t('actions.cancel'), admin_orders_url, icon: 'delete' %>
+    </div>
+  </div>
+<% end %>

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/solidus_ship_compliant/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,23 @@
+en:
+  activerecord:
+    attributes:
+      spree/ship_compliant:
+        username: Username
+        password: Password
+        partner_key: Partner Key
+  spree:
+    admin:
+      tab:
+        ship_compliant: Ship Compliant Settings
+        vendors: Vendors
+    ship_compliant_tax: Ship Compliant Tax
+    ship_compliant_settings_updated: The shipment compliant settings have been successfully updated!
+    ship_compliant_settings: Ship Compliant Settings
+    taxonomy_brands_name: Brand
+    taxonomy_categories_name: Categories
+    taxonomy_types_name: Type
+    ship_compliant_alert: ShipCompliant cannot calculate inclusive sales taxes
+    store_locator: Store Location
+    store_locators: Store Locations
+    locator_address: Locator Address
+    available_shipping_locators: Available Shipping Locators

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.routes.draw do
+  namespace :admin do
+    resource :ship_compliant_settings
+  end
+end

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

@@ -0,0 +1,20 @@
+module SolidusShipCompliant
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=solidus_ship_compliant'
+      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 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/solidus_ship_compliant.rb

@@ -0,0 +1,2 @@
+require 'solidus_core'
+require 'solidus_ship_compliant/engine'

data/lib/solidus_ship_compliant/configuration.rb

@@ -0,0 +1,7 @@
+module SolidusShipCompliant
+  class Configuration < Spree::Preferences::Configuration
+    preference :username, :string, default: ''
+    preference :password, :string, default: ''
+    preference :partner_key, :string, default: ''
+  end
+end

data/lib/solidus_ship_compliant/engine.rb

@@ -0,0 +1,31 @@
+module SolidusShipCompliant
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'solidus_ship_compliant'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer 'solidus_ship_compliant.environment', before: :load_config_initializers do |app|
+      SolidusShipCompliant::Config = SolidusShipCompliant::Configuration.new
+    end
+
+    initializer 'solidus_ship_compliant.register.calculators', after: 'spree.register.calculators' do |app|
+      SolidusShipCompliant::Config = SolidusShipCompliant::Configuration.new
+      app.config.spree.calculators.tax_rates << Spree::Calculator::ShipCompliantCalculator
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare(&method(:activate).to_proc)
+  end
+end

data/lib/solidus_ship_compliant/error.rb

@@ -0,0 +1,4 @@
+module SolidusShipCompliant
+  class Error < StandardError
+  end
+end

data/lib/solidus_ship_compliant/factories.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'solidus_ship_compliant/factories'
+end

data/lib/solidus_ship_compliant/version.rb

@@ -0,0 +1,3 @@
+module SolidusShipCompliant
+  VERSION = '1.0.0'
+end