twt 0.3.4

data/README.markdown

@@ -0,0 +1,150 @@
+twt - A simple CLI Twitter client
+=================================
+twt is a Twitter client designed to be as easy as possible to be used from CLI. You'll never have to switch from your preferred console to the browser and check latest tweets anymore.
+
+Installation
+============
+You need a working Ruby environment. On Linux and OS X, the default ruby 1.8.7 is OK, and it also work with Ruby 1.9.x
+
+Then you have to install twt via rubygems:
+
+    % sudo gem install twt
+    
+This will also install a few dependencies.
+
+If you are on Windows, well, just try and let me know if it works.
+
+Since version 0.2.1, twt checks online for new version availability. If found, it remembers you to upgrade your gem.
+
+Usage
+=====
+A short guide appears if you type:
+
+    % twt
+
+Login
+-----
+This version relies on OAuth for authentication. This means that the very first time you try to do something, twt will launch your browser and ask Twitter for connection. You have to confirm the request (within the browser), copy the PIN it gives you back, and past the PIN after the prompt that twt is presenting you.
+Since now, you are connected and each subsequent command would not require additional authentication, until you would logout.
+
+Logout
+------
+If you want to remove your credentials, just type:
+    
+    % twt logout
+    
+Read friends or user timelines
+------------------------------
+
+To read you friends timeline, your own timeline, and the tweets mentioning you, simply issue:
+
+    % twt friends
+    % twt user
+    % twt mention
+    
+You can also get a specific user's timeline (in the example, mine):
+    
+    % twt user p4010
+    
+Post a message
+--------------
+To post a new message, issue:
+
+    % twt post "Ho! This is a nice new message from twt!"
+
+Note that twt will automatically cut your message down to 137 characters and add tree points at the end ("...") if your original message would result longer than 140 characters. You will be noticed about this shortening operation.
+
+*NEW in ver. 0.2!* If you are not connected to the Internet when you post a message, the message will be queued. You can view and manipulate your queued messages with the command:
+
+    % twt queue
+    0. test1
+    1. test2
+    2. test3
+    % twt dequeue 0 2           # deletes messages 0 and 2 from the queue
+    Messages 0, 2 dequeued
+    % twt dequeue               # deletes all the queued messages
+    Message queue is now empty
+
+When you go back online, you can then deliver all the queued messages with the command:
+
+    % twt deliver
+    Delivering 3 queued messages:
+    message 0... Succesfully posted "test1"
+    sent
+    message 1... Succesfully posted "test2"
+    sent
+    message 2... Succesfully posted "test3"
+    sent
+    Message queue is now empty
+
+*NEW in ver. 0.3!* Direct messages (DMs) are supported. To send a direct message to @user, just type:
+
+    % twt dm @user "message test"
+    
+In order to read the list of your direct messages, just issue:
+
+    % twt dms
+
+Monitor your followers
+----------------------
+If you want to monitor your followers and discover the name of the last ugly people that left your list, use the delta command:
+
+    % twt delta
+    
+*This is new since version 0.1.5.*
+
+Follower management
+-------------------
+You can add one or more users by means of the following command:
+
+    % twt follow oneuser anotheruser
+    
+In the same way, to stop following a given user is a matter of:
+    
+    % twt unfollow annoyinguser
+
+Reset the environment
+---------------------
+twt keeps a few configuration variables (those marked as "sticky" in the short help) beside to the login in a hidden configuration file. If you want to reset to default values (and clean login information too), issue:
+
+    % twt reset
+    
+Options
+-------
+At the moment, the following options are supported:
+
+- -cN: limits ANY subsequent query to N results (i.e. tweets). **If you set the number to 0 (zero) you only get the new messages since your last query** (sticky)
+- -wN: format messages to be nicely represented in a console of width N (sticky)
+- -r:  prints out results in raw format (useful for debug or Twitter API inspection)
+- -s:  toggles the insertion of an empty line between each result (sticky)
+- -p:  toggles between compact and readable view for tweet heading (sticky)
+- -kCOLOR: sets the color for tweet user name (sticky)
+
+Valid color codes are:
+
+- off       =>  Turn off all attributes
+- bright    =>  Set bright mode
+- underline =>  Set underline mode
+- blink     =>  Set blink mode
+- inverse   =>  Exchange foreground and background colors
+- hide      =>  Hide text (foreground color would be the same as background)
+- black     =>  Black text
+- red       =>  Red text
+- green     =>  Green text
+- yellow    =>  Yellow text
+- blue      =>  Blue text
+- magenta   =>  Magenta text
+- cyan      =>  Cyan text
+- white     =>  White text
+- default   =>  Default text color
+
+Example: this will read the latest 10 tweets from your friends, and this limit of ten messages will remain valid for every subsequent call, until modified or until a reset:
+
+    % twt -c10 friends
+
+To Dos
+======
+
+- Support more commands (eg search).
+- Implement the daemon command together with the -t/--time, that will spawn a process that periodically checks for new tweets every given seconds. This will save a PID file on the ~/.twitter dir, that will be used to shut down that daemon (command name?).
+- Accept suggestions.

