fb_graph 2.1.7 → 2.1.8

data/VERSION

@@ -1 +1 @@
-2.1.7
+2.1.8

data/lib/fb_graph.rb

@@ -61,14 +61,17 @@ require 'fb_graph/venue'
 require 'fb_graph/work'
 
 require 'fb_graph/node'
+require 'fb_graph/achievement'
 require 'fb_graph/ad_account'
 require 'fb_graph/ad_campaign'
 require 'fb_graph/ad_campaign_stat'
+require 'fb_graph/ad_connection_object'
 require 'fb_graph/ad_group'
 require 'fb_graph/ad_group_stat'
 require 'fb_graph/ad_keyword'
 require 'fb_graph/ad_keyword_suggestion'
 require 'fb_graph/ad_keyword_valid'
+require 'fb_graph/broad_targeting_category'
 require 'fb_graph/reach_estimate.rb'
 require 'fb_graph/album'
 require 'fb_graph/app_request'
@@ -98,10 +101,13 @@ require 'fb_graph/tab'
 require 'fb_graph/tag'
 require 'fb_graph/thread'
 require 'fb_graph/user'
-require 'fb_graph/ad_user'
-require 'fb_graph/test_user' # Load after FbGraph::User
+require 'fb_graph/user_achievement'
 require 'fb_graph/video'
 
+# Load after FbGraph::User
+require 'fb_graph/ad_user'
+require 'fb_graph/test_user'
+
 require 'fb_graph/klass'
 require 'fb_graph/project'
 

data/lib/fb_graph/achievement.rb

@@ -0,0 +1,44 @@
+module FbGraph
+  class Achievement < Node
+    attr_accessor :type, :application, :title, :url, :description, :image, :images, :data, :updated_time, :context, :points, :display_order
+
+    def initialize(identifier, attributes = {})
+      super
+
+      # TODO: Handle data, context in smarter way.
+      [:type, :title, :url, :description, :data, :context].each do |key|
+        send "#{key}=", attributes[key]
+      end
+
+      if self.data
+        @points = self.data[:points]
+      end
+
+      if self.context
+        @display_order = self.context[:display_order]
+      end
+
+      @images = []
+      if _images_ = attributes[:image]
+        _images_.each do |_image_|
+          @images << _image_[:url]
+        end
+      end
+      @image = @images.first
+
+      if application = attributes[:application]
+        application[:link] = application[:url] # for some reason, FB uses "url" only here..
+        @application = Application.new(application[:id], application)
+      end
+
+      if attributes[:updated_time]
+        @updated_time = Time.parse(attributes[:updated_time]).utc
+      end
+    end
+
+    def destroy(options = {})
+      options[:access_token] ||= self.access_token
+      application.unregister_achievement!(url, options)
+    end
+  end
+end

data/lib/fb_graph/ad_account.rb

@@ -4,7 +4,9 @@ module FbGraph
     include Connections::AdGroups
     include Connections::AdCampaignStats
     include Connections::AdGroupStats
+    include Connections::BroadTargetingCategories
     include Connections::ReachEstimates
+    include Connections::AdConnectionObjects
 
     attr_accessor :account_id, :name, :account_status, :daily_spend_limit, :users, :currency, :timezone_id, :timezone_name, :capabilities, :account_groups
 

data/lib/fb_graph/ad_connection_object.rb

@@ -0,0 +1,38 @@
+module FbGraph
+  class AdConnectionObject < Node
+    attr_accessor :name, :url, :type, :tabs, :picture, :object
+
+    TYPES = {
+      :page => 1,
+      :application => 2,
+      :event => 3,
+      :place => 6,
+      :domain => 7
+    }
+
+    def initialize(identifier, attributes = {})
+      super
+
+      %w(name url type tabs picture).each do |field|
+        send("#{field}=", attributes[field.to_sym])
+      end
+
+      self.object = if page?
+        FbGraph::Page.new(identifier)
+      elsif application?
+        FbGraph::Application.new(identifier)
+      elsif event?
+        FbGraph::Event.new(identifier)
+      elsif place?
+        FbGraph::Place.new(identifier)
+      elsif domain?
+        FbGraph::Domain.new(identifier)
+      end
+    end
+
+    # Defines methods for page?, application?, event? and so forth
+    TYPES.keys.each do |object_type|
+      define_method("#{object_type}?") { type == TYPES[object_type] }
+    end
+  end
+end

