stall 0.1.3 → 0.2.0

data/lib/stall/checkout/informations_checkout_step.rb

@@ -1,20 +1,65 @@
 module Stall
   module Checkout
     class InformationsCheckoutStep < Stall::Checkout::Step
+      validations do
+        validate :customer_accepts_terms
+        validates :customer, :shipping_address, presence: true
+
+        validates :billing_address, presence: true,
+          if: :use_another_address_for_billing?
+
+        nested :shipping_address do
+          validates :civility, :first_name, :last_name, :address, :country,
+                    :zip, :city, presence: true
+        end
+
+        nested :billing_address do
+          validates :civility, :first_name, :last_name, :address, :country,
+                    :zip, :city, presence: true
+        end
+      end
+
       def prepare
         ensure_customer
-        ensure_address(:billing)
-        ensure_address(:shipping)
+        prefill_addresses_from_customer
+        ensure_shipment
+        ensure_payment
       end
 
       def process
+        prepare_user_attributes
         cart.assign_attributes(cart_params)
         process_addresses
-        cart.save if valid?
+
+        return unless valid?
+
+        cart.save.tap do |valid|
+          assign_addresses_to_customer!
+          calculate_shipping_fee!
+        end
       end
 
       private
 
+      def cart_params
+        @cart_params ||= params.require(:cart).permit(
+          :use_another_address_for_billing, :terms,
+          :payment_method_id, :shipping_method_id,
+          customer_attributes: [
+            :email, user_attributes: [
+              :password, :password_confirmation
+            ]
+          ],
+          address_ownerships_attributes: [
+            :id, :shipping, :billing,
+            address_attributes: [
+              :id, :civility, :first_name, :last_name, :address,
+              :address_details, :country, :zip, :city, :phone
+            ]
+          ]
+        )
+      end
+
       def ensure_customer
         cart.build_customer unless cart.customer
       end
@@ -24,18 +69,92 @@ module Stall
         ownership.address || ownership.build_address
       end
 
-      def process_addresses
-        unless params[:use_another_address_for_billing]
-          # Remove submitted billing address
-          if (billing_ownership = cart.address_ownership_for(:billing))
-            cart.address_ownerships.destroy(billing_ownership)
-          end
-
-          # Set shipping address as the billing one
-          if (shipping_ownership = cart.address_ownership_for(:shipping))
-            shipping_ownership.billing = true
-          end
+      def ensure_billing_address
+        return ensure_address(:billing) unless cart_params[:use_another_address_for_billing] == '0'
+
+        # If the form was submitted and we merged both shipping and billing
+        # addresses together, we must separate them back to present them to
+        # the user form, avoiding to render errors in a form that the user
+        # didn't even see before
+        ownership = cart.address_ownership_for(:billing)
+        ownership.billing = false if ownership.shipping
+        ensure_address(:billing)
+      end
+
+      def ensure_shipment
+        cart.build_shipment unless cart.shipment
+      end
+
+      def ensure_payment
+        cart.build_payment unless cart.payment
+      end
+
+      # Remvove user attributes when no account should be created, for an
+      # "anonymous" order creation.
+      #
+      def prepare_user_attributes
+        return if params[:create_account] == '1'
+
+        if cart_params[:customer_attributes] && cart_params[:customer_attributes][:user_attributes]
+          cart_params[:customer_attributes].delete(:user_attributes)
         end
+
+        # Remove user from customer to avoid automatic validation of the user
+        # if no user should be saved with the customer
+        unless stall_user_signed_in? || cart.customer.try(:user).try(:persisted?) ||
+          !cart.customer
+        then
+          cart.customer.user = nil
+        end
+      end
+
+      # Merges shipping and billing addresses into one address when the visitor
+      # has chosen to use the shipping address for both.
+      #
+      def process_addresses
+        return if use_another_address_for_billing?
+
+        shipping_ownership = cart.address_ownership_for(:shipping)
+        billing_ownership = cart.address_ownership_for(:billing)
+
+        return if billing_ownership == shipping_ownership
+
+        # If the user choosed to receive his order by shipping and that he
+        # choosed not to fill a billing address, we remove the billing address
+        # hidden form that was submitted in the step, and make the shipping
+        # address be used as billing address too
+        cart.address_ownerships.destroy(billing_ownership) if billing_ownership
+        cart.mark_address_ownership_as_billing(shipping_ownership) if shipping_ownership
+      end
+
+      # Assigns the shipping fees to the cart based on the selected shipping
+      # method
+      #
+      def calculate_shipping_fee!
+        service_class = Stall.config.service_for(:shipping_fee_calculator)
+        service_class.new(cart).call
+      end
+
+      # Fetches addresses from the customer account and copy them to the
+      # cart to pre-fill the fields for the user
+      #
+      def prefill_addresses_from_customer
+        Stall::Addresses::PrefillTargetFromSource.new(cart.customer, cart).copy
+      end
+
+      # Copies the addresses filled in the cart to the customer account for
+      # next orders informations pre-filling
+      #
+      def assign_addresses_to_customer!
+        Stall::Addresses::CopySourceToTarget.new(cart, cart.customer).copy!
+      end
+
+      def use_another_address_for_billing?
+        @use_another_address_for_billing ||= cart_params[:use_another_address_for_billing] == '1'
+      end
+
+      def customer_accepts_terms
+        cart.errors.add(:terms, :accepted) unless cart.terms == '1'
       end
     end
   end

