stall 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8be8383152aa8e6949b5ff132d32521541d15625
-  data.tar.gz: b62bad7b2c986d09c579bee22d959c4984dda358
+  metadata.gz: 0524d2c5e775b699249a9e311d7eb05f2a28329a
+  data.tar.gz: f13ac7bc4efa4013a6cabf3d92214669832b2610
 SHA512:
-  metadata.gz: 3931aee7e76b2e07d36b8f9f62e2e7fa89688195da6fd3fea8c5d1f0bd57f7b3e92343cea51ea4e734700dc0f81ba160c7117ed1fa1ce6928802d917cf7b26f6
-  data.tar.gz: dd6a569d77cdd85bad7832ffe7aa9dbc21e6fd6450d4ec23e8399063c8c4c688147566cfec61faa5e19aa8977864d3e0fe22c858fb22a3518bb3e6689da7402c
+  metadata.gz: d25def30d139c976bbcc3c25635bcc4321dc152b008c62ea4b9d64798b6402b0d1715625e14763588ee3b0d23bef7d88c9591bbc230d9b31ad486d3c8d147544
+  data.tar.gz: c4a3e2c50f5770ad510c1cf8dce6329526e8dc3b5c16172960150976d0ea6ad75b3c87cf4f6735f1c345680a685ba6b6caf02c18352fe17610a0439d624fc337

data/README.md

