caboose-cms 0.7.85 → 0.8.1

data/app/models/caboose/invoice_discount.rb

@@ -0,0 +1,10 @@
+module Caboose        
+  class InvoiceDiscount < ActiveRecord::Base
+    self.table_name = 'store_invoice_discounts'
+    
+    belongs_to :invoice
+    belongs_to :discount
+    
+    attr_accessible :invoice_id, :discount_id
+  end
+end

data/app/models/caboose/invoice_package.rb

@@ -0,0 +1,76 @@
+module Caboose
+  class InvoicePackage < ActiveRecord::Base
+    self.table_name = 'store_invoice_packages'
+
+    belongs_to :invoice
+    belongs_to :shipping_package
+    belongs_to :shipping_method
+    has_many :line_items    
+    attr_accessible :id, 
+      :invoice_id,
+      :shipping_method_id,
+      :shipping_package_id,
+      :status,
+      :tracking_number,
+      :total
+      
+    STATUS_PENDING = 'Pending'
+    STATUS_SHIPPED = 'Shipped'
+    
+    after_initialize :check_nil_fields
+    
+    def check_nil_fields      
+      self.total = 0.00 if self.total.nil?
+    end
+    
+    def self.custom_invoice_packages(store_config, invoice)          
+      eval(store_config.custom_packages_function)    
+    end
+    
+    # Calculates the shipping packages required for all the items in the invoice
+    def calculate_shipping_package
+      
+      store_config = invoice.site.store_config            
+      if !store_config.auto_calculate_packages                        
+        return self.custom_shipping_package(store_config, self)        
+      end
+      
+      variants = self.line_items.sort_by{ |li| li.quantity * (li.variant.volume ? li.variant.volume : 0.00) * -1 }.collect{ |li| li.variant.downloadable ? nil : li.variant }.reject{ |v| v.nil? }      
+      ShippingPackage.where(:site_id => self.invoice.site_id).reorder(:flat_rate_price).all.each do |sp|
+        if sp.fits(variants)
+          self.shipping_package_id = sp.id
+          self.save
+          return true          
+        end 
+      end                    
+      Caboose.log("Error: line item #{li.id} (#{li.variant.product.title}) does not fit into any package.")
+      return false
+    end
+    
+    def fits(line_item = nil)
+      variants = self.line_items.collect{ |li| li.variant }
+      variants << line_item.variant if line_item
+      return self.shipping_package.fits(variants)
+    end
+    
+    # Gets the activemerchant package based on the shipping package
+    def activemerchant_package
+      sc = self.invoice.site.store_config
+      
+      weight = 0.0
+      self.line_items.each{ |li| weight = weight + (li.variant.weight * li.quantity) }      
+      weight = weight * 0.035274 if sc.weight_unit == StoreConfig::WEIGHT_UNIT_METRIC # grams to ounces
+                  
+      sp = self.shipping_package
+      dimensions = [sp.outside_length, sp.outside_width, sp.outside_height]
+      if sc.length_unit == StoreConfig::LENGTH_UNIT_METRIC # cm to inches
+        dimensions[0] = dimensions[0] / 2.54
+        dimensions[1] = dimensions[0] / 2.54
+        dimensions[2] = dimensions[0] / 2.54
+      end
+      
+      return ActiveShipping::Package.new(weight, dimensions, :units => :imperial, :container => :variable)
+    end
+
+  end
+end

data/app/models/caboose/{order_package_calculator.rb → invoice_package_calculator.rb}

@@ -2,42 +2,42 @@ require 'active_shipping'
 #include ActiveMerchant::Shipping
 
 module Caboose
-  class OrderPackageCalculator
+  class InvoicePackageCalculator
     
-    def self.custom_order_packages(store_config, order)          
+    def self.custom_invoice_packages(store_config, invoice)          
       return eval(store_config.custom_packages_function)    
     end
     
-    def self.order_packages(order)
+    def self.invoice_packages(invoice)
       return [] if Caboose::store_shipping.nil?
             
-      sc = order.site.store_config
+      sc = invoice.site.store_config
       if !sc.auto_calculate_packages        
-        order_packages = self.custom_order_packages(sc, order)
-        return order_packages        
+        invoice_packages = self.custom_invoice_packages(sc, invoice)
+        return invoice_packages        
       end
       
-      # Remove any order packages      
-      LineItem.where(:order_id => order.id).update_all(:order_package_id => nil)
-      OrderPackage.where(:order_id => order.id).destroy_all      
+      # Remove any invoice packages      
+      LineItem.where(:invoice_id => invoice.id).update_all(:invoice_package_id => nil)
+      InvoicePackage.where(:invoice_id => invoice.id).destroy_all      
         
       # Calculate what shipping packages we'll need            
