twitter_util 0.0.1 → 0.0.2

data/README

@@ -1,10 +1,16 @@
 =twitter_util
 
-Clase que provee métodos de consulta básicos a twitter
+Clase que provee métodos de consulta básicos a twitter usando la api de twitter (REST API V1)
+No requiere autenticación (OAuth), usa metodos de consulta públicos
 
 == Métodos:
 * get_trends(momento)
 * get_status(usuario)
+* get_user_timeline(usuario)
+* search_tweets(query,pagina=1) 
+* get_followers(usuario)
+* get_following(usuario)
+
 
 == Author
-wyanez@gmail.com  - 12/06/10 - version 0.0.1
+wyanez@gmail.com  - 12/06/10 - version 0.0.2 (01/09/2012)

data/lib/twitter_util.rb

@@ -8,38 +8,111 @@ require 'json'
 Clase que provee metodos (estaticos) de consulta basicos a twitter.
 
 == Usage
-	require 'twitter_util'
-	trends=TwitterUtil.get_trends
-
+    require 'twitter_util'
+    trends = TwitterUtil.get_trends()
+    status = TwitterUtil.get_status('wryanez')
+    result = TwitterUtil.search_tweets('from:wryanez ruby')
+    timeline = TwitterUtil.get_user_timeline('wryanez')
+    followers = TwitterUtil.get_followers('wryanez')
+    followings = TwitterUtil.get_following('wryanez')
+    users=TwitterUtil.get_users_lookup(arr_ids)
 == Author 
-	William Yanez (wyanez@gmail.com)
-	 
+    William Yanez (wyanez@gmail.com)
+    
 =end
 
 class TwitterUtil
-
+    URL_TWITTER_API="http://api.twitter.com/1"
+    URL_TWITTER_SEARCH="http://search.twitter.com/search.json"
+    
 =begin rdoc
 retorna un hash de hashes de los trends dependiendo del parametro momento: 
-* 'current': trends del momento actual
+* 'current': trends del momento actual (debe estar autenticado el usuario)
 * 'daily': trends de cada hora del dia 
 * 'weekly': trends de cada dia de la semana 
 =end
-	def self.get_trends(momento='current')
+    def self.get_trends(momento='daily')
         trends=nil
-		url = "http://api.twitter.com/1/trends/#{momento}.json"
-		result =get_twitter_data(url)
+        url = "#{URL_TWITTER_API}/trends/#{momento}.json"
+        result =get_twitter_data(url)
         trends = result['trends'] unless result.nil?			
-		return trends 
-	end
+        return trends 
+    end
+
+=begin rdoc
+Retorna un hash con el status actual (ultimo tweet, followers, etc...) del usuario indicado.
+* Algunos campos son: 
+  <b>screen_name,description,location,created_at,url,followers_count,statuses_count</b> (Nro de tweets)
+* El ultimo tweet se puede acceder con el campo status y es un hash con los campos: <b>text,created_at,source</b>
+=end
+    def self.get_status(usuario)
+        url="#{URL_TWITTER_API}/users/show/#{usuario}.json"				
+        result =get_twitter_data(url)
+        return result 
+    end
+
+=begin rdoc
+retorna un arreglo con los tweets que cumplen con el criterio de busqueda dado en query.
+El query es un string con cada uno de los parametros de busquedas separados por un espacio
+en blanco. <b>Ej: query="from:wryanez ruby"</b>
+
+Cada tweet es un hash. Algunos campos utiles son: 
+* text      : contenido del tweet
+* from_user : Usuario que envia el tweet
+* created_at: fecha del tweet
+=end
+    def self.search_tweets(query,page=1)
+        return Array.new if query.empty?
+        
+        query="q="+query 
+        url=URL_TWITTER_SEARCH+"?"+URI.escape(query)
+        url=url+"&page=#{page}" if page>1
+        
+        result =get_twitter_data(url)
+        return result["results"]
+    end    
+
+=begin rdoc
+Retorna un arreglo con los tweets mas recientes del timeline del usuario indicado
+=end
+    def self.get_user_timeline(usuario)
+        url="#{URL_TWITTER_API}/statuses/user_timeline.json"               
+        url =url+"?screen_name="+URI.escape(usuario)
+        result =get_twitter_data(url)
+        return result 
+    end
 
 =begin rdoc
-retorna el status actual (ultimo tweet, followers, etc...) del usuario indicado
+Retorna un arreglo con los ids de seguidores del usuario indicado
 =end
-	def self.get_status(usuario)
-		url="http://api.twitter.com/1/users/show/#{usuario}.json"				
+    def self.get_followers(usuario,cursor=-1)
+        url="#{URL_TWITTER_API}/followers/ids.json"               
+        url =url+"?screen_name="+URI.escape(usuario)
+        url=url+"&cursor=#{cursor}" if cursor>1
         result =get_twitter_data(url)
