yodel_shop 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yodel_shop.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/migrations/01_shop_product_model.rb

@@ -0,0 +1,16 @@
+class ShopProductModelMigration < Migration
+  def self.up(site)
+    site.pages.create_model :products do |products|
+      add_field :price, :decimal, validations: {required: {}}, default: '0.0'
+      add_field :shipping, :decimal, validations: {required: {}}, default: '0.0'
+      add_field :tax, :decimal, validations: {required: {}}, default: '0.0'
+      add_field :unlimited_quantity, :boolean, validations: {required: {}}, default: false
+      add_field :quantity, :integer, validations: {required: {}}, default: 0, index: true
+      add_many  :holds, model: :product_hold
+    end
+  end
+  
+  def self.down(site)
+    site.products.destroy
+  end
+end

data/lib/migrations/02_shop_user_updates.rb

@@ -0,0 +1,13 @@
+class ShopUserUpdatesMigration < Migration
+  def self.up(site)
+    site.users.modify do
+      add_field :balance, :decimal, validations: {required: {}}, default: '0.0'
+    end
+  end
+  
+  def self.down(site)
+    site.users.modify do
+      remove_field :balance
+    end
+  end
+end

data/lib/migrations/03_shop_transaction_model.rb

@@ -0,0 +1,52 @@
+class ShopTransactionModelMigration < Migration
+  def self.up(site)
+    site.records.create_model :transactions do |transactions|
+      add_one   :cart
+      add_field :product_total, :decimal, default: '0.0', validations: {required: {}}
+      add_field :shipping_total, :decimal, default: '0.0', validations: {required: {}}
+      add_field :tax_total, :decimal, default: '0.0', validations: {required: {}}
+      add_field :total, :function, fn: 'sum(product_total, shipping_total, tax_total)'
+      add_field :created_at, :time
+      
+      add_embed_one :shipping_address do
+        add_field :name, :string
+        add_field :address, :string
+        add_field :city, :string
+        add_field :state, :string
+        add_field :country, :string
+        add_field :postcode, :string
+        add_field :phone, :string
+        add_field :email, :string
+      end
+      
+      add_embed_one :billing_address do
+        add_field :name, :string
+        add_field :address, :string
+        add_field :city, :string
+        add_field :state, :string
+        add_field :country, :string
+        add_field :postcode, :string
+        add_field :phone, :string
+        add_field :email, :string
+      end
+      
+      add_field :payment_reference, :string
+      
+      # permissions
+      users_group = site.groups['Users'].id
+      transactions.view_group = users_group
+      transactions.create_group = users_group
+      transactions.update_group = users_group
+      transactions.delete_group = users_group
+    end
+    
+    site.pages.create_model :transaction_pages do |transaction_pages|
+      transaction_pages.record_class_name = 'TransactionPage'
+    end
+  end
+  
+  def self.down(site)
+    site.transactions.destroy
+    site.transaction_pages.destroy
+  end
+end

data/lib/migrations/04_shop_cart_model.rb

@@ -0,0 +1,30 @@
+class ShopCartModelMigration < Migration
+  def self.up(site)
+    site.records.create_model :carts do |carts|
+      add_field :session_id, :string
+      add_one   :user, index: true
+      add_many  :product_holds, foreign_key: 'cart', destroy: true
+      add_field :created_at, :time
+      add_field :updated_at, :time
+      add_field :hold_duration, :integer, default: 600
+      add_one   :transaction, index: true
+      carts.record_class_name = 'Cart'
+      
+      # permissions
+      users_group = site.groups['Users'].id
+      carts.view_group = users_group
+      carts.create_group = users_group
+      carts.update_group = users_group
+      carts.delete_group = users_group
+    end
+    
+    site.pages.create_model :cart_pages do |cart_pages|
+      cart_pages.record_class_name = 'CartPage'
+    end
+  end
+  
+  def self.down(site)
+    site.carts.destroy
+    site.cart_pages.destroy
+  end
+end

data/lib/migrations/05_shop_product_hold_model.rb

@@ -0,0 +1,15 @@
+class ShopProductHoldModelMigration < Migration
+  def self.up(site)
+    site.records.create_model :product_holds do |product_holds|
+      add_one   :product, validations: {required: {}}, index: true
+      add_one   :cart, validations: {required: {}}, index: true
+      add_field :quantity, :integer, default: 0, validations: {required: {}}
+      add_field :sold, :boolean, default: false
+      product_holds.record_class_name = 'ProductHold'
+    end
+  end
+  
+  def self.down(site)
+    site.product_holds.destroy
+  end
+end

data/lib/migrations/06_shop_coupon_model.rb