-      OrderPackage.create_for_order(order)
+      InvoicePackage.create_for_invoice(invoice)
               
       return all_rates
     end
     
-    def self.rate(order)
-      return nil if !order.shipping_service_code
-      self.rates(order).each { |rate| return rate if rate[:service_code] == order.shipping_service_code }
+    def self.rate(invoice)
+      return nil if !invoice.shipping_service_code
+      self.rates(invoice).each { |rate| return rate if rate[:service_code] == invoice.shipping_service_code }
       return nil
     end
                 
-    # Calculates the packages required for all the items in the order
-    #def self.packages_for_order(order)
+    # Calculates the packages required for all the items in the invoice
+    #def self.packages_for_invoice(invoice)
     #
-    #  # Make sure all the items in the order have attributes set
-    #  order.line_items.each do |li|              
+    #  # Make sure all the items in the invoice have attributes set
+    #  invoice.line_items.each do |li|              
     #    v = li.variant
     #    Caboose.log("Error: variant #{v.id} has a zero weight") and return false if v.weight.nil? || v.weight == 0
     #    next if v.volume && v.volume > 0
@@ -48,9 +48,9 @@ module Caboose
     #    v.save
     #  end
     #        
-    #  # Reorder the items in the order by volume            
+    #  # Reorder the items in the invoice by volume            
     #  h = {}
-    #  order.line_items.each do |li|
+    #  invoice.line_items.each do |li|
     #    (1..li.quantity).each do |i|        
     #      v = li.variant          
     #      h[v.volume] = v          
@@ -58,7 +58,7 @@ module Caboose
     #  end      
     #  variants = h.sort_by{ |k,v| k }.collect{ |x| x[1] }
     #  
-    #  all_packages = ShippingPackage.reorder(:price).all
+    #  all_packages = ShippingPackage.reinvoice(:price).all
     #  packages = []
     #  
     #  # Now go through each variant and fit it in a new or existing package

data/app/models/caboose/{order_pdf.rb → invoice_pdf.rb}

@@ -2,9 +2,9 @@ require 'prawn'
 require 'prawn/table'
 
 module Caboose
-  class OrderPdf < Prawn::Document
+  class InvoicePdf < Prawn::Document
     
-    attr_accessor :order, :card_type, :card_number
+    attr_accessor :invoice, :card_type, :card_number
     
     def to_pdf
       
@@ -18,9 +18,9 @@ module Caboose
 
       #image open("https://dmwwflw4i3miv.cloudfront.net/logo.png"), :position => :center
       move_down 10
-      order_info
+      invoice_info
       move_down 15
-      order_table
+      invoice_table
       move_down 15
       customer_info
       move_down 15
@@ -39,8 +39,8 @@ module Caboose
     
     def get_card_details
             
-      sc = self.order.site.store_config
-      ot = self.order.order_transactions.where(:transaction_type => OrderTransaction::TYPE_AUTHORIZE, :success => true).first
+      sc = self.invoice.site.store_config
+      ot = self.invoice.invoice_transactions.where(:transaction_type => InvoiceTransaction::TYPE_AUTHORIZE, :success => true).first
       
       case sc.pp_name
         when 'authorize.net'
@@ -62,14 +62,14 @@ module Caboose
             
     end
 
-    def order_info
+    def invoice_info
 
-      order_info = "Order Number: #{order.order_number}\n"
-      order_info << "Order Date: #{order.date_created.strftime('%d %b %Y %H:%M:%S %p')}\n"
-      order_info << "Status: #{order.status.capitalize}\n"
+      invoice_info = "Invoice Number: #{invoice.invoice_number}\n"
+      invoice_info << "Invoice Date: #{invoice.date_created.strftime('%d %b %Y %H:%M:%S %p')}\n"
+      invoice_info << "Status: #{invoice.status.capitalize}\n"
       tbl = []
       tbl << [
-        { :content => order_info }
+        { :content => invoice_info }
       ]
       move_down 4
       table tbl, :position => 7, :width => 530
@@ -78,19 +78,19 @@ module Caboose
     
     def customer_info
 
-      c = order.customer
+      c = invoice.customer
 
       # #{self.card_type} ending in #{self.card_number
