jls-tweetstream 2.5.0

data/lib/tweetstream/configuration.rb

@@ -0,0 +1,92 @@
+require 'tweetstream/version'
+
+module TweetStream
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring TweetStream.
+    VALID_OPTIONS_KEYS = [
+      :parser,
+      :username,
+      :password,
+      :user_agent,
+      :auth_method,
+      :proxy,
+      :consumer_key,
+      :consumer_secret,
+      :oauth_token,
+      :oauth_token_secret].freeze
+
+    OAUTH_OPTIONS_KEYS = [
+      :consumer_key,
+      :consumer_secret,
+      :oauth_token,
+      :oauth_token_secret].freeze
+
+    # By default, don't set a username
+    DEFAULT_USERNAME = nil
+
+    # By default, don't set a password
+    DEFAULT_PASSWORD = nil
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "TweetStream Ruby Gem #{TweetStream::VERSION}".freeze
+
+    # The default authentication method
+    DEFAULT_AUTH_METHOD = :oauth
+
+    DEFAULT_PROXY = nil
+
+    VALID_FORMATS = [
+      :basic,
+      :oauth].freeze
+
+    # By default, don't set an application key
+    DEFAULT_CONSUMER_KEY = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # By default, don't set a user oauth token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # By default, don't set a user oauth secret
+    DEFAULT_OAUTH_TOKEN_SECRET = nil
+
+    # @private
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      Hash[*VALID_OPTIONS_KEYS.map {|key| [key, send(key)] }.flatten]
+    end
+
+    # Create a hash of options and their values
+    def oauth_options
+      Hash[*OAUTH_OPTIONS_KEYS.map {|key| [key, send(key)] }.flatten]
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.username           = DEFAULT_USERNAME
+      self.password           = DEFAULT_PASSWORD
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.auth_method        = DEFAULT_AUTH_METHOD
+      self.proxy              = DEFAULT_PROXY
+      self.consumer_key       = DEFAULT_CONSUMER_KEY
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
+      self
+    end
+  end
+end

data/lib/tweetstream/daemon.rb

@@ -0,0 +1,52 @@
+require 'daemons'
+
+# A daemonized TweetStream client that will allow you to
+# create backgroundable scripts for application specific
+# processes. For instance, if you create a script called
+# <tt>tracker.rb</tt> and fill it with this:
+#
+#     require 'rubygems'
+#     require 'tweetstream'
+#
+#     TweetStream.configure do |config|
+#       config.consumer_key = 'abcdefghijklmnopqrstuvwxyz'
+#       config.consumer_secret = '0123456789'
+#       config.oauth_token = 'abcdefghijklmnopqrstuvwxyz'
+#       config.oauth_token_secret = '0123456789'
+#       config.auth_method = :oauth
+#     end
+#
+#     TweetStream::Daemon.new('tracker').track('intridea') do |status|
+#       # do something here
+#     end
+#
+# And then you call this from the shell:
+#
+#     ruby tracker.rb start
+#
+# A daemon process will spawn that will automatically
+# run the code in the passed block whenever a new tweet
+# matching your search term ('intridea' in this case)
+# is posted.
+#
+class TweetStream::Daemon < TweetStream::Client
+
+  DEFAULT_NAME = 'tweetstream'.freeze
+  DEFAULT_OPTIONS = { :multiple => true }
+
+  attr_accessor :app_name, :daemon_options
+
+  # The daemon has an optional process name for use when querying
+  # running processes.  You can also pass daemon options.
+  def initialize(name = DEFAULT_NAME, options = DEFAULT_OPTIONS)
+    @app_name = name
+    @daemon_options = options
+    super({})
+  end
+
+  def start(path, query_parameters = {}, &block) #:nodoc:
+    Daemons.run_proc(@app_name, @daemon_options) do
+      super(path, query_parameters, &block)
+    end
+  end
+end

data/lib/tweetstream/site_stream_client.rb

@@ -0,0 +1,122 @@
+require 'em-http'
+require 'em-http/middleware/oauth'
+require 'em-http/middleware/json_response'
+
+module TweetStream
+  class SiteStreamClient
+
+    attr_accessor *Configuration::OAUTH_OPTIONS_KEYS
+
+    def initialize(config_uri, oauth = {})
+      @config_uri = config_uri
+
+      options = TweetStream.oauth_options.merge(oauth)
+      Configuration::OAUTH_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+
+      EventMachine::HttpRequest.use EventMachine::Middleware::JSONResponse
+    end
+
+    def on_error(&block)
+      if block_given?
+        @on_error = block
+        self
+      else
+        @on_error
+      end
+    end
+
+    def info(&block)
+      options = { :error_msg => 'Failed to retrieve SiteStream info.' }
+      request(:get, info_path, options, &block)
+    end
+
+    def add_user(user_id, &block)
+      options = {
+                  :error_msg => 'Failed to add user to SiteStream',
+                  :body => { 'user_id' => normalized_user_ids(user_id) }
+                }
+
+      request(:post, add_user_path, options, &block)
+    end
+
+    def remove_user(user_id, &block)
+      options = {
+                  :error_msg => 'Failed to remove user from SiteStream.',
+                  :body => { 'user_id' => normalized_user_ids(user_id) }
+                }
+
+      request(:post, remove_user_path, options, &block)
+    end
+
+    def friends_ids(user_id, &block)
+      options = { :error_msg => 'Failed to retrieve SiteStream friends ids.',
+                  :body => { 'user_id' => user_id }
+                }
+      request(:post, friends_ids_path, options, &block)
+    end
+
+    private
+
+    def connection
+      return @conn if defined?(@conn)
+
+      @conn = EventMachine::HttpRequest.new('https://sitestream.twitter.com/')
+      @conn.use EventMachine::Middleware::OAuth, oauth_configuration
+      @conn
+    end
+
+    def oauth_configuration
+      {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :access_token => oauth_token,
+        :access_token_secret => oauth_token_secret
+      }
+    end
+
+    def info_path
+      @config_uri + '/info.json'
+    end
+
+    def add_user_path
+      @config_uri + '/add_user.json'
+    end
+
+    def remove_user_path
+      @config_uri + '/remove_user.json'
+    end
+
+    def friends_ids_path
+      @config_uri + '/friends/ids.json'
+    end
+
+    def request(method, path, options, &block)
+      error_msg = options.delete(:error_msg)
+
+      http = connection.send(method, options.merge(:path => path))
+      http.callback do
+        if http.response_header.status == 200
+          if block && block.kind_of?(Proc)
+            if block.arity == 1
+              block.call http.response
+            else
+              block.call
+            end
+          end
+        else
+          @on_error.call(error_msg) if @on_error && @on_error.kind_of?(Proc)
+        end
+      end
+      http.errback do
+        @on_error.call(error_msg) if @on_error && @on_error.kind_of?(Proc)
+      end
+    end
+
+    def normalized_user_ids(user_id)
+      user_id.join(',') if user_id.kind_of?(Array)
+    end
+
+  end
+end

data/lib/tweetstream/version.rb

@@ -0,0 +1,3 @@
+module TweetStream
+  VERSION = '2.5.0' unless defined?(TweetStream::VERSION)
+end

data/spec/fixtures/delete.json

@@ -0,0 +1,8 @@
+{
+  "delete": {
+    "status": {
+      "id": 1234,
+      "user_id": 3
+    }
+  }
+}

data/spec/fixtures/direct_messages.json

