https://github.com/workarea-commerce/workarea-shipping-estimation

https://github.com/workarea-commerce/workarea-shipping-estimation

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/workarea-commerce/workarea-shipping-estimation
• Owner: workarea-commerce
• License: other
• Created: 2019-08-21T19:57:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-06-25T12:55:14.000Z (over 4 years ago)
• Last Synced: 2024-09-17T23:23:11.997Z (3 months ago)
• Language: Ruby
• Size: 44.9 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
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)