@@ -65,6 +65,51 @@ The checkout process is completely flexible and can be overriden easily.
 Please see the Wiki page :
 [The checkout process](https://github.com/rails-stall/stall/wiki/The-checkout-process)
 
+
+### Cleaning up aborted carts
+
+A cart is created for each new visit on the app. You may want to clean
+aborted carts to avoid the table to grow too big.
+
+You can setup the provided `rake` task in a cron :
+
+```bash
+rake stall:carts:clean
+```
+
+#### Configuring what is cleaned in the task
+
+Two types of aborted carts are cleaned :
+
+- Empty carts older than 24h
+- Aborted carts, with products added, older than 2 weeks
+
+You can configure both delays with the following config in the stall initializer :
+
+```ruby
+config.empty_carts_expires_after = 1.day
+config.aborted_carts_expires_after = 14.days
+```
+
+#### Cleaning other types of ProductList
+
+You can create your own cart classes by extending the `Cart` or `ProductList`
+model in your app.
+
+To clean those models, you just need to pass the cart class name to the rake
+task when calling it. For a `TestCart` model, you'd do :
+
+```bash
+rake stall:carts:clean[TestCart]
+```
+
+> **Note** : that double-quotes may be needed around the task name to make that
+syntax work with some shells (e.g. zsh) : `rake "stall:carts:clean[TestCart]"`
+
+You can also override in your subclass the way that the task retrieves aborted
+carts by defining a scope or class method `.aborted(options)` where `options`
+may contain a `:before` option.
+
 # Licence
 
 This project rocks and uses MIT-LICENSE.

data/app/assets/javascripts/stall.coffee

@@ -1,6 +1,8 @@
 #= require vertebra
+#= require cocoon
 #= require_self
 #= require stall/add-to-cart-form
+#= require stall/cart-form
 
 @Stall =
   onDomReady: (callback) ->

data/app/assets/javascripts/stall/cart-form.coffee

@@ -0,0 +1,23 @@
+class Stall.CartForm extends Vertebra.View
+  events:
+    'change [data-quantity-field]': 'formUpdated'
+    'cocoon:after-remove': 'formUpdated'
+    'ajax:success': 'updateSuccess'
+
+  initialize: ->
+    @clean()
+
+  clean: ->
+    @$('[data-cart-update-button]').hide(0)
+
+  formUpdated: (e) ->
+    @$el.submit()
+
+  updateSuccess: (e, resp) ->
+    $form = $(resp).find('[data-cart-form]')
+    @$el.html($form.html())
+    @clean()
+
+Stall.onDomReady ->
+  if ($cartForm = $('[data-cart-form]')).length
+    new Stall.CartForm(el: $cartForm)

data/app/controllers/stall/application_controller.rb

@@ -1,13 +1,21 @@
 module Stall
   class ApplicationController < Stall.config.application_controller_ancestor.constantize
-    layout :_set_stall_layout
+    before_action :set_request_variant
+    layout :set_stall_layout
 
     private
 
+    def set_request_variant
+      request.variant = :xhr if request.xhr?
+    end
+
     # Enforce app-level layout by defaulting to the "application" layout if
     # no parent layout was set before, thus avoiding the "stall/application"
     # layout to be rendered
-    def _set_stall_layout
+    def set_stall_layout
+      return false if request.xhr?
+      return Stall.config.default_layout if Stall.config.default_layout
+
       parent_controller = self.class.ancestors.find do |ancestor|
         !ancestor.name.match(/^Stall::/)
       end

data/app/controllers/stall/carts_controller.rb

@@ -1,28 +1,49 @@
 module Stall
-  class CartsController < ApplicationController
-    before_action :load_cart
+  class CartsController < Stall::ApplicationController
+    before_action :load_cart, except: :show
 
     def show
+      @cart = ProductList.find_by_token(params[:id]) || current_cart
     end
 
     def update
-      if @cart.update_attributes(cart_params)
-        flash[:success] = t('stall.carts.flashes.update.success')
-        redirect_to cart_path(@cart)
-      else
-        flash[:error] = t('stall.carts.flashes.update.error')
-        render 'show'
+      respond_to do |format|
+        service = Stall::CartUpdateService.new(@cart, cart_params)
+
+        if service.call
+          format.html.xhr do
+            render 'show'
+          end
+
+          format.html.any do
+            flash[:success] = t('stall.carts.flashes.update.success')
+            redirect_to cart_path(@cart)
+          end
+        else
+          format.html.xhr do
+            render 'show'
+          end
+
+          format.html.any do
+            flash[:error] = t('stall.carts.flashes.update.error')
+            render 'show'
+          end
+        end
       end
     end
 
     private
 
     def load_cart
-      @cart = Cart.find_by_token(params[:id])
+      @cart = ProductList.find_by_token!(params[:id])
     end
 
     def cart_params
-      params.require(:cart).permit(line_items_attributes: [:id, :quantity])
+      params.require(:cart).permit(
+        line_items_attributes: [
+          :id, :quantity, :_destroy
+        ]
+      )
     end
   end
 end

data/app/controllers/stall/checkout/steps_controller.rb

@@ -3,6 +3,8 @@ module Stall
     class StepsController < Stall::ApplicationController
       include Stall::CheckoutHelper
 
+      before_action :load_cart
+      before_action :ensure_cart_checkoutable
       before_action :load_step
 
       def show
@@ -12,21 +14,51 @@ module Stall
       def update
         if @step.process
           @wizard.validate_current_step!
-          redirect_to step_path(@cart)
+          redirect_to step_path
         else
           @step.prepare
-          flash[:error] = t("stall.checkout.#{ @wizard.current_step_name }.error")
+          flash[:error] ||= t("stall.checkout.#{ @wizard.current_step_name }.error")
+          render 'show'
+        end
+      end
+
+      def change
+        target_step = params[:step]
+
+        if @wizard.step_complete?(target_step)
+          @wizard.move_to_step!(target_step)
+          redirect_to step_path
+        else
+          @step.prepare
+          flash[:error] ||= t("stall.checkout.#{ target_step }.error")
           render 'show'
         end
       end
 
       private
 
+      def load_cart
+        @cart = current_cart
+      end
+
+      def ensure_cart_checkoutable
+        unless @cart.checkoutable?
+          flash[:error] = t('stall.checkout.shared.not_checkoutable')
+          redirect_to request.referrer || root_path
+        end
+      end
+
       def load_step
-        @cart = Stall::Cart.find_by_token(params[:cart_id])
         @wizard = @cart.wizard.new(@cart)
 
-        @step = @wizard.initialize_current_step(params) do |step|
+        @step = @wizard.initialize_current_step do |step|
+          # Inject request dependent data
+          step.inject(:params, params)
+          step.inject(:session, session)
+          step.inject(:cookies, cookies)
+          step.inject(:request, request)
+          step.inject(:flash, flash)
+
           if Stall.config.steps_initialization
             instance_exec(step, &Stall.config.steps_initialization)
           end

data/app/controllers/stall/checkouts_controller.rb

@@ -1,9 +1,18 @@
 module Stall
-  class CheckoutsController < ApplicationController
+  class CheckoutsController < Stall::ApplicationController
+    include CheckoutHelper
+
+    before_action :load_cart
+
     def show
-      @cart = Stall::Cart.find_by_token(params[:id])
       @cart.reset_state!
-      redirect_to checkout_step_path(@cart.wizard.route_key, @cart)
+      redirect_to step_path
+    end
+
+    private
+
+    def load_cart
+      @cart = current_cart
     end
   end
 end

data/app/controllers/stall/line_items_controller.rb

@@ -1,7 +1,7 @@
 module Stall
-  class LineItemsController < ApplicationController
+  class LineItemsController < Stall::ApplicationController
     def create
-      service = Stall::AddToCartService.new(cart, line_item_params)
+      service = Stall.config.service_for(:add_to_cart).new(cart, line_item_params)
 
       if service.call
         @quantity = params[:line_item][:quantity].to_i
@@ -20,7 +20,7 @@ module Stall
     end
 
     def cart
-      @cart ||= Stall::Cart.find_by_token(params[:cart_id])
+      @cart ||= ProductList.find_by_token(params[:cart_id]) || current_cart
     end
   end
 end

data/app/controllers/stall/payments_controller.rb

@@ -1,7 +1,9 @@
 module Stall
-  class PaymentsController < ApplicationController
-    def process
-      service = Stall::PaymentNotificationService.new(request)
+  class PaymentsController < Stall::ApplicationController
+    skip_before_action :verify_authenticity_token, only: [:notify]
+
+    def notify
+      service = Stall.config.service_for(:payment_notification).new(params[:gateway], request)
       service.call
       render service.rendering_options
     end

data/app/helpers/stall/add_to_cart_helper.rb

@@ -3,7 +3,7 @@ module Stall
     def add_to_cart_form_for(sellable, cart: nil)
       render partial: 'stall/line_items/form', locals: {
         cart: (cart || current_cart),
-        line_item: Stall::LineItem.new(sellable: sellable)
+        line_item: LineItem.new(sellable: sellable)
       }
     end
   end

data/app/helpers/stall/checkout_helper.rb

@@ -1,7 +1,27 @@
 module Stall
   module CheckoutHelper
-    def step_path(cart)
-      checkout_step_path(cart.wizard.route_key, cart)
+    def step_path(*args)
+      checkout_step_path(*([current_cart_key] + args))
+    end
+
+    def available_shipping_methods_for(cart)
+      ShippingMethod.active.ordered.select do |shipping_method|
+        calculator_class = Stall::Shipping::Calculator.for(shipping_method)
+
+        unless calculator_class
+          raise Stall::Shipping::CalculatorNotFound,
+                "No calculator found for the shipping method : " +
+                "#{ shipping_method.name } " +
+                "(#{ shipping_method.identifier }). " +
+                "Please remove the Stall::ShippingMethod with id " +
+                "#{ shipping_method.id } or create the associated " +
+                "calculator with `rails g stall:shipping:calculator " +
+                "#{ shipping_method.identifier }`"
+        end
+
+        calculator = calculator_class.new(cart, shipping_method)
+        calculator.available?
+      end
     end
   end
 end

data/app/helpers/stall/payments_helper.rb

@@ -0,0 +1,8 @@
+module Stall
+  module PaymentsHelper
+    def payment_button_for(cart)
+      request = Stall::Payments::Gateway.for(cart.payment.payment_method).request(cart)
+      render partial: request.payment_form_partial_path, locals: { request: request }
+    end
+  end
+end

data/app/mailers/stall/admin_mailer.rb

@@ -0,0 +1,11 @@
+module Stall
+  class AdminMailer < Stall::BaseMailer
+    def order_paid_email(cart)
+      @cart = cart
+
+      mail from: sender_email_for(cart),
+           to: admin_email_for(cart),
+           subject: I18n.t('stall.mailers.admin.order_paid_email.subject', ref: cart.reference)
+    end
+  end
+end

data/app/mailers/stall/base_mailer.rb

@@ -0,0 +1,17 @@
+module Stall
+  class BaseMailer < Stall.config.mailers_parent_class.constantize
+    private
+
+    def sender_email_for(cart)
+      value_for(Stall.config.sender_email, cart)
+    end
+
+    def admin_email_for(cart)
+      value_for(Stall.config.admin_email, cart)
+    end
+
+    def value_for(config, cart)
+      Proc === config ? config.call(cart) : config
+    end
+  end
+end

data/app/mailers/stall/customer_mailer.rb

@@ -0,0 +1,13 @@
+module Stall
+  class CustomerMailer < Stall::BaseMailer
+    def order_paid_email(cart)
+      I18n.with_locale(cart.customer.locale) do
+        @cart = cart
+
+        mail from: sender_email_for(cart),
+             to: cart.customer.email,
+             subject: I18n.t('stall.mailers.customer.order_paid_email.subject', ref: cart.reference)
+      end
+    end
+  end
+end

data/app/models/address.rb

@@ -0,0 +1,3 @@
+class Address < ActiveRecord::Base
+  include Stall::Models::Address
+end

data/app/models/address_ownership.rb

@@ -0,0 +1,3 @@
+class AddressOwnership < ActiveRecord::Base
+  include Stall::Models::AddressOwnership
+end

data/app/models/adjustment.rb

@@ -0,0 +1,3 @@
+class Adjustment < ActiveRecord::Base
+  include Stall::Models::Adjustment
+end

data/app/models/cart.rb

@@ -0,0 +1,3 @@
+class Cart < ::ProductList
+  include Stall::Models::Cart
+end

data/app/models/customer.rb

@@ -0,0 +1,3 @@
+class Customer < ActiveRecord::Base
+  include Stall::Models::Customer
+end

data/app/models/line_item.rb

@@ -0,0 +1,3 @@
+class LineItem < ActiveRecord::Base
+  include Stall::Models::LineItem
+end

data/app/models/payment.rb

@@ -0,0 +1,3 @@
+class Payment < ActiveRecord::Base
+  include Stall::Models::Payment
+end

data/app/models/payment_method.rb

@@ -0,0 +1,3 @@
+class PaymentMethod < ActiveRecord::Base
+  include Stall::Models::PaymentMethod
+end

data/app/models/product_list.rb

@@ -0,0 +1,3 @@
+class ProductList < ActiveRecord::Base
+  include Stall::Models::ProductList
+end

data/app/models/shipment.rb

@@ -0,0 +1,3 @@
+class Shipment < ActiveRecord::Base
+  include Stall::Models::Shipment
+end