broadcast 0.1.0

data/spec/lib/broadcast/media/email_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Email do
+
+  describe '#publish' do
+
+    before {
+      @medium  = Broadcast::Medium::Email.new
+      @message = Broadcast::Message::SpecWithContent.new
+      Mail::TestMailer.deliveries = []
+    }
+
+    it "should deliver the message to one recipient if options.recipients is a string" do
+      @medium.publish(@message)
+      Mail::TestMailer.deliveries.size.should == 1
+      Mail::TestMailer.deliveries.first.to.should == ['foo@moo.com']
+    end
+
+    it "should deliver the message to many recipients if options.recipients is a array" do
+      @medium.options.recipients = ['mike@foo.com', 'tom@foo.com']
+      @medium.publish(@message)
+      Mail::TestMailer.deliveries.size.should == 2
+      Mail::TestMailer.deliveries.first.to.should == ['mike@foo.com']
+      Mail::TestMailer.deliveries.last.to.should   == ['tom@foo.com']
+    end
+
+    it "should properly get delivery_options and set delivery method" do
+      @medium.options.delivery_method = :smtp
+      mail = Mail.new
+      # 'nueter' the mail instance
+      def mail.deliver; end
+      Mail.should_receive(:new).and_return(mail)
+      @medium.publish(@message)
+      mail.delivery_method.settings['user_name'].should == '<username>'
+      mail.delivery_method.settings['password'].should == '<password>'
+      mail.delivery_method.settings['address'].should == 'smtp.gmail.com'
+    end
+
+  end
+
+end

data/spec/lib/broadcast/media/irc_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Irc do
+
+  describe '.new' do
+
+    it "should create a new instance with options provided in config" do
+      medium  = Broadcast::Medium::Irc.new
+      medium.options.username.should == 'foo'
+      medium.options.server.should == 'irc.freenode.net'
+      medium.options.port.should == '6667'
+      medium.options.channel.should == 'broadcast'
+    end
+
+    it "should prioritize options argument over options provided in config" do
+      medium  = Broadcast::Medium::Jabber.new(:username => 'someoneelse', :server => 'irc.otherfreenode.net', :port => '6666', :channel => 'newchannel')
+      medium.options.username.should == 'someoneelse'
+      medium.options.server.should == 'irc.otherfreenode.net'
+      medium.options.port.should == '6666'
+      medium.options.channel.should == 'newchannel'
+    end
+
+  end
+
+  describe '#publish' do
+
+    before do
+      @medium  = Broadcast::Medium::Irc.new
+      @message = Broadcast::Message::SpecWithContent.new
+    end
+
+    it "should send the message to IRC channels with the message body" do
+      ShoutBot.should_receive(:shout).with("irc://foo@irc.freenode.net:6667/#broadcast")
+      @medium.publish(@message)
+    end
+
+  end
+
+end

data/spec/lib/broadcast/media/jabber_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Jabber do
+
+  # 'nueter' the Jabber::Client
+  class Jabber::Client
+    def connect(*args); end
+    def auth(*args); end
+    def send(*args); end
+  end
+
+  describe '::Client' do
+
+    before {
+      @client = Broadcast::Medium::Jabber::Client.new('foo@foo.com', '123')
+    }
+
+    describe '.new' do
+
+      it "should create a new Jabber::Client and connect to jabber" do
+        @client.client.should be_an_instance_of Jabber::Client
+      end
+
+    end
+
+    describe 'deliver' do
+
+      it "should use the client to send a message" do
+        @client.client.should_receive(:send)
+        @client.deliver('mike@foo.com', 'Hi')
+      end
+
+    end
+
+  end
+
+  describe '.new' do
+
+    it "should create a new instance with options provided in config" do
+      medium  = Broadcast::Medium::Jabber.new
+      medium.options.username.should == 'foo@foo.com'
+      medium.options.password.should == 'mypass'
+    end
+
+    it "should prioritize options argument options provided in config" do
+      medium  = Broadcast::Medium::Jabber.new(:username => 'someoneelse@foo.com', :password => 'elsepass')
+      medium.options.username.should == 'someoneelse@foo.com'
+      medium.options.password.should == 'elsepass'
+    end
+
+  end
+
+  describe '#jabber' do
+
+    it "should instantiate a new Broadcast::Medium::Jabber::Client instance" do
+      jabber = Broadcast::Medium::Jabber.new.jabber
+      jabber.should be_an_instance_of(Broadcast::Medium::Jabber::Client)
+    end
+
+    it "should memoize the Broadcast::Medium::Jabber::Client instance" do
+      medium = Broadcast::Medium::Jabber.new
+      jabber = medium.jabber
+      medium.jabber.object_id.should == jabber.object_id
+    end
+
+  end
+
+  describe '#publish' do
+
+    before {
+      @medium  = Broadcast::Medium::Jabber.new(:username => 'foo@foo.com', :password => 'passkey')
+      @message = Broadcast::Message::SpecWithContent.new
+      @jabber  = mock
+      @medium.stub!(:jabber).and_return(@jabber)
+    }
+
+    it "should deliver the message to one recipient if options.recipients is a string" do
+      @jabber.should_receive(:deliver).with('mike@foo.com', "message")
+      @medium.publish(@message)
+    end
+
+    it "should deliver the message to many recipients if options.recipients is a array" do
+      @medium.options.recipients = ['mike@foo.com', 'tom@foo.com']
+      @jabber.should_receive(:deliver).with('mike@foo.com', "message")
+      @jabber.should_receive(:deliver).with('tom@foo.com', "message")
+      @medium.publish(@message)
+    end
+
+  end
+
+end

