cartman 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,8 @@
 # Cartman
 
-TODO: Write a gem description
+![](http://blog.brightcove.com/sites/all/uploads/eric_theodore_cartman_southpark.jpg)
+
+Cartman is a framework agnostic, redis backed, cart system.  It is not a POS, or a full fledged ecommerce system.  Just the cart, man.
 
 ## Installation
 
@@ -16,9 +18,56 @@ Or install it yourself as:
 
     $ gem install cartman
 
+## Setup
+
+Cartman has a few (read 3) configuration options you can set, most likely in an initializer file.  Here's an example configuration:
+
+```ruby
+# config/initializers/cartman.rb
+Cartman.config do
+  cart_expires_in 604800 # one week, in seconds.  This is the default
+  return_items_as :openstruct # vs a :hash
+  cost_field :cost # for cart totaling
+end
+```
+
+- The `cart_expires_in` setting will let you set how long a cart should live.  If no items are added to the cart before the time expires, the cart will be cleared.  If you want to disable cart expiration, set this to `-1`.
+- `return_items_as` lets you set how you want Cartman to return your items as.  You can choose either an `OpenStruct` or a `Hash`.
+- `cost_field` lets you tell Cartman where you're storing the "cost" of each item, so that when you call `cart.total` it knows which values to sum.
+
 ## Usage
 
-TODO: Write usage instructions here
+To create a new shopping cart, just call `Cartman::Cart.new(user.id)`.  The parameter for `Cart.new()` is a unique id.  If you don't want a user to have more than one cart at a time, it's generally best to set this to the user's id.  Then to add an item to the cart, just call `cart.add_item(data)` which takes a hash of data that you want to store.  Then to retrieve the items, you just call `cart.items` which will give you an array of all the items they've added.
+
+Lets walk through an example implementation with a Rails app that has a User model and a Product model.
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  #...
+  def cart
+    Cartman::Cart.new(id)
+  end
+  #...
+end
+
+# app/controllers/products_controller.rb
+class ProductsController < ApplicationController
+  #...
+  # /products/:id/add_to_cart
+  def add_to_cart
+    @product = Product.find(params[:id])
+    current_user.cart.add_item(id: @product.id, name: @product.name, unit_cost: @product.cost, cost: @product.cost * params[:quantity], quantity: params[:quantity])
+  end
+  #...
+end
+
+# app/view/cart/show.html.haml
+%h1 Cart - Total: #{@cart.total}
+%ul
+  - @cart.items.each do |item|
+    %li #{item.name} - #{item.cost}
+```
 
 ## Contributing
 

data/lib/cartman/cart.rb

@@ -11,13 +11,36 @@ module Cartman
       line_item_id = @@redis.incr CART_LINE_ITEM_ID_KEY
       @@redis.mapped_hmset("cartman:line_item:#{line_item_id}", options)
       @@redis.sadd key, line_item_id
+      keys_to_expire = line_item_keys
+      keys_to_expire << key
+      @@redis.pipelined do
+        keys_to_expire.each do |item|
+          @@redis.expire item, Cartman::Configuration.cart_expires_in
+        end
+      end
     end
 
-    def items
-      line_item_ids = @@redis.smembers key
-      line_item_ids.collect { |id|
-        @@redis.hgetall "cartman:line_item:#{id}"
+    def items(return_as=Cartman::Configuration.return_items_as)
+      items = line_item_keys.collect { |item_key|
+        @@redis.hgetall(item_key).inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo} # symbolize keys
       }
+      if return_as == :openstruct
+        items.collect { |item|
+          OpenStruct.new(item)
+        }
+      else
+        items
+      end
+    end
+
+    def total
+      items(:openstruct).collect { |item|
+        (item.send(Cartman::Configuration.cost_field).to_f * 100).to_i
+      }.inject{|sum,cost| sum += cost} / 100.0
+    end
+
+    def ttl
+      @@redis.ttl key
     end
 
     private
@@ -25,5 +48,13 @@ module Cartman
     def key
       "cartman:cart:#{@uid}"
     end
+
+    def line_item_ids
+      @@redis.smembers key
+    end
+
+    def line_item_keys
+      line_item_ids.collect{ |id| "cartman:line_item:#{id}" }
+    end
   end
 end

data/lib/cartman/configuration.rb

@@ -1,6 +1,11 @@
 module Cartman
   class Configuration
-    @@configuration = {}
+    @@configuration = {
+      cart_expires_in: 604800, # one week
+      return_items_as: :openstruct, # vs a :hash
+      cost_field: :cost, # for cart totaling
+    }
+
     def initialize(&block)
       instance_eval &block
     end

data/lib/cartman/version.rb

@@ -1,3 +1,3 @@
 module Cartman
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/cartman.rb

@@ -2,6 +2,7 @@ require "cartman/version"
 require "cartman/configuration"
 require "cartman/cart"
 require 'redis'
+require 'ostruct'
 
 module Cartman
   module_function

data/spec/cart_spec.rb

@@ -28,9 +28,15 @@ describe Cartman do
       it "creates a line item key" do
         Cartman.config.redis.exists("cartman:line_item:1").should be_true
       end
+
       it "adds that line item key's id to the cart set" do
         Cartman.config.redis.sismember(cart.send(:key), 1).should be_true
       end
+
+      it "should expire the line_item_keys in the amount of time specified" do
+        cart.ttl.should eq(Cartman.config.cart_expires_in)
+        Cartman.config.redis.ttl("cartman:line_item:1").should eq(Cartman.config.cart_expires_in)
+      end
     end
 
     describe "#items" do
@@ -39,10 +45,40 @@ describe Cartman do
         cart.add_item(id: 34, class: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
       end
 
-      it "should return an array of hashes" do
+      it "should return an array of hashes if config hashes is set" do
+        Cartman.config do
+          return_items_as :hash
+        end
         cart.items.class.should eq(Array)
         cart.items.first.class.should eq(Hash)
         cart.items.size.should eq(2)
+        cart.items.first[:id].should eq("17")
+      end
+
+      it "should return an array of openstructs if no return type is set" do
+        Cartman.config do
+          return_items_as :openstruct
+        end
+        cart.items.first.class.should eq(OpenStruct)
+        cart.items.first.id.should eq("17")
+        cart.items.first.name.should eq("Bordeux")
+      end
+    end
+
+    describe "#total" do
+      it "should total the default costs field" do
+        cart.add_item(id: 17, class: "Bottle", name: "Bordeux", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.add_item(id: 34, class: "Bottle", name: "Cabernet", unit_cost: 92.12, cost: 184.24, quantity: 2)
+        cart.total.should eq(368.48)
+      end
+
+      it "should total whatever cost field the user sets" do
+        Cartman.config do
+          cost_field :cost_in_cents
+        end
+        cart.add_item(id: 17, class: "Bottle", name: "Bordeux", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.add_item(id: 34, class: "Bottle", name: "Cabernet", unit_cost: 92.12, cost_in_cents: 18424, quantity: 2)
+        cart.total.should eq(36848)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cartman
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-19 00:00:00.000000000 Z
+date: 2012-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2349574205203334648
+      hash: 1736743105413686891
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2349574205203334648
+      hash: 1736743105413686891
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23