RubyGems - mwilliams-facebooker - Versions diffs - 1.0.40 - Mend

mwilliams-facebooker 1.0.40

Files changed (135) hide show

data/.autotest +15 -0
data/CHANGELOG.rdoc +24 -0
data/COPYING.rdoc +19 -0
data/Manifest.txt +133 -0
data/README.rdoc +113 -0
data/Rakefile +85 -0
data/TODO.rdoc +4 -0
data/examples/desktop_login.rb +14 -0
data/facebooker.gemspec +38 -0
data/generators/facebook/facebook_generator.rb +14 -0
data/generators/facebook/templates/config/facebooker.yml +49 -0
data/generators/facebook/templates/public/javascripts/facebooker.js +93 -0
data/generators/facebook_controller/USAGE +33 -0
data/generators/facebook_controller/facebook_controller_generator.rb +40 -0
data/generators/facebook_controller/templates/controller.rb +7 -0
data/generators/facebook_controller/templates/functional_test.rb +11 -0
data/generators/facebook_controller/templates/helper.rb +2 -0
data/generators/facebook_controller/templates/view.fbml.erb +2 -0
data/generators/facebook_controller/templates/view.html.erb +2 -0
data/generators/facebook_publisher/facebook_publisher_generator.rb +14 -0
data/generators/facebook_publisher/templates/create_facebook_templates.rb +15 -0
data/generators/facebook_publisher/templates/publisher.rb +3 -0
data/generators/facebook_scaffold/USAGE +27 -0
data/generators/facebook_scaffold/facebook_scaffold_generator.rb +118 -0
data/generators/facebook_scaffold/templates/controller.rb +93 -0
data/generators/facebook_scaffold/templates/facebook_style.css +2579 -0
data/generators/facebook_scaffold/templates/functional_test.rb +89 -0
data/generators/facebook_scaffold/templates/helper.rb +2 -0
data/generators/facebook_scaffold/templates/layout.fbml.erb +6 -0
data/generators/facebook_scaffold/templates/layout.html.erb +17 -0
data/generators/facebook_scaffold/templates/style.css +74 -0
data/generators/facebook_scaffold/templates/view_edit.fbml.erb +13 -0
data/generators/facebook_scaffold/templates/view_edit.html.erb +18 -0
data/generators/facebook_scaffold/templates/view_index.fbml.erb +24 -0
data/generators/facebook_scaffold/templates/view_index.html.erb +24 -0
data/generators/facebook_scaffold/templates/view_new.fbml.erb +12 -0
data/generators/facebook_scaffold/templates/view_new.html.erb +17 -0
data/generators/facebook_scaffold/templates/view_show.fbml.erb +10 -0
data/generators/facebook_scaffold/templates/view_show.html.erb +10 -0
data/generators/publisher/publisher_generator.rb +14 -0
data/generators/xd_receiver/templates/xd_receiver.html +10 -0
data/generators/xd_receiver/xd_receiver_generator.rb +10 -0
data/init.rb +26 -0
data/install.rb +12 -0
data/lib/facebooker.rb +216 -0
data/lib/facebooker/adapters/adapter_base.rb +91 -0
data/lib/facebooker/adapters/bebo_adapter.rb +77 -0
data/lib/facebooker/adapters/facebook_adapter.rb +52 -0
data/lib/facebooker/admin.rb +42 -0
data/lib/facebooker/batch_request.rb +45 -0
data/lib/facebooker/data.rb +57 -0
data/lib/facebooker/feed.rb +78 -0
data/lib/facebooker/logging.rb +44 -0
data/lib/facebooker/mobile.rb +20 -0
data/lib/facebooker/mock/service.rb +50 -0
data/lib/facebooker/mock/session.rb +18 -0
data/lib/facebooker/model.rb +139 -0
data/lib/facebooker/models/affiliation.rb +10 -0
data/lib/facebooker/models/album.rb +11 -0
data/lib/facebooker/models/applicationproperties.rb +39 -0
data/lib/facebooker/models/applicationrestrictions.rb +10 -0
data/lib/facebooker/models/cookie.rb +10 -0
data/lib/facebooker/models/education_info.rb +11 -0
data/lib/facebooker/models/event.rb +28 -0
data/lib/facebooker/models/friend_list.rb +16 -0
data/lib/facebooker/models/group.rb +36 -0
data/lib/facebooker/models/info_item.rb +10 -0
data/lib/facebooker/models/info_section.rb +10 -0
data/lib/facebooker/models/location.rb +8 -0
data/lib/facebooker/models/notifications.rb +17 -0
data/lib/facebooker/models/page.rb +28 -0
data/lib/facebooker/models/photo.rb +19 -0
data/lib/facebooker/models/tag.rb +12 -0
data/lib/facebooker/models/user.rb +516 -0
data/lib/facebooker/models/video.rb +9 -0
data/lib/facebooker/models/work_info.rb +10 -0
data/lib/facebooker/parser.rb +674 -0
data/lib/facebooker/rails/backwards_compatible_param_checks.rb +31 -0
data/lib/facebooker/rails/controller.rb +356 -0
data/lib/facebooker/rails/cucumber.rb +28 -0
data/lib/facebooker/rails/cucumber/world.rb +46 -0
data/lib/facebooker/rails/extensions/action_controller.rb +48 -0
data/lib/facebooker/rails/extensions/rack_setup.rb +6 -0
data/lib/facebooker/rails/extensions/routing.rb +15 -0
data/lib/facebooker/rails/facebook_form_builder.rb +112 -0
data/lib/facebooker/rails/facebook_pretty_errors.rb +22 -0
data/lib/facebooker/rails/facebook_request_fix.rb +28 -0
data/lib/facebooker/rails/facebook_request_fix_2-3.rb +31 -0
data/lib/facebooker/rails/facebook_session_handling.rb +68 -0
data/lib/facebooker/rails/facebook_url_helper.rb +192 -0
data/lib/facebooker/rails/facebook_url_rewriting.rb +60 -0
data/lib/facebooker/rails/helpers.rb +804 -0
data/lib/facebooker/rails/helpers/fb_connect.rb +118 -0
data/lib/facebooker/rails/integration_session.rb +38 -0
data/lib/facebooker/rails/profile_publisher_extensions.rb +42 -0
data/lib/facebooker/rails/publisher.rb +550 -0
data/lib/facebooker/rails/routing.rb +49 -0
data/lib/facebooker/rails/test_helpers.rb +68 -0
data/lib/facebooker/rails/utilities.rb +22 -0
data/lib/facebooker/server_cache.rb +24 -0
data/lib/facebooker/service.rb +102 -0
data/lib/facebooker/session.rb +636 -0
data/lib/facebooker/version.rb +9 -0
data/lib/net/http_multipart_post.rb +123 -0
data/lib/rack/facebook.rb +82 -0
data/lib/tasks/facebooker.rake +18 -0
data/lib/tasks/tunnel.rake +46 -0
data/rails/init.rb +1 -0
data/setup.rb +1585 -0
data/templates/layout.erb +24 -0
data/test/facebooker/adapters_test.rb +174 -0
data/test/facebooker/admin_test.rb +102 -0
data/test/facebooker/batch_request_test.rb +83 -0
data/test/facebooker/data_test.rb +86 -0
data/test/facebooker/logging_test.rb +43 -0
data/test/facebooker/mobile_test.rb +45 -0
data/test/facebooker/model_test.rb +133 -0
data/test/facebooker/models/event_test.rb +15 -0
data/test/facebooker/models/photo_test.rb +16 -0
data/test/facebooker/models/user_test.rb +361 -0
data/test/facebooker/rails/facebook_request_fix_2-3_test.rb +25 -0
data/test/facebooker/rails/facebook_url_rewriting_test.rb +39 -0
data/test/facebooker/rails/publisher_test.rb +481 -0
data/test/facebooker/rails_integration_test.rb +1434 -0
data/test/facebooker/server_cache_test.rb +44 -0
data/test/facebooker/session_test.rb +652 -0
data/test/facebooker_test.rb +951 -0
data/test/fixtures/multipart_post_body_with_only_parameters.txt +33 -0
data/test/fixtures/multipart_post_body_with_single_file.txt +38 -0
data/test/fixtures/multipart_post_body_with_single_file_that_has_nil_key.txt +38 -0
data/test/net/http_multipart_post_test.rb +52 -0
data/test/rack/facebook_test.rb +61 -0
data/test/rails_test_helper.rb +27 -0
data/test/test_helper.rb +74 -0
metadata +232 -0

