assets/checkout.gif @@ -1,6 +1,12 @@ # Spree Pp Website Standard -Overrides the default Spree checkout process and uses offsite payment processing via PayPal's Website Payment Standard. There are also `after_notify` and `after_success` hooks which allow you to implment your own custom logic after the standard processing is performed. These hooks should be added to `checkout_controller` in the extension you are using for your site specific customizations. +Overrides the default Spree checkout process and uses offsite payment processing via PayPal's Website Payment Standard (WPS). + +You'll want to test this using a paypal sandbox account first. Once you have a business account, you'll want to turn on Instant Payment Notification (IPN). This is how your application will be notified when a transaction is complete. Certain transactions aren't completed immediately. Because of this we use IPN for your application to get notified when the transaction is complete. IPN means that our application gets an incoming request from Paypal when the transaction goes through. To turn IPN on in your sandbox account, login, hit "profile", and go to Instant Payment Notification Preferences. You'll need to turn it on, and point it to your http://www.yourdomain.com/notify. + +Regarding Taxes and shipping, we assumed you'd want to use Paypal's system for this, which can also be configured through the "profile" page. Taxes have been tested (sales tax), but not shipping, so you may want to give that a test run on the sandbox. + +There are also `after_notify` and `after_success` hooks which allow you to implment your own custom logic after the standard processing is performed. These hooks should be added to `checkout_controller` in the extension you are using for your site specific customizations. For example: @@ -16,6 +22,8 @@ CheckoutController.class_eval do end </pre> + + * TODO: User account creation (if necessary) after notify and associate order with a user * TODO: Make the paypal account stuff configurable via new preferences system * TODO: Taxes README.markdown @@ -1,7 +1,14 @@ class CheckoutController < Spree::BaseController + before_filter :verify_authenticity_token, :except => 'notify' include ActiveMerchant::Billing::Integrations + # When people hit the checkout button from other pages + # Bring them to the cart where we have them fill out the form + def index + redirect_to :controller => 'cart' + end + # You can send in test notifications on the developer page here: # https://developer.paypal.com/us/cgi-bin/devscr?cmd=_ipn-link-session def notify @@ -10,17 +17,17 @@ class CheckoutController < Spree::BaseController # create a transaction which records the details of the notification @payment.txns.build :transaction_id => ipn.transaction_id, :amount => ipn.gross, :fee => ipn.fee, - :currency_type => ipn.currency_type, :status => ipn.status, :received_at => ipn.received_at + :currency_type => ipn.currency, :status => ipn.status, :received_at => ipn.received_at @payment.save if ipn.acknowledge case ipn.status when "Completed" - if ipn.gross == @order.total + if ipn.gross.to_f == @order.total.to_f @order.status = Order::Status::PAID else @order.status = Order::Status::INCOMPLETE - logger.error("Incorrect order total during Paypal's notification, please investigate") + logger.error("Incorrect order total during Paypal's notification, please investigate (Paypal processed #{ipn.gross}, and order total is #{@order.total})") end when "Pending" @order.status = Order::Status::PENDING_PAYMENT @@ -37,23 +44,27 @@ class CheckoutController < Spree::BaseController # call notify hook (which will email users, etc.) after_notify(@payment) if @order.status == Order::Status::PAID + + render :nothing => true end # When they've returned from paypal + # Not really "success" as in they've paid. "Success" as in the transaction is in progress + # Notify is called when the transaction is successfull def success ref_hash = params[:invoice] - @order = find_order(ref_hash) + @order = find_order(ref_hash) # create a transaction for the order (record what little information we have from paypal) - @payment.txns.build :amount => params[:mc_gross], :status => "order-success" + @payment.txns.build :amount => params[:mc_gross], :status => "order-processed" @payment.save # call success hook (which will email users, etc.) after_success(@payment) # Render thank you (unless redirected by hook of course) - redirect_to :action => :thank_you, :id => @order.id and return + redirect_to :action => :thank_you, :id => @order.number and return end def after_notify(payment) @@ -65,7 +76,7 @@ class CheckoutController < Spree::BaseController end def thank_you - @order = Order.find(params[:id]) + @order = Order.find_by_number(params[:id]) end private @@ -82,6 +93,9 @@ class CheckoutController < Spree::BaseController # Create a payment for the order @payment = PaypalPayment.create(:reference_hash => ref_hash) @order.paypal_payment = @payment + # Get the tax & shipping + @order.tax_amount = params[:tax].to_f if params[:tax] + @order.ship_amount = params[:mc_shipping].to_f if params[:mc_shipping] @order.save # Destroy the cart (optimistic locking for the cart in case notify is racing us) cart.destroy app/controllers/checkout_controller.rb @@ -1,12 +1,11 @@ <% if RAILS_ENV == 'development' %> -<form action="https://www.sandbox.paypal.com/cgi-bin/webscr" method="post"> +<form action="https://www.sandbox.paypal.com/cgi-bin/webscr" method="post" onsubmit="return check_zipcode();"> <% else %> <form action="https://www.paypal.com/cgi-bin/webscr" method="post"> <% end %>  -<input name="commit" type="submit" value="Make Payment" /> <input id="business" name="business" type="hidden" value="joe@bidness.com" /> <input id="invoice" name="invoice" type="hidden" value="<%= @cart.reference_hash %>" /> @@ -17,15 +16,19 @@ <input id="quantity_<%= index + 1 %>" name="quantity_<%= index + 1 %>" type="hidden" value="<%= item.quantity %>" /> <% end %> -<input id="amount" name="amount" type="hidden" value="58.97" /> + <input name="no_shipping" type="hidden" value="1" /> <input id="cmd" name="cmd" type="hidden" value="_cart" /> <input type="hidden" name="upload" value="1" /> -<input id="country" name="country" type="hidden" value="US" /> -<input id="zip" name="zip" type="hidden" value="32828" /> - +<p> Please select your country <select name="country" id="country"> +<%= country_options_for_select('United States', ['United States']) %> +</select></p> +<span style="color:red; font-weight:bold; display:none;" id="needZipcode">Please enter a valid zipcode.</span> +<p> +Zipcode (if you have one): <input id="zip" name="zip" type="text" value="" /> +</p> <input id="notify_url" name="notify_url" type="hidden" value="http://72.189.229.38:3000/notify" /> <input id="return" name="return" type="hidden" value="http://localhost:3000/checkout/success" /> @@ -35,12 +38,25 @@ <input id="no_note" name="no_note" type="hidden" value="1" /> <input id="no_shipping" name="no_shipping" type="hidden" value="1" /> <input id="item_name" name="item_name" type="hidden" value="Store purchase" /> - - <input id="return" name="return" type="hidden" value="http://localhost:3000/account/show" /> <input id="currency_code" name="currency_code" type="hidden" value="USD" /> <input id="cancel_return" name="cancel_return" type="hidden" value="http://localhost:3000/account/show" /> <input id="custom" name="custom" type="hidden" value="11" /> <input id="item_number" name="item_number" type="hidden" value="11" / -->  -</form> \ No newline at end of file + +<input name="commit" type="submit" value="Make Payment" /> + +</form> + + +<script type="text/javascript" charset="utf-8"> + function check_zipcode () { + if ($('country').value == "United States" && ($('zip').value == null || $('zip').value.length < 5)) { + $('needZipcode').show(); + return false; + } else { + return true; + } + } +</script> \ No newline at end of file app/views/cart/_paypal_checkout.erb @@ -1,16 +1,16 @@ <div id="shopping-cart"> - <h1><%= :shopping_cart.l("Shopping Cart") %></h1> + <h1><%= t("Shopping Cart") %></h1> <%=error_messages_for :cart_item%> <% form_tag do-%> <table class="cart-summary" width="100% "> <tr> - <th colspan="2"><%= :item.l("Item") %></th> - <th><%= :price.l("Price") %></th> - <th><%= :qty.l %></th> + <th colspan="2"><%= t("Item") %></th> + <th><%= t("Price") %></th> + <th><%= t("Qty") %></th>  - <th><%= :total.l("Total") %></th> + <th><%= t("Total") %></th> </tr> <% for @item in @cart_items %> <tr class="<%= cycle('even', 'odd') %>"> @@ -22,30 +22,29 @@ <%= variant_options @item.variant %><br/> <%=truncate(@item.variant.product.description, length = 100, truncate_string = "...")-%> </td> - <td valign="top" width="75">$ <%= sprintf("%0.2f", @item.price) %></td> + <td valign="top" width="75"><%= number_to_currency(@item.price) %></td> <td valign="top" width="50"><%= text_field "item[]", :quantity, :size => 3 -%></td> - <td valign="top" width="75">$ <%= sprintf("%0.2f", @item.price * @item.quantity) unless @item.quantity.nil? %></td> + <td valign="top" width="75"><%= number_to_currency(@item.price * @item.quantity) unless @item.quantity.nil? %></td> </tr> <% end %> </table> <div id="subtotal"> - <h3><%= :subtotal.l("Subtotal") %> $ <%= sprintf("%0.2f", @cart.total) %></h3> - <%= submit_tag :update.l('Update') %> - + <h3><%= "#{t("Subtotal")}: #{number_to_currency(@cart.total)}" %></h3> + <%= submit_tag t('Update') %> + <% end %> + <%= render :partial => 'paypal_checkout' %> </div> - <% end %> + <%if previous_location %> - <p><%=link_to :continue_shopping.l("Continue Shopping"), products_path %></p> + <p><%=link_to t("Continue Shopping"), products_path %></p> <%end%> <% unless @cart.cart_items.empty? %> <p id="clear_cart_link"> <small> - <%= link_to :empty_cart.l("Empty Cart"), :action => 'empty' %> + <%= link_to t("Empty Cart"), :action => 'empty' %> </small> </p> <% end %> </div> - -<%= render :partial => 'paypal_checkout' %> \ No newline at end of file app/views/cart/index.html.erb @@ -1,16 +1,21 @@ # Uncomment this if you reference any of your controllers in activate require_dependency 'application' +unless RAILS_ENV == 'production' + PAYPAL_ACCOUNT = 'joe@bidness.com' + ActiveMerchant::Billing::Base.mode = :test +else + PAYPAL_ACCOUNT = 'Gregg@railsenvy.com' +end + class PpWebsiteStandardExtension < Spree::Extension version "1.0" description "Describe your extension here" url "http://yourwebsite.com/spree_pp_website_standard" - # define_routes do |map| - # map.namespace :admin do |admin| - # admin.resources :whatever - # end - # end + define_routes do |map| + map.notify '/notify', :controller => 'checkout', :action => 'notify' + end def activate pp_website_standard_extension.rb @@ -55,7 +55,7 @@ describe CheckoutController do describe "when the order total is not verified" do before(:each) do - @order.should_receive(:total).and_return(1) + @order.should_receive(:total).twice.and_return(1) end it "should change the order status to incomplete" do @order.should_receive(:status=).with(Order::Status::INCOMPLETE) spec/controllers/checkout_controller_spec.rb 3913ae2da0bd8adc75d93c83b52a6455e4e089fc Gregg Pollack Gregg@RailsEnvy.com http://github.com/Gregg/spree-pp-website-standard/commit/dc0eaafed3dac7627e4382c5a3d43c9ab3476540 dc0eaafed3dac7627e4382c5a3d43c9ab3476540

2008-08-11T14:35:58-07:00

Fixed notify, fixed a few redirects, added fields for tax collection 983f47b4a39e76b7f04bd9af994004f6cd330f3c Gregg Pollack Gregg@RailsEnvy.com