workarea-shipping_estimation 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a56d63bd0fe82a3a189a4fefd5a3af7cb53052c03c9485c2551b291f34efa39
+  data.tar.gz: fb2478137bd04d832f63ed2daedffd82074ca6eea0623f5043324956fcb25c8a
+SHA512:
+  metadata.gz: 778b498242df337170092623e7af0d2f88dc4d561197f8982cbba263ae1393f928021ecf8292c5ed509d3171d05e4801bdab3056030f55e3445afa2880eb6ff4
+  data.tar.gz: 68f36c5b136a4513eef17114379b3806e51d2a431fe6ed8d7da17ebc8b17f1e56e01ad1afcc450631b5b46c8cda36365d3ce1e7b179bee7b9e15ea2e23a468dd

data/.editorconfig

@@ -0,0 +1,20 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[{*.rb,*.haml,*.decorator,*.yml,*.yaml,*.jbuilder}]
+indent_size = 2
+indent_style = space
+
+[{*.js,*.jst,*.ejs,*.scss}]
+indent_size = 4
+
+[*.md]
+indent_size = 4
+trim_trailing_whitespace = false

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report to help us improve Workarea
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+⚠️**Before you create**⚠️
+Please verify the issue you're experiencing is not part of your Workarea project customizations. The best way to do this is with a [vanilla Workarea installation](https://developer.workarea.com/articles/create-a-new-host-application.html). This will help us spend time on fixes/improvements for the whole community. Thank you!
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Workarea Setup (please complete the following information):**
+ - Workarea Version: [e.g. v3.4.6]
+ - Plugins [e.g. workarea-blog, workarea-sitemaps]
+
+**Attachments**
+If applicable, add any attachments to help explain your problem, things like:
+- screenshots
+- Gemfile.lock
+- test cases
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Suggest documentation
+title: ''
+labels: documentation
+assignees: ''
+
+---
+
+**Is your documentation related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm confused by [...]
+
+**Describe the article you'd like**
+A clear and concise description of what would be in the documentation article.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Workarea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.gitignore

