dschn-tweetsy 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,6 @@
+= tweetsy
+
+A minimal and incomplete twitter client inspired from jnunemaker's twitter gem.
+Uses curb instead of net/http.
+
+USE AT YOUR OWN RISK!

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 0
+:major: 0
+:minor: 1

data/lib/tweetsy/client.rb

@@ -0,0 +1,140 @@
+module Tweetsy
+  class Client
+    API_HOST = "http://twitter.com"
+  
+    def initialize(login, password, options = {})
+      @config = options.merge(:auth => [login, password].join(':'))
+    end
+
+    def authenticate_as(login, password)
+      @config[:auth] = [login, password].join(':')
+    end
+
+    def authenticated?
+      begin
+        result = Curl::Easy.perform("#{API_HOST}/account/verify_credentials.xml") do |curl|
+          default_curl_options(curl)          
+          curl.userpwd = @config[:auth]
+        end
+      rescue => e
+        raise CantConnect, "#{e.message}"
+      end
+      
+      case result.response_code
+      when 200
+        return true
+      when 401
+        return false
+      else
+        raise CantConnect, "Twitter is returning a: #{result.response_code}"
+      end
+    end
+    
+    def verify_credentials
+      begin
+        doc = request(:get, '/account/verify_credentials.xml', :auth => true)
+        User.new(doc.at('user'))
+      rescue Tweetsy::Unauthorized
+        return false
+      end
+    end
+
+    def create_friendship(id_or_screen_name)
+      doc = request(:post, "/friendships/create/#{id_or_screen_name}.xml", :auth => true)
+      User.new(doc.at('user'))
+    end
+    
+    def destroy_friendship(id_or_screen_name)
+      doc = request(:post, "/friendships/destroy/#{id_or_screen_name}.xml", :auth => true)
+      User.new(doc.at('user'))
+    end
+  
+    def update(status, options = {})
+      form_data = { :status => status }
+      form_data[:source] = options[:source] if options[:source]
+      form_data[:in_reply_to_status_id] = options[:in_reply_to_status_id] if options[:in_reply_to_status_id]
+      
+      request(:post, "/statuses/update.xml", :auth => true, :form_data => form_data)      
+
+      # Update returns a <status> xml response but we don't need/care about that yet
+      # Can assume if no exceptions it was successful
+      true
+    end
+    
+    def direct_message(recipient, status)
+      form_data = { :user => recipient, :text => status }
+      request(:post, "/direct_messages/new.xml", :auth => true, :form_data => form_data)
+    end
+    
+    def friend_ids(id = nil)
+      endpoint = id ? "/friends/ids/#{id}.xml" : "/friends/ids.xml"
+      
+      doc = request(:get, endpoint, :auth => id ? nil : true) # apparently don't need :auth
+      (doc/:ids/:id).inject([]) { |friends_ids, id| friends_ids << id.inner_text.to_i }
+    end
+    
+    def user(id_or_screen_name)
+      doc = request(:get, "/users/show/#{id_or_screen_name}.xml", :auth => true)      
+      User.new(doc.at('user'))
+    end
+    
+    def friends_timeline(options = {})
+      if options[:since] && options[:since].kind_of?(Date)
+        options[:since] = options[:since].strftime('%a, %d-%b-%y %T GMT')
+      end
+
+      doc = request(:get, build_path("/statuses/friends_timeline.xml", options), :auth => true)
+      (doc/:status).inject([]) do |statuses, status|
+        statuses << Status.new(status)
+      end
+    end
+
+    # --------------------------------------------------------------
+
+    def build_path(path, params = {})
+      if params.any?
+        path += "?" + params.inject('') { |str, h| str += "#{CGI.escape(h[0].to_s)}=#{CGI.escape(h[1].to_s)}&" }
+      else
+        path
+      end
+    end
+
+    def request(method, endpoint, options = {})
+      raise ArgumentError, "#{method} is not a valid request method" unless [:get, :post].include?(method)
+
+      begin      
+        result = case method
+        when :get
+          Curl::Easy.perform("#{API_HOST}/#{endpoint}") do |curl|
+            default_curl_options(curl)
+            curl.userpwd = @config[:auth] if options[:auth]
+          end        
+        when :post
+          options[:form_data] ||= {}
+          post_fields = options[:form_data].inject([]) { |pfs, fd| pfs << Curl::PostField.content(fd[0].to_s, fd[1]) }
+          
+          Curl::Easy.http_post("#{API_HOST}/#{endpoint}", *post_fields) do |curl|
+            default_curl_options(curl)
+            curl.userpwd = @config[:auth] if options[:auth]
+          end
+        end
+      rescue => e
+        raise CantConnect, "#{e.message}"
+      end
+      
+      if [200, 304].include?(result.response_code)
+        Hpricot(result.body_str)
+      elsif result.response_code == 401
+        raise Unauthorized
+      elsif result.response_code == 503
+        raise CantConnect, "Service unavailable"
+      else
+        raise CantConnect, "#{result.response_code}"
+      end
+    end
+    
+    def default_curl_options(curl)
+      curl.timeout = @config[:timeout] || 10
+    end
+  end
+end