data/spec/lib/broadcast/media/log_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Log do
+
+  before do
+    Broadcast.configuration.log.file = nil
+  end
+
+  describe '#publish' do
+
+    it "should send message to logfile if it was defined on class level" do
+      log = StringIO.new
+      Broadcast.configuration.log.file = log
+      message = Broadcast::Message::SpecWithContent.new
+      Broadcast::Medium::Log.new.publish(message)
+      log.rewind
+      log.read.should match(message.body)
+    end
+
+    it "should send message to logfile if it was defined in options" do
+      log = StringIO.new
+      message = Broadcast::Message::SpecWithContent.new
+      Broadcast::Medium::Log.new(:file => log).publish(message)
+      log.rewind
+      log.read.should match(message.body)
+    end
+
+    it "should look at options first before class when looking for file" do
+      log_default = StringIO.new
+      log_options = StringIO.new
+      Broadcast.configuration.log.file = log_default
+
+      message = Broadcast::Message::SpecWithContent.new
+      Broadcast::Medium::Log.new(:file => log_options).publish(message)
+      log_options.rewind
+      log_options.read.should match(message.body)
+      log_default.rewind
+      log_default.read.should == ''
+    end
+
+  end
+
+end

data/spec/lib/broadcast/media/oauth_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Oauth do
+
+  before do
+    Broadcast::Medium::Oauth.site            = nil
+  end
+
+  describe '.consumer' do
+
+    before do
+      Broadcast::Medium::Oauth.site            = 'http://site.com'
+    end
+
+    it "should return consumer object with proper keys and site" do
+      consumer = Broadcast::Medium::Oauth.new.consumer
+      consumer.should be_an_instance_of(OAuth::Consumer)
+      consumer.key.should == 'consumerkey'
+      consumer.secret.should == 'consumersecret'
+    end
+
+    it "should memoize the consumer object" do
+      medium   = Broadcast::Medium::Oauth.new
+      consumer = medium.consumer
+      medium.consumer.object_id.should == consumer.object_id
+    end
+
+  end
+
+  describe '#token' do
+
+    before do
+      Broadcast::Medium::Oauth.site = 'http://site.com'
+    end
+
+    it "should return access token object with proper access token keys" do
+      token = Broadcast::Medium::Oauth.new.token
+      token.should be_an_instance_of(OAuth::AccessToken)
+      token.token.should  == 'accesstoken'
+      token.secret.should == 'accesssecret'
+    end
+
+    it "should memoize the access token" do
+      medium = Broadcast::Medium::Oauth.new
+      token = medium.token
+      medium.token.object_id.should == token.object_id
+    end
+
+    it "should prioritize options argument over class level options" do
+      token = Broadcast::Medium::Oauth.new(:access_token => 'overridetoken', :access_secret => 'overridesecret').token
+      token.should be_an_instance_of(OAuth::AccessToken)
+      token.token.should == 'overridetoken'
+      token.secret.should == 'overridesecret'
+    end
+
+  end
+
+  describe '.authorize' do
+
+    before do
+      Broadcast.configuration.oauth.consumer_key    = nil
+      Broadcast.configuration.oauth.consumer_secret = nil
+      Broadcast::Medium::Oauth.site            = 'http://site.com'
+
+      medium = Broadcast::Medium::Oauth.new
+
+      @request_token = mock
+      @stdout = StringIO.new
+      @old_stdout, $stdout = $stdout, @stdout
+
+      $stdin.should_receive(:gets).and_return('consumerkey123')
+      $stdin.should_receive(:gets).and_return('consumersecret123')
+      $stdin.should_receive(:gets).and_return('12342')
+
+      @request_token.should_receive(:authorize_url).and_return('http://foo.com/1234')
+      medium.consumer.stub!(:get_request_token).and_return(@request_token)
+
+      @access_token  = mock(:token => '6789', :secret => '3456')
+      @request_token.should_receive(:get_access_token).and_return(@access_token)
+
+      medium.authorize
+
+      medium.options.consumer_key.should == 'consumerkey123'
+      medium.options.consumer_secret.should == 'consumersecret123'
+      $stdout = @old_stdout
+      @stdout.rewind
+    end
+
+    it "should use the request token to get the url the user goes to" do
+      @stdout.read.should match('http://foo.com/1234')
+    end
+
+    it "should get the oauth_verifier from the user" do
+      @stdout.read.should match('Enter token')
+    end
+
+    it "should print out the lines the user should put in the config file" do
+      out = @stdout.read
+      out.should match('Put the following in your Broadcast configuration file:')
+      out.should match('config.oauth.consumer_key')
+      out.should match('config.oauth.consumer_secret')
+      out.should match('config.oauth.access_token')
+      out.should match('config.oauth.access_secret')
+    end
+
+  end
+
+end

