fb_graph 1.6.1 → 1.6.2

data/VERSION

@@ -1 +1 @@
-1.6.1
+1.6.2

data/fb_graph.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{fb_graph}
-  s.version = "1.6.1"
+  s.version = "1.6.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["nov matake"]
@@ -86,14 +86,14 @@ Gem::Specification.new do |s|
     "lib/fb_graph/friend_list.rb",
     "lib/fb_graph/group.rb",
     "lib/fb_graph/insight.rb",
+    "lib/fb_graph/klass.rb",
     "lib/fb_graph/link.rb",
     "lib/fb_graph/location.rb",
     "lib/fb_graph/message.rb",
     "lib/fb_graph/node.rb",
     "lib/fb_graph/note.rb",
     "lib/fb_graph/page.rb",
-    "lib/fb_graph/page/categories.rb",
-    "lib/fb_graph/page/categories/local_business.rb",
+    "lib/fb_graph/page/category_attributes.rb",
     "lib/fb_graph/photo.rb",
     "lib/fb_graph/place.rb",
     "lib/fb_graph/post.rb",
@@ -131,6 +131,10 @@ Gem::Specification.new do |s|
     "spec/fake_json/events/noreply/smartday_private.json",
     "spec/fake_json/groups/members/emacs_private.json",
     "spec/fake_json/pages/categories/local_business.json",
+    "spec/fake_json/pages/categories/movie.json",
+    "spec/fake_json/pages/categories/music.json",
+    "spec/fake_json/pages/categories/person.json",
+    "spec/fake_json/pages/categories/product.json",
     "spec/fake_json/pages/checkins/gowalla_private.json",
     "spec/fake_json/pages/checkins/gowalla_public.json",
     "spec/fake_json/pages/insights/FbGraph_private.json",
@@ -282,7 +286,11 @@ Gem::Specification.new do |s|
     "spec/fb_graph/message_spec.rb",
     "spec/fb_graph/node_spec.rb",
     "spec/fb_graph/note_spec.rb",
-    "spec/fb_graph/page/categories/local_business_spec.rb",
+    "spec/fb_graph/page/local_business_spec.rb",
+    "spec/fb_graph/page/movie_spec.rb",
+    "spec/fb_graph/page/music_spec.rb",
+    "spec/fb_graph/page/person_spec.rb",
+    "spec/fb_graph/page/product_spec.rb",
     "spec/fb_graph/page_spec.rb",
     "spec/fb_graph/photo_spec.rb",
     "spec/fb_graph/place_spec.rb",
@@ -374,7 +382,11 @@ Gem::Specification.new do |s|
     "spec/fb_graph/message_spec.rb",
     "spec/fb_graph/node_spec.rb",
     "spec/fb_graph/note_spec.rb",
-    "spec/fb_graph/page/categories/local_business_spec.rb",
+    "spec/fb_graph/page/local_business_spec.rb",
+    "spec/fb_graph/page/movie_spec.rb",
+    "spec/fb_graph/page/music_spec.rb",
+    "spec/fb_graph/page/person_spec.rb",
+    "spec/fb_graph/page/product_spec.rb",
     "spec/fb_graph/page_spec.rb",
     "spec/fb_graph/photo_spec.rb",
     "spec/fb_graph/place_spec.rb",

data/lib/fb_graph/album.rb

@@ -1,98 +1,4 @@
 module FbGraph
