shoppe 0.0.16 → 0.0.17

data/app/models/shoppe/payment.rb

@@ -0,0 +1,80 @@
+module Shoppe
+  class Payment < ActiveRecord::Base
+    
+    # The associated order
+    #
+    # @return [Shoppe::Order]
+    belongs_to :order, :class_name => 'Shoppe::Order'
+    
+    # An associated payment (only applies to refunds)
+    #
+    # @return [Shoppe::Payment]
+    belongs_to :parent, :class_name => "Shoppe::Payment", :foreign_key => "parent_payment_id"
+    
+    # Validatiosn
+    validates :amount, :numericality => true
+    validates :reference, :presence => true
+    validates :method, :presence => true
+    
+    # Payments can have associated properties
+    key_value_store :properties
+    
+    # Callbacks
+    after_create :cache_amount_paid
+    after_destroy :cache_amount_paid
+    before_destroy { self.parent.update_attribute(:amount_refunded, self.parent.amount_refunded + amount) if self.parent }
+    
+    # Is this payment a refund?
+    #
+    # @return [Boolean]
+    def refund?
+      self.amount < BigDecimal(0)
+    end
+    
+    # Has this payment had any refunds taken from it?
+    #
+    # @return [Boolean]
+    def refunded?
+      self.amount_refunded > BigDecimal(0)
+    end
+    
+    # How much of the payment can be refunded
+    #
+    # @return [BigDecimal]
+    def refundable_amount
+      refundable? ? (self.amount - self.amount_refunded) : BigDecimal(0.0)
+    end
+    
+    # Process a refund from this payment. 
+    #
+    # @param amount [String] the amount which should be refunded
+    # @return [Boolean]
+    def refund!(amount)
+      amount = BigDecimal(amount)
+      if refundable_amount >= amount
+        transaction do
+          self.class.create(:parent => self, :order_id => self.order_id, :amount => 0-amount, :method => self.method, :reference => reference)
+          self.update_attribute(:amount_refunded, self.amount_refunded + amount)
+          true
+        end
+      else
+        raise Shoppe::Errors::RefundFailed, :message => "Refunds must be less than the payment (#{refundable_amount})"
+      end
+    end
+    
+    # Return a transaction URL for viewing further information about this
+    # payment.
+    #
+    # @return [String]
+    def transaction_url
+      nil
+    end
+    
+    private
+    
+    def cache_amount_paid
+      self.order.update_attribute(:amount_paid, self.order.payments.sum(:amount))
+    end
+    
+  end
+end

data/app/models/shoppe/product/product_attributes.rb

@@ -1,13 +1,15 @@
 module Shoppe
   class Product < ActiveRecord::Base
   
-    # Relationships
+    # Product attributes for this product
     has_many :product_attributes, -> { order(:position) }, :class_name => 'Shoppe::ProductAttribute'
   
-    # Attribute for providing the hash
+    # Used for setting an array of product attributes which will be updated. Usually
+    # received from a web browser.
     attr_accessor :product_attributes_array
-  
-    # Save the attributes after saving the record
+    
+    # After saving automatically try to update the product attributes based on the
+    # the contents of the product_attributes_array array.
     after_save do
       return unless product_attributes_array.is_a?(Array)
       self.product_attributes.update_from_array(product_attributes_array)

data/app/models/shoppe/product/variants.rb

@@ -1,26 +1,39 @@
 module Shoppe
   class Product < ActiveRecord::Base
     
-    # Relationships
+    # Validations
+    validate { errors.add :base, "can only belong to a root product" if self.parent && self.parent.parent }
+    
+    # Variants of the product
     has_many :variants, -> { order("`default` desc, name asc")}, :class_name => 'Shoppe::Product', :foreign_key => 'parent_id', :dependent => :destroy
-    belongs_to :parent, :class_name => 'Shoppe::Product', :foreign_key => 'parent_id'
     
-    # Validations
-    validate do
-      errors.add :base, "can only belong to a root product" if self.parent && self.parent.parent
-    end
+    # The parent product (only applies to variants)
+    belongs_to :parent, :class_name => 'Shoppe::Product', :foreign_key => 'parent_id'
     
