twitter_oauth 0.3.1 → 0.3.2

data/lib/twitter_oauth/blocks.rb

@@ -1,15 +1,33 @@
 module TwitterOAuth
   class Client
     
-    # unblock this user.
+    # Blocks the user specified in the ID parameter as the authenticating user. 
+    # Destroys a friendship to the blocked user if it exists. 
+    # Returns the blocked user in the requested format when successful.
     def block(id)
       post("/blocks/create/#{id}.json")
     end
     
-    # block this user.
+    # Un-blocks the user specified in the ID parameter for the authenticating user.  
+    # Returns the un-blocked user in the requested format when successful.
     def unblock(id)
       post("/blocks/destroy/#{id}.json")
     end
     
+    # Returns if the authenticating user is blocking a target user.
+    def blocked?(id)
+      get("/blocks/exists/#{id}.json")
+    end
+    
+    # Returns an array of user objects that the authenticating user is blocking.
+    def blocking
+      get("/blocks/blocking.json")
+    end
+    
+    # Returns an array of numeric user ids the authenticating user is blocking.
+    def blocking_ids
+      get("/blocks/blocking/ids.json")
+    end
+    
   end
 end

data/lib/twitter_oauth/client.rb

@@ -11,6 +11,8 @@ require 'twitter_oauth/favorites'
 require 'twitter_oauth/utils'
 require 'twitter_oauth/trends'
 require 'twitter_oauth/lists'
+require 'twitter_oauth/saved_searches'
+require 'twitter_oauth/spam'
 
 module TwitterOAuth
   class Client
@@ -31,26 +33,16 @@ module TwitterOAuth
       @secret = @access_token.secret
       @access_token
     end
-
-    def get(url)
-      oauth_response = access_token.get(url)
-      JSON.parse(oauth_response.body)
-    end
-
-    def post(url, body = '', headers = {})
-      oauth_response = access_token.post(url, body, headers)
-      JSON.parse(oauth_response.body)
-    end
-  
-    def delete(url)
-      oauth_response = access_token.delete(url)
-      JSON.parse(oauth_response.body)
-    end
   
     def show(username)
       get("/users/show/#{username}.json")
     end
     
+    # Returns the string "ok" in the requested format with a 200 OK HTTP status code.
+    def test
+      get("/help/test.json")
+    end
+    
     def request_token(options={})
       consumer.get_request_token(options)
     end
@@ -72,6 +64,21 @@ module TwitterOAuth
       def access_token
         @access_token ||= OAuth::AccessToken.new(consumer, @token, @secret)
       end
+      
+      def get(url)
+        oauth_response = access_token.get(url)
+        JSON.parse(oauth_response.body)
+      end
+
+      def post(url, body = '', headers = {})
+        oauth_response = access_token.post(url, body, headers)
+        JSON.parse(oauth_response.body)
+      end
+
+      def delete(url)
+        oauth_response = access_token.delete(url)
+        JSON.parse(oauth_response.body)
+      end
   end
 end
    

data/lib/twitter_oauth/favorites.rb

@@ -1,14 +1,19 @@
 module TwitterOAuth
   class Client
     
+    # Returns the 20 most recent favorite statuses for the authenticating user or user specified by the ID parameter.
     def favorites(page=1)
       get("/favorites.json?page=#{page}")
     end
     
+    # Favorites the status specified in the ID parameter as the authenticating user. 
+    # Returns the favorite status when successful.
     def favorite
       post("/favorites/create/#{id}.json")
     end
     
+    # Un-favorites the status specified in the ID parameter as the authenticating user. 
+    # Returns the un-favorited status when successful.
     def unfavorite
       post("/favorites/destroy/#{id}.json")
     end

data/lib/twitter_oauth/friendships.rb

@@ -1,31 +1,39 @@
 module TwitterOAuth
   class Client
     
+    # Returns an array of numeric IDs for every user the specified user is following.
     def friends_ids(options={})
       args = options.map{|k,v| "#{k}=#{v}"}.join('&')
       get("/friends/ids.json?#{args}")
     end
     
+    # Returns an array of numeric IDs for every user following the specified user.
     def followers_ids(options={})
       args = options.map{|k,v| "#{k}=#{v}"}.join('&')
       get("/followers/ids.json?#{args}")
     end
     
-    # friend this user.
+    # Allows the authenticating user to follow the specified user. Returns the befriended user when successful.
     def friend(id)
       post("/friendships/create/#{id}.json")
     end
     
-    # unfriend.
+    # Allows the authenticating users to unfollow the specified user. Returns the unfollowed user when successful. 
     def unfriend(id)
       post("/friendships/destroy/#{id}.json")
     end
     
-    # exists?.
-    def exists?(a, b)
+    # Tests for the existence of friendship between two users. Will return true if user_a follows user_b, otherwise will return false.
+    # You are better off using get_friendship as it returns more extended information.
+    def friends?(a, b)
       oauth_response = access_token.get("/friendships/exists.json?user_a=#{a}&user_b=#{b}")
       oauth_response.body.strip == 'true'
     end
     