-  # = Authentication
-  #
-  # * Access token is required to fetch album info.
-  #
-  # = Attributes
-  #
-  # +from+::         FbGraph::User or FbGraph::Page
-  # +name+::         String
-  # +description+::  String
-  # +location+::     String <em>ex.) "NYC"</em>
-  # +link+::         String
-  # +privacy+::      String <em>ex.) "everyone"</em>
-  # +count+::        Integer
-  # +type+::         String <em>ex.) "normal"</em>
-  # +created_time+:: Time (UTC)
-  # +updated_time+:: Time (UTC)
-  #
-  # = Connections
-  #
-  # +photos+::   Array of FbGraph::Photo
-  # +comments+:: Array of FbGraph::Comment
-  # +likes+::    Array of FbGraph::Page
-  #
-  # = Examples
-  #
-  # == Fetch album info
-  #
-  #   album = FbGraph::Album.new(ALBUM_ID)
-  #   album.fetch(:access_token => ACCESS_TOKEN)
-  #
-  # or
-  #
-  #   FbGraph::album.fetch(ALBUM_ID, :access_token => ACCESS_TOKEN)
-  #
-  # == Fetch connection
-  #
-  #   photos = album.photos
-  #   likes = album.likes
-  #   comments = album.comments
-  #
-  # === Pagination
-  #
-  #   photos = album.photos
-  #   photos_next = photos.next
-  #   photos_previous = photos.previous
-  #   photos = album.photos(:since => '2010-09-01', :until => '2010-10-01')
-  #   photos = album.photos(:offset => 20, :limit => 20)
-  #
-  # == Creat new album
-  #
-  # See RDoc for FbGraph::Connections::Albums
-  #
-  # == Upload a photo
-  #
-  #   album.photo!(
-  #     :image => File.new(File.join(File.dirname(__FILE__), 'nov.gif')),
-  #     :name => "name",
-  #     :message => 'message'
-  #   )
-  #
-  # == Post a comment
-  #
-  #   album.comment!(
-  #     :access_token => ACCESS_TOKEN,
-  #     :message => 'Hey, I\'m testing you!'
-  #   )
-  #
-  # == Delete a comment
-  #
-  #   comment = album.comments.last
-  #   comment.destroy
-  #
-  # == Like and unlike
-  #
-  #   album.like!
-  #   album.unlike!
-  #
-  # = Notes
-  #
-  # == Attribute +from+
-  #
-  # Both facebook user and page can have albums, so +from+ can be either FbGraph::User or FbGraph::Page.
-  # * When you called +ablums+ connection of FbGraph::User, all +from+ should be FbGraph::User.
-  # * When you called +ablums+ connection of FbGraph::Page, all +from+ should be FbGraph::Page.
-  # * When you fetched an album by objedt id, +from+ can be either FbGraph::User or FbGraph::Page.
-  #
-  # == Cached +comments+
-  #
-  # When album object fetched, several comments are included in the response.
-  # So first time you called +album.comments+, those cached comments will be returned.
-  # If you put any option parameter like +album.comments(:access_token => ACCESS_TOKEN)+,
-  # fb_graph ignores those cached comments and fetch comments via Graph API.
-  #
-  # <em>If cached "album.comments" are blank, probably the album has no comments yet.</em>
   class Album < Node
     include Connections::Photos
     include Connections::Comments

data/lib/fb_graph/application.rb

@@ -26,23 +26,6 @@ module FbGraph
       @secret       = attributes[:secret]
     end
 
-    # == Get OAuth access token
-    # 
-    # Obtain an OAuth access token associated with your application via the OAuth Client Credentials Flow.
-    # 
-    # ref) http://developers.facebook.com/docs/api#analytics
-    # 
-    #   app = FbGraph::Application.new(APP_ID)
-    #   app.get_access_token
-    #   # => access token as String
-    #   app.access_token # once get_access_token is called, access token is cached.
-    #   # => access token as String
-    # 
-    # This method is automatically called when access token needed and application secret has already given.
-    # 
-    #   app = FbGraph::Application.new(APP_ID, :secret => APP_SECRET)
-    #   app.subscriptions # get_access_token is called automatically
-    #   # => Array of FbGraph::Subscription
     def get_access_token(secret = nil)
       self.secret ||= secret
       auth = Auth.new(self.identifier, self.secret)

data/lib/fb_graph/auth.rb

@@ -1,19 +1,4 @@
 module FbGraph