data/lib/stall/checkout/payment_checkout_step.rb

@@ -1,8 +1,22 @@
 module Stall
   module Checkout
     class PaymentCheckoutStep < Stall::Checkout::Step
+      # Determine wether the customer's payment has been validated or not.
+      #
+      # By default, the payment processing occurs in the background and, for
+      # some of the payment gateways, can be run asynchronously. In this case,
+      # the gateway should redirect here with the `:succeeded` param in the URL.
+      #
+      # If the payment processing occurs synchronously, the gateway overrides
+      # the #synchronous_payment_notification? method, using the cart payment
+      # state to determine this parameter.
+      #
       def process
-        return true if params[:succeeded]
+        if gateway.synchronous_payment_notification?
+          cart.paid?
+        elsif params[:succeeded]
+          true
+        end
       end
 
       # When we access this step after a payment to validate the step, the cart
@@ -11,6 +25,12 @@ module Stall
       def allow_inactive_carts?
         !!params[:succeeded]
       end
+
+      private
+
+      def gateway
+        @gateway ||= Stall::Payments::Gateway.for(cart.payment.payment_method).new(cart)
+      end
     end
   end
 end

data/lib/stall/checkout/step.rb

@@ -3,6 +3,8 @@ module Stall
     class StepNotFoundError < StandardError; end
 
     class Step
+      class_attribute :_validations
+
       attr_reader :cart
 
       def initialize(cart)
@@ -27,14 +29,6 @@ module Stall
         save
       end
 
-      def cart_params
-        @cart_params ||= if params[:cart]
-          params.require(:cart).permit!
-        else
-          {}.with_indifferent_access
-        end
-      end
-
       def skip?
         false
       end
@@ -62,6 +56,16 @@ module Stall
         false
       end
 
+      # Run cart validations then step validations, and cart validations, returning wether they're both valid or
+      # not, allowing to display all involved errors to the visitor in one time
+      #
+      def valid?
+        cart.validate
+        run_step_validations!(clear:  false)
+
+        cart.errors.empty?
+      end
+
       # Abstracts the simple case of assigning the submitted parameters to the
       # cart object, running the step validations and saving the cart
       def save
@@ -69,6 +73,14 @@ module Stall
         cart.save if valid?
       end
 
+      private
+
+      def run_step_validations!(clear: true)
+        if (validations = self.class.validations)
+          validations.new(cart, self, clear: clear).validate
+        end
+      end
+
       # Handles conversion from an identifier to a checkout step class, allowing
       # us to specify a list of symbols in our wizard's .step macro
       #
@@ -92,13 +104,8 @@ module Stall
       end
 
       def self.validations(&block)
-        return @validations unless block
-        @validations = Stall::Checkout::StepForm.build(&block)
-      end
-
-      def valid?
-        return true unless (validations = self.class.validations)
-        validations.new(cart, self).validate
+        return _validations unless block
+        self._validations = Stall::Checkout::StepForm.build(&block)
       end
     end
   end

data/lib/stall/checkout/step_form.rb

@@ -5,17 +5,28 @@ module Stall
 
       class_attribute :nested_forms
 
-      attr_reader :object, :step
+      attr_reader :object, :step, :clear_cart_errors_before_validation
 
       delegate :errors, to: :object
 
-      def initialize(object, step)
+      def initialize(object, step, clear: true)
         @object = object
         @step = step
+        @clear_cart_errors_before_validation = clear
       end
 
+      # Runs form and nested forms validations and returns wether they all
+      # passed or not
+      #
+      # Only clear validation errors on the cart if needed, allowing to run
+      # cart validations before the step ones, passing clear: false in the
+      # form constructor, aggregating both validation sources' errors
+      #
       def validate
-        super && validate_nested_forms
+        errors.clear if clear_cart_errors_before_validation
+        run_validations!
+        validate_nested_forms
+        !errors.any?
       end
 
       def self.nested(type, &block)
@@ -23,6 +34,9 @@ module Stall
         nested_forms[type] = build(&block)
       end
 
