jnunemaker-twitter 0.5.3 → 0.6.0

data/History

@@ -1,3 +1,7 @@
+0.6.0 - April 11, 2009
+* 1 feature addition
+  * Added http authentication back in. You can now use oauth or http auth as your client.
+  
 0.5.3 - April 10, 2009
 * 1 minor fix
   * Twitter API assumed follow true whether true or false. Now only sending follow along to request if follow is true for calls to friendship_create.

data/README.rdoc

@@ -1,9 +1,13 @@
 = twitter
 
-The ruby twitter gem. The gem heard round the world and famous on the streets. Haha.
+The ruby twitter gem. The gem heard round the world and famous on the streets. Haha. This gem works with both oauth and http auth, if you care.
 
 For now this is just an API wrapper. The command line interface is temporarily dead until I have time to make it work with oauth. At that point, I'll make it a new gem twitter-cli or something and it will depend on this gem to work. That will keep the separation of the api wrapper and cli and fix a lot of dependency issues.
 
+= examples
+  
+  See the examples directory.
+
 == Copyright
 
 Copyright (c) 2009 John Nunemaker. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 5
-:patch: 3
+:minor: 6
+:patch: 0

data/examples/httpauth.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'twitter')
+require File.join(File.dirname(__FILE__), 'helpers', 'config_store')
+require 'pp'
+
+config = ConfigStore.new("#{ENV['HOME']}/.twitter")
+
+httpauth = Twitter::HTTPAuth.new(config['email'], config['password'])
+base = Twitter::Base.new(httpauth)
+
+pp base.user_timeline
+pp base.verify_credentials

data/lib/twitter/base.rb

@@ -2,10 +2,12 @@ module Twitter
   class Base
     extend Forwardable
     
-    def_delegators :@client, :get, :post
+    def_delegators :client, :get, :post
     
-    def initialize(oauth)
-      @client = oauth.access_token
+    attr_reader :client
+    
+    def initialize(client)
+      @client = client
     end
     
     # Options: since_id, max_id, count, page, since

data/lib/twitter/httpauth.rb

@@ -0,0 +1,26 @@
+module Twitter
+  class HTTPAuth
+    include HTTParty
+    base_uri 'http://twitter.com'
+    format :plain
+    
+    attr_reader :username, :password
+    
+    def initialize(username, password)
+      @username, @password = username, password
+    end
+    
+    def get(uri, headers={})
+      self.class.get(uri, :headers => headers, :basic_auth => basic_auth)
+    end
+    
+    def post(uri, body={}, headers={})
+      self.class.post(uri, :body => body, :headers => headers, :basic_auth => basic_auth)
+    end
+    
+    private
+      def basic_auth
+        @basic_auth ||= {:username => @username, :password => @password}
+      end
+  end
+end

data/lib/twitter/oauth.rb

@@ -1,5 +1,8 @@
 module Twitter
   class OAuth
+    extend Forwardable
+    def_delegators :access_token, :get, :post
+    
     attr_reader :ctoken, :csecret
     
     def initialize(ctoken, csecret)

data/lib/twitter/request.rb

@@ -2,20 +2,20 @@ module Twitter
   class Request
     extend Forwardable
     
-    def self.get(base, path, options={})
-      new(base, :get, path, options).perform
+    def self.get(client, path, options={})
+      new(client, :get, path, options).perform
     end
     
-    def self.post(base, path, options={})
-      new(base, :post, path, options).perform
+    def self.post(client, path, options={})
+      new(client, :post, path, options).perform
     end
     
-    attr_reader :base, :method, :path, :options
+    attr_reader :client, :method, :path, :options
     
-    def_delegators :base, :get, :post
+    def_delegators :client, :get, :post
     
-    def initialize(base, method, path, options={})
-      @base, @method, @path, @options = base, method, path, options
+    def initialize(client, method, path, options={})
+      @client, @method, @path, @options = client, method, path, options
     end
     
     def uri

data/lib/twitter.rb

@@ -35,6 +35,7 @@ directory = File.dirname(__FILE__)
 $:.unshift(directory) unless $:.include?(directory)
 
 require 'twitter/oauth'
+require 'twitter/httpauth'
 require 'twitter/request'
 require 'twitter/base'
 require 'twitter/search'

data/test/test_helper.rb

@@ -20,15 +20,17 @@ def fixture_file(filename)
   File.read(file_path)
 end
 
+def twitter_url(url)
+  url =~ /^http/ ? url : "http://twitter.com:80#{url}"
+end
+
 def stub_get(url, filename, status=nil)
-  url = url =~ /^http/ ? url : "http://twitter.com:80#{url}"
-  
   options = {:string => fixture_file(filename)}
   options.merge!({:status => status}) unless status.nil?
   
-  FakeWeb.register_uri(:get, url, options)
+  FakeWeb.register_uri(:get, twitter_url(url), options)
 end
 
 def stub_post(url, filename)
-  FakeWeb.register_uri(:post, "http://twitter.com:80#{url}", :string => fixture_file(filename))
+  FakeWeb.register_uri(:post, twitter_url(url), :string => fixture_file(filename))
 end

data/test/twitter/base_test.rb

@@ -10,8 +10,9 @@ class BaseTest < Test::Unit::TestCase
     end
     
     context "initialize" do
-      should "require an oauth object" do
-        @twitter.instance_variable_get('@client').should == @access_token
+      should "require a client" do
+        @twitter.client.should respond_to(:get)
+        @twitter.client.should respond_to(:post)
       end
     end
     

data/test/twitter/httpauth_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class HTTPAuthTest < Test::Unit::TestCase
+  context "Creating new instance" do
+    should "should take user and password" do
+      twitter = Twitter::HTTPAuth.new('username', 'password')
+      twitter.username.should == 'username'
+      twitter.password.should == 'password'
+    end
+  end
+  
+  context "Client methods" do
+    setup do
+      @twitter = Twitter::HTTPAuth.new('username', 'password')
+    end
+
+    should "be able to get" do
+      stub_get('http://twitter.com:80/statuses/user_timeline.json', 'user_timeline.json')
+      response = @twitter.get('/statuses/user_timeline.json')
+      response.should == fixture_file('user_timeline.json')
+    end
+    
+    should "be able to get with headers" do
+      @twitter.class.expects(:get).with(
+        '/statuses/user_timeline.json', {
+          :basic_auth => {:username => 'username', :password => 'password'}, 
+          :headers => {'Foo' => 'Bar'}
+        }
+      ).returns(fixture_file('user_timeline.json'))
+      @twitter.get('/statuses/user_timeline.json', {'Foo' => 'Bar'})
+    end
+    
+    should "be able to post" do
+      stub_post('http://twitter.com:80/statuses/update.json', 'status.json')
+      response = @twitter.post('/statuses/update.json', :text => 'My update.')
+      response.should == fixture_file('status.json')
+    end
+    
+    should "be able to post with headers" do
+      @twitter.class.expects(:post).with(
+        '/statuses/update.json', {
+          :headers => {'Foo' => 'Bar'}, 
+          :body => {:text => 'My update.'}, 
+          :basic_auth => {:username => 'username', :password => 'password'}
+        }
+      ).returns(fixture_file('status.json'))
+      @twitter.post('/statuses/update.json', {:text => 'My update.'}, {'Foo' => 'Bar'})
+    end
+  end
+end

data/test/twitter/oauth_test.rb

@@ -52,4 +52,20 @@ class OAuthTest < Test::Unit::TestCase
     twitter.access_token.token.should == 'atoken'
     twitter.access_token.secret.should == 'asecret'
   end
+  
+  should "delegate get to access token" do
+    access_token = mock('access token')
+    twitter = Twitter::OAuth.new('token', 'secret')
+    twitter.stubs(:access_token).returns(access_token)
+    access_token.expects(:get).returns(nil)
+    twitter.get('/foo')
+  end
+  
+  should "delegate post to access token" do
+    access_token = mock('access token')
+    twitter = Twitter::OAuth.new('token', 'secret')
+    twitter.stubs(:access_token).returns(access_token)
+    access_token.expects(:post).returns(nil)
+    twitter.post('/foo')
+  end
 end

data/test/twitter/request_test.rb

@@ -3,12 +3,12 @@ require File.dirname(__FILE__) + '/../test_helper'
 class RequestTest < Test::Unit::TestCase
   context "new get request" do
     setup do
-      @base = mock('twitter base')
-      @request = Twitter::Request.new(@base, :get, '/statuses/user_timeline.json', {:query => {:since_id => 1234}})
+      @client = mock('twitter client')
+      @request = Twitter::Request.new(@client, :get, '/statuses/user_timeline.json', {:query => {:since_id => 1234}})
     end
     
-    should "have base" do
-      @request.base.should == @base
+    should "have client" do
+      @request.client.should == @client
     end
     
     should "have method" do
@@ -34,7 +34,7 @@ class RequestTest < Test::Unit::TestCase
           stubs(:code).returns('200')
         end
         
-        @base.expects(:get).returns(response)
+        @client.expects(:get).returns(response)
         @object = @request.perform
       end
 
@@ -52,7 +52,7 @@ class RequestTest < Test::Unit::TestCase
           stubs(:code).returns('200')
         end
         
-        @base.expects(:get).returns(response)
+        @client.expects(:get).returns(response)
         @object = @request.perform
       end
 
@@ -64,21 +64,21 @@ class RequestTest < Test::Unit::TestCase
     
     context "with no query string" do
       should "not have any query string" do
-        request = Twitter::Request.new(@base, :get, '/statuses/user_timeline.json')
+        request = Twitter::Request.new(@client, :get, '/statuses/user_timeline.json')
         request.uri.should == '/statuses/user_timeline.json'
       end
     end
     
     context "with blank query string" do
       should "not have any query string" do
-        request = Twitter::Request.new(@base, :get, '/statuses/user_timeline.json', :query => {})
+        request = Twitter::Request.new(@client, :get, '/statuses/user_timeline.json', :query => {})
         request.uri.should == '/statuses/user_timeline.json'
       end
     end
     
     should "have get shortcut to initialize and perform all in one" do
       Twitter::Request.any_instance.expects(:perform).returns(nil)
-      Twitter::Request.get(@base, '/foo')
+      Twitter::Request.get(@client, '/foo')
     end
     
     should "allow setting query string and headers" do
@@ -87,15 +87,15 @@ class RequestTest < Test::Unit::TestCase
         stubs(:code).returns('200')
       end
       
-      @base.expects(:get).with('/statuses/friends_timeline.json?since_id=1234', {'Foo' => 'Bar'}).returns(response)
-      Twitter::Request.get(@base, '/statuses/friends_timeline.json?since_id=1234', :headers => {'Foo' => 'Bar'})
+      @client.expects(:get).with('/statuses/friends_timeline.json?since_id=1234', {'Foo' => 'Bar'}).returns(response)
+      Twitter::Request.get(@client, '/statuses/friends_timeline.json?since_id=1234', :headers => {'Foo' => 'Bar'})
     end
   end
   
   context "new post request" do
     setup do
-      @base = mock('twitter base')
-      @request = Twitter::Request.new(@base, :post, '/statuses/update.json', {:body => {:status => 'Woohoo!'}})
+      @client = mock('twitter client')
+      @request = Twitter::Request.new(@client, :post, '/statuses/update.json', {:body => {:status => 'Woohoo!'}})
     end
     
     should "allow setting body and headers" do
@@ -104,8 +104,8 @@ class RequestTest < Test::Unit::TestCase
         stubs(:code).returns('200')
       end
       
-      @base.expects(:post).with('/statuses/update.json', {:status => 'Woohoo!'}, {'Foo' => 'Bar'}).returns(response)
-      Twitter::Request.post(@base, '/statuses/update.json', :body => {:status => 'Woohoo!'}, :headers => {'Foo' => 'Bar'})
+      @client.expects(:post).with('/statuses/update.json', {:status => 'Woohoo!'}, {'Foo' => 'Bar'}).returns(response)
+      Twitter::Request.post(@client, '/statuses/update.json', :body => {:status => 'Woohoo!'}, :headers => {'Foo' => 'Bar'})
     end
     
     context "performing request" do
@@ -115,7 +115,7 @@ class RequestTest < Test::Unit::TestCase
           stubs(:code).returns('200')
         end
         
-        @base.expects(:post).returns(response)
+        @client.expects(:post).returns(response)
         @object = @request.perform
       end
 
@@ -126,7 +126,7 @@ class RequestTest < Test::Unit::TestCase
     
     should "have post shortcut to initialize and perform all in one" do
       Twitter::Request.any_instance.expects(:perform).returns(nil)
-      Twitter::Request.post(@base, '/foo')
+      Twitter::Request.post(@client, '/foo')
     end
   end
   
@@ -134,69 +134,69 @@ class RequestTest < Test::Unit::TestCase
     setup do
       oauth = Twitter::OAuth.new('token', 'secret')
       oauth.authorize_from_access('atoken', 'asecret')
-      @base = Twitter::Base.new(oauth)
+      @client = Twitter::Base.new(oauth)
     end
     
     should "not raise error for 200" do
       stub_get('http://twitter.com:80/foo', '', ['200'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should_not raise_error
     end
     
     should "not raise error for 304" do
       stub_get('http://twitter.com:80/foo', '', ['304'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should_not raise_error
     end
     
     should "raise RateLimitExceeded for 400" do
       stub_get('http://twitter.com:80/foo', 'rate_limit_exceeded.json', ['400'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::RateLimitExceeded)
     end
     
     should "raise Unauthorized for 401" do
       stub_get('http://twitter.com:80/foo', '', ['401'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::Unauthorized)
     end
     
     should "raise General for 403" do
       stub_get('http://twitter.com:80/foo', '', ['403'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::General)
     end
 
     should "raise NotFound for 404" do
       stub_get('http://twitter.com:80/foo', '', ['404'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::NotFound)
     end
 
     should "raise InformTwitter for 500" do
       stub_get('http://twitter.com:80/foo', '', ['500'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::InformTwitter)
     end
 
     should "raise Unavailable for 502" do
       stub_get('http://twitter.com:80/foo', '', ['502'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::Unavailable)
     end
 
     should "raise Unavailable for 503" do
       stub_get('http://twitter.com:80/foo', '', ['503'])
       lambda {
-        Twitter::Request.get(@base, '/foo')
+        Twitter::Request.get(@client, '/foo')
       }.should raise_error(Twitter::Unavailable)
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jnunemaker-twitter
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors: 
 - John Nunemaker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-10 00:00:00 -07:00
+date: 2009-04-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -110,11 +110,13 @@ files:
 - examples/connect.rb
 - examples/friendship_existance.rb
 - examples/helpers/config_store.rb
+- examples/httpauth.rb
 - examples/search.rb
 - examples/timeline.rb
 - examples/update.rb
 - lib/twitter.rb
 - lib/twitter/base.rb
+- lib/twitter/httpauth.rb
 - lib/twitter/oauth.rb
 - lib/twitter/request.rb
 - lib/twitter/search.rb
@@ -128,6 +130,7 @@ files:
 - test/fixtures/user_timeline.json
 - test/test_helper.rb
 - test/twitter/base_test.rb
+- test/twitter/httpauth_test.rb
 - test/twitter/oauth_test.rb
 - test/twitter/request_test.rb
 - test/twitter/search_test.rb
@@ -161,6 +164,7 @@ summary: wrapper for the twitter api (oauth only)
 test_files: 
 - test/test_helper.rb
 - test/twitter/base_test.rb
+- test/twitter/httpauth_test.rb
 - test/twitter/oauth_test.rb
 - test/twitter/request_test.rb
 - test/twitter/search_test.rb
@@ -168,6 +172,7 @@ test_files:
 - examples/connect.rb
 - examples/friendship_existance.rb
 - examples/helpers/config_store.rb
+- examples/httpauth.rb
 - examples/search.rb
 - examples/timeline.rb
 - examples/update.rb