-  # = Parse & verify facebook auth cookie
-  # 
-  # Used with Facebook JavaScript SDK
-  # 
-  #   app = FbGraph::Auth.new(APP_ID, APP_SECRET)
-  #   app.from_cookie(cookie_hash)
-  #   auth.access_token
-  #   # => OAuth2::AccessToken (not String!)
-  #   auth.user # only initialized
-  #   auth.user.fetch # fetch whole profile
-  # 
-  # This method is called automatically if cookie is given when initializing
-  # 
-  #   auth = FbGraph::Auth.new(APP_ID, APP_SECRET, :cookie => {..})
-  #   auth.access_token # already parsed
   class Auth
     class VerificationFailed < Exception; end
 

data/lib/fb_graph/checkin.rb

@@ -34,13 +34,7 @@ module FbGraph
       end
     end
 
-    # == Search for recent check-ins for an authorized user and his or her friends:
-    # 
-    #   FbGraph::Checkin.search(:access_token => ACCESS_TOKEN)
-    #   # => Array of FbGraph::Checkin
     def self.search(options = {})
-      # NOTE:
-      # checkin search doesn't support "q=***" parameter
       super(nil, options)
     end
   end

data/lib/fb_graph/connections/accounts.rb

@@ -1,50 +1,5 @@
 module FbGraph
   module Connections
-    # = What's "accounts"?
-    #
-    # Pages owned by the current user.
-    #
-    # ref) http://developers.facebook.com/docs/api#impersonation
-    #
-    # = Authentication
-    #
-    # * Access token is required.
-    # * "manage_pages" permission is optional.
-    #
-    # If the "manage_pages" permission has been granted,
-    # this connection also yields access_tokens that can be used to query the Graph API on behalf of the page.
-    #
-    # ref) http://developers.facebook.com/docs/reference/api/user
-    #
-    # = Connected with
-    #
-    # * FbGraph::User
-    #
-    # == Fetch
-    #
-    #   pages = FbGraph::User.me(ACCESS_TOKEN).accounts
-    #   # => array of FbGraph::Page
-    #   pages.first.access_token
-    #   # => String if "manage_pages" permission has been granted, nil if not.
-    #
-    # = Notes
-    #
-    # == Access token of the page
-    #
-    # Using given access token, you can do those things as the page, not as yourself.
-    #
-    # * update the page's wall
-    # * create new page's album and upload photos into it
-    # * create and manage an event
-    # * etc.
-    #
-    # See RDoc for FbGraph::Page for more details.
-    #
-    #   page = FbGraph::User.me(ACCESS_TOKEN).accounts.first
-    #   page.access_token
-    #   # => given because "manage_pages" permission has been granted.
-    #   page.feed!(:message => 'Updating via FbGraph')
-    #   # => update the page's wall, not the user's wall
     module Accounts
       def accounts(options = {})
         accounts = self.connection(:accounts, options)

data/lib/fb_graph/connections/albums.rb

@@ -1,80 +1,5 @@
 module FbGraph
   module Connections
