first commit

Author: hiro

.gitignore

@@ -0,0 +1,2 @@
+*.yml
+*.log

LICENSE.txt

@@ -0,0 +1,29 @@
+twbot2.rb Copyright (c) 2010-, Maraigue
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+Neither the name of the Maraigue nor the names of its contributors
+may be used to endorse or promote products derived from this
+software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -0,0 +1,81 @@
+## About twbot2.rb
+
+**twbot2.rb** is a Twitter bot framework combined with OAuth token manager.
+
+Since version 0.21, the program was remade to be used non-Twitter-bot Twitter program, where twbot2.rb works as only an OAuth token manager.
+
+## Example
+
+We have only to define what the bot tweets as the following format:
+
+    $ cat greeting_bot.rb
+    
+    require "./twbot2"
+    TwBot.create("config-file.yml", "log-file.log").cui_menu do
+      # Define what the bot tweets here
+      tweet_list = ["Good morning", "Good afternoon", "Good evening"]
+      [tweet_list[rand(tweet_list.size)]] # return as an array
+    end
+
+To add the content to be tweeted to the configuration file, call with the parameter "load".
+
+    $ ruby greeting_bot.rb load
+    
+    Running mode 'load'...
+    [2000-00-00 00:00:00 +0000]
+    [cui_menu:mode=load]
+
+To post a tweet stored in "load" mode, call with the parameter "load".
+
+    $ ruby greeting_bot.rb post
+    
+    Running mode 'post'...
+    [2000-00-00 00:00:00 +0000]
+    [cui_menu:mode=post]<Error in updating> A String (user name) or Hash
+    (parameters) is required as the argument (NilClass given)
+    * Perhaps you have not finished authentication. Try 'greeting_bot.rb init' to
+    register the default user.
+    ArgumentError: A String (user name) or Hash (parameters) is required as the
+    argument (NilClass given)
+    * Perhaps you have not finished authentication. Try 'greeting_bot.rb init' to
+    register the default user.
+    (snipped)
+
+However, it fails since no user is registered in the configuration file yet. So let's initialize the configuration file with a default user.
+
+    $ ruby greeting_bot.rb init
+    
+    Running mode 'init'...
+    ============================================================
+    Here I help you register your bot account to the setting file.
+    Please prepare a browser to retrieve OAuth tokens.
+    
+    Input the screen name of your bot account.
+    ============================================================
+    User name >h_hiro_
+    ============================================================
+    To retrieve OAuth token of user "h_hiro_":
+    (1) Log in Twitter with a browser for user "h_hiro_".
+    (2) Access the URL below with same browser:
+        https://api.twitter.com/oauth/authorize?oauth_token=****
+    (3) Check the application name is "twbot2.rb" and
+        click "Allow" link in the browser.
+    (4) Input the shown number (PIN number).
+        To cancel, input nothing and press enter key.
+    ============================================================
+    PIN number >*******
+    User "h_hiro_" is successfully registered.
+    Default user is set to @h_hiro_.
+    [2000-00-00 00:00:00 +0000]
+    [cui_menu:mode=init]
+
+Then try again "post" mode. A tweet will be appear in Twitter.
+
+    $ ruby greeting_bot.rb post
+    
+    Running mode 'post'...
+    [Updated!] Good afternoon
+    [2000-00-00 00:00:00 +0000]
+    [cui_menu:mode=post](A tweet has been posted)
+
+For more details, see the Wiki (https://github.com/maraigue/twbot2.rb/wiki).

greeting_bot.rb

@@ -0,0 +1,6 @@
+require "./twbot2"
+TwBot.create("config-file.yml", "log-file.log").cui_menu do
+  # Define what the bot talks here
+  tweet_list = ["Good morning", "Good afternoon", "Good evening"]
+  [tweet_list[rand(tweet_list.size)]] # return as an array
+end

twbot2-apiaccess.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require "./twbot3"
+
+# Example: show the name of the authenticated user
+# 
+# To run the example,
+# - First try "ruby twbot3.rb run". The content in the block
+#   (extracting authenticated user) will be conducted and probably
+#   results in the message you are not authenticated.
+# - Then try "ruby twbot3.rb init". A dialog will appear to
+#   authenticate you. (You need a browser)
+# - Finally try "ruby twbot3.rb run" again. A message you have
+#   been authenticated will be shown.
+
+TwBot.create("config-apiaccess.yml", "error-apiaccess.log").cui_menu do
+  # Define what to do in the block for TwBot#cui_menu.
+  json_src = auth_http.get("/1.1/account/verify_credentials.json").body
+  data = JSON.load(json_src)
+  puts "You are authenticated as @#{data["screen_name"]}."
+end

twbot2-countreplies.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+# =============================================================
+# An example of Twitter bot by twbot2
+# (old style; also available in version 0.20)
+# 
+# In the old style, the messages to be tweetes should be
+# defined in 'load_data' method in the class inheriting
+# 'TwBot'.
+# Messages should be returned as an array of strings.
+# (Array entries may be 'Array's or 'Hash'es; see the document)
+# 
+# This example is to fetch mentions to the bot and tweet the
+# number of new mentions.
+# =============================================================
+
+$: << File.dirname(__FILE__)
+
+require "twbot2"
+require "rubygems"
+require "json"
+
+class ReplyCounter < TwBot
+  def load_data
+    # ---------- fetch replies ----------
+    
+    # downloading the JSON
+    response = auth_http.get("/1.1/statuses/mentions_timeline.json")
+    json = JSON.load(response.body)
+    
+    # extracting only message IDs
+    mentions_ids = json.elements.map{ |x| x["id"] }
+    
+    # ---------- exclude old replies ----------
+    
+    # If you create a new key in the Hash @config,
+    # this will be kept automatically in the config file.
+    @config['last_id'] ||= 0
+    
+    # keeping the newest ID among the downloaded mentions
+    new_last_id = mentions_ids.first
+    
+    # excluding the IDs representing old messages
+    mentions_ids.reject!{ |m_id| m_id < @config['last_id'] }
+    
+    # renewing the newest ID
+    @config['last_id'] = new_last_id
+    
+    # ---------- return the message to be posted ----------
+    # (as an array)
+    ["#{mentions_ids.size} new replies found!"]
+  end
+end
+
+self_path = File.dirname(__FILE__)
+ARGV.each do |mode|
+  ReplyCounter.new mode, "#{self_path}/config-countreplies.yml", "#{self_path}/error-countreplies.log"
+end

twbot2-rsspost.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+# =============================================================
+# An example of Twitter bot by twbot2
+# (new style; available since version 0.21)
+# 
+# In the new style, the messages to be tweetes should be
+# defined in the block attached to twbot2_instance#cui_menu
+# method.
+# Messages should be returned as an array of strings.
+# (Array entries may be 'Array's or 'Hash'es; see the document)
+# 
+# Note that TwBot.new runs a bot code (because of backward
+# compatibility; see also the example twbot2-countreplies.rb).
+# To only create an instance, call TwBot.create method.
+# 
+# This example is to fetch an RSS and tweet the new entries.
+# To run this program, use commands like these:
+# ruby twbot2-rsspost.rb init        # Authenticate user to post the tweets
+# ruby twbot2-rsspost.rb load        # Load RSS and add messages to the list
+# ruby twbot2-rsspost.rb post        # Post one message in the list
+# ruby twbot2-rsspost.rb post post   # Post two messages in the list
+# ruby twbot2-rsspost.rb load post   # Load RSS and add messages to the list,
+#                                    # and post one message in the list
+# =============================================================
+
+RSS_URL = "http://d.hatena.ne.jp/maraigue/rss"
+
+require "cgi"
+require "open-uri"
+require "./twbot3"
+
+SELFDIR = File.dirname(__FILE__)
+TwBot.create("#{SELFDIR}/config-rsspost.yml", "#{SELFDIR}/error-rsspost.log").cui_menu do
+  # Download RSS
+  buf = nil
+  open(RSS_URL){ |file| buf = file.read }
+  
+  result = []
+  @config["already_retrieved"] ||= ""
+  newest_entry = false
+  
+  # Retrieve entries in RSS
+  # (It is better to use REXML library; this program omits it
+  #  for simpleness.)]
+  buf.scan(/<item.*?>.*?<\/item>/m).each do |entry|
+    # Extract titles and URLs of entries from downloaded RSS
+    title = nil
+    entry.scan(/<title>(.*?)<\/title>/){|tmp| title = CGI.escapeHTML(tmp[0])}
+    link = nil
+    entry.scan(/<link>(.*?)<\/link>/){|tmp| link = CGI.escapeHTML(tmp[0])}
+    
+    # Ignore entries already retrieved by this program
+    # 
+    # NOTE: @config["..."] values are kept for the next running
+    #       of the program.
+    break if link == @config["already_retrieved"]
+    
+    # Adds a message to the list to be tweeted later.
+    # 
+    # Because RSS stores entries from newer one, to post messages in the
+    # original order, the message have to be added to the bottom of the
+    # array 'result'.
+    result.unshift(TwBot."[AUTO POST] #{link} #{title}") if title && link
+    
+    # Keep the URL of the newest entry in the data retrieved now
+    unless newest_entry
+      newest_entry = true
+      @config["already_retrieved"] = link
+    end
+  end
+  
+  
+  # Set logged message
+  @logmsg = "(#{result.size} post added)"
+  
+  # Return the result
+  # 
+  # NOTE: the returned value must be an array of tweets when a bot
+  #       is constructed (called by 'ruby SCRIPTNAME.rb load')
+  result
+end