data/lib/tweetsy/status.rb

@@ -0,0 +1,14 @@
+module Tweetsy
+  class Status
+    ATTRIBUTES = [:created_at, :id, :favorited, :text, :user, :source, :truncated, :in_reply_to_status_id, :in_reply_to_user_id, :in_reply_to_screen_name, :text]
+    attr_accessor *ATTRIBUTES
+    
+    def initialize(xml)
+      ATTRIBUTES.each do |attr|
+        self.send("#{attr}=", xml.at(attr.to_s).innerHTML) if xml.at(attr.to_s)
+      end
+      
+      self.user = User.new(xml.at('user')) if xml.at('user')
+    end
+  end
+end

data/lib/tweetsy/user.rb

@@ -0,0 +1,15 @@
+module Tweetsy
+  class User
+    ATTRIBUTES = [:id, :name, :screen_name, :location, :description, :url, :profile_image_url, :profile_background_color, 
+                  :profile_text_color, :profile_link_color, :profile_sidebar_fill_color, :profile_sidebar_border_color, 
+                  :friends_count, :favourites_count, :statuses_count, :followers_count, :utc_offset, :protected, :status]
+
+    attr_accessor *ATTRIBUTES
+    
+    def initialize(xml)
+      ATTRIBUTES.each do |attr|
+        self.send("#{attr}=", xml.at(attr.to_s).innerHTML) if xml.at(attr.to_s)
+      end
+    end
+  end
+end

data/lib/tweetsy.rb

@@ -0,0 +1,11 @@
+require 'curb'
+require 'hpricot'
+
+module Tweetsy
+  class CantConnect < StandardError; end
+  class Unauthorized < CantConnect; end
+end
+
+require File.dirname(__FILE__) + '/tweetsy/user'
+require File.dirname(__FILE__) + '/tweetsy/status'
+require File.dirname(__FILE__) + '/tweetsy/client'

