merchant_sidekick 0.4.2

data/lib/merchant_sidekick/migrations/addressable.rb

@@ -0,0 +1,47 @@
+class CreateMerchantSidekickAddressableTables < ActiveRecord::Migration
+  def self.up
+    create_table :addresses do |t|
+      t.integer  "addressable_id"
+      t.string   "addressable_type"
+      t.integer  "academic_title_id"
+      t.string   "gender",            :limit => 1
+      t.string   "first_name"
+      t.string   "middle_name"
+      t.string   "last_name"
+      t.text     "street"
+      t.string   "city"
+      t.string   "postal_code"
+      t.string   "province"
+      t.string   "province_code",     :limit => 2
+      t.string   "country"
+      t.string   "country_code",      :limit => 2
+      t.string   "company_name"
+      t.text     "note"
+      t.string   "phone"
+      t.string   "mobile"
+      t.string   "fax"
+      t.string   "type"
+    end
+
+    add_index :addresses, ["academic_title_id"], :name => "index_addresses_on_academic_title_id"
+    add_index :addresses, ["addressable_id", "addressable_type"], :name => "fk_addresses_addressable"
+    add_index :addresses, ["city"], :name => "index_addresses_on_city"
+    add_index :addresses, ["company_name"], :name => "index_addresses_on_company_name"
+    add_index :addresses, ["country"], :name => "index_addresses_on_country"
+    add_index :addresses, ["country_code"], :name => "index_addresses_on_country_code"
+    add_index :addresses, ["fax"], :name => "index_addresses_on_fax"
+    add_index :addresses, ["first_name"], :name => "index_addresses_on_first_name"
+    add_index :addresses, ["gender"], :name => "index_addresses_on_gender"
+    add_index :addresses, ["last_name"], :name => "index_addresses_on_last_name"
+    add_index :addresses, ["middle_name"], :name => "index_addresses_on_middle_name"
+    add_index :addresses, ["mobile"], :name => "index_addresses_on_mobile"
+    add_index :addresses, ["phone"], :name => "index_addresses_on_phone"
+    add_index :addresses, ["province"], :name => "index_addresses_on_state"
+    add_index :addresses, ["province_code"], :name => "index_addresses_on_state_code"
+    add_index :addresses, ["type"], :name => "index_addresses_on_type"
+  end
+
+  def self.down
+    drop_table :addresses
+  end
+end

data/lib/merchant_sidekick/migrations/billing.rb

