Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby
branch: master

This branch is 5 commits ahead of romul:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
lib
spec
.gitignore
LICENSE
README.md
Rakefile
Versionfile
spree_salecycle.gemspec

README.md

SpreeSalecycle

Salecycle provides a pre-configured implementation of the SaleCycle JavaScript complete with variable population and custom method definition for the easiest possible implementation of SaleCycle's services.

SaleCycle

SaleCycle is a shopping cart recovery service. If a user stops shopping with items in their shopping cart, or abandons the checkout phase without confirming their order, then any information that SaleCycle was able to record throughout the user's window-shopping can be used to re-engage the customer in their shopping or checkout to complete the order.

Much more information is available here: http://www.salecycle.com/

Installation

Add the following to your Gemfile: gem 'spree_salecycle', :git => 'git://github.com/minustehbare/spree-salecycle.git', :branch => '0-70-x'.

Run bundle install

And you should be all set. Finish things up by navigating to the Spree Administration interface, clicking the 'Configuration' tab, selecting 'SaleCycle Settings' from the list, and input your Client ID and application name that were defined/provided from signing up with SaleCycle.

If you have a multi-domain store and are using the SpreeMultiDomain extension you will be able to enter a separate Client ID for each of your stores. This will allow Salecycle to gather cart abandonment and recovery for each of your stores separately.

For your unique Client ID(s) and contractual details, please contact spree@salecycle.com.

Overview

Hooks

The Salecycle extension uses hooks defined by Spree to insert the SaleCycle JavaScript that records user information. In order to track the user's order before, during, and after checkout a series of hooks were defined and can be found in the hooks file here: lib/spree_salecycle_hooks.rb

For inquiring minds, here is a list of the hook locations:

  • **/core/app/views/orders/edit.html.erb
  • **/core/app/views/checkout/edit.html.erb
  • **/core/app/views/shared/_order_details.html.erb

Salecycle Javascript

The _salecycle.html.erb partial provides the SaleCycle JavaScript Array of variables and attempts to set them based on the current state of the order and any settings defined through the Spree Administration interface. It also includes a final JavaScript tag to submit the data to SaleCycle.

Configuration Settings

There are a handful of configuration settings that can be set through the Spree Administration interface. To access these settings, simply navigate to the 'Configuration' tab of the Administration interface and select the 'SaleCycle Settings' link from the list.

Mandatory

In order for SaleCycle to function correctly, the following setting must be defined: :salecycle_client_id. In the case of a multi-domain store, there will be a separate Client ID for each store. Data will only be submitted to SaleCycle for a store if the Client ID is configured for that specific store.

The Client ID(s) is defined or provided as a result of signing up with SaleCycle and must be configured before SaleCycle can receive any information being recorded.

Optional

A client can optionally supply a currency code to be recorded with every purchase. A value of 'GBP' supplied in the settings interface would tell SaleCycle that all orders are valued in British pounds.

Custom

SaleCycle also provides 3 variables which are not already handled by attributes on Products, Variants, or Users in a default Spree environment: :salecycle_custom_field_1, :salecycle_custom_field_2 and :salecycle_user_opt_out_method.

Each of these settings is configurable through the settings interface and has a required format of <receiver>#<method>. For example, if the User model in your application has an attribute of :opt_out then the :salecycle_user_opt_out_method would result in User#opt_out or user#opt_out. Deviations from this format might prove unsavory.

The custom fields provided by SaleCycle traditionally track additional information on Products or Variants. To populate these fields simply define a <receiver>#<method> setting. When evaluating the LineItems of the Order will each issue a line_item.product.send(method) or line_item.variant.send(method), with Products taking precedence over Variants. More information on these fields can be found in the SaleCycle documentation.

Copyright (c) 2011 minustehbare, released under the New BSD License

Something went wrong with that request. Please try again.