@@ -0,0 +1 @@
+{"direct_message":{"created_at":"Sat Sep 24 18:59:38 +0000 2011", "id_str":"4227325281", "sender_screen_name":"coreyhaines", "sender":{"name":"Corey Haines", "profile_sidebar_fill_color":"DAECF4", "profile_sidebar_border_color":"C6E2EE", "profile_background_tile":false, "profile_image_url":"http://a0.twimg.com/profile_images/1508969901/Photo_on_2011-08-22_at_19.15__3_normal.jpg", "created_at":"Sun Dec 23 18:11:29 +0000 2007", "location":"Chicago, IL", "follow_request_sent":false, "id_str":"11458102", "is_translator":false, "profile_link_color":"1F98C7", "default_profile":false, "favourites_count":122, "contributors_enabled":false, "url":"http://www.coreyhaines.com", "id":11458102, "profile_image_url_https":"https://si0.twimg.com/profile_images/1508969901/Photo_on_2011-08-22_at_19.15__3_normal.jpg", "utc_offset":-21600, "profile_use_background_image":true, "listed_count":593, "lang":"en", "followers_count":5764, "protected":false, "profile_text_color":"663B12", "notifications":false, "description":"Software Journeyman, Coderetreat Facilitator, Cofounder of MercuryApp.com, Awesome....\r\nI make magic!", "verified":false, "profile_background_color":"C6E2EE", "geo_enabled":false, "profile_background_image_url_https":"https://si0.twimg.com/images/themes/theme2/bg.gif", "time_zone":"Central Time (US & Canada)", "profile_background_image_url":"http://a1.twimg.com/images/themes/theme2/bg.gif", "default_profile_image":false, "friends_count":423, "statuses_count":35950, "following":false, "screen_name":"coreyhaines", "show_all_inline_media":false}, "recipient_screen_name":"coreyhainestest", "text":"waddup gain", "id":4227325281, "recipient":{"name":"Corey's Test Account", "profile_sidebar_fill_color":"DDEEF6", "profile_sidebar_border_color":"C0DEED", "profile_background_tile":false, "profile_image_url":"http://a2.twimg.com/sticky/default_profile_images/default_profile_3_normal.png", "created_at":"Sat Sep 24 13:04:56 +0000 2011", "location":null, "follow_request_sent":false, "id_str":"379145826", "is_translator":false, "profile_link_color":"0084B4", "default_profile":true, "favourites_count":0, "contributors_enabled":false, "url":null, "id":379145826, "profile_image_url_https":"https://si0.twimg.com/sticky/default_profile_images/default_profile_3_normal.png", "utc_offset":null, "profile_use_background_image":true, "listed_count":0, "lang":"en", "followers_count":1, "protected":false, "profile_text_color":"333333", "notifications":false, "description":null, "verified":false, "profile_background_color":"C0DEED", "geo_enabled":false, "profile_background_image_url_https":"https://si0.twimg.com/images/themes/theme1/bg.png", "time_zone":null, "profile_background_image_url":"http://a0.twimg.com/images/themes/theme1/bg.png", "default_profile_image":true, "friends_count":1, "statuses_count":21, "following":true, "screen_name":"coreyhainestest", "show_all_inline_media":false}, "recipient_id":379145826, "sender_id":11458102}}

data/spec/fixtures/favorite.json

