powertrack 1.0.0

data/lib/powertrack/version.rb

@@ -0,0 +1,3 @@
+module PowerTrack
+  VERSION = '1.0.0'
+end

data/powertrack.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'powertrack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'powertrack'
+  spec.version       = PowerTrack::VERSION
+  spec.authors       = ['Laurent Farcy', 'Eric Wendelin', 'Ryan Weald']
+  spec.email         = ['laurent.farcy@ecairn.com', 'me@eriwen.com', 'ryan@weald.com']
+  spec.summary       = %q{Powertrack-rb is a gem used to develop GNIP PowerTrack streaming clients.}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/ecairn/powertrack-rb'
+  spec.license       = 'MIT license'
+  spec.required_ruby_version = '~> 1.9'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.3'
+  spec.add_development_dependency 'minitest', '~> 5.5'
+  spec.add_development_dependency 'ruby-prof', '~> 0.15'
+
+  spec.add_dependency 'multi_json', '~> 1.11'
+  spec.add_dependency 'eventmachine', '~> 1.0'
+  spec.add_dependency 'em-http-request', '~> 1.1'
+  spec.add_dependency 'exponential-backoff',  '~> 0.0.2'
+  spec.add_dependency 'void_logger',  '~> 0.1'
+end

data/test/minitest_helper.rb

@@ -0,0 +1,41 @@
+gem 'minitest'
+require 'minitest/autorun'
+require 'yaml'
+
+class Minitest::Test
+
+  POWERTRACK_CONFIG_FILEPATH = File.join(File.dirname(__FILE__), "powertrack.yml")
+
+  # Returns the PowerTrack configuration as defined in test/powertrack.yml.
+  def powertrack_config
+    unless defined?(@loaded) && @loaded
+      begin
+        if File.exist?(POWERTRACK_CONFIG_FILEPATH)
+          @pwtk_config = (YAML.load_file(POWERTRACK_CONFIG_FILEPATH) || {})
+        else
+          $stderr.puts "No PowerTrack config file found at '#{POWERTRACK_CONFIG_FILEPATH}'"
+        end
+      rescue Exception
+        $stderr.puts "Exception while loading PowerTrack config file: #{$!.message}"
+      ensure
+        @pwtk_config ||= {}
+      end
+
+      # symbolize keys
+      @pwtk_config = Hash[@pwtk_config.map{ |k, v| [k.to_sym, v] }]
+      @loaded = true
+    end
+
+    @pwtk_config
+  end
+
+  # Returns a brand-new stream based on the config found in test/powertrack.yml.
+  def new_stream
+    PowerTrack::Stream.new(
+      powertrack_config[:username],
+      powertrack_config[:password],
+      powertrack_config[:account_name],
+      powertrack_config[:data_source],
+      powertrack_config[:stream_label])
+  end
+end

data/test/test_manage_rules.rb

@@ -0,0 +1,30 @@
+require 'minitest_helper'
+require 'powertrack'
+require 'multi_json'
+
+class TestManageRules < Minitest::Test
+
+  def test_add_then_delete_a_single_rule
+    stream = new_stream
+
+    rule = PowerTrack::Rule.new('coke')
+    assert rule.valid?
+
+    pre_existing_rules = stream.list_rules
+    assert pre_existing_rules.is_a?(Array)
+
+    assert_nil stream.add_rule(rule)
+
+    rules_after_addition = stream.list_rules(false)
+    assert rules_after_addition.is_a?(Array)
+    assert_equal pre_existing_rules.size + 1, rules_after_addition.size
+    assert [ rule ], rules_after_addition - pre_existing_rules
+
+    assert_nil stream.delete_rules(rule)
+
+    rules_after_removal = stream.list_rules
+    assert rules_after_removal.is_a?(Array)
+    assert_equal rules_after_addition.size - 1, rules_after_removal.size
+    assert_equal [], rules_after_removal - rules_after_addition
+  end
+end

data/test/test_rule.rb

@@ -0,0 +1,163 @@
+require 'minitest_helper'
+require 'powertrack'
+require 'multi_json'
+
+class TestRule < Minitest::Test
+
+  def test_valid_rule
+    rule = PowerTrack::Rule.new('coke')
+    assert_equal 'coke', rule.value
+    assert_nil rule.tag
+    assert !rule.long?
+    assert rule.valid?
+    assert_nil rule.error
+
+    rule = PowerTrack::Rule.new('pepsi', 'soda', true)
+    assert_equal 'pepsi', rule.value
+    assert_equal 'soda', rule.tag
+    assert rule.long?
+    assert rule.valid?
+    assert_nil rule.error
+  end
+
+  def test_too_long_tag
+    long_tag = 'a' * PowerTrack::Rule::MAX_TAG_LENGTH
+    rule = PowerTrack::Rule.new('coke', long_tag, false)
+    assert rule.valid?
+    assert_nil rule.error
+
+    long_tag = 'b' * 2 * PowerTrack::Rule::MAX_TAG_LENGTH
+    rule = PowerTrack::Rule.new('coke', long_tag, true)
+    assert !rule.valid?
+    assert_match /too long tag/i, rule.error
+  end
+
+  def test_too_long_value
+    long_val = 'a' * PowerTrack::Rule::MAX_STD_RULE_VALUE_LENGTH
+    rule = PowerTrack::Rule.new(long_val)
+    assert rule.valid?
+
+    long_val = 'c' * PowerTrack::Rule::MAX_LONG_RULE_VALUE_LENGTH
+    rule = long_val.to_pwtk_rule(nil, false)
+
+    assert !rule.valid?
+    assert_match /too long value/i, rule.error
+
+    assert long_val.to_pwtk_rule.valid?
+    assert long_val.to_pwtk_rule(nil, true).valid?
+
+    very_long_val = 'rrr' * PowerTrack::Rule::MAX_LONG_RULE_VALUE_LENGTH
+    rule = very_long_val.to_pwtk_rule
+    assert !rule.valid?
+    assert_match /too long value/i, rule.error
+  end
+
+  def test_too_many_positive_terms
+    phrase = ([ 'coke' ] * PowerTrack::Rule::MAX_POSITIVE_TERMS).join(' ')
+    rule = PowerTrack::Rule.new(phrase)
+    assert !rule.long?
+    assert rule.valid?
+    assert_nil rule.error
+
+    long_rule = PowerTrack::Rule.new(phrase, nil, true)
+    assert long_rule.long?
+    assert long_rule.valid?
+    assert_nil long_rule.error
+
+    phrase = ([ 'coke' ] * (2 * PowerTrack::Rule::MAX_POSITIVE_TERMS)).join(' ')
+    rule = PowerTrack::Rule.new(phrase, nil, false)
+    assert !rule.long?
+    assert !rule.valid?
+    assert_match /too many positive terms/i, rule.error
+
+    long_rule = PowerTrack::Rule.new(phrase, nil, true)
+    assert long_rule.long?
+    assert long_rule.valid?
+    assert_nil long_rule.error
+
+    phrase = "from:lkv1csayp OR from:u42vf OR from:y OR from:groj OR from:69iqciuxlxerqq OR from:4 OR from:9832xjrqi1ncrs OR from:7kfss6jxtl0oj OR from:b31m9qf0u3tc OR from:0 OR from:abo59n OR from:3lma3kl OR from:5 OR from:ovw7bgov OR from:ubp OR from:gc9a6b OR from:jo7ootfvy4 OR from:sg7oohj OR from:349ankku OR from:9b72n OR from:qz7offt5019u OR from:gkd OR from:cc31p3 OR from:xws9 OR from:bjzbatm OR from:rwjm78cgre3j5 OR from:f1obak7w3w OR from:nontf OR from:4aeas6kgb7nia OR from:dzqy7"
+    long_rule = PowerTrack::Rule.new(phrase)
+    assert !long_rule.long?
+    assert long_rule.valid?, long_rule.error
+    assert_nil long_rule.error
+
+    long_rule = PowerTrack::Rule.new(phrase + " OR from:michel")
+    assert !rule.valid?
+    assert_match /too many positive terms/i, rule.error
+  end
+
+  def test_too_many_negative_terms
+    phrase = ([ '-pepsi' ] * PowerTrack::Rule::MAX_POSITIVE_TERMS).join(' ')
+    rule = PowerTrack::Rule.new(phrase)
+    assert !rule.long?
+    assert rule.valid?
+    assert_nil rule.error
+
+    long_rule = PowerTrack::Rule.new(phrase, nil, true)
+    assert long_rule.long?
+    assert long_rule.valid?
+    assert_nil long_rule.error
+
+    phrase = ([ '-pepsi' ] * (2 * PowerTrack::Rule::MAX_POSITIVE_TERMS)).join(' ')
+    rule = PowerTrack::Rule.new(phrase)
+    assert !rule.long?
+    assert !rule.valid?
+    assert_match /too many negative terms/i, rule.error
+
+    long_rule = PowerTrack::Rule.new(phrase, nil, true)
+    assert long_rule.long?
+    assert long_rule.valid?
+    assert_nil long_rule.error
+  end
+
+  def test_contains_negated_or
+    phrase = 'coke OR -pepsi'
+    rule = PowerTrack::Rule.new(phrase)
+    assert !rule.long?
+    assert !rule.valid?
+    assert_match /contains negated or/i, rule.error
+  end
+
+  def test_to_hash_and_json
+    res = { value: 'coke OR pepsi' }
+    rule = PowerTrack::Rule.new(res[:value])
+    assert_equal res, rule.to_hash
+    assert_equal MultiJson.encode(res), rule.to_json
+
+    res[:tag] = 'soda'
+    rule = PowerTrack::Rule.new(res[:value], res[:tag], true)
+    assert_equal res, rule.to_hash
+    assert_equal MultiJson.encode(res), rule.to_json
+  end
+
+  def test_double_quote_jsonification
+    rule = PowerTrack::Rule.new('"social data" @gnip')
+    assert_equal '{"value":"\"social data\" @gnip"}', rule.to_json
+
+    rule = PowerTrack::Rule.new('Toys \"R\" Us')
+    # 2 backslashes for 1
+    assert_equal '{"value":"Toys \\\\\\"R\\\\\\" Us"}', rule.to_json
+  end
+
+  def test_hash
+    short_rule = PowerTrack::Rule.new('coke')
+    not_long_rule = PowerTrack::Rule.new('coke', nil, false)
+    false_long_rule = PowerTrack::Rule.new('coke', nil, true)
+    short_rule_with_tag = PowerTrack::Rule.new('coke', 'soda')
+
+    assert short_rule == not_long_rule
+    assert_equal short_rule, not_long_rule
+    assert_equal short_rule.hash, not_long_rule.hash
+
+    assert short_rule != false_long_rule
+    h = { short_rule => 1 }
+    h[not_long_rule] = 2
+    h[false_long_rule] = 3
+    h[short_rule_with_tag] = 4
+
+    assert_equal 2, h[short_rule]
+    assert_equal h[short_rule], h[not_long_rule]
+    assert_equal 4, h[short_rule_with_tag]
+    assert_nil h[PowerTrack::Rule.new('pepsi', 'soda')]
+  end
+end