-    # = Authentication
-    #
-    # * Access token is required to fetch/create albums.
-    # * "publish_stream" permissin is required to create new album.
-    #
-    # = Connected with
-    #
-    # * FbGraph::Application
-    # * FbGraph::USer
-    # * FbGraph::Page
-    #
-    # = Example
-    #
-    # == Fetch albums
-    #
-    #   me = FbGraph::User.me(ACCESS_TOKEN)
-    #   me.albums
-    #   # => Array of FbGraph::Album
-    #
-    #   page = FbGraph::Page.new('fb_graph')
-    #   page.albums
-    #   # => Array of FbGraph::Album
-    #
-    # == Create an album
-    #
-    #   me = FbGraph::User.me(ACCESS_TOKEN)
-    #   album = me.album!(
-    #     :name => 'FbGraph test',
-    #     :message => 'hello world!',
-    #     :description => 'hello world!'
-    #   )
-    #
-    #   page = FbGraph::Page.new('fb_graph', :access_token => ACCESS_TOKEN)
-    #   album = page.album!(
-    #     :name => 'FbGraph test',
-    #     :message => 'hello world!',
-    #     :description => 'hello world!'
-    #   )
-    #
-    # = Notes
-    #
-    # == Attributes after created
-    #
-    # Only attributes you specified are saved in the created album object.
-    # If you want to access any other attributes, you need to fetch the album info via Graph API.
-    #
-    #   me = FbGraph::User.me(ACCESS_TOKEN)
-    #   album = me.album!(
-    #     :name => 'FbGraph test',
-    #     :message => 'hello world!',
-    #     :description => 'hello world!'
-    #   )
-    #   album.name # => 'FbGraoh test'
-    #   album.from # => nil
-    #   album.created_time # => nil
-    #   album.fetch
-    #   album.from # => me
-    #   album.created_time # => Sun Sep 12 01:18:36 +0900 2010
-    #
-    # == Bug of Graph API
-    #
-    # According facebook's document, the key for +description+ should be +description+ both when fetching and creating,
-    # but actually you need to use +message+ instead of +description+ only when creating.
-    # It probably facebook's bug, and it might be fixed suddenly.
-    # I highly recommend to send same value both as +description+ and +message+ when creating,
-    # then your code will work without any code change.
-    #
-    # ref) http://developers.facebook.com/docs/reference/api/album
-    #
-    #   me = FbGraph::User.me(ACCESS_TOKEN)
-    #   album = me.album!(
-    #     :name => 'FbGraph test',
-    #     :message => 'hello world!',
-    #     :description => 'hello world!'
-    #   )
     module Albums
       def albums(options = {})
         albums = self.connection(:albums, options)

data/lib/fb_graph/connections/checkins.rb

@@ -1,13 +1,5 @@
 module FbGraph
   module Connections
-    # == Fetch checkins
-    # 
-    # * To get a user's check-ins, request the "user_checkins".
-    # * To see the user's friends' check-ins, request the "friends_checkins". 
-    # ref) http://developers.facebook.com/docs/api#places
-    # 
-    #   FbGraph::User.new("matake").checkins(:access_token => ACCESS_TOKEN)
-    #   FbGraph::Page.new("Tokyo").checkins(:access_token => ACCESS_TOKEN)
     module Checkins
       def checkins(options = {})
         checkins = self.connection(:checkins, options)

data/lib/fb_graph/connections/feed.rb

@@ -1,32 +1,6 @@
 module FbGraph
   module Connections
     module Feed
-      # == Fetching Wall posts
-      # 
-      # === User Wall
-      # 
-      #   FbGraph::User.new(username).feed
-      #   # => Array of FbGraph::Post
-      # 
-      # === Page Wall
-      # 
-      #   FbGraph::Page.new(page_id).feed
-      #   # => Array of FbGraph::Post
-      # 
-      # === Application Wall
-      # 
-      #   FbGraph::Application.new(page_id).feed
-      #   # => Array of FbGraph::Post
-      # 
-      # === Event Wall
-      # 
-      #   FbGraph::Event.new(page_id).feed
-      #   # => Array of FbGraph::Post
-      # 
-      # === Group Wall
-      # 
-      #   FbGraph::Group.new(page_id).feed
-      #   # => Array of FbGraph::Post
       def feed(options = {})
         posts = self.connection(:feed, options)
         posts.map! do |post|
@@ -36,49 +10,6 @@ module FbGraph
         end
       end
 
