public
Description: Dead simple IM notifications for your app
Homepage: http://jamesgolick.com/action_messager
Clone URL: git://github.com/giraffesoft/action_messager.git
name age message
file .gitignore Sun Apr 06 13:07:07 -0700 2008 fix a dependency [giraffesoft]
file LICENSE Sun Apr 06 12:56:58 -0700 2008 add a readme [giraffesoft]
file README Sun Apr 06 16:25:55 -0700 2008 fix typo [giraffesoft]
file Rakefile Sun Apr 06 12:33:32 -0700 2008 add gem skeleton [giraffesoft]
file init.rb Sun Apr 06 15:18:02 -0700 2008 add an init.rb file for use when unpacked in rails [giraffesoft]
directory lib/ Sun Apr 06 15:09:00 -0700 2008 bump version to 0.0.2 [giraffesoft]
directory tasks/ Sun Apr 06 15:18:02 -0700 2008 add an init.rb file for use when unpacked in rails [giraffesoft]
directory test/ Sun Apr 06 12:39:35 -0700 2008 add extracted code from zookeepr [giraffesoft]
README
= ActionMessager

ActionMessager is dead simple IM notifications for your app.

== Get It
  
    $ sudo gem install action_messager
    
    ... or get the source ...
    
    $ git clone git@github.com:giraffesoft/action_messager.git
    
== Usage

ActionMessager works just like ActionMailer. All you have to do start sending IM notifications to your users is subclass 
ActionMessager::Base; then, create a method that sets an array of recipients, and returns the message you'd like to 
send:

  class JabberNotifier < ActionMessager::Base
    def friendship_request(friendship_request)
      @recipients = friendship_request.receiver.jabber_contact
      
      "You have received a friendship request from #{friendship_request.sender.name}! Click here to accept or decline: 
      #{friendship_request.url}"
    end
  end
  
Then, wherever you'd like to send the notification:

  JabberNotifier.deliver_friendship_request(friendship_request)
  
That's it!

== Configuration

You'll need to configure ActionMessager with your jabber credentials.

  ActionMessager::Base.jabber_settings = {
    :username => 'somebody@somejabberserver.com',
    :password => 'swordfish!'
  }

== Credits

ActionMessager was created, and is maintained by {James Golick}[http://jamesgolick.com].

== License

ActionMessager is Copyright (c) 2008 James Golick, GiraffeSoft Inc. It is released under the {MIT 
License}[http://en.wikipedia.org/wiki/MIT_License]