data/test/test_track_stream.rb

@@ -0,0 +1,72 @@
+require 'minitest_helper'
+require 'powertrack'
+require 'multi_json'
+
+class TestTrackStream < Minitest::Test
+
+  def test_track_simple_stream
+    stream = new_stream
+
+    # add a logger
+    stream.logger = Logger.new(STDERR)
+
+    rule = PowerTrack::Rule.new('ny OR nyc OR #nyc OR new york')
+    assert rule.valid?
+
+    begin
+      assert_nil stream.add_rule(rule)
+      rules_after_addition = stream.list_rules
+      assert rules_after_addition.is_a?(Array)
+      assert rules_after_addition.size > 0
+
+      heartbeats = 0
+      received = 0
+      tweeted = 0
+      closed = false
+
+      # ready to track
+      on_message = lambda do |message|
+        received += 1
+      end
+      on_heartbeat = lambda do
+        heartbeats += 1
+      end
+      on_activity = lambda do |tweet|
+        tweeted += 1
+      end
+
+      close_now = lambda { closed }
+
+      delay = 60
+      Thread.new do
+        $stderr.puts "Time-bomb thread running for #{delay} seconds..."
+        sleep delay
+        $stderr.puts "Time to shut down !"
+        closed = true
+      end
+
+      started_at = Time.now
+      res = stream.track(on_message: on_message,
+                         on_heartbeat: on_heartbeat,
+                         on_activity: on_activity,
+                         close_now: close_now,
+                         max_retries: 3,
+                         fake_disconnections: 20)
+
+      assert_nil res
+      assert closed, 'Stream not closed'
+      assert Time.now - started_at >= delay
+
+      assert heartbeats > 0, 'No heartbeat received'
+      puts "#{heartbeats} heartbeats received"
+
+      assert received > 0, 'No message received so far'
+      puts "#{received} messages received"
+
+      assert tweeted > 0, 'No tweet received so far'
+      puts "#{tweeted} tweets received"
+    ensure
+      assert_nil stream.delete_rules(rule)
+    end
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: powertrack
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Laurent Farcy
+- Eric Wendelin
+- Ryan Weald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MS4w
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MS4w
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: exponential-backoff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: void_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Powertrack-rb is a gem used to develop GNIP PowerTrack streaming clients.
+email:
+- laurent.farcy@ecairn.com
+- me@eriwen.com
+- ryan@weald.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- TODO.md
+- lib/core_ext/class.rb
+- lib/powertrack.rb
+- lib/powertrack/errors.rb
+- lib/powertrack/rules/rule.rb
+- lib/powertrack/rules/string_extension.rb
+- lib/powertrack/streaming/api.rb
+- lib/powertrack/streaming/data_buffer.rb
+- lib/powertrack/streaming/retrier.rb
+- lib/powertrack/streaming/stream.rb
+- lib/powertrack/version.rb
+- powertrack.gemspec
+- test/minitest_helper.rb
+- test/test_manage_rules.rb
+- test/test_rule.rb
+- test/test_track_stream.rb
+homepage: https://github.com/ecairn/powertrack-rb
+licenses:
+- MIT license
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ~>
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Powertrack-rb is a gem used to develop GNIP PowerTrack streaming clients.
+test_files:
+- test/minitest_helper.rb
+- test/test_manage_rules.rb
+- test/test_rule.rb
+- test/test_track_stream.rb