taweili-facebooker 1.0.47 → 1.0.50

data/Rakefile

@@ -23,26 +23,30 @@ HOE = Hoe.spec('facebooker') do
   self.readme_file   = 'README.rdoc'
   self.history_file  = 'CHANGELOG.rdoc'
   self.remote_rdoc_dir = '' # Release to root
-  self.test_globs = 'test/**/*_test.rb'
+  self.test_globs = ['test/**/*_test.rb']
   extra_deps << ['json', '>= 1.0.0']
   self.extra_rdoc_files  = FileList['*.rdoc']
 end
 
-require 'rcov/rcovtask'
+begin
+  require 'rcov/rcovtask'
 
-namespace :test do
-  namespace :coverage do
-    desc "Delete aggregate coverage data."
-    task(:clean) { rm_f "coverage.data" }
-  end
-  desc 'Aggregate code coverage for unit, functional and integration tests'
-  Rcov::RcovTask.new(:coverage) do |t|
-    t.libs << "test"
-    t.test_files = FileList["test/**/*_test.rb"]
-    t.output_dir = "coverage/"
-    t.verbose = true
-    t.rcov_opts = ['--exclude', 'test,/usr/lib/ruby,/Library/Ruby,/System/Library', '--sort', 'coverage']
+  namespace :test do
+    namespace :coverage do
+      desc "Delete aggregate coverage data."
+      task(:clean) { rm_f "coverage.data" }
+    end
+    desc 'Aggregate code coverage for unit, functional and integration tests'
+    Rcov::RcovTask.new(:coverage) do |t|
+      t.libs << "test"
+      t.test_files = FileList["test/**/*_test.rb"]
+      t.output_dir = "coverage/"
+      t.verbose = true
+      t.rcov_opts = ['--exclude', 'test,/usr/lib/ruby,/Library/Ruby,/System/Library', '--sort', 'coverage']
+    end
   end
+rescue LoadError
+  $stderr.puts "Install the rcov gem to enable test coverage analysis"
 end
 
 namespace :gem do

