craigtmackenzie-twitter4r 0.3.1

data/lib/twitter/version.rb

@@ -0,0 +1,19 @@
+# version.rb contains <tt>Twitter::Version</tt> that provides helper
+# methods related to versioning of the <tt>Twitter4R</tt> project.
+
+module Twitter::Version #:nodoc:
+  MAJOR = 0
+  MINOR = 3
+  REVISION = 1
+  class << self
+    # Returns X.Y.Z formatted version string
+    def to_version
+      "#{MAJOR}.#{MINOR}.#{REVISION}"
+    end
+    
+    # Returns X-Y-Z formatted version name
+    def to_name
+      "#{MAJOR}_#{MINOR}_#{REVISION}"
+    end
+  end
+end

data/spec/twitter/client/account_spec.rb

@@ -0,0 +1,28 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Twitter::Client, "#account_info" do
+  before(:each) do
+    @uri = Twitter::Client.class_eval("@@ACCOUNT_URIS[:rate_limit_status]")
+    @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)
+    @response.stub!(:body).and_return("{}")
+    Net::HTTP.stub!(:new).and_return(@connection)
+    @rate_limit_status = mock(Twitter::RateLimitStatus)
+    @twitter.stub!(:bless_models).and_return({})
+  end
+
+  it "should create expected HTTP GET request" do
+    @twitter.should_receive(:create_http_get_request).with(@uri).and_return(@request)
+    @twitter.account_info
+  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.account_info
+    }.should raise_error(Twitter::RESTError)
+  end
+end

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/base_spec.rb

@@ -0,0 +1,242 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe "Twitter::Client" do
+  before(:each) do
+    @init_hash = { :login => 'user', :password => 'pass' }
+  end
+
+  it ".new should accept login and password as initializer hash keys and set the values to instance values" do
+    client = nil
+    lambda do
+      client = Twitter::Client.new(@init_hash)
+    end.should_not raise_error
+    client.send(:login).should eql(@init_hash[:login])
+    client.send(:password).should eql(@init_hash[:password])
+  end  
+end
+
+describe Twitter::Client, "#inspect" do
+  before(:each) do
+    @client = Twitter::Client.new(:login => "NippleEquality", :password => "3rdnipple")
+  end
+
+  it "should block out password attribute values" do
+    @client.inspect.should_not match(/@password="3rdnipple"/)
+  end
+end
+
+describe Twitter::Client, "#http_header" do
+  before(:each) do
+    @user_agent = 'myapp'
+    @application_name = @user_agent
+    @application_version = '1.2.3'
+    @application_url = 'http://myapp.url'
+    Twitter::Client.configure do |conf|
+      conf.user_agent = @user_agent
+      conf.application_name = @application_name
+      conf.application_version = @application_version
+      conf.application_url = @application_url
+    end
+    @expected_headers = {
+      'Accept' => 'text/x-json',
+      'X-Twitter-Client' => @application_name,
+      'X-Twitter-Client-Version' => @application_version,
+      'X-Twitter-Client-URL' => @application_url,
+      'User-Agent' => "Twitter4R v#{Twitter::Version.to_version} [#{@user_agent}]",
+    }
+    @twitter = client_context
+    # reset @@http_header class variable in Twitter::Client class
+    Twitter::Client.class_eval("@@http_header = nil")
+  end
+  
+  it "should always return expected HTTP headers" do
+    headers = @twitter.send(:http_header)
+    headers.should === @expected_headers
+  end
+  
+  it "should cache HTTP headers Hash in class variable after first invocation" do
+    cache = Twitter::Client.class_eval("@@http_header")
+    cache.should be_nil
+    @twitter.send(:http_header)
+    cache = Twitter::Client.class_eval("@@http_header")
+    cache.should_not be_nil
+    cache.should === @expected_headers
+  end
+  
+  after(:each) do
+    nilize(@user_agent, @application_name, @application_version, @application_url, @twitter, @expected_headers)
+  end
+end
+
+describe Twitter::Client, "#create_http_get_request" do
+  before(:each) do
+  	@uri = '/some/path'
+  	@expected_get_request = mock(Net::HTTP::Get)
+    @twitter = client_context
+  	@default_header = @twitter.send(:http_header)
+  end
+  
+  it "should create new Net::HTTP::Get object with expected initialization arguments" do
+  	Net::HTTP::Get.should_receive(:new).with(@uri, @default_header).and_return(@expected_get_request)
+		@twitter.send(:create_http_get_request, @uri)
+  end
+  
+  after(:each) do
+    nilize(@twitter, @uri, @expected_get_request, @default_header)
+  end
+end
+
+describe Twitter::Client, "#create_http_post_request" do
+  before(:each) do
+  	@uri = '/some/path'
+  	@expected_post_request = mock(Net::HTTP::Post)
+  	@twitter = client_context
+  	@default_header = @twitter.send(:http_header)
+  end
+    
+  it "should create new Net::HTTP::Post object with expected initialization arguments" do
+  	Net::HTTP::Post.should_receive(:new).with(@uri, @default_header).and_return(@expected_post_request)
+    @twitter.send(:create_http_post_request, @uri)
+  end
+  
+  after(:each) do
+    nilize(@twitter, @uri, @expected_post_request, @default_header)    
+  end
+end
+
+describe Twitter::Client, "#create_http_delete_request" do
+  before(:each) do
+    @uri = '/a/stupid/path/that/is/not/restful/since/twitter.com/cannot/do/consistent/restful/apis'
+    @expected_delete_request = mock(Net::HTTP::Delete)
+    @twitter = client_context
+    @default_header = @twitter.send(:http_header)
+  end
+  
+  it "should create new Net::HTTP::Delete object with expected initialization arguments" do
+    Net::HTTP::Delete.should_receive(:new).with(@uri, @default_header).and_return(@expected_delete_request)
+    @twitter.send(:create_http_delete_request, @uri)
+  end
+  
+  after(:each) do
+    nilize(@twitter, @uri, @expected_delete_request, @default_header)
+  end
+end
+
+describe Twitter::Client, "#http_connect" do
+  before(:each) do
+    @request = mas_net_http_get(:basic_auth => nil)
+    @good_response = mas_net_http_response(:success)
+    @bad_response = mas_net_http_response(:server_error)
+    @http_stubs = {:is_a? => true}
+    @block = Proc.new do |conn|
+      conn.is_a?(Net::HTTP).should be(true)
+      @has_yielded = true
+      @request
+    end
+    @twitter = client_context
+    @has_yielded = false
+  end
+  
+  def generate_bad_response
+    @http = mas_net_http(@bad_response, @http_stubs)
+    Net::HTTP.stub!(:new).and_return(@http)
+  end
+  
+  def generate_good_response
+    @http = mas_net_http(@good_response, @http_stubs)
+    Net::HTTP.stub!(:new).and_return(@http)
+  end
+  
+  it "should yield HTTP connection when response is good" do
+    generate_good_response
+    @http.should_receive(:is_a?).with(Net::HTTP).and_return(true)
+    lambda do
+      @twitter.send(:http_connect, &@block)
+    end.should_not raise_error
+    @has_yielded.should be(true)
+  end
+  
+  it "should yield HTTP connection when response is bad" do
+    generate_bad_response
+    @http.should_receive(:is_a?).with(Net::HTTP).and_return(true)
+    lambda {
+      @twitter.send(:http_connect, &@block)
+    }.should raise_error(Twitter::RESTError)
+    @has_yielded.should be(true)
+  end
+  
+  after(:each) do
+    nilize(@good_response, @bad_response, @http)
+  end
+end
+
+describe Twitter::Client, "#bless_model" do
+  before(:each) do
+    @twitter = client_context
+    @model = Twitter::User.new
+  end
+  
+  it "should recieve #client= message on given model to self" do
+  	@model.should_receive(:client=).with(@twitter)
+    model = @twitter.send(:bless_model, @model)
+  end
+  
+  it "should set client attribute on given model to self" do
+    model = @twitter.send(:bless_model, @model)
+    model.client.should eql(@twitter)
+  end
+
+  # if model is nil, it doesn't not necessarily signify an exceptional case for this method's usage.
+  it "should return nil when receiving nil and not raise any exceptions" do
+    model = @twitter.send(:bless_model, nil)
+    model.should be_nil
+  end
+  
+  # needed to alert developer that the model needs to respond to #client= messages appropriately.
+  it "should raise an error if passing in a non-nil object that doesn't not respond to the :client= message" do
+    lambda {
+      @twitter.send(:bless_model, Object.new)      
+    }.should raise_error(NoMethodError)
+  end
+  
+  after(:each) do
+    nilize(@twitter)
+  end
+end
+
+describe Twitter::Client, "#bless_models" do
+  before(:each) do
+    @twitter = client_context
+    @models = [
+    	Twitter::Status.new(:text => 'message #1'),
+    	Twitter::Status.new(:text => 'message #2'),
+    ]
+  end
+
+  it "should set client attributes for each model in given Array to self" do
+    models = @twitter.send(:bless_models, @models)
+    models.each {|model| model.client.should eql(@twitter) }
+  end
+  
+  it "should set client attribute for singular model given to self" do
+    model = @twitter.send(:bless_models, @models[0])
+    model.client.should eql(@twitter)
+  end
+  
+  it "should delegate to bless_model for singular model case" do
+    model = @models[0]
+    @twitter.should_receive(:bless_model).with(model).and_return(model)
+    @twitter.send(:bless_models, model)
+  end
+  
+  it "should return nil when receiving nil and not raise any exceptions" do
+    lambda {
+      value = @twitter.send(:bless_models, nil)
+      value.should be_nil
+    }.should_not raise_error
+  end
+  
+  after(:each) do
+    nilize(@twitter, @models)
+  end
+end

