valken-shipping 1.1.7 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21a15ea0992134b70026f5e873cce4752bb2d208b45c33f89f6fd105bfb09a01
-  data.tar.gz: a975398b63c62662d7dc1d5de4238298e12377b9d10867dd56cadc0e5fc7149f
+  metadata.gz: f9818be8a62cad5c315d34ab0f92ad3329e92cc783239a7e79eb2d0a1ef57ed6
+  data.tar.gz: b4ce33dbb4c6521fd0bba0aa7be81d14141bd44d6f9e98ab3b05580b418c8027
 SHA512:
-  metadata.gz: 600c74fd671573e899bd8a8a527a04ba19057fd0f9049828336ca9261898501a1d876ff87257ea4b54cdfde99e949524f4a8e21fdbc17047e1457b5a896df84c
-  data.tar.gz: 875c6a24365e57ebd4374ac33cf4ce9f6af884414afd083bed38c9a737adc0a83989cd96a658ca828df0dab6a0b70417e795b4829bf5e631bc5a178fee7222b8
+  metadata.gz: aefdbcffb8b51ff670231ad598a339fb4f8184f3670252d0d982136c5b13c834a913dd8db3b581b72bf89b9e393c1f77411e4e805b149042dd4ed72048453652
+  data.tar.gz: 676daa8bcf724b0c134e66bfc95ace4fa8be4ad3745c422badfd794c8ff64bae749e48ed87664a2896a54f00f52b33f3c8fb659f6aa2e804530a198befc3689c

data/app/helpers/workarea/addresses_helper.rb

