spree_zone_pricing 0.1.0

data/app/models/zone_price.rb

@@ -0,0 +1,10 @@
+class ZonePrice < ActiveRecord::Base
+  belongs_to :zone
+  belongs_to :variant
+
+  validates_presence_of :price
+  validates_numericality_of :price
+  validates_presence_of :variant
+  validates_presence_of :zone
+
+end

data/app/views/admin/shared/_zone_prices.html.erb

@@ -0,0 +1,20 @@
+<table class="index">
+  <thead>
+    <tr>
+      <th><%= t("zone") %></th>
+      <th><%= t("price") %></th>
+    </tr>
+  </thead>
+  <tbody id="zone_prices">
+    <% for zone in Zone.all %>
+      <tr>
+        <td>
+          <%= zone.name %>
+        </td>
+        <td>
+          <%= text_field_tag "variant[zone_price_attributes][#{zone.id}][price]", zone.zone_prices.find_by_variant_id(@variant.id).try(:price) %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/admin/shared/_zp_product_tab.html.erb

@@ -0,0 +1,5 @@
+<% if url_options_authenticate?(:controller => 'admin/taxons') %>
+ <li <%= ' class="active"' if current == t("zone_pricing") %>>
+   <%= link_to(t("zone_pricing"), zone_prices_admin_product_variant_url(@product, @product.master)) %>
+ </li>
+<% end %>

data/app/views/admin/variants/zone_prices.html.erb

@@ -0,0 +1,15 @@
+<%= render :partial => 'admin/shared/product_sub_menu' %>
+
+<%= render :partial => 'admin/shared/product_tabs', :locals => {:current => t("zone_pricing")} %>
+
+<%= error_messages_for :variant %>
+
+<% form_for(:variant, :url => admin_product_variant_url(@product, @variant), :html => { :method => :put }) do |f| %>
+
+  <h3><%= t("zone_pricing") %></h3>
+  <%= render 'admin/shared/zone_prices' %>
+  <br/><br/>
+
+  <%= render :partial => 'admin/shared/edit_resource_links' %>
+<% end %>
+

data/app/views/shared/_country_select.html.erb

@@ -0,0 +1,7 @@
+<% form_tag :controller => 'countries', :action => 'set' do %>
+  <%= label_tag t('country')  %>
+  <%= select_tag 'id',
+    options_for_select(Country.order_by_name.collect{ |c| [c.name, c.id] }, get_user_country_id),
+     :onchange => "this.form.submit();" %>
+  <%= content_tag(:noscript, submit_tag(t('change'))) %>
+<% end %>

data/app/views/shared/_store_menu.html.erb

@@ -0,0 +1,4 @@
+<li><%= link_to t("home") , root_path %></li>
+<li class="cart-indicator"><%= link_to_cart %></li>
+<br>
+<li><%= render 'shared/country_select' %></li>

data/config/locales/en_spree.yml

@@ -0,0 +1,5 @@
+---
+en:
+  zone_pricing: "Zone Pricing"
+  country_changed: "Country changed"
+  country_not_changed: "Country was not changed"

data/config/routes.rb

@@ -0,0 +1,5 @@
+map.namespace :admin do |admin|
+   admin.resources :products do |product|
+     product.resources :variants, :member => {:zone_prices => :get}
+   end
+end

data/db/seeds.rb

@@ -0,0 +1,2 @@
+# Use this file to load your own seed data from extensions.  
+# See the db/seeds.rb file in the Spree core for some ideas on what you can do here.

data/lib/spree/zone_pricing/admin/variants_controller.rb

@@ -0,0 +1,30 @@
+module Spree::ZonePricing::Admin::VariantsController
+
+  def self.included(target)
+    target.class_eval do
+
+      create.before do
+        # Set zone product to default if they exist
+        object.set_default_zone_prices(get_user_country_id)
+        # Make sure to call original code to save
+        create_before
+      end
+
+      update.response do |wants|
+        wants.html do
+          redirect_to object.is_master ? zone_prices_admin_product_variant_url(object.product, object) : collection_url
+        end
+      end
+
+      def object
+       @object ||= Variant.find(params[:id])
+      end
+
+      def zone_prices
+        @variant = object
+        @product = @variant.product
+      end
+    end
+  end
+  
+end

data/lib/spree/zone_pricing/checkouts_controller.rb