data/lib/fb_graph/application.rb

@@ -1,6 +1,7 @@
 module FbGraph
   class Application < Node
     include Connections::Accounts
+    include Connections::Achievements
     include Connections::Albums
     include Connections::Events
     include Connections::Feed
@@ -20,15 +21,35 @@ module FbGraph
     # include Connections::Translations
     include Connections::Videos
 
-    attr_accessor :name, :description, :category, :link, :secret
+    @@attributes = [
+      :name,
+      :description,
+      :canvas_name,
+      :category,
+      :company,
+      :icon_url,
+      :subcategory,
+      :link,
+      :logo_url,
+      :daily_active_users,
+      :weekly_active_users,
+      :monthly_active_users,
+      :secret
+    ]
+    attr_accessor *@@attributes
 
     def initialize(client_id, attributes = {})
       super
-      @name         = attributes[:name]
-      @description  = attributes[:description]
-      @category     = attributes[:category]
-      @link         = attributes[:link]
-      @secret       = attributes[:secret]
+      @@attributes.each do |key|
+        # NOTE:
+        # For some reason, Graph API returns daily_active_users, weekly_active_users, monthly_active_users as JSON string.
+        value = if [:daily_active_users, :weekly_active_users, :monthly_active_users].include?(key)
+          attributes[key].to_i
+        else
+          attributes[key]
+        end
+        self.send("#{key}=", value)
+      end
     end
 
     def get_access_token(secret = nil)

data/lib/fb_graph/broad_targeting_category.rb

@@ -0,0 +1,13 @@
+module FbGraph
+  class BroadTargetingCategory < Node
+    attr_accessor :name, :parent_category
+
+    def initialize(identifier, attributes = {})
+      super
+
+      %w(name parent_category).each do |field|
+        self.send("#{field}=", attributes[field.to_sym])
+      end
+    end
+  end
+end

data/lib/fb_graph/connections/achievements.rb

@@ -0,0 +1,21 @@
+module FbGraph
+  module Connections
+    module Achievements
+      def achievements(options = {})
+        options[:access_token] ||= self.access_token
+        achievements = self.connection(:achievements, options)
+        achievements.map! do |achievement|
+          Achievement.new(achievement[:id], achievement.merge(:access_token => options[:access_token]))
+        end
+      end
+
+      def achievement!(achievement_url, options = {})
+        post options.merge(:connection => :achievements, :achievement => achievement_url)
+      end
+
+      def unregister_achievement!(achievement_url, options = {})
+        delete options.merge(:connection => :achievements, :achievement => achievement_url)
+      end
+    end
+  end
+end

data/lib/fb_graph/connections/ad_connection_objects.rb

@@ -0,0 +1,14 @@
+module FbGraph
+  module Connections
+    module AdConnectionObjects
+      def connection_objects(options = {})
+        connection_objects = self.connection(:connectionobjects, options)
+        connection_objects.map! do |connection_object|
+          AdConnectionObject.new(connection_object[:id], connection_object.merge(
+            :access_token => options[:access_token] || self.access_token
+          ))
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph/connections/broad_targeting_categories.rb

@@ -0,0 +1,14 @@
+module FbGraph
+  module Connections
+    module BroadTargetingCategories
+      def broad_targeting_categories(options = {})
+        broad_targeting_categories = self.connection(:broadtargetingcategories, options)
+        broad_targeting_categories.map! do |btc|
+          BroadTargetingCategory.new(btc[:id], btc.merge(
+            :access_token => options[:access_token] || self.access_token
+          ))
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph/connections/mutual_friends.rb