@@ -0,0 +1,59 @@
+module Workarea
+  module AddressesHelper
+    def country_options
+      return [[Country['US'].name, Country['US'].alpha2]] if is_usa_only?
+      Workarea.config.countries.map do |country|
+        [country.name, country.alpha2]
+      end
+    end
+
+    def region_options
+      @region_options ||= Workarea.config.countries.reduce([]) do |memo, country|
+        regions = country.subdivisions
+                    .map { |id, region| [region.translations[I18n.locale.to_s] || region.name, id] }
+                    .sort_by { |name, id| name || id }
+
+        memo << [country.name, regions]
+        memo
+      end
+    end
+
+    def is_usa_only?
+      
+      orders = current_order rescue nil
+      return false if orders.blank? || orders.items.blank?
+
+      usa_only_attribute = Workarea.config.shipping_attributes[:usa_only]
+      product_attributes = orders.items.map(&:product_attributes)
+      return product_attributes.map{ |item| item[:details][:en][usa_only_attribute] }.flatten.include?("true")
+    end
+
+    def formatted_address(address)
+      pieces = {
+        recipient: "#{address.first_name} #{address.last_name}\n#{address.company}".strip,
+        street: "#{address.street} #{address.street_2}".strip,
+        city: address.city,
+        region: address.region_name,
+        region_short: address.region,
+        postalcode: address.postal_code,
+        country: address.country.alpha2
+      }
+
+      address_format = address.country.address_format || Country['US'].address_format
+      result = pieces.reduce(address_format) do |memo, (name, value)|
+        memo.gsub(/{{#{name}}}/, html_escape(value.to_s))
+      end
+
+      if address.phone_number.present?
+        formatted_phone = number_to_phone(
+          address.phone_number,
+          extension: address.phone_extension
+        )
+
+        result << "\n#{formatted_phone}"
+      end
+
+      result.gsub(/\n/, tag(:br)).html_safe
+    end
+  end
+end

data/app/models/workarea/checkout/shipping_options.decorator

@@ -1,192 +1,16 @@
 module Workarea
   decorate Checkout::ShippingOptions, with: :valken do
     decorated do
+      class NoAvailableShippingOption < RuntimeError; end
     end
 
     def all_options
       @all_options ||=
         begin
           packaging = Packaging.new(order, shipping)
-          shipping_option
+          shipping.find_method_options(order, shipping)
         end
     end
 
-    def shipping_option
-      carrier_data = collect_carrier_data(selected_carrier)
-      if Workarea.config.gateways.ups_carrier.class != ActiveShipping::Workarea
-        carrier_data.push(get_ltl_shipping)
-        carrier_data.push(get_free_shipping) if Workarea.config.show_free_shipping
-      end
-      carrier_data
-    end
-
-    # Selecting the shipping carrier based on order items 
-    # 
-    # If the product is type hazmat then it returns ups...or if product is type gun then it returns fedex
-    # else if product is not both type then it returns none
-    def selected_carrier
-      product_ids = order.items.to_a.map(&:product_id)
-      product_details = Catalog::Product.in(id: product_ids).pluck(:details)
-      is_ups = product_details.any? {|item| item["en"]["Type"] && item["en"]["Type"].first == "UPS"}
-      is_fedex = product_details.any? {|item| item["en"]["Type"] && item["en"]["Type"].first == "FEDEX"}
-      return "UPS" if is_ups
-      return "FedEx" if is_fedex
-      return "none" unless is_ups && is_fedex
-    end
-
-    # If the carrier is ups then it will print ups data...or if carrier is fedex then prinnt fedex data...
-    # else if it is not both then choose cheapest price.
-    def collect_carrier_data(carrier)
-      return get_ups_data if carrier == "UPS"
-      return get_fedex_data if carrier == "FedEx"
-      return get_none_data if carrier == "none"
-    end
-
-    # UPS data.
-    def get_ups_data
-      @ups_options ||= get_options(Workarea.config.gateways.ups_carrier, Workarea.config.shipping_rates)
-    end
-
-    # FedEx data.
-    def get_fedex_data
-      @fedex_response ||= get_options(Workarea.config.gateways.fedex_carrier, Workarea.config.shipping_rates)
-    end
-
-    # If the product is not ups or fedex then it will choose the cheapest price among ups and fedex annd print the value.
-    def get_none_data
-      ups = get_ups_data.sort_by(&:price).first
-      fedex = get_fedex_data.sort_by(&:price).first
-
-      if ups.present? && fedex.present?
-        if ups.price > fedex.price
-          return get_fedex_data
-        elsif ups.price < fedex.price
-          return get_ups_data
-        else
-          return get_ups_data
-        end
-      elsif ups.blank? 
-        return get_fedex_data
-      elsif fedex.blank?
-        return get_ups_data
-      else
-        return []
-      end
-      
-    end
-
-    # Free shipping option.
-    def get_free_shipping
-    	ShippingOption.new(
-        carrier: "Free Shipping",
-        name: "Valken Economy",
-        sub_name: "5 - 9 Business Days",
-        service_code: "Free",
-        price: Money.new(0.0, "USD"),
-        tax_code: "TAX01"
-      )
-    end
-
-    # Calculating the ltl shipping rates based on the conditions.
-    def get_ltl_shipping
-      weight_price = 0
-      case weight_convertion
-      when 0..2
-        weight_price = 5
-      when 2..15
-        weight_price = 15
-      when 15..200
-        weight_price = (1 * weight_convertion)
-      when 200..2500
-        weight_price = 200
-      else
-        weight_price = ((weight_convertion / 2500).ceil()) * 200
-      end
-
-      ShippingOption.new(
-        carrier: "LTL Shipping",
-        name: "Valken Standard",
-        sub_name: "3 - 5 Business Days",
-        service_code: "LTL01",
-        price: Money.new(weight_price * 100, "USD"),
-        tax_code: "TAX01"
-      )
-    end
-
-    # Returns the total weight.
-    def weight_convertion
-      packaging = Packaging.new(order, shipping)
-      return 0 if packaging.packages.blank?
-      full_weight = 0
-      packaging.packages.each do |item_package|
-        new_weight = item_package.weight.convert_to(:lb)
-        full_weight += new_weight.value
-      end
-      full_weight
-    end
-
-    # 1. Sending a call to carrier and get shipping rates
-    # 2. Based on service codes in config, filter the shipping rates
-    # 3. If error, return empty array
-    def get_options(carrier, service_code)
-      packaging = Packaging.new(order, shipping)
-      return [] if shipping.address.blank? || packaging.packages.blank?
-      shipping_option = carrier || Workarea.config.gateways.shipping
-
-      origin = ActiveShipping::Location.new(Workarea.config.shipping_origin)
-      begin
-        response = shipping_option.find_rates(
-          origin,
-          shipping.address.to_active_shipping,
-          packaging.packages
-        )
-        if carrier.class == ActiveShipping::Workarea
-          response.rates.sort_by(&:price).map do |rate|
-            ShippingOption.from_rate_estimate(rate)
-          end
-        else
-          filter_shipping_rates(response.rates, service_code)
-        end
-      rescue ActiveShipping::ResponseError => e
-        return []
-      end
-    end
-
-    # Sort rates by delevry date and pick 1st three rates
-    # Find cheapest rate for those three rates
-    # Push all the cheap option for 1, 2, & 3 days into an array and return
-    def filter_shipping_rates(rates, service_code)
-      filtered_rates = []
-
-      # find and sort all delivery dates and pick 1st three
-      all_delivery_dates  = rates.map { |rate| rate.delivery_date }
-      uniq_delivery_dates = all_delivery_dates.compact.sort.uniq[0..2]
-      
-      # For each delivery dates, find cheapest rates and create shipping option and push
-      uniq_delivery_dates.each_with_index do |date, index|
-        selected_rates = rates.select {|rate| rate.delivery_date.present? && rate.delivery_date == date}
-        cheap_rate = selected_rates.sort_by(&:price).first
-        description = "#{cheap_rate.delivery_date.strftime('%A, %B %d, %Y')}"
-        shipping_option = create_shipping_options(cheap_rate, service_code[index], description, Workarea.config.shipping_rates[index])
-        filtered_rates.push(shipping_option)
-      end
-      filtered_rates
-    end
-
-    # creating a ShippingOption
-    def create_shipping_options(rate, rate_label = nil, description = nil, sub_name)
-      ShippingOption.new(
-          carrier: rate.carrier,
-          name: rate_label.keys.join || rate.service_name,
-          sub_name: sub_name.values.join,
-          service_code: rate.service_code,
-          description: description,
-          price: Money.new(rate.price, rate.currency),
-          tax_code: Shipping::Service.find_tax_code(
-            rate.carrier,
-            rate.service_name
-          )
-        )
-    end
   end
 end

data/app/models/workarea/shipping.decorator

@@ -1,26 +1,262 @@
 module Workarea
   decorate Shipping, with: :valken do
-    decorated do 
+    decorated do
+      field :tracking_number, type: String
     end
 
     class_methods do
     end
 
-    def find_method_options(packages, shipping_option)
+    def order
+      @order
+    end
+
+    def shipping
+      @shipping
+    end
+
+
+    def default_options(packages)
       return [] if address.blank? || packages.blank?
-      shipping_option = shipping_option || Workarea.config.gateways.shipping
- 
+      shipping_option = Workarea.config.gateways.shipping
+
       origin = ActiveShipping::Location.new(Workarea.config.shipping_origin)
       response = shipping_option.find_rates(
         origin,
         address.to_active_shipping,
         packages
       )
-
       response.rates.sort_by(&:price).map do |rate|
         ShippingOption.from_rate_estimate(rate)
       end
+    end
+
+    def find_method_options(order, shipping)
+      @order ||= order
+      @shipping ||= shipping
+      carrier_data = []
+
+      packaging = Packaging.new(order, shipping)
+      return [] if packaging.packages.blank?
+
+      return default_options(packaging.packages) if Workarea.config.gateways.ups_carrier.class == ActiveShipping::Workarea
+
+      shipping_options_api = get_final_shipping_options(collect_carrier_data)
+      return [] if @error.present?
+
+      carrier_data.push(shipping_options_api) if shipping_options_api.present? && shipping_options_api.any?
+
+      if Workarea.config.gateways.ups_carrier.class != ActiveShipping::Workarea
+        carrier_data.push(get_ltl_shipping)
+        carrier_data.push(get_free_shipping) if Workarea.config.show_free_shipping
+      else
+        return []
+      end
+
+      carrier_data.flatten.reverse
+    end
+
+    def get_final_shipping_options(rates)
+      options = []
+      
+      if is_ground
+        ground_rate = rates.detect{|rate| rate.service_code == "GROUND_HOME_DELIVERY" || rate.service_code == "03" }
+        return [] if ground_rate.blank?
+
+        description = "#{ground_rate.delivery_date.strftime('%A, %B %d, %Y')}"
+        days_to_deliver = (ground_rate.delivery_date - Date.today).to_i
+
+        label = Workarea.config.shipping_rates[(days_to_deliver - 1)]
+        return options.push(create_shipping_options(ground_rate, label, description))
+      end
+
+      rates.each_with_index do |rate, index|
+        description = "#{rate.delivery_date.strftime('%A, %B %d, %Y')}"
+        label = Workarea.config.shipping_rates[index]
+        options.push(create_shipping_options(rate, label, description))
+      end
+      options
+    end
+
+    # If the carrier is ups then it will print ups data...or if carrier is fedex then prinnt fedex data...
+    # else if it is not both then choose cheapest price.
+    def collect_carrier_data
+      return get_ups_data if is_ups
+      return get_fedex_data if is_fedex
+      return get_none_data unless is_ups && is_fedex
+    end
+
+    # UPS data.
+    def get_ups_data
+      @ups_options ||= get_options(Workarea.config.gateways.ups_carrier, Workarea.config.shipping_rates)
+    end
+
+    # FedEx data.
+    def get_fedex_data
+      @fedex_response ||= get_options(Workarea.config.gateways.fedex_carrier, Workarea.config.shipping_rates)
+    end
+
+    # If the product is not ups or fedex then it will choose the cheapest price among ups and fedex annd print the value.
+    def get_none_data
+      return [] if get_ups_data.blank? || get_fedex_data.blank?
+      final_options = []
+      temp_options = get_fedex_data + get_ups_data
+      return [] unless temp_options.any?
+
+      delivery_dates = temp_options.map(&:delivery_date).uniq.sort
+      delivery_dates.each_with_index do |date, index|
+        selected_rates = temp_options.select {|rate| rate.delivery_date == date}
+        final_options.push(selected_rates.sort_by(&:price).first)
+      end
+      return final_options
+      
+    end
+
+    # Free shipping option.
+    def get_free_shipping
+    	ShippingOption.new(
+        carrier: "Free Shipping",
+        name: "Valken Economy",
+        sub_name: "5 - 9 Business Days",
+        service_code: "Free",
+        price: Money.new(0.0, "USD"),
+        tax_code: "TAX01"
+      )
+    end
+
+    # Calculating the ltl shipping rates based on the conditions.
+    def get_ltl_shipping
+      weight_price = 0
+      case weight_convertion
+      when 0..2
+        weight_price = 5
+      when 2..15
+        weight_price = 15
+      when 15..200
+        weight_price = (1 * weight_convertion)
+      when 200..2500
+        weight_price = 200
+      else
+        weight_price = ((weight_convertion / 2500).ceil()) * 200
+      end
+
+      ShippingOption.new(
+        carrier: "LTL Shipping",
+        name: "Valken Standard",
+        sub_name: "3 - 5 Business Days",
+        service_code: "LTL01",
+        price: Money.new(weight_price * 100, "USD"),
+        tax_code: "TAX01"
+      )
+    end
+
+    # Returns the total weight.
+    def weight_convertion
+      packaging = Packaging.new(order, shipping)
+      return 0 if packaging.packages.blank?
+      full_weight = 0
+      packaging.packages.each do |item_package|
+        new_weight = item_package.weight.convert_to(:lb)
+        full_weight += new_weight.value
+      end
+      full_weight
+    end
+
+    # 1. Sending a call to carrier and get shipping rates
+    # 2. Based on service codes in config, filter the shipping rates
+    # 3. If error, return empty array
+    def get_options(carrier, service_code)
+      packaging = Packaging.new(order, shipping)
+      return [] if @shipping.address.blank? || packaging.packages.blank?
+      shipping_option = carrier || Workarea.config.gateways.shipping
+
+      origin = ActiveShipping::Location.new(Workarea.config.shipping_origin)
+      begin
+        response = shipping_option.find_rates(
+          origin,
+          @shipping.address.to_active_shipping,
+          packaging.packages
+        )
+        if carrier.class == ActiveShipping::Workarea
+          response.rates.sort_by(&:price).map do |rate|
+            ShippingOption.from_rate_estimate(rate)
+          end
+        else
+          filter_shipping_rates(response.rates, service_code)
+        end
+      rescue ActiveShipping::ResponseError => e
+        @error = e
+        return []
+      end
+    end
+
+    # Sort rates by delevry date and pick 1st three rates
+    # Find cheapest rate for those three rates
+    # Push all the cheap option for 1, 2, & 3 days into an array and return
+    def filter_shipping_rates(rates, service_code)
+      filtered_rates = []
+      # find and sort all delivery dates and pick 1st three
+      all_delivery_dates  = rates.map { |rate| rate.delivery_date }
+      # sorting the uniq delivery dates and reversing those delivery dates.
+      uniq_delivery_dates = all_delivery_dates.compact.sort.uniq[0..2]
+      
+      # removing overnight. Assuming the 3rd option is always overnight
+      uniq_delivery_dates.pop if uniq_delivery_dates.length == 3
+
+      # For each delivery dates, find cheapest rates and create shipping option and push
+      uniq_delivery_dates.each_with_index do |date, index|
+        selected_rates = rates.select {|rate| rate.delivery_date.present? && rate.delivery_date == date}
+        cheap_rate = selected_rates.sort_by(&:price).first
+        description = "#{cheap_rate.delivery_date.strftime('%A, %B %d, %Y')}"
+
+        filtered_rates.push(cheap_rate)
+      end
+      filtered_rates
+    end
+
+    # creating a ShippingOption
+    def create_shipping_options(rate, rate_label = nil, description = nil)
+      ShippingOption.new(
+          carrier: rate.carrier,
+          name: rate_label.keys.join || rate.service_name,
+          sub_name: rate_label.values.join,
+          service_code: rate.service_code,
+          description: description,
+          delivery_date: rate.delivery_date,
+          price: Money.new(rate.price, rate.currency),
+          tax_code: Shipping::Service.find_tax_code(
+            rate.carrier,
+            rate.service_name
+          )
+        )
+    end
+
+    # Selecting the shipping carrier based on order items 
+    # 
+    # If the product is type hazmat then it returns ups...or if product is type gun then it returns fedex
+    # else if product is not both type then it returns none
+    def is_fedex
+      carrier_type_attribute = Workarea.config.shipping_attributes[:carrier_type]
+      product_carrier_type = product_details.map{ |item| item[:en][carrier_type_attribute] }.flatten
+      product_carrier_type.include?("FEDEX")
+    end
+
+    def is_ups
+      carrier_type_attribute = Workarea.config.shipping_attributes[:carrier_type]
+      product_carrier_type = product_details.map{ |item| item[:en][carrier_type_attribute] }.flatten
+      product_carrier_type.include?("UPS")
+    end
+
+    def is_ground
+      ground_ship_attribute = Workarea.config.shipping_attributes[:ground_shipping_only]
+      product_carrier_type = product_details.map{ |item| item[:en][ground_ship_attribute] }.flatten
+      product_carrier_type.include?("true")
+    end
+  
+    def product_details
+      # product_attributes   = @order.items.map(&:product_attributes)
 
+      @product_details ||= Catalog::Product.in(id: @order.items.to_a.map(&:product_id)).pluck(:details)
     end
   end
 end

data/app/models/workarea/shipping_option.decorator

@@ -1,7 +1,7 @@
 module Workarea
   decorate ShippingOption, with: :valken do
     decorated do 
-      attr_reader :description, :sub_name
+      attr_reader :description, :sub_name, :delivery_date
     end
 
     class_methods do

data/config/initializers/shipping_configuration.rb

@@ -0,0 +1,12 @@
+Workarea::Configuration.define_fields do
+  fieldset 'Shipping', namespaced: false do
+    field 'Shipping Attributes',
+      type: :hash,
+      default: {
+        'usa_only' => 'usa only',
+        'carrier_type' => 'Type',
+        'ground_shipping_only' => 'ground shipping only'
+      },
+      description: 'Mapping of product details keys with shipping logic. Note: This maps only the keys not the values.'
+  end
+end

data/lib/valken/shipping/version.rb

@@ -1,5 +1,5 @@
 module Valken
   module Shipping
-    VERSION = '1.1.7'
+    VERSION = '2.0.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valken-shipping
 version: !ruby/object:Gem::Version
-  version: 1.1.7
+  version: 2.0.3
 platform: ruby
 authors:
 - sushmitha02
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -41,10 +41,12 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/valken_shipping_manifest.js
+- app/helpers/workarea/addresses_helper.rb
 - app/models/workarea/checkout/shipping_options.decorator
 - app/models/workarea/shipping.decorator
 - app/models/workarea/shipping_option.decorator
 - app/services/workarea/packaging.decorator
+- config/initializers/shipping_configuration.rb
 - config/initializers/workarea.rb
 - config/routes.rb
 - lib/tasks/valken/shipping_tasks.rake
@@ -70,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: shipping options