facebooker 0.9.5 → 1.0.13

Sign up to get free protection for your applications and to get access to all the features.
Files changed (105) hide show
  1. data/History.txt +14 -0
  2. data/Manifest.txt +68 -14
  3. data/README +4 -2
  4. data/README.txt +22 -4
  5. data/Rakefile +42 -4
  6. data/TODO.txt +3 -9
  7. data/generators/facebook/facebook_generator.rb +14 -0
  8. data/{facebooker.yml.tpl → generators/facebook/templates/config/facebooker.yml} +12 -2
  9. data/generators/facebook/templates/public/javascripts/facebooker.js +106 -0
  10. data/generators/facebook_controller/USAGE +33 -0
  11. data/generators/facebook_controller/facebook_controller_generator.rb +40 -0
  12. data/generators/facebook_controller/templates/controller.rb +7 -0
  13. data/generators/facebook_controller/templates/functional_test.rb +11 -0
  14. data/generators/facebook_controller/templates/helper.rb +2 -0
  15. data/generators/facebook_controller/templates/view.fbml.erb +2 -0
  16. data/generators/facebook_controller/templates/view.html.erb +2 -0
  17. data/generators/facebook_publisher/facebook_publisher_generator.rb +14 -0
  18. data/generators/facebook_publisher/templates/create_facebook_templates.rb +15 -0
  19. data/generators/facebook_publisher/templates/publisher.rb +3 -0
  20. data/generators/facebook_scaffold/USAGE +27 -0
  21. data/generators/facebook_scaffold/facebook_scaffold_generator.rb +118 -0
  22. data/generators/facebook_scaffold/templates/controller.rb +93 -0
  23. data/generators/facebook_scaffold/templates/facebook_style.css +2579 -0
  24. data/generators/facebook_scaffold/templates/functional_test.rb +89 -0
  25. data/generators/facebook_scaffold/templates/helper.rb +2 -0
  26. data/generators/facebook_scaffold/templates/layout.fbml.erb +6 -0
  27. data/generators/facebook_scaffold/templates/layout.html.erb +17 -0
  28. data/generators/facebook_scaffold/templates/style.css +74 -0
  29. data/generators/facebook_scaffold/templates/view_edit.fbml.erb +13 -0
  30. data/generators/facebook_scaffold/templates/view_edit.html.erb +18 -0
  31. data/generators/facebook_scaffold/templates/view_index.fbml.erb +24 -0
  32. data/generators/facebook_scaffold/templates/view_index.html.erb +24 -0
  33. data/generators/facebook_scaffold/templates/view_new.fbml.erb +12 -0
  34. data/generators/facebook_scaffold/templates/view_new.html.erb +17 -0
  35. data/generators/facebook_scaffold/templates/view_show.fbml.erb +10 -0
  36. data/generators/facebook_scaffold/templates/view_show.html.erb +10 -0
  37. data/generators/publisher/publisher_generator.rb +14 -0
  38. data/generators/xd_receiver/templates/xd_receiver.html +10 -0
  39. data/generators/xd_receiver/xd_receiver_generator.rb +9 -0
  40. data/init.rb +30 -12
  41. data/install.rb +10 -3
  42. data/lib/facebooker.rb +139 -30
  43. data/lib/facebooker/adapters/adapter_base.rb +87 -0
  44. data/lib/facebooker/adapters/bebo_adapter.rb +75 -0
  45. data/lib/facebooker/adapters/facebook_adapter.rb +48 -0
  46. data/lib/facebooker/admin.rb +42 -0
  47. data/lib/facebooker/batch_request.rb +44 -0
  48. data/lib/facebooker/data.rb +24 -5
  49. data/lib/facebooker/feed.rb +18 -5
  50. data/lib/facebooker/logging.rb +51 -0
  51. data/lib/facebooker/model.rb +18 -1
  52. data/lib/facebooker/{affiliation.rb → models/affiliation.rb} +0 -0
  53. data/lib/facebooker/{album.rb → models/album.rb} +0 -0
  54. data/lib/facebooker/models/applicationproperties.rb +39 -0
  55. data/lib/facebooker/{cookie.rb → models/cookie.rb} +0 -0
  56. data/lib/facebooker/{education_info.rb → models/education_info.rb} +0 -0
  57. data/lib/facebooker/{event.rb → models/event.rb} +2 -0
  58. data/lib/facebooker/models/friend_list.rb +16 -0
  59. data/lib/facebooker/{group.rb → models/group.rb} +1 -0
  60. data/lib/facebooker/models/info_item.rb +10 -0
  61. data/lib/facebooker/models/info_section.rb +10 -0
  62. data/lib/facebooker/{location.rb → models/location.rb} +0 -0
  63. data/lib/facebooker/{notifications.rb → models/notifications.rb} +0 -0
  64. data/lib/facebooker/models/page.rb +27 -0
  65. data/lib/facebooker/{photo.rb → models/photo.rb} +4 -1
  66. data/lib/facebooker/{tag.rb → models/tag.rb} +0 -0
  67. data/lib/facebooker/models/user.rb +394 -0
  68. data/lib/facebooker/{work_info.rb → models/work_info.rb} +0 -0
  69. data/lib/facebooker/parser.rb +201 -19
  70. data/lib/facebooker/rails/controller.rb +129 -21
  71. data/lib/facebooker/rails/facebook_form_builder.rb +3 -3
  72. data/lib/facebooker/rails/facebook_pretty_errors.rb +14 -0
  73. data/lib/facebooker/rails/facebook_request_fix.rb +10 -0
  74. data/lib/facebooker/rails/facebook_session_handling.rb +12 -1
  75. data/lib/facebooker/rails/facebook_url_helper.rb +192 -0
  76. data/lib/facebooker/rails/facebook_url_rewriting.rb +11 -3
  77. data/lib/facebooker/rails/helpers.rb +180 -34
  78. data/lib/facebooker/rails/helpers/fb_connect.rb +38 -0
  79. data/lib/facebooker/rails/profile_publisher_extensions.rb +42 -0
  80. data/lib/facebooker/rails/publisher.rb +513 -0
  81. data/lib/facebooker/rails/routing.rb +1 -1
  82. data/lib/facebooker/rails/test_helpers.rb +75 -3
  83. data/lib/facebooker/server_cache.rb +3 -3
  84. data/lib/facebooker/service.rb +74 -7
  85. data/lib/facebooker/session.rb +245 -68
  86. data/lib/facebooker/version.rb +3 -3
  87. data/lib/tasks/facebooker.rake +4 -2
  88. data/lib/tasks/tunnel.rake +14 -7
  89. data/rails/init.rb +1 -0
  90. data/templates/layout.erb +24 -0
  91. data/test/adapters_test.rb +98 -0
  92. data/test/batch_request_test.rb +82 -0
  93. data/test/facebook_admin_test.rb +102 -0
  94. data/test/facebook_cache_test.rb +1 -0
  95. data/test/facebook_data_test.rb +36 -0
  96. data/test/facebooker_test.rb +221 -80
  97. data/test/logging_test.rb +43 -0
  98. data/test/model_test.rb +12 -0
  99. data/test/publisher_test.rb +458 -0
  100. data/test/rails_integration_test.rb +538 -33
  101. data/test/session_test.rb +223 -6
  102. data/test/test_helper.rb +8 -2
  103. data/test/user_test.rb +191 -2
  104. metadata +99 -18
  105. data/lib/facebooker/user.rb +0 -200