-    # Scopes
+    # All products which are not variants
     scope :root, -> { where(:parent_id => nil) }
     
+    # Does this product have any variants?
+    #
+    # @return [Boolean]
     def has_variants?
       !variants.empty?
     end
     
+    # Returns the default variant for the product or nil if none exists.
+    #
+    # @return [Shoppe::Product]
     def default_variant
       return nil if self.parent
       @default_variant ||= self.variants.select { |v| v.default? }.first
     end
     
+    # Is this product a variant of another?
+    #
+    # @return [Boolean]
+    def variant?
+      !self.parent_id.blank?
+    end
+    
   end
 end

data/app/models/shoppe/product.rb

@@ -1,47 +1,33 @@
-# == Schema Information
-#
-# Table name: shoppe_products
-#
-#  id                  :integer          not null, primary key
-#  parent_id           :integer
-#  product_category_id :integer
-#  name                :string(255)
-#  sku                 :string(255)
-#  permalink           :string(255)
-#  description         :text
-#  short_description   :text
-#  active              :boolean          default(TRUE)
-#  weight              :decimal(8, 3)    default(0.0)
-#  price               :decimal(8, 2)    default(0.0)
-#  cost_price          :decimal(8, 2)    default(0.0)
-#  tax_rate_id         :integer
-#  created_at          :datetime
-#  updated_at          :datetime
-#  featured            :boolean          default(FALSE)
-#  in_the_box          :text
-#  stock_control       :boolean          default(TRUE)
-#  default             :boolean          default(FALSE)
-#
-
 module Shoppe
   class Product < ActiveRecord::Base
   
-    # Set the table name
     self.table_name = 'shoppe_products'  
   
-    # Require some concerns
+    # Add dependencies for products
     require_dependency 'shoppe/product/product_attributes'
     require_dependency 'shoppe/product/variants'
-  
-    # Attachments
+    
+    # Products have a default_image and a data_sheet
     attachment :default_image
     attachment :data_sheet
   
-    # Relationships
+    # The product's category
+    #
+    # @return [Shoppe::ProductCategory]
     belongs_to :product_category, :class_name => 'Shoppe::ProductCategory'
+    
+    # The product's tax rate
+    #
+    # @return [Shoppe::TaxRate]
     belongs_to :tax_rate, :class_name => "Shoppe::TaxRate"
+    
+    # Ordered items which are associated with this product
     has_many :order_items, :dependent => :restrict_with_exception, :class_name => 'Shoppe::OrderItem', :as => :ordered_item
+    
+    # Orders which have ordered this product
     has_many :orders, :through => :order_items, :class_name => 'Shoppe::Order'
+    
+    # Stock level adjustments for this product
     has_many :stock_level_adjustments, :dependent => :destroy, :class_name => 'Shoppe::StockLevelAdjustment', :as => :item
   
     # Validations
@@ -56,47 +42,59 @@ module Shoppe
     validates :weight, :numericality => true
     validates :price, :numericality => true
     validates :cost_price, :numericality => true, :allow_blank => true
-  
-    # Set the permalink
+    
+    # Before validation, set the permalink if we don't already have one
     before_validation { self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String) }
   
-    # Scopes
+    # All active products
     scope :active, -> { where(:active => true) }
+    
+    # All featured products
     scope :featured, -> {where(:featured => true)}
+    
+    # All products ordered with default items first followed by name ascending
     scope :ordered, -> {order('`default` desc, name asc')}
     
     # Return the name of the product
+    #
+    # @return [String]
     def full_name
       self.parent ? "#{self.parent.name} (#{name})" : name
     end
     
-    # Is this product actually orderable?
+    # Is this product orderable?
+    #
+    # @return [Boolean]
     def orderable?
       return false if self.has_variants?
       true
     end
     
-    # Return the price for the product
+    # The price for the product
+    #
+    # @return [BigDecimal]
     def price
       self.default_variant ? self.default_variant.price : read_attribute(:price)
     end
 
     # Is this product currently in stock?
+    #
+    # @return [Boolean]
     def in_stock?
       self.default_variant ? self.default_variant.in_stock? : stock > 0
     end
   
     # Return the total number of items currently in stock
+    #
+    # @return [Fixnum]
     def stock
       @stock ||= self.stock_level_adjustments.sum(:adjustment)
     end
   
-    # Specify which attributes can be searched
     def self.ransackable_attributes(auth_object = nil)
       ["id", "name", "sku"] + _ransackers.keys
     end
   
-    # Specify which associations can be searched
     def self.ransackable_associations(auth_object = nil)
       []
     end
@@ -106,6 +104,8 @@ module Shoppe
     # For example:
     #
     #   Shoppe::Product.active.with_attribute('Manufacturer', 'Apple').with_attribute('Model', ['Macbook', 'iPhone'])
+    #
+    # @return [Enumerable]
     def self.with_attributes(key, values)
       product_ids = Shoppe::ProductAttribute.searchable.where(:key => key, :value => values).pluck(:product_id).uniq
       where(:id => product_ids)

data/app/models/shoppe/product_attribute.rb

@@ -1,35 +1,25 @@
-# == Schema Information
-#
-# Table name: shoppe_product_attributes
-#
-#  id         :integer          not null, primary key
-#  product_id :integer
-#  key        :string(255)
-#  value      :string(255)
-#  position   :integer          default(1)
-#  searchable :boolean          default(TRUE)
-#  created_at :datetime
-#  updated_at :datetime
-#  public     :boolean          default(TRUE)
-#
-
 module Shoppe
   class ProductAttribute < ActiveRecord::Base
   
-    # Set the table name
     self.table_name = 'shoppe_product_attributes'  
-  
+    
     # Validations
     validates :key, :presence => true
   
-    # Relationships
+    # The associated product
+    #
+    # @return [Shoppe::Product]
     belongs_to :product, :class_name => 'Shoppe::Product'
   
-    # Scopes
+    # All attributes which are searchable
     scope :searchable, -> { where(:searchable => true) }
+    
+    # All attributes which are public
     scope :public, -> { where(:public => true) }
   
     # Return the the available options as a hash
+    #
+    # @return [Hash]
     def self.grouped_hash
       all.group_by(&:key).inject(Hash.new) do |h, (key, attributes)|
         h[key] = attributes.map(&:value).uniq
@@ -38,7 +28,9 @@ module Shoppe
     end
   
     # Create/update attributes for a product based on the provided hash of
-    # keys & values
+    # keys & values.
+    #
+    # @param array [Array]
     def self.update_from_array(array)
       existing_keys = self.pluck(:key)
       index = 0
@@ -62,6 +54,7 @@ module Shoppe
         end
       end
       self.where(:key => existing_keys - array.map { |h| h['key']}).delete_all
+      true
     end
   
   end

data/app/models/shoppe/product_category.rb

@@ -1,35 +1,22 @@
-# == Schema Information
-#
-# Table name: shoppe_product_categories
-#
-#  id          :integer          not null, primary key
-#  name        :string(255)
-#  permalink   :string(255)
-#  description :text
-#  created_at  :datetime
-#  updated_at  :datetime
-#
-
 module Shoppe
   class ProductCategory < ActiveRecord::Base
   
-    # Set the table name
     self.table_name = 'shoppe_product_categories'
   
-    # Attachments
+    # Categories have an image attachment
     attachment :image
   
-    # Relationships
+    # All products within this category
     has_many :products, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Product'
-  
+    
     # Validations
     validates :name, :presence => true
     validates :permalink, :presence => true, :uniqueness => true
 
-    # Scopes
+    # All categories ordered by their name ascending
     scope :ordered, -> { order(:name) }
-  
-    # Set the permalink
+    
+    # Set the permalink on callback
     before_validation { self.permalink = self.name.parameterize if self.permalink.blank? && self.name.is_a?(String) }
   
   end

data/app/models/shoppe/setting.rb

@@ -3,6 +3,7 @@ require 'ostruct'
 module Shoppe
   class Setting < ActiveRecord::Base
     