data/spec/twitter/client/blocks_spec.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+describe Twitter::Client, "#block" do
+  before(:each) do
+    @twitter = client_context
+    @id = 1234567
+    @screen_name = 'dummylogin'
+    @friend = Twitter::User.new(:id => @id, :screen_name => @screen_name)
+    @uris = Twitter::Client.class_eval("@@BLOCK_URIS")
+    @request = mas_net_http_get(:basic_auth => nil)
+    @response = mas_net_http_response(:success)
+    @connection = mas_net_http(@response)
+    Net::HTTP.stub!(:new).and_return(@connection)
+    Twitter::User.stub!(:unmarshal).and_return(@friend)
+  end
+  
+  def create_uri(action, id)
+  	"#{@uris[action]}/#{id}.json"
+  end
+  
+  it "should create expected HTTP GET request for :add case using integer user ID" do
+  	# the integer user ID scenario...
+    @twitter.should_receive(:create_http_get_request).with(create_uri(:add, @id)).and_return(@request)
+    @twitter.block(:add, @id)
+  end
+  
+  it "should create expected HTTP GET request for :add case using screen name" do
+    # the screen name scenario...
+    @twitter.should_receive(:create_http_get_request).with(create_uri(:add, @screen_name)).and_return(@request)
+    @twitter.block(:add, @screen_name)
+  end
+
+  it "should create expected HTTP GET request for :add case using Twitter::User object" do
+    # the Twitter::User object scenario...
+    @twitter.should_receive(:create_http_get_request).with(create_uri(:add, @friend.to_i)).and_return(@request)
+    @twitter.block(:add, @friend)
+  end
+  
+  it "should create expected HTTP GET request for :remove case using integer user ID" do
+    # the integer user ID scenario...
+    @twitter.should_receive(:create_http_get_request).with(create_uri(:remove, @id)).and_return(@request)
+    @twitter.block(:remove, @id)
+  end
+
+  it "should create expected HTTP GET request for :remove case using screen name" do
+    # the screen name scenario...
+    @twitter.should_receive(:create_http_get_request).with(create_uri(:remove, @screen_name)).and_return(@request)
+    @twitter.block(:remove, @screen_name)
+  end
+
+  it "should create expected HTTP GET request for :remove case using Twitter::User object" do
+    # the Twitter::User object scenario...
+    @twitter.should_receive(:create_http_get_request).with(create_uri(:remove, @friend.to_i)).and_return(@request)
+    @twitter.block(:remove, @friend)
+  end
+  
+  it "should bless user model returned for :add case" do
+    @twitter.should_receive(:bless_model).with(@friend)
+    @twitter.block(:add, @friend)
+  end
+  
+  it "should bless user model returned for :remove case" do
+    @twitter.should_receive(:bless_model).with(@friend)
+    @twitter.block(:remove, @friend)
+  end
+  
+  it "should raise ArgumentError if action given is not valid" do
+    lambda {
+      @twitter.block(:crap, @friend)
+    }.should raise_error(ArgumentError)
+  end
+  
+  after(:each) do
+    nilize(@twitter, @id, @uris, @request, @response, @connection)
+  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