stall 0.1.1 → 0.1.2

data/lib/stall/checkout/wizard.rb

@@ -19,15 +19,16 @@ module Stall
         @cart = cart
       end
 
-      def initialize_current_step(params, &block)
-        step = current_step.new(cart, params)
-        # This block allows us to let the config inject controller-bound
-        # dependencies to the step just after it is initialized
+      def initialize_current_step(&block)
+        step = current_step.new(cart)
+
+        # This block allows us to let inject controller-bound dependencies
+        # into the step just after it's initialized
         block.call(step) if block
 
         if step.skip?
           validate_current_step!
-          initialize_current_step(params, &block)
+          initialize_current_step(&block)
         else
           step
         end
@@ -56,6 +57,10 @@ module Stall
         step_index && step_index >= steps_count - 1
       end
 
+      def step_complete?(step_identifier)
+        steps.index(cart.state) > steps.index(step_identifier.to_sym)
+      end
+
       def steps_count
         @steps_count ||= steps.length
       end
@@ -65,6 +70,11 @@ module Stall
         cart.save!
       end
 
+      def move_to_step!(target_step)
+        cart.state = target_step
+        cart.save!
+      end
+
       def self.route_key
         name.gsub(/CheckoutWizard/, '').underscore.gsub('_', ' ').parameterize
       end

data/lib/stall/config.rb

@@ -1,6 +1,13 @@
 module Stall
   class Config
     extend Stall::Utils::ConfigDSL
+    param :store_name
+
+    # Admin e-mail address to which order notifications will be sent
+    param :admin_email, -> { ENV['STALL_ADMIN_EMAIL'] || 'admin.change_me_in.stall.rb@example.com' }
+
+    # 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' }
 
     # Default VAT rate
     param :vat_rate, BigDecimal.new('20.0')
@@ -11,9 +18,17 @@ module Stall
     # Engine's ApplicationController parent
     param :application_controller_ancestor, '::ApplicationController'
 
+    param :mailers_parent_class, 'ActionMailer::Base'
+
+    # Default layout used for the checkout
+    param :default_layout
+
     # Default currency for money objects
     param :default_currency, 'EUR'
 
+    # Default app domain for building routes
+    param :_default_app_domain
+
     # Default checkout wizard used
     param :default_checkout_wizard, 'DefaultCheckoutWizard'
 
@@ -23,10 +38,23 @@ module Stall
     # Default step initialization hook
     param :_steps_initialization_callback
 
+    param :services, {}
+
+    # 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
+    param :aborted_carts_expires_after, 14.days
+
+
     def shipping
       @shipping ||= Stall::Shipping::Config.new
     end
 
+    def payment
+      @payment ||= Stall::Payments::Config.new
+    end
+
     def steps_initialization(value = nil, &block)
       if (value ||= block)
         @_steps_initialization_callback = value
@@ -34,5 +62,28 @@ module Stall
         @_steps_initialization_callback
       end
     end
+
+    def default_app_domain
+      _default_app_domain || ENV['APP_DOMAIN']
+    end
+
+    # Fetch user config and add top-namespace lookup to avoid collision
+    # with Stall module services
+    #
+    # Default allows looking up Stall namespace automatically, when no
+    # config has been given
+    def service_for(identifier)
+      class_name = if (service_name = services[identifier])
+        "::#{ services[identifier].gsub(/^::/, '') }"
+      else
+        "Stall::#{ identifier.to_s.camelize }Service"
+      end
+
+      class_name.constantize
+    end
+
+    def services=(value)
+      self.services.merge!(value)
+    end
   end
 end

data/lib/stall/engine.rb

@@ -1,15 +1,37 @@
 module Stall
   class Engine < ::Rails::Engine
-    initializer 'set money gem default currency' do
+    initializer 'stall.set_money_gem_default_currency' do
       Money.default_currency = Stall.config.default_currency
     end
 
-    initializer 'override actionview number helpers' do
+    initializer 'stall.override_actionview_number_helpers' do
       ActiveSupport.on_load(:action_view) do
         include Stall::CurrencyHelper
       end
     end
 