data/install.rb CHANGED
@@ -1,5 +1,12 @@
1
1
  require 'fileutils'
2
+ require 'rubygems'
2
3
 
3
- facebook_config = File.dirname(__FILE__) + '/../../../config/facebooker.yml'
4
- FileUtils.cp File.dirname(__FILE__) + '/facebooker.yml.tpl', facebook_config unless File.exist?(facebook_config)
5
- puts IO.read(File.join(File.dirname(__FILE__), 'README'))
4
+ dir = File.dirname(__FILE__)
5
+ templates = File.join(dir, 'generators', 'facebook', 'templates')
6
+ config = File.join('config', 'facebooker.yml')
7
+ script = File.join('public', 'javascripts', 'facebooker.js')
8
+
9
+ [config, script].each do |path|
10
+ FileUtils.cp File.join(templates, path), File.join(RAILS_ROOT, path) unless File.exist?(File.join(RAILS_ROOT, path))
11
+ end
12
+ puts IO.read(File.join(dir, 'README'))
data/lib/facebooker.rb CHANGED
@@ -1,45 +1,121 @@
1
+ begin
2
+ unless Object.const_defined?("ActiveSupport") and ActiveSupport.const_defined?("JSON")
3
+ require 'json'
4
+ module Facebooker
5
+ def self.json_decode(str)
6
+ JSON.parse(str)
7
+ end
8
+ end
9
+ else
10
+ module Facebooker
11
+ def self.json_decode(str)
12
+ ActiveSupport::JSON.decode(str)
13
+ end
14
+ end
15
+ end
16
+ rescue
17
+ require 'json'
18
+ end
19
+ require 'zlib'
20
+ require 'digest/md5'
21
+
22
+
1
23
 