data/facebooker.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{facebooker}
-  s.version = "1.0.47"
+  s.version = "1.0.50"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Fowler", "Patrick Ewing", "Mike Mangino", "Shane Vitarana", "Corey Innis", "Mike Mangino"]
-  s.date = %q{2009-08-14}
+  s.date = %q{2009-09-08}
   s.description = %q{Facebooker is a Ruby wrapper over the Facebook[http://facebook.com] {REST API}[http://wiki.developers.facebook.com/index.php/API].  Its goals are:
 
 * Idiomatic Ruby

data/lib/facebooker.rb

@@ -164,7 +164,7 @@ module Facebooker
       @timeout
     end
 
-    [:api_key,:secret_key, :www_server_base_url,:login_url_base,:install_url_base,:api_rest_path,:api_server_base,:api_server_base_url,:canvas_server_base, :video_server_base].each do |delegated_method|
+    [:api_key,:secret_key, :www_server_base_url,:login_url_base,:install_url_base,:permission_url_base,:connect_permission_url_base,:api_rest_path,:api_server_base,:api_server_base_url,:canvas_server_base, :video_server_base].each do |delegated_method|
       define_method(delegated_method){ return current_adapter.send(delegated_method)}
     end
 

data/lib/facebooker/adapters/facebook_adapter.rb

@@ -44,6 +44,14 @@ module Facebooker
     def install_url_base
       "http://#{www_server_base_url}/install.php?api_key=#{api_key}&v=1.0"
     end
+
+    def connect_permission_url_base
+      "http://#{www_server_base_url}/connect/prompt_permissions.php?api_key=#{api_key}&v=1.0"      
+    end
+
+    def permission_url_base
+      "http://#{www_server_base_url}/authorize.php?api_key=#{api_key}&v=1.0"
+    end
     
   end
   

data/lib/facebooker/models/group.rb

@@ -8,7 +8,7 @@ module Facebooker
       attr_accessor :position, :gid, :uid
     end
     include Model
-    attr_accessor :pic, :pic_small, :pic_big, :name, :creator, :recent_news, :update_time, :group_subtype, :group_type, :website, :office, :description, :venue, :nid
+    attr_accessor :pic, :pic_small, :pic_big, :name, :creator, :recent_news, :update_time, :group_subtype, :group_type, :website, :office, :description, :venue, :nid, :privacy
 
     id_is :gid
 

data/lib/facebooker/models/user.rb

@@ -11,7 +11,7 @@ module Facebooker
       attr_accessor :message, :time, :status_id
     end
     FIELDS = [:status, :political, :pic_small, :name, :quotes, :is_app_user, :tv, :profile_update_time, :meeting_sex, :hs_info, :timezone, :relationship_status, :hometown_location, :about_me, :wall_count, :significant_other_id, :pic_big, :music, :work_history, :sex, :religion, :notes_count, :activities, :pic_square, :movies, :has_added_app, :education_history, :birthday, :birthday_date, :first_name, :meeting_for, :last_name, :interests, :current_location, :pic, :books, :affiliations, :locale, :profile_url, :proxied_email, :email_hashes, :allowed_restrictions, :pic_with_logo, :pic_big_with_logo, :pic_small_with_logo, :pic_square_with_logo]
-    STANDARD_FIELDS = [:uid, :first_name, :last_name, :name, :timezone, :birthday, :sex, :affiliations, :locale, :profile_url, :pic_square]
+    STANDARD_FIELDS = [:uid, :first_name, :last_name, :name, :timezone, :birthday, :sex, :affiliations, :locale, :profile_url, :proxied_email]
     populating_attr_accessor(*FIELDS)
     attr_reader :affiliations
     populating_hash_settable_accessor :current_location, Location
@@ -63,7 +63,17 @@ module Facebooker
       @events[params.to_s] ||= @session.post('facebook.events.get', {:uid => self.id}.merge(params)).map do |event|
         Event.from_hash(event)
       end
-    end    
+    end
+
+    # Rsvp to an event with the eid and rsvp_status which can be 'attending', 'unsure', or 'declined'.
+    # http://wiki.developers.facebook.com/index.php/Events.rsvp
+    # E.g:
+    #  @user.rsvp_event('100321123', 'attending')
+    #  # => Returns true if all went well
+    def rsvp_event(eid, rsvp_status, options = {})
+      result = @session.post('facebook.events.rsvp', options.merge(:eid => eid, :rsvp_status => rsvp_status))
+      result == '1' ? true : false
+    end
     
     # 
     # Set the list of friends, given an array of User objects.  If the list has been retrieved previously, will not set
@@ -127,21 +137,25 @@ module Facebooker
     #     :text => 'my website',
     #     :href => 'http://tenderlovemaking.com/'
     #   ])
-    def publish_to target, options = {}
-      
-      attachment = options[:attachment]
-      links = options[:action_links]
-      @session.post('facebook.stream.publish',
-                    { :uid        => self.id,
-                      :target_id  => target.id,
-                      :message    => options[:message],
-                      :attachment => attachment && Facebooker.json_encode(attachment),
-                      :action_links => links && Facebooker.json_encode(links) }, 
-                    false
-                   )
+    def publish_to(target, options = {})
+      @session.post('facebook.stream.publish', prepare_publish_to_options(target, options), false)
+    end
+   
+    # Prepares options for the stream.publish
+    def prepare_publish_to_options(target, options)
+      opts = {:uid          => self.id,
+              :target_id    => target.id,
+              :message      => options[:message]} 
+
+      if(attachment = options[:attachment] && Facebooker.json_encode(options[:attachment]))
+        opts[:attachment] = attachment
+      end
+      if (links = options[:action_links] && Facebooker.json_encode(options[:action_links]))
+        opts[:action_links] = links
+      end
+      opts
     end
     
-    
     ###
     # Publish a comment on a post
     #

data/lib/facebooker/parser.rb

@@ -211,12 +211,12 @@ module Facebooker
       element('stream_publish_response', data).content.strip
     end
   end
-  
+
   class StreamAddComment < Parser#:nodoc:
     def self.process(data)
       element('stream_addComment_response', data).content.strip
     end
-  end  
+  end
 
   class RegisterTemplateBundle < Parser#:nodoc:
     def self.process(data)
@@ -461,12 +461,18 @@ module Facebooker
     end
   end
 
+  class EventsRsvp < Parser#:nodoc:
+     def self.process(data)
+       element('events_rsvp_response', data).content.strip
+     end
+   end
+
   class EventsRsvp < Parser#:nodoc:
     def self.process(data)
       element('events_rsvp_response', data).text_value
     end
   end
-  
+
   class EventsGet < Parser#:nodoc:
     def self.process(data)
       array_of_hashes(element('events_get_response', data), 'event')
@@ -563,10 +569,10 @@ module Facebooker
 
   class Errors < Parser#:nodoc:
     EXCEPTIONS = {
-      1 	=> Facebooker::Session::UnknownError,
-      2 	=> Facebooker::Session::ServiceUnavailable,
-      4 	=> Facebooker::Session::MaxRequestsDepleted,
-      5 	=> Facebooker::Session::HostNotAllowed,
+      1   => Facebooker::Session::UnknownError,
+      2   => Facebooker::Session::ServiceUnavailable,
+      4   => Facebooker::Session::MaxRequestsDepleted,
+      5   => Facebooker::Session::HostNotAllowed,
       100 => Facebooker::Session::MissingOrInvalidParameter,
       101 => Facebooker::Session::InvalidAPIKey,
       102 => Facebooker::Session::SessionExpired,
@@ -667,8 +673,10 @@ module Facebooker
       'facebook.photos.addTag' => AddTags,
       'facebook.photos.upload' => UploadPhoto,
       'facebook.stream.publish' => StreamPublish,
-      'facebook.stream.addComment' => StreamAddComment,      
+      'facebook.stream.addComment' => StreamAddComment,
       'facebook.events.get' => EventsGet,
+      'facebook.events.rsvp' => EventsRsvp,
+      'facebook.groups.get' => GroupsGet,
       'facebook.events.getMembers' => EventMembersGet,
       'facebook.events.rsvp' => EventsRsvp,
       'facebook.groups.get' => GroupsGet,

data/lib/facebooker/rails/helpers.rb

@@ -451,10 +451,10 @@ module Facebooker
       def facebook_messages
         message=""
         unless flash[:notice].blank?
-          message += fb_success(flash[:notice])
+          message += fb_success(*flash[:notice])
         end
         unless flash[:error].blank?
-          message += fb_error(flash[:error])
+          message += fb_error(*flash[:error])
         end
         message
       end

data/lib/facebooker/rails/helpers/fb_connect.rb

@@ -33,9 +33,9 @@ module Facebooker
           end
 
           if request.ssl?
-            init_string = "FB.Facebook.init('#{Facebooker.api_key}','/xd_receiver_ssl.html', #{options[:app_settings]});"
+            init_string = "FB.init('#{Facebooker.api_key}','/xd_receiver_ssl.html', #{options[:app_settings]});"
           else
-            init_string = "FB.Facebook.init('#{Facebooker.api_key}','/xd_receiver.html', #{options[:app_settings]});"
+            init_string = "FB.init('#{Facebooker.api_key}','/xd_receiver.html', #{options[:app_settings]});"
           end
           unless required_features.blank?
              init_string = <<-FBML

data/lib/facebooker/rails/publisher.rb

@@ -4,7 +4,7 @@ module Facebooker
     # 
     # To use, create a subclass and define methods
     # Each method should start by calling send_as to specify the type of message
-    # Valid options are  :email and :notification, :user_action, :profile, :ref
+    # Valid options are  :email and :notification, :user_action, :profile, :ref, :publish_stream
     # 
     #
     # Below is an example of each type
@@ -78,6 +78,16 @@ module Facebooker
     #       handle "a_ref_handle"
     #   end
     #
+    #     #  Publish a post into the stream on the user's Wall and News Feed.
+    #     def publish_stream(user_with_session_to_use, user_to_update, params)
+    #       send_as :publish_stream
+    #       from  user_with_session_to_use
+    #       target user_to_update
+    #       attachment params[:attachment]
+    #       message params[:message]
+    #       action_links params[:action_links]
+    #     end
+    #
     #
     # To send a message, use ActionMailer like semantics
     #    TestPublisher.deliver_action(@user)
@@ -254,6 +264,13 @@ module Facebooker
         end
       end
 
+      class PublishStream
+        attr_accessor :target
+        attr_accessor :attachment
+        attr_accessor :action_links
+        attr_accessor :message
+      end
+
       cattr_accessor :ignore_errors
       attr_accessor :_body
 
@@ -292,6 +309,8 @@ module Facebooker
           Ref.new
         when :user_action
           UserAction.new
+        when :publish_stream
+          PublishStream.new
         else
           raise UnknownBodyType.new("Unknown type to publish")
         end
@@ -403,6 +422,8 @@ module Facebooker
           Facebooker::Session.create.server_cache.set_ref_handle(_body.handle,_body.fbml)
         when UserAction
           @from.session.publish_user_action(_body.template_id,_body.data_hash,_body.target_ids,_body.body_general,_body.story_size)
+        when PublishStream
+         @from.publish_to(_body.target, {:attachment => _body.attachment, :action_links => @action_links, :message => _body.message })
         else
           raise UnspecifiedBodyType.new("You must specify a valid send_as")
         end
@@ -493,6 +514,15 @@ module Facebooker
           end
         end
         
+        def unregister_inactive_templates
+          session = Facebooker::Session.create
+          active_template_ids = FacebookTemplate.all.map(&:bundle_id)
+          all_template_ids = session.active_template_bundles.map {|t| t["template_bundle_id"]}
+          (all_template_ids - active_template_ids).each do |template_bundle_id|
+            session.deactivate_template_bundle_by_id(template_bundle_id)
+          end
+        end
+        
         def method_missing(name,*args)
           should_send = false
           method = ''
@@ -526,7 +556,7 @@ module Facebooker
           args.each do |arg|
             case arg
             when Symbol,String
-              add_template_helper("#{arg.to_s.classify}Helper".constantize)
+              add_template_helper("#{arg.to_s.camelcase}Helper".constantize)
             when Module
               add_template_helper(arg)
             end

data/lib/facebooker/session.rb

@@ -122,7 +122,16 @@ module Facebooker
     # * sms
     def permission_url(permission,options={})
       options = default_login_url_options.merge(options)
-      "http://#{Facebooker.www_server_base_url}/authorize.php?api_key=#{@api_key}&v=1.0&ext_perm=#{permission}#{install_url_optional_parameters(options)}"
+      options = add_next_parameters(options)
+      options << "&ext_perm=#{permission}"
+      "#{Facebooker.permission_url_base}#{options.join}"
+    end
+
+    def connect_permission_url(permission,options={})
+      options = default_login_url_options.merge(options)
+      options = add_next_parameters(options)
+      options << "&ext_perm=#{permission}"
+      "#{Facebooker.connect_permission_url_base}#{options.join}"
     end
 
     def install_url_optional_parameters(options)
@@ -145,6 +154,8 @@ module Facebooker
       optional_parameters << "&skipcookie=true" if options[:skip_cookie]
       optional_parameters << "&hide_checkbox=true" if options[:hide_checkbox]
       optional_parameters << "&canvas=true" if options[:canvas]
+      optional_parameters << "&fbconnect=true" if options[:fbconnect]
+      optional_parameters << "&req_perms=#{options[:req_perms]}" if options[:req_perms]
       optional_parameters.join
     end
 
@@ -269,6 +280,23 @@ module Facebooker
       end
     end
 
+    # Creates an event with the event_info hash and an optional Net::HTTP::MultipartPostFile for the event picture
+    # Returns the eid of the newly created event
+    # http://wiki.developers.facebook.com/index.php/Events.create
+    def create_event(event_info, multipart_post_file = nil)
+      post_file('facebook.events.create', :event_info => event_info.to_json, nil => multipart_post_file)
+    end
+    
+    # Cancel an event
+    # http://wiki.developers.facebook.com/index.php/Events.cancel
+    # E.g:
+    #  @session.cancel_event('100321123', :cancel_message => "It's raining...")
+    #  # => Returns true if all went well
+    def cancel_event(eid, options = {})
+      result = post('facebook.events.cancel', options.merge(:eid => eid))
+      result == '1' ? true : false
+    end
+
     def event_members(eid)
       @members = post('facebook.events.getMembers', :eid => eid) do |response|
         response.map do |attendee_hash|
@@ -347,7 +375,9 @@ module Facebooker
       if [subj_id, pids, aid].all? {|arg| arg.nil?}
         raise ArgumentError, "Can't get a photo without a picture, album or subject ID" 
       end
-      @photos = post('facebook.photos.get', :subj_id => subj_id, :pids => pids, :aid => aid ) do |response|
+      # We have to normalize params orherwise FB complain about signature
+      params = {:pids => pids, :subj_id => subj_id, :aid => aid}.delete_if { |k,v| v.nil? }
+      @photos = post('facebook.photos.get', params ) do |response|
         response.map do |hash|
           Photo.from_hash(hash)
         end
@@ -422,6 +452,10 @@ module Facebooker
       post("facebook.feed.deactivateTemplateBundleByID", {:template_bundle_id => template_bundle_id.to_s}, false)
     end
 
+    def active_template_bundles
+      post("facebook.feed.getRegisteredTemplateBundles",{},false)
+    end
+
     ##
     # publish a previously rendered template bundle
     # see http://wiki.developers.facebook.com/index.php/Feed.publishUserAction

data/lib/facebooker/version.rb

@@ -2,7 +2,7 @@ module Facebooker #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 47
+    TINY  = 50
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/facebooker/models/user_test.rb

@@ -130,6 +130,14 @@ class Facebooker::UserTest < Test::Unit::TestCase
     assert_equal "2357384227378429949", photos.first.aid
   end
 
+  def test_prepare_publish_to_options_pass_only_neccessary_parameters
+    options = @user.prepare_publish_to_options(@user, {:message => 'Hey there', :action_links => [:text => 'Link', :href => 'http://example.com']})
+    assert_equal(options[:uid], @user.uid)
+    assert_equal(options[:target_id], @user.id)
+    assert_equal(options[:message], 'Hey there')
+    assert_nil(options[:attachment])
+    assert_equal(options[:action_links], [:text => 'Link', :href => 'http://example.com'].to_json )
+  end
   def test_publish_to
     @user = Facebooker::User.new(548871286, @session)
     expect_http_posts_with_responses(example_profile_publish_to_get_xml)
@@ -254,6 +262,12 @@ class Facebooker::UserTest < Test::Unit::TestCase
     assert_equal "http://www.facebook.com/profile.php?id=8055", @user.profile_url
   end
 
+  def test_can_rsvp_to_event
+    expect_http_posts_with_responses(example_events_rsvp_xml)
+    result = @user.rsvp_event(1000, 'attending')
+    assert result
+  end
+
   private
   def example_profile_photos_get_xml
     "<?xml version=\"1.0\" encoding=\"UTF-8\"?>
@@ -363,4 +377,13 @@ class Facebooker::UserTest < Test::Unit::TestCase
 <stream_addComment_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd">703826862_78463536863</stream_addComment_response>
     eoxml
   end  
+  
+  def example_events_rsvp_xml
+      <<-E
+      <?xml version="1.0" encoding="UTF-8"?>
+      <events_rsvp_response xmlns="http://api.facebook.com/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+          xsi:schemaLocation="http://api.facebook.com/1.0/ http://api.facebook.com/1.0/facebook.xsd">1
+      </events_rsvp_response>
+    E
+  end
 end

data/test/facebooker/rails/publisher_test.rb

@@ -137,6 +137,23 @@ class TestPublisher < Facebooker::Rails::Publisher
     recipients to
   end
 
+  def publish_post_to_own_stream(user)
+    send_as :publish_stream
+    from  user
+    target user
+    attachment({:name => "Facebooker", :href => "http://www.exampple.com"})
+    message "Posting post to own stream"
+    action_links([{:text => "Action Link", :href => "http://www.example.com/action_link"}])
+  end
+
+  def publish_post_to_friends_stream(from, to)
+    send_as :publish_stream
+    from  from
+    target to
+    attachment({:name => "Facebooker", :href => "http://www.exampple.com"})
+    message "Posting post to friends stream"
+    action_links([{:text => "Action Link", :href => "http://www.example.com/action_link"}])
+  end
 end
 
 class Facebooker::Rails::Publisher::FacebookTemplateTest < Test::Unit::TestCase
@@ -413,6 +430,20 @@ class Facebooker::Rails::Publisher::PublisherTest < Test::Unit::TestCase
     }
   end
 
+  def test_publish_post_to_own_stream
+    @user = Facebooker::User.new
+    @user.expects(:publish_to).with(@user, has_entry(:attachment=>instance_of(Hash)))
+
+    TestPublisher.deliver_publish_post_to_own_stream(@user)
+  end
+
+  def test_publish_post_to_friends_stream
+    @from_user = Facebooker::User.new
+    @to_user = Facebooker::User.new
+    @from_user.expects(:publish_to).with(@to_user, has_entry(:action_links=>instance_of(Array)))
+
+    TestPublisher.deliver_publish_post_to_friends_stream(@from_user, @to_user)
+  end
 
   def test_keeps_class_method_missing
     assert_raises(NoMethodError) {

data/test/facebooker/session_test.rb

@@ -22,6 +22,33 @@ class Facebooker::SessionTest < Test::Unit::TestCase
     assert_equal("http://www.facebook.com/install.php?api_key=1234567&v=1.0&next=next_url%3Fa%3D1%26b%3D2", session.install_url(:next => "next_url?a=1&b=2"))
   end
 
+  def test_permission_url_returns_correct_url_and_parameters
+    fb_url = "http://www.facebook.com/connect/prompt_permissions.php?api_key=#{ENV['FACEBOOK_API_KEY']}&v=1.0&next=next_url&ext_perm=publish_stream,email"
+    url = Facebooker::Session.new(ENV['FACEBOOK_API_KEY'], ENV['FACEBOOK_SECRET_KEY']).connect_permission_url('publish_stream,email', {:next => 'next_url'})
+    assert_equal url, fb_url
+  end
+
+  def test_login_url_skips_all_parameters_when_not_passed_or_false
+    session = Facebooker::Session.new(ENV['FACEBOOK_API_KEY'], ENV['FACEBOOK_SECRET_KEY'])
+    url = session.login_url({:fbconnect => false})
+    expected_url = Facebooker.login_url_base
+    assert_equal url, expected_url
+  end
+
+  def test_login_url_adds_all_parameters_when_passed
+    login_options = {:skipcookie => true,
+                     :hide_checkbox => true,
+                     :canvas => true,
+                     :fbconnect => true,
+                     :req_perms => 'publish_stream',
+                     :next => 'http://example.com'}
+
+    session = Facebooker::Session.new(ENV['FACEBOOK_API_KEY'], ENV['FACEBOOK_SECRET_KEY'])
+    url = session.login_url(login_options)
+    expected_url = "#{Facebooker.login_url_base}&next=#{CGI.escape(login_options[:next])}&hide_checkbox=true&canvas=true&fbconnect=true&req_perms=publish_stream"
+    assert_equal url, expected_url
+  end
+
   def test_can_get_api_and_secret_key_from_environment
     assert_equal('1234567', Facebooker::Session.api_key)
     assert_equal('7654321', Facebooker::Session.secret_key)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: taweili-facebooker
 version: !ruby/object:Gem::Version 
-  version: 1.0.47
+  version: 1.0.50
 platform: ruby
 authors: 
 - Chad Fowler
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-14 00:00:00 -07:00
+date: 2009-09-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency