facebooker-lite 1.0.67

data/lib/facebooker/mock/session.rb

@@ -0,0 +1,18 @@
+require 'facebooker/session'
+
+module Facebooker
+  class MockSession < Session
+    def secured?
+      true
+    end
+
+    def secure!
+      @uid = 1
+      true
+    end
+ 
+    def service
+      @service ||= MockService.new(Facebooker.api_server_base, Facebooker.api_rest_path, @api_key)
+    end
+  end
+end

data/lib/facebooker/model.rb

@@ -0,0 +1,139 @@
+module Facebooker
+  ##
+  # helper methods primarily supporting the management of Ruby objects which are populatable via Hashes.
+  # Since most Facebook API calls accept and return hashes of data (as XML), the Model module allows us to
+  # directly populate a model's attributes given a Hash with matching key names.
+  module Model
+    class UnboundSessionException < Exception; end
+    def self.included(includer)
+      includer.extend ClassMethods
+      includer.__send__(:attr_writer, :session)
+      includer.__send__(:attr_reader, :anonymous_fields)
+    end
+    module ClassMethods
+      ##
+      # Instantiate a new instance of the class into which we are included and populate that instance's
+      # attributes given the provided Hash.  Key names in the Hash should map to attribute names on the model.
+      def from_hash(hash)
+        instance = new(hash)
+        yield instance if block_given?
+        instance
+      end
+
+      ##
+      # Create a standard attr_writer and a populating_attr_reader
+      def populating_attr_accessor(*symbols)
+        attr_writer(*symbols)
+        populating_attr_reader(*symbols)
+      end
+
+      ##
+      # Create a reader that will attempt to populate the model if it has not already been populated
+      def populating_attr_reader(*symbols)
+        symbols.each do |symbol|
+          define_method(symbol) do
+            populate unless populated?
+            instance_variable_get("@#{symbol}")
+          end
+        end
+      end
+      
+      def populating_hash_settable_accessor(symbol, klass)
+        populating_attr_reader symbol
+        hash_settable_writer(symbol, klass)
+      end
+        
+      def populating_hash_settable_list_accessor(symbol, klass)
+        populating_attr_reader symbol
+        hash_settable_list_writer(symbol, klass)
+      end
+      
+      #
+      # Declares an attribute named ::symbol:: which can be set with either an instance of ::klass::
+      # or a Hash which will be used to populate a new instance of ::klass::.
+      def hash_settable_accessor(symbol, klass)
+        attr_reader symbol
+        hash_settable_writer(symbol, klass)
+      end
+      
+      def hash_settable_writer(symbol, klass)
+        define_method("#{symbol}=") do |value|
+          instance_variable_set("@#{symbol}", value.kind_of?(Hash) ? klass.from_hash(value) : value)
+        end
+      end
+      
+      #
+      # Declares an attribute named ::symbol:: which can be set with either a list of instances of ::klass::
+      # or a list of Hashes which will be used to populate a new instance of ::klass::.
+      def hash_settable_list_accessor(symbol, klass)
+        attr_reader symbol
+        hash_settable_list_writer(symbol, klass)
+      end
+
+      def hash_settable_list_writer(symbol, klass)
+        define_method("#{symbol}=") do |list|
+          instance_variable_set("@#{symbol}", list.map do |item|
+            item.kind_of?(Hash) ? klass.from_hash(item) : item
+          end)
+        end
+      end
+
+      def id_is(attribute)
+        (file, line) = caller.first.split(':')
+
+        class_eval(<<-EOS, file, line.to_i)
+        def #{attribute}=(value)
+          @#{attribute} = value.to_i
+        end
+
+        attr_reader #{attribute.inspect}
+        alias :id #{attribute.inspect}
+        alias :id= #{"#{attribute}=".to_sym.inspect}
+        EOS
+      end
+    end
+
+    ##
+    # Centralized, error-checked place for a model to get the session to which it is bound.
+    # Any Facebook API queries require a Session instance.
+    def session
+      @session || (raise UnboundSessionException, "Must bind this object to a Facebook session before querying")
+    end
+    
+    # 
+    # This gets populated from FQL queries.
+    def anon=(value)
+      @anonymous_fields = value
+    end
+    
+    def initialize(hash = {})
+      populate_from_hash!(hash)
+    end
+
+    def populate
+      raise NotImplementedError, "#{self.class} included me and should have overriden me"
+    end
+
+    def populated?
+      @populated
+    end
+    
+    ##
+    # Set model's attributes via Hash.  Keys should map directly to the model's attribute names.
+    def populate_from_hash!(hash)
+      unless hash.nil? || hash.empty?
+        hash.each do |key, value|
+          set_attr_method = "#{key}="
+          unless value.nil?
+            if respond_to?(set_attr_method)
+              self.__send__(set_attr_method, value) 
+            else
+              Facebooker::Logging.log_info("**Warning**, Attempt to set non-attribute: #{key}",hash)
+            end
+          end
+        end
+        @populated = true
+      end      
+    end    
+  end
+end

data/lib/facebooker/models/affiliation.rb

@@ -0,0 +1,10 @@
+require 'facebooker/model'
+module Facebooker
+  ##
+  # Represents a user's affiliation, for example, which educational institutions
+  # the user is associated with.
+  class Affiliation
+    include Model
+    attr_accessor :name, :status, :type, :year, :nid
+  end
+end

data/lib/facebooker/models/album.rb

@@ -0,0 +1,11 @@
+require 'facebooker/model'
+module Facebooker
+  ##
+  # A simple representation of a photo album.
+  class Album
+    include Model
+    attr_accessor :aid, :cover_pid, :owner, :name, :created,
+                  :modified, :description, :location, :link, :size, :visible
+
+  end
+end

data/lib/facebooker/models/applicationproperties.rb

@@ -0,0 +1,39 @@
+module Facebooker
+  
+  # application_name  string   The name of your application.  
+  # callback_url  string   Your application's callback URL. The callback URL cannot be longer than 100 characters.  
+  # post_install_url  string   The URL where a user gets redirected after installing your application. The post-install URL cannot be longer than 100 characters. 
+  # edit_url  string    
+  # dashboard_url string    
+  # uninstall_url string   The URL where a user gets redirected after removing your application.  
+  # ip_list string   For Web-based applications, these are the IP addresses of your servers that can access Facebook's servers and serve information to your application. 
+  # email string   The email address associated with the application; the email address Facebook uses to contact you about your application. (default value is your Facebook email address.)  
+  # description string   The description of your application. 
+  # use_iframe  bool   Indicates whether you render your application with FBML (0) or in an iframe (1). (default value is 1)  
+  # desktop bool   Indicates whether your application is Web-based (0) or gets installed on a user's desktop (1). (default value is 1)  
+  # is_mobile bool   Indicates whether your application can run on a mobile device (1) or not (0). (default value is 1) 
+  # default_fbml  string   The default FBML code that appears in the user's profile box when he or she adds your application. 
+  # default_column  bool   Indicates whether your application appears in the wide (1) or narrow (0) column of a user's Facebook profile. (default value is 1) 
+  # message_url string   For applications that can create attachments, this is the URL where you store the attachment's content.  
+  # message_action  string   For applications that can create attachments, this is the label for the action that creates the attachment. It cannot be more than 20 characters.  
+  # about_url string   This is the URL to your application's About page. About pages are now Facebook Pages.  
+  # private_install bool   Indicates whether you want to disable (1) or enable (0) News Feed and Mini-Feed stories when a user installs your application. (default value is 1)  
+  # installable bool   Indicates whether a user can (1) or cannot (0) install your application. (default value is 1)  
+  # privacy_url string   The URL to your application's privacy terms. 
+  # help_url  string   The URL to your application's help page. 
+  # see_all_url string    
+  # tos_url string   The URL to your application's Terms of Service.  
+  # dev_mode  bool   Indicates whether developer mode is enabled (1) or disabled (0). Only developers can install applications in developer mode. (default value is 1)  
+  # preload_fql string   A preloaded FQL query.
+  class ApplicationProperties
+    include Model
+    FIELDS = [ :application_name, :callback_url, :post_install_url, :edit_url, :dashboard_url,
+               :uninstall_url, :ip_list, :email, :description, :use_iframe, :desktop, :is_mobile,
+               :default_fbml, :default_column, :message_url, :message_action, :about_url,
+               :private_install, :installable, :privacy_url, :help_url, :see_all_url, :tos_url,
+               :dev_mode, :preload_fql, :icon_url, :canvas_name, :logo_url, :connect_logo_url ]
+    
+    attr_accessor(*FIELDS)
+         
+  end
+end

data/lib/facebooker/models/applicationrestrictions.rb

@@ -0,0 +1,10 @@
+module Facebooker
+
+  class ApplicationRestrictions
+    include Model
+    FIELDS = [ :age, :location, :age_distribution, :type ]
+
+    attr_accessor(*FIELDS)
+
+  end
+end

data/lib/facebooker/models/comment.rb

@@ -0,0 +1,9 @@
+require 'facebooker/model'
+module Facebooker
+  ##
+  # A simple representation of a comment
+  class Comment
+    include Model
+    attr_accessor :xid, :fromid, :time, :text, :id
+  end
+end

data/lib/facebooker/models/cookie.rb

@@ -0,0 +1,10 @@
+require 'facebooker/model'
+module Facebooker
+  
+  ##
+  # A simple representation of a cookie.
+  class Cookie
+    include Model
+    attr_accessor :uid, :name, :value, :expires, :path
+  end
+end

data/lib/facebooker/models/education_info.rb

@@ -0,0 +1,11 @@
+module Facebooker
+  class EducationInfo
+    class HighschoolInfo
+      include Model
+      attr_accessor :hs1_id, :hs2_id, :grad_year, :hs1_name, :hs2_name
+    end
+    
+    include Model
+    attr_accessor :concentrations, :name, :year, :degree, :school_type
+  end
+end

data/lib/facebooker/models/event.rb

@@ -0,0 +1,28 @@
+require 'facebooker/model'
+module Facebooker
+  class Event
+    
+    ##
+    # The relationship between a Facebook user and an Event to which he or she has been
+    # invited and may or may not be attending (based on #rsvp_status)
+    class Attendance
+      include Model
+      attr_accessor :eid, :uid, :rsvp_status
+      
+      ##
+      # Get the full, populated Event object which this Attendance is associated with.
+      # First access will query the Facebook API (facebook.events.get).  Subsequent
+      # calls are retrieved from in-memory cache.
+      def event
+        @event ||= Event.from_hash(session.post('facebook.events.get', :eids => [eid]).first)
+      end
+      
+      #TODO: implement user() method
+    end
+    
+    include Model
+    attr_accessor :pic, :pic_small, :pic_big, :name, :creator, :update_time, :description, :tagline, :venue, :host, :event_type, :nid, :location, :end_time, :start_time, :event_subtype
+
+    id_is :eid
+  end
+end

data/lib/facebooker/models/family_relative_info.rb

@@ -0,0 +1,7 @@
+require 'facebooker/model'
+module Facebooker
+  class FamilyRelativeInfo
+    include Model
+    attr_accessor :relationship, :uid, :name, :birthday
+  end
+end

data/lib/facebooker/models/friend_list.rb

@@ -0,0 +1,16 @@
+require 'facebooker/model'
+module Facebooker
+  ##
+  # A simple representation of a friend list.
+  class FriendList
+    include Model
+    attr_accessor :name
+
+    id_is :flid
+
+    # We need this to be an integer, so do the conversion
+    def flid=(f)
+      @flid= ( f.nil? ? nil : f.to_i)
+    end
+  end
+end

data/lib/facebooker/models/group.rb

@@ -0,0 +1,36 @@
+require 'facebooker/model'
+module Facebooker
+  class Group
+    ##
+    # The model of a user's relationship to a group.  Users can occupy different positions within a group (e.g. 'owner')
+    class Membership
+      include Model
+      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, :privacy
+
+    id_is :gid
+
+    ##
+    # Get the full list of members as populated User objects.  First time fetches group members via Facebook API call.  
+    # Subsequent calls return cached values.
+    # This is a convenience method for getting all of the Membership instances and instantiating User instances for each Membership.
+    def members
+      @members ||= memberships.map do |membership|
+        User.new(membership.uid, session)
+      end
+    end
+    
+    ##
+    # Get a list of Membership instances associated with this Group.  First call retrieves the Membership instances via a Facebook
+    # API call.  Subsequent calls are retrieved from in-memory cache.
+    def memberships
+      @memberships ||= session.post('facebook.groups.getMembers', :gid => gid).map do |hash|
+        Membership.from_hash(hash) do |membership|
+          membership.gid = gid
+        end
+      end
+    end
+  end
+end

data/lib/facebooker/models/info_item.rb

@@ -0,0 +1,10 @@
+module Facebooker
+  class InfoItem
+    include Model
+    attr_accessor :label, :image, :description, :link, :sublabel
+    
+    def to_json
+      {:label => label, :image => image, :description => description, :link => link, :sublabel => sublabel}.to_json
+    end
+  end
+end