@@ -0,0 +1,13 @@
+Gemfile.lock
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/tmp/
+test/dummy/public/
+test/dummy/log/*.log
+node_modules
+test/reports
+package.json
+yarn.lock

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+Workarea Shipping Estimation 1.1.2 (2019-08-21)
+--------------------------------------------------------------------------------
+
+*   Open Source!
+
+
+
+Workarea Shipping Estimation 1.1.1 (2018-10-30)
+--------------------------------------------------------------------------------
+
+*   Recalculate Shipping when Cart is Updated
+
+    Estimating shipping charges in the cart did not previously update when
+    the subtotal changed, and causes UX issues because the shipping total in
+    the cart's summary could be different from the estimated shipping cost
+    given in the dropdown. Workarea Shipping Estimation now calculates the
+    shipping total when rendering the cart in order to show the most
+    up-to-date shipping cost at all times.
+
+    SHIPEST-10
+    Tom Scott
+
+*   Leverage Workarea Changelog task
+
+    ECOMMERCE-5355
+    Curt Howard
+
+
+
+Workarea Shipping Estimation 1.1.0 (2018-02-06)
+--------------------------------------------------------------------------------
+
+*   Remove geocoder dependency from gemspec
+
+    Workarea already defines a dependency on geocoder. There is no need
+    to manage it for this plugin as well.
+
+    SHIPEST-9
+    Matt Duffy
+
+
+Workarea Shipping Estimation 1.0.0 (2017-10-17)
+--------------------------------------------------------------------------------
+
+*   Autofill shipping estimation form based on user address or geolocation info
+
+    SHIPEST-6, SHIPEST-8
+    Matt Duffy
+
+*   Fix mention of weblinc, locale file, add css margin under estimator, loosen postal code field for Canada
+
+    SHIPEST-5
+    Dave Barnow
+
+*   Update for compatibility with workarea v3
+
+    SHIPEST-3
+    Matt Duffy

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+View this plugin's code of conduct here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CODE_OF_CONDUCT.md>

data/CONTRIBUTING.md

@@ -0,0 +1,3 @@
+View this plugin's contribution guidelines here:
+
+<https://github.com/workarea-commerce/workarea/blob/master/CONTRIBUTING.md>

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "git@github.com:#{repo}.git" }
+
+gemspec
+
+gem 'workarea', github: 'workarea-commerce/workarea'

data/LICENSE

@@ -0,0 +1,52 @@
+WebLinc
+Business Source License
+
+Licensor: WebLinc Corporation, 22 S. 3rd Street, 2nd Floor, Philadelphia PA 19106
+
+Licensed Work: Workarea Commerce Platform
+               The Licensed Work is (c) 2019 WebLinc Corporation
+
+Additional Use Grant:
+                      You may make production use of the Licensed Work without an additional license agreement with WebLinc so long as you do not use the Licensed Work for a Commerce Service.
+
+                      A "Commerce Service" is a commercial offering that allows third parties (other than your employees and contractors) to access the functionality of the Licensed Work by creating or managing commerce functionality, the products, taxonomy, assets and/or content of which are controlled by such third parties. 
+
+                      For information about obtaining an additional license agreement with WebLinc, contact licensing@workarea.com.
+
+Change Date: 2019-08-20
+
+Change License: Version 2.0 or later of the GNU General Public License as published by the Free Software Foundation
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative works, redistribute, and make non-production use of the Licensed Work. The Licensor may make an Additional Use Grant, above, permitting limited production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly available distribution of a specific version of the Licensed Work under this License, whichever comes first, the Licensor hereby grants you rights under the terms of the Change License, and the rights granted in the paragraph above terminate.
+
+If your use of the Licensed Work does not comply with the requirements currently in effect as described in this License, you must purchase a commercial license from the Licensor, its affiliated entities, or authorized resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works of the Licensed Work, are subject to this License. This License applies separately for each version of the Licensed Work and the Change Date may vary for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy of the Licensed Work. If you receive the Licensed Work in original or modified form from a third party, the terms and conditions set forth in this License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically terminate your rights under this License for the current and all other versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of Licensor or its affiliates (provided that you may use a trademark or logo of Licensor as expressly required by this License). TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS, EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND TITLE. MariaDB hereby grants you permission to use this License’s text to license your works and to refer to it using the trademark "Business Source License" as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+In consideration of the right to use this License’s text and the "Business Source License" name and trademark, Licensor covenants to MariaDB, and to all other recipients of the licensed work to be provided by Licensor:
+
+To specify as the Change License the GPL Version 2.0 or any later version, or a license that is compatible with GPL Version 2.0 or a later version, where "compatible" means that software provided under the Change License can be included in a program with software provided under GPL Version 2.0 or a later version. Licensor may specify additional Change Licenses without limitation.
+
+To either: (a) specify an additional grant of rights to use that does not impose any additional restriction on the right granted in this License, as the Additional Use Grant; or (b) insert the text "None."
+
+To specify a Change Date.
+
+Not to modify this License in any other way.
+
+Notice
+The Business Source License (this document, or the "License") is not an Open Source license. However, the Licensed Work will eventually be made available under an Open Source License, as stated in this License.
+
+For more information on the use of the Business Source License generally, please visit the Adopting and Developing Business Source License FAQ.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved. "Business Source License" is a trademark of MariaDB Corporation Ab.

data/README.md

@@ -0,0 +1,62 @@
+Workarea Shipping Estimation
+================================================================================
+
+A Workarea Commerce plugin that adds shipping estimation functionality to the storefront cart page.
+
+Getting Started
+--------------------------------------------------------------------------------
+
+Add the gem to your application's Gemfile:
+
+```ruby
+# ...
+gem 'workarea-shipping_estimation'
+# ...
+```
+
+Update your application's bundle.
+
+```bash
+cd path/to/application
+bundle
+```
+
+Configuration
+--------------------------------------------------------------------------------
+
+This plugin utilizes the [Geocoder gem](https://github.com/alexreisner/geocoder) for gathering address information required to estimate shipping from a postal code. Depending on the services you decide to use, it may require [configuring Geocoder](https://github.com/alexreisner/geocoder#geocoding-service-lookup-configuration).
+
+Workarea recommends using Google for geolocation services. However, Google is not free and requires the use of an [API key](https://developers.google.com/maps/documentation/geocoding/get-api-key).
+
+To configure a pay-as-you-go Google API key with Geocoder:
+
+```ruby
+Geocoder.configure(
+  lookup: :google,
+  api_key: Rails.application.secrets.google_maps_api_key
+)
+```
+
+Testing
+--------------------------------------------------------------------------------
+
+When writing tests for/around this gem, make sure to wrap your submissions of the shipping estimate with VCR:
+
+```ruby
+VCR.use_cassette(:geocoding) do
+  within '#estimate_shipping_form' do
+    select 'Ground - $7.00', from: 'shipping_service'
+    click_button 'estimate_shipping'
+  end
+end
+```
+
+Workarea Commerce Documentation
+--------------------------------------------------------------------------------
+
+See [https://developer.workarea.com](https://developer.workarea.com) for Workarea Commerce documentation.
+
+License
+--------------------------------------------------------------------------------
+
+Workarea Shipping Estimation is released under the [Business Software License](LICENSE)

data/Rakefile

@@ -0,0 +1,52 @@
+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    = 'Tasker'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+load 'workarea/changelog.rake'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'workarea/shipping_estimation/version'
+
+desc "Release version #{Workarea::ShippingEstimation::VERSION} of the gem"
+task :release do
+  host = "https://#{ENV['BUNDLE_GEMS__WEBLINC__COM']}@gems.weblinc.com"
+
+  #Rake::Task['workarea:changelog'].execute
+  #system 'git add CHANGELOG.md'
+  #system 'git commit -m "Update CHANGELOG"'
+  #system 'git push origin HEAD'
+
+  system "git tag -a v#{Workarea::ShippingEstimation::VERSION} -m 'Tagging #{Workarea::ShippingEstimation::VERSION}'"
+  system 'git push --tags'
+
+  system 'gem build workarea-shipping_estimation.gemspec'
+  system "gem push workarea-shipping_estimation-#{Workarea::ShippingEstimation::VERSION}.gem"
+  system "gem push workarea-shipping_estimation-#{Workarea::ShippingEstimation::VERSION}.gem --host #{host}"
+  system "rm workarea-shipping_estimation-#{Workarea::ShippingEstimation::VERSION}.gem"
+end

data/app/assets/stylesheets/workarea/storefront/shipping_estimation/components/_shipping_estimation.scss

@@ -0,0 +1,7 @@
+/*------------------------------------*\
+    #SHIPPING-ESTIMATION
+\*------------------------------------*/
+
+.shipping-estimation {
+    margin-bottom: $vertical-margin;
+}