data/lib/facebooker/rails/backwards_compatible_param_checks.rb ADDED

@@ -0,0 +1,31 @@
+module Facebooker::Rails::BackwardsCompatibleParamChecks
+    def one_or_true( value )
+      case value
+        when String then
+          value == "1"
+        when Numeric then
+          value.to_f == 1.0
+        when TrueClass then
+          true
+        else
+          false
+      end
+    end
+    def zero_or_false( value )
+      case value
+        when String then
+          value == "0"
+        when Numeric then
+          value.to_f == 0.0
+        when FalseClass then
+          true
+        when NilClass then
+          true
+        else
+          false
+      end
+    end
+end

data/lib/facebooker/rails/controller.rb ADDED

@@ -0,0 +1,356 @@
+require 'facebooker'
+require 'facebooker/rails/profile_publisher_extensions'
+module Facebooker
+  module Rails
+    module Controller
+      include Facebooker::Rails::BackwardsCompatibleParamChecks
+      include Facebooker::Rails::ProfilePublisherExtensions
+      def self.included(controller)
+        controller.extend(ClassMethods)
+        controller.before_filter :set_adapter
+        controller.before_filter :set_facebook_request_format
+        controller.helper_attr :facebook_session_parameters
+        controller.helper_method :request_comes_from_facebook?
+      end
+      def initialize *args
+        @facebook_session       = nil
+        @installation_required  = nil
+        super
+      end
+      def facebook_session
+        @facebook_session
+      end
+      def facebook_session_parameters
+        {:fb_sig_session_key=>params[:fb_sig_session_key]}
+      end
+      def create_facebook_session
+        secure_with_facebook_params! || secure_with_cookies! || secure_with_token!
+      end
+      #this is used to proxy a connection through a rails app so the facebook secret key is not needed
+      #iphone apps use this
+      def create_facebook_session_with_secret
+        secure_with_session_secret!
+      end
+      def set_facebook_session
+        # first, see if we already have a session
+        session_set = session_already_secured?
+        # if not, see if we can load it from the environment
+        unless session_set
+          session_set = create_facebook_session
+          session[:facebook_session] = @facebook_session if session_set
+        end
+        if session_set
+          capture_facebook_friends_if_available!
+          Session.current = facebook_session
+        end
+        return session_set
+      end
+      def facebook_params
+        @facebook_params ||= verified_facebook_params
+      end
+      # Redirects the top window to the given url if the content is in an iframe, otherwise performs
+      # a normal redirect_to call.
+      def top_redirect_to(*args)
+        if request_is_facebook_iframe?
+          @redirect_url = url_for(*args)
+          render :layout => false, :inline => <<-HTML
+            <html><head>
+              <script type="text/javascript">
+                window.top.location.href = <%= @redirect_url.to_json -%>;
+              </script>
+              <noscript>
+                <meta http-equiv="refresh" content="0;url=<%=h @redirect_url %>" />
+                <meta http-equiv="window-target" content="_top" />
+              </noscript>
+            </head></html>
+          HTML
+        else
+          redirect_to(*args)
+        end
+      end
+      def redirect_to(*args)
+        if request_is_for_a_facebook_canvas? and !request_is_facebook_tab?
+          render :text => fbml_redirect_tag(*args)
+        else
+          super
+        end
+      end
+      private
+      def session_already_secured?
+        (@facebook_session = session[:facebook_session]) && session[:facebook_session].secured? if valid_session_key_in_session?
+      end
+      def user_has_deauthorized_application?
+        # if we're inside the facebook session and there is no session key,
+        # that means the user revoked our access
+        # we don't want to keep using the old expired key from the cookie.
+        request_comes_from_facebook? and params[:fb_sig_session_key].blank?
+      end
+      def clear_facebook_session_information
+        session[:facebook_session] = nil
+        @facebook_session=nil
+      end
+      def valid_session_key_in_session?
+        #before we access the facebook_params, make sure we have the parameters
+        #otherwise we will blow up trying to access the secure parameters
+        if user_has_deauthorized_application?
+          clear_facebook_session_information
+          false
+        else
+          !session[:facebook_session].blank? &&  (params[:fb_sig_session_key].blank? || session[:facebook_session].session_key == facebook_params[:session_key])
+        end
+      end
+      def clear_fb_cookies!
+        domain_cookie_tag = "base_domain_#{Facebooker.api_key}"
+        cookie_domain = ".#{cookies[domain_cookie_tag]}" if cookies[domain_cookie_tag]
+        fb_cookie_names.each {|name| cookies.delete(name, :domain=>cookie_domain)}
+        cookies.delete Facebooker.api_key
+      end
+      def fb_cookie_prefix
+        Facebooker.api_key+"_"
+      end
+      def fb_cookie_names
+        fb_cookie_names = cookies.keys.select{|k| k.starts_with?(fb_cookie_prefix)}
+      end
+      def secure_with_cookies!
+          parsed = {}
+          fb_cookie_names.each { |key| parsed[key[fb_cookie_prefix.size,key.size]] = cookies[key] }
+          #returning gracefully if the cookies aren't set or have expired
+          return unless parsed['session_key'] && parsed['user'] && parsed['expires'] && parsed['ss']
+          return unless Time.at(parsed['expires'].to_s.to_f) > Time.now || (parsed['expires'] == "0")
+          #if we have the unexpired cookies, we'll throw an exception if the sig doesn't verify
+          verify_signature(parsed,cookies[Facebooker.api_key])
+          @facebook_session = new_facebook_session
+          @facebook_session.secure_with!(parsed['session_key'],parsed['user'],parsed['expires'],parsed['ss'])
+          @facebook_session
+      end
+      def secure_with_token!
+        if params['auth_token']
+          @facebook_session = new_facebook_session
+          @facebook_session.auth_token = params['auth_token']
+          @facebook_session.secure!
+          @facebook_session
+        end
+      end
+      def secure_with_session_secret!
+        if params['auth_token']
+          @facebook_session = new_facebook_session
+          @facebook_session.auth_token = params['auth_token']
+          @facebook_session.secure_with_session_secret!
+          @facebook_session
+        end
+      end
+      def secure_with_facebook_params!
+        return unless request_comes_from_facebook?
+        if ['user', 'session_key'].all? {|element| facebook_params[element]}
+          @facebook_session = new_facebook_session
+          @facebook_session.secure_with!(facebook_params['session_key'], facebook_params['user'], facebook_params['expires'])
+          @facebook_session
+        end
+      end
+      #override to specify where the user should be sent after logging in
+      def after_facebook_login_url
+        nil
+      end
+      def default_after_facebook_login_url
+        url_for(:only_path => false, :overwrite_params => {})
+      end
+      def create_new_facebook_session_and_redirect!
+        session[:facebook_session] = new_facebook_session
+        next_url = after_facebook_login_url || default_after_facebook_login_url
+        top_redirect_to session[:facebook_session].login_url({:next => next_url}) unless @installation_required
+        false
+      end
+      def new_facebook_session
+        Facebooker::Session.create(Facebooker.api_key, Facebooker.secret_key)
+      end
+      def capture_facebook_friends_if_available!
+        return unless request_comes_from_facebook?
+        if friends = facebook_params['friends']
+          facebook_session.user.friends = friends.map do |friend_uid|
+            User.new(friend_uid, facebook_session)
+          end
+        end
+      end
+      def blank?(value)
+        (value == '0' || value.nil? || value == '')
+      end
+      def verified_facebook_params
+        facebook_sig_params = params.inject({}) do |collection, pair|
+          collection[pair.first.sub(/^fb_sig_/, '')] = pair.last if pair.first[0,7] == 'fb_sig_'
+          collection
+        end
+        verify_signature(facebook_sig_params,params['fb_sig'])
+        facebook_sig_params.inject(HashWithIndifferentAccess.new) do |collection, pair|
+          collection[pair.first] = facebook_parameter_conversions[pair.first].call(pair.last)
+          collection
+        end
+      end
+      def earliest_valid_session
+        48.hours.ago
+      end
+      def verify_signature(facebook_sig_params,expected_signature)
+        # Don't verify the signature if rack has already done so.
+        if ::Rails.version >= "2.3"
+          return if ActionController::Dispatcher.middleware.include? Rack::Facebook
+        end
+        raw_string = facebook_sig_params.map{ |*args| args.join('=') }.sort.join
+        actual_sig = Digest::MD5.hexdigest([raw_string, Facebooker::Session.secret_key].join)
+        raise Facebooker::Session::IncorrectSignature if actual_sig != expected_signature
+        raise Facebooker::Session::SignatureTooOld if facebook_sig_params['time'] && Time.at(facebook_sig_params['time'].to_f) < earliest_valid_session
+        true
+      end
+      def facebook_parameter_conversions
+        @facebook_parameter_conversions ||= Hash.new do |hash, key|
+          lambda{|value| value}
+        end.merge(
+          'time' => lambda{|value| Time.at(value.to_f)},
+          'in_canvas' => lambda{|value| !blank?(value)},
+          'added' => lambda{|value| !blank?(value)},
+          'expires' => lambda{|value| blank?(value) ? nil : Time.at(value.to_f)},
+          'friends' => lambda{|value| value.split(/,/)}
+        )
+      end
+      def fbml_redirect_tag(url)
+        "<fb:redirect url=\"#{url_for(url)}\" />"
+      end
+      def request_comes_from_facebook?
+        request_is_for_a_facebook_canvas? || request_is_facebook_ajax? || request_is_fb_ping?
+      end
+      def request_is_fb_ping?
+        !params['fb_sig'].blank?
+      end
+      def request_is_for_a_facebook_canvas?
+        !params['fb_sig_in_canvas'].blank?
+      end
+      def request_is_facebook_tab?
+        !params["fb_sig_in_profile_tab"].blank?
+      end
+      def request_is_facebook_iframe?
+        !params["fb_sig_in_iframe"].blank?
+      end
+      def request_is_facebook_ajax?
+        one_or_true(params["fb_sig_is_mockajax"]) || one_or_true(params["fb_sig_is_ajax"])
+      end
+      def xml_http_request?
+        request_is_facebook_ajax? || super
+      end
+      def application_is_installed?
+        facebook_params['added']
+      end
+      def ensure_has_status_update
+        has_extended_permission?("status_update") || application_needs_permission("status_update")
+      end
+      def ensure_has_photo_upload
+        has_extended_permission?("photo_upload") || application_needs_permission("photo_upload")
+      end
+      def ensure_has_video_upload
+        has_extended_permission?("video_upload") || application_needs_permission("video_upload")
+      end
+      def ensure_has_create_listing
+        has_extended_permission?("create_listing") || application_needs_permission("create_listing")
+      end
+      def application_needs_permission(perm)
+        top_redirect_to(facebook_session.permission_url(perm))
+      end
+      def has_extended_permission?(perm)
+        params["fb_sig_ext_perms"] and params["fb_sig_ext_perms"].include?(perm)
+      end
+      def ensure_authenticated_to_facebook
+        set_facebook_session || create_new_facebook_session_and_redirect!
+      end
+      def ensure_application_is_installed_by_facebook_user
+        @installation_required = true
+        returning ensure_authenticated_to_facebook && application_is_installed? do |authenticated_and_installed|
+           application_is_not_installed_by_facebook_user unless authenticated_and_installed
+        end
+      end
+      def application_is_not_installed_by_facebook_user
+        next_url = after_facebook_login_url || default_after_facebook_login_url
+        top_redirect_to session[:facebook_session].install_url({:next => next_url})
+      end
+      def set_facebook_request_format
+        if request_is_facebook_ajax?
+          request.format = :fbjs
+        elsif request_comes_from_facebook? && !request_is_facebook_iframe?
+          request.format = :fbml
+        end
+      end
+      def set_adapter
+        Facebooker.load_adapter(params) if(params[:fb_sig_api_key])
+      end
+      module ClassMethods
+        #
+        # Creates a filter which reqires a user to have already authenticated to
+        # Facebook before executing actions.  Accepts the same optional options hash which
+        # before_filter and after_filter accept.
+        def ensure_authenticated_to_facebook(options = {})
+          before_filter :ensure_authenticated_to_facebook, options
+        end
+        def ensure_application_is_installed_by_facebook_user(options = {})
+          before_filter :ensure_application_is_installed_by_facebook_user, options
+        end
+        def request_comes_from_facebook?
+          request_is_for_a_facebook_canvas? || request_is_facebook_ajax?
+        end
+      end
+    end
+  end
+end

data/lib/facebooker/rails/cucumber.rb ADDED

@@ -0,0 +1,28 @@
+require 'facebooker/rails/cucumber/world'
+require 'facebooker/mock/session'
+require 'facebooker/mock/service'
+Facebooker::MockService.fixture_path = File.join(RAILS_ROOT, 'features', 'support', 'facebook')
+module Facebooker
+  class << self
+    # prevent Facebooker from adding canvas name as prefix to URLs
+    def request_for_canvas(arg)
+      yield
+    end
+  end
+  module Rails
+    module Controller
+      # prevent Facebooker from rendering fb:redirect
+      def redirect_to(*args)
+        super
+      end
+      # Return the mock session
+      def new_facebook_session
+        Facebooker::MockSession.create
+      end
+    end
+  end
+end

data/lib/facebooker/rails/cucumber/world.rb ADDED

@@ -0,0 +1,46 @@
+require 'cucumber/rails/world'
+require 'facebooker/rails/integration_session'
+module Facebooker
+  module Rails
+    module Cucumber
+      class World < ::Cucumber::Rails::World
+        def open_session
+          session = Facebooker::Rails::IntegrationSession.new
+          # delegate the fixture accessors back to the test instance
+          extras = Module.new { attr_accessor :delegate, :test_result }
+          if self.class.respond_to?(:fixture_table_names)
+            self.class.fixture_table_names.each do |table_name|
+              name = table_name.tr(".", "_")
+              next unless respond_to?(name)
+              extras.__send__(:define_method, name) { |*args| delegate.send(name, *args) }
+            end
+          end
+          # delegate add_assertion to the test case
+          extras.__send__(:define_method, :add_assertion) { test_result.add_assertion }
+          session.extend(extras)
+          session.delegate = self
+          session.test_result = @_result
+          yield session if block_given?
+          session
+        end
+        def without_canvas
+          in_canvas = @integration_session.canvas
+          @integration_session.canvas = false
+          yield
+          @integration_session.canvas = in_canvas
+        end
+      end
+    end
+  end
+end
+World do
+  w = Facebooker::Rails::Cucumber::World.new
+  w.reset!
+  w
+end