-		return result 
-	end
+        return result 
+    end
+
+=begin rdoc
+Retorna un arreglo con los ids de los usuarios que sigue el usuario indicado
+=end
+    def self.get_following(usuario,cursor=-1)
+        url="#{URL_TWITTER_API}/friends/ids.json"               
+        url =url+"?screen_name="+URI.escape(usuario)
+        url=url+"&cursor=#{cursor}" if cursor>1
+        result =get_twitter_data(url)
+        return result 
+    end
+
+=begin rdoc
+Retorna un arreglo con los información de los usuarios indicados en el arreglo de ids dado
+=end
+    def self.get_users_lookup(arr_ids)
+        str_ids=arr_ids.join(',')
+        url="#{URL_TWITTER_API}/users/lookup.json?user_id="+str_ids
+        result =get_twitter_data(url)
+        return result 
+    end
 
 private
 
@@ -48,15 +121,15 @@ se conecta a la url dada de twitter y retorna la data correspondiente.
 devuelve nil si hay problemas con la conexion
 =end
     def self.get_twitter_data(url)
-		begin
-			buffer = open(url, "UserAgent" => "Ruby-Wget").read
-			result = JSON.parse(buffer)
-		rescue Exception => ex
-			puts ex
+        #puts "Procesando #{url}"
+        
+        begin
+            buffer = open(url, "UserAgent" => "Ruby-Wget").read
+            result = JSON.parse(buffer)
+        rescue Exception => ex
+            puts "Exception: #{ex}"
             result = nil
-		end
-		return result
-    
+        end
+        return result
     end
-    
 end

data/test/test_twitter_util.rb

@@ -5,14 +5,76 @@ class TestTwitterUtil < Test::Unit::TestCase
 
 	def test_trends_not_empty
 		trends=TwitterUtil.get_trends(:daily)
-        puts trends.inspect
 		assert_not_nil(trends)
+        assert(trends.size==24)
+        
+        trends=TwitterUtil.get_trends(:weekly)
+		assert_not_nil(trends)
+        assert(trends.size==7)
 	end
 
-    def test_status_not_empty
+    def test_status_when_user_is_valid
 		status=TwitterUtil.get_status('wryanez')
-        puts status.inspect
+        
 		assert_not_nil(status)
+        assert_equal(status["screen_name"],'wryanez')
+        assert_equal(status["location"],'Barquisimeto, Venezuela')
+	end
+ 
+    def test_status_when_user_not_found
+		status=TwitterUtil.get_status('UsuarioNoExiste2012')
+		assert_nil(status)
 	end
+    
+    def test_search_tweets_when_there_are_results
+        result=TwitterUtil.search_tweets("from:wryanez")
+        assert_not_nil(result)
+        assert(result.size>0)
+        
+        ult_tweet=result[0]
+        assert_equal(ult_tweet["from_user"],"wryanez")
+    end
+    
+    def test_search_tweets_when_query_empty
+        result=TwitterUtil.search_tweets("")
+        assert_not_nil(result)
+        assert_equal(result,Array.new)
+    end
+ 
+    def test_search_tweets_when_not_there_are_results
+        result=TwitterUtil.search_tweets("from:wryanez99999")
+        assert_not_nil(result)
+        assert_equal(result,Array.new)
+    end
+
+    def test_timeline_not_empty
+        timeline = TwitterUtil.get_user_timeline('wryanez')
+        assert(timeline.size>0) 
+    end
+
+    def test_following_and_followers_ok
+        status=TwitterUtil.get_status('wryanez')
+        assert_not_nil(status)
+        followers = status['followers_count'] 
+        following = status['friends_count']    
+        
+        data_followers = TwitterUtil.get_followers('wryanez')
+        assert_not_nil(data_followers)
+
+        data_following = TwitterUtil.get_following('wryanez')
+        assert_not_nil(data_following)
+
+        assert_equal(following,data_following['ids'].size)
+        assert_equal(followers,data_followers['ids'].size)
+    end
 
+    def test_users_lookup_ok
+        data_following = TwitterUtil.get_following('wryanez')
+        assert_not_nil(data_following)
+        
+        arr_ids=data_following['ids'][0..99]                  
+        users=TwitterUtil.get_users_lookup(arr_ids)
+        assert_not_nil(users)
+        assert_equal(users.size,100)
+    end    
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter_util
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: twitter_util
 bindir: bin
 cert_chain: []
-date: 2011-10-27 00:00:00.000000000Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &83005420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *83005420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Twitter search basic utilities collection
 email:
 - wyanez@gmail.com
@@ -33,7 +38,7 @@ files:
 - lib/twitter_util.rb
 - test/test_twitter_util.rb
 - README
-homepage: http://wryanez.blogspot.com
+homepage: http://about.me/wryanez
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -53,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Twitter Utilities Search