messenger 0.0.1 → 0.0.2

data/README.markdown

@@ -1,2 +1,51 @@
 Messenger
+=========
+
+Messenger makes it easy to send messages using a variety of services (e.g. email, web, campfire, jabber). It is designed to be used via the command-line or invoked directly with in a Ruby application. One of the guiding principles behind the library is to specify as much as possible through a single URL.
+
+
+Services
 ========
+
+Email
+-----
+
+Email messages are sent using the Pony gem.
+
+    messenger mailto:email@example.com "Message" --email-from your.email@example.com --email-subject "Hi"
+
+
+Web
+---
+
+Web posts are send using the HTTParty gem. The message is sent as the request body, not the query.
+
+    messenger http://example.com "Message"
+
+
+Campfire
+--------
+
+Campfire messages are sent using the HTTParty gem against the Campfire API.
+
+    messenger campfire://api-key:room-id@subdomain.campfirenow.com "Message"
+
+
+Jabber
+------
+
+Jabber messages are sent using the xmppr4-simple gem. It's important to note that the jabber server can be sent in the URL if it can't be inferred from the jabber ID (as is the case for Google Apps ids).
+
+    messenger jabber://email@example.com/jabber_server "Message" --jabber-id your.email@example.com --jabber-password #######
+
+
+Config
+======
+
+Messenger will also read in ~/.messenger (a YAML file) for default config information, such as:
+
+    jabber_id: email@example.com
+    jabber_password: ########
+
+
+(c) 2010 Brandon Arbini / Zencoder, Inc.

data/VERSION.yml

@@ -1,4 +1,5 @@
----
-:major: 0
+--- 
 :minor: 0
-:patch: 1
+:patch: 2
+:major: 0
+:build: 

data/bin/messenger

@@ -44,7 +44,7 @@ trollop_options = Trollop::options do
 Messenger makes sending messages easy.
 
 Usage:
-        script/messenger [options] <service> <message>
+        messenger [options] <service> <message>
 
 Where [options] are:
 EOS
@@ -53,8 +53,8 @@ EOS
   opt :timeout, "The number of seconds to allow for the call", :type => Integer
 
   # Email options
-  opt :from, "Who the message is from (email).", :type => String
-  opt :subject, "The message subject (email).", :type => String
+  opt :email_from, "Who the message is from (email).", :type => String
+  opt :email_subject, "The message subject (email).", :type => String
 
   # Jabber options
   opt :jabber_id, "The jabber ID to connect as (user@example.com)", :type => String
@@ -77,7 +77,7 @@ Error: no service or message specified.
 
 Usage (--help for more):
 
-        script/messenger [options] <service> <message>
+        messenger [options] <service> <message>
 
 EOS
   exit -1

data/lib/messenger/campfire.rb

@@ -5,6 +5,8 @@ module Messenger
 
   class Campfire
 
+    # URL format:
+    #     campfire://api-key:room-id@subdomain.campfirenow.com
     def self.send(url, body, options={})
       begin
         api_key, room, subdomain = url.match(/^campfire:\/\/([^:]+):([^@]+)@([^\.]+)/)[1,3]

data/lib/messenger/email.rb

@@ -4,11 +4,17 @@ module Messenger
 
   class Email
 
+    # URL format:
+    #     mailto:email@example.com
+    #
+    # Options:
+    #     :email_from => Who the email is from
+    #     :email_subject => The subject of the email
     def self.send(url, message, options={})
       Pony.mail(
         :to => url.sub(/mailto:/, ''),
-        :from => options[:from],
-        :subject => options[:subject],
+        :from => options[:email_from],
+        :subject => options[:email_subject],
         :body => message
       )
       [true, nil]

data/lib/messenger/jabber.rb

@@ -4,6 +4,14 @@ module Messenger
 
   class Jabber
 
+    # URL format:
+    #     jabber://email@example.com/server_hostname
+    #
+    # The server's hostname is optional, but needed for Google Apps jabber accounts.
+    #
+    # Options:
+    #     :jabber_id => The jabber id of the sender
+    #     :jabber_password => The password of the sender
     def self.send(url, body, options={})
       recipient, host = url.sub("jabber://", "").split("/")[0,2]
       jabber = ::Jabber::Simple.new(options[:jabber_id], options[:jabber_password], host)

data/lib/messenger/web.rb

@@ -4,6 +4,10 @@ module Messenger
 
   class Web
 
+    # URL format:
+    #     http://example.com
+    #
+    # The body of the message is posted as the body of the request, not the query.
     def self.send(url, body, options={})
       response = HTTParty.post(url, options.merge(:body => body))
       [success?(response), response]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: messenger
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Brandon Arbini