stall 0.1.1 → 0.1.2

data/config/locales/stall.fr.yml

@@ -11,11 +11,16 @@ fr:
           success: "Votre panier a bien été mis à jour."
           error: "Votre panier n'a pu être mis à jour, merci de vérifier les champs."
       recap:
+        order_ref: "Commande n°%{ref}"
+        ordered_at: "Passée le %{at}"
+        subtotal: "Sous-total"
+        total_shipment_price: "Livraison"
         total_eot_price: "Prix total HT"
         total_vat: "Total TVA"
         total_price: "Prix total"
         update: "Mettre à jour le panier"
         validate: "Passer la commande"
+        paid_at: "Payée le %{at}"
 
     line_items:
       form:
@@ -29,6 +34,8 @@ fr:
         description: "Merci de vérifier que vous avez bien rempli la quantité avant d'ajouter le produit au panier."
 
     checkout:
+      shared:
+        not_checkoutable: "Aucun produit dans le panier, impossible de passer la commande."
       informations:
         title: "Vos informations"
         validate: "Valider mes adresses"
@@ -41,23 +48,72 @@ fr:
         validate: "Valider mon mode de paiement"
       payment:
         title: "Paiement"
+        error: |
+          Votre paiement n'a pas pu être pris en compte, vous pouvez réessayer
+          de payer avec le bouton : "Payer ma commande"
+      payment_return:
+        title: "Paiement effectué"
+        help: |
+          Votre paiement a bien été pris en compte et votre commande a été
+          validée. Celle-ci sera traitée dans les plus bref délais.
+          <br><br>
+          Un e-mail de confirmation vous a été envoyé.
+          <br><br>
+          Merci pour votre confiance !
+
+        back_to_shop: "Retour à la boutique"
 
     payments:
       gateway:
         pay: "Payer ma commande"
 
+    addresses:
+      civilities:
+        m: M.
+        mme: Mme.
+
+    mailers:
+      customer:
+        order_paid_email:
+          subject: "Le paiement de votre commande n°%{ref} a bien été effectué !"
+          intro: "Votre commande sera traitée dans les meilleurs délais."
+      admin:
+        order_paid_email:
+          subject: "Une nouvelle commande a été passée sur le site - %{ref}"
+
   activerecord:
+    enums:
+      shipment:
+        state:
+          pending: "En attente"
+          shipped: "Expédié"
+      payment:
+        state:
+          pending: "En attente"
+          shipped: "Payé"
+    models:
+      line_item: "Produit"
+      customer: "Client"
+      address: "Adresse"
+      cart: "Panier"
+      shipment: "Livraison"
+      payment: "Paiement"
     attributes:
-      stall/line_item:
-        name: "Produit"
-        unit_price: "Prix unitaire"
-        unit_eot_price: "Prix unitaire HT"
-        price: "Prix"
-        eot_price: "Prix HT"
+      line_item:
+        sellable: "Produit source"
+        name: "Nom du produit"
         quantity: "Quantité"
-      stall/customer:
+        unit_eot_price: "Prix unitaire HT"
+        unit_price: "Prix unitaire TTC"
+        eot_price: "Prix total HT"
+        price: "Prix total TTC"
+        vat_rate: "Taux de TVA"
+        weight: "Poids"
+      customer:
         email: "Adresse e-mail"
-      stall/address:
+        shipping_address: "Adresse de livraison"
+        billing_address: "Adresse de facturation"
+      address:
         civility: "Civilité"
         first_name: "Prénom"
         last_name: "Nom"
@@ -67,3 +123,29 @@ fr:
         city: "Ville"
         country: "Pays"
         phone: "Téléphone"
+        state: "État"
+      product_list:
+        reference: "Référence"
+        customer: "Client"
+        created_at: "Date"
+        line_items: "Produits"
+      cart:
+        state: "Étape du panier"
+        total_price: "Montant total"
+        payment: "Paiement"
+        shipment: "Livraison"
+        shipping_address: "Adresse de livraison"
+        billing_address: "Adresse de facturation"
+      shipment:
+        price: "Prix"
+        eot_price: "Prix HT"
+        vat_rate: "Taux de TVA"
+        sent_at: "Expédié le"
+        shipping_method: "Mode de livraison"
+        tracking_code: "Code de suivi"
+        state: "État"
+      payment:
+        payment_method: "Mode de paiement"
+        paid_at: "Payé le"
+        transaction_id: "Numéro de transaction"
+        state: "État"

data/db/migrate/20160304134849_change_all_json_columns_to_jsonb.rb

@@ -0,0 +1,18 @@
+# This allows to avoid SELECT DISTINCT errors where JSON field type would throw
+# a PG::UndefinedFunction error
+#
+# See : https://github.com/activerecord-hackery/ransack/issues/453
+#
+class ChangeAllJsonColumnsToJsonb < ActiveRecord::Migration
+  def up
+    change_column :stall_line_items, :data, 'jsonb USING CAST(data AS jsonb)'
+    change_column :stall_payments, :data, 'jsonb USING CAST(data AS jsonb)'
+    change_column :stall_product_lists, :data, 'jsonb USING CAST(data AS jsonb)'
+  end
+
+  def down
+    change_column :stall_line_items, :data, 'json USING CAST(data AS json)'
+    change_column :stall_payments, :data, 'json USING CAST(data AS json)'
+    change_column :stall_product_lists, :data, 'json USING CAST(data AS json)'
+  end
+end

data/db/migrate/20160307142924_add_state_to_stall_addresses.rb

@@ -0,0 +1,5 @@
+class AddStateToStallAddresses < ActiveRecord::Migration
+  def change
+    add_column :stall_addresses, :state, :string
+  end
+end

data/db/migrate/20160308142713_create_adjustments.rb

@@ -0,0 +1,16 @@
+class CreateAdjustments < ActiveRecord::Migration
+  def change
+    create_table :stall_adjustments do |t|
+      t.string     :name,            null: false
+      t.monetize   :eot_price,       null: false, currency: { present: false }
+      t.monetize   :price,           null: false, currency: { present: false }
+      t.decimal    :vat_rate,        null: false
+      t.string     :type
+      t.references :cart, index: true
+
+      t.timestamps null: false
+    end
+
+    add_foreign_key :stall_adjustments, :stall_product_lists, column: :cart_id
+  end
+end

data/db/migrate/20160309165136_add_identifier_to_stall_product_lists.rb

@@ -0,0 +1,5 @@
+class AddIdentifierToStallProductLists < ActiveRecord::Migration
+  def change
+    add_column :stall_product_lists, :identifier, :string, null: false, default: 'default'
+  end
+end

data/db/migrate/20160316114649_add_data_to_stall_shipments.rb

@@ -0,0 +1,5 @@
+class AddDataToStallShipments < ActiveRecord::Migration
+  def change
+    add_column :stall_shipments, :data, :jsonb
+  end
+end

data/db/migrate/20160317141632_add_state_to_stall_shipments.rb

@@ -0,0 +1,5 @@
+class AddStateToStallShipments < ActiveRecord::Migration
+  def change
+    add_column :stall_shipments, :state, :integer, default: 0
+  end
+end

data/db/migrate/20160629102943_add_active_to_stall_shipping_methods.rb

@@ -0,0 +1,11 @@
+class AddActiveToStallShippingMethods < ActiveRecord::Migration
+  def up
+    add_column :stall_shipping_methods, :active, :boolean, default: true
+
+    ShippingMethod.update_all(active: true)
+  end
+
+  def down
+    remove_column :stall_shipping_methods, :active
+  end
+end

data/db/migrate/20160629104617_add_active_to_stall_payment_methods.rb

@@ -0,0 +1,11 @@
+class AddActiveToStallPaymentMethods < ActiveRecord::Migration
+  def up
+    add_column :stall_payment_methods, :active, :boolean, default: true
+
+    PaymentMethod.update_all(active: true)
+  end
+
+  def down
+    remove_column :stall_payment_methods, :active
+  end
+end

data/db/migrate/20160705110151_add_locale_to_stall_customers.rb

@@ -0,0 +1,5 @@
+class AddLocaleToStallCustomers < ActiveRecord::Migration
+  def change
+    add_column :stall_customers, :locale, :string, default: I18n.default_locale
+  end
+end

data/lib/generators/stall/checkout/step/templates/step.html.haml.erb

@@ -1,6 +1,6 @@
 %h1= t('stall.checkout.<%= base_file_name %>.title')
 
-= simple_form_for cart, as: :cart, url: step_path(cart) do |form|
+= simple_form_for cart, as: :cart, url: step_path do |form|
 
   %button.btn.btn-primary{ type: 'submit' }
     = t('stall.checkout.<%= base_file_name %>.validate')

data/lib/generators/stall/checkout/step/templates/step.rb.erb

@@ -1,13 +1,21 @@
 class <%= class_name %> < Stall::Checkout::Step
+  # Declare your step validations here
+  # Those validations will be run against the cart object
+  #
+  # validations do
+  #   validates :foo, presence: true
+  # end
+
   # Prepare the `cart` before showing your view
   #
   # def prepare
   # end
 
-  # Process `params` here, defaults to updating the cart with `cart_params`
-  # (params[:cart])
+  # Process `params` here, defaults to assigning the cart with `cart_params`
+  # (params[:cart]) to the cart, running the step validations
   #
   # def process
+  #   save
   # end
 
   # Handle the case where the step should be skipped by returning true from

data/lib/generators/stall/checkout/wizard/templates/wizard.rb.erb

@@ -1,3 +1,3 @@
 class <%= class_name %> < Stall::Checkout::Wizard
-  steps :informations, :shipping_method, :payment_method, :payment
+  steps :informations, :shipping_method, :payment_method, :payment, :payment_return
 end

data/lib/generators/stall/install/templates/initializer.rb

@@ -1,4 +1,30 @@
 Stall.configure do |config|
+  # Store name used by the system when a human readable identifier for your
+  # store is needed, e.g. for payment gateways
+  #
+  config.store_name = "My stall (Change me in config/initializers/stall.rb)"
+
+  # Configure the admin e-mail to which order notifications will be sent
+  #
+  # Either set the `STALL_ADMIN_EMAIL` env var or use the below config.
+  #
+  # You can also set that param as a proc / lambda that will get the cart
+  # as argument, allowing you to dynamically define which e-mail to send
+  # notifications *to*
+  #
+  # config.admin_email = ENV['STALL_ADMIN_EMAIL']
+
+  # Configure the e-mail address used to send e-mails to customers for
+  # order notifications
+  #
+  # Either set the `STALL_SENDER_EMAIL` env var or use the below config
+  #
+  # You can also set that param as a proc / lambda that will get the cart
+  # as argument, allowing you to dynamically define which e-mail to send
+  # notifications *from*
+  #
+  # config.sender_email = ENV['STALL_SENDER_EMAIL']
+
   # Global default VAT rate, can be overrided by products
   #
   # config.vat_rate = BigDecimal.new('20.0')
@@ -11,6 +37,19 @@ Stall.configure do |config|
   #
   # config.application_controller_ancestor = '::ApplicationController'
 
+  # Set a layout to use in the checkouts controllers
+  #
+  # The default is set to nil, which will make the controllers inherit from the
+  # layout of the controller set in `config.application_controller_ancestor`
+  #
+  # config.default_layout = nil
+
+  # Defines the parent mailer for the Stall customer and admin mailers
+  #
+  # If commented out, ActionMailer::Base will be used
+  #
+  config.mailers_parent_class = 'ApplicationMailer'
+
   # Default currency used in the app for money objects.
   #
   # Note : If you need multi currency support in your app, you'll have to ensure
@@ -19,6 +58,15 @@ Stall.configure do |config|
   #
   # param :default_currency, 'EUR'
 
+  # Default app domain use for building URLs in payment gateway forms and in
+  # e-mails.
+  #
+  # Add the `APP_DOMAIN` environment variable, or modify the parameter below.
+  #
+  # Ex : 'localhost:3000', 'www.example.com'
+  #
+  # config.default_app_domain = ENV['APP_DOMAIN']
+
   # Defined the default checkout wizard used for checking carts out in the
   # shop process.
   #