data/spec/client_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "Tweetsy::Client" do
+  before do
+    @base = Tweetsy::Client.new('foo', 'bar')
+  end
+    
+  describe "authenticated?" do
+    it "should return true on successful authentication (200)" do
+      Curl::Easy.stub!(:perform).and_return(mock(:result, :response_code => 200))
+      @base.authenticated?.should be_true
+    end
+    
+    it "should return false on unsuccessful authentication (401)" do
+      Curl::Easy.stub!(:perform).and_return(mock(:result, :response_code => 401))
+      @base.authenticated?.should be_false
+    end
+    
+    it "should raise CantConnect on anything that's not 200 or 401" do
+      Curl::Easy.stub!(:perform).and_return(mock(:result, :response_code => 502))
+      lambda {
+        @base.authenticated?
+      }.should raise_error(Tweetsy::CantConnect)
+    end
+  end
+    
+  describe "being initialized" do
+    it "should require email and password" do
+      lambda { Tweetsy::Client.new }.should raise_error(ArgumentError)
+    end
+  end
+  
+  describe "timelines" do
+    it "should be able to retrieve friends timeline" do
+      data = open(File.dirname(__FILE__) + '/fixtures/friends_timeline.xml').read
+      @base.should_receive(:request).and_return(Hpricot::XML(data))
+      @base.friends_timeline.size.should == 3
+    end
+  end
+  
+  describe "social graphs" do
+    it "should be able to retrieve friend_ids" do
+      data = open(File.dirname(__FILE__) + '/fixtures/friend_ids.xml').read
+      @base.should_receive(:request).and_return(Hpricot::XML(data))
+      @base.friend_ids.size.should == 3
+    end
+  end
+  
+  describe "users" do
+    it "should be able to get single user" do
+      data = open(File.dirname(__FILE__) + '/fixtures/user.xml').read
+      @base.should_receive(:request).and_return(Hpricot::XML(data))
+      @base.user('4243').name.should == 'John Nunemaker'
+    end
+  end
+  
+  describe "request" do   
+    it "should raise ArgumentError on bad arguments" do
+      lambda { 
+        @base.request(:whoa, 'nada')
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should raise Unauthorized on 401" do
+      response = mock(:response, :response_code => 401)
+      Curl::Easy.stub!(:perform).and_return(response)
+      
+      lambda {
+        @base.request(:get, 'blah')
+      }.should raise_error(Tweetsy::Unauthorized)
+      
+      lambda {
+        @base.request(:get, 'blah')        
+      }.should raise_error(Tweetsy::CantConnect)
+    end
+
+    it "should raise CantConnect on anything that isn't 200 or 304 response" do
+      [401, 503, 504, 505, nil].each do |code|
+        response = mock(:response, :response_code => code)
+        Curl::Easy.stub!(:perform).and_return(response)
+        
+        lambda {
+          @base.request(:get, 'blah')
+        }.should raise_error(Tweetsy::CantConnect)
+      end
+    end
+  end
+end

data/spec/fixtures/friend_ids.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ids>
+<id>7318032</id>
+<id>3829151</id>
+<id>676573</id>
+</ids>

data/spec/fixtures/friends_timeline.xml

@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<statuses type="array">
+	<status>
+		<created_at>Sun May 04 21:59:52 +0000 2008</created_at>
+		<id>803435310</id>
+		<text>Writing tests (rspec) for the twitter gem that all can run. Wish I would have done this when I wrote it years back.</text>
+		<source>&lt;a href="http://iconfactory.com/software/twitterrific"&gt;twitterrific&lt;/a&gt;</source>
+		<truncated>false</truncated>
+		<in_reply_to_status_id></in_reply_to_status_id>
+		<in_reply_to_user_id></in_reply_to_user_id>
+		<favorited>false</favorited>
+		<user>
+			<id>4243</id>
+			<name>John Nunemaker</name>
+			<screen_name>jnunemaker</screen_name>
+			<location>Indiana</location>
+			<description>Loves his wife, ruby, notre dame football and iu basketball</description>	
+				<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/52619256/ruby_enterprise_shirt_normal.jpg</profile_image_url>
+			<url>http://addictedtonew.com</url>
+			<protected>false</protected>
+			<followers_count>363</followers_count>
+		</user>
+	</status>
+	<status>
+		<created_at>Sun May 04 20:38:39 +0000 2008</created_at>
+		<id>803397135</id>
+		<text>This weekend's open-window apartment cleaning serenade to the corner of 4th &amp; Harrison: My Morning Jacket.</text>
+		<source>web</source>
+		<truncated>false</truncated>
+		<in_reply_to_status_id></in_reply_to_status_id>
+		<in_reply_to_user_id></in_reply_to_user_id>
+		<favorited>false</favorited>
+		<user>
+			<id>18713</id>
+			<name>Alex Payne</name>
+			<screen_name>al3x</screen_name>
+			<location>San Francisco, CA</location>
+			<description>Oh, hi.  No, I just work here.</description>
+			<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/51961745/al3x_normal.jpg</profile_image_url>
+			<url>http://www.al3x.net</url>
+			<protected>false</protected>
+			<followers_count>2891</followers_count>
+		</user>
+	</status>
+	<status>
+		<created_at>Sun May 04 19:46:01 +0000 2008</created_at>
+		<id>803372400</id>
+		<text>Experiencing Philz Coffee for the first time. It's 2 blocks from my house. Don't know what took me so long.</text>
+		<source>web</source>
+		<truncated>false</truncated>
+		<in_reply_to_status_id></in_reply_to_status_id>
+		<in_reply_to_user_id></in_reply_to_user_id>
+		<favorited>false</favorited>
+		<user>
+			<id>20</id>
+			<name>Evan Williams</name>
+			<screen_name>ev</screen_name>
+			<location>San Francisco, CA, US</location>
+			<description>Founder of Obvious </description>
+			<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/14019652/ev-sky_normal.jpg</profile_image_url>
+			<url>http://evhead.com</url>
+			<protected>false</protected>
+			<followers_count>11463</followers_count>
+		</user>
+	</status>
+</statuses>

data/spec/fixtures/user.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<user>
+  <id>4243</id>
+  <name>John Nunemaker</name>
+  <screen_name>jnunemaker</screen_name>
+  <location>Indiana</location>
+  <description>Loves his wife, ruby, notre dame football and iu basketball</description>
+	<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/52619256/ruby_enterprise_shirt_normal.jpg</profile_image_url>
+  <url>http://addictedtonew.com</url>
+  <protected>false</protected>
+  <followers_count>363</followers_count>
+  <profile_background_color>FFFFFF</profile_background_color>
+  <profile_text_color>000000</profile_text_color>
+
+  <profile_link_color>000000</profile_link_color>
+  <profile_sidebar_fill_color>FD8C19</profile_sidebar_fill_color>
+  <profile_sidebar_border_color>F82500</profile_sidebar_border_color>
+  <friends_count>109</friends_count>
+  <created_at>Sun Aug 13 22:56:06 +0000 2006</created_at>
+  <favourites_count>18</favourites_count>
+  <utc_offset>-18000</utc_offset>
+  <time_zone>Indiana (East)</time_zone>
+ 	<profile_background_image_url>http://s3.amazonaws.com/twitter_production/profile_background_images/2349547/logo.jpg</profile_background_image_url>
+  <profile_background_tile>false</profile_background_tile>
+  <following>false</following>
+  <notifications>false</notifications>
+  <statuses_count>1981</statuses_count>
+  <status>
+    <created_at>Sun May 04 21:59:52 +0000 2008</created_at>
+    <id>803435310</id>
+    <text>Writing tests (rspec) for the twitter gem that all can run. Wish I would have done this when I wrote it years back.</text>
+    <source>&lt;a href="http://iconfactory.com/software/twitterrific"&gt;twitterrific&lt;/a&gt;</source>
+    <truncated>false</truncated>
+    <in_reply_to_status_id></in_reply_to_status_id>
+    <in_reply_to_user_id></in_reply_to_user_id>
+    <favorited>false</favorited>
+  </status>
+</user>

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require 'rubygems'
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+dir = File.dirname(__FILE__)
+
+$:.unshift(File.join(dir, '/../lib/'))
+require dir + '/../lib/tweetsy'

data/spec/status_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Tweetsy::Status do
+  it "should create new status from xml doc" do
+    xml = <<EOF
+<status>
+	<created_at>Sun May 04 21:59:52 +0000 2008</created_at>
+	<id>803435310</id>
+	<text>Writing tests (rspec) for the twitter gem that all can run. Wish I would have done this when I wrote it years back.</text>
+	<source>&lt;a href="http://iconfactory.com/software/twitterrific"&gt;twitterrific&lt;/a&gt;</source>
+	<truncated>false</truncated>
+	<in_reply_to_status_id></in_reply_to_status_id>
+	<in_reply_to_user_id></in_reply_to_user_id>
+	<in_reply_to_screen_name>blah</in_reply_to_screen_name>
+	<favorited>false</favorited>
+	<user>
+		<id>4243</id>
+		<name>John Nunemaker</name>
+		<screen_name>jnunemaker</screen_name>
+		<location>Indiana</location>
+		<description>Loves his wife, ruby, notre dame football and iu basketball</description>	
+			<profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/52619256/ruby_enterprise_shirt_normal.jpg</profile_image_url>
+		<url>http://addictedtonew.com</url>
+		<protected>false</protected>
+		<followers_count>363</followers_count>
+	</user>
+</status>
+EOF
+    s = Tweetsy::Status.new(Hpricot.XML(xml))
+    s.id.should == '803435310'
+    s.created_at.should == 'Sun May 04 21:59:52 +0000 2008'
+    s.text.should == 'Writing tests (rspec) for the twitter gem that all can run. Wish I would have done this when I wrote it years back.'
+    s.source.should == '&lt;a href="http://iconfactory.com/software/twitterrific"&gt;twitterrific&lt;/a&gt;'
+    s.truncated.should == "false"
+    s.in_reply_to_status_id.should == ''
+    s.in_reply_to_user_id.should == ''
+    s.in_reply_to_screen_name.should == 'blah'
+    s.favorited.should == "false"
+    s.user.id.should == '4243'
+    s.user.name.should == 'John Nunemaker'
+  end
+end

data/spec/user_spec.rb

@@ -0,0 +1,42 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Tweetsy::User do  
+  it "should create new user from xml doc" do
+    xml = <<EOF
+<user>
+  <id>18713</id>
+  <name>Alex Payne</name>
+  <screen_name>al3x</screen_name>
+  <location>San Francisco, CA</location>
+  <description>Oh, hi.  No, I just work here.</description>
+  <profile_image_url>http://s3.amazonaws.com/twitter_production/profile_images/51961745/al3x_normal.jpg</profile_image_url>
+  <url>http://www.al3x.net</url>
+  <protected>false</protected>
+  <followers_count>2889</followers_count>
+  <status>
+    <created_at>Sun May 04 22:38:39 +0000 2008</created_at>
+    <id>803453211</id>
+    <text>@5dots Yes.  Give me about 8 hours.  *sigh*</text>
+
+    <source>&lt;a href="http://iconfactory.com/software/twitterrific"&gt;twitterrific&lt;/a&gt;</source>
+    <truncated>false</truncated>
+    <in_reply_to_status_id>803450314</in_reply_to_status_id>
+    <in_reply_to_user_id>618923</in_reply_to_user_id>
+    <favorited>false</favorited>
+
+  </status>
+</user>
+EOF
+    u = Tweetsy::User.new(Hpricot.XML(xml))
+    u.id.should == '18713'
+    u.name.should =='Alex Payne'
+    u.screen_name.should == 'al3x'
+    u.location.should == 'San Francisco, CA'
+    u.description.should == 'Oh, hi.  No, I just work here.'
+    u.profile_image_url.should == 'http://s3.amazonaws.com/twitter_production/profile_images/51961745/al3x_normal.jpg'
+    u.url.should == 'http://www.al3x.net'
+    u.protected.should == "false"
+    u.followers_count.should == '2889'
+    #u.status.text.should == '@5dots Yes.  Give me about 8 hours.  *sigh*'
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: dschn-tweetsy
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dustin Schneider
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-16 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dustin@genevate.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/tweetsy
+- lib/tweetsy/client.rb
+- lib/tweetsy/status.rb
+- lib/tweetsy/user.rb
+- lib/tweetsy.rb
+- spec/client_spec.rb
+- spec/fixtures
+- spec/fixtures/friend_ids.xml
+- spec/fixtures/friends_timeline.xml
+- spec/fixtures/user.xml
+- spec/spec_helper.rb
+- spec/status_spec.rb
+- spec/tweetsy_spec.rb
+- spec/user_spec.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/dschn/tweetsy
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: []
+