2
- require 'facebooker/affiliation'
3
- require 'facebooker/album'
4
- require 'facebooker/education_info'
5
- require 'facebooker/feed'
6
- require 'facebooker/location'
7
- require 'facebooker/model'
8
- require 'facebooker/notifications'
9
- require 'facebooker/parser'
10
- require 'facebooker/photo'
11
- require 'facebooker/cookie'
12
- require 'facebooker/service'
13
- require 'facebooker/server_cache'
14
- require 'facebooker/data'
15
- require 'facebooker/session'
16
- require 'facebooker/tag'
17
- require 'facebooker/user'
18
- require 'facebooker/version'
19
- require 'facebooker/work_info'
20
- require 'facebooker/event'
21
- require 'facebooker/group'
22
24
  module Facebooker
23
- VERSION="0.9.5"
24
- class << self
25
- def path_prefix
26
- @path_prefix
25
+
26
+ class << self
27
+
28
+ def load_configuration(facebooker_yaml_file)
29
+ if File.exist?(facebooker_yaml_file)
30
+ if defined? RAILS_ENV
31
+ facebooker = YAML.load_file(facebooker_yaml_file)[RAILS_ENV]
32
+ else
33
+ facebooker = YAML.load_file(facebooker_yaml_file)
34
+ end
35
+ ENV['FACEBOOK_API_KEY'] = facebooker['api_key']
36
+ ENV['FACEBOOK_SECRET_KEY'] = facebooker['secret_key']
37
+ ENV['FACEBOOKER_RELATIVE_URL_ROOT'] = facebooker['canvas_page_name']
38
+ ENV['FACEBOOKER_API'] = facebooker['api']
39
+ if facebooker.has_key?('set_asset_host_to_callback_url')
40
+ Facebooker.set_asset_host_to_callback_url = facebooker['set_asset_host_to_callback_url']
41
+ end
42
+ Facebooker.timeout = facebooker['timeout']
43
+ if Object.const_defined?("ActionController")
44
+ ActionController::Base.asset_host = facebooker['callback_url'] if(ActionController::Base.asset_host.blank?) && Facebooker.set_asset_host_to_callback_url
45
+ end
46
+ @facebooker_configuration = facebooker
47
+ end
27
48
  end
28
-
49
+
50
+ def facebooker_config
51
+ @facebooker_configuration
52
+ end
53
+
54
+ def current_adapter=(adapter_class)
55
+ @current_adapter = adapter_class
56
+ end
57
+
58
+ def current_adapter
59
+ @current_adapter || Facebooker::AdapterBase.default_adapter
60
+ end
61
+
62
+ def load_adapter(params)
63
+ self.current_adapter = Facebooker::AdapterBase.load_adapter(params)
64
+ end
65
+
29
66
  def facebook_path_prefix=(path)
30
- @facebook_path_prefix = path
67
+ current_adapter.facebook_path_prefix = path
31
68
  end
32
69
 
70
+ # Default is canvas_page_name in yml file
33
71
  def facebook_path_prefix
34
- "/" + (@facebook_path_prefix || ENV["FACEBOOK_CANVAS_PATH"] || ENV["FACEBOOKER_RELATIVE_URL_ROOT"])
72
+ current_adapter.facebook_path_prefix
35
73
  end