@@ -39,12 +87,30 @@ Stall.configure do |config|
 
   # Allows configuring which countries are available for free shipping offers
   #
-  # Accepts an array of country codes or a proc with a Stall::Address argument
+  # Accepts an array of country codes or a proc with an Address argument
   #
   # Defaults to nil, which means all countries are available
   #
   # config.shipping.free_shipping.available = nil
 
+  # Register custom shipping methods and calculators
+  #
+  # If no existing shipping method / calculator cover your needs, you can
+  # create one by subclassing Stall::Shipping::Calculator
+  #
+  # Read more at : https://github.com/rails-stall/stall/wiki/Shipping-methods
+  #
+  # config.shipping.register_calculator :my_calculator, 'MyCalculator'
+
+  # Register custom payment methods and gateways
+  #
+  # If no existing payment method / gateway cover your needs, you can
+  # create one by subclassing Stall::Payments::Gateway
+  #
+  # Read more at : https://github.com/rails-stall/stall/wiki/Payment-methods
+  #
+  # config.payment.register_gateway :my_gateway, 'MyGateway'
+
   # Allows hooking into checkout steps initialization in the steps controller
   # to inject dependencies to all or a specific step
   #
@@ -54,4 +120,22 @@ Stall.configure do |config|
   #   # Only inject in the :some step :
   #   step.inject(:ip, request.remote_ip) if SomeCheckoutStep === step
   # end
+
+  # Configure app services to override default Stall services and add
+  # functionalities to existing ones
+  #
+  # config.services = {
+  #   payment_notification: 'PaymentNotificationService'
+  # }
+
+  # Delay before empty carts are cleaned with the `stall:carts:clean` task
+  #
+  # config.empty_carts_expires_after = 1.day
+
+  # Delay before aborted carts are cleaned with the `stall:carts:clean` task
+  #
+  # Aborted carts are controlled with a scope on the cart model. To change
+  # the `aborted` behavior, you can override the `.aborted` scope in your model.
+  #
+  # config.aborted_carts_expires_after = 14.days
 end

data/lib/generators/stall/model/model_generator.rb

@@ -0,0 +1,27 @@
+module Stall
+  class ModelGenerator < ::Rails::Generators::NamedBase
+    class ModelModelNotFound < StandardError; end
+
+    MODELS_DIR = File.expand_path('../../../../../app/models', __FILE__)
+    source_root MODELS_DIR
+
+    def copy_model_template
+      if File.exist?(source_path)
+        template source_path, "app/models/#{ file_path_with_ext }"
+      else
+        raise ModelModelNotFound,
+              "Could not find any stall model for #{ class_name }"
+      end
+    end
+
+    private
+
+    def source_path
+      @source_path ||= File.join(MODELS_DIR, file_path_with_ext)
+    end
+
+    def file_path_with_ext
+      @file_path_with_ext ||= "#{ file_path }.rb"
+    end
+  end
+end

data/lib/generators/stall/service/service_generator.rb

@@ -0,0 +1,39 @@
+module Stall
+  class ServiceGenerator < ::Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def store_services_folder_existence
+      @services_folder_existed = File.exist?('app/services')
+    end
+
+    def copy_service_template
+      template 'service.rb.erb', "app/services/#{ service_file_path }.rb"
+    end
+
+    def post_template_message
+      puts "\n" +
+           "Service class generated. Please add the service to the " +
+           "`config.services` hash in your config/initializers/stall.rb file\n\n"
+
+      return if @services_folder_existed
+
+      puts " * Warning : app/services folder was just created, \n" +
+           " * please restart your server to let Rails know that it should\n" +
+           " * autoload this folder.\n\n"
+    end
+
+    private
+
+    def service_class_name
+      @service_class_name ||= service_file_path.camelize
+    end
+
+    def stall_service_class_name
+      @stall_service_class_name ||= ['Stall', service_class_name.demodulize].join('::')
+    end
+
+    def service_file_path
+      @service_file_path ||= [file_path.gsub(/service$/, ''), 'service'].join('_')
+    end
+  end
+end