markpercival-twitter_getter 1.0.6

data/.gitignore

@@ -0,0 +1 @@
+/spec/test_account.yaml

data/README.markdown

@@ -0,0 +1,24 @@
+# TwitterGetter - A simple Twitter API gem
+
+## Installation
+
+    sudo gem install markpercival-twittergetter --sources http://gems.github.com
+
+## Usage
+  
+    @tg = TwitterGetter::Base.new('ev', 'password')
+    tweets = @tg.search('failwhale')
+    tweets.each do |t|
+      p "#{t.from_user}: #{t.text}"
+    end
+    
+    @tg.follow('aplusk')
+
+## License
+
+This code is free to use under the terms of the MIT license. 
+
+## Contact
+
+Mark Percival <mark@mpercival.com>
+

data/lib/twitter_getter.rb

@@ -0,0 +1,123 @@
+require 'rubygems'
+require 'cgi'
+require 'rest_client'
+require 'json/pure'
+require 'twitter_getter/promiscuous_struct'
+
+module TwitterGetter
+
+  class Tweet
+    include PromiscuousStruct
+  end
+
+  class User
+    include PromiscuousStruct
+  end
+
+  class Base
+
+    attr_accessor :user, :password
+
+    def initialize(user=nil, password=nil)
+      @user = user
+      @password = password
+    end
+    
+    def update_status(message, in_reply_to_status_id = nil)
+      raise AuthenicationNeeded if @password.nil?
+      t = JSON.parse(RestClient.post("http://#{@user}:#{@password}@twitter.com/statuses/update.json", 
+                 :status => message,
+                 :in_reply_to_status_id => in_reply_to_status_id))
+      Tweet.new(t)
+    end
+    
+    def destroy_status(id)
+      raise AuthenicationNeeded if @password.nil?
+      t = JSON.parse(RestClient.post("http://#{@user}:#{@password}@twitter.com/statuses/destroy/#{id}.json", :id => id))
+      Tweet.new(t)
+    end
+    
+    def status(id)
+      t = JSON.parse(RestClient.get("http://twitter.com/statuses/show/#{id}.json"))
+      Tweet.new(t)
+    end
+
+    def friend_ids
+      JSON.parse(RestClient.get("http://twitter.com/friends/ids/#{self.user}.json"))
+    end
+
+    def follower_ids
+      JSON.parse(RestClient.get("http://twitter.com/followers/ids/#{self.user}.json"))
+    end
+
+    def unfriendly_ids
+      self.friend_ids - self.follower_ids
+    end
+
+    def unfollow(id)
+      raise AuthenicationNeeded if @password.nil?
+      begin
+        u = JSON.parse(RestClient.post("http://#{@user}:#{@password}@twitter.com/friendships/destroy/#{id}.json", :id => id))
+        u['status'] ? User.new(u) : nil
+      rescue RestClient::ResourceNotFound => e
+        p "Error - #{e}" 
+        nil
+      end
+    end
+
+    def follow(id)
+      raise AuthenicationNeeded if @password.nil?
+      begin
+        u = JSON.parse(RestClient.post("http://#{@user}:#{@password}@twitter.com/friendships/create/#{id}.json", :id => id))
+        u['status'] ? User.new(u) : nil
+      rescue RestClient::ResourceNotFound => e
+        p "Error - #{e}" 
+        nil
+      end
+    end
+
+    def rate_limit_status
+      results = JSON.parse(RestClient.get("http://#{@user}:#{@password}@twitter.com/account/rate_limit_status.json"))
+    end
+
+    def search(term, opts = {})
+      if opts[:max_pages]
+        max_pages = opts[:max_pages]
+        opts.delete(:max_pages)
+      end
+      term = CGI.escape(term)
+      opts = {
+        :since_id => 10,
+        :rpp => 50
+      }.merge(opts)
+      params = hash2params(opts)
+      tweets = []
+      JSON.parse(RestClient.get("http://search.twitter.com/search.json?q=#{term}#{params}"))['results'].each do |t|
+        tweets << Tweet.new(t)
+      end
+      results = tweets.size
+      page = 2
+      while results == 50 && page <= max_pages.to_i
+        next_tweets = JSON.parse(RestClient.get("http://search.twitter.com/search.json?q=#{term}#{params}&page=#{page}"))['results']
+        results = next_tweets.size
+        next_tweets.each do |t|
+          tweets << Tweet.new(t)
+        end
+        page += 1
+      end
+      tweets.reverse
+    end
+
+    private
+
+    def hash2params(hash)
+      params = ''
+      hash.each_pair do |k,v|
+        params += "&#{k}=#{CGI.escape(v.to_s)}"
+      end
+      params
+    end
+
+
+  end
+end

data/lib/twitter_getter/promiscuous_struct.rb

@@ -0,0 +1,35 @@
+module PromiscuousStruct
+  attr_reader :attributes
+  
+  def initialize(h)
+    @attributes = h
+  end
+  
+  def get_val(a)
+    val = @attributes[a] || @attributes[a.to_s] || @attributes[a.to_sym]
+    if val.is_a?(Hash)
+      self.class.new(val)
+    else
+      val
+    end
+  end
+  
+  def [](a)
+   get_val(a)
+  end
+  
+  # an existing but depricated method we need to overide
+  def id
+    get_val(:id)
+  end
+  
+  def method_missing(m)
+    if val = get_val(m)
+      return val
+    elsif @attributes.respond_to?(m)
+      return @attributes.send(m)
+    else
+      nil
+    end
+  end
+end

data/spec/destroy_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe TwitterGetter, "behaviour" do
+  
+  it "should destroy an existing status" do
+     auth = YAML.load(File.open(File.dirname(__FILE__) + '/test_account.yaml'))
+     tg = TwitterGetter::Base.new(auth['user'], auth['password'])
+     p tg.destroy_status(1650005187)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+dir = File.dirname(__FILE__)
+
+$:.unshift(File.join(dir, '/../lib/'))
+require dir + '/../lib/twitter_getter'
+
+
+def unauthenticate_twitter
+  TwitterGetter::Base.new
+end
+
+def authenticated_twitter
+  auth = YAML.load(File.open(File.dirname(__FILE__) + '/test_account.yaml'))
+  TwitterGetter::Base.new(auth['user'], auth['password'])
+end

data/spec/test_account.sample.yaml

@@ -0,0 +1,4 @@
+---
+  # Just rename this to test_account.yaml to run the specs
+user: testaccount
+password: secret

data/spec/tweet_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe TwitterGetter::Tweet, "behaviour" do
+  
+  
+  before :all do
+    @t = TwitterGetter::Tweet.new(:itsa => "hash", :andalso => {:complex=>true}, 'andevenallows' => 'string keys')
+  end
+  
+  it "should instantiate with a hash and be accessible" do
+    @t.andalso.complex.should == true
+    @t.andalso[:complex].should == true
+    @t[:itsa].should == 'hash'
+    @t['itsa'].should == 'hash'
+    @t.itsa.should == 'hash'
+    @t.size.should == 3
+  end
+  
+  it "should force instantiation with a hash" do
+    lambda {TwitterGetter::Tweet.new()}.should raise_error(ArgumentError)
+  end
+  
+  it "should raise nil on an unknown method call" do
+    @t.wtf.should == nil
+  end
+  
+  
+end
+
+
+describe TwitterGetter, "example of what to expect in the return from twitter" do
+  
+  before :all do
+    @tg = authenticated_twitter
+    @status_update =  @tg.search('twitter').first
+  end
+  
+  it "from a status update" do
+    @status_update.from_user.should be_an_instance_of(String)
+  end
+  
+  it "from a user follow" do
+    user = @tg.follow(@status_update.from_user)
+    user.screen_name.should == @status_update.from_user
+    user.friends_count.should >= 0
+  end
+  
+end

data/spec/twitter_getter_spec.rb

@@ -0,0 +1,49 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'yaml'
+
+describe TwitterGetter, "GeoIP search" do
+  
+  
+  before :all do
+    @tg = unauthenticate_twitter
+  end
+  
+  it "should find all location based tweets" do
+    t = @tg.search('twitter', :geocode => '33.75916942652898,-84.38941955566406,100mi')
+    t.size.should eql(50)
+    t[0].from_user.size.should >= 1
+  end
+  
+  it "should allow search multiple pages" do
+    t = @tg.search('twitter', :geocode => '33.75916942652898,-84.38941955566406,100mi', :max_pages => 2)
+    t.size.should eql(100)
+  end
+  
+  
+end
+
+describe TwitterGetter, "sends a tweet, find it, and destroy it" do
+  
+  before :all do
+    @tg = authenticated_twitter
+    tweets = @tg.search('twitter')
+    t = tweets.first
+    @test_message = "RT @#{t.from_user} #{t.text[0, t.from_user.size + 5]}"
+    @test_update = @tg.update_status(@test_message)
+  end
+  
+  it "should be able to send and then find a status update for the authenticated user" do
+    @test_update.text.should eql(@test_message)
+  end
+  
+  it "should be able to find the test tweet" do
+    @tg.status(@test_update.id).text.should eql(@test_message)
+  end
+  
+  it "should also be able to destroy it" do
+    @tg.destroy_status(@test_update.id).text.should eql(@test_message)
+    # Verify it's destroyed
+    lambda {@tg.status(@test_update.id)}.should raise_error(RestClient::Exception)
+  end
+  
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: markpercival-twitter_getter
+version: !ruby/object:Gem::Version 
+  version: 1.0.6
+platform: ruby
+authors: 
+- Mark Percival
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-09 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mark@mpercival.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- README.markdown
+- lib/twitter_getter.rb
+- lib/twitter_getter/promiscuous_struct.rb
+- spec/destroy_spec.rb
+- spec/spec_helper.rb
+- spec/test_account.sample.yaml
+- spec/tweet_spec.rb
+- spec/twitter_getter_spec.rb
+has_rdoc: true
+homepage: http://github.com/markpercival/twitter_getter
+post_install_message: 
+rdoc_options: 
+- --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: TwitterGetter - The Twitter API Wrapper
+test_files: 
+- spec/destroy_spec.rb
+- spec/spec_helper.rb
+- spec/tweet_spec.rb
+- spec/twitter_getter_spec.rb