messenger 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Brandon Arbini / Zencoder, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,2 @@
+Messenger
+========

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:major: 0
+:minor: 0
+:patch: 1

data/bin/messenger

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH.unshift lib_dir if File.directory?(lib_dir)
+
+require 'messenger'
+require 'trollop'
+require 'yaml'
+
+
+#-------------------------------------
+# Support
+#-------------------------------------
+
+class Hash
+
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+
+end
+
+
+#
+# Configure options
+#
+
+if File.exists?(File.expand_path("~/.messenger"))
+  options = YAML.load_file(File.expand_path("~/.messenger")).symbolize_keys!
+else
+  options = {}
+end
+
+trollop_options = Trollop::options do
+  version "Messenger #{Messenger.version} (c) Zencoder Inc. All rights reserved, etc."
+  banner <<-EOS
+Messenger makes sending messages easy.
+
+Usage:
+        script/messenger [options] <service> <message>
+
+Where [options] are:
+EOS
+
+  # Global options
+  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
+
+  # Jabber options
+  opt :jabber_id, "The jabber ID to connect as (user@example.com)", :type => String
+  opt :jabber_password, "The password for your jabber id", :type => String
+
+  # CLI options
+  opt :silent, "Don't print anything to stdout", :default => false
+  opt :verbose, "Print verbose output on success", :default => false
+end
+
+options.merge!(trollop_options.reject{|k,v| v.nil?})
+
+#
+# Validate input
+#
+
+if ARGV[0].nil? || ARGV[1].nil?
+  puts <<-EOS
+Error: no service or message specified.
+
+Usage (--help for more):
+
+        script/messenger [options] <service> <message>
+
+EOS
+  exit -1
+end
+
+
+#
+# Run Messenger
+#
+puts "# Sending message to #{ARGV[0]}"
+begin
+  status, details = Messenger.send(ARGV[0], ARGV[1], options)
+  if !!status
+    puts "# Message sent successfully"
+  else
+    puts "# Message not sent"
+    puts "# Details:"
+    puts details
+  end
+rescue => e
+  puts "# **Error** #{e}"
+  puts e.backtrace
+end

data/lib/messenger/campfire.rb

@@ -0,0 +1,36 @@
+require 'httparty'
+require 'json'
+
+module Messenger
+
+  class Campfire
+
+    def self.send(url, body, options={})
+      begin
+        api_key, room, subdomain = url.match(/^campfire:\/\/([^:]+):([^@]+)@([^\.]+)/)[1,3]
+      rescue
+        raise URLError, "The URL provided is invalid"
+      end
+      response = HTTParty.post(
+        "http://#{subdomain}.campfirenow.com/room/#{room}/speak.json",
+        :basic_auth => { :username => api_key, :password => "x" },
+        :headers => { "Content-Type" => "application/json" },
+        :body => { "message" => { "body" => body } }.to_json
+      )
+      [success?(response), response]
+    end
+
+
+  private
+
+    def self.success?(response)
+      case response.code
+      when 200, 201: true
+      else
+        false
+      end
+    end
+
+  end
+
+end

data/lib/messenger/email.rb

@@ -0,0 +1,19 @@
+require 'pony'
+
+module Messenger
+
+  class Email
+
+    def self.send(url, message, options={})
+      Pony.mail(
+        :to => url.sub(/mailto:/, ''),
+        :from => options[:from],
+        :subject => options[:subject],
+        :body => message
+      )
+      [true, nil]
+    end
+
+  end
+
+end

data/lib/messenger/errors.rb

@@ -0,0 +1,7 @@
+module Messenger
+
+  class MessengerError < StandardError; end
+  class ProtocolError < MessengerError; end
+  class URLError < MessengerError; end
+
+end

data/lib/messenger/jabber.rb

@@ -0,0 +1,68 @@
+require 'xmpp4r-simple'
+
+module Messenger
+
+  class Jabber
+
+    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)
+      jabber.deliver(recipient, body)
+      pending_messages_count = 1
+      until pending_messages_count == 0
+        pending_messages_count = jabber.send(:queue, :pending_messages).size
+        sleep 1
+      end
+      status = jabber.subscribed_to?(recipient)
+      [status, status ? nil : "Not yet authorized"]
+    end
+
+  end
+
+end
+
+
+# MONKEY PATCHING
+#
+# xmpp4r-simple does not allow you to specify the jabber host, but we need to do that for Google Apps.
+
+module Jabber
+
+  class Simple
+
+    def initialize(jid, password, host=nil, status=nil, status_message="Available")
+      @jid = jid
+      @password = password
+      @host = host
+      @disconnected = false
+      status(status, status_message)
+      start_deferred_delivery_thread
+    end
+
+    def connect!
+      raise ConnectionError, "Connections are disabled - use Jabber::Simple::force_connect() to reconnect." if @disconnected
+      # Pre-connect
+      @connect_mutex ||= Mutex.new
+
+      # don't try to connect if another thread is already connecting.
+      return if @connect_mutex.locked?
+
+      @connect_mutex.lock
+      disconnect!(false) if connected?
+
+      # Connect
+      jid = JID.new(@jid)
+      my_client = Client.new(@jid)
+      my_client.connect(@host)
+      my_client.auth(@password)
+      self.client = my_client
+
+      # Post-connect
+      register_default_callbacks
+      status(@presence, @status_message)
+      @connect_mutex.unlock
+    end
+
+  end
+
+end

