twitterstream 0.0.4 → 0.1.0

data/History.txt

@@ -1,4 +1,10 @@
-=== 0.0.1 2009-12-30
+=== 0.1.0 2010-01-01
 
-* 1 major enhancement:
-  * Initial release
+* Fixed some from Sora Harakami
+  * TwitterStream::Client => TwitterStream
+  * require 'twitterStream' => require 'twitter_stream'
+  * TwitterStream#start_stream is to be a private method
+
+=== 0.0.1 2009-12-31
+
+* Initial release from yayugu

data/Manifest.txt

@@ -1,11 +1,11 @@
 History.txt
 Manifest.txt
 README.rdoc
-README.txt
+README.mkd
 Rakefile
-lib/twitterstream.rb
+lib/twitter_stream.rb
 script/console
 script/destroy
 script/generate
 test/test_helper.rb
-test/test_twitterstream.rb
+test/test_twitter_stream.rb

data/{README.txt → README.mkd}

@@ -1,44 +1,48 @@
-= twitterstream
+# twitterstream
 
-* http://rubyforge.org/projects/twitterstream/
+* [rubyforge - twitterstream](http://rubyforge.org/projects/twitterstream/)
 
-== DESCRIPTION:
+## DESCRIPTION
 
-It is the simple library to access the Twitter Streaming API( http://apiwiki.twitter.com/Streaming-API-Documentation ). It works with pure-ruby(don't need C compiler) and rubygems.
+It is the simple library to access the [Twitter Streaming API](http://apiwiki.twitter.com/Streaming-API-Documentation). It works with pure-ruby(don't need C compiler) and rubygems.
 
-== FEATURES/PROBLEMS:
+## FEATURES/PROBLEMS
 
-== SYNOPSIS:
+## SYNOPSIS
 
-require "twitterStream"
-TwitterStream::Client.new("username", "password").sample do |status|
-  next unless status['text']
-  user = status['user']
-  puts "#{user['screen_name']}: #{status['text']}"
-end
+    require "twitter_stream"
 
-or
+    ts = TwitterStream.new(USERNAME,PASSWORD)
 
-require "twitterStream"
-TwitterStream::Client.new("username", "password").track("bit,ly") do |status|
-  next unless status['text']
-  user = status['user']
-  puts "#{user['screen_name']}: #{status['text']}"
-end
+    ts.sample do |status|
+      user = status['user']
+      puts "#{user['screen_name']}: #{status['text']}"
+    end
 
-== REQUIREMENTS:
+    ts.track(['bit','ly']) do |status| # or ts.track("bit,ly")
+      user = status['user']
+      puts "#{user['screen_name']}: #{status['text']}"
+    end
+
+    ts.follow([5161091,66137185]) do |status| # or ts.track("5161091,66137185") or ts.track(["5161091",66137185])
+      user = status['user']
+      puts "#{user['screen_name']}: #{status['text']}"
+    end
+
+## REQUIREMENTS
 
 * json
 
-== INSTALL:
+## INSTALL:
 
-sudo gem install twitterstream
+    sudo gem install twitterstream
 
-== LICENSE:
+## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 FIXME full name
+Copyright (c) 2010 Sora Harakami (Modified)
+Copyright (c) 2009 yayugu
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,62 +1,10 @@
 = twitterstream
 
-* http://rubyforge.org/projects/twitterstream/
 
 == DESCRIPTION:
 
 It is the simple library to access the Twitter Streaming API( http://apiwiki.twitter.com/Streaming-API-Documentation ). It works with pure-ruby(don't need C compiler) and rubygems.
 
-== FEATURES/PROBLEMS:
+== DETAIL:
 
-
-
-== SYNOPSIS:
-
-require "twitterStream"
-TwitterStream::Client.new("username", "password").sample do |status|
-  next unless status['text']
-  user = status['user']
-  puts "#{user['screen_name']}: #{status['text']}"
-end
-
-or
-
-require "twitterStream"
-TwitterStream::Client.new("username", "password").track("bit,ly") do |status|
-  next unless status['text']
-  user = status['user']
-  puts "#{user['screen_name']}: #{status['text']}"
-end
-
-== REQUIREMENTS:
-
-* json
-
-== INSTALL:
-
-sudo gem install twitterstream
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2009 FIXME full name
-
-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.
+see README.mkd

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 gem 'hoe', '>= 2.1.0'
 require 'hoe'
 require 'fileutils'
-require './lib/twitterstream'
+require './lib/twitter_stream'
 
 Hoe.plugin :newgem
 # Hoe.plugin :website
@@ -13,7 +13,7 @@ Hoe.plugin :newgem
 $hoe = Hoe.spec 'twitterstream' do
   self.developer 'yayugu', 'yayugu@gmail.com'
 
-  self.rubyforge_name       = self.name # TODO this is default value
+  self.rubyforge_name       = "twitterstream" # TODO this is default value
   self.extra_deps         = [['json','>= 1.2.0']]
 
 end

data/lib/twitter_stream.rb

@@ -0,0 +1,107 @@
+$:.unshift(File.dirname(__FILE__)) unless
+$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'net/http'
+require 'uri'
+require 'rubygems'
+require 'json'
+
+module Net
+    class HTTPResponse
+        def each_line(rs = "\n")
+            stream_check
+            while line = @socket.readuntil(rs)
+                yield line
+            end
+            self
+        end
+    end
+end
+
+class TwitterStream
+    VERSION = '0.1.0'
+    @@urls = {
+        'sample' => URI.parse("http://stream.twitter.com/1/statuses/sample.json"),
+        'filter' => URI.parse("http://stream.twitter.com/1/statuses/filter.json")
+    }
+
+    def initialize(username, password)
+        @username = username
+        @password = password
+        self
+    end
+
+    def sample(params=nil)
+        raise ArgumentError, "params is not hash" unless params.nil? || params.kind_of?(Hash)
+        start_stream('sample', params) do |status|
+            yield status
+        end
+    end
+
+    def filter(params=nil)
+        raise ArgumentError, "params is not hash" unless params.nil? || params.kind_of?(Hash)
+        start_stream('filter', params) do |status|
+            yield status
+        end
+    end
+
+    def track(track, params=nil)
+        raise ArgumentError, "track is not array or string" unless track.kind_of?(Array) || track.kind_of?(String)
+        raise ArgumentError, "params is not hash" unless params.nil? || params.kind_of?(Hash)
+
+        p = { 'track' => track.kind_of?(Array) ? track.map{|x| raise ArgumentError, "track item is not string or integer!" unless x.kind_of?(String) || x.kind_of?(Integer); x.kind_of?(Integer) ? x.to_s : x }.join(",") : track }
+
+        p.merge!('filter',params) if params
+        start_stream('filter', p) do |status|
+            yield status
+        end
+    end
+
+    def follow(follow, params=nil)
+        raise ArgumentError, "follow is not array or string" unless follow.kind_of?(Array) || follow.kind_of?(String)
+        raise ArgumentError, "params is not hash" unless params.nil? || params.kind_of?(Hash)
+
+        p = { 'follow' => follow.kind_of?(Array) ? follow.join(",") : follow }
+        p.merge!(params) if params
+
+        start_stream('filter', p) do |status|
+            yield status
+        end
+    end
+
+    private
+
+    def start_stream(url, params=nil)
+        raise ArgumentError, "params is not hash" unless params.nil? || params.kind_of?(Hash)
+        raise ArgumentError, "url is not String or URI!" unless url.kind_of?(URI) || url.kind_of?(String)
+
+        if url.kind_of?(URI)
+            uri = url
+        elsif url.kind_of?(String)
+            if @@urls[url]
+                uri = @@urls[url]
+            elsif /^https?:/ =~ url
+                uri = URI.parse(url)
+            else
+                raise ArgumentError, "@@urls['#{url}'] not found"
+            end
+        end
+
+        http = Net::HTTP.start(uri.host, uri.port)
+        request = Net::HTTP::Post.new(uri.request_uri)
+        request.set_form_data(params) if params
+        request.basic_auth(@username, @password)
+
+        begin
+            http.request(request) do |response|
+                response.each_line("\r\n") do |line|
+                    j = JSON.parse(line) rescue next
+                    next unless j["text"]
+                    yield j
+                end
+            end
+        ensure
+            http.finish
+        end
+    end
+end

data/test/test_helper.rb

@@ -1,3 +1,3 @@
 require 'stringio'
 require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/twitterstream'
+require File.dirname(__FILE__) + '/../lib/twitter_stream'

data/test/{test_twitterstream.rb → test_twitter_stream.rb}

@@ -2,10 +2,11 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 class TestTwitterStream < Test::Unit::TestCase
 
-  def setup
-  end
-  
-  def test_truth
-    assert true
-  end
+    def setup
+
+    end
+
+    def test_truth
+        assert true
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: twitterstream
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - yayugu
@@ -42,21 +42,20 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
 - README.rdoc
-- README.txt
+- README.mkd
 - Rakefile
-- lib/twitterstream.rb
+- lib/twitter_stream.rb
 - script/console
 - script/destroy
 - script/generate
 - test/test_helper.rb
-- test/test_twitterstream.rb
+- test/test_twitter_stream.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/twitterstream/
+homepage: 
 licenses: []
 
 post_install_message: 
@@ -85,5 +84,5 @@ signing_key:
 specification_version: 3
 summary: It is the simple library to access the Twitter Streaming API( http://apiwiki.twitter.com/Streaming-API-Documentation )
 test_files: 
-- test/test_twitterstream.rb
+- test/test_twitter_stream.rb
 - test/test_helper.rb

data/lib/twitterstream.rb

@@ -1,77 +0,0 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-require 'net/http'
-require 'uri'
-require 'rubygems'
-require 'json'
-
-module Net
-  class HTTPResponse
-    def each_line(rs = "\n")
-      stream_check
-      while line = @socket.readuntil(rs)
-        yield line
-      end
-      self
-    end
-  end
-end
-
-module TwitterStream
-  VERSION = '0.0.4'
-  
-  class Client
-    def initialize(username, password)
-      @username = username
-      @password = password
-      self
-    end
-
-    def start_stream(uri, params=nil)
-      Net::HTTP.start(uri.host, uri.port) do |http|
-        request = Net::HTTP::Post.new(uri.request_uri)
-        request.set_form_data(params) if params
-        request.basic_auth(@username, @password)
-        http.request(request) do |response|
-          response.each_line("\r\n") do |line|
-            status = JSON.parse(line) rescue next
-            yield status
-          end
-        end
-      end
-    end
-    
-    def sample(params=nil)
-      uri = URI.parse("http://stream.twitter.com/1/statuses/sample.json")
-      start_stream(uri, params) do |status|
-        yield status
-      end
-    end
-
-    def filter(params=nil)
-      uri = URI.parse("http://stream.twitter.com/1/statuses/filter.json")
-      start_stream(uri, params) do |status|
-        yield status
-      end
-    end
-
-    def track(track, params=nil)
-      uri = URI.parse("http://stream.twitter.com/1/statuses/filter.json")
-      p = {'track'=>track}
-      p.merge!(params) if params
-      start_stream(uri, p) do |status|
-        yield status
-      end
-    end
-    
-    def follow(follow, params=nil)
-      uri = URI.parse("http://stream.twitter.com/1/statuses/filter.json")
-      p = {'follow'=>follow}
-      p.merge!(params) if params
-      start_stream(uri, p) do |status|
-        yield status
-      end
-    end
-  end
-end