+      # Build an dynamic StepForm subclass with the given block as the body
+      # of the class
+      #
       def self.build(&block)
         Class.new(StepForm, &block)
       end
@@ -40,7 +54,7 @@ module Stall
       # Override model name instanciation to add a name, since the form classes
       # are anonymous, and ActiveModel::Name does not support unnamed classes
       def model_name
-        @model_name ||= ActiveModel::Name.new(self, nil, object.class.name)
+        @model_name ||= ActiveModel::Name.new(self, nil, self.class.name)
       end
 
       private
@@ -54,12 +68,12 @@ module Stall
       def validate_nested_forms
         # If no nested forms are present in the class, just return true since
         # no validation should be tested
-        return true unless self.class.nested_forms
+        return true unless nested_forms
 
         # Run all validations on all nested forms and ensure they're all valid
-        self.class.nested_forms.map do |name, form|
-          if object.respond_to?(name) && (model = object.send(name))
-            Array.wrap(model).map { |m| form.new(m, step).validate }.all?
+        nested_forms.map do |name, form|
+          if object.respond_to?(name) && (resource = object.send(name))
+            Array.wrap(resource).map { |m| form.new(m, step).validate }.all?
           else
             # Nested validations shouldn't be run on undefined relations
             true

data/lib/stall/config.rb

@@ -1,6 +1,8 @@
 module Stall
   class Config
     extend Stall::Utils::ConfigDSL
+    # Store name used in e-mails and other interfaces duisplaying such an
+    # information
     param :store_name
 
     # Admin e-mail address to which order notifications will be sent
@@ -9,6 +11,9 @@ module Stall
     # E-mail address used to send e-mails to customers
     param :sender_email, -> { ENV['STALL_SENDER_EMAIL'] || 'shop.change_me_in.stall.rb@example.com' }
 
+    # Email regex validation. Taken from Devise
+    param :email_regexp, -> { (defined?(Devise) && Devise.email_regexp) || /\A[^@\s]+@([^@\s]+\.)+[^@\W]+\z/ }
+
     # Default VAT rate
     param :vat_rate, BigDecimal.new('20.0')
 
@@ -27,7 +32,7 @@ module Stall
     param :default_currency, 'EUR'
 
     # Default app domain for building routes
-    param :_default_app_domain
+    param :default_app_domain
 
     # Default checkout wizard used
     param :default_checkout_wizard, 'DefaultCheckoutWizard'
@@ -43,9 +48,14 @@ module Stall
     # Duration after which an empty cart is cleaned out by the rake task
     param :empty_carts_expires_after, 1.day
 
-    # Duration after which an aborted is cleaned out by the rake task
+    # Duration after which an aborted cart is cleaned out by the rake task
     param :aborted_carts_expires_after, 14.days
 
+    param :default_user_model_name, 'User'
+    param :default_user_helper_method, :current_user
+
+    # Configure the terms of service page path
+    param :terms_path, 'about:blank'
 
     def shipping
       @shipping ||= Stall::Shipping::Config.new
@@ -64,7 +74,7 @@ module Stall
     end
 
     def default_app_domain
-      _default_app_domain || ENV['APP_DOMAIN']
+      @default_app_domain || ENV['APP_DOMAIN']
     end
 
     # Fetch user config and add top-namespace lookup to avoid collision
@@ -85,5 +95,9 @@ module Stall
     def services=(value)
       self.services.merge!(value)
     end
+
+    def default_user_model
+      default_user_model_name.try(:constantize)
+    end
   end
 end

data/lib/stall/engine.rb

@@ -4,6 +4,12 @@ module Stall
       Money.default_currency = Stall.config.default_currency
     end
 
+    initializer 'stall.add_routing_mapper_extension' do
+      ActiveSupport.on_load(:action_controller) do
+        ActionDispatch::Routing::Mapper.send(:include, Stall::RoutingMapper)
+      end
+    end
+
     initializer 'stall.override_actionview_number_helpers' do
       ActiveSupport.on_load(:action_view) do
         include Stall::CurrencyHelper

data/lib/stall/payable.rb

@@ -22,5 +22,14 @@ module Stall
 
       delegate :paid?, to: :payment, allow_nil: true
     end
+
+    module ClassMethods
+      def find_by_payment_transaction_id(transaction_id)
+        joins(:payment).where(
+          "stall_payments.data->>'transaction_id' = ?",
+          transaction_id
+        ).first
+      end
+    end
   end
 end

data/lib/stall/payments/gateway.rb

@@ -1,8 +1,6 @@
 module Stall
   module Payments
     class Gateway
-      TRANSACTION_ID_FORMAT = 'ESHOP-%{cart_id}-%{transaction_index}'
-
       attr_reader :cart
 
       def initialize(cart)
