broadcast 0.1.0 → 0.2.0

data/.gitignore

@@ -6,4 +6,5 @@ sandbox
 *.log
 coverage
 bin
-.rspec
+.rspec
+facebook_test/config.yml

data/.travis.yml

@@ -0,0 +1,7 @@
+script: "bundle exec rspec spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - jruby
+  - rbx

data/Gemfile

@@ -3,14 +3,16 @@ source "http://rubygems.org"
 gemspec
 
 group :development, :test do
+  gem 'rake', '0.8.7'
   gem 'rspec'
-  gem 'rcov'
 
   platforms :mri_18 do
+    gem 'rcov'
     gem "ruby-debug"
   end
 
   platforms :mri_19 do
+    gem 'rcov'
     gem "ruby-debug19"
   end
 end

data/README.markdown

@@ -1,8 +1,10 @@
-Broadcast
+Broadcast [![Build Status](http://travis-ci.org/futuresimple/broadcast.png)](http://travis-ci.org/futuresimple/broadcast)
 =========
 
 A broadcasting microframework making publishing of messages to different services easy and DRY.
 
+
+
 Use Cases
 ------------
 
@@ -17,11 +19,13 @@ Possible use cases include:
 Installation
 ------------
 
-Broadcast is in alpha state, so it's not pushed to RubyGems yet.
+You can install broadcast via Rubygems by typing:
 
-You can install it by adding the following line to your Gemfile:
+    gem install broadcast
 
-    gem 'broadcast', :git => 'git://github.com/futuresimple/broadcast.git'
+It you use bundler, you can install it by adding the following line to your Gemfile:
+
+    gem 'broadcast'
 
 and running
 
@@ -206,6 +210,22 @@ Broadcast::Medium::Irc employs the shout-bot gem.
   end
 ```
 
+### Facebook
+
+Broadcast::Medium::Facebook uses the koala gem. It is designed to publish messages to Facebook pages.
+It is based on the assumption that the user associated with the access token has publishing access to the page.
+
+#### Example setup
+
+```ruby
+  Broadcast.setup do |config|
+    config.facebook { |facebook|
+      facebook.token = 'facebook_access_token',
+      facebook.page  = 'Name of the page to publish to'
+    }
+  end
+```
+
 Copyright
 ---------
 

data/Rakefile

@@ -17,7 +17,16 @@ begin
     t.verbose = false
   end
 
+  task :default => [:spec]
+
+rescue
+  puts 'Could not load Broadcast RSpec Rake tasks'
+end
+
+begin
+
   namespace :spec do
+
     task :cleanup do
       rm_rf 'coverage.data'
     end
@@ -30,6 +39,6 @@ begin
 
   end
 
-rescue 
-  puts 'Could not load Broadcast RSpec Rake tasks'
-end
+rescue
+  puts 'Could not load Broadcast RSpec Rcov Rake tasks'
+end

data/broadcast.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "broadcast"
   s.version     = Broadcast::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Marcin Bunsch"]
+  s.authors     = ["Marcin Bunsch", "Antek Piechnik"]
   s.email       = ["marcin@futuresimple.com"]
   s.homepage    = "http://github.com/futuresimple/broadcast"
   s.summary     = %q{A broadcasting microframework making publishing of messages to different services easy}
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'mail'
   s.add_dependency 'broach'
   s.add_dependency 'shout-bot'
+  s.add_dependency 'koala'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/broadcast/media/facebook.rb

@@ -0,0 +1,25 @@
+require 'koala'
+
+class Broadcast::Medium::Facebook < Broadcast::Medium::Oauth
+
+  def publish(message)
+    # We do not rescue any Koala exceptions to make them crash the sendout
+    # This should make debugging easier i.e. when fb has privilege issues
+
+    # Connect to facebook and get info about current user
+    graph       = Koala::Facebook::GraphAPI.new(options.token)
+    me          = graph.get_object('me')
+    # Get the connections to retrieve the appropriate page
+    connections = graph.get_connections(me['id'], 'accounts')
+    raise "No pages available" if connections.size == 0
+
+    # Find the page to post to
+    page        = connections.find { |connection| connection['name'] == options.page }
+    raise 'Page not found' if !page
+
+    # Create a new graph so that the page posts to itself
+    page_graph = Koala::Facebook::GraphAPI.new(page['access_token'])
+    page_graph.put_wall_post(message.body)
+  end
+
+end

data/lib/broadcast/version.rb

@@ -1,5 +1,5 @@
 class Broadcast
 
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 
 end

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

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Broadcast::Medium::Facebook do
+
+  describe '.new' do
+
+    it "should create a new instance with options provided in config" do
+      medium  = Broadcast::Medium::Facebook.new
+      medium.options.token.should == 'fb_token'
+      medium.options.page.should == 'My Page'
+    end
+
+    it "should prioritize options argument over options provided in config" do
+      medium  = Broadcast::Medium::Facebook.new(:page => 'Different Page')
+      medium.options.token.should == 'fb_token'
+      medium.options.page.should == 'Different Page'
+    end
+
+  end
+
+  describe '#publish' do
+
+    before do
+      @medium  = Broadcast::Medium::Facebook.new
+      @message = Broadcast::Message::SpecWithChagingContent.new
+      @me = {"name"=>"Your Name", "username"=>"yourname", "timezone"=>0, "gender"=>"male", "id"=>"1", "last_name"=>"Name", "updated_time"=>"2011-06-01T17:29:02+0000", "verified"=>true, "locale"=>"en_US", "hometown"=>{"name"=>"Palo Alto", "id"=>"1"}, "link"=>"http://www.facebook.com/yourname", "first_name"=>"Your"}
+      @connections = [{"name"=>"My Page", "category"=>"Software", "id"=>"123", "access_token"=>"page_access_token"}]
+    end
+
+    it "should send the message to a Facebook page" do
+      mock_graph = mock
+      mock_page_graph = mock
+      Koala::Facebook::GraphAPI.should_receive(:new).with('fb_token').and_return(mock_graph)
+      Koala::Facebook::GraphAPI.should_receive(:new).with('page_access_token').and_return(mock_page_graph)
+      mock_graph.should_receive(:get_object).with('me').and_return(@me)
+      mock_graph.should_receive(:get_connections).with('1', 'accounts').and_return(@connections)
+
+      mock_page_graph.should_receive(:put_wall_post).with(@message.body)
+      @medium.publish(@message)
+    end
+
+    it "should raise an error when no pages are available" do
+      mock_graph = mock
+      mock_page_graph = mock
+      Koala::Facebook::GraphAPI.should_receive(:new).with('fb_token').and_return(mock_graph)
+      mock_graph.should_receive(:get_object).with('me').and_return(@me)
+      mock_graph.should_receive(:get_connections).with('1', 'accounts').and_return([])
+
+      lambda { @medium.publish(@message) }.should raise_error('No pages available')
+    end
+
+    it "should raise an error when no page was not found" do
+      mock_graph = mock
+      mock_page_graph = mock
+      Koala::Facebook::GraphAPI.should_receive(:new).with('fb_token').and_return(mock_graph)
+      mock_graph.should_receive(:get_object).with('me').and_return(@me)
+
+      @connections.first['name'] = 'Different name'
+      mock_graph.should_receive(:get_connections).with('1', 'accounts').and_return(@connections)
+
+      lambda { @medium.publish(@message) }.should raise_error('Page not found')
+    end
+
+  end
+
+end

data/spec/support/config.rb

@@ -34,6 +34,11 @@ Broadcast.setup { |config|
     campfire.room      = 'My Room'
   }
 
+  config.facebook { |facebook|
+    facebook.token     = 'fb_token'
+    facebook.page      = 'My Page'
+  }
+
   config.irc { |irc|
     irc.username = 'foo'
     irc.server = 'irc.freenode.net'

data/spec/support/examples.rb

@@ -7,5 +7,12 @@ class Broadcast::Message::SpecWithContent < Broadcast::Message
   end
 end
 
+class Broadcast::Message::SpecWithChagingContent < Broadcast::Message
+  def body
+    "message | " + Time.now.to_s
+  end
+end
+
+
 class Broadcast::Medium::Spec < Broadcast::Medium
 end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: broadcast
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Marcin Bunsch
+- Antek Piechnik
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-05-29 00:00:00 Z
+date: 2011-06-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: hashie
@@ -101,6 +102,20 @@ dependencies:
         version: "0"
   prerelease: false
   requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: koala
+  type: :runtime
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id007
 description: A broadcasting microframework making publishing of messages to different services easy
 email: 
 - marcin@futuresimple.com
@@ -112,6 +127,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.markdown
@@ -121,6 +137,7 @@ files:
 - lib/broadcast/config.rb
 - lib/broadcast/media/campfire.rb
 - lib/broadcast/media/email.rb
+- lib/broadcast/media/facebook.rb
 - lib/broadcast/media/irc.rb
 - lib/broadcast/media/jabber.rb
 - lib/broadcast/media/log.rb
@@ -134,6 +151,7 @@ files:
 - lib/broadcast/version.rb
 - spec/lib/broadcast/media/campfire_spec.rb
 - spec/lib/broadcast/media/email_spec.rb
+- spec/lib/broadcast/media/facebook_spec.rb
 - spec/lib/broadcast/media/irc_spec.rb
 - spec/lib/broadcast/media/jabber_spec.rb
 - spec/lib/broadcast/media/log_spec.rb
@@ -182,6 +200,7 @@ summary: A broadcasting microframework making publishing of messages to differen
 test_files: 
 - spec/lib/broadcast/media/campfire_spec.rb
 - spec/lib/broadcast/media/email_spec.rb
+- spec/lib/broadcast/media/facebook_spec.rb
 - spec/lib/broadcast/media/irc_spec.rb
 - spec/lib/broadcast/media/jabber_spec.rb
 - spec/lib/broadcast/media/log_spec.rb