36
-
74
+
75
+ def is_for?(application_container)
76
+ current_adapter.is_for?(application_container)
77
+ end
78
+
79
+ def set_asset_host_to_callback_url=(val)
80
+ @set_asset_host_to_callback_url=val
81
+ end
82
+
83
+ def set_asset_host_to_callback_url
84
+ @set_asset_host_to_callback_url.nil? ? true : @set_asset_host_to_callback_url
85
+ end
86
+
87
+ def use_curl=(val)
88
+ @use_curl=val
89
+ end
90
+
91
+ def use_curl?
92
+ @use_curl
93
+ end
94
+
95
+ def timeout=(val)
96
+ @timeout = val.to_i
97
+ end
98
+
99
+ def timeout
100
+ @timeout
101
+ end
102
+
103
+ [: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].each do |delegated_method|
104
+ define_method(delegated_method){ return current_adapter.send(delegated_method)}
105
+ end
106
+
107
+
108
+ def path_prefix
109
+ @path_prefix
110
+ end
111
+
112
+
37
113
  # Set the asset path to the canvas path for just this one request
38
114
  # by definition, we will make this a canvas request
39
115
  def with_asset_path_for_canvas
40
116
  original_asset_host = ActionController::Base.asset_host
41
117
  begin
42
- ActionController::Base.asset_host = "http://apps.facebook.com"
118
+ ActionController::Base.asset_host = Facebooker.api_server_base_url
43
119
  request_for_canvas(true) do
44
120
  yield
45
121
  end
@@ -60,4 +136,37 @@ module Facebooker
60
136
  end
61
137
  end
62
138
  end