-      ba = order.billing_address
-      ba_address = "#{ba.address1}" + (ba.address2.blank? ? '' : "\n#{ba.address2}") + "\n#{ba.city}, #{ba.state} #{ba.zip}"
+      ba = invoice.billing_address
+      ba_address = ba ? "#{ba.address1}" + (ba.address2.blank? ? '' : "\n#{ba.address2}") + "\n#{ba.city}, #{ba.state} #{ba.zip}" : ''
       billed_to = [
-        [{ :content => "Name"    , :border_width => 0, :width => 55 },{ :content => "#{ba.first_name} #{ba.last_name}" , :border_width => 0, :width => 200 }],
-        [{ :content => "Address" , :border_width => 0, :width => 55 },{ :content => ba_address                         , :border_width => 0, :width => 200 }],
-        [{ :content => "Email"   , :border_width => 0, :width => 55 },{ :content => "#{c.email}"                       , :border_width => 0, :width => 200 }],
-        [{ :content => "Phone"   , :border_width => 0, :width => 55 },{ :content => "#{self.formatted_phone(c.phone)}" , :border_width => 0, :width => 200 }]
+        [{ :content => "Name"    , :border_width => 0, :width => 55 },{ :content => ba ? "#{ba.first_name} #{ba.last_name}" : '' , :border_width => 0, :width => 200 }],
+        [{ :content => "Address" , :border_width => 0, :width => 55 },{ :content => ba ? ba_address                         : '' , :border_width => 0, :width => 200 }],
+        [{ :content => "Email"   , :border_width => 0, :width => 55 },{ :content => "#{c.email}"                                 , :border_width => 0, :width => 200 }],
+        [{ :content => "Phone"   , :border_width => 0, :width => 55 },{ :content => "#{self.formatted_phone(c.phone)}"           , :border_width => 0, :width => 200 }]
       ]
       