@@ -0,0 +1,18 @@
+class ShopCouponModelMigration < Migration
+  def self.up(site)
+    site.records.create_model :coupons do |coupons|
+      add_field :code, :string
+      add_field :value, :decimal
+    end
+    
+    site.records.create_model :coupon_redemptions do |coupon_redemptions|
+      add_one :user
+      add_one :coupon
+    end
+  end
+  
+  def self.down(site)
+    site.coupons.destroy
+    site.coupon_redemptions.destroy
+  end
+end

data/lib/migrations/07_shop_coupon_redemption_page_model.rb

@@ -0,0 +1,12 @@
+class CouponRedemptionPageModelMigration < Migration
+  def self.up(site)
+    site.pages.create_model :coupon_redemption_pages do |coupon_redemption_pages|
+      add_one :redirect_to, model: :page
+      coupon_redemption_pages.record_class_name = 'CouponRedemptionPage'
+    end
+  end
+  
+  def self.down(site)
+    site.coupon_redemption_pages.destroy
+  end
+end

data/lib/migrations/08_shop_model_functions.rb

@@ -0,0 +1,37 @@
+class ShopModelFunctionsMigration < Migration
+  def self.up(site)
+    site.products.modify do |products|
+      add_field :total_cost, :function, fn: 'sum(price, shipping, tax)'
+    end
+    
+    site.product_holds.modify do |products|
+      add_field :total_cost, :function, fn: 'multiply(product.total_cost, quantity)'
+    end
+    
+    site.carts.modify do |carts|
+      add_field :total_cost, :function, fn: 'product_holds.sum(total_cost)'
+    end
+    
+    site.transactions.modify do |transactions|
+      remove_field :product_total
+      remove_field :shipping_total
+      remove_field :tax_total
+      remove_field :total
+      
+      modify_field :shipping_address do |shipping_address|
+        remove_field :name
+        add_field :first_name, :string
+        add_field :last_name, :string
+      end
+      
+      modify_field :billing_address do |billing_address|
+        remove_field :name
+        add_field :first_name, :string
+        add_field :last_name, :string
+      end
+    end
+  end
+  
+  def self.down(site)
+  end
+end

data/lib/migrations/09_shop_cart_duration_task.rb

@@ -0,0 +1,17 @@
+class ShopCartDurationMigration < Migration
+  def self.up(site)
+    # duration is now stored outside a cart
+    site.carts.modify do |carts|
+      remove_field :hold_duration
+    end
+    
+    # clean up carts every minute
+    cart_task = Task.new(site)
+    cart_task.type = 'perform_destroy_stale_carts'
+    cart_task.repeat_in = 60
+    cart_task.save
+  end
+  
+  def self.down(site)
+  end
+end

data/lib/migrations/10_shop_coupon_restrictions.rb

@@ -0,0 +1,21 @@
+class CouponRestrictionsMigration < Migration
+  def self.up(site)
+    site.coupon_redemptions.destroy
+    
+    site.coupons.modify do |coupons|
+      add_field :user_restrictions, :hash
+      add_field :product_restrictions, :hash
+      add_field :value_type, :enum, options: %w{currency percent}, default: 'currency'
+      add_many  :redemptions, model: :user
+    end
+  end
+  
+  def self.down(site)
+    site.coupons.modify do |coupons|
+      remove_field :user_restrictions
+      remove_field :product_restrictions
+      remove_field :value_type
+      remove_field :redemptions
+    end
+  end
+end

data/lib/migrations/11_shop_discount_model.rb

@@ -0,0 +1,19 @@
+class ShopDiscountModelMigration < Migration
+  def self.up(site)
+    site.records.create_model :discounts do |discounts|
+      add_field :amount, :integer, validations: {required: {}}, default: '0.0'
+    end
+    
+    site.carts.modify do |carts|
+      add_many :discounts
+      modify_field :total_cost, fn: 'subtract(product_holds.sum(total_cost), discounts.sum(amount))'
+    end
+  end
+  
+  def self.down(site)
+    site.discounts.destroy
+    site.carts.modify do |carts|
+      remove_field :discounts
+    end
+  end
+end

data/lib/models/cart.rb

@@ -0,0 +1,15 @@
+class Cart < Record
+  CART_HOLD_DURATION = 10 * 60 # 10 minutes
+  
+  before_destroy :delete_all_product_holds    
+  def delete_all_product_holds
+    product_holds.each(&:destroy)
+  end
+  
+  def self.perform_destroy_stale_carts(site)
+    # ignore carts which have been purchased
+    query = site.carts.where(transaction: nil)
+    query = query.where(updated_at: {'$lt' => Time.at(Time.now.utc.to_i - CART_HOLD_DURATION)})
+    query.all.each(&:destroy)
+  end
+end

data/lib/models/cart_page.rb