data/lib/facebooker/models/info_section.rb

@@ -0,0 +1,10 @@
+module Facebooker
+  class InfoSection
+    include Model
+    attr_accessor :field, :items
+    
+    def to_json
+      {:field => field, :items => items}.to_json
+    end
+  end
+end

data/lib/facebooker/models/location.rb

@@ -0,0 +1,8 @@
+module Facebooker
+  ##
+  # Representation of Location used in all places where a Location is specified.
+  class Location
+    include Model
+    attr_accessor :city, :zip, :country, :state
+  end
+end

data/lib/facebooker/models/message_thread.rb

@@ -0,0 +1,89 @@
+require 'facebooker/model'
+module Facebooker
+  class MessageThread
+    include Model
+    
+    id_is :thread_id
+    attr_accessor :subject, :updated_time, :recipients
+    attr_accessor :parent_message_id, :parent_thread_id, :message_count
+    attr_accessor :snippet, :snippet_author, :object_id, :unread
+    
+    class Message
+      include Model
+      
+      attr_accessor :message_id, :author_id, :body, :created_time, :attachment, :thread_id
+      
+      # An attachment can be a photo, a video, or a link
+      class Attachment
+        include Model
+        
+        attr_accessor :name, :href, :icon, :caption, :description
+        
+        # The Facebook messages API is in beta, this helper method is supposed to fail anytime soon
+        def video?
+          self.href =~ /\Ahttp:\/\/www\.facebook\.com\/video\/video\.php.*/
+        end
+        
+        # The Facebook messages API is in beta, this helper method is supposed to fail anytime soon
+        def photo?
+          self.href =~ /\Ahttp:\/\/www\.facebook\.com\/photo\.php.*/
+        end
+        
+        # The Facebook messages API is in beta, this helper method is supposed to fail anytime soon
+        def link?
+          !video? && !photo?
+        end
+      end
+      hash_settable_accessor :attachment, Facebooker::MessageThread::Message::Attachment
+    end
+    hash_settable_list_accessor :messages, Facebooker::MessageThread::Message
+    
+  end
+end
+
+# Example of attachments
+
+# -- Photo --
+
+# <attachment>
+#   <media list="true"/>
+#   <href>http://www.facebook.com/photo.php?pid=12345&amp;id=54321</href>
+#   <properties list="true"/>
+#   <icon>http://b.static.ak.fbcdn.net/rsrc.php/zB010/hash/9yvl71tw.gif</icon>
+#   <fb_object_type/>
+#   <fb_object_id/>
+#   <tagged_ids list="true"/>
+# </attachment>
+
+# -- Webcam video --
+
+# <attachment>
+#   <media list="true"/>
+#   <name>Feb 10, 2010 1:26pm</name>
+#   <href>http://www.facebook.com/video/video.php?v=12345</href>
+#   <properties list="true"/>
+#   <icon>http://static.ak.fbcdn.net/rsrc.php/zB010/hash/9yvl71tw.gif</icon>
+#   <fb_object_type/>
+#   <fb_object_id/>
+#   <tagged_ids list="true"/>
+# </attachment>
+
+# -- Link --
+
+# <attachment>
+#   <media list="true">
+#     <stream_media>
+#       <href>http://www.facebook.com/l.php?u=http%253A%252F%252Fwww.google.fr%252F&amp;h=e46dd63cdbfadb74958fbe44e98f339c</href>
+#       <type>link</type>
+#       <src>http://external.ak.fbcdn.net/safe_image.php?d=dd54bba6b6e6479a89bb8084573c02c8&amp;w=90&amp;h=90&amp;url=http%3A%2F%2Fwww.google.fr%2Fintl%2Ffr_fr%2Fimages%2Flogo.gif</src>
+#     </stream_media>
+#   </media>
+#   <name>Google</name>
+#   <href>http://www.facebook.com/l.php?u=http%253A%252F%252Fwww.google.fr%252F&amp;h=e46dd63cdbfadb74958fbe44e98f339c</href>
+#   <caption>www.google.fr</caption>
+#   <properties list="true"/>
+#   <icon>http://b.static.ak.fbcdn.net/rsrc.php/zB010/hash/9yvl71tw.gif</icon>
+#   <fb_object_type/>
+#   <fb_object_id/>
+#   <tagged_ids list="true"/>
+# </attachment>