facebook_feed 1.0.1 → 1.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTJhYjVjNDAyNTgwZjIwNTc0YWJlN2UxYzJkYjJlNmM5MzdjM2RiZQ==
+  data.tar.gz: !binary |-
+    MDQzOTMwY2U2NGFmNDEwMjFkYjZjNjAyMzIxNDEwZmNhYzVlMGY3OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTI4MmEyYjFlM2FiYTg4OTM1MThhODE1YmZjNzdmNDZlNjkxOWIyZGU4ZTVh
+    ZjJjN2Q2NzkxYjczNTJkN2Q1OThiODFkMjE1MzBiMTRiZWUyZDMzYzAzY2Yy
+    N2UyNGM0OGRmZjZkZTdjYTk0MGIyMWU0ZTA0NGY2NWRmNDQzMzc=
+  data.tar.gz: !binary |-
+    NTRlYTNhOWViYmRmZDU2NmE2M2ZjMTQzNDA4ZTliMWNmZTgyNTg4MzM3YmVk
+    MmFkNzhhNGNiNzA2NGU5NTU3ZDFjMzVkMzMyZmViZTQ3ZDU2NTY4OGUyOGE1
+    ZGUyMGQ5MjNmM2VhOTI4ZWI4ZjViY2E3YWI5OTMyYWE0Y2QwN2I=

data/lib/facebook_feed.rb

@@ -6,4 +6,5 @@ require 'facebook_feed/feed_downloader'
 
 # Errors
 require 'facebook_feed/errors/feed_error'
-require 'facebook_feed/errors/invalid_credentials_error'
+require 'facebook_feed/errors/invalid_credentials_error'
+require 'facebook_feed/errors/invalid_feed_downloader_error'

data/lib/facebook_feed/errors/invalid_feed_downloader_error.rb

@@ -0,0 +1,4 @@
+module FacebookFeed
+  class InvalidFeedDownloaderError < FeedError
+  end
+end

data/lib/facebook_feed/feed_downloader.rb

@@ -6,12 +6,19 @@ module FacebookFeed
   class FeedDownloader
     attr_reader :access_token, :feed_id
 
+    # Initialize an instance of FeedDownloader like so
+    # opts = { :feed_id => 1234567, :access_token => 'ABCDEFGHI' }
+    # downloader = FeedDownloader.new(opts)
+
     def initialize(args)
+      raise FacebookFeed::InvalidFeedDownloaderError, "FeedDownloader must be instantiated with a Ruby hash" unless args.is_a?(Hash)
+      unless (args.keys.length == 2) and args.keys.include?(:feed_id) and args.keys.include?(:access_token)
+        raise FacebookFeed::InvalidFeedDownloaderError, "FeedDownloader must be configured with a hash with two keys only: :feed_id and :access_token"
+      end
+
       args.each do |k, v|
         instance_variable_set("@#{k}", v) unless v.nil?
       end
-      #feed_id = opts[:feed_id]
-      #access_token = opts[:access_token]
 
       base_url = "https://graph.facebook.com/#{@feed_id}/feed?access_token=#{@access_token}"
       @feed_urls = []
@@ -43,6 +50,7 @@ module FacebookFeed
       feed_urls << content_hash["paging"]["next"] unless posts.empty?
     end
 
+    # Returns a hash object of the JSON returned by the Facebook Graph API
     def get_content_hash(url)
       # TO-DO: Write code to authenticate server
       content = RestClient::Resource.new(
@@ -56,6 +64,28 @@ module FacebookFeed
       JSON.parse(content)
     end
 
+    # Takes in a hash object of the JSON returned by the Facebook Graph API
+    # and returns an array of hash objects like the following:
+    # {
+    # :poster => 'Name of message poster',
+    # :message => 'Message text',
+    # :type => 'Type of post',
+    # :created_time => 'UTC time message was created',
+    # :updated_time => 'UTC time message was updated',
+    # :like_count => 'Number of likes the post has',
+    # :comment_count => 'Number of comments the post has',
+    # :comments => ['Array of comment data']
+    # }
+    # 
+    # A comment datum is itself as a hash as well.
+    # It is like the following:
+    # {
+    #   :commenter => 'Name of person who made the comment',
+    #   :message => 'Comment text',
+    #   :created_time => 'UTC time comment was made',
+    #   :like_count => 'Number of likes the comment has'
+    # }
+
     def extract_posts(content_hash)
       posts = content_hash["data"]
       return [] if posts.nil?
@@ -68,34 +98,29 @@ module FacebookFeed
         doc[:type] = post["type"]
         doc[:created_time] = post["created_time"]
         doc[:updated_time] = post["updated_time"]
-        unless post["likes"].nil?
-          doc[:like_count] = post["likes"]["count"]
-        else
-          doc[:like_count] = 0
-        end
+        doc[:like_count] = post["likes"].nil? ? 0 : post["likes"]["count"]
         
         # Store each comment's sender, time, number of likes, and
         # the total number of comments for this post
-        doc[:comment_count] = post["comments"]["count"]
-
-        # Check if data is not nil rather than comment count because
-        # there's a Facebook bug that doesn't log all comments even
-        # if comment number > 0
-        unless post["comments"]["data"].nil?
-          doc[:comments] = []
-          comments = post["comments"]["data"]
-          comments.each do |comment|
-            comment_data = {}
-            comment_data[:commenter] = comment["from"]["name"]
-            comment_data[:message] = comment["message"]
-            comment_data[:created_time] = comment["created_time"]
-            if comment["likes"].nil?
-              comment_data[:like_count] = 0
-            else
-              comment_data[:like_count] = comment["likes"]
+        unless post["comments"].nil?
+          doc[:comment_count] = post["comments"]["count"]
+          # Check if data is not nil rather than comment count because
+          # there's a Facebook bug that doesn't log all comments even
+          # if comment number > 0
+          unless post["comments"]["data"].nil?
+            doc[:comments] = []
+            comments = post["comments"]["data"]
+            comments.each do |comment|
+              comment_data = {}
+              comment_data[:commenter] = comment["from"]["name"]
+              comment_data[:message] = comment["message"]
+              comment_data[:created_time] = comment["created_time"]
+              comment_data[:like_count] = comment["likes"] || 0
+              doc[:comments] << comment_data
             end
-            doc[:comments] << comment_data
           end
+        else
+          doc[:comment_count] = 0
         end
         docs << doc
       end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: facebook_feed
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.0.4
 platform: ruby
 authors:
 - Carson Tang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -54,28 +49,28 @@ files:
 - lib/facebook_feed/feed_downloader.rb
 - lib/facebook_feed/errors/feed_error.rb
 - lib/facebook_feed/errors/invalid_credentials_error.rb
+- lib/facebook_feed/errors/invalid_feed_downloader_error.rb
 homepage: https://github.com/carsontang/facebook_feed
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby bindings for Facebook feed APIs
 test_files: []