@@ -0,0 +1,65 @@
+class CartPage < Page
+  def products
+    cart.product_holds.collect(&:product)
+  end
+
+  def hold_product(product, quantity)
+    # TODO: find_or_create
+    # use any existing holds for this product
+    hold = site.product_holds.where(product: product.id, cart: cart.id).first
+    hold ||= site.product_holds.new(product: product, cart: cart)
+  
+    if product.quantity >= quantity
+      if product.increment! :quantity, -quantity, :quantity.gt => 0
+        hold.quantity += quantity
+        return hold.save
+      end
+    end
+    false
+  end
+
+  def cart
+    if logged_in?
+      @cart ||= site.carts.where(transaction: nil, user: current_user.id).order('created desc').first
+    else
+      # TODO: need to track by session
+      nil
+    end
+  end
+
+  respond_to :post do
+    with :html do
+      return unless user_allowed_to?(:create)
+    
+      # we're creating a new cart, so delete any existing (current) carts
+      site.carts.where(transaction: nil, user: current_user.id).all.each(&:destroy)
+    
+      # create a new cart to hold any products sent in the request
+      @cart = site.carts.new(user: current_user, name: current_user.name)
+      @cart.save
+    
+      # if any products were added to the cart, create holds on them
+      flash[:failed] = []
+    
+      params['products'].each do |product_options|
+        product = site.products.where(_id: BSON::ObjectId.from_string(product_options['id'])).first
+        quantity = product_options['quantity'].to_i
+        unless product.unlimited_quantity || hold_product(product, quantity)
+          flash[:failed] << product_options['id']
+        end
+      end
+    
+      # finally render the cart page
+      cart.reload
+      respond_to_get_with_html
+    end
+  end
+
+  respond_to :put do
+    with :html do
+      return unless user_allowed_to?(:update)
+      # FIXME: implement
+    end
+  end
+
+end

data/lib/models/coupon_redemption_page.rb

@@ -0,0 +1,44 @@
+class CouponRedemptionPage < Page
+  respond_to :post do
+    with :html do
+      user = current_user
+      coupon = site.coupons.where(code: params['coupon_code']).first
+      
+      if user && coupon
+        unless coupon.redemptions.include?(user)
+          if user_permitted_to_redeem?(user, coupon)
+            coupon.redemptions << user
+            coupon.save
+        
+            # FIXME: needs to be atomic and respect percent value_type
+            user.balance += coupon.value
+            user.save_without_validation
+            flash[:coupon_successfully_redeemed] = true
+          else
+            flash[:failed_redemption_rules] = true
+          end
+        else
+          flash[:coupon_already_redeemed] = true
+        end
+      else
+        flash[:coupon_not_found] = true
+      end
+      
+      response.redirect redirect_to.path
+    end
+  end
+  
+  private
+    def user_permitted_to_redeem?(user, coupon)
+      return true if coupon.user_restrictions.blank?
+      
+      coupon.user_restrictions.each do |field, restriction|
+        # TODO: support other restriction types
+        if restriction.is_a?(Array)
+          return false unless restriction.include?(user.get(field))
+        end
+      end
+      
+      true
+    end
+end

data/lib/models/product_hold.rb

@@ -0,0 +1,7 @@
+class ProductHold < Record
+  after_destroy :increment_quantity
+  def increment_quantity
+    return if product.unlimited_quantity
+    product.increment! :quantity
+  end
+end

data/lib/models/transaction_page.rb

