mikedamage-tweeb 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,9 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+spec/test_auth.yml
+*.tmproj
+._*
+*~

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Green
+
+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.textile

@@ -0,0 +1,52 @@
+h1. Tweeb
+
+Tweeb is a really simple, bare bones Twitter library that I created because I'm a glutton for punishment and enjoy reinventing the wheel.
+In all seriousness, I'm creating it because I want to understand the Twitter API and the best way to understand something is to get your hands dirty. I don't expect anyone but me to actually use it, since John Nunemaker's Twitter gem is most excellent.
+
+I'm using his "HTTParty":http://github.com/jnunemaker/httparty gem (at least at first) for the REST API, but I might get frisky and use "Yajl-Ruby":http://github.com/brianmario/yajl-ruby/tree/master to provide Stream API functionality.
+
+h2. Documentation
+
+Head on over to "http://rdoc.info/projects/mikedamage/tweeb":http://rdoc.info/projects/mikedamage/tweeb to peruse the project's RDoc at your leisure. The basics to get you up and Tweebing in no time are below:
+
+h2. Installing
+
+Once I get to a stable point in development, I'll release this project as a gem. Then all you'll have to do is
+
+<pre>
+	$ sudo gem sources -a http://gems.github.com
+	$ sudo gem install mikedamage-tweeb
+</pre>
+
+h2. Usage
+
+h3. Tweeb::Client
+
+<pre>
+	require "rubygems"
+	require "tweeb"
+	
+	tweeb = Tweeb::Client.new('username', 'password')
+	public_timeline = tweeb.public_timeline # can also be: tweeb.timeline(:public)
+	public_timeline.each do |tweet|
+		puts tweet["text"]
+	end
+</pre>
+
+h3. Tweeb::Stream
+
+<pre>
+	require "rubygems"
+	require "tweeb"
+	
+	tweeb = Tweeb::Stream.new('username', 'password')
+	
+	# Uses Twitter's "spritzer" stream
+	tweeb.spritzer do |tweet|
+		puts tweet["text"]
+	end
+</pre>
+
+h2. Copyright
+
+Copyright (c) 2009 Mike Green. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tweeb"
+    gem.summary = %Q{Tweeb is a really simple, bare bones Twitter library made possible by HTTParty}
+    gem.email = "mike.is.green@gmail.com"
+    gem.homepage = "http://github.com/mikedamage/tweeb"
+    gem.authors = ["Mike Green"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |spec|
+    spec.libs << 'spec'
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tweeb #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/lib/tweeb.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), "tweeb_client.rb")
+require File.join(File.dirname(__FILE__), "tweeb_stream.rb")
+require File.join(File.dirname(__FILE__), "tweeb_search.rb")

data/lib/tweeb_client.rb

@@ -0,0 +1,288 @@
+require "rubygems"
+require "httparty"
+require File.join(File.dirname(__FILE__), "tweeb_client_error.rb")
+require File.join(File.dirname(__FILE__), "tweeb_search.rb")
+
+class Hash
+	def symbolize_keys
+		t = self.dup
+		self.clear
+		t.each_pair do |key, value|
+			self[key.to_sym] = value
+		end
+		return self
+	end
+end
+
+module Tweeb
+	class Client
+		include HTTParty
+		attr_reader :username, :password
+		
+		base_uri "http://twitter.com"
+		format :json
+	
+		def initialize(username, password, options={})
+			@username = username
+			@password = password
+			@options = {
+				:public_refresh => 60
+			}.merge(options)
+			self.class.basic_auth(@username, @password)
+			@symbolizer = lambda {|hash| hash['user'].symbolize_keys; hash.symbolize_keys; return hash }
+		end
+		
+		def timeline(type, options={})
+			case type
+				when :public then public_timeline(options)
+				when :user then user_timeline(options)
+				when :friends then friends_timeline(options)
+			end
+		end
+		
+		def public_timeline(options={})
+			if options.empty?
+				json = self.class.get("/statuses/public_timeline.json")
+			else
+				if options[:count] && options[:count] > 200
+					raise Tweeb::ClientError, "Count must be less than 200"
+				end
+				json = self.class.get("/statuses/public_timeline.json", :query => options)
+			end
+			timeline = Array.new
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:user].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def user_timeline(options={})
+			if options.empty?
+				json = self.class.get("/statuses/user_timeline.json")
+			else
+				if options[:count] && options[:count] > 200
+					raise Tweeb::ClientError, "Count must be less than 200"
+				end
+				json = self.class.get("/statuses/user_timeline.json", :query => options)
+			end
+			timeline = Array.new
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:user].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def friends_timeline(options={})
+			if options.empty?
+				json = self.class.get("/statuses/friends_timeline.json")
+			else
+				if options[:count] && options[:count] > 200
+					raise Tweeb::ClientError, "Count must be less than 200"
+				end
+				json = self.class.get("/statuses/friends_timeline.json", :query => options)
+			end
+			timeline = Array.new
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:user].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def mentions(options={})
+			if options.empty?
+				json = self.class.get("/statuses/mentions.json")
+			else
+				if options[:count] and options[:count] > 200
+					raise Tweeb::ClientError, "Count must be less than 200"
+				end
+				json = self.class.get("/statuses/mentions.json", :query => options)
+			end
+			timeline = Array.new
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:user].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def update_status(message, reply_id=nil)
+			if message.length > 140
+				raise Tweeb::ClientError, "Message must be 140 characters or less"
+			end
+			if reply_id
+				json = self.class.post("/statuses/update.json", :query => {:status => message, :in_reply_to_status_id => reply_id})
+			else
+				json = self.class.post("/statuses/update.json", :query => {:status => message})
+			end
+			json.symbolize_keys
+			json[:user].symbolize_keys
+			json
+		end
+		
+		def delete_status(id)
+			json = self.class.delete("/statuses/destroy/#{id}.json")
+			json.symbolize_keys
+			json[:user].symbolize_keys
+			json
+		end
+		
+		def search(query, options={})
+			Tweeb::Search.search(query, options)
+		end
+		
+		def trends(type=:trends)
+			case type
+				when :trends then Tweeb::Search.trends
+				when :current then Tweeb::Search.current_trends
+				when :daily then Tweeb::Search.daily_trends
+				when :weekly then Tweeb::Search.weekly_trends
+			end
+		end
+		
+		def get_status(id)
+			json = self.class.get("/statuses/show/#{id}.json")
+			json.symbolize_keys
+			json[:user].symbolize_keys
+			json
+		end
+		
+		def friends(options={})
+			if options.empty?
+				json = self.class.get("/statuses/friends.json")
+			else
+				json = self.class.get("/statuses/friends.json", :query => options)
+			end
+			timeline = Array.new
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:user].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def show_user(id)
+			json = self.class.get("/users/show/#{id}.json")
+			json.symbolize_keys
+		end
+		
+		def direct_message_inbox(options={})
+			if options.empty?
+				json = self.class.get("/direct_messages.json")
+			else
+				if options[:count] and options[:count] > 200
+					raise Tweeb::ClientError, "Count must be less than 200"
+				end
+				json = self.class.get("/direct_messages.json", :query => options)
+			end
+			timeline = Array.new
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:sender].symbolize_keys
+				tweet[:recipient].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def direct_messages_sent(options={})
+			if options.empty?
+				json = self.class.get("/direct_messages/sent.json")
+			else
+				if options[:count] and options[:count] > 200
+					raise Tweeb::ClientError, "Count must be less than 200"
+				end
+				json = self.class.get("/direct_messages/sent.json", :query => options)
+			end
+			json.each do |tweet|
+				tweet.symbolize_keys
+				tweet[:sender].symbolize_keys
+				tweet[:recipient].symbolize_keys
+				timeline << tweet
+			end
+			timeline
+		end
+		
+		def direct_message(recipient, message)
+			json = self.class.post("/direct_messages/new.json", :query => {:user => recipient, :text => message})
+			json.symbolize_keys
+			json[:sender].symbolize_keys
+			json[:recipient].symbolize_keys
+			json
+		end
+		
+		def delete_direct_message(id)
+			json = self.class.delete("/direct_messages/destroy.json", :query => {:id => id})
+			json.symbolize_keys
+			json[:sender].symbolize_keys
+			json[:recipient].symbolize_keys
+			json
+		end
+		
+		def befriend(user, options={:follow => true})
+			json = self.class.post("/friendships/create.json", :query => {:id => user}.merge(options))
+			json.symbolize_keys
+			json[:status].symbolize_keys
+			json
+		end
+		alias_method :follow, :befriend
+		
+		def unfriend(user)
+			json = self.class.delete("/friendships/destroy.json", :query => {:id => user})
+			json.symbolize_keys
+			json[:status].symbolize_keys
+			json
+		end
+		alias_method :unfollow, :unfriend
+		
+		def friendship_info(target, source=nil)
+			query = Hash.new
+			if source
+				if source.is_a?(Fixnum)
+					query[:source_id] = source
+				elsif source.is_a?(String)
+					query[:source_screen_name] = source
+				end
+			end
+			
+			if target.is_a?(Fixnum)
+				query[:target_id] = target
+			elsif target.is_a?(String)
+				query[:target_screen_name] = target
+			end
+			
+			json = self.class.get("/friendships/show.json", :query => query)
+			json.symbolize_keys
+			relationship = json[:relationship].symbolize_keys
+			relationship[:source].symbolize_keys
+			relationship[:target].symbolize_keys
+			relationship
+		end
+		
+		def friendship_exists?(target, source=nil)
+			rel = source.nil? ? friendship_info(target) : friendship_info(target, source)
+			return true if rel[:source][:following] && rel[:target][:following]
+			false
+		end
+		
+		def following_me?(target)
+			rel = friendship_info(target)
+			return true if rel[:source][:followed_by]
+			false
+		end
+		
+		def am_i_following?(target)
+			rel = friendship_info(target)
+			return true if rel[:source][:following]
+			false
+		end
+		
+	end
+end

data/lib/tweeb_client_error.rb

@@ -0,0 +1,4 @@
+module Tweeb
+	class ClientError < StandardError
+	end
+end

data/lib/tweeb_search.rb

@@ -0,0 +1,42 @@
+require "rubygems"
+require "httparty"
+require File.join(File.dirname(__FILE__), "tweeb_search_error.rb")
+
+module Tweeb
+	class Search
+		include HTTParty
+		base_uri "http://search.twitter.com"
+		format :json
+		
+		def search(query, options={})
+			if options.empty?
+				json = self.class.get("/search.json", :query => {:q => query})
+			else
+				if options[:rpp] && options[:rpp] > 100
+					raise Tweeb::SearchError, "rpp parameter must be < 100"
+				end
+				if options[:rpp] && options[:page] && (options[:rpp] * options[:page]) > 1500
+					raise Tweeb::SearchError, "A maximum of 1500 tweets can be returned. Either lower rpp, or lower page options."
+				end
+				json = self.class.get("/search.json", :query => {:q => query}.merge(options))
+			end
+			return json
+		end
+		
+		def trends
+			json = self.class.get("/trends.json")
+		end
+		
+		def current_trends
+			json = self.class.get("/trends/current.json")
+		end
+		
+		def daily_trends
+			json = self.class.get("/trends/daily.json")
+		end
+		
+		def weekly_trends
+			json = self.class.get("/trends/weekly.json")
+		end
+	end
+end

