Class: Facebooker::Rails::Publisher

Inherits:
Object
  • Object
show all
Defined in:
lib/facebooker/rails/publisher.rb

Overview

ActionMailer like module for publishing Facbook messages

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

Below is an example of each type

class TestPublisher < Facebooker::Rails::Publisher
  # The new message templates are supported as well
  # First, create a method that contains your templates:
  # You may include multiple one line story templates and short story templates
  # but only one full story template
  #  Your most specific template should be first
  #
  # Before using, you must register your template by calling register. For this example
  #  You would call TestPublisher.register_publish_action
  #  Registering the template will store the template id returned from Facebook in the 
  # facebook_templates table that is created when you create your first publisher
  def publish_action_template
    one_line_story_template "{*actor*} did stuff with {*friend*}"
    one_line_story_template "{*actor*} did stuff"
    short_story_template "{*actor*} has a title {*friend*}", render(:partial=>"short_body")
    short_story_template "{*actor*} has a title", render(:partial=>"short_body")
    full_story_template "{*actor*} has a title {*friend*}", render(:partial=>"full_body")    
    action_links action_link("My text {*template_var*}","{*link_url*}")
  end

  # To send a registered template, you need to create a method to set the data
  # The publisher will look up the template id from the facebook_templates table
  def publish_action(f)
    send_as :user_action
    from f
    story_size SHORT # or ONE_LINE or FULL
    data :friend=>"Mike"
  end

  # Provide a from user to send a general notification
  # if from is nil, this will send an announcement
  def notification(to,f)
    send_as :notification
    recipients to
    from f
    fbml "Not"
  end

  def email(to,f)
    send_as :email
    recipients to
    from f
    title "Email"
    fbml 'text'
    text fbml
  end
  # This will render the profile in /users/profile.erb
  #   it will set @user to user_to_update in the template
  #  The mobile profile will be rendered from the app/views/test_publisher/_mobile.erb
  #   template
  def profile_update(user_to_update,user_with_session_to_use)
    send_as :profile
    from user_with_session_to_use
    to user_to_update
    profile render(:action=>"/users/profile",:assigns=>{:user=>user_to_update})
    profile_action "A string"
    mobile_profile render(:partial=>"mobile",:assigns=>{:user=>user_to_update})
end

  #  Update the given handle ref with the content from a
  #   template
  def ref_update(user)
    send_as :ref
    from user
    fbml render(:action=>"/users/profile",:assigns=>{:user=>user_to_update})
    handle "a_ref_handle"
end

To send a message, use ActionMailer like semantics

TestPublisher.deliver_action(@user)

For testing, you may want to create an instance of the underlying message without sending it

TestPublisher.create_action(@user)

will create and return an instance of Facebooker::Feeds::Action

Publisher makes many helpers available, including the linking and asset helpers

Defined Under Namespace

Classes: Email, FacebookTemplate, ImageHolder, InvalidSender, Notification, Profile, PublisherController, Ref, UnknownBodyType, UnspecifiedBodyType, UserAction

Constant Summary collapse

ONE_LINE =

story sizes from the Facebooker API

1
SHORT = 
2
FULL = 
4

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Publisher

Returns a new instance of Publisher.



97
98
99
 
# File 'lib/facebooker/rails/publisher.rb', line 97

def initialize
  @controller = PublisherController.new        
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object 



305
306
307
308
309
310
311
312
313
 
# File 'lib/facebooker/rails/publisher.rb', line 305

def method_missing(name,*args)
  if args.size==1 and self._body.respond_to?("#{name}=")
    self._body.send("#{name}=",*args)
  elsif self._body.respond_to?(name)
    self._body.send(name,*args)
  else
    super
  end
end

Instance Attribute Details

#_body ⇒ Object

Returns the value of attribute _body.



237
238
239
 
# File 'lib/facebooker/rails/publisher.rb', line 237

def _body
  @_body
end

#action_links(*links) ⇒ Object

Returns the value of attribute action_links.



191
192
193
 
# File 'lib/facebooker/rails/publisher.rb', line 191

def action_links
  @action_links
end

#one_line_story_templates ⇒ Object

Returns the value of attribute one_line_story_templates.



191
192
193
 
# File 'lib/facebooker/rails/publisher.rb', line 191

def one_line_story_templates
  @one_line_story_templates
end

#short_story_templates ⇒ Object

Returns the value of attribute short_story_templates.



191
192
193
 
# File 'lib/facebooker/rails/publisher.rb', line 191

def short_story_templates
  @short_story_templates
end

Class Method Details