@@ -0,0 +1,138 @@
+class TransactionPage < Page
+  
+  # TODO: find way to abstract this
+  def cart
+    if logged_in?
+      @cart ||= site.carts.where(transaction: nil, user: current_user.id).order('created desc').first
+    else
+      # TODO: need to track by session
+      nil
+    end
+  end
+  
+  def successful?
+    @successful
+  end
+  
+  def products
+    cart.product_holds.collect(&:product)
+  end
+  
+  respond_to :post do
+    with :html do
+      return unless user_allowed_to?(:create)
+      
+      # update the cart from the checkout form (e.g to include discounts)
+      cart.from_json(params['cart']) if params['cart']
+      
+      # FIXME: race condition (user a window 1, user a window 2, both doing purchases, inconsistent charge)
+      # Unable to do an atomic update because big decimals are stored as strings... store as int (*100)??
+      current_user.balance -= cart.total_cost
+      current_user.save_without_validation
+      transaction_successful = false
+      transaction_id = BSON::ObjectId.new
+      
+      if current_user.balance < 0
+        gateway = ActiveMerchant::Billing::PayWayGateway.new(
+          username: 'Q14555',
+          password: 'Au5xh8v8g',
+          merchant: '23891864',
+          pem: File.join(site.root_directory, 'ccapi.pem'),
+          eci: 'SSL'
+        )
+        
+        # construct an expiry month & date from a date string or separate m/y values
+        if params['expiry_month'] && params['expiry_year']
+          expiry_month = params['expiry_month']
+          expiry_year = params['expiry_year']
+        else
+          begin
+            expiry = Date.parse(params['expiry'].to_s)
+            expiry_month = expiry.month.to_s
+            expiry_year = expiry.year.to_s
+          rescue
+            expiry_month = expiry_month = nil
+          end
+        end
+        
+        # ignore spaces and any non numeric characters
+        card_number = params['card_number'].scan(/\d+/).join
+        
+        # use the current user's name if no other name is provided
+        first_name = params['first_name'] || current_user.first_name
+        last_name = params['last_name'] || current_user.last_name
+        
+        card = ActiveMerchant::Billing::CreditCard.new(
+          number: card_number,
+          month: expiry_month,
+          year: expiry_year,
+          first_name: first_name,
+          last_name: last_name,
+          verification_value: params['verification']
+        )
+        
+        if card.valid?
+          order_number = [transaction_id.data.collect(&:chr).join].pack('m0')
+          result = gateway.purchase((current_user.balance * -100).to_i, card, order_number: order_number)
+          if result.success?
+            payment_reference = result.params['receipt_no']
+            transaction_successful = true
+          else
+            flash[:transact_error] = result.message
+          end
+        else
+          flash[:card_error] = card.errors.collect {|field, val| "#{field.humanize} #{val.to_sentence}"}.join('. ')
+        end
+      else
+        payment_reference = 'Positive Balance'
+        transaction_successful = true
+      end
+      
+      if transaction_successful
+        transaction = site.transactions.new(cart: cart)
+        transaction.set_id(transaction_id)
+        
+        # billing
+        transaction.billing_address.first_name = params['first_name']
+        transaction.billing_address.last_name = params['last_name']
+        
+        # shipping
+        transaction.shipping_address.first_name = current_user.first_name
+        transaction.shipping_address.last_name = current_user.last_name
+        transaction.shipping_address.address = current_user.address
+        transaction.shipping_address.state = current_user.state
+        transaction.shipping_address.city = current_user.city
+        transaction.shipping_address.postcode = current_user.postcode
+        transaction.shipping_address.phone = current_user.phone
+        transaction.shipping_address.email = current_user.email
+        
+        # transaction
+        transaction.payment_reference = payment_reference
+        transaction.save
+        
+        # mark the products as sold
+        # TODO: switch to hold.update(sold: true)
+        cart.product_holds.each do |hold|
+          hold.sold = true
+          hold.save
+        end
+        
+        cart.transaction = transaction
+        cart.save
+        
+        @successful = true
+        respond_to_get_with_html()
+      else
+        current_user.balance += cart.total_cost
+        current_user.save_without_validation
+        flash[:first_name] = params['first_name']
+        flash[:last_name] = params['last_name']
+        flash[:expiry] = params['expiry']
+        flash[:card_number] = params['card_number']
+        flash[:verification] = params['verification']
+        response.redirect('/cart')
+      end
+    end
+  end
+  
+end

data/lib/yodel_shop.rb

@@ -0,0 +1,3 @@
+module YodelShop
+  VERSION = '0.0.1'
+end

data/yodel_shop.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'yodel_shop'
+
+Gem::Specification.new do |s|
+  s.name        = 'yodel_shop'
+  s.version     = YodelShop::VERSION
+  s.authors     = ['Will Cannings']
+  s.email       = ['me@willcannings.com']
+  s.homepage    = 'http://yodelcms.com'
+  s.summary     = 'Yodel CMS Shop Extension'
+  s.description = 'Yodel CMS Shop Extension'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: yodel_shop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Will Cannings
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-09 00:00:00.000000000Z
+dependencies: []
+description: Yodel CMS Shop Extension
+email:
+- me@willcannings.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/migrations/01_shop_product_model.rb
+- lib/migrations/02_shop_user_updates.rb
+- lib/migrations/03_shop_transaction_model.rb
+- lib/migrations/04_shop_cart_model.rb
+- lib/migrations/05_shop_product_hold_model.rb
+- lib/migrations/06_shop_coupon_model.rb
+- lib/migrations/07_shop_coupon_redemption_page_model.rb
+- lib/migrations/08_shop_model_functions.rb
+- lib/migrations/09_shop_cart_duration_task.rb
+- lib/migrations/10_shop_coupon_restrictions.rb
+- lib/migrations/11_shop_discount_model.rb
+- lib/models/cart.rb
+- lib/models/cart_page.rb
+- lib/models/coupon_redemption_page.rb
+- lib/models/product_hold.rb
+- lib/models/transaction_page.rb
+- lib/yodel_shop.rb
+- yodel_shop.gemspec
+homepage: http://yodelcms.com
+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.10
+signing_key: 
+specification_version: 3
+summary: Yodel CMS Shop Extension
+test_files: []