hyper-graph 0.2 → 0.3

data/README.md

@@ -35,44 +35,51 @@ Usage
 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:
+Version 0.3 introduces a new, friendlier HyperGraph API. If you're familiar with previous versions, review the updated API but don't worry: the new API 100% backward compatible.
+
+Create a HyperGraph to store your access token:
 	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}
-    
-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}
+	
+You can load an object and make requests against it:	
+    irb > me = graph.object(518018845)
+    => #<HyperGraphObject:0x1945934 @id="518018845" @access_token="my-access-token">
+You can make connection requests, too:
+	irb > me.get(:likes)
+	=> [{:category=>"Websites", :name=>"Slate.com", :id=>21516776437}]
+	irb > graph.object('514569082_115714061789461').post(:comments, :message => 'durian is disgustingly delicious')
+	=> true
+	irb > graph.object('514569082_115714061789461').delete(:likes)
+	=> true
     
-You can also request connections: 
+Or, you can request from the graph directly:
+    irb > graph.get('me')
+    => {:updated_time=>Wed Mar 17 16:19:03 -0400 2010, :first_name=>"Chris", :last_name=>"Dinn", ...
     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, 
-	:id=>248026512444, :width=>604, :height=>483}]
-
-Similarly, make a post or delete request:
-	irb > graph.post('514569082_115714061789461/likes')
+	=> [{:source=>"http://sphotos.ak.fbcdn.net/hphotos-a...
+
+Similarly, make a post or delete request directly from the graph:
+    irb > graph.post('514569082_115714061789461/likes')
     => true
-	irb > graph.post('514569082_115714061789461/comments', :message => 'durian is disgustingly delicious')
+    irb > graph.post('514569082_115714061789461/comments', :message => 'durian is disgustingly delicious')
     => true
-	irb > graph.delete('514569082_115714061789461/likes')
+    irb > graph.delete('514569082_115714061789461/likes')
     => true
+	    
+As well, you can make requests directly from HyperGraph, with or without an access token (though you'll need an access token for most requests):
+    irb > HyperGraph.get('518018845')
+    => {:first_name=>"Chris", :last_name=>"Dinn", :name=>"Chris Dinn", ...
+    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", ...
+
+HyperGraph tries to convert `id` values into integers when possible, for easy database storage. When that's not possible, the `id` will be returned as a string. Values representing a date are converted into Time objects.
 
-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.
+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.  
+Please, file an issue.
 	
 Note on Patches/Pull Requests
 -----------------------------

data/lib/hyper_graph.rb

@@ -2,6 +2,7 @@ require 'net/http'
 require 'net/https'
 require 'time'
 require 'json'
+require 'hyper_graph_object'
 
 # Wrapper for errors generated by the Facebook Graph API server
 class FacebookError<StandardError;end
@@ -92,7 +93,11 @@ class HyperGraph
         when "error"
           raise FacebookError.new("#{v['type']} - #{v['message']}")
         when "id"
-          normalized_hash[k.to_sym] = v.to_i
+          if (v.to_i == v.to_s.to_i)
+            normalized_hash[k.to_sym] = v.to_i 
+          else
+            normalized_hash[k.to_sym] = v 
+          end
         when /_time$/
           normalized_hash[k.to_sym] = Time.parse(v)
         else
@@ -111,7 +116,13 @@ class HyperGraph
     end
     
     def normalize_array(array)
-      array.collect{ |item| normalize_response(item) }.sort{ |a, b| a[:id] <=> b[:id] }
+      array.collect{ |item| normalize_response(item) }.sort do |a, b| 
+        if a[:id] && b[:id]
+          a[:id] <=> b[:id]
+        elsif a[:name]&&b[:name]
+          a[:name] <=> b[:name]
+        end
+      end
     end
     
     # Extracts data from "data" key in Hash, if present
@@ -129,6 +140,10 @@ class HyperGraph
     @access_token = access_token
   end
   
+  def object(id)
+    HyperGraphObject.new(self, id)
+  end
+  
   def get(requested_object_id, options = {})
     self.class.get(requested_object_id, options.merge(:access_token => @access_token))
   end

data/lib/hyper_graph_object.rb

@@ -0,0 +1,25 @@
+class HyperGraphObject
+  
+  def initialize(graph, id)
+    @graph = graph
+    @id = id
+  end
+  
+  def get(connection=nil, options={})
+    request = @id.to_s
+    request += "/#{connection.to_s}" if connection
+    @graph.get(request, options)
+  end
+  
+  def post(connection=nil, options={})
+    request = @id.to_s
+    request += "/#{connection.to_s}" if connection
+    @graph.post(request, options)
+  end
+  
+  def delete(connection=nil, options={})
+    request = @id.to_s
+    request += "/#{connection.to_s}" if connection
+    @graph.delete(request, options)
+  end
+end

data/test/hyper_graph_object_test.rb

@@ -0,0 +1,89 @@
+require 'test_helper'
+
+class HyperGraphObjectTest < Test::Unit::TestCase
+
+  def setup
+    @mock_connection = mock('api-connection')
+    @mock_connection.stubs(:verify_mode=)
+    Net::HTTP.stubs(:new).returns(@mock_connection)
+  end
+
+  def test_get_object
+    json_api_response = '{"id":"518018845","name":"Chris Dinn","first_name":"Chris","last_name":"Dinn","link":"http://www.facebook.com/chrisdinn","birthday":"05/28/1983","email":"expected-app-specific-email@proxymail.facebook.com","timezone":-4,"verified":true,"updated_time":"2010-03-17T20:19:03+0000"}'
+    expected_parsed_response = {  :id => 518018845, 
+                                  :name => "Chris Dinn", 
+                                  :first_name => "Chris", 
+                                  :last_name => "Dinn", 
+                                  :link => "http://www.facebook.com/chrisdinn", 
+                                  :birthday => "05/28/1983", 
+                                  :email => "expected-app-specific-email@proxymail.facebook.com", 
+                                  :timezone => -4, 
+                                  :verified => true, 
+                                  :updated_time => Time.parse("2010-03-17T20:19:03+0000")}
+                                  
+    access_token = "test-access-token"
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.expects(:use_ssl=).with(true)
+    @mock_connection.stubs(:get).with("/518018845?access_token=#{access_token}").returns(mock_response)
+    
+    graph = HyperGraph.new(access_token)
+    graph_object = graph.object(518018845)
+    
+    assert_equal expected_parsed_response, graph_object.get
+  end
+
+  def test_get_object_connection
+    json_api_response = '{ "data":[{"name": "Andrew Louis", "id": "28103622"},{"name": "Joey Coleman","id": "72600429"},{"name": "Kathryn Kinley","id": "28125421"},{"name": "Vanessa Larkey", "id": "28112600"}] }'
+    expected_sorted_array = [{:name => "Andrew Louis", :id => 28103622},{:name => "Vanessa Larkey", :id => 28112600},{:name => "Kathryn Kinley", :id => 28125421}, {:name => "Joey Coleman", :id => 72600429}]
+                                  
+    access_token = "test-access-token"
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.expects(:use_ssl=).with(true)
+    @mock_connection.stubs(:get).with("/518018845/friends?access_token=#{access_token}").returns(mock_response)
+    
+    graph = HyperGraph.new(access_token)
+    graph_object = graph.object('518018845')
+    
+    assert_equal expected_sorted_array, graph_object.get(:friends)
+  end
+
+  def test_post_request_returning_true
+    json_api_response = 'true'
+    access_token = "test-access-token"
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.expects(:use_ssl=).with(true)
+    @mock_connection.stubs(:post).with("/115934485101003/maybe", "access_token=#{access_token}").returns(mock_response)
+    
+    graph = HyperGraph.new(access_token)
+    object = graph.object(115934485101003)
+    assert_equal true, object.post(:maybe)
+  end
+  
+  def test_post_request_raising_error
+    json_api_response = '{"error":{"type":"Exception","message":"(#210) User not visible"}}'
+    access_token = "test-access-token"
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.expects(:use_ssl=).with(true)
+    @mock_connection.stubs(:post).with('/514569082_115714061789461/comments', "access_token=#{access_token}").returns(mock_response)
+
+    graph = HyperGraph.new(access_token)
+    object = graph.object('514569082_115714061789461')
+    
+    assert_raise FacebookError do
+      object.post(:comments)
+    end
+  end
+
+  def test_delete_request
+    json_api_response = 'true'
+    access_token = "test-access-token"
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.expects(:use_ssl=).with(true)
+    @mock_connection.stubs(:post).with("/514569082_115714061789461/likes", "access_token=#{access_token}&method=delete").returns(mock_response)
+    
+    graph = HyperGraph.new(access_token)
+    object = graph.object('514569082_115714061789461')
+    
+    assert_equal true, object.delete(:likes)
+  end
+end

metadata

@@ -4,8 +4,8 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Chris Dinn
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 -04:00
+date: 2010-04-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,6 +39,8 @@ extra_rdoc_files: []
 
 files: 
 - lib/hyper_graph.rb
+- lib/hyper_graph_object.rb
+- test/hyper_graph_object_test.rb
 - test/hyper_graph_test.rb
 - test/test_helper.rb
 - LICENSE