.add_template_helper(helper_module) ⇒ Object

:nodoc:



499
500
501
502
 
# File 'lib/facebooker/rails/publisher.rb', line 499

def add_template_helper(helper_module) #:nodoc:
  master_helper_module.send :include,helper_module
  include master_helper_module
end

.controller_path ⇒ Object 



484
485
486
 
# File 'lib/facebooker/rails/publisher.rb', line 484

def controller_path
  self.to_s.underscore
end

.default_url_options ⇒ Object 



480
481
482
 
# File 'lib/facebooker/rails/publisher.rb', line 480

def default_url_options
  {:host => Facebooker.canvas_server_base + Facebooker.facebook_path_prefix}
end

.helper(*args) ⇒ Object 



488
489
490
491
492
493
494
495
496
497
 
# File 'lib/facebooker/rails/publisher.rb', line 488

def helper(*args)
  args.each do |arg|
    case arg
    when Symbol,String
      add_template_helper("#{arg.to_s.classify}Helper".constantize)              
    when Module
      add_template_helper(arg)
    end
  end
end

.inherited(child) ⇒ Object 



505
506
507
508
509
510
511
 
# File 'lib/facebooker/rails/publisher.rb', line 505

def inherited(child)
  super          
  child.master_helper_module=Module.new
  child.master_helper_module.__send__(:include,self.master_helper_module)
  child.send(:include, child.master_helper_module)
  FacebookTemplate.clear_cache!
end

.method_missing(name, *args) ⇒ Object 



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/facebooker/rails/publisher.rb', line 455

def method_missing(name,*args)
  should_send = false
  method = ''
  if md = /^create_(.*)$/.match(name.to_s)
    method = md[1]
  elsif md = /^deliver_(.*)$/.match(name.to_s)
    method = md[1]
    should_send = true            
  elsif md = /^register_(.*)$/.match(name.to_s)
    return FacebookTemplate.register(self, md[1])
  else
    super
  end
      
  #now create the item
  (publisher=new).send(method,*args)
  case publisher._body
  when UserAction
    publisher._body.template_name = method
    publisher._body.template_id = FacebookTemplate.bundle_id_for_class_and_method(self,method)
  end
  
  should_send ? publisher.send_message(method) : publisher._body
end

.register_all_templates ⇒ Object 



446
447
448
449
450
451
452
453
 
# File 'lib/facebooker/rails/publisher.rb', line 446

def register_all_templates
  all_templates = instance_methods.grep(/_template$/) - %w(short_story_template full_story_template one_line_story_template) 
  all_templates.each do |template|
    template_name=template.sub(/_template$/,"")
    puts "Registering #{template_name}"
    send("register_"+template_name)
  end
end

Instance Method Details



332
333
334
 
# File 'lib/facebooker/rails/publisher.rb', line 332

def action_link(text,target)
  {:text=>text, :href=>target}
end

#announcement_notification?(from, body) ⇒ Boolean

Returns:

  • (Boolean) 


348
349
350
 
# File 'lib/facebooker/rails/publisher.rb', line 348

def announcement_notification?(from,body)
  from.nil? and body.is_a?(Notification)
end

#from(*args) ⇒ Object 



247
248
249
250
251
252
253
 
# File 'lib/facebooker/rails/publisher.rb', line 247

def from(*args)
  if args.size==0
    @from
  else
    @from=args.first
  end        
end

#full_story_template(title = nil, body = nil, params = {}) ⇒ Object 



279
280
281
282
283
284
285
 
# File 'lib/facebooker/rails/publisher.rb', line 279

def full_story_template(title=nil,body=nil,params={})
  if title.nil?
    @full_story_template
  else
    @full_story_template=params.merge(:template_title=>title, :template_body=>body)
  end
end

#image(src, target) ⇒ Object 



328
329
330
 
# File 'lib/facebooker/rails/publisher.rb', line 328

def image(src,target)
  ImageHolder.new(image_path(src),target.respond_to?(:to_str) ? target : url_for(target))
end

#initialize_template_class(assigns) ⇒ Object 



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
 
# File 'lib/facebooker/rails/publisher.rb', line 401

def initialize_template_class(assigns)
  template_root = "#{RAILS_ROOT}/app/views"
 controller_root = File.join(template_root,self.class.controller_path)
  #only do this on Rails 2.1
 if ActionController::Base.respond_to?(:append_view_path)
   # only add the view path once
   ActionController::Base.append_view_path(controller_root) unless ActionController::Base.view_paths.include?(controller_root)
 end
  returning ActionView::Base.new([template_root,controller_root], assigns, self) do |template|
    template.controller=self
    template.extend(self.class.master_helper_module)
    def template.request_comes_from_facebook?
      true
    end
  end