data/spec/lib/broadcast/media/twitter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Twitter do
+
+  describe '.site' do
+
+    it "should be set to TwitterO OAuth endpoint" do
+      Broadcast::Medium::Twitter.site.should == 'http://api.twitter.com'
+    end
+
+  end
+
+  describe '#publish' do
+
+    it "should send a post to twitter with the message body" do
+      message = Broadcast::Message::SpecWithContent.new
+      medium  = Broadcast::Medium::Twitter.new
+      token   = mock
+      token.should_receive(:post).with("/1/statuses/update.json", {:status=>"message"})
+      medium.should_receive(:token).and_return(token)
+      medium.publish(message)
+    end
+
+  end
+
+end

data/spec/lib/broadcast/media/yammer_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Yammer do
+
+  describe '.site' do
+
+    it "should be set to Yammer OAuth endpoint" do
+      Broadcast::Medium::Yammer.site.should == 'https://www.yammer.com'
+    end
+
+  end
+
+  describe '#publish' do
+
+    it "should send a post to yammer with the message body" do
+      message = Broadcast::Message::SpecWithContent.new
+      medium  = Broadcast::Medium::Yammer.new
+      token   = mock
+      token.should_receive(:post).with("/api/v1/messages.json", { :body=>"message" })
+      medium.should_receive(:token).and_return(token)
+      medium.publish(message)
+    end
+
+  end
+
+end

data/spec/lib/broadcast/medium_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Broadcast::Medium do
+
+  describe '#publish' do
+
+    before do
+      @medium  = Broadcast::Medium::Spec.new
+      @message = Broadcast::Message::Spec.new
+    end
+
+    it "should properly load options" do
+      @medium.options.option.should == 1
+    end
+
+    it "should accept 1 argument" do
+      lambda {
+        @medium.publish(@message)
+      }.should_not raise_error(ArgumentError)
+    end
+
+  end
+
+end

data/spec/lib/broadcast/message_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe Broadcast::Message do
+
+  before do
+    Broadcast::Message::Spec.media = []
+    @log = StringIO.new
+    Broadcast.logger = Logger.new(@log)
+  end
+
+  describe ".initialize" do
+
+    it "should accept options" do
+      msg = Broadcast::Message::Spec.new(:foo => 1)
+      msg.options.foo.should == 1
+    end
+
+  end
+
+  describe ".medium" do
+
+    it "should add a medium to media" do
+      Broadcast::Message::Spec.medium :spec
+      Broadcast::Message::Spec.media.size.should == 1
+      Broadcast::Message::Spec.media.first[:name].should == :spec
+    end
+
+    it "should allow adding of options" do
+      Broadcast::Message::Spec.medium :spec, :option => 1
+      Broadcast::Message::Spec.media.size.should == 1
+      Broadcast::Message::Spec.media.first[:name].should == :spec
+      Broadcast::Message::Spec.media.first[:options].should == { :option => 1 }
+    end
+
+  end
+
+  describe "#body" do
+
+    it "should be empty by default" do
+      Broadcast::Message::Spec.new.body.should == ''
+    end
+
+  end
+
+  describe '#publish' do
+
+    it "should properly load all media of the message" do
+      Broadcast::Message::Spec.medium :spec
+      Broadcast::Message::Spec.new.publish
+    end
+
+    it "should properly instantiate all media of the message" do
+      medium = mock
+      medium.should_receive(:publish)
+      Broadcast::Medium::Spec.should_receive(:new).once.and_return(medium)
+      Broadcast::Message::Spec.medium :spec
+      Broadcast::Message::Spec.new.publish
+    end
+
+    it "should send to logger if medium instantiation fails" do
+      medium = mock
+      medium.should_receive(:publish).and_raise 'Some Exception'
+      Broadcast::Medium::Spec.should_receive(:new).once.and_return(medium)
+      Broadcast::Message::Spec.medium :spec
+      lambda {
+        Broadcast::Message::Spec.new.publish
+      }.should_not raise_error
+      @log.rewind
+      @log.read.should match('Publishing of Broadcast::Message::Spec to spec failed:\nSome Exception')
+    end
+
+  end
+
+end