data/lib/tweeb_search_error.rb

@@ -0,0 +1,4 @@
+module Tweeb
+	class SearchError < StandardError
+	end
+end

data/lib/tweeb_stream.rb

@@ -0,0 +1,22 @@
+require "uri"
+require "rubygems"
+require "yajl/http_stream"
+
+module Tweeb
+	class Stream
+	
+		def initialize(username, password)
+			@username = username
+			@password = password
+			@url = URI.parse("http://#{@username}:#{@password}@stream.twitter.com")
+		end
+		
+		def spritzer(&block)
+			@url.path = "/spritzer.json"
+			Yajl::HttpStream.get(@url, :symbolize_keys => true) do |json|
+				block.call(json)
+			end
+		end
+	
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bacon'
+require 'yaml'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tweeb'
+
+Bacon.summary_on_exit

data/spec/test_auth.yml.example

@@ -0,0 +1,3 @@
+twitter_auth:
+  username: test_user
+  password: password

data/spec/tweeb_client_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe "a Tweeb::Client instance" do
+  
+	before do
+		@auth_info = YAML.load_file("test_auth.yml")["twitter_auth"]
+		@tweeb = Tweeb::Client.new(@auth_info["username"], @auth_info["password"])
+	end
+	
+	tweeb_object = lambda {|obj| obj.is_a?(Tweeb::Client) }
+	it "should return an object of class Tweeb::Client" do
+		@tweeb.should.be.a tweeb_object
+	end
+	
+	array_with_hash = lambda {|obj| obj.is_a?(Array) && obj.first.is_a?(Hash) }
+	it "should return an array of hashes for public_timeline" do
+		@tweeb.public_timeline.should.be.a array_with_hash
+	end
+	
+	it "should return an array of hashes for user_timeline" do
+		@tweeb.user_timeline.should.be.a array_with_hash
+	end
+	
+	it "should return an array of hashes for friends_timeline" do
+		@tweeb.friends_timeline.should.be.a array_with_hash
+	end
+	
+	it "should throw a Tweeb::ClientError when the public timeline's count option is too high" do
+		should.raise(Tweeb::ClientError) { @tweeb.public_timeline(:count => 400) }
+	end
+	
+	it "should throw a Tweeb::ClientError when the user timeline's count option is too high" do
+		should.raise(Tweeb::ClientError) { @tweeb.user_timeline(:count => 400) }
+	end
+	
+	it "should throw a Tweeb::ClientError when the friends timeline's count option is too high" do
+		should.raise(Tweeb::ClientError) { @tweeb.friends_timeline(:count => 400) }
+	end
+end