+    initializer 'stall.include_cart_helper' do
+      ActiveSupport.on_load(:action_controller) do
+        include Stall::CartHelper
+      end
+    end
+
+    initializer 'stall.ensure_shipping_method_for_all_calculators' do
+      Stall::Shipping.calculators.each_key do |name|
+        ShippingMethod.where(identifier: name).first_or_create do |method|
+          method.name = name.to_s.humanize
+        end
+      end
+    end
+
+    initializer 'stall.ensure_payment_method_for_all_gateways' do
+      Stall::Payments.gateways.each_key do |name|
+        PaymentMethod.where(identifier: name).first_or_create do |method|
+          method.name = name.to_s.humanize
+        end
+      end
+    end
+
     # Development : Configure rails generators to only generate the target
     # files and not try to generate useless complementary files
     #

data/lib/stall/payable.rb

@@ -0,0 +1,26 @@
+module Stall
+  module Payable
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :payment, dependent: :destroy,
+                        inverse_of: :cart,
+                        foreign_key: :cart_id
+      accepts_nested_attributes_for :payment
+
+      scope :paid, -> {
+        joins(:payment).where.not(stall_payments: { paid_at: nil })
+      }
+
+      scope :finalized, -> { paid }
+
+      scope :aborted, ->(options = {}) {
+        joins('LEFT JOIN stall_payments ON stall_payments.cart_id = stall_product_lists.id')
+          .where(stall_payments: { paid_at: nil })
+          .older_than(options.fetch(:before, 1.day.ago))
+      }
+
+      delegate :paid?, to: :payment, allow_nil: true
+    end
+  end
+end

data/lib/stall/payments.rb

@@ -3,11 +3,15 @@ module Stall
     extend ActiveSupport::Autoload
 
     autoload :Gateway
-
-    # autoload :Config
+    autoload :Config
+    autoload :UrlsConfig
+    autoload :FakeGatewayPaymentNotification
 
     mattr_reader :gateways
-    @@gateways = {}
+    @@gateways = {}.with_indifferent_access
+
+    mattr_reader :payment_urls
+    @@payment_urls = {}.with_indifferent_access
   end
 end
 

data/lib/stall/payments/config.rb

@@ -0,0 +1,37 @@
+module Stall
+  module Payments
+    class Config
+      extend Stall::Utils::ConfigDSL
+
+      # This mehtod allows for registering an in-app gateway that can be
+      # auto loaded without having to explicitly require it
+      #
+      # Use a string representing the gateway name if the target class is
+      # auto-loaded by Rails
+      #
+      def register_gateway(name, gateway)
+        Stall::Payments.gateways[name] = gateway
+      end
+
+      def configure
+        yield self
+      end
+
+      def configure_urls(&block)
+        Stall::Payments::UrlsConfig.config_block = block
+      end
+
+      def method_missing(name, *args)
+        if (gateway = Stall::Payments::Gateway.for(name))
+          if block_given?
+            yield gateway
+          else
+            gateway
+          end
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/stall/payments/fake_gateway_payment_notification.rb

@@ -0,0 +1,34 @@
+module Stall
+  module Payments
+    class FakeGatewayPaymentNotification
+      attr_reader :cart
+
+      def initialize(cart)
+        @cart = cart
+      end
+
+      def params
+        raise 'FakeGatewayPaymentNotification subclasses must define the ' \
+              '#params method to return a valid notification params hash.'
+      end
+
+      def raw_post
+        params.to_query
+      end
+
+      private
+
+      def transaction_id
+        ['FAKE', cart.reference, 0].join('-')
+      end
+
+      def gateway
+        @gateway ||= gateway_class.new(cart)
+      end
+
+      def gateway_class
+        @gateway_class ||= Stall::Payments::Gateway.for(cart.payment.payment_method)
+      end
+    end
+  end
+end

data/lib/stall/payments/gateway.rb

@@ -10,24 +10,27 @@ module Stall
       end
 
       def self.register(name)
-        Stall::Payments.gateways[name] = self
+        Stall.config.payment.register_gateway(name, self)
       end
 
-      def self.cart_id_from(_request)
-        raise NoMethodError,
-          'Subclasses must implement the .cart_id_from(request) class method ' \
-          'to allow retrieving the cart from the remote gateway notification ' \
-          'request object'
+      def self.for(payment_method)
+        identifier = case payment_method
+        when String, Symbol then payment_method.to_s
+        else payment_method.identifier
+        end
+
+        gateway = Stall::Payments.gateways[identifier]
+        String === gateway ? gateway.constantize : gateway
       end
 
