em-twitter 0.1.0

data/.gitignore

@@ -0,0 +1,40 @@
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.emacs.desktop
+.emacs.desktop.lock
+.redcar
+.yardoc
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.simplecov

@@ -0,0 +1 @@
+SimpleCov.start

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx
+  - ree
+  - ruby-head

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+end
+
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Steve Agalloco
+
+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.md

@@ -0,0 +1,117 @@
+# EM-Twitter
+
+EM-Twitter is an EventMachine-based ruby client for the Twitter Streaming API.
+
+## Usage
+
+```ruby
+require 'em-twitter'
+
+options = {
+  :path   => '/1/statuses/filter.json',
+  :params => { :track => 'yankees' },
+  :oauth  => {
+    :consumer_key     => ENV['CONSUMER_KEY'],
+    :consumer_secret  => ENV['CONSUMER_SECRET'],
+    :token            => ENV['OAUTH_TOKEN'],
+    :token_secret     => ENV['OAUTH_TOKEN_SECRET']
+  }
+}
+
+EM.run do
+  client = EM::Twitter::Client.connect(options)
+
+  client.each do |result|
+    puts result
+  end
+end
+```
+
+## SSL
+
+SSL is used by default (EventMachine defaults to verify_peer => false), and can be configured:
+
+```ruby
+options = {
+  :ssl => {
+    :private_key_file => "path/to/key.pem",
+    :cert_chain_file => "path/to/cert.pem",
+    :verify_peer => true
+  }
+}
+
+client = EM::Twitter.Client.connect(options)
+```
+
+## Proxy Support
+
+EM-Twitter includes proxy support via a configuration option:
+
+```ruby
+options = {
+  :proxy => {
+    :username => 'myusername',
+    :passowrd => 'mypassword',
+    :uri => 'http://my-proxy:8080'
+  }
+}
+
+client = EM::Twitter.Client.connect(options)
+```
+
+## Error Handling
+
+EM-Twitter supports the following callbacks for handling errors:
+
+* on_unauthorized
+* on_forbidden
+* on_not_found
+* on_not_acceptable
+* on_too_long
+* on_range_unacceptable
+* on_enhance_your_calm (aliased as on_rate_limited)
+
+Errors callbacks are invoked on a Client like so:
+
+```ruby
+client = EM::Twitter.Client.connect(options)
+client.on_forbidden do
+  puts 'oops'
+end
+```
+
+## Reconnections
+
+EM-Twitter has two callbacks for reconnection handling:
+
+```ruby
+client = EM::Twitter.Client.connect(options)
+client.on_reconnect do |timeout, count|
+  # called each time the client reconnects
+end
+
+client.on_max_reconnects do |timeout, count|
+  # called when the client has exceeded either:
+  # 1. the maximum number of reconnect attempts
+  # 2. the maximum timeout limit for reconnections
+end
+```
+
+## Todo
+
+* Gzip encoding support (see [issue #1](https://github.com/spagalloco/em-twitter/issues/1) for more information)
+* JSON Parser (see [issue #2](https://github.com/spagalloco/em-twitter/issues/2) for more information)
+
+## Inspiration
+
+EM-Twitter is heavily inspired by Vladimir Kolesnikov's [twitter-stream](https://github.com/voloko/twitter-stream).  I learned an incredible amount from studying his code and much of the reconnection handling in EM-Twitter is derived/borrowed from his code as are .  Eloy Durán's [ssalleyware](https://github.com/alloy/ssalleyware) was very helpful in adding SSL Certificate verification as was David Graham's [vines](https://github.com/negativecode/vines).
+
+Testing with EM can be a challenge, but was made incredibly easy through the use of Hayes Davis' awesome [mockingbird](https://github.com/hayesdavis/mockingbird) gem.
+
+## Contributing
+
+Pull requests welcome: fork, make a topic branch, commit (squash when possible) *with tests* and I'll happily consider.
+
+## Copyright
+
+Copyright (c) 2012 Steve Agalloco. See [LICENSE](https://github.com/spagalloco/em-twitter/blob/master/LICENSE.md) for detail

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/em-twitter.gemspec

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require File.expand_path('../lib/em-twitter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'em-twitter'
+  gem.version     = EventMachine::Twitter::VERSION
+  gem.homepage    = 'https://github.com/spagalloco/em-twitter'
+
+  gem.author      = "Steve Agalloco"
+  gem.email       = 'steve.agalloco@gmail.com'
+  gem.description = %q{Twitter Streaming API client for EventMachine}
+  gem.summary     = %q{Twitter Streaming API client for EventMachine}
+
+  gem.add_dependency "eventmachine", ">= 1.0.0.beta.4"
+  gem.add_dependency "http_parser.rb", "~> 0.5"
+  gem.add_dependency "simple_oauth", "~> 0.1"
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdiscount'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'yard'
+  gem.add_development_dependency 'mockingbird', "~> 0.1.1"
+  gem.add_development_dependency 'guard-rspec'
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.require_paths = ['lib']
+end

data/examples/stream.rb

@@ -0,0 +1,61 @@
+require 'bundler/setup'
+require 'em-twitter'
+
+EM::run do
+
+  options = {
+    :path   => '/1/statuses/filter.json',
+    :params => {
+      :track            => 'yankees'
+    },
+    :oauth  => {
+      :consumer_key     => ENV['CONSUMER_KEY'],
+      :consumer_secret  => ENV['CONSUMER_SECRET'],
+      :token            => ENV['OAUTH_TOKEN'],
+      :token_secret     => ENV['OAUTH_TOKEN_SECRET']
+    }
+  }
+
+  client = EM::Twitter::Client.connect(options)
+
+  client.each do |result|
+    puts result
+  end
+
+  client.on_error do |message|
+    puts "oops: error: #{message}"
+  end
+
+  client.on_unauthorized do
+    puts "oops: unauthorized"
+  end
+
+  client.on_forbidden do
+    puts "oops: unauthorized"
+  end
+
+  client.on_not_found do
+    puts "oops: not_found"
+  end
+
+  client.on_not_acceptable do
+    puts "oops: not_acceptable"
+  end
+
+  client.on_too_long do
+    puts "oops: too_long"
+  end
+
+  client.on_range_unacceptable do
+    puts "oops: range_unacceptable"
+  end
+
+  client.on_enhance_your_calm do
+    puts "oops: enhance_your_calm"
+  end
+
+  EM.add_timer(10) do
+    EM.stop
+  end
+
+end

data/lib/em-twitter.rb

@@ -0,0 +1,35 @@
+require 'em-twitter/client'
+require 'em-twitter/version'
+require 'logger'
+
+module EventMachine
+  module Twitter
+    DEFAULT_CONNECTION_OPTIONS = {
+      :host               => 'stream.twitter.com',
+      :port               => 443,
+      :method             => 'POST',
+      :content_type       => "application/x-www-form-urlencoded",
+      :path               => '/',
+      :params             => {},
+      :headers            => {},
+      :user_agent         => "EM::Twitter Ruby Gem #{EM::Twitter::VERSION}",
+      :proxy              => nil,
+      :ssl                => {},
+      :timeout            => 0,
+      :auth               => {},
+      :reconnect_options  => {},
+      :encoding           => nil,
+      :auto_reconnect     => true
+    }
+
+    class ReconnectLimitError < StandardError; end
+
+    def self.logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+    def self.logger=(new_logger)
+      @logger = new_logger
+    end
+  end
+end

data/lib/em-twitter/client.rb

@@ -0,0 +1,111 @@
+require 'em-twitter/connection'
+
+module EventMachine
+  module Twitter
+    class Client
+
+      CALLBACKS = [
+        :each_item_callback,
+        :error_callback,
+        :unauthorized_callback,
+        :forbidden_callback,
+        :not_found_callback,
+        :not_acceptable_callback,
+        :too_long_callback,
+        :range_unacceptable_callback,
+        :enhance_your_calm_callback,
+        :reconnect_callback,
+        :max_reconnects_callback,
+        :close_callback
+      ].freeze unless defined?(CALLBACKS)
+
+      attr_accessor :connection, :options, :host, :port
+      attr_accessor *CALLBACKS
+
+      # A convenience method for creating and connecting.
+      def self.connect(options = {})
+        new(options).tap do |client|
+          client.connect
+        end
+      end
+
+      def initialize(options = {})
+        @options = DEFAULT_CONNECTION_OPTIONS.merge(options)
+
+        @host = @options[:host]
+        @port = @options[:port]
+
+        if @options[:proxy] && @options[:proxy][:uri]
+          proxy_uri = URI.parse(@options[:proxy][:uri])
+          @host = proxy_uri.host
+          @port = proxy_uri.port
+        end
+        @connection = nil
+      end
+
+      def connect
+        @connection = EM.connect(@host, @port, Connection, self, @host, @port)
+      end
+
+      def each(&block)
+        @each_item_callback = block
+      end
+
+      def on_error(&block)
+        @error_callback = block
+      end
+
+      def on_unauthorized(&block)
+        @unauthorized_callback = block
+      end
+
+      def on_forbidden(&block)
+        @forbidden_callback = block
+      end
+
+      def on_not_found(&block)
+        @not_found_callback = block
+      end
+
+      def on_not_acceptable(&block)
+        @not_acceptable_callback = block
+      end
+
+      def on_too_long(&block)
+        @too_long_callback = block
+      end
+
+      def on_range_unacceptable(&block)
+        @range_unacceptable_callback = block
+      end
+
+      def on_enhance_your_calm(&block)
+        @enhance_your_calm_callback = block
+      end
+      alias :on_rate_limited :on_enhance_your_calm
+
+      def on_reconnect(&block)
+        @reconnect_callback = block
+      end
+
+      def on_max_reconnects(&block)
+        @max_reconnects_callback = block
+      end
+
+      def on_close(&block)
+        @close_callback = block
+      end
+
+      # Delegate to EM::Twitter::Connection
+      def method_missing(method, *args, &block)
+        return super unless @connection.respond_to?(method)
+        @connection.send(method, *args, &block)
+      end
+
+      def respond_to?(method, include_private=false)
+        @connection.respond_to?(method, include_private) || super(method, include_private)
+      end
+
+    end
+  end
+end