@@ -0,0 +1,21 @@
+module Spree::ZonePricing::CheckoutsController
+  def self.included(target)
+    target.class_eval do
+      address.update_hook :update_zone_prices
+    end
+  end
+
+  private
+
+  # Check the ship country and compare against the currently selected country,
+  # if different update the order line items with the prices from the ship country
+  def update_zone_prices
+    # Same country do not update prices
+    return if get_user_country_id == object.ship_address.country.id 
+    # Update the order prices using the ship to country
+    @order.update_zone_prices(object.ship_address.country.id)
+    # Update selected country with ship to country
+    session[:zone_pricing_country] = object.ship_address.country.id
+  end
+
+end

data/lib/spree/zone_pricing/countries_controller.rb

@@ -0,0 +1,30 @@
+module Spree::ZonePricing::CountriesController
+
+  def self.included(target)
+    target.class_eval do
+
+      # Change the currently selected country
+      def set
+        country = Country.find(params[:id])
+        if request.referer && request.referer.starts_with?("http://" + request.host)
+          session[:return_to] = request.referer
+        end
+        if country
+          # Store country in the session
+          session[:zone_pricing_country] = country.id
+          # Update prices for the current order
+          if session[:order_id]
+            order = Order.find(session[:order_id])
+            order.update_zone_prices(get_user_country_id)
+          end
+          flash[:notice] = t("country_changed")
+        else
+          flash[:error] = t("country_not_changed")
+        end
+        redirect_back_or_default(root_path)
+      end
+
+    end
+  end
+  
+end

data/lib/spree/zone_pricing/get_country.rb

@@ -0,0 +1,17 @@
+module Spree::ZonePricing::GetCountry
+  def self.included(base)
+    base.class_eval do
+      # This method will retrieve the users country
+      def get_user_country_id
+        # Check if set in session
+        country = session[:zone_pricing_country] if session.has_key?(:zone_pricing_country)
+        # If no country in session, check if user has a bill address, if so use
+        # the country from the address
+        country ||= (current_user && current_user.respond_to?('ship_address') &&
+          current_user.ship_address) ? current_user.ship_address.country.id : nil
+        # If no bill address country use default country
+        country ||= Spree::Config[:default_country_id]
+      end
+    end
+  end
+end

data/lib/spree/zone_pricing/order.rb

@@ -0,0 +1,65 @@
+module Spree::ZonePricing::Order
+
+  def self.included(target)
+    target.class_eval do
+      # Override add_variant method so that we can use zone pricing
+      alias :spree_add_variant :add_variant unless method_defined?(:spree_add_variant)
+      alias :add_variant :site_add_variant
+
+      # Method to update prices in the current order when country changes
+      def update_zone_prices(country_id); order_update_zone_prices(country_id); end
+
+      # We need to know what the currently selected country is so that we can
+      # determine the zone price
+      attr_accessor :country_id
+    end
+  end
+
+  # Override the add_variant functionality so that we can adjust the price based on
+  # the country and therefore zone selected
+  def site_add_variant(variant, quantity=1)
+    current_item = contains?(variant)
+    # Added: Check if country specified, if so check if zone price defined,
+    # if no country specified use normal price
+    if @country_id
+      price = variant.zone_price(@country_id)
+    else
+      price = variant.price
+    end
+    if current_item
+      current_item.increment_quantity unless quantity > 1
+      current_item.quantity = (current_item.quantity + quantity) if quantity > 1
+      current_item.price = price # Added
+      current_item.save
+    else
+      current_item = LineItem.new(:quantity => quantity)
+      current_item.variant = variant
+      current_item.price   = price
+      self.line_items << current_item
+    end
+
+    # populate line_items attributes for additional_fields entries
+    # that have populate => [:line_item]
+    Variant.additional_fields.select{|f| !f[:populate].nil? && f[:populate].include?(:line_item) }.each do |field|
+      value = ""
+
+      if field[:only].nil? || field[:only].include?(:variant)
+        value = variant.send(field[:name].gsub(" ", "_").downcase)
+      elsif field[:only].include?(:product)
+        value = variant.product.send(field[:name].gsub(" ", "_").downcase)
+      end
+      current_item.update_attribute(field[:name].gsub(" ", "_").downcase, value)
+    end
+
+    current_item
+  end
+
+  private
+
+  # Update price of line items in current order on change
+  # of country
+  def order_update_zone_prices(country_id)
+    self.line_items.each {|li| li.update_attribute(:price, li.variant.zone_price(country_id))}
+    update_totals!
+  end
+end

data/lib/spree/zone_pricing/orders_controller.rb

