shoppe 0.0.16 → 0.0.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcbba75865dfb23d23a64375e7706b6664bc1d19
+  data.tar.gz: f5b5ae13ac740c329f9f1b693a42708c632e6530
+SHA512:
+  metadata.gz: 8cab21ef5ecd835b5a6afb468c1aa5dbc2a6064ffe536e72e0da60f1bac1ce6c4b1d61b7e60a66e67366a9736bbb47b3afbd74cef97126d2061abeb05ad0786e
+  data.tar.gz: ac7abebddd19f138855ed9cc86bda752bf3a2eb9d6156f717abc5dc7f839ab2c48919057e206d4e5f0c51013295d5c1fa7e1b549b5156d52e86f055d39a737a7

data/Rakefile

@@ -18,16 +18,15 @@ Rake::TestTask.new(:test) do |t|
 end
 
 namespace :shoppe do
-  
-  desc "Generate RDoc documentation into doc/"
-  task :generate_docs do
-    system("rm -Rf doc")
-    system("bundle exec sdoc app/models lib README.rdoc")
+  desc 'Publish the release notes'
+  task :changelog do
+    system "scp CHANGELOG.md rubyapps@tryshoppe.com:/opt/rubyapps/shoppe-website/shared/CHANGELOG.md"
   end
   
   desc "Publish RDoc documentation from doc to api.tryshoppe.com"
-  task :publish_docs do
+  task :docs do
     if File.exist?("doc")
+      system "yard"
       system "ssh root@tryshoppe.com rm -Rf /var/www/shoppe-api"
       system "scp -r doc root@tryshoppe.com:/var/www/shoppe-api"
     else

data/app/assets/javascripts/shoppe/application.coffee

@@ -42,12 +42,23 @@ $ ->
   # Chosen
   $('select.chosen').chosen()
   $('select.chosen-with-deselect').chosen({allow_single_deselect: true})
+  $('select.chosen-basic').chosen({disable_search_threshold:100})
   
   # Printables
   $('a[rel=print]').on 'click', ->
     window.open($(this).attr('href'), 'despatchnote', 'width=700,height=800')
     false
   
+  # Order editting
+  toggleDeliveryFieldsetForOrder = ->
+    fieldset = $('form.edit_order fieldset.delivery')
+    if $('form.edit_order input#order_separate_delivery_address').prop('checked') then fieldset.show() else fieldset.hide()
+  $('form.edit_order input#order_separate_delivery_address').on 'change', toggleDeliveryFieldsetForOrder
+  toggleDeliveryFieldsetForOrder()
+  
+  # Close dialog
+  $('body').on 'click', 'a[rel=closeDialog]', Nifty.Dialog.closeTopDialog
+  
   # Open AJAX dialogs
   $('a[rel=dialog]').on 'click', ->
     element = $(this)
@@ -59,6 +70,14 @@ $ ->
     options.url = element.attr('href')
     Nifty.Dialog.open(options)
     false
+  
+  # Format money values to 2 decimal places
+  formatMoneyField = ->
+    value = $(this).val()
+    if value.length
+      $(this).val(parseFloat(value).toFixed(2))
+  $('div.moneyInput input').each formatMoneyField
+  $('div.moneyInput input').on('blur', formatMoneyField)
 
 #
 # Stock Level Adjustment dialog beavior

data/app/assets/stylesheets/shoppe/application.scss