-      def self.cart_id_from_transaction_id(transaction_id)
-        transaction_id && transaction_id.split('-')[2].to_i
+      def self.request(cart)
+        raise NoMethodError,
+          'Subclasses must implement the .request(cart) class method '
       end
 
-      def process_payment_for(_request)
+      def self.response(_request)
         raise NoMethodError,
-          'Subclasses must implement the #process_payment_for(request) ' \
-          'method to handle payment verifications and cart payment validation'
+          'Subclasses must implement the .response(request) class method '
       end
 
       def transaction_id
@@ -50,10 +53,14 @@ module Stall
         { text: nil }
       end
 
+      def payment_urls
+        @payment_urls ||= Stall::Payments::UrlsConfig.new(cart)
+      end
+
       private
 
       def next_transaction_id
-        if (last_transaction = Stall::Payment.order("data->>'transaction_id' DESC").select(:data).first)
+        if (last_transaction = Payment.order("data->>'transaction_id' DESC").select(:data).first)
           if (id = last_transaction.transaction_id)
             index = id.split('-').pop.to_i + 1
             return transaction_id_for(index)

data/lib/stall/payments/urls_config.rb

@@ -0,0 +1,40 @@
+module Stall
+  module Payments
+    class UrlsConfig
+      include Rails.application.routes.url_helpers
+
+      class_attribute :config_block
+
+      attr_reader   :cart
+
+      attr_accessor :payment_notification_url,
+                    :payment_success_return_url,
+                    :payment_failure_return_url
+
+      def initialize(cart)
+        @cart = cart
+
+        # Parse URLs
+        instance_exec(self, &config_block)
+      end
+
+      private
+
+      def config_block
+        self.class.config_block || default_config
+      end
+
+      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)
+        }
+      end
+
+      def gateway_identifier
+        @gateway_identifier ||= cart.payment.payment_method.identifier
+      end
+    end
+  end
+end

data/lib/stall/priceable.rb

@@ -0,0 +1,7 @@
+module Stall
+  module Priceable
+    def vat
+      price - eot_price
+    end
+  end
+end

data/lib/stall/rails/currency_helper.rb

@@ -18,7 +18,7 @@ module Stall
             options[:unit] = price.symbol
           end
 
-          original_number_to_currency(price, options)
+          original_number_to_currency(price.to_f, options)
         end
       end
     end

data/lib/stall/routes.rb

@@ -13,13 +13,26 @@ module Stall
             resources :line_items
           end
 
-          resources :checkouts, only: [:show]
+          get 'checkout/:cart_key' => 'checkouts#show', as: :checkout
 
-          scope '/checkout/:type/:cart_id', module: 'checkout', as: :checkout do
-            resource :step, only: [:show, :update]
+          scope 'checkout', module: 'checkout', as: :checkout do
+            scope '(:cart_key)' do
+              resource :step, only: [:show, :update] do
+                post '/', action: :update, as: :update
+                get '/process', action: :update, as: :process
+                get 'change/:step', action: :change, as: :change
+              end
+            end
           end
 
-          match '/payments/:gateway/process' => 'payments#process', via: [:get, :post]
+
+          scope '/:gateway' do
+            resource :payment, only: [] do
+              member do
+                match 'notify', action: 'notify', via: [:get, :post]
+              end
+            end
+          end
         end
       end
     end

data/lib/stall/sellable.rb

@@ -3,8 +3,7 @@ module Stall
     extend ActiveSupport::Concern
 
     included do
-      has_many :line_items, class_name: 'Stall::LineItem',
-                            dependent: :nullify,
+      has_many :line_items, dependent: :nullify,
                             as: :sellable,
                             inverse_of: :sellable
     end

data/lib/stall/shipping.rb

@@ -10,7 +10,9 @@ module Stall
     autoload :Config
 
     mattr_reader :calculators
-    @@calculators = {}
+    @@calculators = {}.with_indifferent_access
+
+    class CalculatorNotFound < StandardError; end
   end
 end