@@ -0,0 +1,22 @@
+module FbGraph
+  module Connections
+    module MutualFriends
+      def mutual_friends(friend, options = {})
+        friends = self.connection(:mutualfriends, options.merge(:connection_scope => connection_scope(friend)))
+        friends.map! do |friend|
+          User.new(friend[:id], friend.merge(:access_token => options[:access_token] || self.access_token))
+        end
+      end
+
+      private
+
+      def connection_scope(friend)
+        if friend.is_a?(User)
+          friend.identifier
+        else
+          friend
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph/connections/user_achievements.rb

@@ -0,0 +1,22 @@
+module FbGraph
+  module Connections
+    module UserAchievements
+      def achievements(options = {})
+        options[:access_token] ||= self.access_token
+        achievements = self.connection(:achievements, options)
+        achievements.map! do |achievement|
+          UserAchievement.new(achievement[:id], achievement.merge(:access_token => options[:access_token]))
+        end
+      end
+
+      def achieve!(achievement_url, options = {})
+        achievement = post options.merge(:connection => :achievements, :achievement => achievement_url)
+        UserAchievement.new achievement[:id], achievement
+      end
+
+      def unachieve!(achievement_url, options = {})
+        delete options.merge(:connection => :achievements, :achievement => achievement_url)
+      end
+    end
+  end
+end

data/lib/fb_graph/exception.rb

@@ -1,6 +1,40 @@
 module FbGraph
   class Exception < StandardError
     attr_accessor :code, :type, :message
+
+    ERROR_HEADER_MATCHERS = {
+      /invalid_token/ => "InvalidToken",
+      /invalid_request/ => "InvalidRequest"
+    }
+
+    def self.handle_httpclient_error(response, headers)
+      return nil unless response[:error]
+
+      # Check the WWW-Authenticate header, since it seems to be more standardized than the response
+      # body error information.
+      if www_authenticate = headers["WWW-Authenticate"]
+        # Session expiration/invalidation is very common. Check for that first.
+        if www_authenticate =~ /invalid_token/ && response[:error][:message] =~ /session has been invalidated/
+          raise InvalidSession.new("#{response[:error][:type]} :: #{response[:error][:message]}")
+        end
+
+        ERROR_HEADER_MATCHERS.keys.each do |matcher|
+          if matcher =~ www_authenticate
+            exception_class = FbGraph::const_get(ERROR_HEADER_MATCHERS[matcher])
+            raise exception_class.new("#{response[:error][:type]} :: #{response[:error][:message]}")
+          end
+        end
+      end
+
+      # If we can't match on WWW-Authenticate, use the type
+      case response[:error][:type]
+      when /OAuth/
+        raise Unauthorized.new("#{response[:error][:type]} :: #{response[:error][:message]}")
+      else
+        raise BadRequest.new("#{response[:error][:type]} :: #{response[:error][:message]}")
+      end
+    end
+
     def initialize(code, message, body = '')
       @code = code
       if body.blank?
@@ -30,4 +64,10 @@ module FbGraph
       super 404, message, body
     end
   end
-end
+
+  class InvalidToken < Unauthorized; end
+
+  class InvalidSession < InvalidToken; end
+
+  class InvalidRequest < BadRequest; end
+end

data/lib/fb_graph/node.rb

@@ -120,21 +120,12 @@ module FbGraph
           _response_.map!(&:with_indifferent_access)
         when Hash
           _response_ = _response_.with_indifferent_access
-          handle_httpclient_error(_response_) if _response_[:error]
+          Exception.handle_httpclient_error(_response_, response.headers) if _response_[:error]
           _response_
         end
       end
     rescue JSON::ParserError
       raise Exception.new(response.status, 'Unparsable Error Response')
     end
-
-    def handle_httpclient_error(response)
-      case response[:error][:type]
-      when /OAuth/
-        raise Unauthorized.new("#{response[:error][:type]} :: #{response[:error][:message]}")
-      else
-        raise BadRequest.new("#{response[:error][:type]} :: #{response[:error][:message]}")
-      end
-    end
   end
-end
+end

data/lib/fb_graph/user.rb

@@ -22,6 +22,7 @@ module FbGraph
     include Connections::Links
     include Connections::Movies
     include Connections::Music
+    include Connections::MutualFriends
     include Connections::Notes
     include Connections::Outbox
     include Connections::Payments
@@ -33,6 +34,7 @@ module FbGraph
     include Connections::Tagged
     include Connections::Television
     include Connections::Threads
+    include Connections::UserAchievements
     include Connections::Videos
     extend Searchable
 

data/lib/fb_graph/user_achievement.rb

@@ -0,0 +1,35 @@
+module FbGraph
+  class UserAchievement < Node
+    include Connections::Comments
+    include Connections::Likes
+
+    attr_accessor :from, :created_time, :application, :achievement
+
+    def initialize(identifier, attributes = {})
+      super
+
+      if from = attributes[:from]
+        @from = User.new(from[:id], from)
+      end
+      if created_time = attributes[:created_time] || attributes[:publish_time]
+        @created_time = Time.parse(created_time).utc
+      end
+      if application = attributes[:application]
+        application[:link] = application[:url] # for some reason, FB uses "url" only here..
+        @application = Application.new(application[:id], application)
+      end
+      if achievement = attributes[:achievement]
+        @achievement = Achievement.new(achievement[:id], achievement)
+      end
+
+      # cached connection
+      @_likes_ = Collection.new(attributes[:likes])
+      @_comments_ = Collection.new(attributes[:comments])
+    end
+
+    def destroy(options = {})
+      options[:access_token] ||= self.access_token
+      from.unachieve!(achievement.url, options)
+    end
+  end
+end

data/spec/fb_graph/achievement_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe FbGraph::Achievement do
+  subject { achievement }
+  let(:achievement) { FbGraph::Achievement.new(attributes[:id], attributes) }
+  let(:attributes) do
+    {
+      :id => "10150310611431721",
+      :url => "http:\/\/fbgraphsample.heroku.com\/achievements\/1",
+      :type => "game.achievement",
+      :title => "1st Achievement",
+      :image => [{
+        :url => "http:\/\/matake.jp\/images\/nov.gif"
+      }],
+      :description => "For testing purpose",
+      :data => {
+        :points => 50
+      },
+      :updated_time => "2011-09-27T08:06:59+0000",
+      :application => {
+        :id => "134145643294322",
+        :name => "gem sample",
+        :url => "http:\/\/www.facebook.com\/apps\/application.php?id=134145643294322"
+      },
+      :context => {
+        :display_order => 0
+      }
+    }
+  end
+
+  [:type, :title, :url, :description, :data, :context].each do |key|
+    its(key) { should == attributes[key] }
+  end
+
+  its(:image) { should == attributes[:image].first[:url] }
+  its(:images) { should == attributes[:image].collect { |h| h[:url] } }
+  its(:points) { should == 50 }
+  its(:display_order) { should == 0 }
+  its(:updated_time) { should == Time.parse(attributes[:updated_time]).utc }
+  describe 'application' do
+    subject { achievement.application }
+    its(:name) { should == attributes[:application][:name] }
+    its(:link) { should == attributes[:application][:url] }
+  end
+
+  describe '#destroy' do
+    it 'should call DELETE /:app_id/achievements' do
+      expect { achievement.destroy }.should request_to('134145643294322/achievements', :delete)
+    end
+
+    it 'should delete achievement' do
+      mock_graph :delete, '134145643294322/achievements', 'true', :access_token => 'app_token', :params => {
+        :achievement => achievement.url
+      } do
+        achievement.destroy(:access_token => 'app_token').should be_true
+      end
+    end
+  end
+end