fb_graph2 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aada3bb0f27460fa19a74601046d482a0d08117
-  data.tar.gz: 5c7342702b69f58154689439912e73afca059111
+  metadata.gz: a3b9b96bd354676b41303ec71bb42e5a37f83e79
+  data.tar.gz: 353b8100ce89c4e3b96f832e209d4612357ff44a
 SHA512:
-  metadata.gz: a44c71b1317b8e3c537e17e7511a6a023f355fc7916a5620e113f0e2ee8c8643d990650e4e4bb18b7447570a41891ea201260d21b6d13bc8fe14039ec914b94e
-  data.tar.gz: 3956dcb25143d937db3b10597e79fbf72083b0348a7ec81ebe58ad6d271ea68857e2bea5113b868d5409fe7598ef6f3da7280a73e18b2d7c958929ac0d12e28d
+  metadata.gz: 215b26018c47fa99f1da5d3cd07caaf5ff2c62e15b2bcc289a02dfccd43bacdc0d29bb34706ab568c265189ea5bbc2508733a3cf8f69d3d144b3ebf63c57bc7e
+  data.tar.gz: 80c709b966450c3afeb9795b15a5aef28c420cde256bac977bb685654800270c14e27359f6a411769ef345a51b01288861654fbd567e488b9c83b4bcbde6c569

data/README.md

@@ -1,6 +1,6 @@
 # FbGraph2
 
