jugyo-termtter 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-26
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+bin/termtter
+lib/termtter.rb
+lib/termtter/stdout.rb
+lib/termtter/notify-send.rb
+test/test_termtter.rb
+

data/PostInstall.txt

@@ -0,0 +1 @@
+

data/README.rdoc

@@ -0,0 +1,49 @@
+= termtter
+
+http://github.com/jugyo/termtter
+
+== DESCRIPTION:
+
+Termtter is a terminal based Twitter client
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+Run:
+
+  termtter
+
+== REQUIREMENTS:
+
+* nokogiri
+* configatron
+
+== INSTALL:
+
+  sudo gem install jugyo-termtter
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/termtter'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('termtter', Termtter::VERSION) do |p|
+  p.developer('jugyo', 'jugyo.org@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+    ['nokogiri'],
+    ['configatron'],
+  ]
+  #p.extra_dev_deps = [
+  #  ['newgem', ">= #{::Newgem::VERSION}"]
+  #]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/bin/termtter

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+$KCODE = 'u'
+
+$:.unshift(File.dirname(__FILE__) + "/../lib")
+
+require 'termtter'
+require 'termtter/stdout'
+require 'configatron'
+
+conf_file = File.expand_path('~/.termtter')
+if File.exist? conf_file
+  load conf_file
+else
+  puts <<EOS
+The configuration file does not exist.
+Example: 
+# ~/.termtter
+configatron.user_name = USERNAME
+configatron.password = PASSWORD
+EOS
+  exit 1
+end
+
+Termtter::Client.new.run
+

data/lib/termtter.rb

@@ -0,0 +1,212 @@
+require 'rubygems'
+require 'nokogiri'
+require 'open-uri'
+require 'cgi'
+require 'readline'
+require 'enumerator'
+require 'parsedate'
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Termtter
+  VERSION = '0.1.0'
+  
+  class Client
+    
+    @@hooks = []
+
+    def self.add_hook(&hook)
+      @@hooks << hook
+    end
+
+    def self.clear_hook
+      @@hooks.clear
+    end
+    
+    attr_reader :since_id
+
+    def initialize
+      configatron.set_default(:update_interval, 300)
+      configatron.set_default(:debug, false)
+      @user_name = configatron.user_name
+      @password = configatron.password
+      @update_interval = configatron.update_interval
+      @debug = configatron.debug
+    end
+
+    def update_status(status)
+      req = Net::HTTP::Post.new('/statuses/update.xml')
+      req.basic_auth(@user_name, @password)
+      req.add_field("User-Agent", "Termtter http://github.com/jugyo/termtter")
+      req.add_field("X-Twitter-Client", "Termtter")
+      req.add_field("X-Twitter-Client-URL", "http://github.com/jugyo/termtter")
+      req.add_field("X-Twitter-Client-Version", "0.1")
+      Net::HTTP.start("twitter.com", 80) do |http|
+        http.request(req, "status=#{CGI.escape(status)}")
+      end
+    end
+
+    def list_friends_timeline
+      statuses = get_timeline("http://twitter.com/statuses/friends_timeline.xml")
+      call_hooks(statuses, :list_friends_timeline)
+    end
+    
+    def update_friends_timeline
+      uri = "http://twitter.com/statuses/friends_timeline.xml"
+      if @since_id && !@since_id.empty?
+        uri += "?since_id=#{@since_id}"
+      end
+
+      statuses = get_timeline(uri, true)
+      call_hooks(statuses, :update_friends_timeline)
+    end
+
+    def get_user_timeline(screen_name)
+      statuses = get_timeline("http://twitter.com/statuses/user_timeline/#{screen_name}.xml")
+      call_hooks(statuses, :list_user_timeline)
+    end
+
+    def search(query)
+      doc = Nokogiri::XML(open('http://search.twitter.com/search.atom?q=' + CGI.escape(query)))
+
+      statuses = []
+      ns = {'atom' => 'http://www.w3.org/2005/Atom'}
+      doc.xpath('//atom:entry', ns).each do |node|
+        status = {}
+        published = node.xpath('atom:published', ns).text
+        status['created_at'] = Time.utc(*ParseDate::parsedate(published)).localtime
+        status['text'] = CGI.unescapeHTML(node.xpath('atom:content', ns).text.gsub(/<\/?[^>]*>/, ''))
+        name = node.xpath('atom:author/atom:name', ns).text
+        status['user/screen_name'] = name.scan(/^([^\s]+) /).flatten[0]
+        status['user/name'] = name.scan(/\((.*)\)/).flatten[0]
+        statuses << status
+      end
+
+      call_hooks(statuses, :search)
+      return statuses
+    end
+    
+    def show(id)
+      statuses = get_timeline("http://twitter.com/statuses/show/#{id}.xml")
+      call_hooks(statuses, :show)
+    end
+
+    def replies
+      statuses = get_timeline("http://twitter.com/statuses/replies.xml")
+      call_hooks(statuses, :show)
+    end
+
+    def call_hooks(statuses, event)
+      @@hooks.each do |h|
+        h.call(statuses.dup, event)
+      end
+    end
+
+    def get_timeline(uri, update_since_id = false)
+      doc = Nokogiri::XML(open(uri, :http_basic_authentication => [@user_name, @password]))
+
+      statuses = []
+      doc.xpath('//status').each do |s|
+        status = {}
+        %w(
+          id text created_at truncated in_reply_to_status_id in_reply_to_user_id 
+          user/id user/name user/screen_name
+        ).each do |key|
+          status[key] = CGI.unescapeHTML(s.xpath(key).text)
+        end
+        status['created_at'] = Time.utc(*ParseDate::parsedate(status['created_at'])).localtime
+        statuses << status
+      end
+
+      if update_since_id && !statuses.empty?
+        @since_id = statuses[0]['id']
+      end
+
+      return statuses
+    end
+
+    def run
+      pause = false
+
+      update = Thread.new do
+        while true
+          if pause
+            Thread.stop
+          end
+          update_friends_timeline()
+          sleep @update_interval
+        end
+      end
+
+      input = Thread.new do
+        while buf = Readline.readline("", true)
+          begin
+            case buf
+            when ''
+              # do nothing
+            when 'debug'
+              if @debug
+                update_friends_timeline()
+              end
+            when /^(post|p)\s+(.*)/, /^(update|u)\s+(.*)/
+              unless $2.empty?
+                update_status($2)
+                puts "=> #{$2}"
+              end
+            when /^(list|l)\s*$/
+              list_friends_timeline()
+            when /^(list|l)\s+([^\s]+)/
+              get_user_timeline($2)
+            when /^(search|s)\s+(.*)/
+              unless $2.empty?
+                search($2)
+              end
+            when /^(replies|r)\s*$/
+              replies()
+            when /^show\s+([^\s]+)/
+              show($1)
+            when /^pause\s*$/
+              pause = true
+            when /^resume\s*$/
+              pause = false
+              update.run
+            when /^exit\s*$/
+              update.kill
+              input.kill
+            when /^help\s*$/
+              puts <<-EOS
+exit              Exit
+help              Print this help message
+list              List the posts in your friends timeline
+list USERNAME     List the posts in the the given user's timeline
+pause             Pause updating
+post TEXT         Post a new message
+resume            Resume updating
+replies           List the most recent @replies for the authenticating user
+search TEXT       Search for Twitter
+show ID           Show a single status
+update TEXT       Update friends timeline
+            EOS
+            else
+              puts <<-EOS
+Unknown command "#{buf}"
+Enter "help" for instructions
+            EOS
+            end
+          rescue => e
+            puts "Error: #{e}"
+            puts e.backtrace.join("\n") if @debug
+          end
+        end
+      end
+
+      stty_save = `stty -g`.chomp
+      trap("INT") { system "stty", stty_save; exit }
+
+      input.join
+    end
+
+  end
+end
+

data/lib/termtter/notify-send.rb

@@ -0,0 +1,15 @@
+Termtter::Client.add_hook do |statuses, event|
+  if !statuses.empty? && event == :update_friends_timeline
+    max = 10
+    
+    text = statuses[0..(max - 1)].map{|s|
+      status_text = s['text'].gsub(%r{https?://[-_.!~*\'()a-zA-Z0-9;\/?:\@&=+\$,%#]+},'<a href="\0">\0</a>')
+      "<b>#{s['user/screen_name']}</b> <span font=\"9.0\">#{status_text}</span>"
+    }.join("\n")
+    
+    text += "\n<a href=\"http://twitter.com/\">more…</a>" if statuses.size > max
+    
+    system 'notify-send', 'Termtter', text, '-t', '60000'
+  end
+end
+

data/lib/termtter/stdout.rb

@@ -0,0 +1,42 @@
+def color(str, num)
+  "\e[#{num}m#{str}\e[0m"
+end
+
+Termtter::Client.add_hook do |statuses, event|
+  colors = %w(0 31 32 33 34 35 36 91 92 93 94 95 96)
+
+  case event
+  when :update_friends_timeline, :list_friends_timeline, :list_user_timeline, :show
+    unless statuses.empty?
+      if event == :update_friends_timeline then statuses = statuses.reverse end
+      statuses.each do |s|
+        text = s['text'].gsub("\n", '')
+        color_num = colors[s['user/screen_name'].hash % colors.size]
+        status = "#{s['user/screen_name']}: #{text}"
+        unless s['in_reply_to_status_id'].empty?
+          status += " (reply to #{s['in_reply_to_status_id']})"
+        end
+
+        case event
+        when :update_friends_timeline, :list_friends_timeline
+          time_format = '%H:%d:%S'
+        else
+          time_format = '%m-%d %H:%d'
+        end
+        time_str = "(#{s['created_at'].strftime(time_format)})"
+
+        puts "#{color(time_str, 90)} #{color(status, color_num)}"
+      end
+    end
+  when :search
+    statuses.each do |s|
+      text = s['text'].gsub("\n", '')
+      color_num = colors[s['user/screen_name'].hash % colors.size]
+      status = "#{s['user/screen_name']}: #{text}"
+      time_str = "(#{s['created_at'].strftime('%m-%d %H:%d')})"
+
+      puts "#{color(time_str, 90)} #{color(status, color_num)}"
+    end
+  end
+end
+

data/test/test_termtter.rb

@@ -0,0 +1,83 @@
+require 'rubygems'
+require 'configatron'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/termtter'
+
+class TestTermtter < Test::Unit::TestCase
+  def setup
+    configatron.user_name = 'test'
+    configatron.password = 'test'
+    @termtter = Termtter::Client.new
+    
+    Termtter::Client.add_hook do |statuses, event|
+      @statuses = statuses
+      @event = event
+    end
+  end
+
+  def test_get_timeline
+    def @termtter.open(*arg)
+      return File.open(File.dirname(__FILE__) + '/../test/friends_timeline.xml')
+    end
+
+    statuses = @termtter.get_timeline('')
+
+    assert_equal 3, statuses.size
+    assert_equal '102', statuses[0]['user/id']
+    assert_equal 'test2', statuses[0]['user/screen_name']
+    assert_equal 'Test User 2', statuses[0]['user/name']
+    assert_equal 'texttext 2', statuses[0]['text']
+    assert_equal 'Thu Dec 25 22:19:57 +0900 2008', statuses[0]['created_at'].to_s
+    assert_equal '100', statuses[2]['user/id']
+    assert_equal 'test0', statuses[2]['user/screen_name']
+    assert_equal 'Test User 0', statuses[2]['user/name']
+    assert_equal 'texttext 0', statuses[2]['text']
+    assert_equal 'Thu Dec 25 22:10:57 +0900 2008', statuses[2]['created_at'].to_s
+  end
+  
+  def test_get_timeline_with_update_since_id
+    def @termtter.open(*arg)
+      return File.open(File.dirname(__FILE__) + '/../test/friends_timeline.xml')
+    end
+
+    statuses = @termtter.get_timeline('', true)
+    assert_equal '10002', @termtter.since_id
+  end
+  
+  def test_search
+    def @termtter.open(*arg)
+      return File.open(File.dirname(__FILE__) + '/../test/search.atom')
+    end
+
+    statuses = @termtter.search('')
+    assert_equal 3, statuses.size
+    assert_equal 'test2', statuses[0]['user/screen_name']
+    assert_equal 'Test User 2', statuses[0]['user/name']
+    assert_equal 'texttext 2', statuses[0]['text']
+    assert_equal 'Thu Dec 25 22:52:36 +0900 2008', statuses[0]['created_at'].to_s
+    assert_equal 'test0', statuses[2]['user/screen_name']
+    assert_equal 'Test User 0', statuses[2]['user/name']
+    assert_equal 'texttext 0', statuses[2]['text']
+    assert_equal 'Thu Dec 25 22:42:36 +0900 2008', statuses[2]['created_at'].to_s
+  end
+  
+  def test_add_hook
+    def @termtter.open(*arg)
+      return File.open(File.dirname(__FILE__) + '/../test/search.atom')
+    end
+    call_hook = false
+    Termtter::Client.add_hook do |statuses, event|
+      call_hook = true
+    end
+    @termtter.search('')
+    
+    assert_equal true, call_hook
+    
+    Termtter::Client.clear_hook()
+    call_hook = false
+    @termtter.search('')
+    
+    assert_equal false, call_hook
+  end
+end
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: jugyo-termtter
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- jugyo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-26 00:00:00 -08:00
+default_executable: termtter
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Termtter is a terminal based Twitter client
+email: 
+- jugyo.org@gmail.com
+executables: 
+- termtter
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- bin/termtter
+- lib/termtter.rb
+- lib/termtter/stdout.rb
+- lib/termtter/notify-send.rb
+- test/test_termtter.rb
+has_rdoc: true
+homepage: http://github.com/jugyo/termtter
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: termtter
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Termtter is a terminal based Twitter client
+test_files: 
+- test/test_termtter.rb