broadcast 0.2.3 → 0.3.0

data/README.markdown

@@ -68,6 +68,22 @@ When you're ready, just instantiate the Message class and call #publish:
   Poke.new.publish
 ```
 
+Broadcast::Message::Simple
+------------
+
+If you need to dynamically create a message or just want a oneliner to publish a message, Broadcast::Message::Simple is your friend!
+
+```ruby
+  Broadcast::Message::Simple.new(:body => 'Poke!').publish(:jabber)
+```
+
+Broadcast::Message::Simple accepts the following keys in the arguments hash
+
+* body
+* subject
+
+Broadcast::Message::Simple#publish accepts the name of the medium and optional override settings for that medium
+
 Delayed::Job
 ------------
 

data/lib/broadcast.rb

@@ -30,5 +30,7 @@ class Broadcast
 
 end
 
+require 'broadcast/publishable'
 require 'broadcast/medium'
 require 'broadcast/message'
+

data/lib/broadcast/message.rb

@@ -1,33 +1,12 @@
 class Broadcast::Message
+  autoload "Simple", "broadcast/simple"
+  include Broadcast::Publishable
 
+  # Make the options Hashie::Mash a specific trait of Broadcast::Message
   attr_accessor :options
-  class << self
-    attr_accessor :media
-    def medium(name, options = {})
-      self.media ||= []
-      self.media.push({ :name => name, :options => options })
-    end
-  end
 
   def initialize(options = {})
     @options = Hashie::Mash.new(options)
   end
 
-  def publish
-    (self.class.media || []).each do |medium|
-      begin
-        Broadcast::Medium.const_get(medium[:name].to_s.downcase.capitalize).new(medium[:options]).publish(self)
-      rescue
-        Broadcast.logger.error "Publishing of #{self.class.name} to #{medium[:name]} failed:\n#{$!}"
-      end
-    end
-  end
-
-  def subject
-  end
-
-  def body
-    ""
-  end
-
 end

data/lib/broadcast/publishable.rb

@@ -0,0 +1,35 @@
+# Module which allows any class to be turned into a message
+module Broadcast::Publishable
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    attr_accessor :media
+
+    def medium(name, options = {})
+      (self.media ||= []).push({ :name => name, :options => options })
+    end
+
+  end
+
+  def publish
+    (self.class.media || []).each do |medium|
+      begin
+        Broadcast::Medium.const_get(medium[:name].to_s.downcase.capitalize).new(medium[:options]).publish(self)
+      rescue
+        Broadcast.logger.error "Publishing of #{self.class.name} to #{medium[:name]} failed:\n#{$!}"
+      end
+    end
+  end
+
+  def subject
+  end
+
+  def body
+    ""
+  end
+
+end

data/lib/broadcast/simple.rb

@@ -0,0 +1,21 @@
+class Broadcast::Message::Simple < Broadcast::Message
+
+  attr_accessor :body, :subject
+
+  def body
+    @body || options.body
+  end
+
+  def subject
+    @subject || options.subject
+  end
+
+  def publish(medium, medium_arguments = {})
+    begin
+      Broadcast::Medium.const_get(medium.to_s.downcase.capitalize).new(medium_arguments).publish(self)
+    rescue
+      Broadcast.logger.error "Publishing of #{self.class.name} to #{medium} failed:\n#{$!}"
+    end
+  end
+
+end

data/lib/broadcast/version.rb

@@ -1,5 +1,5 @@
 class Broadcast
 
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 
 end

data/spec/lib/broadcast/publishable_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+class ClassToBecomeMessage
+  include Broadcast::Publishable
+
+  attr_accessor :something
+
+  def initialize(somthng = nil)
+    self.something = somthng
+  end
+
+end
+
+describe Broadcast::Publishable do
+
+  describe "in class scope" do
+
+    it "should add the media accessor" do
+      ClassToBecomeMessage.should respond_to(:media)
+      ClassToBecomeMessage.should respond_to(:media=)
+    end
+
+    it "should add the medium method" do
+      ClassToBecomeMessage.should respond_to(:medium)
+    end
+
+  end
+
+  describe "in instance scope" do
+
+    before {
+      @instance = ClassToBecomeMessage.new(123)
+    }
+    it "should add the publish method" do
+      @instance.should respond_to(:publish)
+    end
+
+    it "should add the subject method" do
+      @instance.should respond_to(:subject)
+    end
+
+    it "should add the body method" do
+      @instance.should respond_to(:body)
+    end
+
+    it "should not add the options accessor" do
+      @instance.should_not respond_to(:options)
+      @instance.should_not respond_to(:options=)
+    end
+
+    it "should not mess with the initializer" do
+      ClassToBecomeMessage.new(123).something.should == 123
+    end
+
+  end
+
+end

data/spec/lib/broadcast/simple_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Broadcast::Message::Simple do
+
+  before do
+    @message = Broadcast::Message::Simple.new(:body => 'my body', :subject => 'OMG!')
+  end
+
+  describe ".initialize" do
+
+    it "should accept options" do
+      Broadcast::Message::Simple.new(:body => 'my body', :subject => 'OMG!')
+    end
+
+  end
+
+  describe "#body and #subject accessors" do
+
+    describe "#body" do
+
+      it "should be the value sent to the initializer" do
+        @message.body.should == 'my body'
+      end
+
+    end
+
+    describe "#body=" do
+
+      it "should allow changing the value of body dynamically" do
+        @message.body = 'updated body'
+        @message.body.should == 'updated body'
+      end
+
+    end
+
+    describe "#subject" do
+
+      it "should be the value sent to the initializer" do
+        @message.subject.should == 'OMG!'
+      end
+
+    end
+
+    describe "#subject=" do
+
+      it "should be the value sent to the initializer" do
+        @message.subject = 'LOL'
+        @message.subject.should == 'LOL'
+      end
+
+    end
+
+  end
+
+  describe '#publish' do
+
+    it "should explode when no media is supplied" do
+      lambda {
+        @message.publish
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should publish to the media passed as first argument" do
+      mocked = mock
+      mocked.should_receive(:publish).with(@message)
+      Broadcast::Medium::Log.should_receive(:new).and_return(mocked)
+      @message.publish :log
+    end
+
+    it "should override media settings if provided as second argument" do
+      mocked = mock
+      mocked.should_receive(:publish).with(@message)
+      Broadcast::Medium::Log.should_receive(:new).with(:file => 'different.log').and_return(mocked)
+      @message.publish :log, :file => 'different.log'
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: broadcast
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marcin Bunsch
@@ -163,7 +163,9 @@ files:
 - lib/broadcast/media/yammer.rb
 - lib/broadcast/medium.rb
 - lib/broadcast/message.rb
+- lib/broadcast/publishable.rb
 - lib/broadcast/railtie.rb
+- lib/broadcast/simple.rb
 - lib/broadcast/tasks/broadcast.rake
 - lib/broadcast/version.rb
 - spec/lib/broadcast/media/campfire_spec.rb
@@ -179,6 +181,8 @@ files:
 - spec/lib/broadcast/media/yammer_spec.rb
 - spec/lib/broadcast/medium_spec.rb
 - spec/lib/broadcast/message_spec.rb
+- spec/lib/broadcast/publishable_spec.rb
+- spec/lib/broadcast/simple_spec.rb
 - spec/lib/broadcast_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
@@ -231,6 +235,8 @@ test_files:
 - spec/lib/broadcast/media/yammer_spec.rb
 - spec/lib/broadcast/medium_spec.rb
 - spec/lib/broadcast/message_spec.rb
+- spec/lib/broadcast/publishable_spec.rb
+- spec/lib/broadcast/simple_spec.rb
 - spec/lib/broadcast_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb