twitter4r 0.2.5 → 0.3.0

data/lib/twitter/client/auth.rb

@@ -0,0 +1,27 @@
+class Twitter::Client
+  @@AUTHENTICATION_URIS = {
+    :verify => '/account/verify_credentials',
+  }
+  
+	# Provides access to the Twitter verify credentials API.
+	# 
+	# You can verify Twitter user credentials with minimal overhead using this method.
+  # 
+	# Example:
+	#  client.authenticate?("osxisforlightweights", "l30p@rd_s^cks!")
+	def authenticate?(login, password)
+    verify_credentials(login, password)
+	end
+	
+private
+  def verify_credentials(username, passwd)
+  	connection = create_http_connection
+  	connection.start do |connection|
+  	  request = create_http_get_request("#{@@AUTHENTICATION_URIS[:verify]}.json")
+  		request.basic_auth(username, passwd)
+  		response = connection.request(request)
+  		response.is_a?(Net::HTTPSuccess) ? true : false
+    end
+  end
+end
+

data/lib/twitter/client/base.rb

@@ -79,3 +79,4 @@ class Twitter::Client
     	Net::HTTP::Delete.new(path, http_header)
     end
 end
+

data/lib/twitter/client/favorites.rb

@@ -0,0 +1,53 @@
+class Twitter::Client
+  # Why Twitter.com developers can't correctly document their API, I do not know!
+	@@FAVORITES_URIS = {
+		:add => '/favourings/create',
+		:remove => '/favourings/destroy',
+	}
+
+  # Provides access to the Twitter list favorites API.
+  # 
+  # You can access the authenticated [Twitter] user's favorites list using this method.
+  # 
+  # By default you will receive the last twenty statuses added to your favorites list.
+  # To get a previous page you can provide options to this method.  For example,
+  #  statuses = client.favorites(:page => 2)
+  # The above one-liner will get the second page of favorites for the authenticated user.
+	def favorites(options = nil)
+	  def uri_suffix(opts); opts && opts[:page] ? "?page=#{opts[:page]}" : ""; end
+    uri = '/favorites.json' + uri_suffix(options)
+    response = http_connect {|conn|	create_http_get_request(uri) }
+    bless_models(Twitter::Status.unmarshal(response.body))
+	end
+	
+	# Provides access to the Twitter add/remove favorite API.
+	# 
+	# You can add and remove favorite status using this method.
+	# 
+	# <tt>action</tt> can be any of the following values:
+	# * <tt>:add</tt> - to add a status to your favorites, you would use this <tt>action</tt> value
+	# * <tt>:remove</tt> - to remove an status from your existing favorites list use this.
+	# 
+	# The <tt>value</tt> must be either the status object to add or remove or 
+	# the integer unique status ID.
+	# 
+	# Examples:
+	#  id = 126006103423
+	#  client.favorite(:add, id)
+	#  client.favorite(:remove, id)
+	#  status = Twitter::Status.find(id, client)
+	#  client.favorite(:add, status)
+	#  client.favorite(:remove, status)
+	def favorite(action, value)
+	  raise ArgumentError, "Invalid favorite action provided: #{action}" unless @@FAVORITES_URIS.keys.member?(action)
+		value = value.to_i.to_s unless value.is_a?(String)
+		uri = "#{@@FAVORITES_URIS[action]}/#{value}.json"
+		case action
+		when :add
+		  response = http_connect {|conn| create_http_post_request(uri) }
+		when :remove
+		  response = http_connect {|conn| create_http_delete_request(uri) }
+		end
+		bless_model(Twitter::Status.unmarshal(response.body))
+	end
+end

data/lib/twitter/client/messaging.rb

@@ -18,7 +18,6 @@ class Twitter::Client
   # * +:received+
   # * +:sent+
   def messages(action, options = nil)
-    # method scoped method
     def uri_suffix(opts); opts && opts[:page] ? "?page=#{opts[:page]}" : ""; end
     raise ArgumentError, "Invalid messaging action: #{action}" unless [:sent, :received].member?(action)
     uri = @@MESSAGING_URIS[action] + uri_suffix(options)

data/lib/twitter/client.rb

@@ -15,4 +15,6 @@ require('twitter/client/status.rb')
 require('twitter/client/friendship.rb')
 require('twitter/client/messaging.rb')
 require('twitter/client/user.rb')
+require('twitter/client/auth.rb')
+require('twitter/client/favorites.rb')
 

data/lib/twitter/version.rb

@@ -3,8 +3,8 @@
 
 module Twitter::Version #:nodoc:
   MAJOR = 0
-  MINOR = 2
-  REVISION = 5
+  MINOR = 3
+  REVISION = 0
   class << self
     # Returns X.Y.Z formatted version string
     def to_version

data/spec/twitter/client/auth_spec.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Twitter::Client, "#authenticate?" do
+  before(:each) do
+    @uri = '/account/verify_credentials.json'
+    @request = mas_net_http_get(:basic_auth => nil)
+    @twitter = client_context
+    @default_header = @twitter.send(:http_header)
+    @response = mas_net_http_response(:success)
+    @error_response = mas_net_http_response(404, "Resource Not Found")
+    @connection = mas_net_http(@response)
+    Net::HTTP.stub!(:new).and_return(@connection)
+    @login = "applestillsucks"
+    @password = "linuxstillrocks"
+  end
+  
+  it "creates expected HTTP GET request" do
+    @twitter.should_receive(:create_http_get_request).with(@uri).and_return(@request)
+    @twitter.authenticate?(@login, @password)
+  end
+  
+  it "should return true if HTTP response is 20X" do
+    @twitter.authenticate?(@login, @password).should be(true)
+  end
+  
+  it "should return false if HTTP response is not 20X" do
+    Net::HTTP.stub!(:new).and_return(mas_net_http(@error_response))
+    @twitter.authenticate?(@login, @password).should be(false)
+  end
+  
+  after(:each) do
+    nilize(@uri, @request, @twitter, @default_header, @response, @error_response, @connection, @login, @password)
+  end
+end

data/spec/twitter/client/favorites_spec.rb

@@ -0,0 +1,183 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Twitter::Client, "#favorites" do
+  before(:each) do
+    @uri = '/favorites.json'
+    @request = mas_net_http_get(:basic_auth => nil)
+    @twitter = client_context
+    @default_header = @twitter.send(:http_header)
+    @response = mas_net_http_response(:success)
+    @connection = mas_net_http(@response)
+    @options = { :page => 4 }
+    Net::HTTP.stub!(:new).and_return(@connection)
+    @favorites = []
+    Twitter::Status.stub!(:unmarshal).and_return(@favorites)
+  end
+  
+  it "should create expected HTTP GET request when not giving options" do
+    @twitter.should_receive(:create_http_get_request).with(@uri).and_return(@request)
+    @twitter.favorites
+  end
+  
+  it "should create expected HTTP GET request when giving :page options" do
+    @twitter.should_receive(:create_http_get_request).with("#{@uri}?#{@options.to_http_str}").and_return(@request)
+    @twitter.favorites(@options)
+  end
+  
+  it "should raise Twitter::RESTError when 401 HTTP response received without giving options" do
+    @connection = mas_net_http(mas_net_http_response(:not_authorized))
+    lambda {
+      @twitter.favorites
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 401 HTTP response received when giving page options" do
+    @connection = mas_net_http(mas_net_http_response(:not_authorized))
+    lambda {
+      @twitter.favorites(@options)
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 403 HTTP response received without giving options" do
+    @connection = mas_net_http(mas_net_http_response(:forbidden))
+    lambda {
+      @twitter.favorites
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 403 HTTP response received when giving page options" do
+    @connection = mas_net_http(mas_net_http_response(:forbidden))
+    lambda {
+      @twitter.favorites(@options)
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 500 HTTP response received without giving options" do
+    @connection = mas_net_http(mas_net_http_response(:server_error))
+    lambda {
+      @twitter.favorites
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  it "should raise Twitter::RESTError when 500 HTTP response received when giving page options" do
+    @connection = mas_net_http(mas_net_http_response(:server_error))
+    lambda {
+      @twitter.favorites(@options)
+    }.should raise_error(Twitter::RESTError)
+  end
+  
+  after(:each) do
+    nilize(@uri, @request, @twitter, @default_header, @response, @error_response, @connection)
+  end
+end
+
+module FavoriteSpecMixin
+  def init
+    @base_uri = '/favourings'
+    @request = mas_net_http_get(:basic_auth => nil)
+    @twitter = client_context
+    @default_header = @twitter.send(:http_header)
+    @response = mas_net_http_response(:success)
+    @connection = mas_net_http(@response)
+    Net::HTTP.stub!(:new).and_return(@connection)
+    @id = 234923423
+    @status = mas_twitter_status(:id => @id, :to_i => @id)
+    Twitter::Status.stub!(:unmarshal).and_return(@status)
+  end
+  
+  def create_uri(method, id)
+    "#{@base_uri}/#{method.to_s}/#{id.to_i.to_s}.json"
+  end
+  
+  def connection=(connection)
+    @connection = connection
+  end
+  
+  def finalize
+    nilize(@uri, @request, @twitter, @default_header, @response, @error_response, @connection)
+  end
+end
+
+describe "Twitter::Client#favorite error handling", :shared => true do
+  it "should raise a Twitter::RESTError exception when a 401 HTTP response is received" do
+    connection = mas_net_http(mas_net_http_response(:not_authorized))
+    lambda {
+      execute_method
+    }.should raise_error(Twitter::RESTError)
+  end  
+
+  it "should raise a Twitter::RESTError exception when a 403 HTTP response is received" do
+    connection = mas_net_http(mas_net_http_response(:forbidden))
+    lambda {
+      execute_method
+    }.should raise_error(Twitter::RESTError)
+  end  
+
+  it "should raise a Twitter::RESTError exception when a 404 HTTP response is received" do
+    connection = mas_net_http(mas_net_http_response(:file_not_found))
+    lambda {
+      execute_method
+    }.should raise_error(Twitter::RESTError)
+  end  
+
+  it "should raise a Twitter::RESTError exception when a 500 HTTP response is received" do
+    connection = mas_net_http(mas_net_http_response(:server_error))
+    lambda {
+      execute_method
+    }.should raise_error(Twitter::RESTError)
+  end  
+end
+
+describe Twitter::Client, "#favorite(:add, status)" do
+  include FavoriteSpecMixin
+  it_should_behave_like "Twitter::Client#favorite error handling"
+  
+  before(:each) do
+    init
+  end
+  
+  def execute_method
+    @twitter.favorite(:add, @id)
+  end
+  
+  it "should create expected POST request for :add action supplying integer id of status" do
+    @twitter.should_receive(:create_http_post_request).with(create_uri(:create, @id)).and_return(@request)
+    @twitter.favorite(:add, @id)
+  end
+  
+  it "should create expected POST request for :add action supplying status object" do
+    @twitter.should_receive(:create_http_post_request).with(create_uri(:create, @id)).and_return(@request)
+    @twitter.favorite(:add, @status)
+  end
+  
+  after(:each) do
+    finalize
+  end
+end
+
+describe Twitter::Client, "#favorite(:remove, status)" do
+  include FavoriteSpecMixin
+  it_should_behave_like "Twitter::Client#favorite error handling"
+
+  before(:each) do
+    init
+  end
+  
+  def execute_method
+    @twitter.favorite(:remove, @id)
+  end
+  
+  it "should create expected DELETE request for :remove action supplying integer id of status" do
+    @twitter.should_receive(:create_http_delete_request).with(create_uri(:destroy, @id)).and_return(@request)
+    @twitter.favorite(:remove, @id)
+  end
+  
+  it "should create expected DELETE request for :remove action supplying status object" do
+    @twitter.should_receive(:create_http_delete_request).with(create_uri(:destroy, @id)).and_return(@request)
+    @twitter.favorite(:remove, @status)
+  end
+  
+  after(:each) do
+    finalize
+  end
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: twitter4r
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
-date: 2007-09-23 00:00:00 -07:00
+  version: 0.3.0
+date: 2007-11-05 00:00:00 -06:00
 summary: A clean Twitter client API in pure Ruby. Will include Twitter add-ons also in Ruby.
 require_paths: 
 - lib
@@ -35,8 +35,10 @@ files:
 - lib/twitter/client/timeline.rb
 - lib/twitter/client/messaging.rb
 - lib/twitter/client/base.rb
+- lib/twitter/client/favorites.rb
 - lib/twitter/client/status.rb
 - lib/twitter/client/friendship.rb
+- lib/twitter/client/auth.rb
 - lib/twitter/client/user.rb
 - lib/twitter/rails.rb
 - lib/twitter/client.rb
@@ -52,9 +54,11 @@ files:
 - spec/twitter/model_spec.rb
 - spec/twitter/client/status_spec.rb
 - spec/twitter/client/timeline_spec.rb
+- spec/twitter/client/auth_spec.rb
 - spec/twitter/client/user_spec.rb
 - spec/twitter/client/messaging_spec.rb
 - spec/twitter/client/base_spec.rb
+- spec/twitter/client/favorites_spec.rb
 - spec/twitter/client/friendship_spec.rb
 - spec/twitter/version_spec.rb
 - spec/twitter/rails_spec.rb