hyper-graph 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Dinn
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+HyperGraph
+===========
+
+HyperGraph is a simple Ruby library for accessing [Facebook's Graph API](http://developers.facebook.com/docs/api)
+
+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.
+
+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}
+    
+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 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, 
+	:id=>248026512444, :width=>604, :height=>483}]
+
+Similarly, make a post or delete request:
+	irb > graph.post('514569082_115714061789461/likes')
+    => true
+	irb > graph.post('514569082_115714061789461/comments', :message => 'durian is disgustingly delicious')
+    => true
+	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.
+	
+	
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+-----------------------------
+
+© 2010 Chris Dinn. See [LICENSE](http://github.com/chrisdinn/SocialGraph/blob/master/LICENSE) for details.

data/lib/hyper_graph.rb

@@ -0,0 +1,117 @@
+require 'net/http'
+require 'time'
+require 'json'
+
+class FacebookError<StandardError;end
+
+class HyperGraph
+  API_URL = 'graph.facebook.com'
+  
+  # Class methods
+  class << self
+    #Request an object from the social graph
+    def get(requested_object_id, options = {})
+      http = Net::HTTP.new(API_URL) 
+      request_path = "/#{requested_object_id}"
+      
+      query = build_query(options)   
+      request_path << "?#{query}" unless query==""
+      
+      http_response = http.get(request_path)
+      data = extract_data(JSON.parse(http_response.body))
+      normalize_response(data)
+    end
+  
+    def post(requested_object_id, options = {})
+      http = Net::HTTP.new(API_URL) 
+      request_path = "/#{requested_object_id}"
+      http_response = http.post(request_path, build_query(options))
+      if http_response.body=='true'
+        return true
+      else
+        data = extract_data(JSON.parse(http_response.body))
+        return normalize_response(data)
+      end
+    end
+    
+    def delete(requested_object_id, options = {})
+       post(requested_object_id, options.merge(:method => 'delete'))
+    end
+  
+    protected
+    
+    def build_query(options)
+      options.to_a.collect{ |i| "#{i[0].to_s}=#{i[1]}" }.sort.join('&')
+    end
+    
+    def normalize_response(response)
+     normalized_response = {}      
+      case response
+      when Hash
+        normalized_response = normalize_hash(response)
+      when Array
+        normalized_response = normalize_array(response)
+      end
+      normalized_response
+    end
+    
+    private
+    
+    # Converts JSON-parsed hash keys and values into a Ruby-friendly format
+    # Convert :id into integer and :updated_time into Time and all keys into symbols
+    def normalize_hash(hash)
+      normalized_hash = {}
+      hash.each do |k, v|
+        case k 
+        when "error"
+          raise FacebookError.new("#{hash['error']} - #{hash['message']}")
+        when "id"
+          normalized_hash[k.to_sym] = v.to_i
+        when /_time$/
+          normalized_hash[k.to_sym] = Time.parse(v)
+        else
+          data = extract_data(v)
+          case data
+          when Hash
+            normalized_hash[k.to_sym] = normalize_hash(data)
+          when Array
+            normalized_hash[k.to_sym] = normalize_array(data)
+          else
+            normalized_hash[k.to_sym] = data
+          end
+        end
+      end
+      normalized_hash
+    end
+    
+    def normalize_array(array)
+      array.collect{ |item| normalize_response(item) }.sort{ |a, b| a[:id] <=> b[:id] }
+    end
+    
+    # Extracts data from "data" key in Hash, if present
+    def extract_data(object)
+      if object.is_a?(Hash)&&object.keys.include?('data')
+        return object['data']
+      else
+        return object
+      end
+    end   
+  end
+  
+  # Instance methods
+  def initialize(access_token)
+    @access_token = access_token
+  end
+  
+  def get(requested_object_id, options = {})
+    self.class.get(requested_object_id, options.merge(:access_token => @access_token))
+  end
+  
+  def post(requested_object_id, options = {})
+    self.class.post(requested_object_id, options.merge(:access_token => @access_token))
+  end
+
+  def delete(requested_object_id, options = {})
+    self.class.delete(requested_object_id, options.merge(:access_token => @access_token))
+  end
+end

data/test/hyper_graph_test.rb

@@ -0,0 +1,154 @@
+require 'test_helper'
+
+class HyperGraphTest < Test::Unit::TestCase
+
+  def setup
+    @mock_connection = mock('api-connection')
+    Net::HTTP.stubs(:new).returns(@mock_connection)
+  end
+  
+  def test_get_object_info_while_unauthenticated
+    json_api_response = '{"id":"518018845","name":"Chris Dinn","first_name":"Chris","last_name":"Dinn","link":"http://www.facebook.com/chrisdinn"}'
+    expected_parsed_response = {  :id => 518018845, 
+                                  :name => "Chris Dinn", 
+                                  :first_name => "Chris", 
+                                  :last_name => "Dinn", 
+                                  :link => "http://www.facebook.com/chrisdinn"}
+                                  
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.stubs(:get).with("/518018845").returns(mock_response)
+    
+    assert_equal expected_parsed_response, HyperGraph.get('518018845')
+  end
+  
+  def test_get_object_info_when_authenticated
+    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.stubs(:get).with("/518018845?access_token=#{access_token}").returns(mock_response)
+    
+    assert_equal expected_parsed_response, HyperGraph.get('518018845', :access_token => access_token)
+  end
+  
+  def test_get_object_connection_when_authenticated
+    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.stubs(:get).with("/518018845/friends?access_token=#{access_token}").returns(mock_response)
+    
+    assert_equal expected_sorted_array, HyperGraph.get('518018845/friends', :access_token => access_token)
+  end
+  
+  def test_object_pagination
+    json_api_response = '{ "data": [  { "id": "248026512444",
+                                         "from": { "name": "Jennifer Byrne", "id": "511872444" },
+                                         "tags": { "data": [ { "id": "518018845", "name": "Chris Dinn", "x": 83.8889, "y": 15.3846, "created_time": "2010-01-10T23:06:41+0000" } ] },
+                                         "name": "Finally a day off....xmas dinner, a few days late", "picture": "http://photos-b.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_s.jpg", "source": "http://sphotos.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_n.jpg",
+                                         "height": 483, "width": 604, "link": "http://www.facebook.com/photo.php?pid=3217612&id=511872444", "icon": "http://static.ak.fbcdn.net/rsrc.php/z2E5Y/hash/8as8iqdm.gif",
+                                         "created_time": "2010-01-10T23:00:10+0000", "updated_time": "2010-01-10T23:06:36+0000" },
+                                      { "id": "248026522444",
+                                         "from": { "name": "Jennifer Byrne", "id": "511872444" },
+                                         "tags": { "data": [ { "id": "518018845", "name": "Chris Dinn","x": 92.2222, "y": 29.6296, "created_time": "2010-01-10T23:06:42+0000"}, { "id": "691356318", "name": "Steve Durant","x": 34.4444,"y": 19.2593,"created_time": "2010-01-10T23:06:42+0000" } ] }, 
+                                         "name": "Steve cooking dinner", "picture": "http://photos-e.ak.fbcdn.net/hphotos-ak-snc3/hs219.snc3/22675_248026522444_511872444_3217614_8129653_s.jpg","source": "http://sphotos.ak.fbcdn.net/hphotos-ak-snc3/hs219.snc3/22675_248026522444_511872444_3217614_8129653_n.jpg", 
+                                         "height": 604, "width": 402, "link": "http://www.facebook.com/photo.php?pid=3217614&id=511872444", "icon": "http://static.ak.fbcdn.net/rsrc.php/z2E5Y/hash/8as8iqdm.gif",
+                                         "created_time": "2010-01-10T23:00:10+0000", "updated_time": "2010-01-10T23:06:36+0000" } ]}'
+    expected_sorted_array = [ {:id => 248026512444, :from => { :name => "Jennifer Byrne", :id => 511872444}, :tags => [ { :id => 518018845, :name => "Chris Dinn", :x => 83.8889, :y => 15.3846, :created_time => Time.parse("2010-01-10T23:06:41+0000") } ], 
+                                    :name => "Finally a day off....xmas dinner, a few days late", 
+                                    :picture => "http://photos-b.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_s.jpg", 
+                                    :source => "http://sphotos.ak.fbcdn.net/hphotos-ak-snc3/hs239.snc3/22675_248026512444_511872444_3217612_4249159_n.jpg",
+                                    :height => 483, :width => 604, :link => "http://www.facebook.com/photo.php?pid=3217612&id=511872444", 
+                                    :icon => "http://static.ak.fbcdn.net/rsrc.php/z2E5Y/hash/8as8iqdm.gif", 
+                                    :created_time => Time.parse("2010-01-10T23:00:10+0000"), 
+                                    :updated_time => Time.parse("2010-01-10T23:06:36+0000") },
+                              {:id => 248026522444, :from => { :name => "Jennifer Byrne", :id => 511872444}, :tags => [ { :id => 518018845, :name => "Chris Dinn", :x => 92.2222, :y => 29.6296, :created_time => Time.parse("2010-01-10T23:06:42+0000") }, { :id => 691356318, :name => "Steve Durant", :x => 34.4444, :y => 19.2593, :created_time => Time.parse("2010-01-10T23:06:42+0000") } ], 
+                                    :name => "Steve cooking dinner", 
+                                    :picture => "http://photos-e.ak.fbcdn.net/hphotos-ak-snc3/hs219.snc3/22675_248026522444_511872444_3217614_8129653_s.jpg", 
+                                    :source => "http://sphotos.ak.fbcdn.net/hphotos-ak-snc3/hs219.snc3/22675_248026522444_511872444_3217614_8129653_n.jpg", 
+                                    :height => 604, :width => 402, :link => "http://www.facebook.com/photo.php?pid=3217614&id=511872444", 
+                                    :icon => "http://static.ak.fbcdn.net/rsrc.php/z2E5Y/hash/8as8iqdm.gif", 
+                                    :created_time => Time.parse("2010-01-10T23:00:10+0000"), :updated_time => Time.parse("2010-01-10T23:06:36+0000")}]
+     access_token = "test-access-token"
+     limit = 2
+     mock_response = stub(:body => json_api_response)
+     @mock_connection.stubs(:get).with("/me/photos?access_token=#{access_token}&limit=#{limit}").returns(mock_response)
+
+     assert_equal expected_sorted_array, HyperGraph.get('me/photos', :access_token => access_token, :limit => limit)
+  end
+  
+  def test_instance_with_stored_access_token
+    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.stubs(:get).with("/me?access_token=#{access_token}").returns(mock_response)
+     
+     graph = HyperGraph.new(access_token)
+     
+     assert_equal expected_parsed_response, HyperGraph.get('me', :access_token => access_token)
+     assert_equal expected_parsed_response, graph.get('me')
+  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.stubs(:post).with("/115934485101003/maybe", "access_token=#{access_token}").returns(mock_response)
+    
+    graph = HyperGraph.new(access_token)
+    assert_equal true, graph.post('115934485101003/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.stubs(:post).with('/514569082_115714061789461/comments', "access_token=#{access_token}").returns(mock_response)
+
+    graph = HyperGraph.new(access_token)
+    assert_raise FacebookError do
+      graph.post('514569082_115714061789461/comments')
+    end
+  end
+  
+  def test_get_request_raising_error
+    json_api_response = '{"error":{"type":"QueryParseException", "message":"An active access token must be used to query information about the current user."}}'
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.stubs(:get).with('/me/home').returns(mock_response)
+    
+    assert_raise FacebookError do
+      HyperGraph.get('me/home')
+    end
+  end
+  
+  def test_delete_request
+    json_api_response = 'true'
+    access_token = "test-access-token"
+    mock_response = stub(:body => json_api_response)
+    @mock_connection.stubs(:post).with("/514569082_115714061789461/likes", "access_token=#{access_token}&method=delete").returns(mock_response)
+    
+    graph = HyperGraph.new(access_token)
+    assert_equal true, graph.delete('514569082_115714061789461/likes')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'hyper_graph'

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: hyper-graph
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Dinn
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+- chrisgdinn@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/hyper_graph.rb
+- test/hyper_graph_test.rb
+- test/test_helper.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/chrisdinn/hyper-graph
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A gem for working with the Facebook Graph API
+test_files: []
+