hyper-graph 0.1.0 → 0.1.1

data/README.md

@@ -3,28 +3,45 @@ HyperGraph
 
 HyperGraph is a simple Ruby library for accessing [Facebook's Graph API](http://developers.facebook.com/docs/api)
 
+Installation
+-----
+	
+Install it with:	
+	
+    gem install hyper-graph
+
+Be sure to require it properly, with an underscore not a hyphen:
+
+    require 'hyper_graph'
+
 Usage
 -----
 
-Supports id and connection get and post requests, parsing the response into a Ruby-friendly format. [Read up on the API](http://developers.facebook.com/docs/api) to learn how it works.
+Supports 'ID' and 'ID/CONNECTION_TYPE' API requests using GET, POST and DELETE. HyperGraph parses the API's JSON response into a Ruby-friendly format. 
+[Read up on the API](http://developers.facebook.com/docs/api) to learn what that means.
 
 Create a graph to store the session key:
 	irb > graph = HyperGraph.new('my-access-token')
 	=> #<HyperGraph:0x1943b98 @access_token="my-access-token">
 	irb > graph.get('me')
-	=> {:updated_time=>Wed Mar 17 16:19:03 -0400 2010, :first_name=>"Chris", :last_name=>"Dinn", :name=>"Chris Dinn", :link=>"http://www.facebook.com/chrisdinn", :timezone=>-4, :birthday=>"05/28/1983", :id=>518018845, :verified=>true}
+    => {:updated_time=>Wed Mar 17 16:19:03 -0400 2010, :first_name=>"Chris", :last_name=>"Dinn", :name=>"Chris Dinn", 
+	:link=>"http://www.facebook.com/chrisdinn", :timezone=>-4, :birthday=>"05/28/1983", :id=>518018845, :verified=>true}
     
 Or, make requests directly from HyperGraph, though you'll need an access token for most requests:
     irb > HyperGraph.get('518018845')
     => {:first_name=>"Chris", :last_name=>"Dinn", :name=>"Chris Dinn", :link=>"http://www.facebook.com/chrisdinn", :id=>518018845}
     irb > HyperGraph.get('518018845', :access_token => 'my-access-token')
-    => {:updated_time=>Wed Mar 17 16:19:03 -0400 2010, :first_name=>"Chris", :last_name=>"Dinn", :name=>"Chris Dinn", :link=>"http://www.facebook.com/chrisdinn", :timezone=>-4, :birthday=>"05/28/1983", :id=>518018845, :verified=>true}
+    => {:updated_time=>Wed Mar 17 16:19:03 -0400 2010, :first_name=>"Chris", :last_name=>"Dinn", :name=>"Chris Dinn", 
+    :link=>"http://www.facebook.com/chrisdinn", :timezone=>-4, :birthday=>"05/28/1983", :id=>518018845, :verified=>true}
     
 You can also request connections: 
     irb > graph.get('me/photos', :limit => 1)
-	=> [{:source=>"http://sphotos.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_n.jpg", :picture=>"http://photos-b.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_s.jpg", 
-	:updated_time=>Sun Jan 10 18:06:36 -0500 2010, :from=>{:name=>"Jennifer Byrne", :id=>511872444}, :name=>"Finally a day off....xmas dinner, a few days late", :link=>"http://www.facebook.com/photo.php?pid=3217612&id=511872444", 
-	:icon=>"http://static.ak.fbcdn.net/rsrc.php/z2E5Y/hash/8as8iqdm.gif", :tags=>[{:name=>"Chris Dinn", :y=>15.3846, :created_time=>Sun Jan 10 18:06:41 -0500 2010, :id=>518018845, :x=>83.8889}], :created_time=>Sun Jan 10 18:00:10 -0500 2010, 
+	=> [{:source=>"http://sphotos.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_n.jpg", 
+	:picture=>"http://photos-b.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_s.jpg", 
+	:updated_time=>Sun Jan 10 18:06:36 -0500 2010, :from=>{:name=>"Jennifer Byrne", :id=>511872444}, 
+	:name=>"Finally a day off....xmas dinner, a few days late", :link=>"http://www.facebook.com/photo.php?pid=3217612&id=511872444", 
+	:icon=>"http://static.ak.fbcdn.net/rsrc.php/z2E5Y/hash/8as8iqdm.gif", :tags=>[{:name=>"Chris Dinn", :y=>15.3846, 
+	:created_time=>Sun Jan 10 18:06:41 -0500 2010, :id=>518018845, :x=>83.8889}], :created_time=>Sun Jan 10 18:00:10 -0500 2010, 
 	:id=>248026512444, :width=>604, :height=>483}]
 
 Similarly, make a post or delete request:
@@ -35,8 +52,12 @@ Similarly, make a post or delete request:
 	irb > graph.delete('514569082_115714061789461/likes')
     => true
 
-Time variables are converted into Time objects, IDs are converted to integers. Paging information is discarded from requests that return an array, so be sure to managed paging manually.
-	
+When parsing the response, time variables are converted into Time objects and IDs are converted to integers. Note that paging information is discarded from requests that return an array, so be sure to manage paging manually.
+
+Problems/Bugs/Requests
+-----------------------------
+
+Please, file an issue.  
 	
 Note on Patches/Pull Requests
 -----------------------------

data/lib/hyper_graph.rb

@@ -2,14 +2,17 @@ require 'net/http'
 require 'time'
 require 'json'
 
+# Wrapper for errors generated by the Facebook Graph API server
 class FacebookError<StandardError;end
 
+# HyperGraph acts as a facade for the Facebook Graph API.
+# It handles network calls and JSON response parsing.
 class HyperGraph
   API_URL = 'graph.facebook.com'
   
   # Class methods
   class << self
-    #Request an object from the social graph
+    # Request an object from the social graph
     def get(requested_object_id, options = {})
       http = Net::HTTP.new(API_URL) 
       request_path = "/#{requested_object_id}"
@@ -22,6 +25,7 @@ class HyperGraph
       normalize_response(data)
     end
   
+    # Post an object to the graph
     def post(requested_object_id, options = {})
       http = Net::HTTP.new(API_URL) 
       request_path = "/#{requested_object_id}"
@@ -34,6 +38,7 @@ class HyperGraph
       end
     end
     
+    # Send a delete request to the graph
     def delete(requested_object_id, options = {})
        post(requested_object_id, options.merge(:method => 'delete'))
     end
@@ -64,7 +69,7 @@ class HyperGraph
       hash.each do |k, v|
         case k 
         when "error"
-          raise FacebookError.new("#{hash['error']} - #{hash['message']}")
+          raise FacebookError.new("#{v['type']} - #{v['message']}")
         when "id"
           normalized_hash[k.to_sym] = v.to_i
         when /_time$/

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Dinn
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-23 00:00:00 -04:00
+date: 2010-04-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency