twitter-stream 0.1.14 → 0.1.15

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Vladimir Kolesnikov, twitter-stream
+
+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.markdown

@@ -1,7 +1,7 @@
 # twitter-stream
 
-Simple Ruby client library for [twitter streaming API](http://apiwiki.twitter.com/Streaming-API-Documentation). 
-Uses [EventMachine](http://rubyeventmachine.com/) for connection handling. Adheres to twitter's [reconnection guidline](http://apiwiki.twitter.com/Streaming-API-Documentation#Connecting).
+Simple Ruby client library for [twitter streaming API](http://apiwiki.twitter.com/Streaming-API-Documentation).
+Uses [EventMachine](http://rubyeventmachine.com/) for connection handling. Adheres to twitter's [reconnection guidline](https://dev.twitter.com/docs/streaming-api/concepts#connecting).
 
 JSON format only.
 
@@ -13,7 +13,7 @@ JSON format only.
 
     require 'rubygems'
     require 'twitter/json_stream'
-    
+
     EventMachine::run {
       stream = Twitter::JSONStream.connect(
         :path    => '/1/statuses/filter.json?track=football',
@@ -25,15 +25,15 @@ JSON format only.
       end
 
       stream.on_error do |message|
-        # No need to worry here. It might be an issue with Twitter. 
+        # No need to worry here. It might be an issue with Twitter.
         # Log message for future reference. JSONStream will try to reconnect after a timeout.
       end
-      
+
       stream.on_max_reconnects do |timeout, retries|
         # Something is wrong on your side. Send yourself an email.
       end
     }
-    
+
 
 ## Examples
 

data/lib/twitter/json_stream.rb

@@ -27,8 +27,8 @@ module Twitter
       :content        => '',
       :path           => '/1/statuses/filter.json',
       :host           => 'stream.twitter.com',
-      :port           => 80,
-      :ssl            => false,
+      :port           => 443,
+      :ssl            => true,
       :user_agent     => 'TwitterStream',
       :timeout        => 0,
       :proxy          => ENV['HTTP_PROXY'],
@@ -60,7 +60,6 @@ module Twitter
       end
 
       connection = EventMachine.connect host, port, self, options
-      connection.start_tls if options[:ssl]
       connection
     end
 
@@ -122,6 +121,7 @@ module Twitter
     end
 
     def connection_completed
+      start_tls if @options[:ssl]
       send_request
     end
 
@@ -248,7 +248,7 @@ module Twitter
       if @proxy && @proxy.user
         data << "Proxy-Authorization: Basic " + ["#{@proxy.user}:#{@proxy.password}"].pack('m').delete("\r\n")
       end
-      if @options[:method] == 'POST'
+      if ['POST', 'PUT'].include?(@options[:method])
         data << "Content-type: #{@options[:content_type]}"
         data << "Content-length: #{content.length}"
       end
@@ -311,7 +311,9 @@ module Twitter
         :token_secret => @options[:oauth][:access_secret]
       }
 
-      SimpleOAuth::Header.new(@options[:method], uri, params, oauth)
+      data = ['POST', 'PUT'].include?(@options[:method]) ? params : {}
+
+      SimpleOAuth::Header.new(@options[:method], uri, data, oauth)
     end
 
     # Scheme (https if ssl, http otherwise) and host part of URL

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-$:.unshift File.expand_path("../../lib", __FILE__)
 
 gem 'rspec', '>= 2.5.0'
 require 'rspec'
@@ -51,4 +50,4 @@ end
 def http_chunk(data)
   # See http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.6.1
   "#{data.length.to_s(16)}\r\n#{data}\r\n"
-end
+end

data/spec/twitter/json_stream_spec.rb

@@ -1,5 +1,4 @@
-$:.unshift "."
-require File.dirname(__FILE__) + '/../spec_helper.rb'
+require 'spec_helper.rb'
 require 'twitter/json_stream'
 
 include Twitter
@@ -24,7 +23,7 @@ describe JSONStream do
 
   context "authentication" do
     it "should connect with basic auth credentials" do
-      connect_stream :auth => "username:password"
+      connect_stream :auth => "username:password", :ssl => false
       $recieved_data.should include('Authorization: Basic')
     end
 
@@ -35,7 +34,7 @@ describe JSONStream do
         :access_key => 'ohai',
         :access_secret => 'ohno'
       }
-      connect_stream :oauth => oauth
+      connect_stream :oauth => oauth, :ssl => false
       $recieved_data.should include('Authorization: OAuth')
     end
   end
@@ -51,7 +50,7 @@ describe JSONStream do
     it "should define default properties" do
       EM.should_receive(:connect).with do |host, port, handler, opts|
         host.should == 'stream.twitter.com'
-        port.should == 80
+        port.should == 443
         opts[:path].should == '/1/statuses/filter.json'
         opts[:method].should == 'GET'
       end
@@ -63,12 +62,19 @@ describe JSONStream do
         host.should == 'my-proxy'
         port.should == 8080
         opts[:host].should == 'stream.twitter.com'
-        opts[:port].should == 80
+        opts[:port].should == 443
         opts[:proxy].should == 'http://my-proxy:8080'
       end
       stream = JSONStream.connect(:proxy => "http://my-proxy:8080") {}
     end
 
+    it "should not trigger SSL until connection is established" do
+      connection = stub('connection')
+      EM.should_receive(:connect).and_return(connection)
+      stream = JSONStream.connect(:ssl => true)
+      stream.should == connection
+    end
+
   end
 
   context "on valid stream" do
@@ -76,46 +82,46 @@ describe JSONStream do
     before :each do
       $body = File.readlines(fixture_path("twitter/tweets.txt"))
       $body.each {|tweet| tweet.strip!; tweet << "\r" }
-      $data_to_send = http_response(200,"OK",{},$body)
+      $data_to_send = http_response(200, "OK", {}, $body)
       $recieved_data = ''
       $close_connection = false
     end
 
     it "should add no params" do
-      connect_stream
+      connect_stream :ssl => false
       $recieved_data.should include('/1/statuses/filter.json HTTP')
     end
 
     it "should add custom params" do
-      connect_stream :params => {:name => 'test'}
+      connect_stream :params => {:name => 'test'},  :ssl => false
       $recieved_data.should include('?name=test')
     end
 
     it "should parse headers" do
-      connect_stream
+      connect_stream :ssl => false
       stream.code.should == 200
       stream.headers.keys.map{|k| k.downcase}.should include('content-type')
     end
 
     it "should parse headers even after connection close" do
-      connect_stream
+      connect_stream :ssl => false
       stream.code.should == 200
       stream.headers.keys.map{|k| k.downcase}.should include('content-type')
     end
 
     it "should extract records" do
-      connect_stream :user_agent => 'TEST_USER_AGENT'
+      connect_stream :user_agent => 'TEST_USER_AGENT',  :ssl => false
       $recieved_data.upcase.should include('USER-AGENT: TEST_USER_AGENT')
     end
 
     it 'should allow custom headers' do
-      connect_stream :headers => { 'From' => 'twitter-stream' }
+      connect_stream :headers => { 'From' => 'twitter-stream' },  :ssl => false
       $recieved_data.upcase.should include('FROM: TWITTER-STREAM')
     end
 
     it "should deliver each item" do
       items = []
-      connect_stream do
+      connect_stream :ssl => false do
         stream.each_item do |item|
           items << item
         end
@@ -198,6 +204,12 @@ describe JSONStream do
       end
     end
 
+    it "should reconnect with SSL if enabled" do
+      connect_stream :ssl => true do
+        stream.should_receive(:start_tls).twice
+      end
+    end
+
     it_should_behave_like "network failure"
   end
 
@@ -225,26 +237,26 @@ describe JSONStream do
     end
 
     it "should reconnect on application failure 10 at base" do
-      connect_stream do
+      connect_stream :ssl => false do
         stream.should_receive(:reconnect_after).with(10)
       end
     end
 
     it "should not reconnect on application failure 10 at base when not configured to auto reconnect" do
-      connect_stream(:auto_reconnect => false) do
+      connect_stream  :ssl => false, :auto_reconnect => false do
         stream.should_receive(:reconnect_after).never
       end
     end
 
     it "should reconnect with exponential timeout" do
-      connect_stream do
+      connect_stream :ssl => false do
         stream.af_last_reconnect = 160
         stream.should_receive(:reconnect_after).with(320)
       end
     end
 
     it "should not try to reconnect after limit is reached" do
-      connect_stream do
+      connect_stream :ssl => false do
         stream.af_last_reconnect = 320
         stream.should_not_receive(:reconnect_after)
       end
@@ -262,7 +274,7 @@ describe JSONStream do
       body_chunks = ["{\"screen"+"_name\"",":\"user1\"}\r\r\r{","\"id\":9876}\r\r"]
       $data_to_send = http_response(200,"OK",{},body_chunks)
       items = []
-      connect_stream do
+      connect_stream :ssl => false do
         stream.each_item do |item|
           items << item
         end
@@ -276,7 +288,7 @@ describe JSONStream do
       body_chunks = ["{\"id\"",":1234}\r{","\"id\":9876}"]
       $data_to_send = http_response(200,"OK",{},body_chunks)
       items = []
-      connect_stream do
+      connect_stream :ssl => false do
         stream.each_item do |item|
           items << item
         end

data/twitter-stream.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{twitter-stream}
-  s.version = "0.1.14"
+  s.version = "0.1.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Vladimir Kolesnikov"]
-  s.date = %q{2010-10-05}
+  s.date = %q{2012-04-10}
   s.description = %q{Simple Ruby client library for twitter streaming API. Uses EventMachine for connection handling. Adheres to twitter's reconnection guidline. JSON format only.}
   s.summary = %q{Twitter realtime API client}
   s.homepage = %q{http://github.com/voloko/twitter-stream}
@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.6") if s.respond_to? :required_rubygems_version=
 
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = ["README.markdown"]
+  s.extra_rdoc_files = ["README.markdown", "LICENSE"]
 
   s.add_runtime_dependency('eventmachine', ">= 0.12.8")
   s.add_runtime_dependency('simple_oauth', '~> 0.1.4')

metadata

@@ -1,96 +1,70 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: twitter-stream
-version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 14
-  version: 0.1.14
+version: !ruby/object:Gem::Version
+  version: 0.1.15
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Vladimir Kolesnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-05 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: eventmachine
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70312242841020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 12
-        - 8
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.12.8
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: simple_oauth
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70312242841020
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: &70312242839900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 0
-        - 1
-        - 4
+      - !ruby/object:Gem::Version
         version: 0.1.4
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: http_parser.rb
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *70312242839900
+- !ruby/object:Gem::Dependency
+  name: http_parser.rb
+  requirement: &70312242838600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 0
-        - 5
-        - 1
+      - !ruby/object:Gem::Version
         version: 0.5.1
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *70312242838600
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70312242837520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 5
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.5.0
   type: :development
-  version_requirements: *id004
-description: Simple Ruby client library for twitter streaming API. Uses EventMachine for connection handling. Adheres to twitter's reconnection guidline. JSON format only.
+  prerelease: false
+  version_requirements: *70312242837520
+description: Simple Ruby client library for twitter streaming API. Uses EventMachine
+  for connection handling. Adheres to twitter's reconnection guidline. JSON format
+  only.
 email: voloko@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+- LICENSE
+files:
 - .gemtest
 - .gitignore
 - .rspec
@@ -104,42 +78,32 @@ files:
 - spec/spec_helper.rb
 - spec/twitter/json_stream_spec.rb
 - twitter-stream.gemspec
-has_rdoc: true
+- LICENSE
 homepage: http://github.com/voloko/twitter-stream
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Twitter realtime API client
-test_files: 
+test_files:
 - spec/spec_helper.rb
 - spec/twitter/json_stream_spec.rb