049770056d
* removed the deface override that modified the checkout/_delivery partial * created custom digital delivery calculator * removed digital_shipping_method from Spree::Order. Moved logic to available_shipping_methods monkey patch The main goal was to eliminate the shipping method detection logic from the _delivery partial. This was a bit of a hack all along and didn't really present the correct information to the underlying order logic (i.e. rate_hash.blank? would return true when there was no shipping options available). This should be more future proof and make overriding another aspect of the delivery process easier.
97 lines
5.1 KiB
Plaintext
97 lines
5.1 KiB
Plaintext
h1. Spree Digital
|
|
|
|
This is a spree extension to enable downloadable products. The design goal is to keep it robust. It should survive future spree versions out of the box.
|
|
|
|
The master branch is compatible with Spree 1.1.x, <= 1.0 versions are referenced in the Versionfile.
|
|
|
|
The idea is simple. You attach a file to a Product (or a Variant of this Product) and when people buy it, they will receive a link via email where they can download it once. There are a few assumptions that spree_digital (currently) makes and it's important to be aware of them.
|
|
|
|
* The table structure of spree_core is not touched. Spree_digital lives parallel to spree_core and does not do any changes to your existing database, except adding two new tables.
|
|
* The download links will be sent via email in the order confirmation (or "resend" from the admin section). The links do *not* appear in the order "overview" that the customer sees.
|
|
* There should only be "live" payments. Once the order is checked-out, the download links will immediately be sent (i.e. in the order confirmation).
|
|
* You should create a ShippingMethod based on the Digital Delivery calculator type. The default cost for digital delivery is 0, but you can define a flat rate (creating a per-item digital delivery fee would be possible as well).
|
|
* One may buy several items of the same digital product in one cart. The customer will simply receive several links by doing so. This allows customer's to legally purchase multiple copies of the same product and maybe give one away to a friend.
|
|
* The links will only work 3 times (but we tell the customer that it works only once). After 24 hours the links are deactivated. This should keep you reasonably free from complaints of people who are not capable of appropriately clicking on a link. They can try a whole day long, 3 times per link. The file should really be downloadable for weird customers. I understand that this is a little bit security by obscurity, but it's better than other solutions that I've seen. The number of clicks and days the links are valid for is customizable via preferences.
|
|
* The file @views/order_mailer/confirm_email.text.erb@ is the only thing that should need customization. But since I assume you do that anyway, it doesn't hurt to do it when you're using spree_digital. The reason is that the download links are added to the confirmation email to the customer. "http://github.com/iloveitaly/spree-html-email":http://github.com/iloveitaly/spree-html-email also supports spree_digital.
|
|
* A purchased product can be downloaded even if you disable the product immediately. You would have to remove the attached file in your admin section to prevent people from downloading purchased products.
|
|
* File are uploaded to @rails_root/private@. Make sure it's symlinked in case you're using Capistrano.
|
|
* We use send_file to send the files on download. Yes, it goes through the entire stack right now.
|
|
|
|
h2. Installation
|
|
|
|
I assume that you already have a Rails 3 Spree application up and running. If not, the "Spree Documentation":http://spreecommerce.com/documentation will help you getting started.
|
|
|
|
To make use of @digital_spree@, you need to add this line to your @Gemfile@:
|
|
|
|
<pre>
|
|
gem 'spree_digital', :git => 'git://github.com/funkensturm/spree_digital.git', :branch => 'master'
|
|
</pre>
|
|
|
|
The following terminal commands will copy the file "spree_digital/db/migration/20110410134726_create_digitals.rb":http://github.com/funkensturm/spree_digital/blob/master/db/migrate/20110410134726_create_digitals.rb to the corresponding directory in your Rails application and apply the migration to your database.
|
|
|
|
<pre>
|
|
rake spree_digital:install
|
|
rake db:migrate
|
|
</pre>
|
|
|
|
This should be all there is to do.
|
|
|
|
h3. Important!
|
|
|
|
You should create a ShippingMethod based on the Digital Delivery calculator type. It will be detected by spree_digital. Otherwise your customer will be forced to choose something like "UPS" even if they purchase only downloadable products.
|
|
|
|
h2. Usage
|
|
|
|
...
|
|
|
|
|
|
h1. Developer Section
|
|
|
|
h3. Table Diagram
|
|
|
|
<img src="http://github.com/funkensturm/spree_digital/raw/master/doc/tables.png">
|
|
|
|
h3. Installation (for Developers)
|
|
|
|
Get the spree framework and spree_digital extension for it:
|
|
|
|
<pre>
|
|
git clone git://github.com/spree/spree.git
|
|
git clone git://github.com/funkensturm/spree_digital
|
|
</pre>
|
|
|
|
Go into the spree directory and run the bundle command:
|
|
|
|
<pre>
|
|
cd spree
|
|
bundle install
|
|
</pre>
|
|
|
|
Go into the spree_digital directory and do the same:
|
|
|
|
NOTE: At this point you may need to uncomment the stuff in the @Gemfile@ before you can start developing and testing!
|
|
|
|
<pre>
|
|
cd spree_digital
|
|
bundle install
|
|
</pre>
|
|
|
|
Bring up the test application (you only need to do this whenever you fiddle around with the migrations) and then you can run the tests as you please.
|
|
|
|
<pre>
|
|
rake test_app
|
|
rake spec
|
|
</pre>
|
|
|
|
This link may be very helpful to you: "http://github.com/spree/spree":http://github.com/spree/spree
|
|
|
|
h3. Authors
|
|
|
|
* "iloveitaly":http://github.com/iloveitaly/
|
|
* "funkensturm":http://github.com/funkensturm
|
|
|
|
h3. License
|
|
|
|
Copyright (c) 2011 funkensturm.
|
|
Released under the MIT License
|
|
See "http://github.com/funkensturm/spree_digital/blob/master/LICENSE":LICENSE |