end

#logger ⇒ Object

nodoc needed for actionview



388
389
390
 
# File 'lib/facebooker/rails/publisher.rb', line 388

def logger
  RAILS_DEFAULT_LOGGER
end

#one_line_story_template(str) ⇒ Object 



287
288
289
290
 
# File 'lib/facebooker/rails/publisher.rb', line 287

def one_line_story_template(str)
  @one_line_story_templates ||= []
  @one_line_story_templates << str
end

#profile_update?(body) ⇒ Boolean

Returns:

  • (Boolean) 


340
341
342
 
# File 'lib/facebooker/rails/publisher.rb', line 340

def profile_update?(body)
  body.is_a?(Profile)
end

#recipients(*args) ⇒ Object 



239
240
241
242
243
244
245
 
# File 'lib/facebooker/rails/publisher.rb', line 239

def recipients(*args)
  if args.size==0
    @recipients
  else
    @recipients=args.first
  end
end

#ref_update?(body) ⇒ Boolean

Returns:

  • (Boolean) 


344
345
346
 
# File 'lib/facebooker/rails/publisher.rb', line 344

def ref_update?(body)
  body.is_a?(Ref)
end

#render(opts) ⇒ Object

nodoc delegate to action view. Set up assigns and render



394
395
396
397
398
 
# File 'lib/facebooker/rails/publisher.rb', line 394

def render(opts)
  opts = opts.dup
  body = opts.delete(:assigns) || {}
  initialize_template_class(body.dup.merge(:controller=>self)).render(opts)
end

#request_comes_from_facebook? ⇒ Boolean

use facebook options everywhere

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/facebooker/rails/publisher.rb', line 102

def request_comes_from_facebook?
  true
end

#requires_from_user?(from, body) ⇒ Boolean

Returns:

  • (Boolean) 


336
337
338
 
# File 'lib/facebooker/rails/publisher.rb', line 336

def requires_from_user?(from,body)
  ! (announcement_notification?(from,body) or ref_update?(body) or profile_update?(body))
end

#send_as(option) ⇒ Object 



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/facebooker/rails/publisher.rb', line 256

def send_as(option)
  self._body=case option
  when :action
    Facebooker::Feed::Action.new
  when :story
    Facebooker::Feed::Story.new
  when :templatized_action
    Facebooker::Feed::TemplatizedAction.new
  when :notification
    Notification.new
  when :email
    Email.new
  when :profile
    Profile.new
  when :ref
    Ref.new
  when :user_action
    UserAction.new
  else
    raise UnknownBodyType.new("Unknown type to publish")
  end
end

#send_message(method) ⇒ Object

Raises:



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/facebooker/rails/publisher.rb', line 352

def send_message(method)
  @recipients = @recipients.is_a?(Array) ? @recipients : [@recipients]
  if from.nil? and @recipients.size==1 and requires_from_user?(from,_body)
    @from = @recipients.first
  end
  # notifications can 
  # omit the from address
  raise InvalidSender.new("Sender must be a Facebooker::User") unless from.is_a?(Facebooker::User) || !requires_from_user?(from,_body)
  case _body
  when Facebooker::Feed::TemplatizedAction,Facebooker::Feed::Action
    from.publish_action(_body)
  when Facebooker::Feed::Story
    @recipients.each {|r| r.publish_story(_body)}
  when Notification
    (from.nil? ? Facebooker::Session.create : from.session).send_notification(@recipients,_body.fbml)
  when Email
    from.session.send_email(@recipients, 
                                       _body.title, 
                                       _body.text, 
                                       _body.fbml)
  when Profile
   # If recipient and from aren't the same person, create a new user object using the
   # userid from recipient and the session from from
   @from = Facebooker::User.new(Facebooker::User.cast_to_facebook_id(@recipients.first),Facebooker::Session.create) 
   @from.set_profile_fbml(_body.profile, _body.mobile_profile, _body.profile_action, _body.profile_main)
  when Ref
    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)
  else
    raise UnspecifiedBodyType.new("You must specify a valid send_as")
  end
end

#short_story_template(title, body, params = {}) ⇒ Object 



292
293
294
295
 
# File 'lib/facebooker/rails/publisher.rb', line 292

def short_story_template(title,body,params={})
  @short_story_templates ||= []
  @short_story_templates << params.merge(:template_title=>title, :template_body=>body)
end