+    # Validations
     validates :key, :presence => true, :uniqueness => true
     validates :value, :presence => true
     validates :value_type, :presence => true
@@ -13,6 +14,8 @@ module Shoppe
     end
     
     # The encoded value for saving in the backend (as a string)
+    #
+    # @return [String]
     def encoded_value
       case value_type
       when 'Array', 'Hash'  then  value.to_json
@@ -22,6 +25,8 @@ module Shoppe
     end
     
     # The decoded value for the setting attribute (in it's native type)
+    #
+    # @return [Object]
     def decoded_value
       case value_type
       when 'Fixnum'         then  value.to_i
@@ -33,6 +38,8 @@ module Shoppe
     end
     
     # A full hash of all settings available in the current scope
+    #
+    # @return [Hash]
     def self.to_hash
       all.inject({}) do |h, setting|
         h[setting.key.to_s] = setting.decoded_value
@@ -42,6 +49,8 @@ module Shoppe
     
     # Update settings from a given hash and persist them. Accepts a 
     # hash of keys (which should be strings).
+    #
+    # @return [Hash]
     def self.update_from_hash(hash)
       existing_settings = self.all.to_a
       hash.each do |key, value|

data/app/models/shoppe/stock_level_adjustment.rb

@@ -1,23 +1,10 @@
-# == Schema Information
-#
-# Table name: shoppe_stock_level_adjustments
-#
-#  id          :integer          not null, primary key
-#  item_id     :integer
-#  item_type   :string(255)
-#  description :string(255)
-#  adjustment  :integer          default(0)
-#  parent_type :string(255)
-#  parent_id   :integer
-#  created_at  :datetime
-#  updated_at  :datetime
-#
-
 module Shoppe
   class StockLevelAdjustment < ActiveRecord::Base
     
-    # Relationships
+    # The orderable item which the stock level adjustment belongs to
     belongs_to :item, :polymorphic => true
+    
+    # The parent (OrderItem) which the stock level adjustment belongs to
     belongs_to :parent, :polymorphic => true
     
     # Validations
@@ -25,8 +12,8 @@ module Shoppe
     validates :adjustment, :numericality => true
     validate { errors.add(:adjustment, "must be greater or less than zero") if adjustment == 0 }
     
-    # Scopes
-    scope :ordered, -> { order('created_at desc') }
+    # All stock level adjustments ordered by their created date desending
+    scope :ordered, -> { order('id desc') }
     
   end
 end

data/app/models/shoppe/tax_rate.rb

@@ -1,45 +1,42 @@
-# == Schema Information
-#
-# Table name: shoppe_tax_rates
-#
-#  id          :integer          not null, primary key
-#  name        :string(255)
-#  rate        :decimal(8, 2)
-#  created_at  :datetime
-#  updated_at  :datetime
-#  country_ids :text
-#
-
 module Shoppe
   class TaxRate < ActiveRecord::Base
     
-    # Set the table name
     self.table_name = 'shoppe_tax_rates'
     
-    # Tax rates are associated with countries
     include Shoppe::AssociatedCountries
     
+    # The order address types which may be used when choosing how to apply the tax rate
+    ADDRESS_TYPES = ['billing', 'delivery']
+    
     # Validations
     validates :name, :presence => true
+    validates :address_type, :inclusion => {:in => ADDRESS_TYPES}
     validates :rate, :numericality => true
     
-    # Relationships
+    # All products which are assigned to this tax rate
     has_many :products, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Product'
+    
+    # All delivery service prices which are assigned to this tax rate
     has_many :delivery_service_prices, :dependent => :restrict_with_exception, :class_name => 'Shoppe::DeliveryServicePrice'
     
-    # Scopes
+    # All tax rates ordered by their ID
     scope :ordered, -> { order("shoppe_tax_rates.id")}
     
+    # A description of the tax rate including its name & percentage
+    #
+    # @return [String]
     def description
       "#{name} (#{rate}%)"
     end
     
+    # The rate for a given order based on the rules on the tax rate
+    #
+    # @return [BigDecimal]
     def rate_for(order)
