nervion 0.0.3 → 0.0.4

data/.gitignore

@@ -3,6 +3,6 @@
 .yardoc
 coverage
 doc
-examples
+examples_with_keys
 Gemfile.lock
 pkg

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# version 0.0.4
+
+- Nervion won't raise an exception if you try to stop it and it wasn't running
+- Added `running?` method to check whether Nervion is running or not
+
 # version 0.0.3
 
 - Allow Nervion to run without being responsible for EventMachine's event loop

data/README.md

@@ -177,10 +177,42 @@ end
 
 ## EventMachine Integration
 
-Nervion runs on the top of EventMachine.
+Nervion runs on the top of EventMachine. This means that you can take advantage
+of any of the features of the EventMachine ecosystem in your Nervion callbacks.
 
-In the near future this `README` will provide a guideline to take advantage of
-the benefits that EventMachine can provide when used correctly.
+Nervion can be run insinde an instance of EventMachine that is already running
+or you can let Nervion handle the event loop for you.
+
+With that purpose in mind Nervion provides a few handy methods:
+
+### stop
+
+The `stop` method will stop both the streaming and EventMachine.
+
+```ruby
+  Nervion.stop
+```
+
+### close_stream
+
+You can use `close_stream` to close the connection to the streaming API but
+keep EventMachine's event loop running.
+
+```ruby
+  Nervion.close_stream
+```
+
+### running?
+
+The `running?` method will allow you to check whether Nervion is already
+running or not, what, in the asyncronous land that EventMachine lives in, you
+may not be sure about.
+
+```ruby
+  Nervion.running?
+```
+
+And remember **do not block the event loop**.
 
 
 

data/examples/filter_endpoint.rb

@@ -0,0 +1,47 @@
+require 'nervion'
+
+RED      = "\e[0;31m"
+NO_COLOR = "\e[0m"
+
+def print_status(name, status)
+  puts "#{RED}#{name.rjust(20)}:#{NO_COLOR} #{status}"
+end
+
+# Setup your own keys here
+Nervion.configure do |config|
+  config.consumer_key = ''
+  config.consumer_secret = ''
+  config.access_token = ''
+  config.access_token_secret = ''
+end
+
+EM.run do
+  @count = 0
+
+  # This is tracking every tweet that includes the string "madrid" OR any tweet
+  # that is geo-located in Madrid.
+  Nervion.filter(track: 'madrid', locations: '40.364,-3.760,40.365,-3.609') do |status|
+    print_status status[:user][:screen_name], status[:text] if status.has_key? :text
+    @count += 1
+  end
+
+  # Check the count of streamed statuses every 2 seconds and switch to sample
+  # stream after getting 20. Stop after getting 5 statuses through the sample
+  # endpoint.
+  EM.add_periodic_timer(2) do
+    STDERR.puts "Checking the number of tweets: #{@count}"
+    if @count > 20
+      @count = 0
+      STDERR.puts "MORE THAN 20!!!!!! => switching to sample endpoint"
+      Nervion.close_stream
+
+      EM.next_tick do
+        Nervion.sample do |status|
+          @count += 1
+          STDERR.puts @count
+          Nervion.stop if @count >= 5
+        end
+      end
+    end
+  end
+end

data/examples/firehose_example.rb

@@ -0,0 +1,13 @@
+require 'nervion'
+
+# Setup your own keys here
+Nervion.configure do |config|
+  config.consumer_key = ''
+  config.consumer_secret = ''
+  config.access_token = ''
+  config.access_token_secret = ''
+end
+
+# This will cause a 403: User not in role message unless you have the level of
+# access required to stream the firehose endpoint.
+Nervion.firehose { |status| puts status }

data/examples/sample_endpoint.rb

@@ -0,0 +1,32 @@
+require 'nervion'
+
+CYAN     = "\e[0;36m"
+NO_COLOR = "\e[0m"
+
+def print_non_status(text)
+  puts "#{CYAN}#{text}#{NO_COLOR}"
+end
+
+# Setup your own keys here
+Nervion.configure do |config|
+  config.consumer_key = ''
+  config.consumer_secret = ''
+  config.access_token = ''
+  config.access_token_secret = ''
+end
+
+@deleted_count = 0
+# Calculate the percentage of delete statuses streamed through the sample endpoint.
+Nervion.sample(stall_warnings: true) do |status|
+  @count += 1
+  if status.has_key? :delete
+    print_non_status status
+    @deleted_count += 1
+  end
+
+  if @count >= 1000
+    Nervion.stop
+    percentage = (@deleted_count * 100.0) / @count
+    puts "#@deleted_count out of #@count were deleted tweets (#{percentage.round(2)}%)"
+  end
+end

data/lib/nervion/facade.rb

@@ -90,16 +90,19 @@ module Nervion
 
   # Stops streaming and stops EventMachine's event loop
   def self.stop
-    check_for_running_client
     @client.stop
   end
 
   # Stops streaming but keeps EventMachine's event loop running
   def self.close_stream
-    check_for_running_client
     @client.close_stream
   end
 
+  # @return [boolean] whether Nervion is running or not
+  def self.running?
+    not @client.nil?
+  end
+
   private
 
   def self.callback_table
@@ -137,10 +140,6 @@ module Nervion
     raise "You have to setup a message callback. Please, check out #{MSG_CALLBACK_README_URL}"
   end
 
-  def self.check_for_running_client
-    raise 'Nervion is not running' if @client.nil?
-  end
-
   STREAM_API_HOST   = 'stream.twitter.com'
   STREAM_API_PORT   = 443
   SAMPLE_ENDPOINT   = "https://#{STREAM_API_HOST}/1/statuses/sample.json"
@@ -149,5 +148,4 @@ module Nervion
 
   AUTHENTICATION_README_URL = 'https://github.com/jacegu/nervion#authentication'
   MSG_CALLBACK_README_URL   = 'https://github.com/jacegu/nervion#message-callback'
-
 end

data/lib/nervion/version.rb

@@ -1,3 +1,3 @@
 module Nervion
-  VERSION = "0.0.3"
+  VERSION = '0.0.4'
 end

data/nervion.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Javier Acero"]
   gem.email         = ["j4cegu@gmail.com"]
   gem.description   = %q{A minimalistic Ruby client for the Public Streams of Twitter Streaming API}
-  gem.summary       = %q{}
+  gem.summary       = %q{Nervions is an easy tool and lightweight tool for consuming Twitter's Public Streams with an API that mimics the provided endpoints}
   gem.homepage      = "https://github.com/jacegu/nervion"
 
   gem.files         = `git ls-files`.split($\)

data/spec/nervion/facade_spec.rb

@@ -1,10 +1,8 @@
 require 'nervion/facade'
 
-class Callable; def call; end; end;
-
 describe "Facade that exposes Nervion's API" do
   let(:callback_table)   { mock(:callback_table).as_null_object }
-  let(:message_callback)  { lambda { :message_callback } }
+  let(:message_callback) { lambda { :message_callback } }
   let(:http_callback)    { lambda { :http_error_callback } }
   let(:network_callback) { lambda { :network_error_callback } }
 
@@ -97,32 +95,23 @@ describe "Facade that exposes Nervion's API" do
       it_behaves_like 'an endpoint'
     end
 
-    context 'stoping' do
-      it 'stops the client and the event loop' do
-        client.should_receive(:stop)
-        Nervion.sample{}
-        Nervion.stop
-      end
-
-      it 'raises an error if it is not streaming' do
-        Nervion.instance_variable_set(:@client, nil)
-        expect { Nervion.stop }.to raise_error
-      end
+    it 'stops the client and the event loop' do
+      client.should_receive(:stop)
+      Nervion.sample{}
+      Nervion.stop
     end
 
-    context 'closing the stream' do
-      it 'closes the stream but keeps the event loop running' do
-        client.should_receive(:close_stream)
-        Nervion.sample{}
-        Nervion.close_stream
-      end
-
-      it 'raises an error if it is not streaming' do
-        Nervion.instance_variable_set(:@client, nil)
-        expect { Nervion.close_stream }.to raise_error
-      end
+    it 'closes the stream but keeps the event loop running' do
+      client.should_receive(:close_stream)
+      Nervion.sample{}
+      Nervion.close_stream
     end
 
+    it 'knows if Nervion is running' do
+      Nervion.instance_variable_set('@client', nil)
+      Nervion.should_not be_running
+      Nervion.sample{}
+      Nervion.should be_running
+    end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nervion
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-10 00:00:00.000000000 Z
+date: 2012-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -156,6 +156,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/filter_endpoint.rb
+- examples/firehose_example.rb
+- examples/sample_endpoint.rb
 - features/callbacks.feature
 - features/client_validation.feature
 - features/step_definitions/client_validation_steps.rb
@@ -215,7 +218,8 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ''
+summary: Nervions is an easy tool and lightweight tool for consuming Twitter's Public
+  Streams with an API that mimics the provided endpoints
 test_files:
 - features/callbacks.feature
 - features/client_validation.feature