@@ -0,0 +1,100 @@
+class CreateMerchantSidekickBillingTables < ActiveRecord::Migration
+
+  def self.up
+    create_table :line_items do |t|
+      t.integer "order_id"
+      t.integer "invoice_id"
+      t.integer "sellable_id"
+      t.string  "sellable_type"
+      t.integer "net_cents",     :default   => 0, :null => false
+      t.integer "tax_cents",     :default   => 0, :null => false
+      t.integer "gross_cents",   :default   => 0, :null => false
+      t.string  "currency",      :default   => "USD", :null => false
+      t.decimal "tax_rate",      :precision => 15, :scale => 10, :default => 0.0, :null => false
+      t.timestamps
+    end
+    add_index :line_items, "order_id"
+    add_index :line_items, "invoice_id"
+    add_index :line_items, ["sellable_id", "sellable_type"]
+
+
+    create_table :orders do |t|
+      t.integer  "buyer_id"
+      t.string   "buyer_type"
+      t.integer  "seller_id"
+      t.string   "seller_type"
+      t.integer  "invoice_id"
+      t.integer  "net_cents",                                 :default => 0,         :null => false
+      t.integer  "tax_cents",                                 :default => 0,         :null => false
+      t.integer  "gross_cents",                               :default => 0,         :null => false
+      t.string   "currency",                     :limit => 3, :default => "USD",     :null => false
+      t.string   "type"
+      t.string   "status",                                    :default => "created", :null => false
+      t.string   "number"
+      t.string   "description"
+      t.datetime "canceled_at"
+      t.timestamps
+    end
+    add_index :orders, ["buyer_id", "buyer_type"]
+    add_index :orders, ["seller_id", "seller_type"]
+    add_index :orders, "status"
+    add_index :orders, "type"
+
+
+    create_table :invoices do |t|
+      t.integer  "buyer_id"
+      t.string   "buyer_type"
+      t.integer  "seller_id"
+      t.string   "seller_type"
+      t.integer  "net_cents",               :default => 0,         :null => false
+      t.integer  "tax_cents",               :default => 0,         :null => false
+      t.integer  "gross_cents",             :default => 0,         :null => false
+      t.string   "currency",                :default => "USD",     :null => false
+      t.string   "type"
+      t.string   "number"
+      t.string   "status",                  :default => "pending", :null => false
+      t.datetime "paid_at"
+      t.integer  "order_id"
+      t.datetime "authorized_at"
+      t.timestamps
+    end
+    add_index :invoices, ["buyer_id", "buyer_type"]
+    add_index :invoices, "number"
+    add_index :invoices, "order_id"
+    add_index :invoices, ["seller_id", "seller_type"]
+    add_index :invoices, "type"
+
+
+    #--- payments
+    create_table :payments do |t|
+      t.integer  "payable_id"
+      t.string   "payable_type"
+      t.boolean  "success"
+      t.string   "reference"
+      t.string   "message"
+      t.string   "action"
+      t.string   "params"
+      t.boolean  "test"
+      t.integer  "cents",                                :default => 0,     :null => false
+      t.string   "currency",                :limit => 3, :default => "USD", :null => false
+      t.integer  "position"
+      t.string   "type"
+      t.string   "paypal_account"
+      t.string   "uuid"
+      t.timestamps
+    end
+    add_index :payments, "action"
+    add_index :payments, ["payable_id", "payable_type"]
+    add_index :payments, "position"
+    add_index :payments, "reference"
+    add_index :payments, "uuid"
+  end
+
+  def self.down
+    drop_table :gateways
+    drop_table :payments
+    drop_table :invoices
+    drop_table :orders
+    drop_table :line_items
+  end
+end

data/lib/merchant_sidekick/migrations/shopping_cart.rb

@@ -0,0 +1,28 @@
+class CreateMerchantSidekickShoppingCartTables < ActiveRecord::Migration
+  def self.up
+    create_table :cart_line_items do |t|
+      t.string   "item_number"
+      t.string   "name"
+      t.string   "description"
+      t.integer  "quantity",                  :default => 1,       :null => false
+      t.string   "unit",                      :default => "piece", :null => false
+      t.integer  "pieces",                    :default => 0,       :null => false
+      t.integer  "cents",                     :default => 0,       :null => false
+      t.string   "currency",     :limit => 3, :default => "USD",   :null => false
+      t.boolean  "taxable",                   :default => false,   :null => false
+      t.integer  "product_id",                                     :null => false
+      t.string   "product_type",                                   :null => false
+      t.timestamps
+    end
+    add_index :cart_line_items, "item_number"
+    add_index :cart_line_items, "name"
+    add_index :cart_line_items, "unit"
+    add_index :cart_line_items, "pieces"
+    add_index :cart_line_items, ["product_id", "product_type"]
+    add_index :cart_line_items, "quantity"
+  end
+
+  def self.down
+    drop_table :cart_line_items
+  end
+end

data/lib/merchant_sidekick/money.rb

