workarea-shipping_estimation 1.1.2

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,43 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => 'public, max-age=3600'
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+  config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+  config.cache_store = :null_store
+end

data/test/dummy/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,6 @@
+# Be sure to restart your server when you modify this file.
+
+# ApplicationController.renderer.defaults.merge!(
+#   http_host: 'example.org',
+#   https: false
+# )

data/test/dummy/config/initializers/assets.rb

@@ -0,0 +1,11 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+# Rails.application.config.assets.precompile += %w( search.js )

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/test/dummy/config/initializers/new_framework_defaults.rb

@@ -0,0 +1,18 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains migration options to ease your Rails 5.0 upgrade.
+#
+# Read the Rails 5.0 release notes for more info on each option.
+
+# Enable per-form CSRF tokens. Previous versions had false.
+Rails.application.config.action_controller.per_form_csrf_tokens = true
+
+# Enable origin-checking CSRF mitigation. Previous versions had false.
+Rails.application.config.action_controller.forgery_protection_origin_check = true
+
+# Make Ruby 2.4 preserve the timezone of the receiver when calling `to_time`.
+# Previous versions had false.
+ActiveSupport.to_time_preserves_timezone = true
+
+# Configure SSL options to enable HSTS with subdomains. Previous versions had false.
+Rails.application.config.ssl_options = { hsts: { subdomains: true } }

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/initializers/workarea.rb

@@ -0,0 +1,5 @@
+Workarea.configure do |config|
+  # Basic site info
+  config.site_name = 'Workarea Shipping Estimation'
+  config.domain = 'www.example.com'
+end

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/test/dummy/config/puma.rb

