brookr-tootils 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jack Danger Canty
+
+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

@@ -0,0 +1,69 @@
+Description:
+A collection of useful Twitter Utilities
+Tools:
+Of primary interest is the graphing tool. It will determine if a 
+Twitter user has another user in thier 1st, 2nd or 
+3rd degree of connections
+Limitations: 
+Running 3rd degree checks on users that have a lot of followers/friends 
+will result in using all your available API hit. Twitter developer 
+account recommended!
+
+Result: the graph method returns a hash of arrays, keyed off the degree of
+separation. The value for each key an array of all the connections that exist
+at that level. Each connection is described by a series of Twitter IDs
+that are ordered by the flow of the connection.
+
+Example: 
+tootil = Tootils.new(user, pass)
+tootil.graph(sarahr, brookr)
+- {1=>[[11146212, 11136022]], 2=>[], 3=>[]}
+tootil.graph(sarahr, whitscott)
+- {1=>[],
+-  2=>
+-   [[11146212, 11136022, 9338922],
+-    [11146212, 14864296, 9338922],
+-    [11146212, 17785160, 9338922],
+-    [11146212, 6602252, 9338922],
+-    [11146212, 11136252, 9338922]],
+-  3=>[]}
+
+tootil.graph(sarahr, pop17)
+- {1=>[],
+-  2=>[],
+-  3=>
+-   [[11146212, 11136022, 9338922, 74673],
+-    [11146212, 11136022, 813286, 74673],
+-    [11146212, 11136022, 5997662, 74673],
+-    [11146212, 11136022, 2874, 74673],
+-    [11146212, 11136022, 734493, 74673],
+-    [11146212, 14864296, 9338922, 74673],
+-    ...}
+   
+Author: 
+Brook Riggio
+http://twitter.com/brookr
+
+History:
+2009-07-16:
+Version 0.1.1: "Gemified!"
+ – Thanks to @jackdanger for using technicalpickles-jeweler to set up the gem
+2009-07-15: 
+Version 0.1.0: "Layout the API"
+ – Renamed project Tootils, to make space for other utilities
+ – Totally refactored
+ – Graph now shows all connections between two users
+ – Consistent internal API
+ – Renamed links_to to graph
+ – Better data structure for graph results
+2009-05-26: 
+Version 0.0.2: "We might have something here"
+ – Now checks the 3rd degree as intended
+ – Various optimizations to reduce API hits
+ – Refactorings!
+
+2009-02-20:
+Version 0.0.1: "Proof of concept"
+ – Checks first and second degree
+ – Uses lots of API hits
+ – But keeps track of those API hits used!

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tootils"
+    gem.summary = %Q{Twitter Utilities}
+    gem.email = "gitcommit@6brand.com"
+    gem.homepage = "http://github.com/JackDanger/tootils"
+    gem.authors = ["Jack Danger Canty"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tootils #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/tootils.rb

@@ -0,0 +1,115 @@
+# See README for version history and usage
+#
+
+require 'rubygems'
+require 'httparty'
+require 'pp'
+config = YAML::load(File.read(File.join(ENV['HOME'], '.twitter')))
+
+module Tootils
+  class Tools
+    include HTTParty
+    base_uri 'twitter.com'
+    format :json
+
+    def initialize(user, pass)
+      @auth = {:username => user, :password => pass}
+    end
+
+    def options
+      options = { :basic_auth => @auth }
+    end
+
+    def self.remaining_hits
+      options = { :basic_auth => @auth }
+      get("/account/rate_limit_status.json", options)['remaining_hits']
+    end
+
+    def check_limit
+      if self.class.remaining_hits > 1
+        true
+      else
+        raise 'Over API rate limit!'
+        exit 2
+      end
+    end
+  
+  
+    def friends(user)
+      friends = self.class.get("/friends/ids/#{user.to_s}.json", options)
+      if friends["error"] 
+        pp friends
+        return []
+      end  unless friends.class == Array
+      friends
+    end
+  
+    def followers(user)
+      followers = self.class.get("/followers/ids/#{user.to_s}.json", options)
+      if followers["error"] 
+        pp followers
+        return []
+      end unless followers.class == Array
+      followers
+    end
+  
+    def info(user)
+      info = self.class.get("/users/show/#{user.to_s}.json", options)
+      if info["error"]
+        pp info
+        return {}
+      end
+      info
+    end
+  
+    # Our first twitter tool: Graphing connections from the first user to the second.
+    # This will check the first 3 degrees for links, and return a hash of connections
+    # found in each degree.
+    # Once any degree has a connection in it, additional degrees are not checked.
+    def graph(twit1, twit2)
+      twit1_id = info(twit1)['id']
+      twit1_friends = friends(twit1)
+      twit2_id = info(twit2)['id']
+      twit2_followers = followers(twit2)
+      # Start assuming there are no connections
+      graph = { 1 => [], 2 => [], 3 => [] }
+    
+      if twit2_followers.include?(twit1_id)
+        graph[1] = [[twit1_id, twit2_id]]
+      end
+    
+      return graph unless graph[1].empty?
+    
+      # Check second degree: Are there friends of twit1 who are followers of twit2? 
+      # Get an array of all connections.
+      for friend in (twit1_friends & twit2_followers)
+        graph[2] << [twit1_id, friend, twit2_id]
+      end
+      return graph unless graph[2].empty?
+    
+      # Check the 3rd degree: This is where we really burn through API calls.
+      # We need to check friends of friends, or the followers of followers,
+      # which ever is fewer to save API hits
+      if twit1_friends.length < twit2_followers.length
+        for friend in twit1_friends
+          friends_of_friend = friends(friend)
+          deg3 = friends_of_friend & twit2_followers
+          # Add a connection for each friend of a friend who is a follower of twit2
+          for fof in deg3
+            graph[3] << [twit1_id, friend, fof, twit2_id]
+          end
+        end
+      else
+        for follower in twit2_followers
+          followers_of_follower = followers(follower)
+          deg3 = twit1_friends & followers_of_follower
+          # Add a connection for each follower of a follower who is a friend of twit1
+          for fof in deg3
+            graph[3] << [twit1_id, fof, follower, twit2_id]
+          end rescue pp "Can't get followers for #{follower}: #{info(follower)}"
+        end
+      end
+      return graph
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tootils'
+
+class Test::Unit::TestCase
+  include Tootils
+end

data/test/tootils_test.rb

@@ -0,0 +1,11 @@
+require 'test_helper'
+
+class TootilsTest < Test::Unit::TestCase
+  should "build auth hash" do
+    assert !Tootils::Tools.new('user', 'pass').options.empty?
+  end
+  
+  should "find first degree connections" do
+    assert !Tootils::Tools.new('user', 'pass').graph('brookr', 'jackdanger')[1].empty?
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: brookr-tootils
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Brook Riggio
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: brookr@brookr.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- lib/tootils.rb
+- test/test_helper.rb
+- test/tootils_test.rb
+has_rdoc: false
+homepage: http://github.com/brookr/tootils
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Twitter Utilities
+test_files: 
+- test/test_helper.rb
+- test/tootils_test.rb