messenger 0.1.1 → 0.2.0

data/VERSION.yml

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

data/bin/messenger

@@ -60,6 +60,12 @@ EOS
   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
 
+  # Notifo options
+  opt :notifo_api_username, "The service's API username", :type => String
+  opt :notifo_api_secret, "The service's API secret", :type => String
+  opt :notifo_title, "The notificaiton title", :type => String
+  opt :notifo_url, "Open this URL", :type => String
+
   # CLI options
   # opt :silent, "Don't print anything to stdout", :default => false
   # opt :verbose, "Print verbose output on success", :default => false

data/lib/messenger.rb

@@ -1,7 +1,6 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'rubygems'
-require 'ruby-debug'
 require 'messenger/errors'
 require 'system_timer'
 
@@ -23,6 +22,8 @@ module Messenger
   def self.valid_url?(url)
     service_handler = handler(url)
     service_handler.valid_url?(url)
+  rescue ProtocolError
+    false
   end
 
   def self.send(url, message, options={})
@@ -44,10 +45,11 @@ module Messenger
     #   twitter://username
     #   aim://username
     case url
-    when /^mailto/:   :email
-    when /^http/:     :http
-    when /^campfire/: :campfire
-    when /^jabber/:   :jabber
+    when /^http/:      :http
+    when /^campfire/:  :campfire
+    when /^jabber/:    :jabber
+    when /^notifo/:    :notifo
+    when /^mailto|@+/: :email
     end
   end
 
@@ -57,6 +59,7 @@ module Messenger
     when :http:     Web
     when :campfire: Campfire
     when :jabber:   Jabber
+    when :notifo:   Notifo
     else
       raise ProtocolError, "Malformed service URL: #{url}. Either this syntax is wrong or this service type is not yet implemented."
     end
@@ -68,5 +71,6 @@ module Messenger
   autoload :Web, "messenger/web"
   autoload :Campfire, "messenger/campfire"
   autoload :Jabber, "messenger/jabber"
+  autoload :Notifo, "messenger/notifo"
 
 end

data/lib/messenger/campfire.rb

@@ -15,9 +15,9 @@ module Messenger
     #     campfire://api-key:room-id@subdomain.campfirenow.com
     def self.send(url, body, options={})
       raise URLError, "The URL provided is invalid" unless valid_url?(url)
