public
Description: Dead simple IM notifications for your app
Homepage: http://jamesgolick.com/action_messager
Clone URL: git://github.com/giraffesoft/action_messager.git
action_messager / README
100644 47 lines (27 sloc) 1.432 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
= 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]