workarea-valken-shipping 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 230124e4ac5db27cfd29ae6ab6a71d79342365a0510fcf3c9c5677d72588e229
+  data.tar.gz: 60cd8040bc385b9b7de3ccfbae148f8662ff3756ff51ae8eef7efdfaac968f71
+SHA512:
+  metadata.gz: c2fcd56f5131127418c269eef0322ccdc0dbd4b18eb17f6da5a2c57ab0deaae60b0a53192e87d834da77ffe8adcb561e9e6c95a5b1b10dd46c52e8ff1d9c5558
+  data.tar.gz: 800918f479596701f9a0c2d13884a3e94c781ad4e95047780a8c8cf30d2a4e14714bc5e19d61f0d0b0d646317e9dc43b54dd15c3cf68541400dd0f276fd9887e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 sushmitha02
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Valken::Shipping
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'valken-shipping'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install valken-shipping
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Valken::Shipping'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

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

@@ -0,0 +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.find_method_options(order, shipping)
+        end
+    end
+
+  end
+end

data/app/models/workarea/shipping.decorator

@@ -0,0 +1,262 @@
+module Workarea
+  decorate Shipping, with: :valken do
+    decorated do
+      field :tracking_number, type: String
+    end
+
+    class_methods do
+    end
+
+    def order
+      @order
+    end
+
+    def shipping
+      @shipping
+    end
+
+
+    def default_options(packages)
+      return [] if address.blank? || packages.blank?
+      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

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

data/app/services/workarea/packaging.decorator

@@ -0,0 +1,27 @@
+module Workarea
+  decorate Packaging, with: :valken do
+    decorated do
+    end
+
+    def find_shipping_sku(sku)
+      shipping_skus.detect { |s| s.id == sku } || Shipping::Sku.new(id: sku, weight: find_sku_weight(sku))
+    end
+
+    def find_sku_weight(sku)
+      product_by_sku = Catalog::Product.find_by_sku(sku).variants
+      sku_data = product_by_sku.detect {|variant| variant.sku == sku }
+      sku_weight = is_pounds(sku_data) ? convert_to_lb(sku_data.weight || 0) : (sku_data.weight  || 0)
+      sku_weight
+    end
+
+    def convert_to_lb(weight)
+      unit = Measured::Weight.new(weight, :lb)
+      ounce_unit = unit.convert_to(:oz)
+      ounce_unit.value
+    end
+
+    def is_pounds(sku_data)
+      sku_data.weight_unit == "lb"
+    end
+  end
+end

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/config/initializers/workarea.rb

@@ -0,0 +1,14 @@
+Workarea.configure do |config|
+  ActiveShipping::Carriers.register :UPS,    'active_shipping/carriers/ups'
+
+  config.weight_table = {"2": 5, "15": 15, "200": 1, "2500": 200}
+
+  config.shipping_rates = [
+    {"Valken Overnight" => "Overnight"},
+    {"Valken Express 2-Day" => "2 Business Days"},
+    {"Valken Express 3-Day" => "3 Business Days"}
+  ]
+  config.ups_options = {"12"=> "Valken Express 3-Day", "01"=> "Valken Overnight", "02"=> "Valken Express 2-Day"}
+  config.fedex_options = {"STANDARD_OVERNIGHT"=> "Valken Overnight", "FEDEX_2_DAY"=> "Valken Express 2-Day", "GROUND_HOME_DELIVERY"=> "Valken Express 3-Day"}
+end
+Valken::Shipping.auto_initialize_gateway

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/tasks/valken/shipping_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :valken_shipping do
+#   # Task goes here
+# end

data/lib/valken/shipping.rb

@@ -0,0 +1,42 @@
+require 'workarea'
+require 'workarea/storefront'
+require 'workarea/admin'
+require "valken/shipping/engine"
+
+module Valken
+  module Shipping
+
+    def self.ups_credentials
+      return {} unless Rails.application.secrets.ups_carrier.present?
+      Rails.application.secrets.ups_carrier.symbolize_keys
+    end
+
+    def self.fedex_credentials
+      return {} unless Rails.application.secrets.fedex_carrier.present?
+      Rails.application.secrets.fedex_carrier.symbolize_keys
+    end
+
+    def self.ups_gateway=(gateway)
+      Workarea.config.gateways.ups_carrier = gateway
+    end
+
+    def self.fedex_gateway=(gateway)
+      Workarea.config.gateways.fedex_carrier = gateway
+    end
+
+    def self.auto_initialize_gateway
+      if ups_credentials.present? && fedex_credentials.present?
+        if Rails.env.test?
+          self.ups_gateway = ActiveShipping::Workarea.new
+          self.fedex_gateway = ActiveShipping::Workarea.new
+        else
+          self.ups_gateway = ActiveShipping::UPS.new ups_credentials
+          self.fedex_gateway = ActiveShipping::FedEx.new fedex_credentials
+        end
+      else
+        self.ups_gateway = ActiveShipping::Workarea.new
+        self.fedex_gateway = ActiveShipping::Workarea.new
+      end
+    end
+  end
+end

data/lib/valken/shipping/engine.rb

@@ -0,0 +1,6 @@
+module Valken
+  module Shipping
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/valken/shipping/version.rb

@@ -0,0 +1,5 @@
+module Valken
+  module Shipping
+    VERSION = '2.0.0'
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: workarea-valken-shipping
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- sushmitha02
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.2
+description: Choosing multiple carrier shipping options
+email:
+- sushmitha.h@trikatechnologies.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- 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
+- lib/valken/shipping.rb
+- lib/valken/shipping/engine.rb
+- lib/valken/shipping/version.rb
+homepage: https://github.com/sushmitha02
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: shipping options
+test_files: []