-TODO: Write a gem description
+Similar to [fb_graph gem](https://github.com/nov/fb_graph), but supports Graph API v2.0+.
 
 ## Installation
 
@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See [fb_graph2 Wiki](https://github.com/nov/fb_graph2/wiki).
 
 ## Contributing
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/fb_graph2.rb

@@ -2,12 +2,13 @@ require 'active_support/all'
 require 'rack/oauth2'
 
 module FbGraph2
-  cattr_accessor :api_version, :gem_version, :logger, :debugging, :_http_config_
+  cattr_accessor :api_version, :gem_version, :logger, :debugging, :_http_config_, :object_classes
 
   self.api_version = 'v2.0'
   self.gem_version = File.read(File.join(__dir__, '../VERSION')).delete("\n\r")
   self.logger = Logger.new(STDOUT)
   self.logger.progname = 'FbGraph2'
+  self.object_classes = Array.new
 
   class << self
     def root_url

data/lib/fb_graph2/edge/admins.rb

@@ -0,0 +1,17 @@
+module FbGraph2
+  class Edge
+    module Admins
+      def admins(params = {})
+        users = self.edge :admins, params
+        users.collect do |user|
+          User.new(user[:id], user).authenticate self.access_token
+        end
+      end
+
+      def admin?(user, params = {})
+        users = self.edge :admins, params, edge_scope: user
+        users.present?
+      end
+    end
+  end
+end

data/lib/fb_graph2/edge/blocked.rb

@@ -0,0 +1,24 @@
+module FbGraph2
+  class Edge
+    module Blocked
+      def blocked(params = {})
+        users = self.edge :blocked, params
+        users.collect do |user|
+          User.new(user[:id], user).authenticate self.access_token
+        end
+      end
+
+      def block!(user, params = {})
+        self.post params.merge(
+          user_id: Util.as_identifier(user)
+        ), edge: :blocked
+      end
+
+      def unblock!(user, params = {})
+        self.delete params.merge(
+          user_id: Util.as_identifier(user)
+        ), edge: :blocked
+      end
+    end
+  end
+end

data/lib/fb_graph2/edge/comments.rb

@@ -1,8 +1,19 @@
 module FbGraph2
   class Edge
     module Comments
+      def assign(attributes)
+        super
+        if attributes.include?(:comments)
+          @_cached_comments = Collection.new attributes[:comments]
+        end
+      end
+
       def comments(params = {})
-        comments = self.edge :comments, params
+        comments = if @_cached_comments.present? && params.blank?
+          @_cached_comments
+        else
+          self.edge :comments, params
+        end
         comments.collect do |comment|
           Comment.new(comment[:id], comment).authenticate self.access_token
         end

data/lib/fb_graph2/edge/global_brand_children.rb

@@ -0,0 +1,12 @@
+module FbGraph2
+  class Edge
+    module GlobalBrandChildren
+      def global_brand_children(params = {})
+        pages = self.edge :global_brand_children, params
+        pages.collect do |page|
+          Page.new(page[:id], page).authenticate self.access_token
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph2/edge/likes.rb

@@ -9,15 +9,26 @@ module FbGraph2
           end
         end
 
-        def liked?(page_id, params = {})
-          pages = self.edge :likes, params, edge_scope: page_id
+        def liked?(page, params = {})
+          pages = self.edge :likes, params, edge_scope: page
           pages.present?
         end
       end
 
       module LikeeContext
+        def assign(attributes)
+          super
+          if attributes.include?(:likes)
+            @_cached_likes = Collection.new attributes[:likes]
+          end
+        end
+
         def likes(params = {})
-          users = self.edge :likes, params
+          users = if @_cached_likes.present? && params.blank?
+            @_cached_likes
+          else
+            self.edge :likes, params
+          end
           users.collect do |user|
             User.new(user[:id], user).authenticate self.access_token
           end

data/lib/fb_graph2/edge/locations.rb

@@ -0,0 +1,14 @@
+module FbGraph2
+  class Edge
+    module Locations
+      def locations(params = {})
+        pages = self.edge :locations, params
+        pages.collect do |page|
+          Page.new(page[:id], page).authenticate self.access_token
+        end
+      end
+
+      # TODO: add, delete and update locations
+    end
+  end
+end

data/lib/fb_graph2/edge/milestones.rb

@@ -0,0 +1,12 @@
+module FbGraph2
+  class Edge
+    module Milestones
+      def milestones(params = {})
+        milestones = self.edge :milestones, params
+        milestones.collect do |milestone|
+          Milestone.new(milestone[:id], milestone).authenticate self.access_token
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph2/edge/offers.rb

@@ -0,0 +1,12 @@
+module FbGraph2
+  class Edge
+    module Offers
+      def offers(params = {})
+        offers = self.edge :offers, params
+        offers.collect do |offer|
+          Offer.new(offer[:id], offer).authenticate self.access_token
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph2/edge/promotable_posts.rb

@@ -0,0 +1,12 @@
+module FbGraph2
+  class Edge
+    module PromotablePosts
+      def promotable_posts(params = {})
+        posts = self.edge :promotable_posts, params
+        posts.collect do |post|
+          Post.new(post[:id], post).authenticate self.access_token
+        end
+      end
+    end
+  end
+end

data/lib/fb_graph2/milestone.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Milestone < Node
+    register_attributes(
+      raw: [:title, :description],
+      time: [:created_time, :updated_time, :start_time, :end_time],
+      page: [:from]
+    )
+  end
+end

data/lib/fb_graph2/node.rb

@@ -4,6 +4,7 @@ module FbGraph2
 
     def self.inherited(klass)
       klass.include AttributeAssigner
+      FbGraph2.object_classes << klass
     end
 
     def initialize(id, attributes = {})
@@ -36,6 +37,12 @@ module FbGraph2
       )
     end
 
+    def edges
+      @edges ||= self.class.included_modules.select do |_module_|
+        _module_.name =~ /FbGraph2::Edge/
+      end.collect(&:instance_methods).sort
+    end
+
     def destroy(params = {}, options = {})
       delete params, options
     end
@@ -75,7 +82,7 @@ module FbGraph2
       File.join [
         File.join(FbGraph2.root_url, id.to_s),
         options[:edge],
-        options[:edge_scope]
+        Util.as_identifier(options[:edge_scope])
       ].compact.collect(&:to_s)
     end
 

data/lib/fb_graph2/offer.rb

@@ -0,0 +1,10 @@
+module FbGraph2
+  class Offer < Node
+    register_attributes(
+      raw: [:claim_limit, :coupon_type, :image_url, :published, :redemption_code, :redemption_link, :terms, :title, :message],
+      time: [:created_time, :expiration_time, :reminder_time],
+      timestamp: [:scheduled_publish_time],
+      page: [:from]
+    )
+  end
+end

data/lib/fb_graph2/page.rb

@@ -1,5 +1,23 @@
 module FbGraph2
   class Page < Node
+    include Edge::Admins
+    include Edge::Albums
+    include Edge::Blocked
+    include Edge::Events
+    include Edge::Feed
+    include Edge::GlobalBrandChildren
+    include Edge::Links
+    include Edge::Locations
+    include Edge::Milestones
+    include Edge::Offers
+    include Edge::Picture
+    include Edge::Photos
+    include Edge::Posts
+    include Edge::PromotablePosts
+    include Edge::Statuses
+    include Edge::Tagged
+    include Edge::Videos
+
     register_attributes(
       raw: [
         :about, :attire, :band_members, :booking_agent, :can_post, :category, :checkins, :company_overview,

data/lib/fb_graph2/photo.rb

@@ -1,5 +1,8 @@
 module FbGraph2
   class Photo < Node
+    include Edge::Comments
+    include Edge::Likes::LikeeContext
+
     register_attributes(
       raw: [
         :backdated_time_granularity, :height, :icon, :link, :name, :page_story_id, :picture, :position, :source, :width,

data/lib/fb_graph2/post.rb

@@ -1,6 +1,8 @@
 module FbGraph2
   class Post < Node
+    include Edge::Comments
     include Edge::Likes::LikeeContext
+    include Edge::SharedPosts
 
     register_attributes(
       raw: [

data/lib/fb_graph2/user.rb

@@ -36,7 +36,9 @@ module FbGraph2
         :middle_name, :name, :name_format, :political, :quotes, :relationship_status, :religion,
         :timezone, :third_party_id, :verified, :website,
         # NOTE: in family edge context
-        :relationship
+        :relationship,
+        # NOTE: in page admin context
+        :perms, :role
       ],
       time: [:updated_time], # NOTE: undocumented attribute
       date: [:birthday],

data/lib/fb_graph2/util.rb

@@ -0,0 +1,13 @@
+module FbGraph2
+  module Util
+    module_function
+
+    def as_identifier(object)
+      if object.respond_to? :id
+        object.id
+      else
+        object
+      end
+    end
+  end
+end

data/spec/fb_graph2/edge/accounts_spec.rb

@@ -4,14 +4,16 @@ describe FbGraph2::Edge::Accounts do
   context 'included in User' do
     describe '#accounts' do
       let(:me) { FbGraph2::User.me('token') }
-      it 'should return pages with page token' do
+      it 'should return an Array of FbGraph2::Page with page token' do
         accounts = mock_graph :get, 'me/accounts', 'user/accounts', access_token: 'token' do
           me.accounts
         end
-        account = accounts.first
-        account.should be_instance_of FbGraph2::Page
-        account.name.should == 'Identity Conference #idcon'
-        account.access_token.should == 'page_token'
+        accounts.should_not be_blank
+        accounts.each do |account|
+          account.should be_instance_of FbGraph2::Page
+          account.access_token.should == 'page_token'
+        end
+        accounts.first.name.should == 'Identity Conference #idcon'
       end
     end
   end

data/spec/fb_graph2/edge/comments_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe FbGraph2::Edge::Comments do
+  context 'included in Post' do
+    let(:post) { FbGraph2::Post.new('post_id').authenticate('token') }
+
+    describe '#comments' do
+      context 'when cached' do
+        let(:fetched) do
+          mock_graph :get, 'post_id', 'post/liked_and_commented', access_token: 'token' do
+            post.fetch
+          end
+        end
+
+        context 'without params' do
+          it 'should not call API' do
+            expect do
+              fetched.comments
+            end.not_to request_to "#{fetched.id}/comments"
+          end
+        end
+
+        context 'with params' do
+          it 'should call API' do
+            expect do
+              fetched.comments no_cache: true
+            end.to request_to "#{fetched.id}/comments"
+          end
+        end
+      end
+
+      context 'otherwise' do
+        it 'should return an Array of FbGraph2::Post' do
+          comments = mock_graph :get, 'post_id/comments', 'post/comments', access_token: 'token' do
+            post.comments
+          end
+          comments.should_not be_blank
+          comments.each do |comment|
+            comment.should be_instance_of FbGraph2::Comment
+          end
+        end
+      end
+    end
+
+    describe '#comment!' do
+      it 'should return FbGraph2::Post with posted params' do
+        comment = mock_graph :post, 'post_id/comments', 'success_with_id', access_token: 'token' do
+          post.comment! message: 'hello'
+        end
+        comment.should be_instance_of FbGraph2::Comment
+        comment.id.should == 'created_object_id'
+        comment.message.should == 'hello'
+      end
+    end
+  end
+end

data/spec/fb_graph2/edge/feed_spec.rb

@@ -5,10 +5,18 @@ describe FbGraph2::Edge::Feed do
     let(:me) { FbGraph2::User.me('token') }
 
     describe '#feed' do
-      it :TODO
+      it 'should return an Array of FbGraph2::Post' do
+        posts = mock_graph :get, 'me/feed', 'user/feed', access_token: 'token' do
+          me.feed
+        end
+        posts.should_not be_blank
+        posts.each do |post|
+          post.should be_instance_of FbGraph2::Post
+        end
+      end
     end
 
-    describe 'feed!' do
+    describe '#feed!' do
       it 'should return FbGraph2::Post with posted params' do
         post = mock_graph :post, 'me/feed', 'success_with_id', access_token: 'token' do
           me.feed! message: 'hello'

data/spec/fb_graph2/edge/likes_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe FbGraph2::Edge::Likes do
+  context 'included in User' do
+    let(:me) { FbGraph2::User.me('token') }
+
+    describe '#likes' do
+      it 'should return an Array of FbGraph2::Page' do
+        likes = mock_graph :get, 'me/likes', 'user/likes', access_token: 'token' do
+          me.likes
+        end
+        likes.should_not be_blank
+        likes.each do |like|
+          like.should be_instance_of FbGraph2::Page
+        end
+      end
+    end
+
+    describe '#liked?' do
+      context 'liked' do
+        it do
+          mock_graph :get, 'me/likes/page_id', 'user/likes', access_token: 'token' do
+            me.liked? 'page_id'
+          end.should be_true
+        end
+      end
+
+      context 'otherwise' do
+        it do
+          mock_graph :get, 'me/likes/page_id', 'blank_collection', access_token: 'token' do
+            me.liked? 'page_id'
+          end.should be_false
+        end
+      end
+    end
+  end
+
+  context 'included in Post' do
+    let(:post) { FbGraph2::Post.new('post_id').authenticate('token') }
+
+    describe '#likes' do
+      context 'when cached' do
+        let(:fetched) do
+          mock_graph :get, 'post_id', 'post/liked_and_commented', access_token: 'token' do
+            post.fetch
+          end
+        end
+
+        context 'without params' do
+          it 'should not call API' do
+            expect do
+              fetched.likes
+            end.not_to request_to "#{fetched.id}/likes"
+          end
+        end
+
+        context 'with params' do
+          it 'should call API' do
+            expect do
+              fetched.likes no_cache: true
+            end.to request_to "#{fetched.id}/likes"
+          end
+        end
+      end
+
+      context 'otherwise' do
+        it 'should return an Array of FbGraph2::User' do
+          likes = mock_graph :get, 'post_id/likes', 'post/likes', access_token: 'token' do
+            post.likes
+          end
+          likes.should_not be_blank
+          likes.each do |like|
+            like.should be_instance_of FbGraph2::User
+          end
+        end
+      end
+    end
+
+    describe '#like!' do
+      it 'should return true' do
+        mock_graph :post, 'post_id/likes', 'true', access_token: 'token' do
+          post.like!
+        end.should be_true
+      end
+    end
+
+    describe '#unlike!' do
+      it 'should return true' do
+        mock_graph :delete, 'post_id/likes', 'true', access_token: 'token' do
+          post.unlike!
+        end.should be_true
+      end
+    end
+  end
+end