@@ -129,17 +129,25 @@ header.main {
 		&.received { color:#909091; background-image:image-url('shoppe/statuses/received.svg'); }
 	}
 	
+	//
+	// fieldset
+	//
+	fieldset {
+		border:1px solid #dce2eb;
+		background:#fff;
+		padding-top:15px;
+		padding-bottom:25px;
+		margin-bottom:15px;
+		legend {color:#5B6270; margin:0 25px; font-weight:300; font-size:1.5em;}
+		&.padded { padding:15px 25px 25px 25px;}
+		&.padded legend { margin:0;}
+	}
+	
 	//
 	// forms
 	//
 	form {
 		fieldset {
-			border:1px solid #dce2eb;
-			background:#fff;
-			padding-top:15px;
-			padding-bottom:25px;
-			margin-bottom:15px;
-			legend {color:#5B6270; margin:0 25px; font-weight:300; font-size:1.5em;}
 
 			.splitContainer { margin:0 25px; margin-bottom:15px; height:50px;}
 			.splitContainer:last-child { margin-bottom:0;}
@@ -162,6 +170,8 @@ header.main {
 					padding-top:4px;
 					input,label { margin-right:10px;}
 				}
+				dd.space { margin-bottom:5px;}
+				dd.space:last-child { margin-bottom:0;}
 				&.half {
 					width:49%;
 					margin:0;
@@ -272,6 +282,7 @@ header.main {
 			dl {
 				dt { float:left; width:30%; text-align:right; color:#888;white-space:nowrap}
 				dd { font-weight:bold; margin-left:35%; margin-bottom:6px; white-space:nowrap}
+				dd a { color:inherit;}
 				dt.padding { padding-top:6px;}
 			}
 			
@@ -289,7 +300,7 @@ header.main {
 			margin:45px 0;
 			overflow:hidden;
 			ul {
-				li { width:25%;float:left; text-align:center; background:image-url('shoppe/statuses/shipped.svg') no-repeat center 0; background-size:36px; padding-top:42px;z-index:10;}
+				li { width:33%;float:left; text-align:center; background:image-url('shoppe/statuses/shipped.svg') no-repeat center 0; background-size:36px; padding-top:42px;z-index:10;}
 				h4 { color:#E32479;}
 				li p { margin-top:5px; font-size:0.9em; color:#999;}
 				li a { color:inherit;}
@@ -304,29 +315,50 @@ header.main {
 			}
 		}
 		
-		.notes {
-			background:#fff;
-			border:1px solid #CED2D8;
-			p { padding:15px;}
-			p textarea { border:0; padding:0; width:100%; resize:none; height:100px; font-family:$font; font-size:1.1em}
-			h4 { background:#F7F9FC; padding:10px 15px; font-weight:500;}
-			h4 input { float:right; margin-top:-3px;}
-		}
-		
 		.order_items {
-			margin:25px 0;
 			table.data {
  				.money { text-align:right; width:8%}
 				.product { width:42%;}
 				.sku { width:18%;}
 				.qty {text-align:center; width:5%;}
-				tfoot td { background:#5B6270; color:#fff; border:1px solid #5B6270; font-weight:bold; font-size:1.1em;}
 			}
 		}
 	}
 	
 	//
-	// orer search
+	// payments
+	//
+	fieldset.orderPayments {
+		h4 { font-weight:bold; text-transform:uppercase; color:#5B6270;}
+		.table {
+			margin-bottom:20px;
+			table td.refund { width:10%; text-align:center;}
+			table td.confirmed { width:5%; text-align:center;}
+		}
+		form {
+			overflow:hidden;
+			background:#F7F9FC;
+			border:1px solid #DCE2EB;
+			padding:15px;
+			dl {
+				width:23%;float:left;
+				dt {  margin-bottom:4px; font-size:0.9em;color:#A9AEB5; font-weight:500;}
+				&.text { width:27%;margin-right:2%;}
+				&.amount { width:25%;}
+				&.submit { width:15%; text-align:right; margin-top:15px;}
+			}
+		}
+		p.notice {
+			background:#fffff3;
+			padding:10px;
+			color:#F67C00;
+			border:1px solid #F6B721;
+			margin-bottom:15px;
+		}
+	}
+	
+	//
+	// order search
 	//
 	div.orderSearch {
 		overflow:hidden;
@@ -366,13 +398,22 @@ footer {
 	}
 }
 
-span.boolean span.true { color:#38BA4F}
+span.boolean span.true { color:#96BF48}
 span.boolean span.false { color:#c04a4a}
 
 .float-right { float:right;}
 
 div.field_with_errors { display:inline;}
 
+//
+// money input box
+//
+div.moneyInput {
+	overflow:hidden;
+	div.currency {float:left; background:#f3f6ec; color:#74884a; padding:5px; width:20px; text-align:center;border:1px solid #c5ceb1; font-size:1.1em; border-right:0;}
+	input {  width:100px; font-size:1.1em;}
+}
+
 //
 // standard text input box
 //
@@ -425,6 +466,7 @@ div.table {
 			td.desc input[type=text] { width:95%;}
 			td.adjustment input[type=text] { width:50px; margin-right:5px;}
 		}
+		tfoot td { background:#5B6270; color:#fff; border:1px solid #5B6270; font-weight:bold; font-size:1.1em;}
 	}
 }
 

data/app/assets/stylesheets/shoppe/{chosen.css → chosen.scss}

@@ -74,7 +74,7 @@
   display: block;
   width: 12px;
   height: 12px;
-  background: url('chosen-sprite.png') -42px 1px no-repeat;
+  background: image-url('shoppe/chosen-sprite.png') -42px 1px no-repeat;
   font-size: 1px;
 }
 .chosen-container-single .chosen-single abbr:hover {
@@ -95,7 +95,7 @@
   display: block;
   width: 100%;
   height: 100%;
-  background: url('chosen-sprite.png') no-repeat 0px 2px;
+  background: image-url('shoppe/chosen-sprite.png') no-repeat 0px 2px;
 }
 .chosen-container-single .chosen-search {
   position: relative;
@@ -114,12 +114,12 @@
   height: auto;
   outline: 0;
   border: 1px solid #ccc;
-  background: white url('chosen-sprite.png') no-repeat 100% -20px;
-  background: url('chosen-sprite.png') no-repeat 100% -20px, -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
-  background: url('chosen-sprite.png') no-repeat 100% -20px, -webkit-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background: url('chosen-sprite.png') no-repeat 100% -20px, -moz-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background: url('chosen-sprite.png') no-repeat 100% -20px, -o-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background: url('chosen-sprite.png') no-repeat 100% -20px, linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: white image-url('shoppe/chosen-sprite.png') no-repeat 100% -20px;
+  background: image-url('shoppe/chosen-sprite.png') no-repeat 100% -20px, -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
+  background: image-url('shoppe/chosen-sprite.png') no-repeat 100% -20px, -webkit-linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: image-url('shoppe/chosen-sprite.png') no-repeat 100% -20px, -moz-linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: image-url('shoppe/chosen-sprite.png') no-repeat 100% -20px, -o-linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: image-url('shoppe/chosen-sprite.png') no-repeat 100% -20px, linear-gradient(#eeeeee 1%, #ffffff 15%);
   font-size: 1em;
   font-family: sans-serif;
   line-height: normal;
@@ -197,17 +197,12 @@
   -moz-box-sizing: border-box;
   box-sizing: border-box;
   margin: 0;
-  padding: 0;
+  padding: 5px;
   width: 100%;
   height: auto !important;
   height: 1%;
   border: 1px solid #ccc;
   background-color: #fff;
-  background-image: -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
-  background-image: -webkit-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background-image: -moz-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background-image: -o-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background-image: linear-gradient(#eeeeee 1%, #ffffff 15%);
   cursor: text;
 }
 .chosen-container-multi .chosen-choices li {
@@ -261,7 +256,7 @@
   display: block;
   width: 12px;
   height: 12px;
-  background: url('chosen-sprite.png') -42px 1px no-repeat;
+  background: image-url('shoppe/chosen-sprite.png') -42px 1px no-repeat;
   font-size: 1px;
 }
 .chosen-container-multi .chosen-choices li.search-choice .search-choice-close:hover {
@@ -298,7 +293,7 @@
 /* @group Active  */
 .chosen-container-active .chosen-single {
   border: 1px solid #9AC835;
-  box-shadow: 0 0 5px rgba(0, 0, 0, 0.3);
+  //box-shadow: 0 0 5px rgba(0, 0, 0, 0.3);
 }
 .chosen-container-active.chosen-with-drop .chosen-single {
   border: 1px solid #ccc;
@@ -322,7 +317,6 @@
 }
 .chosen-container-active .chosen-choices {
   border: 1px solid #9AC835;
-  box-shadow: 0 0 5px rgba(0, 0, 0, 0.3);
 }
 .chosen-container-active .chosen-choices li.search-field input[type="text"] {
   color: #111 !important;
@@ -397,12 +391,12 @@
 }
 .chosen-rtl .chosen-search input[type="text"] {
   padding: 4px 5px 4px 20px;
-  background: white url('chosen-sprite.png') no-repeat -30px -20px;
-  background: url('chosen-sprite.png') no-repeat -30px -20px, -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
-  background: url('chosen-sprite.png') no-repeat -30px -20px, -webkit-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background: url('chosen-sprite.png') no-repeat -30px -20px, -moz-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background: url('chosen-sprite.png') no-repeat -30px -20px, -o-linear-gradient(#eeeeee 1%, #ffffff 15%);
-  background: url('chosen-sprite.png') no-repeat -30px -20px, linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: white image-url('shoppe/chosen-sprite.png') no-repeat -30px -20px;
+  background: image-url('shoppe/chosen-sprite.png') no-repeat -30px -20px, -webkit-gradient(linear, 50% 0%, 50% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff));
+  background: image-url('shoppe/chosen-sprite.png') no-repeat -30px -20px, -webkit-linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: image-url('shoppe/chosen-sprite.png') no-repeat -30px -20px, -moz-linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: image-url('shoppe/chosen-sprite.png') no-repeat -30px -20px, -o-linear-gradient(#eeeeee 1%, #ffffff 15%);
+  background: image-url('shoppe/chosen-sprite.png') no-repeat -30px -20px, linear-gradient(#eeeeee 1%, #ffffff 15%);
   direction: rtl;
 }
 .chosen-rtl.chosen-container-single .chosen-single div b {
@@ -422,7 +416,7 @@
   .chosen-container-multi .chosen-choices .search-choice .search-choice-close,
   .chosen-container .chosen-results-scroll-down span,
   .chosen-container .chosen-results-scroll-up span {
-    background-image: url('chosen-sprite@2x.png') !important;
+    background-image: image-url('shoppe/chosen-sprite@2x.png') !important;
     background-size: 52px 37px !important;
     background-repeat: no-repeat !important;
   }

data/app/assets/stylesheets/shoppe/dialog.scss

@@ -1,10 +1,25 @@
 div.niftyDialog {
 	h2 {
 		background:#fff;
-		border-bottom:1px solid #efefef;
-		font-size:1.2em;
+		border:0;
+		padding:0;
+		font-size:1.3em;
+		border-bottom:1px solid #000;
+		padding-bottom:4px;
+		margin-bottom:10px;
 		color:#111;
 	}
 	padding:15px;
 	nav.pagination { margin:0; margin-top:15px;}
+	p.intro { line-height:1.5; color:#666; margin:6px 0;}
+	
+	form.refundForm {
+		overflow:hidden;
+		margin:10px;
+		p.intro { margin-bottom:25px;}
+		.moneyInput { float:left; }
+		.moneyInput .currency { font-size:1.4em;}
+		.moneyInput input { font-size:1.4em}
+		p.submit { float:right;}
+	}
 }

data/app/controllers/shoppe/orders_controller.rb

@@ -8,10 +8,17 @@ module Shoppe
       @query = Shoppe::Order.ordered.received.includes(:order_items => :ordered_item).page(params[:page]).search(params[:q])
       @orders = @query.result
     end
+    
+    def show
+      @payments = @order.payments.to_a
+    end
   
     def update
-      @order.update_attributes!(params[:order].permit(:notes))
-      redirect_to @order, :notice => "Order has been saved successfully"
+      if @order.update_attributes(params[:order].permit(:notes, :first_name, :last_name, :company, :billing_address1, :billing_address2, :billing_address3, :billing_address4, :billing_postcode, :billing_country_id, :separate_delivery_address,:delivery_name, :delivery_address1, :delivery_address2, :delivery_address3, :delivery_address4, :delivery_postcode, :delivery_country_id, :email_address, :phone_number))
+        redirect_to @order, :notice => "Order has been saved successfully"
+      else
+        render :action => "edit"
+      end
     end
   
     def search
@@ -34,11 +41,6 @@ module Shoppe
       redirect_to @order, :notice => "Order has been shipped successfully"
     end
   
-    def pay
-      @order.pay!(params[:payment_reference], params[:payment_method].blank? ? 'Unknown' : params[:payment_method])
-      redirect_to @order, :notice => "Order has been marked as paid successfully"
-    end
-    
     def despatch_note
       render :layout => 'shoppe/printable'
     end

data/app/controllers/shoppe/payments_controller.rb

@@ -0,0 +1,33 @@
+module Shoppe
+  class PaymentsController < ApplicationController
+    
+    before_filter { @order = Shoppe::Order.find(params[:order_id]) }
+    before_filter { params[:id] && @payment = @order.payments.find(params[:id]) }
+    
+    def create
+      payment = @order.payments.build(params[:payment].permit(:amount, :method, :reference))
+      if payment.save
+        redirect_to @order, :notice => "Payment has been added successfully"
+      else
+        redirect_to @order, :alert => payment.errors.full_messages.to_sentence
+      end
+    end
+    
+    def destroy
+      @payment.destroy
+      redirect_to @order, :notice => "Payment has been removed successfully"
+    end
+    
+    def refund
+      if request.post?
+        @payment.refund!(params[:amount])
+        redirect_to @order, :notice => "Refund has been processed successfully."
+      else
+        render :layout => false
+      end
+    rescue Shoppe::Errors::RefundFailed => e
+      redirect_to @order, :alert => e.message
+    end
+    
+  end
+end

data/app/controllers/shoppe/settings_controller.rb

@@ -4,6 +4,10 @@ module Shoppe
     before_filter { @active_nav = :settings }
     
     def update
+      if Shoppe.settings.demo_mode?
+        raise Shoppe::Error, "You cannot make changes to settings in demo mode. Sorry about that."
+      end
+      
       Shoppe::Setting.update_from_hash(params[:settings].permit!)
       redirect_to :settings, :notice => "Settings have been updated successfully."
     end

data/app/controllers/shoppe/tax_rates_controller.rb

@@ -42,7 +42,7 @@ module Shoppe
     private
   
     def safe_params
-      params[:tax_rate].permit(:name, :rate, :country_ids => [])
+      params[:tax_rate].permit(:name, :rate, :address_type, :country_ids => [])
     end
   
   end

data/app/controllers/shoppe/users_controller.rb

@@ -5,7 +5,7 @@ module Shoppe
     before_filter { params[:id] && @user = Shoppe::User.find(params[:id]) }
     before_filter(:only => [:create, :update, :destroy]) do
       if Shoppe.settings.demo_mode?
-        raise Shoppe::Error, "You cannot make changes to user in demo mode. Sorry about that."
+        raise Shoppe::Error, "You cannot make changes to users in demo mode. Sorry about that."
       end
     end
   

data/app/helpers/shoppe/application_helper.rb

@@ -1,15 +1,6 @@
 module Shoppe
   module ApplicationHelper
   
-    def number_to_currency(number, options = {})
-      options[:unit] ||= Shoppe.settings.currency_unit
-      super
-    end
-  
-    def number_to_weight(kg)
-      "#{kg}#{t('shoppe.helpers.number_to_weight.kg', :default => 'kg')}"
-    end
-  
     def status_tag(status)
       content_tag :span, status, :class => "status-tag #{status}"
     end

data/app/models/shoppe/country.rb

@@ -1,30 +1,27 @@
-# == Schema Information
-#
-# Table name: shoppe_countries
-#
-#  id        :integer          not null, primary key
-#  name      :string(255)
-#  code2     :string(255)
-#  code3     :string(255)
-#  continent :string(255)
-#  tld       :string(255)
-#  currency  :string(255)
-#  eu_member :boolean          default(FALSE)
-#
-
 module Shoppe
+  
+  # The Shoppe::Country model stores countries which can be used for delivery & billing
+  # addresses for orders.
+  #
+  # You can use the Shoppe::CountryImporter to import a pre-defined list of countries 
+  # into your database. This automatically happens when you run the 'shoppe:setup' 
+  # rake task.
+  
   class Country < ActiveRecord::Base
-
-    # Set the table name
+    
     self.table_name = 'shoppe_countries'
-
-    # Relationships
+    
+    # All orders which have this country set as their billing country
     has_many :billed_orders, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Order', :foreign_key => 'billing_country_id'
-    has_many :delivered_orders, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Order', :foreign_key => 'delivery_country_id'
     
+    # All orders which have this country set as their delivery country
+    has_many :delivered_orders, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Order', :foreign_key => 'delivery_country_id'
     
-    # Scopes
+    # All countries ordered by their name asending
     scope :ordered, -> { order('shoppe_countries.name asc') }
     
+    # Validations
+    validates :name, :presence => true
+    
   end
 end

data/app/models/shoppe/delivery_service.rb

@@ -1,38 +1,32 @@
-# == Schema Information
-#
-# Table name: shoppe_delivery_services
-#
-#  id           :integer          not null, primary key
-#  name         :string(255)
-#  code         :string(255)
-#  default      :boolean          default(FALSE)
-#  active       :boolean          default(TRUE)
-#  created_at   :datetime
-#  updated_at   :datetime
-#  courier      :string(255)
-#  tracking_url :string(255)
-#
-
 module Shoppe
   class DeliveryService < ActiveRecord::Base
   
-    # Set the table name
     self.table_name = 'shoppe_delivery_services'
-  
+
     # Validations
     validates :name, :presence => true
     validates :courier, :presence => true
   
-    # Relationships
+    # Orders which are assigned to this delivery service
     has_many :orders, :dependent => :restrict_with_exception, :class_name => 'Shoppe::Order'
+    
+    # Prices for the different levels of service within this delivery service
     has_many :delivery_service_prices, :dependent => :destroy, :class_name => 'Shoppe::DeliveryServicePrice'
   
-    # Scopes
+    # All active delivery services
     scope :active, -> { where(:active => true)}
   
-    # Return the tracking URL for the given consignment number
-    def tracking_url_for(consignment_number)
-      tracking_url.gsub("{{consignment_number}}", consignment_number)
+    # Returns a tracking URL for the passed order
+    #
+    # @param order [Shoppe::Order]
+    # @return [String] the full URL for the order.
+    def tracking_url_for(order)
+      return nil if self.tracking_url.blank?
+      tracking_url = self.tracking_url.dup
+      tracking_url.gsub!("{{consignment_number}}", CGI.escape(order.consignment_number.to_s))
+      tracking_url.gsub!("{{delivery_postcode}}", CGI.escape(order.delivery_postcode.to_s))
+      tracking_url.gsub!("{{billing_postcode}}", CGI.escape(order.billing_postcode.to_s))
+      tracking_url
     end
 
   end

data/app/models/shoppe/delivery_service_price.rb

@@ -1,41 +1,30 @@
-# == Schema Information
-#
-# Table name: shoppe_delivery_service_prices
-#
-#  id                  :integer          not null, primary key
-#  delivery_service_id :integer
-#  code                :string(255)
-#  price               :decimal(8, 2)
-#  cost_price          :decimal(8, 2)
-#  tax_rate_id         :integer
-#  min_weight          :decimal(8, 2)
-#  max_weight          :decimal(8, 2)
-#  created_at          :datetime
-#  updated_at          :datetime
-#  country_ids         :text
-#
-
 module Shoppe
   class DeliveryServicePrice < ActiveRecord::Base
 
     # Set the table name
     self.table_name = 'shoppe_delivery_service_prices'
   
-    # Tax rates are associated with countries
     include Shoppe::AssociatedCountries
   
-    # Relationships
+    # The delivery service which this price belongs to
     belongs_to :delivery_service, :class_name => 'Shoppe::DeliveryService'
+    
+    # The tax rate which should be applied
     belongs_to :tax_rate, :class_name => "Shoppe::TaxRate"
-  
+    
     # Validations
+    validates :code, :presence => true
     validates :price, :numericality => true
     validates :cost_price, :numericality => true, :allow_blank => true
     validates :min_weight, :numericality => true
     validates :max_weight, :numericality => true
   
-    # Scopes
+    # All prices ordered by their price ascending
     scope :ordered, -> { order('price asc')}
+    
+    # All prices which are suitable for the weight passed.
+    #
+    # @param weight [BigDecimal] the weight of the order
     scope :for_weight, -> weight { where("min_weight <= ? AND max_weight >= ?", weight, weight) }
   
   end