data/spec/tweeb_search_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "a Tweeb::Stream instance" do
+  
+	before do
+		@auth_info = YAML.load_file("test_auth.yml")["twitter_auth"]
+		@tweeb = Tweeb::Stream.new(@auth_info["username"], @auth_info["password"])
+	end
+	
+	tweeb_stream_object = lambda {|obj| obj.is_a?(Tweeb::Stream) }
+	it "should return an object of class Tweeb::Stream" do
+		@tweeb.should.be.a tweeb_object
+	end
+	
+	
+end

data/spec/tweeb_stream_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe "a Tweeb::Stream instance" do
+  
+	before do
+		@auth_info = YAML.load_file("test_auth.yml")["twitter_auth"]
+		@tweeb = Tweeb::Stream.new(@auth_info["username"], @auth_info["password"])
+	end
+	
+	tweeb_stream_object = lambda {|obj| obj.is_a?(Tweeb::Stream) }
+	it "should return an object of class Tweeb::Stream" do
+		@tweeb.should.be.a tweeb_object
+	end
+	
+	
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: mikedamage-tweeb
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Mike Green
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+description: 
+email: mike.is.green@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/tweeb.rb
+- lib/tweeb_client.rb
+- lib/tweeb_client_error.rb
+- lib/tweeb_search.rb
+- lib/tweeb_search_error.rb
+- lib/tweeb_stream.rb
+- spec/spec_helper.rb
+- spec/test_auth.yml.example
+- spec/tweeb_client_spec.rb
+- spec/tweeb_search_spec.rb
+- spec/tweeb_stream_spec.rb
+has_rdoc: false
+homepage: http://github.com/mikedamage/tweeb
+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: 3
+summary: Tweeb is a really simple, bare bones Twitter library made possible by HTTParty
+test_files: 
+- spec/spec_helper.rb
+- spec/tweeb_client_spec.rb
+- spec/tweeb_search_spec.rb
+- spec/tweeb_stream_spec.rb