data/spec/lib/broadcast_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+ORIGINAL_CONFIG = Broadcast.configuration
+
+describe Broadcast do
+
+  describe '.publish' do
+
+    it "should properly load the message class and instantiate the message" do
+      msg = mock(:publish => true)
+      Broadcast::Message::Spec.should_receive(:new).once.and_return(msg)
+      Broadcast.publish(:spec)
+    end
+
+    it "should properly load the message class if in camelcase and instantiate the message" do
+      msg = mock(:publish => true)
+      Broadcast::Message::SpecWithContent.should_receive(:new).once.and_return(msg)
+      Broadcast.publish(:spec_with_content)
+    end
+
+    it "should call publish on the message" do
+      msg = mock
+      msg.should_receive(:publish)
+      Broadcast::Message::Spec.should_receive(:new).once.and_return(msg)
+      Broadcast.publish(:spec)
+    end
+
+  end
+
+  describe '.setup' do
+
+    before {
+      Broadcast.configuration = ORIGINAL_CONFIG
+    }
+
+    it "should allow setting of single settings" do
+      Broadcast.setup { |config|
+        config.some_setting = 1
+      }
+      Broadcast.configuration.should be_an_instance_of(Broadcast::Config)
+      Broadcast.configuration.some_setting.should == 1
+    end
+
+    it "should allow setting of namespaced settings" do
+      Broadcast.setup { |config|
+        config.log.some_setting = 1
+      }
+      Broadcast.configuration.log.should be_an_instance_of(Hashie::Mash)
+      Broadcast.configuration.log.some_setting.should == 1
+    end
+
+    it "should allow setting of namespaced settings using a block" do
+      Broadcast.setup { |config|
+        config.log { |log|
+          log.file  = "foo.log"
+          log.color = 'red'
+        }
+      }
+      Broadcast.configuration.log.should be_an_instance_of(Hashie::Mash)
+      Broadcast.configuration.log.file.should  == 'foo.log'
+      Broadcast.configuration.log.color.should == 'red'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$:.push File.expand_path("../../lib", __FILE__)
+require 'broadcast'
+require 'rspec'
+
+$:.push File.expand_path("../..", __FILE__)
+Dir.glob('spec/support/*').each { |f| require f }

data/spec/support/config.rb

@@ -0,0 +1,43 @@
+Broadcast.setup { |config|
+  config.spec.option = 1
+
+  config.oauth { |oauth|
+    oauth.consumer_key    = 'consumerkey'
+    oauth.consumer_secret = 'consumersecret'
+    oauth.access_token    = 'accesstoken'
+    oauth.access_secret   = 'accesssecret'
+  }
+
+  config.jabber { |jabber|
+    jabber.username       = 'foo@foo.com'
+    jabber.password       = 'mypass'
+    jabber.recipients     = 'mike@foo.com'
+  }
+
+  config.email { |email|
+    email.recipients       = ['foo@moo.com']
+    email.delivery_method  = :test
+    email.delivery_options = {
+      :address => "smtp.gmail.com",
+      :port                 => 587,
+      :domain               => 'your.host.name',
+      :user_name            => '<username>',
+      :password             => '<password>',
+      :authentication       => 'plain',
+      :enable_starttls_auto => true
+    }
+  }
+
+  config.campfire { |campfire|
+    campfire.subdomain = 'myaccount'
+    campfire.token     = 'token'
+    campfire.room      = 'My Room'
+  }
+
+  config.irc { |irc|
+    irc.username = 'foo'
+    irc.server = 'irc.freenode.net'
+    irc.port = '6667'
+    irc.channel = 'broadcast'
+  }
+}

data/spec/support/examples.rb

@@ -0,0 +1,11 @@
+class Broadcast::Message::Spec < Broadcast::Message
+end
+
+class Broadcast::Message::SpecWithContent < Broadcast::Message
+  def body
+    "message"
+  end
+end
+
+class Broadcast::Medium::Spec < Broadcast::Medium
+end