twistream 0.3.0 → 0.4.0.beta1

data/.gitignore

@@ -0,0 +1,4 @@
+.idea
+pkg
+*doc
+spec/auth.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    twistream (0.4.0.beta1)
+      yajl-ruby (~> 0.7.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    yajl-ruby (0.7.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (>= 2.4.0)
+  twistream!

data/README.md

@@ -0,0 +1,30 @@
+twistream
+=========
+
+twistream is an simple client for hooking up with the twitter streaming api
+
+Installation
+------------
+
+** stable release **
+
+	gem install twistream
+
+** beta release **
+
+	gem install twistream --pre
+	
+Usage
+-----
+
+	auth = { :user => 'username', :pass => 'password' }
+	@client = TwiStream::Client.new(auth)
+	@client.sample do |status|
+		puts status
+	end
+
+Disclaimer
+----------
+
+This gem is still very experimental and undocumented.
+There could be major API changes between future versions

data/Rakefile

@@ -1,58 +1,16 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "twistream"
-    gem.summary = %Q{a simple streaming api client for twitter}
-    gem.description = %Q{a simple streaming api client for twitter}
-    gem.email = "swessel@gr4yweb.de"
-    gem.homepage = "http://github.com/gr4y/twistream"
-    gem.authors = ["Sascha Wessel"]
-    gem.require_path = 'lib'
-    gem.files = %w( Rakefile ) + Dir.glob("{lib}/**/*") + %w( VERSION )
-    gem.add_runtime_dependency "yajl-ruby", "~> 0.7.8"
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-desc "generate rdoc"
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "twistream #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc "generate documentation"
+require 'yard'
+YARD::Rake::YardocTask.new do |yard|
+  yard.files = ['lib/**/*.rb']
+  yard.options = ["--no-private"]
 end
 
 desc "run all specs"
-begin
-  gem 'rspec', '1.3.0'
-  require 'spec/rake/spectask'
-  Spec::Rake::SpecTask.new do |t|
-    t.spec_files = FileList['spec/**/*_spec.rb']
-  end
-rescue LoadError
-  warn "[twistream] rspec is not installed. install it with: gem install rspec --version 1.3.0"
-end
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "twistream #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'reek/rake/task'
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = false
-  t.verbose = true
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-task :test => [:spec]
-task :default => [:test, :build]
+task :devbuild => [:yard, :build]
+task :default => [:spec, :devbuild]

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0.beta1

data/lib/twistream/client.rb

@@ -2,8 +2,8 @@ module TwiStream
   class Client
     extend TwiStream::EventHandler
     attr_accessor :realm
-    events :on_error
-
+    events :on_error, :on_start
+    
     def initialize(auth)
       self.realm = "#{auth[:user]}:#{auth[:pass]}".chomp
     end
@@ -32,25 +32,24 @@ module TwiStream
       start(:filter, :locations => params.join(','), & block)
     end
 
-    def stop
-      if @thread.alive?
-        @thread.kill
+    def stop 
+      if @stream.alive?
+        @stream.kill
       end
     end
 
     private
     def start(api_method, params = {}, & block)
       url = build_uri(api_method)
-      @thread = Thread.new do
-        begin
+      begin
+        @stream = Thread.new do 
           ::Yajl::HttpStream.post(url, params) do |status|
             block.call(status)
           end
-        rescue
-          on_error.trigger($!, $@)
         end
+      rescue 
+        on_error.trigger($!, $@)
       end
-      @thread.join
     end
 
     def build_uri(api_method)

data/lib/twistream/event.rb

@@ -6,7 +6,7 @@ module TwiStream
       @name = name
     end
 
-    def handle(method=nil, & block)
+    def receive(method=nil, & block)
       @handler = method if method
       @handler = block if block
     end

data/spec/auth.yml.sample

@@ -0,0 +1,2 @@
+:user: username
+:pass: password

data/spec/client_spec.rb

@@ -5,19 +5,17 @@ describe TwiStream::Client do
   before :all do
     auth = YAML.load_file('spec/auth.yml')
     @client = TwiStream::Client.new(auth)
-    @client.on_error.handle do |msg,tr|
-      puts msg 
+    @client.on_error.receive do |msg,tr|
+      raise e
     end
   end
 
-  context "start the filter stream, wait 10 seconds and stop" do
+  context "filter by keywords, wait, stop" do
     it "should start the filter stream" do
       keywords = "nowplaying", "nowwatching"
-      @thread = Thread.new do 
-        @client.filter_by_keywords(keywords) do |status|
-          status.should_not == be_nil
-          puts status['id']
-        end
+      @client.filter_by_keywords(keywords) do |status|
+        status.should_not == be_nil
+        puts status['id']
       end
     end
 
@@ -30,7 +28,7 @@ describe TwiStream::Client do
     end
   end
 
-  context "start the sample stream, wait 10 seconds and stop" do
+  context "sample, wait, stop" do
     it "should start the sample stream" do
       @thread = Thread.new do 
         @client.sample do |status|

data/twistream.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = %q{twistream}
+  s.version = File.read('VERSION')
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Sascha Wessel"]
+  s.email = %q{swessel@gr4yweb.de}
+  s.homepage = %q{http://github.com/gr4y/twistream}
+  s.description = %q{a simple streaming api client for twitter}
+  s.summary = %q{a simple streaming api client for twitter}
+
+  s.rubyforge_project = "twistream"
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "yajl-ruby", "~> 0.7.8"
+  s.add_development_dependency "rspec", ">= 2.4.0"
+end
+

metadata

@@ -1,75 +1,83 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: twistream
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.3.0
+version: !ruby/object:Gem::Version
+  version: 0.4.0.beta1
+  prerelease: 6
 platform: ruby
-authors: 
+authors:
 - Sascha Wessel
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-18 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-09-02 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: yajl-ruby
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70144168678040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.7.8
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70144168678040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70144168676760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70144168676760
 description: a simple streaming api client for twitter
 email: swessel@gr4yweb.de
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
 - Rakefile
 - VERSION
 - lib/twistream.rb
 - lib/twistream/client.rb
 - lib/twistream/event.rb
 - lib/twistream/event_handler.rb
-- README.rdoc
+- spec/auth.yml.sample
 - spec/client_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+- twistream.gemspec
 homepage: http://github.com/gr4y/twistream
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-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 
-      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 
-      version: "0"
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.5.0
+rubyforge_project: twistream
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: a simple streaming api client for twitter
-test_files: 
+test_files:
+- spec/auth.yml.sample
 - spec/client_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,5 +0,0 @@
-= twistream
-
-== what?
-
-twistream is an simple client for hooking up with the twitter streaming api