63
- end
139
+ end
140
+
141
+ require 'facebooker/batch_request'
142
+ require 'facebooker/feed'
143
+ require 'facebooker/logging'
144
+ require 'facebooker/model'
145
+ require 'facebooker/parser'
146
+ require 'facebooker/service'
147
+ require 'facebooker/server_cache'
148
+ require 'facebooker/data'
149
+ require 'facebooker/admin'
150
+ require 'facebooker/session'
151
+ require 'facebooker/version'
152
+ require 'facebooker/models/location'
153
+ require 'facebooker/models/affiliation'
154
+ require 'facebooker/models/album'
155
+ require 'facebooker/models/education_info'
156
+ require 'facebooker/models/work_info'
157
+ require 'facebooker/models/event'
158
+ require 'facebooker/models/group'
159
+ require 'facebooker/models/notifications'
160
+ require 'facebooker/models/page'
161
+ require 'facebooker/models/photo'
162
+ require 'facebooker/models/cookie'
163
+ require 'facebooker/models/applicationproperties'
164
+ require 'facebooker/models/applicationrestrictions'
165
+ require 'facebooker/models/tag'
166
+ require 'facebooker/models/user'
167
+ require 'facebooker/models/info_item'
168
+ require 'facebooker/models/info_section'
169
+ require 'facebooker/adapters/adapter_base'
170
+ require 'facebooker/adapters/facebook_adapter'
171
+ require 'facebooker/adapters/bebo_adapter'
172
+ require 'facebooker/models/friend_list'
@@ -0,0 +1,87 @@
1
+ module Facebooker
2
+
3
+ class AdapterBase
4
+ class UnableToLoadAdapter < Exception; end
5
+ require 'active_support/inflector'
6
+ include ActiveSupport::CoreExtensions::String::Inflections
7
+ def facebook_path_prefix
8
+ "/" + (@facebook_path_prefix || canvas_page_name || ENV['FACEBOOK_CANVAS_PATH'] || ENV['FACEBOOKER_RELATIVE_URL_ROOT'])
9
+ end
10
+
11
+ def facebook_path_prefix=(prefix)
12
+ @facebook_path_prefix = prefix
13
+ end
14
+
15
+ def facebooker_config
16
+ @config
17
+ end
18
+
19
+ def api_server_base_url
20
+ "http://" + api_server_base
21
+ end
22
+
23
+ def is_for?(application_context)
24
+ raise "SubClassShouldDefine"
25
+ end
26
+
27
+ def initialize(config)
28
+ @config = config
29
+ end
30
+
31
+ def self.facebooker_config
32
+ Facebooker.facebooker_config
33
+ end
34
+
35
+
36
+ def self.load_adapter(params)
37
+
38
+ config_key_base = params[:config_key_base] # This allows for loading of a aspecific adapter
39
+ config_key_base += "_" unless config_key_base.blank?
40
+
41
+ unless api_key = (params[:fb_sig_api_key] || facebooker_config["#{config_key_base}api_key"])
42
+ raise Facebooker::AdapterBase::UnableToLoadAdapter
43
+ end
44
+
45
+ unless facebooker_config
46
+ return self.default_adapter(params)
47
+ end
48
+
49
+ facebooker_config.each do |key,value|
50
+ next unless value == api_key
51
+
52
+ key_base = key.match(/(.*)[_]?api_key/)[1]
53
+
54
+ adapter_class_name = if key_base.blank?
55
+ "FacebookAdapter"
56
+ else
57
+ facebooker_config[key_base + "adapter"]
58
+ end
59
+
60
+ adapter_class = "Facebooker::#{adapter_class_name}".constantize
61
+
62
+ # Collect the rest of the configuration
63
+ adapter_config = {}
64
+ facebooker_config.each do |key,value|
65
+ if (match = key.match(/#{key_base}[_]?(.*)/))
66
+ adapter_config[match[1]] = value
67
+ end
68
+ end
69
+ return adapter_class.new(adapter_config)
70
+ end
71
+ end
72
+
73
+ def self.default_adapter(params = {})
74
+ if facebooker_config.nil? || (facebooker_config.blank? rescue nil)
75
+ config = { "api_key" => ENV['FACEBOOK_API_KEY'], "secret_key" => ENV['FACEBOOK_SECRET_KEY']}
76
+ else
77
+ config = facebooker_config
78
+ end
79
+ FacebookAdapter.new(config)
80
+ end
81
+
82
+ [:canvas_page_name, :api_key,:secret_key].each do |key_method|
83
+ define_method(key_method){ return facebooker_config[key_method.to_s]}
84
+ end
85
+
86
+ end
87
+ end
@@ -0,0 +1,75 @@
1
+ module Facebooker
2
+ class BeboAdapter < AdapterBase
3
+
4
+ def canvas_server_base
5
+ "apps.bebo.com"
6
+ end
7
+
8
+ def api_server_base
9
+ 'apps.bebo.com'
10
+ end
11
+
12
+ def api_rest_path
13
+ "/restserver.php"
14
+ end
15
+
16
+ def is_for?(application_context)
17
+ application_context == :bebo
18
+ end
19
+
20
+ def www_server_base_url
21
+ "www.bebo.com"
22
+ end
23
+
24
+
25
+ def login_url_base
26
+ "http://#{www_server_base_url}/SignIn.jsp?ApiKey=#{api_key}&v=1.0"
27
+ end
28
+
29
+ def install_url_base
30
+ "http://#{www_server_base_url}/c/apps/add?ApiKey=#{api_key}&v=1.0"
31
+ end
32
+ end
33
+ end
34
+
35
+ # Things that don't actually work as expected in BEBO
36
+ Facebooker::PublishTemplatizedAction
37
+ module Facebooker
38
+ class User
39
+ def set_profile_fbml_with_bebo_adapter(profile_fbml, mobile_fbml, profile_action_fbml, profile_main = nil)
40
+ if(Facebooker.is_for?(:bebo))
41
+ self.session.post('facebook.profile.setFBML', :uid => @id, :markup => profile_fbml)
42
+ else
43
+ set_profile_fbml_without_bebo_adapter(profile_fbml,mobile_fbml, profile_action_fbml, profile_main)
44
+ end
45
+ end
46
+ alias_method :set_profile_fbml_without_bebo_adapter, :set_profile_fbml
47
+ alias_method :set_profile_fbml, :set_profile_fbml_with_bebo_adapter
48
+
49
+ private
50
+
51
+ BEBO_FIELDS = FIELDS - [:meeting_sex, :wall_count, :meeting_for]
52
+ def collect(fields)
53
+ if(Facebooker.is_for?(:bebo) )
54
+ BEBO_FIELDS.reject{|field_name| !fields.empty? && !fields.include?(field_name)}.join(',')
55
+ else
56
+ FIELDS.reject{|field_name| !fields.empty? && !fields.include?(field_name)}.join(',')
57
+ end
58
+ end
59
+ end
60
+
61
+
62
+ class PublishTemplatizedAction < Parser#:nodoc:
63
+ class <<self
64
+ def process_with_bebo_adapter(data)
65
+ if(Facebooker.is_for?(:bebo))
66
+ element('feed_publishTemplatizedAction_response', data).text_value
67
+ else
68
+ process_without_bebo_adapter(data)
69
+ end
70
+ end
71
+ alias_method :process_without_bebo_adapter, :process
72
+ alias_method :process, :process_with_bebo_adapter
73
+ end
74
+ end
75
+ end
@@ -0,0 +1,48 @@
1
+ module Facebooker
2
+
3
+
4
+ class FacebookAdapter < AdapterBase
5
+
6
+ def canvas_server_base
7
+ "apps.facebook.com"
8
+ end
9
+
10
+ def api_server_base
11
+ "api.facebook.com"
12
+ end
13
+
14
+ def www_server_base_url
15
+ "www.facebook.com"
16
+ end
17
+
18
+ def api_rest_path
19
+ "/restserver.php"
20
+ end
21
+
22
+ def api_key
23
+ ENV['FACEBOOK_API_KEY'] || super
24
+ end
25
+
26
+ def secret_key
27
+ ENV['FACEBOOK_SECRET_KEY'] || super
28
+ end
29
+
30
+ def is_for?(application_context)
31
+ application_context == :facebook
32
+ end
33
+
34
+
35
+
36
+ def login_url_base
37
+ "http://#{www_server_base_url}/login.php?api_key=#{api_key}&v=1.0"
38
+ end
39
+
40
+ def install_url_base
41
+ "http://#{www_server_base_url}/install.php?api_key=#{api_key}&v=1.0"
42
+ end
43
+
44
+ end
45
+
46
+ end
47
+
48
+
@@ -0,0 +1,42 @@
1
+ module Facebooker
2
+ class Admin
3
+ def initialize(session)
4
+ @session = session
5
+ end
6
+
7
+ # ** BETA ***
8
+ # +properties+: Hash of properties you want to set
9
+ def set_app_properties(properties)
10
+ properties = properties.respond_to?(:to_json) ? properties.to_json : properties
11
+ (@session.post 'facebook.admin.setAppProperties', :properties => properties) == '1'
12
+ end
13
+
14
+ # ** BETA ***
15
+ # +properties+: Hash of properties you want to view.
16
+ def get_app_properties(*properties)
17
+ json = @session.post('facebook.admin.getAppProperties', :properties => properties.to_json)
18
+ hash = JSON.parse(CGI.unescapeHTML(json))
19
+ @properties = ApplicationProperties.from_hash(hash)
20
+ end
21
+
22
+ # ** BETA ***
23
+ # +restrictions+: Hash of restrictions you want to set.
24
+ def set_restriction_info(restrictions)
25
+ restrictions = restrictions.respond_to?(:to_json) ? restrictions.to_json : restrictions
26
+ (@session.post 'facebook.admin.setRestrictionInfo', :restriction_str => restrictions) == '1'
27
+ end
28
+
29
+ # ** BETA ***
30
+ def get_restriction_info(*restrictions)
31
+ json = @session.post('facebook.admin.getRestrictionInfo')
32
+ hash = JSON.parse(CGI.unescapeHTML(json))
33
+ @restrictions = ApplicationRestrictions.from_hash(hash)
34
+ end
35
+
36
+ # Integration points include..
37
+ # :notifications_per_day, :requests_per_day, :emails_per_day, :email_disable_message_location
38
+ def get_allocation(integration_point)
39
+ @session.post('facebook.admin.getAllocation', :integration_point_name => integration_point.to_s).to_i
40
+ end
41
+ end
42
+ end