Module: Facebooker

Defined in:
lib/facebooker/version.rb,
lib/facebooker.rb,
lib/facebooker.rb,
lib/facebooker.rb,
lib/facebooker/data.rb,
lib/facebooker/feed.rb,
lib/facebooker/admin.rb,
lib/facebooker/model.rb,
lib/facebooker/mobile.rb,
lib/facebooker/parser.rb,
lib/facebooker/logging.rb,
lib/facebooker/service.rb,
lib/facebooker/session.rb,
lib/facebooker/models/tag.rb,
lib/facebooker/models/page.rb,
lib/facebooker/models/user.rb,
lib/facebooker/mock/service.rb,
lib/facebooker/mock/session.rb,
lib/facebooker/models/album.rb,
lib/facebooker/models/event.rb,
lib/facebooker/models/group.rb,
lib/facebooker/models/photo.rb,
lib/facebooker/models/video.rb,
lib/facebooker/server_cache.rb,
lib/facebooker/batch_request.rb,
lib/facebooker/models/cookie.rb,
lib/facebooker/rails/helpers.rb,
lib/facebooker/rails/routing.rb,
lib/facebooker/rails/cucumber.rb,
lib/facebooker/models/location.rb,
lib/facebooker/rails/publisher.rb,
lib/facebooker/rails/utilities.rb,
lib/facebooker/models/info_item.rb,
lib/facebooker/models/work_info.rb,
lib/facebooker/rails/controller.rb,
lib/facebooker/models/affiliation.rb,
lib/facebooker/models/friend_list.rb,
lib/facebooker/rails/test_helpers.rb,
lib/facebooker/models/info_section.rb,
lib/facebooker/models/notifications.rb,
lib/facebooker/rails/cucumber/world.rb,
lib/facebooker/adapters/adapter_base.rb,
lib/facebooker/adapters/bebo_adapter.rb,
lib/facebooker/adapters/bebo_adapter.rb,
lib/facebooker/models/education_info.rb,
lib/facebooker/rails/helpers/fb_connect.rb,
lib/facebooker/adapters/facebook_adapter.rb,
lib/facebooker/rails/facebook_form_builder.rb,
lib/facebooker/models/applicationproperties.rb,
lib/facebooker/models/applicationrestrictions.rb,
lib/facebooker/rails/profile_publisher_extensions.rb

Overview

Things that don’t actually work as expected in BEBO

Defined Under Namespace

Modules: Feed, Logging, Model, Rails, VERSION Classes: AdapterBase, AddTags, Admin, Affiliation, Album, ApplicationProperties, ApplicationRestrictions, AreFriends, BatchRequest, BatchRun, BeboAdapter, CanvasSession, Cookie, CreateAlbum, CreateToken, Data, DeactivateTemplateBundleByID, EducationInfo, Errors, Event, EventMembersGet, EventsGet, FacebookAdapter, FqlQuery, FriendList, FriendListsGet, GetAlbums, GetAllocation, GetAppProperties, GetAppUsers, GetCookies, GetFriends, GetLoggedInUser, GetPhotos, GetPreference, GetRegisteredTemplateBundles, GetRestrictionInfo, GetSession, GetTags, GetUnconnectedFriendsCount, Group, GroupGetMembers, GroupsGet, InfoItem, InfoSection, Location, Mobile, MockService, MockSession, NonSessionUser, Notifications, NotificationsGet, NotificationsSend, NotificationsSendEmail, Page, PagesGetInfo, PagesIsAdmin, PagesIsFan, Parser, Photo, ProfileFBML, ProfileFBMLSet, ProfileInfo, ProfileInfoSet, PublishActionOfUser, PublishStoryToUser, PublishTemplatizedAction, PublishUserAction, RefreshImgSrc, RefreshRefURL, RegisterTemplateBundle, RegisterUsers, RevokeAuthorization, SendRequest, ServerCache, Service, Session, SetAppProperties, SetCookie, SetPreference, SetRefHandle, SetRestrictionInfo, SetStatus, SmsCanSend, SmsSend, StreamPublish, Tag, UnregisterUsers, UploadPhoto, UploadVideo, User, UserHasPermission, UserInfo, UserStandardInfo, Video, WorkInfo

Constant Summary collapse

@@logger = 
nil

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.current_adapter ⇒ Object

Get the current adapter



77
78
79
 
# File 'lib/facebooker.rb', line 77

def current_adapter
  @current_adapter || Facebooker::AdapterBase.default_adapter
end

.path_prefix ⇒ Object (readonly)

Returns the value of attribute path_prefix.



115
116
117
 
# File 'lib/facebooker.rb', line 115

def path_prefix
  @path_prefix
end

.set_asset_host_to_callback_url ⇒ Object

Returns the value of attribute set_asset_host_to_callback_url.



98
99
100
 
# File 'lib/facebooker.rb', line 98

def set_asset_host_to_callback_url
  @set_asset_host_to_callback_url
end

.use_curl ⇒ Object Also known as: use_curl?

Returns the value of attribute use_curl.



99
100
101
 
# File 'lib/facebooker.rb', line 99

def use_curl
  @use_curl
end

Class Method Details

.apply_configuration(config) ⇒ Object

Sets the Facebook environment based on a hash of options. By default the hash passed in is loaded from facebooker.yml, but it can also be passed in manually every request to run multiple Facebook apps off one Rails app.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/facebooker.rb', line 51

def apply_configuration(config)
  ENV['FACEBOOK_API_KEY']             = config['api_key']
  ENV['FACEBOOK_SECRET_KEY']          = config['secret_key']
  ENV['FACEBOOKER_RELATIVE_URL_ROOT'] = config['canvas_page_name']
  ENV['FACEBOOKER_API']               = config['api']
  if config.has_key?('set_asset_host_to_callback_url')
    Facebooker.set_asset_host_to_callback_url = config['set_asset_host_to_callback_url'] 
  end
  if Object.const_defined?("ActionController") and Facebooker.set_asset_host_to_callback_url
    ActionController::Base.asset_host = config['callback_url'] 
  end
  Facebooker.timeout = config['timeout']
  @facebooker_configuration = config
end

.facebook_path_prefix ⇒ Object

Default is canvas_page_name in yml file



90
91
92
 
# File 'lib/facebooker.rb', line 90

def facebook_path_prefix
  current_adapter.facebook_path_prefix
end

.facebook_path_prefix=(path) ⇒ Object 



85
86
87
 
# File 'lib/facebooker.rb', line 85

def facebook_path_prefix=(path)
  current_adapter.facebook_path_prefix = path
end

.facebooker_config ⇒ Object 



66
67
68
 
# File 'lib/facebooker.rb', line 66

def facebooker_config
  @facebooker_configuration
end

.is_for?(application_container) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/facebooker.rb', line 94

def is_for?(application_container)
  current_adapter.is_for?(application_container)
end

.json_decode(str) ⇒ Object 



4
5
6
 
# File 'lib/facebooker.rb', line 4

def self.json_decode(str)
  JSON.parse(str)
end

.json_encode(o) ⇒ Object 



8
9
10
 
# File 'lib/facebooker.rb', line 8

def self.json_encode(o)
  JSON.dump(o)
end

.load_adapter(params) ⇒ Object 



81
82
83
 
# File 'lib/facebooker.rb', line 81

def load_adapter(params)
  self.current_adapter = Facebooker::AdapterBase.load_adapter(params)
end

.load_configuration(facebooker_yaml_file) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/facebooker.rb', line 37

def load_configuration(facebooker_yaml_file)
  if File.exist?(facebooker_yaml_file)
    if defined? RAILS_ENV
      config = YAML.load_file(facebooker_yaml_file)[RAILS_ENV] 
    else
      config = YAML.load_file(facebooker_yaml_file)           
    end
    apply_configuration(config)
  end
end

.logger ⇒ Object 



7
8
9
 
# File 'lib/facebooker/logging.rb', line 7

def self.logger
  @@logger
end

.logger=(logger) ⇒ Object 



4
5
6
 
# File 'lib/facebooker/logging.rb', line 4

def self.logger=(logger)
  @@logger = logger
end

.request_for_canvas(arg) ⇒ Object

prevent Facebooker from adding canvas name as prefix to URLs



134
135
136
137
138
139
140
141
142
 
# File 'lib/facebooker.rb', line 134

def request_for_canvas(is_canvas_request)
  original_path_prefix = @path_prefix 
  begin
    @path_prefix = facebook_path_prefix if is_canvas_request
    yield
  ensure
    @path_prefix = original_path_prefix
  end
end

.timeout ⇒ Object 



106
107
108
 
# File 'lib/facebooker.rb', line 106

def timeout
  @timeout
end

.timeout=(val) ⇒ Object 



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

def timeout=(val)
  @timeout = val.to_i
end

.with_asset_path_for_canvas ⇒ Object

Set the asset path to the canvas path for just this one request by definition, we will make this a canvas request



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/facebooker.rb', line 120

def with_asset_path_for_canvas
  original_asset_host = ActionController::Base.asset_host
  begin
    ActionController::Base.asset_host = Facebooker.api_server_base_url
    request_for_canvas(true) do
      yield
    end
  ensure
    ActionController::Base.asset_host = original_asset_host
  end
end