data/lib/messenger/web.rb

@@ -0,0 +1,24 @@
+require 'httparty'
+
+module Messenger
+
+  class Web
+
+    def self.send(url, body, options={})
+      response = HTTParty.post(url, options.merge(:body => body))
+      [success?(response), response]
+    end
+
+  private
+
+    def self.success?(response)
+      case response.code
+      when 200, 201: true
+      else
+        false
+      end
+    end
+
+  end
+
+end

data/lib/messenger.rb

@@ -0,0 +1,61 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'ruby-debug'
+require 'messenger/errors'
+require 'system_timer'
+
+
+module Messenger
+
+  MESSAGER_VERSION = [0,1] unless defined?(MESSAGER_VERSION)
+  APP_ROOT = File.expand_path(File.dirname(__FILE__) + '/..') unless defined?(APP_ROOT)
+
+  def self.version
+    MESSAGER_VERSION.join(".")
+  end
+
+  def self.root
+    APP_ROOT
+  end
+
+
+  def self.send(url, message, options={})
+    service_handler = handler(url)
+    SystemTimer.timeout_after(options[:timeout] || 15) do
+      service_handler.send(url, message, options)
+    end
+  end
+
+
+  def self.protocol(url)
+    # TODO: More services
+    #   sms://1231231234
+    #   twitter://username
+    #   aim://username
+    case url
+    when /^mailto/:   :email
+    when /^http/:     :http
+    when /^campfire/: :campfire
+    when /^jabber/:   :jabber
+    end
+  end
+
+  def self.handler(url)
+    case protocol(url)
+    when :email:    Email
+    when :http:     Web
+    when :campfire: Campfire
+    when :jabber:   Jabber
+    else
+      raise ProtocolError, "Malformed service URL: #{url}. Either this syntax is wrong or this service type is not yet implemented."
+    end
+  end
+
+
+  autoload :Email, "messenger/email"
+  autoload :Web, "messenger/web"
+  autoload :Campfire, "messenger/campfire"
+  autoload :Jabber, "messenger/jabber"
+
+end

data/test/test_campfire.rb

@@ -0,0 +1,35 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+require 'httparty'
+
+module Messenger
+
+  class CampfireTest < Test::Unit::TestCase
+
+    context "Campfire notification" do
+      setup do
+        @success_response = stub("response", :code => 200)
+        @failure_response = stub("response", :code => 500)
+      end
+
+      should "post a successful message" do
+        HTTParty.expects(:post).with("http://subdomain.campfirenow.com/room/room/speak.json", :basic_auth => { :username => 'api', :password => 'x' }, :body => '{"message":{"body":"content"}}', :headers => { "Content-Type" => "application/json" }).returns(@success_response)
+        result = Campfire.send("campfire://api:room@subdomain.campfirewnow.com", 'content')
+        assert_equal [true, @success_response], result
+      end
+
+      should "post a failed message" do
+        HTTParty.expects(:post).with("http://subdomain.campfirenow.com/room/room/speak.json", :basic_auth => { :username => 'api', :password => 'x' }, :body => '{"message":{"body":"content"}}', :headers => { "Content-Type" => "application/json" }).returns(@failure_response)
+        result = Campfire.send("campfire://api:room@subdomain.campfirewnow.com", 'content')
+        assert_equal [false, @failure_response], result
+      end
+
+      should "raise on invalid URL" do
+        assert_raises Messenger::URLError do
+          Campfire.send("campfire://missing_room@subdomain.campfirewnow.com", 'content')
+        end
+      end
+    end
+
+  end
+
+end

data/test/test_email.rb

@@ -0,0 +1,17 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+require 'pony'
+
+module Messenger
+
+  class EmailTest < Test::Unit::TestCase
+
+    context "Email notification" do
+      should "send an email" do
+        Pony.expects(:mail).with(:to => "test@example.com", :body =>  "Test message", :from => "test@example.com", :subject => "Test")
+        Email.send("mailto:test@example.com", "Test message", :from => "test@example.com", :subject => "Test")
+      end
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require "#{File.dirname(__FILE__)}/../lib/messenger"
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+Dir["#{File.dirname(__FILE__)}/shoulda_macros/*.rb"].each {|file| require file }

data/test/test_jabber.rb

@@ -0,0 +1,35 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+require 'xmpp4r-simple'
+
+module Messenger
+
+  class JabberTest < Test::Unit::TestCase
+
+    context "Jabber notification" do
+      setup do
+        @successful_jabber = stub("jabber", :deliver => nil, :queue => stub("queue", :size => 0), :subscribed_to? => true)
+        @failed_jabber = stub("jabber", :deliver => nil, :queue => stub("queue", :size => 0), :subscribed_to? => false)
+      end
+
+      should "send a successful jabber message" do
+        ::Jabber::Simple.expects(:new).with("notifier@zencoder.com", "asdfasdf", nil).returns(@successful_jabber)
+        result = Jabber.send("jabber://brandon@zencoder.com", "Test message", :jabber_id => "notifier@zencoder.com", :jabber_password => "asdfasdf")
+        assert_equal [true, nil], result
+      end
+
+      should "determine and set the jabber host" do
+        ::Jabber::Simple.expects(:new).with("notifier@zencoder.com", "asdfasdf", "host.com").returns(@successful_jabber)
+        result = Jabber.send("jabber://brandon@zencoder.com/host.com", "Test message", :jabber_id => "notifier@zencoder.com", :jabber_password => "asdfasdf")
+        assert_equal [true, nil], result
+      end
+
+      should "fail if the recipient is not subscribed" do
+        ::Jabber::Simple.expects(:new).with("notifier@zencoder.com", "asdfasdf", nil).returns(@failed_jabber)
+        result = Jabber.send("jabber://brandon@zencoder.com", "Test message", :jabber_id => "notifier@zencoder.com", :jabber_password => "asdfasdf")
+        assert_equal [false, "Not yet authorized"], result
+      end
+    end
+
+  end
+
+end

data/test/test_messenger.rb

@@ -0,0 +1,23 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+
+module Messenger
+
+  class MessengerTest < Test::Unit::TestCase
+
+    context "Protocol/Handler" do
+      should "determine the proper service" do
+        assert_equal :email, Messenger.protocol("mailto:test@example.com")
+        assert_equal :http, Messenger.protocol("http://example.com")
+        assert_equal :http, Messenger.protocol("https://example.com")
+      end
+
+      should "determine the proper notification handler given a protocol" do
+        assert_equal Email, Messenger.handler("mailto:test@example.com")
+        assert_equal Web, Messenger.handler("http://example.com")
+        assert_equal Web, Messenger.handler("https://example.com")
+      end
+    end
+
+  end
+
+end

data/test/test_web.rb

@@ -0,0 +1,29 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+require 'httparty'
+
+module Messenger
+
+  class WebTest < Test::Unit::TestCase
+
+    context "Web notification" do
+      setup do
+        @success_response = stub("response", :code => 200)
+        @failure_response = stub("response", :code => 500)
+      end
+
+      should "post a successful message" do
+        HTTParty.expects(:post).with("http://example.com", :body => '{ "key": "value" }', :headers => { "Content-Type" => "application/json" }).returns(@success_response)
+        result = Web.send("http://example.com", '{ "key": "value" }', :headers => { "Content-Type" => "application/json" })
+        assert_equal [true, @success_response], result
+      end
+
+      should "post a failed message" do
+        HTTParty.expects(:post).with("http://example.com", :body => '{ "key": "value" }', :headers => { "Content-Type" => "application/json" }).returns(@failure_response)
+        result = Web.send("http://example.com", '{ "key": "value" }', :headers => { "Content-Type" => "application/json" })
+        assert_equal [false, @failure_response], result
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: messenger
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brandon Arbini
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-04 00:00:00 -08:00
+default_executable: messenger
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.15"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: SystemTimer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "0.5"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.8.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+description: "Messenger: easy message sending"
+email: brandon@zencoder.tv
+executables: 
+- messenger
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- README.markdown
+- VERSION.yml
+- lib/messenger.rb
+- lib/messenger/campfire.rb
+- lib/messenger/email.rb
+- lib/messenger/errors.rb
+- lib/messenger/jabber.rb
+- lib/messenger/web.rb
+- test/test_campfire.rb
+- test/test_email.rb
+- test/test_helper.rb
+- test/test_jabber.rb
+- test/test_messenger.rb
+- test/test_web.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/zencoder/messenger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Messenger: easy message sending"
+test_files: 
+- test/test_campfire.rb
+- test/test_email.rb
+- test/test_helper.rb
+- test/test_jabber.rb
+- test/test_messenger.rb
+- test/test_web.rb