-      api_key, room, subdomain = matcher(url)
+      ssl, api_key, room, subdomain = matcher(url)
       response = HTTParty.post(
-        "http://#{subdomain}.campfirenow.com/room/#{room}/speak.json",
+        "http#{ssl ? "s" : ""}://#{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
@@ -27,15 +27,15 @@ module Messenger
 
     def self.obfuscate(url)
       raise URLError, "The URL provided is invalid" unless valid_url?(url)
-      api_key, room, subdomain = matcher(url)
-      "campfire://xxxx:#{room}@#{subdomain}.campfirenow.com"
+      ssl, api_key, room, subdomain = matcher(url)
+      "campfire#{ssl ? "-ssl" : ""}://xxxx:#{room}@#{subdomain}.campfirenow.com"
     end
 
 
   private
 
     def self.matcher(url)
-      url.match(/^campfire:\/\/([^:]+):([^@]+)@([^\.]+).campfirenow.com/)[1,3]
+      url.match(/^campfire(-ssl)?:\/\/([^:]+):([^@]+)@([^\.]+).campfirenow.com/)[1,4]
     end
 
     def self.success?(response)

data/lib/messenger/email.rb

@@ -5,7 +5,7 @@ module Messenger
   class Email
 
     def self.valid_url?(url)
-      !!url.match(/mailto:[^@]+@.*/)
+      !!url.match(/^(mailto:)?[^@]+@.*$/)
     end
 
     # URL format:
@@ -24,6 +24,8 @@ module Messenger
       end
       mail.deliver!
       Result.new(true, nil)
+    rescue Errno::ECONNREFUSED, Errno::EAFNOSUPPORT => e
+      Result.new(false, e)
     end
 
     def self.obfuscate(url)

data/lib/messenger/notifo.rb

@@ -0,0 +1,47 @@
+require 'httparty'
+require 'json'
+
+module Messenger
+
+  class Notifo
+
+    def self.valid_url?(url)
+      !!url.match(/^notifo:\/\/.+$/)
+    end
+
+    # URL format:
+    #     notifo://username
+    #
+    # Options:
+    #     :notifo_api_username => The service's API username
+    #     :notifo_api_secret => The service's API secret
+    #     :notifo_title => The notificaiton title
+    #     :notifo_url => Open this URL
+    def self.send(url, message, options={})
+      raise URLError, "The URL provided is invalid" unless valid_url?(url)
+      username = matcher(url)
+      response = HTTParty.post("https://api.notifo.com/v1/send_notification",
+                   :body => { :to => username, :msg => message, :title => options[:notifo_title], :uri => options[:notifo_url] },
+                   :basic_auth => { :username => options[:notifo_api_username], :password => options[:notifo_api_secret] })
+      Result.new(success?(response), response)
+    end
+
+    def self.obfuscate(url)
+      raise URLError, "The URL provided is invalid" unless valid_url?(url)
+      url
+    end
+
+
+  private
+
+    def self.matcher(url)
+      url.match(/^notifo:\/\/(.+)/)[1]
+    end
+
+    def self.success?(response)
+      response.code == 200
+    end
+
+  end
+
+end

data/lib/messenger/result.rb

@@ -13,6 +13,18 @@ module Messenger
       !!@success
     end
 
+    def code
+      response.code rescue nil
+    end
+
+    def body
+      if response.respond_to?(:body)
+        response.body
+      else
+        response.to_s
+      end
+    end
+
   end
 
 end

data/test/test_campfire.rb

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/test_helper"
+require "test_helper"
 require 'httparty'
 
 module Messenger
@@ -7,8 +7,8 @@ module Messenger
 
     context "Campfire notification" do
       setup do
-        @success_response = stub("response", :code => 200)
-        @failure_response = stub("response", :code => 500)
+        @success_response = stub(:code => 200)
+        @failure_response = stub(:code => 500)
       end
 
       should "post a successful message" do
@@ -18,6 +18,13 @@ module Messenger
         assert_equal @success_response, result.response
       end
 
+      should "post to secure URL" do
+        HTTParty.expects(:post).with("https://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-ssl://api:room@subdomain.campfirenow.com", 'content')
+        assert result.success?
+        assert_equal @success_response, result.response
+      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.campfirenow.com", 'content')
@@ -35,6 +42,10 @@ module Messenger
         assert_equal "campfire://xxxx:1234@example.campfirenow.com", Campfire.obfuscate("campfire://asdf1234:1234@example.campfirenow.com")
       end
 
+      should "obfuscate a secure URL" do
+        assert_equal "campfire-ssl://xxxx:1234@example.campfirenow.com", Campfire.obfuscate("campfire-ssl://asdf1234:1234@example.campfirenow.com")
+      end
+
       should "raise when obfuscating an invalid URL" do
         assert_raises URLError do
           Campfire.obfuscate("campfire://missing_room@subdomain.campfirenow.com")
@@ -45,6 +56,7 @@ module Messenger
     context "Campfire URL validation" do
       should "return true for good URLs" do
         assert true, Campfire.valid_url?("campfire://api_key:room@subdomain.campfirenow.com")
+        assert true, Campfire.valid_url?("campfire-ssl://api_key:room@subdomain.campfirenow.com")
       end
 
       should "return false for bad URLs" do

data/test/test_email.rb

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/test_helper"
+require "test_helper"
 require 'mail'
 
 module Messenger
@@ -46,7 +46,6 @@ module Messenger
       should "return false for bad URLs" do
         assert_equal false, Email.valid_url?("mailto:")
         assert_equal false, Email.valid_url?("mailto:test")
-        assert_equal false, Email.valid_url?("mailto:@example.com")
         assert_equal false, Email.valid_url?("mailto:example.com")
       end
     end

data/test/test_helper.rb

@@ -1,6 +1,11 @@
-require "#{File.dirname(__FILE__)}/../lib/messenger"
+require "messenger"
 require 'test/unit'
 require 'shoulda'
 require 'mocha'
+require 'webmock/test_unit'
+
+class Test::Unit::TestCase
+  include WebMock
+end
 
 Dir["#{File.dirname(__FILE__)}/shoulda_macros/*.rb"].each {|file| require file }

data/test/test_jabber.rb

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/test_helper"
+require "test_helper"
 require 'xmpp4r-simple'
 
 module Messenger

data/test/test_messenger.rb

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/test_helper"
+require "test_helper"
 
 module Messenger
 
@@ -6,18 +6,34 @@ module Messenger
 
     should "determine the proper protocol" do
       assert_equal :email, Messenger.protocol("mailto:test@example.com")
+      assert_equal :email, Messenger.protocol("test@example.com")
       assert_equal :http, Messenger.protocol("http://example.com")
       assert_equal :http, Messenger.protocol("https://example.com")
       assert_equal :jabber, Messenger.protocol("jabber://test@example.com")
       assert_equal :campfire, Messenger.protocol("campfire://api_key:room_id@subdomain.campfirenow.com")
+      assert_nil Messenger.protocol("bogus")
     end
 
     should "determine the proper notification handler given a protocol" do
       assert_equal Email, Messenger.handler("mailto:test@example.com")
+      assert_equal Email, Messenger.handler("test@example.com")
       assert_equal Web, Messenger.handler("http://example.com")
       assert_equal Web, Messenger.handler("https://example.com")
       assert_equal Jabber, Messenger.handler("jabber://test@example.com")
       assert_equal Campfire, Messenger.handler("campfire://api_key:room_id@subdomain.campfirenow.com")
+      assert_raises Messenger::ProtocolError do
+        Messenger.handler("example.com")
+      end
+    end
+
+    should "determine valid URLs" do
+      assert Messenger.valid_url?("mailto:test@example.com")
+      assert Messenger.valid_url?("test@example.com")
+      assert Messenger.valid_url?("http://example.com")
+      assert Messenger.valid_url?("https://example.com")
+      assert Messenger.valid_url?("jabber://test@example.com")
+      assert Messenger.valid_url?("campfire://api_key:room_id@subdomain.campfirenow.com")
+      assert !Messenger.valid_url?("bogus")
     end
 
   end

data/test/test_notifo.rb

@@ -0,0 +1,40 @@
+require "test_helper"
+require 'httparty'
+
+module Messenger
+
+  class NotifoTest < Test::Unit::TestCase
+
+    context "Notifo notification" do
+      should "post a successful message" do
+        stub_request(:post, "https://api.notifo.com/v1/send_notification").to_return(:status => 200)
+        result = Notifo.send("notifo://testuser", 'message')
+        assert result.success?
+      end
+
+      should "post a failed message" do
+        stub_request(:post, "https://api.notifo.com/v1/send_notification").to_return(:status => 400)
+        result = Notifo.send("notifo://testuser", 'message')
+        assert !result.success?
+      end
+
+      should "raise when sending to an invalid URL" do
+        assert_raises URLError do
+          Notifo.send("notifo://", 'message')
+        end
+      end
+    end
+
+    context "Notifo URL validation" do
+      should "return true for good URLs" do
+        assert true, Notifo.valid_url?("notifo://testuser")
+      end
+
+      should "return false for bad URLs" do
+        assert_equal false, Notifo.valid_url?("notifo://")
+      end
+    end
+
+  end
+
+end

data/test/test_result.rb

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/test_helper"
+require "test_helper"
 
 module Messenger
 

data/test/test_web.rb

@@ -1,4 +1,4 @@
-require "#{File.dirname(__FILE__)}/test_helper"
+require "test_helper"
 require 'httparty'
 
 module Messenger

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: messenger
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Brandon Arbini
@@ -9,89 +15,134 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-08 00:00:00 -08:00
+date: 2010-06-17 00:00:00 -05:00
 default_executable: messenger
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: trollop
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 1
+        - 15
         version: "1.15"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: mime-types
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 1
+        - 16
         version: "1.16"
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
         version: 0.5.2
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: SystemTimer
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 1
+        - 3
         version: 1.1.3
-    version: 
+  type: :runtime
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: xmpp4r
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 0
+        - 5
         version: "0.5"
-    version: 
+  type: :runtime
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: xmpp4r-simple
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 0
+        - 8
+        - 8
         version: 0.8.8
-    version: 
+  type: :runtime
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: json_pure
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 2
+        - 0
         version: 1.2.0
-    version: 
+  type: :runtime
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: mail
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
         version: 2.1.2
-    version: 
+  type: :runtime
+  version_requirements: *id008
 description: "Messenger: easy message sending"
 email: brandon@zencoder.tv
 executables: 
@@ -109,6 +160,7 @@ files:
 - lib/messenger/email.rb
 - lib/messenger/errors.rb
 - lib/messenger/jabber.rb
+- lib/messenger/notifo.rb
 - lib/messenger/result.rb
 - lib/messenger/web.rb
 - test/test_campfire.rb
@@ -116,9 +168,11 @@ files:
 - test/test_helper.rb
 - test/test_jabber.rb
 - test/test_messenger.rb
+- test/test_notifo.rb
 - test/test_result.rb
 - test/test_web.rb
 - LICENSE
+- bin/messenger
 has_rdoc: true
 homepage: http://github.com/zencoder/messenger
 licenses: []
@@ -129,21 +183,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: "Messenger: easy message sending"
@@ -153,5 +213,6 @@ test_files:
 - test/test_helper.rb
 - test/test_jabber.rb
 - test/test_messenger.rb
+- test/test_notifo.rb
 - test/test_result.rb
 - test/test_web.rb