data/app/controllers/workarea/storefront/carts_controller.decorator

@@ -0,0 +1,17 @@
+module Workarea
+  decorate Storefront::CartsController, with: :shipping_estimation do
+    decorated do
+      before_action :set_shipping_estimation_address, only: :show
+    end
+
+    private
+
+    def set_shipping_estimation_address
+      SetShippingEstimationAddress.new(
+        current_checkout,
+        current_location,
+        current_user
+      ).perform
+    end
+  end
+end

data/app/controllers/workarea/storefront/shipping_estimations_controller.rb

@@ -0,0 +1,17 @@
+module Workarea
+  class Storefront::ShippingEstimationsController < Storefront::ApplicationController
+    def create
+      address = Geocoder.search(params[:postal_code]).first
+
+      current_shipping.set_address(
+        postal_code: address.postal_code,
+        region: address.state_code,
+        country: address.country_code,
+        used_for_shipping_estimation: true
+      )
+
+      Workarea::Checkout::Steps::Shipping.new(current_checkout).update(params)
+      redirect_to cart_path
+    end
+  end
+end

data/app/models/workarea/shipping/address.decorator

@@ -0,0 +1,30 @@
+module Workarea
+  decorate Shipping::Address, with: :shipping_estimation do
+    decorated do
+      field :used_for_shipping_estimation, type: Boolean, default: false
+
+      before_validation :set_estimate_data
+      after_validation :unset_estimate_data
+    end
+
+    def set_estimate_data
+      return unless used_for_shipping_estimation?
+
+      Workarea.config
+              .shipping_estimation_placeholder_address
+              .each do |field, value|
+                send("#{field}=", value) if send(field).blank?
+              end
+    end
+
+    def unset_estimate_data
+      return unless used_for_shipping_estimation?
+
+      Workarea.config
+              .shipping_estimation_placeholder_address
+              .each do |field, value|
+                send("#{field}=", nil) if send(field) == value
+              end
+    end
+  end
+end