-      # == Updating Wall
-      # 
-      # * See supported arguments here http://developers.facebook.com/docs/reference/api/post
-      # * You need admin user's access_token to update Page/Application/Event/Group wall as itself
-      # 
-      # === User Wall
-      # 
-      #   me = FbGraph::User.me(ACCESS_TOKEN)
-      #   me.feed!(
-      #     :message => 'Updating via FbGraph'
-      #   )
-      # 
-      # === Page Wall
-      # 
-      #   page = FbGraph::Page.new(page_id)
-      #   page.feed!(
-      #     :access_token => ACCESS_TOKEN,
-      #     :message => 'Updating via FbGraph'
-      #   )
-      # 
-      # === Application Wall
-      # 
-      #   application = FbGraph::Page.new(application_id)
-      #   application.feed!(
-      #     :access_token => ACCESS_TOKEN,
-      #     :message => 'Updating via FbGraph'
-      #   )
-      # 
-      # === Event Wall
-      # 
-      #   event = FbGraph::Event.new(event_id)
-      #   event.feed!(
-      #     :access_token => ACCESS_TOKEN,
-      #     :message => 'Updating via FbGraph'
-      #   )
-      # 
-      # === Group Wall
-      # 
-      #   group = FbGraph::Group.new(group_id)
-      #   group.feed!(
-      #     :access_token => ACCESS_TOKEN,
-      #     :message => 'Updating via FbGraph'
-      #   )
       def feed!(options = {})
         post = post(options.merge(:connection => :feed))
         Post.new(post.delete(:id), options.merge(post).merge(

data/lib/fb_graph/education.rb

@@ -23,7 +23,7 @@ module FbGraph
       @classes = []
       if attributes[:classes]
         attributes[:classes].each do |klass|
-          @classes << Page.new(klass.delete(:id), klass)
+          @classes << Klass.new(klass.delete(:id), klass)
         end
       end
       @type = attributes[:type]

data/lib/fb_graph/klass.rb

@@ -0,0 +1,31 @@
+module FbGraph
+  class Klass < Page
+    attr_accessor :with, :start_date, :end_date
+
+    def initialize(identifier, attributes = {})
+      super
+      @with = []
+      if attributes[:with]
+        attributes[:with].each do |user|
+          @with << User.new(user.delete(:id), user)
+        end
+      end
+      if attributes[:start_date]
+        year, month = attributes[:start_date].split('-').collect(&:to_i)
+        @start_date = if month.blank? || month == 0
+          Date.new(year)
+        else
+          Date.new(year, month)
+        end
+      end
+      if attributes[:end_date]
+        year, month = attributes[:end_date].split('-').collect(&:to_i)
+        @end_date = if month.blank? || month == 0
+          Date.new(year)
+        else
+          Date.new(year, month)
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph/page/category_attributes.rb

@@ -0,0 +1,108 @@
+module FbGraph
+  class Page
+    module CategoryAttributes
+      @@attributes = {}
+      @@attributes[:raw] = [
+        :affiliation,
+        :artists_we_like,
+        :attire,
+        :awards,
+        :band_interests,
+        :band_members,
+        :bio,
+        :booking_agent,
+        :can_post,
+        :company_overview,
+        :culinary_team,
+        :current_location,
+        :directed_by,
+        :features,
+        :general_info,
+        :general_manager,
+        :genre,
+        :influences,
+        :is_community_page,
+        :link,
+        :location,
+        :mission,
+        :mpg,
+        :personal_info,
+        :personal_interests,
+        :phone,
+        :plot_outline,
+        :press_contact,
+        :price_range,
+        :produced_by,
+        :products,
+        :public_transit,
+        :record_label,
+        :screenplay_by,
+        :starring,
+        :studio,
+        :website,
+        :written_by
+      ]
+      @@attributes[:symbols] = [
+        :parking,
+        :payment_options,
+        :restaurant_services,
+        :restaurant_specialties
+      ]
+      @@attributes[:date] = [
+        :birthday,
+        :built,
+        :founded,
+        :release_date
+      ]
+      @@attributes[:others] = [
+        :checkin_count,
+        :hours,
+        :location
+      ]
+      attr_accessor *@@attributes.values.flatten
+
+      def self.included(klass)
+        klass.alias_method_chain :initialize, :category_specific_attributes
+      end
+
+      def initialize_with_category_specific_attributes(identifier, attributes = {})
+        initialize_without_category_specific_attributes identifier, attributes
+        @@attributes[:raw].each do |key|
+          self.send :"#{key}=", attributes[key]
+        end
+        @@attributes[:symbols].each do |key|
+          self.send :"#{key}=", []
+          if attributes[key]
+            self.send :"#{key}=", attributes[key].keys.collect(&:to_sym)
+          end
+        end
+        @@attributes[:date].each do |key|
+          if attributes[key]
+            value = Date.parse(attributes[key]) rescue attributes[key]
+            self.send :"#{key}=", value
+          end
+        end
+        @checkin_count = attributes[:checkins]
+        @hours = {}
+        if attributes[:hours]
+          utc_beginning_of_day = Time.now.utc.beginning_of_day
+          attributes[:hours].each do |key, value|
+            date, index, mode = key.split('_')
+            index = index.to_i - 1
+            date, mode = date.to_sym, mode.to_sym
+            time = value.since(utc_beginning_of_day)
+            time = Time.utc(1970, 1, 1, time.hour, time.min)
+            @hours[date] ||= []
+            @hours[date][index] ||= {}
+            @hours[date][index][mode] = time
+          end
+        end
+        if attributes[:location]
+          @location = Venue.new(attributes[:location])
+        end
+      end
+    end
+
+    include CategoryAttributes
+  end
+end

data/lib/fb_graph/page.rb

@@ -16,45 +16,16 @@ module FbGraph
     include Connections::Videos
     extend Searchable
 
-    attr_accessor :name, :username, :link, :category, :founded, :can_post, :is_community_page, :company_overview, :general_info, :mission, :products, :public_transit, :release_date, :location, :website, :websites, :like_count, :checkin_count, :with, :created_time
+    attr_accessor :name, :username, :category, :like_count
 
     def initialize(identifier, attributes = {})
       super
-      @name     = attributes[:name]
-      @username = attributes[:username]
-      @link     = attributes[:link]
-      @category = attributes[:category]
-      if (founded = attributes[:founded])
-        @founded = Date.parse(founded) rescue Date.new(founded.to_i)
-      end
-      @can_post = attributes[:can_post]
-      @is_community_page = attributes[:is_community_page]
-      @company_overview = attributes[:company_overview]
-      @general_info = attributes[:general_info]
-      @mission = attributes[:mission]
-      @products = attributes[:products]
-      @public_transit = attributes[:public_transit]
-      if (release_date = attributes[:release_date])
-        @release_date = Date.parse(release_date) rescue release_date
-      end
-      if (location = attributes[:location])
-        @location = Venue.new(location)
-      end
-      @website = attributes[:website]
-      @websites = attributes[:website].to_s.split
-      @like_count = attributes[:likes]
-      @checkin_count = attributes[:checkins]
-      @with = []
-      if attributes[:with]
-        attributes[:with].each do |user|
-          @with << User.new(user.delete(:id), user)
-        end
-      end
-      if attributes[:created_time]
-        @created_time = Time.parse(attributes[:created_time]).utc
+      [:name, :username, :category].each do |key|
+        self.send :"#{key}=", attributes[key]
       end
+      @like_count = attributes[:likes] || attributes[:fan_count]
     end
   end
 end
 
-require 'fb_graph/page/categories'
+require 'fb_graph/page/category_attributes'

data/lib/fb_graph/project.rb

@@ -1,25 +1,4 @@
 module FbGraph
-  class Project < Page
-    attr_accessor :start_date, :end_date
-
-    def initialize(identifier, attributes = {})
-      super
-      if attributes[:start_date]
-        year, month = attributes[:start_date].split('-').collect(&:to_i)
-        @start_date = if month.blank? || month == 0
-          Date.new(year)
-        else
-          Date.new(year, month)
-        end
-      end
-      if attributes[:end_date]
-        year, month = attributes[:end_date].split('-').collect(&:to_i)
-        @end_date = if month.blank? || month == 0
-          Date.new(year)
-        else
-          Date.new(year, month)
-        end
-      end
-    end
+  class Project < Klass
   end
 end