-      sa = order.shipping_address
+      sa = invoice.shipping_address
       sa_address = "#{sa.address1}" + (sa.address2.blank? ? '' : "\n#{sa.address2}") + "\n#{sa.city}, #{sa.state} #{sa.zip}"
       shipped_to = [
         [{ :content => "Name"    , :border_width => 0, :width => 55 },{ :content => "#{sa.first_name} #{sa.last_name}" , :border_width => 0, :width => 200 }],
@@ -113,9 +113,9 @@ module Caboose
       
     end
     
-    def order_table
+    def invoice_table
       
-      hide_prices = order.hide_prices_for_any_line_item?
+      hide_prices = invoice.hide_prices_for_any_line_item?
       
       tbl = []
       tbl << [
@@ -129,9 +129,9 @@ module Caboose
         tbl[0] << { :content => "Amount"     , :align => :right , :valign => :bottom }
       end
 
-      order.calculate
+      invoice.calculate
       
-      order.order_packages.all.each do |pk|
+      invoice.invoice_packages.all.each do |pk|
 
         carrier = pk.shipping_method.carrier
         service = pk.shipping_method.service_name
@@ -172,7 +172,7 @@ module Caboose
         end
       end
 
-      unassigned = order.line_items.where("order_package_id IS NULL OR order_package_id = ?",-1)
+      unassigned = invoice.line_items.where("invoice_package_id IS NULL OR invoice_package_id = ?",-1)
       unassigned.each_with_index do |li, index|
         options = ''
         if li.variant.product.option1 && li.variant.option1 then options += li.variant.product.option1 + ": " + li.variant.option1 + "\n" end
@@ -208,11 +208,11 @@ module Caboose
         tbl << arr
       end
       if !hide_prices
-        tbl << [{ :content => "Subtotal"                       , :colspan => 6, :align => :right                       }, { :content => "$"     + sprintf("%.2f", order.subtotal                        ) , :align => :right }]
-        tbl << [{ :content => "Discount"                       , :colspan => 6, :align => :right                       }, { :content => "(-) $" + sprintf("%.2f", order.discount ? order.discount : 0.0 ) , :align => :right }]
-        tbl << [{ :content => "Shipping and Handling Charges"  , :colspan => 6, :align => :right                       }, { :content => "(+) $" + sprintf("%.2f", order.shipping_and_handling           ) , :align => :right }]    
-        tbl << [{ :content => "Sales Tax"                      , :colspan => 6, :align => :right                       }, { :content => "(+) $" + sprintf("%.2f", order.tax ? order.tax : 0.0           ) , :align => :right }]
-        tbl << [{ :content => "Grand Total"                    , :colspan => 6, :align => :right, :font_style => :bold }, { :content => "$"     + sprintf("%.2f", order.total                           ) , :align => :right, :font_style => :bold }]
+        tbl << [{ :content => "Subtotal"                       , :colspan => 6, :align => :right                       }, { :content => "$"     + sprintf("%.2f", invoice.subtotal                        ) , :align => :right }]
+        tbl << [{ :content => "Discount"                       , :colspan => 6, :align => :right                       }, { :content => "(-) $" + sprintf("%.2f", invoice.discount ? invoice.discount : 0.0 ) , :align => :right }]
+        tbl << [{ :content => "Shipping and Handling Charges"  , :colspan => 6, :align => :right                       }, { :content => "(+) $" + sprintf("%.2f", invoice.shipping_and_handling           ) , :align => :right }]    
+        tbl << [{ :content => "Sales Tax"                      , :colspan => 6, :align => :right                       }, { :content => "(+) $" + sprintf("%.2f", invoice.tax ? invoice.tax : 0.0           ) , :align => :right }]
+        tbl << [{ :content => "Grand Total"                    , :colspan => 6, :align => :right, :font_style => :bold }, { :content => "$"     + sprintf("%.2f", invoice.total                           ) , :align => :right, :font_style => :bold }]
       end
       
       table tbl , :position => 7, :width => 530      
@@ -229,7 +229,7 @@ module Caboose
 
     def payment_info
 
-      trans = order.order_transactions.where(:transaction_type => OrderTransaction::TYPE_AUTHORIZE, :success => true).first
+      trans = invoice.invoice_transactions.where(:transaction_type => InvoiceTransaction::TYPE_AUTHORIZE, :success => true).first
       tbl = []
       tbl2 = []
       tbl3 = []

data/app/models/caboose/{order_reporter.rb → invoice_reporter.rb}

@@ -1,7 +1,7 @@
 module Caboose
-  class OrderReporter
+  class InvoiceReporter
             
-    def OrderReporter.summary_report(site_id, d1, d2)
+    def InvoiceReporter.summary_report(site_id, d1, d2)
       q = ["select 
           concat(date_part('year', date_authorized), '-', date_part('month', date_authorized), '-', date_part('day', date_authorized)),
           count(*),          
@@ -13,7 +13,7 @@ module Caboose
           sum(total),
           sum(cost),
           sum(profit)
-        from store_orders
+        from store_invoices
         where site_id = ?
         and (financial_status = ? or financial_status = ?)
         and date_authorized >= ?
@@ -68,7 +68,7 @@ module Caboose
       return days2            
     end
     
-    def OrderReporter.city_report(site_id, d1, d2)
+    def InvoiceReporter.city_report(site_id, d1, d2)
       q = ["select 
         count(*),
         sum(O.subtotal),
@@ -79,7 +79,7 @@ module Caboose
         sum(O.total),
         SA.city,
         SA.state
-        from store_orders O
+        from store_invoices O
         left join store_addresses SA on O.shipping_address_id = SA.id
         where O.site_id = ?
         and (O.financial_status = ? or O.financial_status = ?)

data/app/models/caboose/invoice_transaction.rb

@@ -0,0 +1,169 @@
+module Caboose
+  class InvoiceTransaction < ActiveRecord::Base
+    self.table_name  = 'store_invoice_transactions'
+    self.primary_key = 'id'
+    
+    belongs_to :invoice
+    belongs_to :parent, :class_name => 'Caboose::InvoiceTransaction', :foreign_key => :parent_id
+    attr_accessible :id,    
+      :invoice_id,
+      :parent_id,
+      :transaction_id,
+      :transaction_type,
+      :amount,
+      :amount_refunded,
+      :auth_code,
+      :date_processed,
+      :response_code,
+      :success,
+      :captured,
+      :refunded
+        
+    TYPE_AUTHORIZE = 'auth'
+    TYPE_CAPTURE   = 'capture'
+    TYPE_AUTHCAP   = 'authcap'    
+    TYPE_VOID      = 'void'
+    TYPE_REFUND    = 'refund'
+    
+    after_initialize :check_nil_fields
+    
+    def children
+      InvoiceTransaction.where(:parent_id => self.id).all
+    end
+    
+    def check_nil_fields
+      self.amount = 0.00 if self.amount.nil?        
+    end
+    
+    def self.type_from_authnet_status(status)
+      case status
+        when 'settledSuccessfully'        then InvoiceTransaction::TYPE_CAPTURE
+        when 'voided'                     then InvoiceTransaction::TYPE_VOID
+        when 'declined'                   then InvoiceTransaction::TYPE_AUTHORIZE
+        when 'authorizedPendingCapture'   then InvoiceTransaction::TYPE_AUTHORIZE
+        when 'refundSettledSuccessfully'  then InvoiceTransaction::TYPE_REFUND
+      end
+    end
+    
+    # Capture funds from a previously authorized transaction
+    def capture
+      
+      return { :error => "This invoice doesn't seem to be authorized." } if !self.success
+      
+      ct = InvoiceTransaction.where(:parent_id => self.id, :transaction_type => InvoiceTransaction::TYPE_CAPTURE, :success => true).first      
+      return { :error => "Funds for this invoice have already been captured." } if ct
+            
+      resp = Caboose::StdClass.new
+      sc = self.invoice.site.store_config                
+      case sc.pp_name
+                                  
+        when StoreConfig::PAYMENT_PROCESSOR_STRIPE
+                                                                                    
+          Stripe.api_key = sc.stripe_secret_key.strip
+          bt = nil
+          begin
+            c = Stripe::Charge.retrieve(self.transaction_id)
+            c = c.capture
+            bt = Stripe::BalanceTransaction.retrieve(c.balance_transaction)
+          rescue Exception => ex
+            resp.error = "Error during capture process\n#{ex.message}"                
+          end
+          
+          if resp.error.nil?
+            InvoiceTransaction.create(
+              :invoice_id => self.invoice_id,
+              :parent_id => self.id,
+              :transaction_id => bt.id,
+              :transaction_type => InvoiceTransaction::TYPE_CAPTURE, 
+              :amount => bt.amount / 100.0,                
+              :date_processed => DateTime.strptime(bt.created.to_s, '%s'),
+              :success => bt.status == 'succeeded' || bt.status == 'pending'
+            )
+            if bt.status == 'succeeded' || bt.status == 'pending'
+              self.captured = true
+              self.save              
+              self.invoice.financial_status = Invoice::FINANCIAL_STATUS_CAPTURED
+              self.invoice.save
+              resp.success = true
+            else
+              resp.error = "Error capturing funds."
+            end
+          end
+          
+      end
+      return resp
+      
+    end
+        
+    def refund(amount_to_refund = nil)
+      
+      resp = StdClass.new
+      
+      amount_available_to_refund = self.amount - (self.amount_refunded ? self.amount_refunded : 0.00)
+      amount_to_refund = amount_available_to_refund if amount_to_refund.nil?
+
+      if self.transaction_type != InvoiceTransaction::TYPE_AUTHORIZE && self.transaction_type != InvoiceTransaction::TYPE_AUTHCAP                
+        resp.error = "You can only refund authorize transactions."      
+      elsif amount_to_refund > amount_available_to_refund
+        resp.error = "The amount to refund exceeds the amount available to refund."      
+      else
+                        
+        sc = self.invoice.site.store_config                
+        case sc.pp_name
+                                    
+          when StoreConfig::PAYMENT_PROCESSOR_STRIPE
+                                                                              
+            Stripe.api_key = sc.stripe_secret_key.strip
+            bt = nil
+            begin
+              r = Stripe::Refund.create(:charge => self.transaction_id, :amount => (amount_to_refund * 100).to_i)
+            rescue Exception => ex              
+              resp.error = "Error during refund process\n#{ex.message}"                
+            end
+            
+            if resp.error.nil?
+              it = InvoiceTransaction.create(
+                :invoice_id => self.invoice_id,
+                :parent_id => self.id,
+                :transaction_id => r.id,
+                :transaction_type => InvoiceTransaction::TYPE_REFUND, 
+                :amount => r.amount / 100.0,
+                :date_processed => DateTime.strptime(r.created.to_s, '%s'),
+                :success => r.status == 'succeeded' || r.status == 'pending'
+              )
+              if it.success
+                self.amount_refunded = (self.amount_refunded ? self.amount_refunded : 0.00) + amount_to_refund
+                self.refunded = self.amount_refunded >= self.amount                
+                self.save
+                if self.amount_refunded >= self.invoice.total
+                  self.invoice.financial_status = Invoice::FINANCIAL_STATUS_REFUNDED
+                  self.invoice.save
+                end                
+                resp.success = true
+              else
+                resp.error = "Error refunding transaction."
+              end
+            end            
+          
+        end        
+      end      
+      return resp
+    end
+    
+    def void
+      
+      resp = StdClass.new                                    
+      sc = self.invoice.site.store_config                
+      case sc.pp_name
+                                  
+        when StoreConfig::PAYMENT_PROCESSOR_STRIPE
+          return self.refund                                                                                                  
+        
+      end
+      return resp
+    end
+    
+  end
+end
+   
+