@@ -33,9 +31,9 @@ module Stall
           'Subclasses must implement the .response(request) class method '
       end
 
-      def transaction_id
+      def transaction_id(refresh: false)
         @transaction_id ||= begin
-          unless (id = cart.payment.transaction_id)
+          if refresh || !(id = cart.payment.transaction_id)
             id = next_transaction_id
             cart.payment.update_attributes(transaction_id: id)
           end
@@ -50,13 +48,21 @@ module Stall
       # Most of the gateways expect some specific return, so this is to be
       # overriden by subclasses
       def rendering_options
-        { text: nil }
+        { nothing: false }
       end
 
       def payment_urls
         @payment_urls ||= Stall::Payments::UrlsConfig.new(cart)
       end
 
+      # Override this method and retrun true if the gateway payment
+      # notification should be taken into account to determine wether the
+      # payment has been successful or not  when returning from the gateway.
+      #
+      def synchronous_payment_notification?
+        false
+      end
+
       private
 
       def next_transaction_id
@@ -71,10 +77,14 @@ module Stall
       end
 
       def transaction_id_for(index)
-        TRANSACTION_ID_FORMAT
+        transaction_id_format
           .gsub('%{cart_id}', cart.reference)
           .gsub('%{transaction_index}', ('%05d' % index))
       end
+
+      def transaction_id_format
+        'ESHOP-%{cart_id}-%{transaction_index}'
+      end
     end
   end
 end

data/lib/stall/payments/urls_config.rb

@@ -27,8 +27,8 @@ module Stall
       def default_config
         ->(urls) {
           urls.payment_notification_url   = notify_payment_url(gateway: gateway_identifier, host: Stall.config.default_app_domain)
-          urls.payment_success_return_url = process_checkout_step_url(cart.identifier, host: Stall.config.default_app_domain)
-          urls.payment_failure_return_url = process_checkout_step_url(cart.identifier, host: Stall.config.default_app_domain)
+          urls.payment_success_return_url = process_checkout_step_url(cart.identifier, host: Stall.config.default_app_domain, succeeded: true)
+          urls.payment_failure_return_url = process_checkout_step_url(cart.identifier, host: Stall.config.default_app_domain, aborted: true)
         }
       end
 

data/lib/stall/rails/routing_mapper.rb

@@ -1,12 +1,10 @@
 # Routing mapper override to allow mounting the engine as non-isolated, avoiding
 # issues with routes in templates when switching from the app to the engine
 #
-module ActionDispatch
-  module Routing
-    class Mapper
-      def mount_stall(mount_location)
-        Stall::Routes.new(self).draw(mount_location)
-      end
+module Stall
+  module RoutingMapper
+    def mount_stall(mount_location)
+      Stall::Routes.new(self).draw(mount_location)
     end
   end
 end

data/lib/stall/routes.rb

@@ -19,7 +19,10 @@ module Stall
             scope '(:cart_key)' do
               resource :step, only: [:show, :update] do
                 post '/', action: :update, as: :update
-                get '/process', action: :update, as: :process
+                get  '/process', action: :update, as: :process
+                # Allow external URLs process steps, allowing some payment
+                # gateways to return the user through a POST request
+                post '/process', action: :foreign_update
                 get 'change/:step', action: :change, as: :change
               end
             end

data/lib/stall/sellable.rb

@@ -10,8 +10,8 @@ module Stall
 
     def to_line_item
       line_items.build(
-        name: (respond_to?(:name) && name) || (respond_to?(:title) && title),
-        unit_price: (respond_to?(:price) && price),
+        name: (try(:name) || try(:title)),
+        unit_price: try(:price),
         unit_eot_price: eot_price,
         vat_rate: vat_rate,
       )
@@ -21,16 +21,26 @@ module Stall
       (vat_rate / 100.0) + 1
     end
 
+    def currency
+      Money.default_currency
+    end
+
     private
 
     def default_eot_price
-      price && (price / vat_ratio)
+      if (price = try(:price))
+        price / vat_ratio
+      end
     end
 
     def default_vat_rate
       @default_vat_rate ||= Stall.config.vat_rate
     end
 
+    # Create default handlers for the `#eot_price` and `#vat_rate` methods that
+    # don't need to be explictly defined if the whole shop has a single VAT rate
+    # for all products
+    #
     def method_missing(name, *args, &block)
       if [:eot_price, :vat_rate].include?(name)
         send(:"default_#{ name }")

data/lib/stall/version.rb

@@ -1,3 +1,3 @@
 module Stall
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/stall.rb

@@ -16,6 +16,7 @@ module Stall
 
   autoload :Sellable
   autoload :Addressable
+  autoload :Addresses
   autoload :Priceable
   autoload :Payable