ledger 0.0.3 → 0.0.4

data/README.md

@@ -1,4 +1,4 @@
-# Ledger
+![Ledger](http://dl.dropbox.com/u/3155323/Screenshots/e~rru3f-4d8j.png)
 
 Does your app have the concept of accounts, with multiple users per account?
 
@@ -27,7 +27,7 @@ Or install it yourself as:
 Start by adding the `HasEvents` module to your account object.
 
 ```ruby
-class Account < ActiveRecord::Base
+class Accounts
 	…
 	include Ledger::HasEvents
 	…
@@ -37,7 +37,7 @@ end
 Add in the `CreatesEvents` module to your controller.
 
 ```ruby
-class CategoriesController < ApplicationController
+class CategoriesController
 	…
 	include Ledger::CreatesEvents
 	…
@@ -49,7 +49,7 @@ Now all you need to do is call `#create_event` when you do something.
 ```ruby
 def update
 	@category.update_attributes! params[:category]
-	create_event :updateated, @category
+	create_event :updated, @category
 end
 ```
 
@@ -68,7 +68,6 @@ Each event has the following (by default, for options see further down).
 
 ```
 {
-	"key"=>"category_updated",
 	"action"=>"updated",
 	"object"=>"Category",
 	"actor"=>{
@@ -122,13 +121,12 @@ end
 
 Want to send more information about events? Just send through the information at the end of the `#create_event` call.
 
-```
+```ruby
 create_event :state_changed, @category, from: from_state, to: @category.state
 ```
-```
 
+```
 {
-	"key"=>"category_state_changed",
 	"action"=>"state_changed",
 	"object"=>"Category",
 	"actor"=>{
@@ -164,16 +162,16 @@ end
 
 ### Manual Events
 
-You can add an event manually by creating an instance of `Ledger::Event`, then adding than in via `account.add_event`.
+You can add an event manually by creating an instance of `Ledger::Event`, then adding that in via `account.add_event`.
 
 ```ruby
-new_event = Ledger::Event.new key: "manual_event", data: { some: "thing" }
+new_event = Ledger::Event.new action: "create", object: "manual_event", data: { some: "thing" }
 account.add_event new_event
 ```
 
 ### Direct Redis access
 
-You can access redis directly through `#events`. This will be a [Nest](https://github.com/soveran/nest) instance, and you can call on this, or use its naming schema to do some other magic.
+You can access redis directly through `#events`. This will be a [Nest](https://github.com/soveran/nest) instance and you can call on it, or use its naming schema to do some other magic.
 
 ```ruby
 # Trim the events down to the last 100 events
@@ -183,6 +181,16 @@ account.events.ltrim 0, 100
 account.events["something_else"].lpush "Some data"
 ```
 
+## Who
+
+Created with love by [Mal Curtis](http://github.com/snikch)
+
+Twitter: [snikchnz](http://twitter.com/snikchnz)
+
+## License
+
+MIT. See license file.
+
 
 ## Contributing
 

data/lib/ledger/creates_events.rb

@@ -10,11 +10,10 @@ module Ledger
         object that does."
       end
 
-      object_name = object.class.name.downcase
-      key = [object_name, action].join('_')
+      object_name = object.class.name == "String" ? \
+        object : object.class.name.downcase
 
       details = {
-        key: key,
         action: action,
         object: object_name,
         actor: {},

data/lib/ledger/event.rb

@@ -1,6 +1,6 @@
 module Ledger
   class Event
-    attr_accessor :actor, :key, :action, :object, :data, :created_at
+    attr_accessor :actor, :action, :object, :data, :created_at
 
     def initialize opts
       opts.each do |attr, value|
@@ -8,7 +8,7 @@ module Ledger
       end
       self.created_at = Time.now
     end
-    
+
     class << self
       def from_json json
         require 'json'

data/lib/ledger/version.rb

@@ -1,3 +1,3 @@
 module Ledger
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nest