messenger 0.1.0 → 0.1.1

data/VERSION.yml

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

data/bin/messenger

@@ -89,13 +89,13 @@ end
 #
 puts "# Sending message to #{ARGV[0]}"
 begin
-  status, details = Messenger.send(ARGV[0], ARGV[1], options)
-  if !!status
+  result = Messenger.send(ARGV[0], ARGV[1], options)
+  if result.success?
     puts "# Message sent successfully"
   else
     puts "# Message not sent"
     puts "# Details:"
-    puts details
+    puts result.response
   end
 rescue => e
   puts "# **Error** #{e}"

data/lib/messenger.rb

@@ -63,6 +63,7 @@ module Messenger
   end
 
 
+  autoload :Result, "messenger/result"
   autoload :Email, "messenger/email"
   autoload :Web, "messenger/web"
   autoload :Campfire, "messenger/campfire"

data/lib/messenger/campfire.rb

@@ -22,7 +22,7 @@ module Messenger
         :headers => { "Content-Type" => "application/json" },
         :body => { "message" => { "body" => body } }.to_json
       )
-      [success?(response), response]
+      Result.new(success?(response), response)
     end
 
     def self.obfuscate(url)

data/lib/messenger/email.rb

@@ -23,7 +23,7 @@ module Messenger
             body message
       end
       mail.deliver!
-      [true, nil]
+      Result.new(true, nil)
     end
 
     def self.obfuscate(url)

data/lib/messenger/jabber.rb

@@ -29,7 +29,7 @@ module Messenger
         sleep 1
       end
       status = jabber.subscribed_to?(recipient)
-      [status, status ? nil : "Not yet authorized"]
+      Result.new(status, status ? nil : "Not yet authorized")
     end
 
     def self.obfuscate(url)

data/lib/messenger/result.rb

@@ -0,0 +1,18 @@
+module Messenger
+
+  class Result
+
+    attr_reader :response
+
+    def initialize(success, response)
+      @success = success
+      @response = response
+    end
+
+    def success?
+      !!@success
+    end
+
+  end
+
+end

data/lib/messenger/web.rb

@@ -18,7 +18,7 @@ module Messenger
     def self.send(url, body, options={})
       raise URLError, "The URL provided is invalid" unless self.valid_url?(url)
       response = HTTParty.post(url, options.merge(:body => body))
-      [success?(response), response]
+      Result.new(success?(response), response)
     end
 
     def self.obfuscate(url)

data/test/test_campfire.rb

@@ -14,13 +14,15 @@ module Messenger
       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.campfirenow.com", 'content')
-        assert_equal [true, @success_response], result
+        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')
-        assert_equal [false, @failure_response], result
+        assert_equal false, result.success?
+        assert_equal @failure_response, result.response
       end
 
       should "raise when sending to an invalid URL" do

data/test/test_jabber.rb

@@ -14,19 +14,22 @@ module Messenger
       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
+        assert result.success?
+        assert_nil result.response
       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
+        assert result.success?
+        assert_nil result.response
       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
+        assert_equal false, result.success?
+        assert_equal "Not yet authorized", result.response
       end
 
       should "raise when sending to an invalid URL" do

data/test/test_result.rb

@@ -0,0 +1,25 @@
+require "#{File.dirname(__FILE__)}/test_helper"
+
+module Messenger
+
+  class ResultTest < Test::Unit::TestCase
+
+    context "A result" do
+
+      should "return success as a boolean" do
+        result = Result.new(true, "Response")
+        assert result.success?
+        result = Result.new(false, "Response")
+        assert_equal false, result.success?
+      end
+
+      should "give access to the raw response" do
+        result = Result.new(true, "Response")
+        assert_equal "Response", result.response
+      end
+
+    end
+
+  end
+
+end

data/test/test_web.rb

@@ -14,13 +14,15 @@ module Messenger
       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
+        assert result.success?
+        assert_equal @success_response, result.response
       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
+        assert_equal false, result.success?
+        assert_equal @failure_response, result.response
       end
 
       should "raise if trying to send to an invalid URL" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: messenger
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Brandon Arbini
@@ -109,12 +109,14 @@ files:
 - lib/messenger/email.rb
 - lib/messenger/errors.rb
 - lib/messenger/jabber.rb
+- lib/messenger/result.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_result.rb
 - test/test_web.rb
 - LICENSE
 has_rdoc: true
@@ -151,4 +153,5 @@ test_files:
 - test/test_helper.rb
 - test/test_jabber.rb
 - test/test_messenger.rb
+- test/test_result.rb
 - test/test_web.rb