-      if countries.empty? || order.billing_country.nil? || country?(order.billing_country)
-        self.rate
-      else
-        0.0
-      end
+      return rate if countries.empty?
+      return rate if address_type == 'billing'  && (order.billing_country.nil?   || country?(order.billing_country))
+      return rate if address_type == 'delivery' && (order.delivery_country.nil?  || country?(order.delivery_country))
+      BigDecimal(0)
     end
     
   end

data/app/models/shoppe/user.rb

@@ -1,23 +1,8 @@
-# == Schema Information
-#
-# Table name: shoppe_users
-#
-#  id              :integer          not null, primary key
-#  first_name      :string(255)
-#  last_name       :string(255)
-#  email_address   :string(255)
-#  password_digest :string(255)
-#  created_at      :datetime
-#  updated_at      :datetime
-#
-
 module Shoppe
   class User < ActiveRecord::Base
 
-    # Set the table name
     self.table_name = 'shoppe_users'
   
-    # Self explanatory I think!
     has_secure_password
   
     # Validations
@@ -26,11 +11,15 @@ module Shoppe
     validates :email_address, :presence => true
   
     # The user's first name & last name concatenated
+    #
+    # @return [String]
     def full_name
       "#{first_name} #{last_name}"
     end
   
     # The user's first name & initial of last name concatenated
+    #
+    # @return [String]
     def short_name
       "#{first_name} #{last_name[0,1]}"
     end
@@ -45,6 +34,10 @@ module Shoppe
   
     # Attempt to authenticate a user based on email & password. Returns the 
     # user if successful otherwise returns false.
+    #
+    # @param email_address [String]
+    # @param paassword [String]
+    # @return [Shoppe::User]
     def self.authenticate(email_address, password)
       user = self.where(:email_address => email_address).first
       return false if user.nil?

data/app/views/shoppe/delivery_service_prices/_form.html.haml

@@ -4,7 +4,7 @@
     .splitContainer
       %dl.third
         %dt= f.label :code
-        %dd= f.text_field :code, :class => 'text'
+        %dd= f.text_field :code, :class => 'focus text'
       
       %dl.third
         %dt= f.label :min_weight
@@ -17,10 +17,16 @@
     .splitContainer
       %dl.third
         %dt= f.label :price
-        %dd= f.text_field :price, :class => 'text'
+        %dd
+          .moneyInput
+            .currency= Shoppe.settings.currency_unit.html_safe
+            = f.text_field :price, :class => 'text'
       %dl.third
         %dt= f.label :cost_price
-        %dd= f.text_field :cost_price, :class => 'text'
+        %dd
+          .moneyInput
+            .currency= Shoppe.settings.currency_unit.html_safe
+            = f.text_field :cost_price, :class => 'text'
       %dl.third
         %dt= f.label :tax_rate_id
         %dd= f.collection_select :tax_rate_id, Shoppe::TaxRate.ordered, :id, :description, {:include_blank => true}, {:class => 'chosen-with-deselect', :data => {:placeholder => "No tax"}}

data/app/views/shoppe/delivery_service_prices/index.html.haml

@@ -10,13 +10,15 @@
   %table.data
     %thead
       %tr
-        %th Price
-        %th Weight Allowance
         %th Code
+        %th Weight Allowance
+        %th Price
+        %th Cost
     %tbody
       - for price in @delivery_service_prices
         %tr
-          %td= link_to number_to_currency(price.price), [:edit, @delivery_service, price]
+          %td= link_to price.code, [:edit, @delivery_service, price]
           %td #{number_to_weight price.min_weight} → #{number_to_weight price.max_weight}
-          %td= price.code
+          %td= number_to_currency(price.price)
+          %td= number_to_currency price.cost_price
           

data/app/views/shoppe/delivery_services/_form.html.haml

@@ -4,7 +4,7 @@
     .splitContainer
       %dl.half
         %dt= f.label :name
-        %dd= f.text_field :name, :class => 'text'
+        %dd= f.text_field :name, :class => 'focus text'
       %dl.half
         %dt= f.label :code
         %dd= f.text_field :code, :class => 'text'