@@ -0,0 +1,38 @@
+module MerchantSidekick
+  module Money
+    def money(name, options = {})
+      options = {:cents => "#{name}_cents".to_sym}.merge(options)
+      mapping = [[options[:cents].to_s, 'cents']]
+      mapping << ([options[:currency].to_s, 'currency_as_string']) if options[:currency]
+
+      composed_of name,
+        :class_name => "::Money",
+        :mapping => mapping,
+        :constructor => Proc.new {|cents, currency| ::Money.new(cents || 0, currency || ::Money.default_currency)},
+        :converter => Proc.new {|value| value.respond_to?(:to_money) ? value.to_money : raise(ArgumentError, "Can't convert #{value.class} to Money")}
+
+      if options[:currency]
+        class_eval(<<-END, __FILE__, __LINE__+1)
+          def currency
+            ::Money::Currency.wrap(self[:#{options[:currency]}])
+          end
+
+          def currency_as_string
+            self[:#{options[:currency]}]
+          end
+        END
+      else
+        class_eval(<<-END, __FILE__, __LINE__+1)
+          def currency
+            ::Money.default_currency
+          end
+
+          def currency_as_string
+            ::Money.default_currency.to_s
+          end
+        END
+      end
+
+    end
+  end
+end

data/lib/merchant_sidekick/order.rb

@@ -0,0 +1,244 @@
+# Baseclass of all orders which can be:
+#
+#   * Purchase Order: outbound orders, i.e. a user buys a product from the merchant
+#   * Sales Order: inbound order i.e. the merchant sells a product to a user
+#
+module MerchantSidekick
+  class Order < ActiveRecord::Base
+    include AASM
+    self.table_name = "orders"
+
+    belongs_to :seller, :polymorphic => true
+    belongs_to :buyer, :polymorphic => true
+    has_many   :line_items, :dependent => :destroy, :class_name => "::MerchantSidekick::LineItem"
+    has_many   :payments, :as => :payable, :class_name => "::MerchantSidekick::Payment"
+    has_many   :invoices, :foreign_key => :order_id, :class_name => "::MerchantSidekick::Invoice"
+
+    money :net_amount,   :cents => :net_cents,   :currency => :currency
+    money :tax_amount,   :cents => :tax_cents,   :currency => :currency
+    money :gross_amount, :cents => :gross_cents, :currency => :currency
+    has_address :origin, :billing, :shipping
+
+    #--- state machine
+    aasm :column => "status" do
+      state :created,   :enter => :enter_created,   :exit => :exit_created, :initial => true
+      state :pending,   :enter => :enter_pending,   :exit => :exit_pending
+      state :approved,  :enter => :enter_approved,  :exit => :exit_approved
+      state :shipping,  :enter => :enter_shipping,  :exit => :exit_shipping
+      state :shipped,   :enter => :enter_shipped,   :exit => :exit_shipped
+      state :received,  :enter => :enter_received,  :exit => :exit_received
+      state :returning, :enter => :enter_returning, :exit => :exit_returning
+      state :returned,  :enter => :enter_returned,  :exit => :exit_returned
+      state :refunded,  :enter => :enter_refunded,  :exit => :exit_refunded
+      state :canceled,  :enter => :enter_canceled,  :exit => :exit_canceled
+
+      event :process_payment do
+        transitions :from      => :created, :to => :pending, :guard => :guard_process_payment_from_created
+      end
+
+      event :approve_payment do
+        transitions :from      => :pending, :to => :approved, :guard => :guard_approve_payment_from_pending
+      end
+
+      event :process_shipping do
+        transitions :from      => :approved, :to => :shipping, :guard => :guard_process_shipping_from_approved
+      end
+
+      event :ship do
+        transitions :from      => :shipping, :to => :shipped, :guard => :guard_ship_from_shipping
+      end
+
+      event :confirm_reception do
+        transitions :from      => :shipped, :to => :received, :guard => :guard_confirm_reception_from_shipped
+      end
+
+      event :reject do
+        transitions :from      => :received, :to => :returning, :guard => :guard_reject_from_received
+      end
+
+      event :confirm_return do
+        transitions :from      => :returning, :to => :returned, :guard => :guard_confirm_return_from_returning
+        transitions :from      => :shipped, :to => :returned, :guard => :guard_confirm_return_from_shipped
+      end
+
+      event :refund do
+        transitions :from      => :returned, :to => :refunded, :guard => :guard_refund_from_returned
+      end
+
+      event :cancel do
+        transitions :from      => :created, :to => :canceled, :guard => :guard_cancel_from_created
+        transitions :from      => :pending, :to => :canceled, :guard => :guard_cancel_from_pending
+      end
+    end
+
+    # state transition callbacks, to be overwritten
+    def enter_created; end
+    def enter_pending; end
+    def enter_approved; end
+    def enter_shipping; end
+    def enter_shipped; end
+    def enter_received; end
+    def enter_returning; end
+    def enter_returned; end
+    def enter_refunded; end
+    def enter_canceled; end
+
+    def exit_created; end
+    def exit_pending; end
+    def exit_approved; end
+    def exit_shipping; end
+    def exit_shipped; end
+    def exit_received; end
+    def exit_returning; end
+    def exit_returned; end
+    def exit_refunded; end
+    def exit_canceled; end
+
+    # event guard callbacks, to be overwritten
+    def guard_process_payment_from_created; true; end
+    def guard_approve_payment_from_pending; true; end
+    def guard_process_shipping_from_approved; true; end
+    def guard_ship_from_shipping; true; end
+    def guard_confirm_reception_from_shipped; true; end
+    def guard_reject_from_received; true; end
+    def guard_confirm_return_from_returning; true; end
+    def guard_confirm_return_from_shipped; true; end
+    def guard_refund_from_returned; true; end
+    def guard_cancel_from_created; true; end
+    def guard_cancel_from_pending; true; end
+
+    #--- callbacks
+    before_save :total, :number
+
+    #--- class methods
+    class << self
+
+      # hex digest 16 char in length
+      # TODO change this to customize number schema
+      def generate_unique_id
+        value = Digest::MD5.hexdigest("#{Time.now.utc.to_i}#{rand(2 ** 128)}")[0..6]
+        value.encode! 'utf-8'
+        value
+      end
+
+    end
+
+    #--- instance methods
+
+    alias_method :current_state, :aasm_current_state
+
+    def number
+      self[:number] ||= Order.generate_unique_id
+    end
+
+    # abstract overriden in sublcasses
+    # returns the invoice instance
+    def invoice
+      raise "deprecated as we use has_many :invoices association"
+    end
+
+    # abstract to be overriden inside puchase and sales orders
+    def build_invoice
+      raise "override in purchase_order or sales_order"
+    end
+
+    # Builds billing, shipping and origin addresses
+    def build_addresses(options={})
+      raise "override in purchase_order or sales_order"
+    end
+
+    # Net total amount
+    def net_total
+      self.net_amount = line_items.inject(0.to_money) {|sum,l| sum + l.net_amount }
+    end
+
+    # Calculates tax and sets the tax_amount attribute
+    # It adds tax_amount across all line_items
+    def tax_total
+      self.tax_amount = line_items.inject(0.to_money) {|sum,l| sum + l.tax_amount }
+      self.tax_amount
+    end
+
+    # Gross amount including tax
+    def gross_total
+      self.gross_amount = self.net_total + self.tax_total
+    end
+
+    # Same as gross_total with tax
+    def total
+      self.gross_total
+    end
+
+    # is the number of line items stored in the order, though not to be
+    # confused by the items_count
+    def line_items_count
+      self.line_items.count
+    end
+
+    # total number of items purchased
+    def items_count
+      counter = 0
+      self.line_items.each do |item|
+        if item.sellable && item.sellable.respond_to?(:quantity)
+          counter += item.sellable.quantity
+        else
+          counter += 1
+        end
+      end
+      counter
+    end
+
+    # updates the order and all contained line_items after an address has changed
+    # or an order item was added or removed. The order can only be evaluated if the
+    # created state is active. The order is saved if it is an existing order.
+    # Returns true if evaluation happend, false if not.
+    def evaluate
+      if :created == current_state
+        self.line_items.each(&:evaluate)
+        self.calculate
+        return save(false) unless new_record?
+      end
+      false
+    end
+
+    # adds a line item or sellable to order and updates the order
+    def push(an_item_or_sellable)
+      if !an_item_or_sellable.is_a?(LineItem) && an_item_or_sellable.respond_to?(:price)
+        li = LineItem.new(:sellable => an_item_or_sellable, :order => self)
+      elsif an_item_or_sellable.is_a?(LineItem)
+        li = an_item_or_sellable
+      end
+      if li
+        self.line_items.push(li)
+        self.evaluate
+      end
+    end
+
+    protected
+
+    # Recalculates the order, adding order lines, tax and gross totals
+    def calculate
+      self.total
+    end
+
+    # override in subclass
+    def to_invoice_class_name
+    end
+
+    # override in subclass
+    def purchase_order?
+      false
+    end
+
+    # override in subclass
+    def sales_order?
+      false
+    end
+
+    def push_payment(a_payment)
+      a_payment.payable = self
+      self.payments.push(a_payment)
+    end
+
+  end
+end