@@ -0,0 +1,19 @@
+module Spree::ZonePricing::OrdersController
+  def self.included(target)
+    target.class_eval do
+      alias_method :spree_create_before, :create_before unless method_defined?(:spree_create_before)
+      alias_method :create_before, :site_create_before
+    end
+  end
+
+  # The order object needs to know which country has been selected
+  # by the user so that we can calculate the zone prices. This informations
+  # may be stored in the session which we do not have access to in the model
+  # so this method will get the currently selected country and provide it to
+  # the Order model
+  def site_create_before
+    @order.country_id = get_user_country_id if @order
+    spree_create_before
+  end
+
+end

data/lib/spree/zone_pricing/products_helper.rb

@@ -0,0 +1,30 @@
+module Spree::ZonePricing::ProductsHelper
+  def self.included(base)
+    base.class_eval do
+      alias_method :spree_product_price, :product_price unless method_defined?(:spree_product_price)
+      alias_method :product_price, :site_product_price
+    end
+  end
+
+  # returns the price of the product to show for display purposes
+  def site_product_price(product_or_variant, options={})
+    options.assert_valid_keys(:format_as_currency, :show_vat_text)
+    options.reverse_merge! :format_as_currency => true, :show_vat_text => Spree::Config[:show_price_inc_vat]
+
+    # Check if this object is a product, if so then access the master variant
+    # record for the product to get the zone pricing
+    object = product_or_variant.is_a?(Product) ? product_or_variant.master : product_or_variant
+
+    # Get the zone price for this variant/product if one is defined
+    # otherwise use the normal price
+    if object.respond_to?(:zone_price)
+      amount = object.zone_price(get_user_country_id)
+    else
+      amount = object.price
+    end
+
+    amount += Calculator::Vat.calculate_tax_on(product_or_variant) if Spree::Config[:show_price_inc_vat]
+    options.delete(:format_as_currency) ? format_price(amount, options) : ("%0.2f" % amount).to_f
+  end
+
+end

data/lib/spree/zone_pricing/variant.rb

@@ -0,0 +1,52 @@
+module Spree::ZonePricing::Variant
+
+  def self.included(target)
+    target.class_eval do
+      has_many :zone_prices, :dependent => :destroy
+      has_many :zones, :through => :zone_prices
+
+      # Update zone prices for variant from attributes
+      # passed to us from the form
+      def zone_price_attributes=(price_attributes)
+        price_attributes.each do |key, value|
+          # Check if record exists, if so update. If value of price
+          # is blank or 0 then delete record
+          zone_price = ZonePrice.first(:conditions => {:zone_id => key, :variant_id => self.id})
+          if zone_price
+            # Record exists, update or delete if no price specified
+            if value['price'].to_f != 0
+              zone_price.update_attribute(:price, value['price'].to_f)
+            else
+              zone_price.destroy
+            end
+          elsif value['price'].to_f != 0
+            # Record does not exist, create
+            ZonePrice.create(:zone_id => key, :variant => self, :price => value['price'].to_f)
+          end
+        end
+      end
+
+      # Return zone price if defined otherwise return normal price
+      def zone_price(country_id)
+        # Find zone and check if zone price set for the product/variant
+        zone = Country.find(country_id).zone
+        zone_price = self.zone_prices.find_by_zone_id(zone.id) if zone && self.respond_to?('zone_prices')
+        if zone_price
+          # Zone price set us it
+          amount = zone_price.price
+        else
+          amount = self.price
+        end
+      end
+
+      # Method to default variant zone prices to the product zone prices
+      def set_default_zone_prices(country_id)
+        return if self.product.master.zone_prices.size <= 0 # No zone prices specified for product
+        # Assign product zone prices as defaults
+        self.product.master.zone_prices.each {|zp| self.zone_prices.build(zp.attributes)}
+      end
+
+    end
+  end
+
+end

data/lib/spree/zone_pricing/zone.rb

@@ -0,0 +1,10 @@
+module Spree::ZonePricing::Zone
+
+  def self.included(target)
+    target.class_eval do
+      has_many :zone_prices, :dependent => :destroy
+      has_many :variants, :through => :zone_prices
+    end
+  end
+  
+end

data/lib/spree_zone_pricing.rb

@@ -0,0 +1,5 @@
+class SpreeZonePrincing
+  def self.hi
+    puts "Hello world!"
+  end
+end

data/lib/tasks/zone_pricing_extension_tasks.rake

@@ -0,0 +1,17 @@
+namespace :spree do
+  namespace :extensions do
+    namespace :zone_pricing do
+      desc "Copies public assets of the Zone Pricing to the instance public/ directory."
+      task :update => :environment do
+        is_svn_git_or_dir = proc {|path| path =~ /\.svn/ || path =~ /\.git/ || File.directory?(path) }
+        Dir[ZonePricingExtension.root + "/public/**/*"].reject(&is_svn_git_or_dir).each do |file|
+          path = file.sub(ZonePricingExtension.root, '')
+          directory = File.dirname(path)
+          puts "Copying #{path}..."
+          mkdir_p RAILS_ROOT + directory
+          cp file, RAILS_ROOT + path
+        end
+      end  
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+unless defined? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require ENV["SPREE_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{SPREE_ROOT}/spec/spec_helper"
+
+if File.directory?(File.dirname(__FILE__) + "/scenarios")
+  Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+end
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/zone_pricing_extension.rb

@@ -0,0 +1,44 @@
+# Uncomment this if you reference any of your controllers in activate
+# require_dependency 'application'
+
+class ZonePricingExtension < Spree::Extension
+  version "1.0"
+  description "Allows prices to be set by zone"
+  url "http://yourwebsite.com/zone_pricing"
+
+  # Please use zone_pricing/config/routes.rb instead for extension routes.
+
+  # def self.require_gems(config)
+  #   config.gem "gemname-goes-here", :version => '1.2.3'
+  # end
+  
+  def activate
+
+    # Add helper to retrieve the users country
+    ApplicationHelper.send(:include, Spree::ZonePricing::GetCountry)
+    # Add helper to retrieve the users country, used by a number of controllers
+    Spree::BaseController.send(:include, Spree::ZonePricing::GetCountry)
+
+    # Add additional associations to allow m:m relationship
+    # between zones<->variants
+    Zone.send(:include, Spree::ZonePricing::Zone)
+    Variant.send(:include, Spree::ZonePricing::Variant)
+
+    # Override add_variant method so that we can use zone pricing
+    Order.send(:include, Spree::ZonePricing::Order)
+
+    # Override price
+    ProductsHelper.send(:include, Spree::ZonePricing::ProductsHelper)
+
+    # Add action to countries controller to handle country selection
+    CountriesController.send(:include, Spree::ZonePricing::CountriesController)
+    # Add code to set the currently country in the order
+    OrdersController.send(:include, Spree::ZonePricing::OrdersController)
+    # Add code to save zone prices
+    Admin::VariantsController.send(:include, Spree::ZonePricing::Admin::VariantsController)
+    # Add code to check zone prices after address is saved during checkout, if ship
+    # country not the same change prices in order
+    CheckoutsController.send(:include, Spree::ZonePricing::CheckoutsController)
+
+  end
+end

data/zone_pricing_hooks.rb

@@ -0,0 +1,9 @@
+class ZonePricingHooks < Spree::ThemeSupport::HookListener
+
+  # Add zone pricing tab to products admin area
+  insert_after :admin_product_tabs, :partial => "admin/shared/zp_product_tab"
+
+  # Add zone pricing to variant edit form
+  insert_after :admin_variant_edit_form, :partial => 'admin/shared/zone_prices'
+
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: spree_zone_pricing
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Henrique Ferreira
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-18 00:00:00.000000000 Z
+dependencies: []
+description: Set different price zones within Spree (Based in spree-zone-pricing)
+email: henriquebf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/zone_price.rb
+- app/views/admin/shared/_zone_prices.html.erb
+- app/views/admin/shared/_zp_product_tab.html.erb
+- app/views/admin/variants/zone_prices.html.erb
+- app/views/shared/_country_select.html.erb
+- app/views/shared/_store_menu.html.erb
+- config/routes.rb
+- config/locales/en_spree.yml
+- db/seeds.rb
+- lib/spree_zone_pricing.rb
+- lib/spree/zone_pricing/checkouts_controller.rb
+- lib/spree/zone_pricing/countries_controller.rb
+- lib/spree/zone_pricing/get_country.rb
+- lib/spree/zone_pricing/order.rb
+- lib/spree/zone_pricing/orders_controller.rb
+- lib/spree/zone_pricing/products_helper.rb
+- lib/spree/zone_pricing/variant.rb
+- lib/spree/zone_pricing/zone.rb
+- lib/spree/zone_pricing/admin/variants_controller.rb
+- lib/tasks/zone_pricing_extension_tasks.rake
+- spec/spec.opts
+- spec/spec_helper.rb
+- zone_pricing_extension.rb
+- zone_pricing_hooks.rb
+homepage: http://rubygems.org/gems/spree_zone_pricing
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Spree Zone Pricing
+test_files: []