@@ -0,0 +1,150 @@
+{"target":
+  {"id": 598914668,
+   "verified": false,
+   "id_str": "598914668",
+   "profile_background_tile": false,
+   "location": "",
+   "profile_sidebar_fill_color": "DDEEF6",
+   "contributors_enabled": false,
+   "notifications": false,
+   "geo_enabled": false,
+   "profile_image_url_https": "https://si0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+   "utc_offset": null,
+   "default_profile": true,
+   "statuses_count": 151,
+   "name": "dev4sns",
+   "profile_background_color": "C0DEED",
+   "friends_count": 15,
+   "show_all_inline_media": false,
+   "protected": false,
+   "follow_request_sent": false,
+   "screen_name": "dev4sns",
+   "listed_count": 0,
+   "profile_background_image_url": "http://a0.twimg.com/images/themes/theme1/bg.png",
+   "lang": "ko",
+   "profile_link_color": "0084B4",
+   "time_zone": null,
+   "description": "Dev 계정입니다.",
+   "is_translator": false,
+   "profile_use_background_image": true,
+   "url": null,
+   "profile_text_color": "333333",
+   "created_at": "Mon Jun 04 04:07:27 +0000 2012",
+   "default_profile_image": false,
+   "profile_background_image_url_https":
+    "https://si0.twimg.com/images/themes/theme1/bg.png",
+   "favourites_count": 0,
+   "profile_sidebar_border_color": "C0DEED",
+   "profile_image_url":
+    "http://a0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+   "following": true,
+   "followers_count": 5},
+ "target_object":
+  {"id_str": "228029422597443584",
+   "in_reply_to_user_id": null,
+   "truncated": false,
+   "contributors": null,
+   "retweet_count": 0,
+   "possibly_sensitive_editable": true,
+   "favorited": false,
+   "coordinates": null,
+   "geo": null,
+   "possibly_sensitive": false,
+   "user":
+    {"id": 598914668,
+     "verified": false,
+     "id_str": "598914668",
+     "profile_background_tile": false,
+     "location": "",
+     "profile_sidebar_fill_color": "DDEEF6",
+     "contributors_enabled": false,
+     "notifications": false,
+     "geo_enabled": false,
+     "profile_image_url_https":
+      "https://si0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+     "utc_offset": null,
+     "default_profile": true,
+     "statuses_count": 151,
+     "name": "dev4sns",
+     "profile_background_color": "C0DEED",
+     "friends_count": 15,
+     "show_all_inline_media": false,
+     "protected": false,
+     "follow_request_sent": false,
+     "screen_name": "dev4sns",
+     "listed_count": 0,
+     "profile_background_image_url":
+      "http://a0.twimg.com/images/themes/theme1/bg.png",
+     "lang": "ko",
+     "profile_link_color": "0084B4",
+     "time_zone": null,
+     "description": "Dev 계정입니다.",
+     "is_translator": false,
+     "profile_use_background_image": true,
+     "url": null,
+     "profile_text_color": "333333",
+     "created_at": "Mon Jun 04 04:07:27 +0000 2012",
+     "default_profile_image": false,
+     "profile_background_image_url_https":
+      "https://si0.twimg.com/images/themes/theme1/bg.png",
+     "favourites_count": 0,
+     "profile_sidebar_border_color": "C0DEED",
+     "profile_image_url":
+      "http://a0.twimg.com/profile_images/2276724218/raf46pju0mijc6ixm6ke_normal.jpeg",
+     "following": true,
+     "followers_count": 5},
+   "in_reply_to_status_id_str": null,
+   "in_reply_to_screen_name": null,
+   "source": "<a href=\"http://www.a2m.co.kr\" rel=\"nofollow\">Dev Acct</a>",
+   "in_reply_to_user_id_str": null,
+   "retweeted": false,
+   "in_reply_to_status_id": null,
+   "id": 228029422597443584,
+   "place": null,
+   "text": "asdf http://t.co/CRX3fCRa",
+   "created_at": "Wed Jul 25 07:30:25 +0000 2012"},
+ "source":
+  {"id": 459909498,
+   "verified": false,
+   "id_str": "459909498",
+   "profile_background_tile": false,
+   "location": "",
+   "profile_sidebar_fill_color": "DDEEF6",
+   "contributors_enabled": false,
+   "notifications": false,
+   "geo_enabled": false,
+   "profile_image_url_https":
+    "https://si0.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
+   "utc_offset": null,
+   "default_profile": true,
+   "statuses_count": 124,
+   "name": "Brian Park",
+   "profile_background_color": "C0DEED",
+   "friends_count": 3,
+   "show_all_inline_media": false,
+   "protected": false,
+   "follow_request_sent": false,
+   "screen_name": "bdares",
+   "listed_count": 0,
+   "profile_background_image_url":
+    "http://a0.twimg.com/images/themes/theme1/bg.png",
+   "lang": "en",
+   "profile_link_color": "0084B4",
+   "time_zone": null,
+   "description": "",
+   "is_translator": false,
+   "profile_use_background_image": true,
+   "url": null,
+   "profile_text_color": "333333",
+   "created_at": "Tue Jan 10 05:33:52 +0000 2012",
+   "default_profile_image": true,
+   "profile_background_image_url_https":
+    "https://si0.twimg.com/images/themes/theme1/bg.png",
+   "favourites_count": 14,
+   "profile_sidebar_border_color": "C0DEED",
+   "profile_image_url":
+    "http://a0.twimg.com/sticky/default_profile_images/default_profile_6_normal.png",
+   "following": false,
+   "followers_count": 1},
+ "event": "favorite",
+ "created_at": "Mon Aug 06 02:24:16 +0000 2012"}

data/spec/fixtures/ids.json

@@ -0,0 +1,30 @@
+{
+    "follow":
+    {
+        "user":
+        {
+            "id":119476949,
+            "name":"oauth_dancer",
+            "dm":false
+        },
+        "friends":
+        [
+            795649,
+            819797,
+            1401881,
+            3191321,
+            6253282,
+            8285392,
+            9160152,
+            13058772,
+            15147442,
+            15266205,
+            15822993,
+            27831060,
+            101058399,
+            289788076
+        ],
+        "previous_cursor":0,
+        "next_cursor":0
+    }
+}