@@ -0,0 +1,47 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum, this matches the default thread size of Active Record.
+#
+threads_count = ENV.fetch('RAILS_MAX_THREADS') { 5 }.to_i
+threads threads_count, threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests, default is 3000.
+#
+port        ENV.fetch('PORT') { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch('RAILS_ENV') { 'development' }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked webserver processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory. If you use this option
+# you need to make sure to reconnect any threads in the `on_worker_boot`
+# block.
+#
+# preload_app!
+
+# The code in the `on_worker_boot` will be called if you are using
+# clustered mode by specifying a number of `workers`. After each worker
+# process is booted this block will be run, if you are using `preload_app!`
+# option you will want to use this block to reconnect to any threads
+# or connections that may have been created at application boot, Ruby
+# cannot share connections between processes.
+#
+# on_worker_boot do
+#   ActiveRecord::Base.establish_connection if defined?(ActiveRecord)
+# end
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/test/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  mount Workarea::Core::Engine => '/'
+  mount Workarea::Admin::Engine => '/admin', as: 'admin'
+  mount Workarea::Storefront::Engine => '/', as: 'storefront'
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rails secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 870eee0f7420be138166670bd1b5e304173db0f7cdcfe790f5c83b1a5697db5d0b88214b4fa1b3e738299ae941abc4cb3334651ced32f2ae34c3de255e8b3279
+
+test:
+  secret_key_base: 64265df703401873d5f2fe9fb2966fbe7ea426bef025900aa023a0945b0e0b3eb3d2a424ac619c48acd5014fc5d738419fde608a3987ed390993f2fd6633d23a
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/test/dummy/config/spring.rb

@@ -0,0 +1,6 @@
+%w(
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+).each { |path| Spring.watch(path) }

data/test/models/shipping/address_estimation_validation_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+module Workarea
+  class Shipping
+    class AddressEstimationValidationTest < TestCase
+      def test_validation
+        address = Shipping::Address.new(
+          region: 'PA',
+          country: 'US',
+          postal_code: '19106'
+        )
+
+        refute(address.valid?)
+
+        address.used_for_shipping_estimation = true
+        assert(address.valid?)
+        assert(address.first_name.nil?)
+        assert(address.last_name.nil?)
+        assert(address.street.nil?)
+        assert(address.city.nil?)
+
+        address.used_for_shipping_estimation = false
+        refute(address.valid?)
+
+        address.assign_attributes(
+          first_name: 'Test',
+          last_name: 'User',
+          street: '12 N. 3rd St.',
+          city: 'Philadelphia'
+        )
+        assert(address.valid?)
+
+        address.used_for_shipping_estimation = true
+        assert(address.valid?)
+        assert_equal('Test', address.first_name)
+        assert_equal('User', address.last_name)
+        assert_equal('12 N. 3rd St.', address.street)
+        assert_equal('Philadelphia', address.city)
+      end
+    end
+  end
+end

data/test/services/workarea/set_shipping_estimation_address_test.rb

@@ -0,0 +1,114 @@
+require 'test_helper'
+
+module Workarea
+  class SetShippingEstimationAddressTest < TestCase
+    setup :set_shipping_service
+
+    def set_shipping_service
+      create_shipping_service(
+        name: 'Ground',
+        tax_code: '001',
+        rates: [{ price: 7.to_m }]
+      )
+    end
+
+    def user
+      @user ||= create_user.tap do |user|
+        user.auto_save_shipping_address(
+          first_name: 'Ben',
+          last_name: 'Crouse',
+          street: '22 S. 3rd St.',
+          city: 'Philadelphia',
+          region: 'PA',
+          postal_code: '19106',
+          country: 'US',
+          phone_number: '2159251800'
+        )
+      end
+    end
+
+    def location
+      @location ||= Geolocation.new(
+        'HTTP_GEOIP_CITY_COUNTRY_CODE' => 'US',
+        'HTTP_GEOIP_REGION' => 'PA',
+        'HTTP_GEOIP_POSTAL_CODE' => '19106'
+      )
+    end
+
+    def order
+      @order ||= create_order(items: [{ product_id: '1234', sku: 'SKU' }])
+    end
+
+    def test_setting_address_from_user_saved_addresses
+      checkout = Checkout.new(order, user)
+
+      SetShippingEstimationAddress.new(
+        checkout,
+        Geolocation.new({}),
+        user
+      ).perform
+
+      assert(checkout.shipping.reload.address.present?)
+
+      address = checkout.shipping.address
+      assert_equal('22 S. 3rd St.', address.street)
+      assert_equal('Philadelphia', address.city)
+      assert_equal('19106', address.postal_code)
+      assert_equal('PA', address.region)
+      assert_equal('US', address.country.alpha2)
+    end
+
+    def test_setting_address_from_gelocation_data
+      checkout = Checkout.new(order)
+
+      SetShippingEstimationAddress.new(checkout, location).perform
+
+      assert(checkout.shipping.reload.address.present?)
+
+      address = checkout.shipping.address
+      assert_equal('19106', address.postal_code)
+      assert_equal('PA', address.region)
+      assert_equal('US', address.country.alpha2)
+    end
+
+    def test_recalculate_shipping_price_when_quantity_changes
+      item = order.items.first
+      pricing = create_pricing_sku(id: item.sku)
+      pricing.prices.create!(regular: 10.to_m)
+      checkout = Checkout.new(order)
+      service = create_shipping_service(
+        rates: [
+          { price: 1.to_m, tier_max: 19.to_m },
+          { price: 2.to_m, tier_min: 20.to_m }
+        ]
+      )
+      address_params = {
+        first_name: 'Bob',
+        last_name: 'Clams',
+        street: '123 Fake Street',
+        city: 'Philadelphia',
+        region: 'PA',
+        country: 'US',
+        postal_code: '19145'
+      }
+
+      checkout.shipping.set_shipping_service(service.attributes)
+      checkout.shipping.set_address(address_params)
+      SetShippingEstimationAddress.new(checkout, location).perform
+      Pricing.perform(order, checkout.shippings)
+
+      assert_equal(10.to_m, order.subtotal_price)
+      assert_equal(1.to_m, checkout.shipping.shipping_total)
+
+      item.update!(quantity: 2)
+      order.reload
+      checkout.shipping.set_shipping_service(service.attributes)
+      checkout.shipping.set_address(address_params)
+      SetShippingEstimationAddress.new(checkout, location).perform
+      Pricing.perform(order, checkout.shippings)
+
+      assert_equal(20.to_m, order.subtotal_price)
+      assert_equal(2.to_m, checkout.shipping.shipping_total)
+    end
+  end
+end

data/test/system/workarea/storefront/shipping_estimation_system_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+module Workarea
+  module Storefront
+    class ShippingEstimationSystemTest < Workarea::SystemTest
+      setup :product, :tax_category, :shipping_service
+
+      def product
+        @product = create_product(
+          name: 'Integration Product',
+          variants: [
+            { name: 'SKU1', sku: 'SKU1', regular: 5.to_m },
+            { name: 'SKU2', sku: 'SKU2', regular: 6.to_m }
+          ]
+        )
+        create_inventory(id: 'SKU1', policy: 'standard', available: 2)
+      end
+
+      def tax_category
+        create_tax_category(
+          name: 'Sales Tax',
+          code: '001',
+          rates: [{ percentage: 0.07, country: 'US', region: 'PA' }]
+        )
+      end
+
+      def shipping_service
+        create_shipping_service(
+          name: 'Ground',
+          tax_code: '001',
+          rates: [{ price: 7.to_m }]
+        )
+      end
+
+      def set_and_login_user
+        user = create_user(email: 'bcrouse@workarea.com', password: 'w3bl1nc')
+        user.auto_save_shipping_address(
+          first_name: 'Ben',
+          last_name: 'Crouse',
+          street: '22 S. 3rd St.',
+          city: 'Philadelphia',
+          region: 'PA',
+          postal_code: '19106',
+          country: 'US',
+          phone_number: '2159251800'
+        )
+
+        visit storefront.login_path
+        within '#login_form' do
+          fill_in 'email', with: 'bcrouse@workarea.com'
+          fill_in 'password', with: 'w3bl1nc'
+          click_button t('workarea.storefront.users.login')
+        end
+      end
+
+      def test_estimating_shipping
+        visit storefront.product_path(@product)
+        select @product.skus.first, from: 'sku'
+        click_button t('workarea.storefront.products.add_to_cart')
+        click_link t('workarea.storefront.carts.view_cart')
+
+        VCR.use_cassette('geolocation') do
+          within '#estimate_shipping_form' do
+            fill_in 'postal_code', with: '19143'
+            click_button 'estimate_shipping'
+          end
+
+          within '#estimate_shipping_form' do
+            select 'Ground - $7.00', from: 'shipping_service'
+            click_button 'estimate_shipping'
+          end
+
+          assert(page.has_content?('0.49'))
+          assert(page.has_content?('12.49'))
+        end
+      end
+
+      def test_estimating_shipping_automatically_for_logged_in_user
+        set_and_login_user
+
+        visit storefront.product_path(@product)
+        select @product.skus.first, from: 'sku'
+        click_button t('workarea.storefront.products.add_to_cart')
+
+        VCR.use_cassette('geolocation_19106') do
+          click_link t('workarea.storefront.carts.view_cart')
+
+          within '#estimate_shipping_form' do
+            assert_equal('19106', find_field('postal_code').value)
+            select 'Ground - $7.00', from: 'shipping_service'
+            click_button 'estimate_shipping'
+          end
+        end
+
+        assert(page.has_content?('0.49'))
+        assert(page.has_content?('12.49'))
+      end
+    end
+  end
+end