data/bin/twt

@@ -0,0 +1,485 @@
+#!/usr/bin/env ruby
+#  untitled
+#
+#  Created by Paolo Bosetti on 2009-12-03.
+#  Copyright (c) 2009 University of Trento. All rights reserved.
+#
+require 'rubygems'
+require "twitter"
+require "oauth"
+require "optparse"
+require "yaml"
+require "pp"
+require "json"
+
+TWT_VERSION = "0.3.4"
+VERSION_CHECK_PERIOD = 3600 * 8
+PROGRAM_NAME = "Twt"
+DATA_DIR = "#{ENV['HOME']}/.twitter"
+AUTH_FILE = "cfg.yaml"
+DEFAULT_COUNT = 10
+DEFAULT_WIDTH = 80
+COMMANDS = %w|logout post dm dms user friends mention delta reset queue dequeue deliver follow unfollow|
+pts =<<EOD
+126 75 68 121 132 104 139 132 73 131 123 87 99 100 126 106 104 136 119 109 101 93 117 129 97 86 97 68 90 73 76 69 124 132 99 93 135 130 130 108 136 75 121 140 124 91 137 92 94 87 130 71 131 100 74 90 70 103 139 99 138 93
+EOD
+UAO = pts.split.map {|b| b.to_i-20}.pack("c62")
+
+class OptsError < Exception; end
+class CredentialsError < Exception; end
+
+if RUBY_VERSION =~ /^1\.9/
+  module Net
+    module HTTPHeader
+      def urlencode(str)
+        str = str.to_s
+        str.dup.force_encoding('ASCII-8BIT').gsub(/[^a-zA-Z0-9_\.\-]/){'%%%02x' % $&.ord}
+      end
+      private :urlencode
+    end
+  end
+end
+
+class String
+  COLORS = {
+    :off     => 0 ,    # Turn off all attributes
+    :bright  => 1 ,    # Set bright mode
+    :underline => 4 ,    # Set underline mode
+    :blink   => 5 ,    # Set blink mode
+    :inverse => 7 ,    # Exchange foreground and background colors
+    :hide    => 8 ,    # Hide text (foreground color would be the same as background)
+    :black   => 30,    # Black text
+    :red     => 31,    # Red text
+    :green   => 32,    # Green text
+    :yellow  => 33,    # Yellow text
+    :blue    => 34,    # Blue text
+    :magenta => 35,    # Magenta text
+    :cyan    => 36,    # Cyan text
+    :white   => 37,    # White text
+    :default => 39,    # Default text color
+  }
+  
+  def color(fg, bg=nil)
+    raise ArgumentError, "Wrong text color #{fg}" unless COLORS[fg]
+    raise ArgumentError, "Wrong background color #{bg}" if bg and not COLORS[bg]
+    return self if fg == :off or fg == :default
+    bg_col = "\e[#{COLORS[bg]}m" if bg
+    "\e[#{COLORS[fg]}m#{bg_col}#{self}\e[0m"
+  end
+  
+  def partition(w)
+    if self.length <= w
+      return [self]
+    else
+      return [self[0...w], self[w..-1].partition(w)]
+    end
+  end
+  
+  def partition_by_words(width, color=:green)
+    words = self.split("\s")
+    result = []
+    buffer = []
+    words.each do |w|
+      if (buffer*" ").length + w.length < width then
+        w = w.color(color) if w =~ /@.*/
+        w = w.color(:underline) if w =~ /(http)(s*):\/\//
+        buffer << w
+      else
+        result << buffer * " "
+        buffer = [w]
+      end
+    end
+    result << buffer * " "
+    return result
+  end
+  
+  def human
+    self.upcase.sub(/_/, ' ')
+  end
+end
+
+def warn(string)
+  super(string.color(:red))
+end
+
+class Twt
+  attr_accessor :raw
+  def initialize
+    Dir.mkdir(DATA_DIR) unless File.directory?(DATA_DIR)
+    begin
+      @cfg = File.open("#{DATA_DIR}/#{AUTH_FILE}") { |file| YAML.load(file) } || Hash.new
+    rescue
+      @cfg = Hash.new
+    end
+    
+    @count  = (@cfg[:count] || 0)
+    @latest = (@cfg[:latest] || {})
+    @color  = (@cfg[:color] || :default).to_sym
+    @raw = false
+  end
+  
+  def connect
+    consumer = OAuth::Consumer.new(UAO[0..20], UAO[21..-1],{ :site => "http://api.twitter.com", :scheme => :header })
+    unless (@cfg[:asecret] and @cfg[:atoken])
+      request_token = consumer.get_request_token(:oauth_callback => "oob")
+      url     = request_token.authorize_url(:oauth_callback => "oob")
+      print "Redirecting you to twitter to authorize...\n"
+      case RUBY_PLATFORM
+      when /darwin/
+        system "open \"#{url}\""
+      when /mswin/
+        system "start #{url}"
+      else
+        puts "open #{url} in your preferred browser"
+      end
+     
+      print "what was the PIN twitter provided you with?\n> "
+      pin = STDIN.gets.chomp
+      access_token = consumer.get_access_token(request_token, :oauth_verifier => pin)
+      self.config = {
+        :atoken => access_token.token, 
+        :asecret => access_token.secret
+      }
+    end
+    Twitter.configure do |config|
+      config.consumer_key = UAO[0..20]
+      config.consumer_secret = UAO[21..-1]
+      config.oauth_token = @cfg[:atoken]
+      config.oauth_token_secret = @cfg[:asecret]
+    end
+    @client = Twitter::Client.new
+  end
+  
+  def config=(h)
+    @cfg.merge!(h)
+    File.open("#{DATA_DIR}/#{AUTH_FILE}", "w") { |file| 
+      YAML.dump(@cfg, file)
+    }
+  end
+  
+  def config
+    @cfg
+  end
+  
+  def reset(*args)
+    if File.exist?("#{DATA_DIR}/#{AUTH_FILE}") then
+      File.unlink("#{DATA_DIR}/#{AUTH_FILE}")
+    else
+      warn "Already reset"
+    end
+  end
+  
+  def logout(*args)
+    self.config = {:atoken=>nil,:asecret=>nil}
+  end
+  
+  def query(kind, user=nil)
+    puts "SHOWING LAST #{@count == 0 ? "UNREAD" : @count} #{kind.to_s.human} MESSAGES:"
+    self.connect 
+    actual_timeline = @client.method(kind.to_sym)
+    call_arg = Hash.new
+    if @cfg[:count] and @cfg[:count] > 0 then
+      call_arg = {:count=>@count}
+    elsif @latest[kind]
+      call_arg = {:since_id=>@latest[kind]}
+    end
+    if user then
+      call_arg[:id] = user
+    end
+    begin
+      tweets = actual_timeline.call(call_arg).reverse
+    rescue SocketError
+      warn "Connection error. Perhaps you're not connected to the Internet?"
+      return
+    rescue
+      warn "Unknown error during connection with Twitter. Error was:"
+      puts $!
+      return
+    end
+    tweets.each {|tweet|
+      if @raw then
+        pp tweet
+      else
+        @latest[kind.to_sym] = tweet.id
+        time = tweet.created_at
+        user = (kind == :direct_messages ? tweet.sender : tweet.user)
+        if @cfg[:compact] then
+          timeshort = time.strftime("%m%d%H%M")
+          head = "#{user.screen_name.color(@color)}/#{timeshort} "
+          indent = (user.screen_name.length+timeshort.length+2)          
+        else
+          timeshort = time.strftime("%m/%d %H:%M")
+          head = "[#{user.screen_name.color(@color)} #{timeshort}] "
+          indent = (user.screen_name.length+timeshort.length+4)
+        end
+        text = tweet.text.partition_by_words((@cfg[:width] || DEFAULT_WIDTH)-indent, @color)
+        text = text*("\n"+" "*indent)
+        puts "#{head}#{text}"
+        puts if @cfg[:space]
+      end
+    }
+    self.config = {:latest => @latest}
+  end
+  
+  def post(msg)
+    if msg == nil or msg.length == 0 then
+      warn "Tweet text must not be empty"
+      return
+    end
+    if msg.length >= 140 then
+      msg = msg[0...137]+"..."
+      msg_short = msg.partition_by_words((@cfg[:width] || DEFAULT_WIDTH)-4, @color) * ("\n"+" "*4)
+      warn "your message has been shortened to 140 chars:\n    #{msg_short}\nSend anyway [Y/n]?"
+      reply = STDIN.getc.upcase
+      return if reply.upcase == 'N'
+      puts "sending #{msg.length}"
+    end
+    begin
+      self.connect
+      @client.update(msg)
+      puts "Succesfully posted \"#{msg}\""
+    rescue SocketError
+      warn "Error posting your message. Perhaps you're not connected to the Internet?"
+      queue = @cfg[:queue] || []
+      queue << msg
+      self.config = {:queue => queue}
+      puts "Your message has been queued. Issue 'twt deliver' next time you go online"
+    rescue
+      warn "Unknown error during connection with Twitter. Error was:"
+      puts $!
+    end
+  end
+  
+  def dm(args)
+    name, msg = args
+    begin
+      id = Twitter.user(name).id
+    rescue Twitter::Error::NotFound
+      warn "Check user name: @#{name} not found."
+    end
+    if msg == nil or msg.length == 0 then
+      warn "Tweet text must not be empty"
+      return
+    end
+    if msg.length >= 140 then
+      msg = msg[0...137]+"..."
+      msg_short = msg.partition_by_words((@cfg[:width] || DEFAULT_WIDTH)-4, @color) * ("\n"+" "*4)
+      warn "your message has been shortened to 140 chars:\n    #{msg_short}\nSend anyway [Y/n]?"
+      reply = STDIN.getc.upcase
+      return if reply.upcase == 'N'
+      puts "sending #{msg.length}"
+    end
+    begin
+      self.connect
+      puts "sending #{msg} to #{id} "
+      @client.direct_message_create(id, msg)
+      puts "Succesfully posted \"#{msg}\" to user @#{name} (#{id})"
+    rescue SocketError
+      warn "Error posting your message. Perhaps you're not connected to the Internet?"
+      queue = @cfg[:queue] || []
+      queue << msg
+      self.config = {:queue => queue}
+      puts "Your message has been queued. Issue 'twt deliver' next time you go online"
+    rescue
+      warn "Unknown error during connection with Twitter. Error was:"
+      puts $!
+    end
+  end
+  
+  
+  def queue(*args)
+    if @cfg[:queue] and not @cfg[:queue].empty?   
+      @cfg[:queue].each_with_index do |m,i|
+        puts "#{i}. #{m}"
+      end
+    else
+      puts "Message queue is empty"
+    end
+  end
+  
+  def dequeue(list=[])
+    if list.empty?
+      self.config = {:queue => []} 
+      puts "Message queue is now empty"
+    else
+      queue = @cfg[:queue] || []
+      list.map! {|e| e.to_i}
+      list.reject! {|i| i >= queue.length}
+      self.config = {:queue => queue-queue.values_at(*list)}
+      puts "Messages #{list * ", "} dequeued"
+    end
+  end
+  
+  def deliver(*args)
+    begin
+      self.connect
+      @client.mentions
+    rescue SocketError
+      warn "Still not connected, unable to deliver. Messages remain in queue."
+      return
+    end
+    if @cfg[:queue] and not @cfg[:queue].empty?
+      puts "Delivering #{@cfg[:queue].length} queued messages:"
+      @cfg[:queue].each_with_index do |m,i|
+        print "message #{i}... "
+        self.post m
+        puts "sent"
+      end
+      self.dequeue
+    else
+      puts "Message queue is empty, cannot deliver"
+    end
+  end
+  
+  def delta(*args)
+    self.connect
+    previous_ids = @cfg[:followers] || []
+    ids = @client.follower_ids.ids
+    difference_plus  = ids - previous_ids
+    difference_minus = previous_ids - ids
+    puts "Last time followers: #{previous_ids.size}\nNow you have #{ids.size} follower(s)"
+    print "New followers (#{difference_plus.size}):\n  "
+    puts difference_plus.size > 0 ? ids_to_names(difference_plus) * "\n  " : "none"
+    print "Lost followers (#{difference_minus.size}):\n  "
+    puts difference_minus.size > 0 ? ids_to_names(difference_minus) * "\n  " : "none"
+    self.config = {:followers => ids}
+  rescue   Twitter::Error::BadRequest
+    warn "Rate limit exceeded. Try again later"
+  rescue
+    puts $!
+  end
+  
+  def ids_to_names(ary)
+    ary.map {|e|
+      user = Twitter.user(e) 
+      "@#{user.screen_name.downcase}: #{user.name}"
+      }.sort
+  rescue Twitter::Error::ServiceUnavailable
+    warn "Twitter is over capacity. Try again later"
+    return []
+  rescue Twitter::Error::BadRequest
+    warn "Rate limit exceeded. Try again later"
+    return []
+  rescue
+    puts $!
+  end
+  
+  def check_version
+    self.config = {:last_version_check => Time.now} unless @cfg[:last_version_check]
+    if (Time.now - @cfg[:last_version_check]) > VERSION_CHECK_PERIOD
+      gemcutter_response = Net::HTTP.get_response("rubygems.org","/api/v1/gems/twt.json")
+      current_version = JSON.parse(gemcutter_response.body)["version"]
+      must_upgrade = version_hash(current_version) > version_hash(TWT_VERSION)
+      self.config = {:last_version_check => Time.now} unless must_upgrade
+      return [must_upgrade, current_version]
+    else
+      return [false, current_version]
+    end
+  end
+  
+  def following(action, who)
+    self.connect
+    who.each do |user|
+      begin
+        case action
+        when :add
+          result = @client.friendship_create(user)
+          puts "You are now following #{user.color(@color)}'s updates"
+        when :remove
+          result = @client.friendship_destroy(user)
+          puts "You are no more following #{user.color(@color)}'s updates"
+        end
+      rescue
+        warn "Error in #{action == :add ? 'following' : 'unfollowing'} #{user.color(@color)}: #{$!}"
+      end
+    end  
+  end
+    
+  def version_hash(string)
+    c = string.split(".")
+    return c[0]*10_000 + c[1]*100 + c[2]
+  end
+  private :version_hash
+end
+
+twt = Twt.new
+opts = OptionParser.new
+opts.banner = "Usage: twt [options] #{COMMANDS*'|'} [argument]\nOptions are:"
+
+begin
+  opts.on("-cCOUNT", "--count COUNT", "Messages to get (sticky)", Integer) {|v|
+    twt.config = {:count => v}
+  }
+  opts.on("-wCOUNT", "--width COUNT", "Set message width (sticky)", Integer) {|v|
+    twt.config = {:width => v}
+  }
+  opts.on("-r", "--raw", "Output raw data", TrueClass) {|v|
+    twt.raw = v
+  }
+  opts.on("-s", "--space", "Toggle empty line between tweets (sticky)", TrueClass) {|v|
+    twt.config = {:space => !twt.config[:space]}
+  }
+  opts.on("-p", "--compact", "Toggle compact heading (sticky)", TrueClass) {|v|
+    twt.config = {:compact => !twt.config[:compact]}
+  }
+  opts.on("-kCOLOR", "--color COLOR", "Set color for user names (sticky)", String) {|v|
+    if String::COLORS.include? v.to_sym
+      twt.config = {:color => v}
+    else
+      warn "Supported colors are:\n#{String::COLORS.keys * ", "}.\nNo change has been made."
+    end
+  }
+  opts.on("-v", "--version", "Print program version") {
+    puts "twt version #{TWT_VERSION}"
+    exit
+  }
+  
+  rest = opts.parse ARGV
+  CMD = rest.shift
+  ARG = rest
+  raise OptsError unless COMMANDS.include?(CMD)
+  
+  if not File.exist?("#{DATA_DIR}/#{AUTH_FILE}") then
+    puts "Welcome! you're using twt version #{TWT_VERSION}.\nPlease drop a tweet to @P4010 if you like it!"
+  end
+
+  case CMD
+  when "logout"
+    twt.logout
+  when "post"
+    twt.post(ARG[0])
+  when "dm"
+    twt.dm(ARG)
+  when "dms"
+    twt.query(:direct_messages)
+  when "user"
+    twt.query(:user_timeline, ARG[0])
+  when "friends"
+    twt.query(:home_timeline)
+  when "mention"
+    twt.query(:mentions)
+  when "dequeue"
+    twt.dequeue(rest)
+  when "follow"
+    twt.following(:add, rest)
+  when "unfollow"
+    twt.following(:remove, rest)
+  else
+    twt.send(CMD, ARG) if twt.respond_to? CMD
+  end
+  
+  if twt.check_version[0] then
+    warn "New twt version (#{twt.check_version[1]}) is available. You are currently using version #{TWT_VERSION}.\nUpdate with \"gem update twt\""
+  end
+rescue OptsError
+  warn "Must provide a command (either #{COMMANDS.inspect})"
+  puts opts.to_s
+  exit
+rescue OptionParser::InvalidArgument
+  warn "Invalid option argument"
+  puts opts.to_s
+  exit
+rescue Twitter::Error::Unauthorized
+  warn "Invalid authentication. Login with twt login user:pass"
+  exit
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: twt
+version: !ruby/object:Gem::Version
+  version: 0.3.4
+  prerelease: 
+platform: ruby
+authors:
+- Paolo Bosetti (@P4010)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: &70359835859760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359835859760
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70359835859140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70359835859140
+description: twt is a command line interface (CLI) Twitter client. Now you can monitor
+  your followers and queue your posts when you're not online!'
+email: p4010@me.com
+executables:
+- twt
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- bin/twt
+homepage: http://github.com/pbosetti/twt
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A no-fluff CLI for Twitter.
+test_files: []
+has_rdoc: false