merchant_sidekick 0.4.2

data/lib/merchant_sidekick/shopping_cart/line_item.rb

@@ -0,0 +1,152 @@
+# MerchantSidekick::ShoppingCart::LineItem duplicates the actual purchasable product upon putting a product into a cart.
+# This is necessary, because we want to maintain order information even after the product
+# might have already been removed from the system.
+#
+# This class copies many of the product attributes, because product rows usually undergo
+# constant changes (description, price, etc.), while the cart_line_item will remain unchanged
+# during its lifetime.
+module MerchantSidekick
+  module ShoppingCart
+    class LineItem < ActiveRecord::Base
+      self.table_name = "cart_line_items"
+
+      attr_accessor :options
+
+      belongs_to :product, :polymorphic => true
+      money :unit_price, :cents => "cents", :currency => "currency"
+      acts_as_sellable
+
+      validates_presence_of :product
+
+      def options=(some_options={})
+        @options = some_options.to_hash
+      end
+
+      def options
+        @options || {}
+      end
+
+      def product_with_price=(a_product)
+        if a_product && (a_product.respond_to?(:price) || a_product.respond_to?(:copy_price))
+          self[:taxable] = if a_product.respond_to?(:taxable?)
+            a_product.send(:taxable?)
+          elsif a_product.respond_to?(:taxable)
+            a_product.send(:taxable)
+          else
+            false
+          end
+          self[:unit] = a_product.respond_to?(:unit) ? a_product.unit.to_s : 'piece'
+          self[:pieces] = a_product.respond_to?(:pieces) ? a_product.pieces : 1,
+
+          # name from product copy_name method, name or title column
+          self[:name] = if a_product.respond_to?(:copy_name)
+            a_product.send(:copy_name, self.options)
+          elsif a_product.respond_to?(:title)
+            a_product.send(:title)
+          elsif a_product.respond_to?(:name)
+            a_product.send(:name)
+          else
+            'No name'
+          end
+
+          # item_number from product copy_iten_number method, sku or number column
+          self[:item_number] = if a_product.respond_to?(:copy_item_number)
+            a_product.send(:copy_item_number, self.options)
+          elsif a_product.respond_to?(:sku)
+            a_product.send(:sku)
+          elsif a_product.respond_to?(:number)
+            a_product.send(:number)
+          else
+            a_product.id unless a_product.new_record?
+          end
+
+          # description from product copy_description or description column
+          self[:description] = if a_product.respond_to?(:copy_description)
+            a_product.send(:copy_description, self.options)
+          elsif a_product.respond_to?(:description)
+            a_product.send(:description)
+          else
+            'No description'
+          end
+
+          # unit price
+          product_unit_price = if a_product.respond_to?(:copy_price)
+            a_product.send(:copy_price, self.options)
+          else
+            a_product.send(:price)
+          end
+          product_unit_price = ::Money.new(1, self.currency || 'USD') + product_unit_price - ::Money.new(1, self.currency || 'USD')
+          self.unit_price = product_unit_price
+        end
+        self.product_without_price = a_product
+      end
+      alias_method_chain :product=, :price
+
+      # overwrites from taxable? from acts_as_sellable
+      # Important! don't change this to is_taxable?, rather alias it!
+      def taxable?
+        self.taxable
+      end
+      alias_method :is_taxable?, :taxable?
+
+      # overwrites from price_is_net? from product
+      def price_is_net?
+        if self.product
+          return self.product.send(:price_is_net?) if self.product.respond_to?(:price_is_net?)
+        end
+        true
+      end
+
+      # overwrites from price_is_gross? from acts_as_sellable
+      def price_is_gross?
+        !price_is_net?
+      end
+
+      # Returns a product name and sets the title attribute
+      def name
+        self[:name]
+      end
+
+      # returns or sets the item number based on the product's
+      # SKU, number, or id
+      def item_number
+        self[:item_number]
+      end
+
+      # Make the unit a symbol
+      # getter
+      def unit
+        self[:unit].to_s.empty? ? :piece : self[:unit].to_sym
+      end
+
+      # Make the unit a symbol
+      # setter
+      def unit=(a_unit)
+        self[:unit] = a_unit.to_s
+      end
+
+      # total price = unit_price * quantity
+      # unit_price is defined as money!
+      def total_amount
+        self.unit_price * (self.quantity || 1)
+      end
+      alias_method :price, :total_amount
+      # alias_method :total_price, :total_amount
+
+      # Price per piece
+      # Example:
+      #   12 bottles (pieces) of a unit price of $45.00 per box (unit price)
+      #   is a per piece price of $3.75
+      def price_per_piece
+        self.unit_price / (self.pieces || 1) if self.unit_price
+      end
+
+      # Returns a localized description text
+      # e.g. "12 months subscription for $74 ($5.95 per month)"
+      def description
+        self[:description]
+      end
+
+    end
+  end
+end

data/lib/merchant_sidekick/version.rb

@@ -0,0 +1,3 @@
+module MerchantSidekick
+  VERSION = "0.4.2"
+end

data/merchant_sidekick.gemspec

@@ -0,0 +1,37 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+
+require File.expand_path("../lib/merchant_sidekick/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name              = "merchant_sidekick"
+  s.version           = MerchantSidekick::VERSION
+  s.authors           = ["Juergen Fesslmeier"]
+  s.email             = ["jfesslmeier@gmail.com"]
+  s.homepage          = ""
+  s.summary           = "A light-weight E-commerce plugin."
+  s.rubyforge_project = "merchant_sidekick"
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths     = ["lib"]
+
+  s.add_dependency "activerecord", ">= 3.1.0"
+  s.add_dependency "money"
+  s.add_dependency "acts_as_list"
+  s.add_dependency "aasm"
+  s.add_dependency "activemerchant"
+
+  s.add_development_dependency "rspec", "~> 2.7.0"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "rake"
+
+  s.description = <<-EOM
+EOM
+
+  s.post_install_message = <<-EOM
+NOTE: This is an experimental port of the original MerchantSidekick plugin.
+
+https://github.com/chinshr/merchant_sidekick/README.md
+EOM
+
+end

data/spec/address_spec.rb

@@ -0,0 +1,153 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe MerchantSidekick::Addressable::Address, "should handle default columns" do
+  it "should have default class attr columns assigned" do
+    MerchantSidekick::Addressable::Address.street_address_column.should == :street
+    MerchantSidekick::Addressable::Address.city_column.should == :city
+    MerchantSidekick::Addressable::Address.postal_code_column.should == :postal_code
+    MerchantSidekick::Addressable::Address.province_column.should  == :province
+    MerchantSidekick::Addressable::Address.province_code_column.should == :province_code
+    MerchantSidekick::Addressable::Address.country_column.should == :country
+    MerchantSidekick::Addressable::Address.country_code_column.should  == :country_code
+    MerchantSidekick::Addressable::Address.gender_column.should == :gender
+    MerchantSidekick::Addressable::Address.first_name_column.should == :first_name
+    MerchantSidekick::Addressable::Address.middle_name_column.should == false
+    MerchantSidekick::Addressable::Address.last_name_column.should == :last_name
+  end
+end
+
+describe MerchantSidekick::Addressable::Address, "with address members" do
+
+  before(:each) do
+    @address = MerchantSidekick::Addressable::Address.new(valid_address_attributes(:addressable => Addressable.create))
+  end
+
+  it "should create an address" do
+    @address.should_not == nil
+    @address.first_name.should == "George"
+    @address.firstname.should == "George"
+    @address.middle_name.should == "W." if @address.middle_name?
+    @address.last_name.should == "Bush"
+    @address.lastname.should == "Bush"
+  end
+
+  it "should handle street and address_line" do
+    @address.street.should == "100 Washington St."
+    @address.address_line_1.should == "100 Washington St."
+  end
+
+  it "should add address_line_2 properly" do
+    @address.street.should == "100 Washington St."
+    @address.address_line_2 = "Suite 1234"
+    @address.address_line_2.should == "Suite 1234"
+    @address.street.should == "100 Washington St.\nSuite 1234"
+  end
+
+  it "should address_line_1 and address_line_2 properly" do
+    @address.street = ''
+    @address.address_line_1 = "100 Enterprise Way"
+    @address.address_line_2 = "Office Square 15"
+
+    @address.address_line_1.should == "100 Enterprise Way"
+    @address.address_line_2.should == "Office Square 15"
+    @address.street.should == "100 Enterprise Way\nOffice Square 15"
+  end
+
+  it "should have a valid name" do
+    if @address.middle_name?
+      @address.name.should == "George W. Bush"
+    else
+      @address.name.should == "George Bush"
+    end
+  end
+
+  it "should have a valid salutation and name" do
+    if @address.middle_name?
+      @address.salutation_and_name.should  == "Mr George W. Bush"
+    else
+      @address.salutation_and_name.should == "Mr George Bush"
+    end
+  end
+
+  it "should stringify address fields" do
+    # full
+    @address.to_s.should == "George Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+
+    # sparse
+    @address = MerchantSidekick::Addressable::Address.new(
+      :street        => "100 Sunshine Blvd.",
+      :postal_code   => '95066',
+      :city          => 'Scotts Valley',
+      :province_code => 'CA',
+      :country_code  => 'US'
+    )
+    @address.to_s.should == "100 Sunshine Blvd., Scotts Valley, CA, 95066, US"
+  end
+
+  it "should return a name" do
+    @address.name.should == 'George Bush'
+  end
+
+  it "should return nil if names are nil" do
+    @address = MerchantSidekick::Addressable::Address.new
+    @address.name.should be_nil
+  end
+
+  it "should convert to active merchant address attributes" do
+    @address = MerchantSidekick::Addressable::Address.new(valid_address_attributes(
+      :addressable => Addressable.create,
+      :street => "100 Sunshine Blvd.\nSuite 7"
+    ))
+    merchant = @address.to_merchant_attributes
+    merchant[:name].should == "George Bush"
+    merchant[:address1].should == "100 Sunshine Blvd."
+    merchant[:address2].should == "Suite 7"
+    merchant[:city].should == "Santa Cruz"
+    merchant[:state].should == "CA"
+    merchant[:country].should == "US"
+    merchant[:zip].should == "95065"
+    merchant[:phone].should == "+1 831 123-4567"
+  end
+
+  it "should work with gender" do
+    @address.should be_gender  # funny :-)
+    @address.gender = :male
+    @address.gender.should == 'm'
+    @address.should be_is_gender_male
+    @address.gender = :female
+    @address.gender.should == 'f'
+    @address.gender = 'm'
+    @address.gender.should == 'm'
+    @address.gender = 'f'
+    @address.gender.should == 'f'
+  end
+
+  it "should return a province or a province code" do
+    address = MerchantSidekick::Addressable::Address.new(:province => "California", :province_code => "CA" )
+    address.province_or_province_code.should == "California"
+
+    address = MerchantSidekick::Addressable::Address.new(:province_code => "CA" )
+    address.province_or_province_code.should == "CA"
+
+    address = MerchantSidekick::Addressable::Address.new(:province => "", :province_code => "CA" )
+    address.province_or_province_code.should == "CA"
+
+    address = MerchantSidekick::Addressable::Address.new
+    address.province_or_province_code.should be_nil
+  end
+
+  it "should return a country or a country code" do
+    address = MerchantSidekick::Addressable::Address.new(:country => 'Germany', :country_code => 'DE')
+    address.country_or_country_code.should == "Germany"
+
+    address = MerchantSidekick::Addressable::Address.new(:country_code => 'DE')
+    address.country_or_country_code.should == "DE"
+
+    address = MerchantSidekick::Addressable::Address.new(:country => '', :country_code => 'DE')
+    address.country_or_country_code.should == "DE"
+
+    address = MerchantSidekick::Addressable::Address.new
+    address.country_or_country_code.should be_nil
+  end
+
+end

data/spec/addressable_spec.rb

@@ -0,0 +1,250 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe HasOneSingleAddressModel, "new" do
+
+  before(:each) do
+    MerchantSidekick::Addressable::Address.middle_name_column = false
+    @addressable = HasOneSingleAddressModel.new
+    @address = @addressable.build_address valid_address_attributes
+  end
+
+  it "should have an addressable for address" do
+    @address.addressable.should_not be_nil
+    @address.addressable.should == @addressable
+  end
+
+end
+
+describe HasOneSingleAddressModel, "create" do
+
+  before(:each) do
+    MerchantSidekick::Addressable::Address.middle_name_column = false
+    @addressable = HasOneSingleAddressModel.create
+    @address = @addressable.create_address valid_address_attributes
+  end
+
+  it "should have a single address" do
+    @addressable.address.should_not be_nil
+    @addressable.address.to_s.should == "George Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+  end
+
+end
+
+describe HasManySingleAddressModel do
+
+  before(:each) do
+    MerchantSidekick::Addressable::Address.middle_name_column = false
+    @addressable = HasManySingleAddressModel.create
+    @address = @addressable.addresses.create valid_address_attributes
+  end
+
+  it "should hold at least one" do
+    @addressable.addresses.should_not be_empty
+    @addressable.addresses.size.should == 1
+  end
+
+  it "should add more addresses" do
+    @addressable.addresses.create valid_address_attributes(
+      :first_name => "Barbara", :last_name => "Bush"
+    )
+    @addressable.addresses.create valid_address_attributes(
+      :first_name => "Tom", :last_name => "Bush"
+    )
+    @addressable.addresses.size.should == 3
+    @addressable.addresses[0].to_s.should == "George Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+    @addressable.addresses[1].to_s.should == "Barbara Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+    @addressable.addresses[2].to_s.should == "Tom Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+  end
+
+end
+
+describe HasOneMultipleAddressModel do
+
+  before(:each) do
+    MerchantSidekick::Addressable::Address.middle_name_column = false
+    @addressable = HasOneMultipleAddressModel.create
+    @billing_address = @addressable.create_billing_address valid_address_attributes(:first_name => "Bill")
+    @shipping_address = @addressable.create_shipping_address valid_address_attributes(:first_name => "Ship")
+  end
+
+  it "should have a valid billing address" do
+    @addressable.billing_address.should_not be_nil
+    @addressable.billing_address.type.should == "BillingAddress"
+    @addressable.billing_address.kind.should == :billing
+    @addressable.billing_address.to_s.should == "Bill Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+  end
+
+  it "should populate addressable of an address instance with create" do
+    @addressable.billing_address.addressable.should == @addressable
+  end
+
+  it "should populate addressable of an address instance with build on an existing" do
+    @invoice = HasOneMultipleAddressModel.create
+    @invoice.build_billing_address(valid_address_attributes(:first_name => "Bill"))
+    @invoice.billing_address.should_not be_nil
+    @invoice.billing_address.addressable.should == @invoice
+  end
+
+  it "should populate addressable of an address instance with create on an existing" do
+    @invoice = HasOneMultipleAddressModel.create
+    @invoice.create_billing_address(valid_address_attributes(:first_name => "Bill"))
+    @invoice.billing_address.should_not be_nil
+    @invoice.billing_address.addressable.should == @invoice
+  end
+
+  it "should populate addressable of an address instance with build on a new" do
+    @invoice = HasOneMultipleAddressModel.new
+    @invoice.build_billing_address(valid_address_attributes(:first_name => "Bill"))
+    @invoice.billing_address.should_not be_nil
+    @invoice.billing_address.addressable.should == @invoice
+  end
+
+  it "should build_shipping_address" do
+    customer = HasOneMultipleAddressModel.create
+    address = customer.build_shipping_address valid_address_attributes
+    customer.shipping_address.should == address
+    customer.shipping_address.addressable.should == customer
+  end
+
+  it "should create_shipping_address" do
+    addressable = HasOneMultipleAddressModel.create
+    lambda {
+      address = addressable.create_shipping_address valid_address_attributes
+      addressable.shipping_address.should == address
+      addressable.shipping_address.addressable.should == addressable
+    }.should change(MerchantSidekick::Addressable::Address, :count)
+  end
+
+  it "should have a valid shipping address" do
+    @addressable.shipping_address.should_not be_nil
+    @addressable.shipping_address.should be_shipping
+    @addressable.shipping_address.to_s.should == "Ship Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+  end
+
+  it "should assign a new shipping address" do
+    save_billing_address = @addressable.billing_address
+    @addressable.billing_address = BillingAddress.new valid_address_attributes(
+      :first_name => "New Billing"
+    )
+    @addressable.save
+    @addressable.reload
+    save_billing_address.to_s.should_not == @addressable.billing_address
+    save_billing_address.id.should_not == @addressable.billing_address.id
+    @addressable.billing_address.first_name.should == "New Billing"
+  end
+
+  it "should find_addresses" do
+    #@addressable.addresses.first.should == @billing_address
+
+    address = @addressable.find_addresses(:first, :billing)
+    address.should == @billing_address
+  end
+
+  it "should find_billing_address" do
+    address = @addressable.find_billing_address
+    address.should == @billing_address
+
+    address = @addressable.find_billing_address :conditions => @billing_address.content_attributes
+    address.should == @billing_address
+  end
+
+  it "should find_default_shipping_address and default_shipping_address" do
+    @addressable.find_default_shipping_address.should == @shipping_address
+    @addressable.default_shipping_address.should == @shipping_address
+  end
+
+
+  it "should find_or_build_shipping_address" do
+    # take existing shipping address
+    lambda {
+      existing_address = @addressable.find_or_build_shipping_address(
+        @shipping_address.content_attributes
+      )
+    }.should_not change(MerchantSidekick::Addressable::Address, :count)
+
+    # new shipping addresss
+    #lambda {
+      new_address = @addressable.find_or_build_shipping_address(valid_address_attributes(
+        :first_name => "New shipping address")
+      )
+      new_address.should be_new_record
+      new_address.should be_shipping
+      new_address.first_name.should == "New shipping address"
+      new_address.save
+    #}.should change(MerchantSidekick::Addressable::Address, :count)
+  end
+
+  it "should find_billing_address_or_clone_from" do
+    # billing address exists, don't clone
+    address = @addressable.find_billing_address_or_clone_from :shipping
+    address.should be_instance_of(BillingAddress)
+    address.should == @billing_address
+    address.street.should == @billing_address.street
+
+    # destroy billing address
+    lambda {
+      @addressable.billing_address.destroy
+      @addressable.reload
+      @addressable.billing_address.should == nil
+    }.should change(MerchantSidekick::Addressable::Address, :count)
+
+    # clone from new instance
+    shipping_address = ShippingAddress.new valid_address_attributes(
+      :first_name => "Another Shipping Address"
+    )
+    lambda {
+      cloned_address = @addressable.find_billing_address_or_clone_from shipping_address
+      cloned_address.should be_instance_of(BillingAddress)
+      cloned_address.should be_billing
+      cloned_address.first_name.should == "Another Shipping Address"
+      @addressable.save
+    }.should change(MerchantSidekick::Addressable::Address, :count)
+
+    # destroy billing address
+    @addressable.billing_address.destroy
+    @addressable.reload
+
+    # clone from attributes
+    shipping_address = ShippingAddress.new valid_address_attributes(
+      :first_name => "Yet Another Shipping Address"
+    )
+    lambda {
+      cloned_address = @addressable.find_billing_address_or_clone_from shipping_address.content_attributes
+      cloned_address.should be_instance_of(BillingAddress)
+      cloned_address.should be_billing
+      cloned_address.first_name.should == "Yet Another Shipping Address"
+      @addressable.save
+    }.should change(MerchantSidekick::Addressable::Address, :count)
+  end
+
+end
+
+describe HasManyMultipleAddressModel do
+
+  before(:each) do
+    MerchantSidekick::Addressable::Address.middle_name_column = false
+    @addressable = HasManyMultipleAddressModel.create
+    @billing_address = @addressable.billing_addresses.create valid_address_attributes(:first_name => "Bill")
+    @shipping_address = @addressable.shipping_addresses.create valid_address_attributes(:first_name => "Ship")
+  end
+
+  it "should have at least one valid billing addresses" do
+    @addressable.billing_addresses.should_not be_empty
+    @addressable.addresses.size.should == 2
+    @addressable.billing_addresses.size.should == 1
+    @addressable.billing_addresses.first.should be_billing
+    @addressable.billing_addresses.first.should_not be_shipping
+    @addressable.billing_addresses.first.to_s.should == "Bill Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+  end
+
+  it "should have at least one valid shipping addresses" do
+    @addressable.shipping_addresses.should_not be_empty
+    @addressable.addresses.size.should == 2
+    @addressable.shipping_addresses.size.should == 1
+    @addressable.shipping_addresses.first.should be_shipping
+    @addressable.shipping_addresses.first.should_not be_billing
+    @addressable.shipping_addresses.first.to_s.should == "Ship Bush, 100 Washington St., Santa Cruz, California, 95065, United States of America"
+  end
+
+end
+