+    # Returns detailed information about the relationship between two users.
+    def get_friendship(a, b)
+      get("/friendships/show.json?source_screen_name=#{a}&target_screen_name=#{b}")
+    end
+    
   end
 end

data/lib/twitter_oauth/notifications.rb

@@ -1,12 +1,14 @@
 module TwitterOAuth
   class Client
     
-    # follow this user.
+    # Enables device notifications for updates from the specified user.  
+    # Returns the specified user when successful.
     def follow(id)
       post("/notifications/follow/#{id}.json")
     end
     
-    # unfollow.
+    # Disables notifications for updates from the specified user to the authenticating user.  
+    # Returns the specified user when successful.
     def leave(id)
       post("/notifications/leave/#{id}.json")
     end

data/lib/twitter_oauth/saved_searches.rb

@@ -0,0 +1,24 @@
+module TwitterOAuth
+  class Client
+    
+    # Returns the authenticated user's saved search queries.
+    def saved_searches
+      get("/saved_searches.json")
+    end
+    
+    # Retrieve the data for a saved search owned by the authenticating user specified by the given id.
+    def get_saved_search(search_id)
+      get("/saved_searches/show/#{search_id}.json")
+    end
+    
+    # Creates a saved search for the authenticated user.
+    def create_saved_search(query)
+      post("/saved_searches/create.json", :query => query)
+    end
+    
+    def delete_saved_search(search_id)
+      post("/saved_searches/destroy/#{search_id}.json")
+    end
+    
+  end
+end

data/lib/twitter_oauth/search.rb

@@ -6,27 +6,29 @@ module TwitterOAuth
     def search(q, options={})
       options[:page] ||= 1
       options[:per_page] ||= 20
-      search_get("http://search.twitter.com/search.json?q=#{URI.escape(q)}&page=#{options[:page]}&rpp=#{options[:per_page]}&since_id=#{options[:since_id]}")
+      options[:q] = URI.escape(q)
+      args = options.map{|k,v| "#{k}=#{v}"}.join('&')
+      search_get("/search.json?#{args}")
     end
     
     # Returns the current top 10 trending topics on Twitter.
     def current_trends
-      search_get("http://search.twitter.com/trends/current.json")
+      search_get("/trends/current.json")
     end
     
     # Returns the top 20 trending topics for each hour in a given day.
     def daily_trends
-      search_get("http://search.twitter.com/trends/daily.json")
+      search_get("/trends/daily.json")
     end
     
     # Returns the top 30 trending topics for each day in a given week.
     def weekly_trends
-      search_get("http://search.twitter.com/trends/weekly.json")
+      search_get("/trends/weekly.json")
     end
     
     private
-      def search_get(url)
-        response = open(url, 'User-Agent' => 'github.com/moomerman/twitter_outh')
+      def search_get(path)
+        response = open('http://search.twitter.com' + path, 'User-Agent' => 'github.com/moomerman/twitter_outh')
         JSON.parse(response.read)
       end
   end

data/lib/twitter_oauth/spam.rb

@@ -0,0 +1,10 @@
+module TwitterOAuth
+  class Client
+    
+    # The user specified in the id is blocked by the authenticated user and reported as a spammer.
+    def report_spam(user)
+      post("/report_spam.json", :id => user)
+    end
+    
+  end
+end

data/lib/twitter_oauth/trends.rb

@@ -6,5 +6,20 @@ module TwitterOAuth
       get("/trends.json")
     end
     
+    # Returns the locations that Twitter has trending topic information for. 
+    # The response is an array of "locations" that encode the location's WOEID (a Yahoo! Where On Earth ID)
+    # and some other human-readable information such as a canonical name and country the location belongs in.
+    def trends_available
+      get("/trends/available.json")
+    end
+    
+    # Returns the top 10 trending topics for a specific location Twitter has trending topic information for. 
+    # The response is an array of "trend" objects that encode the name of the trending topic, the query 
+    # parameter that can be used to search for the topic on Search, and the direct URL that can be issued against Search. 
+    # This information is cached for five minutes, and therefore users are discouraged from querying these endpoints 
+    # faster than once every five minutes.  Global trends information is also available from this API by using a WOEID of 1.
+    def trends_for_location(woeid)
+      get("/trends/woeid.json")
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: twitter_oauth
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Richard Taylor
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-20 00:00:00 +00:00
+date: 2009-12-30 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -61,7 +61,9 @@ files:
 - lib/twitter_oauth/friendships.rb
 - lib/twitter_oauth/lists.rb
 - lib/twitter_oauth/notifications.rb
+- lib/twitter_oauth/saved_searches.rb
 - lib/twitter_oauth/search.rb
+- lib/twitter_oauth/spam.rb
 - lib/twitter_oauth/status.rb
 - lib/twitter_oauth/timeline.rb
 - lib/twitter_oauth/trends.rb