tuomas-tweetwine 0.1.11 → 0.2.1

data/CHANGELOG.rdoc

@@ -1,3 +1,14 @@
+=== 0.2.1 released 2009-08-17
+
+* Command line option "-v" show version information.
+* Slight implementation code cleaning.
+
+=== 0.2.0 released 2009-08-17
+
+* URL shortening by using an external web service.
+* Show a preview before sending status update.
+* Avoid stack trace upon erroneous connection.
+
 === 0.1.11 released 2009-08-10
 
 * Fixed highlighting multiple nicks in statuses.

data/README.rdoc

@@ -8,7 +8,8 @@ Install Tweetwine as a RubyGem from GitHub:
 
   $ sudo gem install tuomas-tweetwine --source http://gems.github.com
 
-The program is compatible with Ruby 1.9.1.
+The program is compatible with Ruby 1.9.1, and it requires <b>rest_client</b>
+gem to be installed. In addition, <b>json</b> gem is needed for Ruby 1.8.6.
 
 == Usage
 
@@ -22,7 +23,7 @@ information can be supplied either via a configuration file or as an option
 former method over the latter.
 
 The configuration file, in <tt>~/.tweetwine</tt>, is in YAML syntax. The
-program recognizes the following settings:
+program recognizes the following basic settings:
 
   username: <your_username>
   password: <your_password>
@@ -43,6 +44,39 @@ For all the options, see:
 
   $ tweetwine -h
 
+=== URL shortening for status update
+
+Before actually sending a status update, it is possible for the software to
+shorten the URLs in the update by using an external web service. This can be
+enabled via the <tt>shorten_urls</tt> key in configuration file; for
+example:
+
+  username: spoonman
+  password: withyourhands
+  colorize: true
+  shorten_urls:
+    enable: true
+    service_url: http://is.gd/create.php
+    method: post
+    url_param_name: URL
+    xpath_selector: //input[@id='short_url']/@value
+
+The supported methods are <tt>get</tt> and <tt>post</tt>. The method chosen
+affects whether parameters are passed as URL query parameters or as payload
+in the HTTP request, respectively. Extra parameters can be given via
+<tt>extra_params</tt> key, as a hash.
+
+The <tt>xpath_selector</tt> is needed to extract the shortened URL from the
+result.
+
+The feature can be disabled by
+
+* not defining <tt>shorten_urls</tt> key in the configuration file,
+* setting key <tt>enable</tt> to <tt>false</tt>, or
+* using the command line option <tt>--no-url-shorten</tt>.
+
+The use of the feature requires <b>nokogiri</b> gem to be installed.
+
 == Contacting
 
 Please send feedback by email to Tuomas Kareinen < tkareine (at) gmail (dot)

data/Rakefile

@@ -1,10 +1,9 @@
 require "rubygems"
 
-full_name = "Tweetwine"
 package_name = "tweetwine"
-version = "0.1.11"
-
 require "lib/#{package_name}"
+full_name = Tweetwine::Meta::NAME
+version = Tweetwine::Meta::VERSION
 
 require "rake/clean"
 

data/bin/tweetwine

@@ -1,11 +1,12 @@
 #!/usr/bin/env ruby
 
 EXIT_HELP = 1
-EXIT_SIGINT = 2
+EXIT_VERSION = 2
+EXIT_SIGINT = 6
 EXIT_ERROR = 64
 
 trap("INT") do
-  puts "\nAbort."
+  puts "\nAbort"
   exit(EXIT_SIGINT)
 end
 
@@ -39,10 +40,17 @@ Usage: tweetwine [options...] [command]
         opt.on("-n", "--num N", Integer, "The number of statuses to fetch, defaults to #{Client::DEFAULT_NUM_STATUSES}") do |arg|
           options[:num_statuses] = arg
         end
+        opt.on("--no-url-shorten", "Do not shorten URLs for status update") do
+          options[:shorten_urls] = { :enable => false }
+        end
         opt.on("-p", "--page N", Integer, "The page number of the statuses to fetch, defaults to #{Client::DEFAULT_PAGE_NUM}") do |arg|
           options[:page_num] = arg
         end
-        opt.on_tail("-h", "--help", "Show this help message") do
+        opt.on("-v", "--version", "Show version information and exit") do
+          puts Meta
+          exit(EXIT_VERSION)
+        end
+        opt.on_tail("-h", "--help", "Show this help message and exit") do
           puts opt
           exit(EXIT_HELP)
         end
@@ -52,7 +60,8 @@ Usage: tweetwine [options...] [command]
     end
     options
   end
-  client = Client.new(config.options)
+  io = Tweetwine::IO.new(config.options)
+  client = Client.new(io, config.options)
   client.send(config.command, *config.args)
 rescue ArgumentError, ClientError => e
   puts "Error: #{e.message}"

data/lib/tweetwine/client.rb

@@ -1,9 +1,7 @@
 require "json"
-require "rest_client"
+require "uri"
 
 module Tweetwine
-  class ClientError < RuntimeError; end
-
   class Client
     attr_reader :num_statuses, :page_num
 
@@ -13,14 +11,19 @@ module Tweetwine
     DEFAULT_PAGE_NUM = 1
     MAX_STATUS_LENGTH = 140
 
-    def initialize(options)
+    def initialize(io, options)
+      @io = io
       @username = options[:username].to_s
       raise ArgumentError, "No authentication data given" if @username.empty?
       @base_url = "https://#{@username}:#{options[:password]}@twitter.com/"
-      @colorize = options[:colorize] || false
-      @num_statuses = parse_int_gt_option(options[:num_statuses], DEFAULT_NUM_STATUSES, 1, "number of statuses_to_show")
-      @page_num = parse_int_gt_option(options[:page_num], DEFAULT_PAGE_NUM, 1, "page number")
-      @io = IO.new(options)
+      @num_statuses = Util.parse_int_gt(options[:num_statuses], DEFAULT_NUM_STATUSES, 1, "number of statuses_to_show")
+      @page_num = Util.parse_int_gt(options[:page_num], DEFAULT_PAGE_NUM, 1, "page number")
+      @url_shortener = if options[:shorten_urls] && options[:shorten_urls][:enable]
+        UrlShortener.new(options[:shorten_urls])
+      else
+        nil
+      end
+      @status_update_factory = StatusUpdateFactory.new(@io, @url_shortener)
     end
 
     def home
@@ -36,18 +39,18 @@ module Tweetwine
     end
 
     def update(new_status = nil)
-      new_status = @io.prompt("Status update") unless new_status
-      if new_status.length > MAX_STATUS_LENGTH
-        new_status = new_status[0...MAX_STATUS_LENGTH]
-        @io.warn("Status will be truncated: #{new_status}")
-      end
-      if !new_status.empty? && @io.confirm("Really send?")
-        status = JSON.parse(post("statuses/update.json", {:status => new_status}))
-        @io.info "Sent status update.\n\n"
-        show_statuses([status])
-      else
-        @io.info "Cancelled."
+      new_status = @status_update_factory.prepare(new_status)
+      completed = false
+      unless new_status.empty?
+        @io.show_status_preview(new_status)
+        if @io.confirm("Really send?")
+          status = JSON.parse(post("statuses/update.json", {:status => new_status.to_s}))
+          @io.info "Sent status update.\n\n"
+          show_statuses([status])
+          completed = true
+        end
       end
+      @io.info "Cancelled." unless completed
     end
 
     def friends
@@ -60,19 +63,6 @@ module Tweetwine
 
     private
 
-    def parse_int_gt_option(value, default, min, name_for_error)
-      if value
-        value = value.to_i
-        if value >= min
-          value
-        else
-          raise ArgumentError, "Invalid #{name_for_error} -- must be greater than or equal to #{min}"
-        end
-      else
-        default
-      end
-    end
-
     def get_response_as_json(url_body, *query_opts)
       url = url_body + ".json?#{parse_query_options(query_opts)}"
       JSON.parse(get(url))
@@ -103,7 +93,7 @@ module Tweetwine
     def show_responses(data)
       data.each do |entry|
         user_data, status_data = yield entry
-        @io.show(parse_response(user_data, status_data))
+        @io.show_record(parse_response(user_data, status_data))
       end
     end
 
@@ -120,17 +110,62 @@ module Tweetwine
     end
 
     def get(body_url)
-      rest_client_action(:get, @base_url + body_url)
+      RestClientWrapper.get @base_url + body_url
     end
 
     def post(body_url, body)
-      rest_client_action(:post, @base_url + body_url, body)
+      RestClientWrapper.post @base_url + body_url, body
     end
 
-    def rest_client_action(action, *args)
-      RestClient.send(action, *args)
-    rescue RestClient::Exception => e
-      raise ClientError, e.message
+    class StatusUpdateFactory
+      def initialize(io, url_shortener)
+        @io = io
+        @url_shortener = url_shortener
+      end
+
+      def prepare(status)
+        StatusUpdate.new(status, @io, @url_shortener).to_s
+      end
+    end
+
+    class StatusUpdate
+      def initialize(status, io, url_shortener)
+        @io = io
+        @url_shortener = url_shortener
+        @text = prepare(status)
+      end
+
+      def to_s
+        @text.to_s
+      end
+
+      private
+
+      def prepare(status)
+        status = unless status
+          @io.prompt("Status update")
+        else
+          status.dup
+        end
+        status.strip!
+        shorten_urls!(status) if @url_shortener
+        truncate!(status) if status.length > MAX_STATUS_LENGTH
+        status
+      end
+
+      def truncate!(status)
+        status.replace status[0...MAX_STATUS_LENGTH]
+        @io.warn("Status will be truncated.")
+      end
+
+      def shorten_urls!(status)
+        url_pairs = URI.extract(status, ["http", "https"]).map do |url_to_be_shortened|
+          [url_to_be_shortened, @url_shortener.shorten(url_to_be_shortened)]
+        end
+        url_pairs.reject { |pair| pair.last.nil? || pair.last.empty? }.each do |url_pair|
+          status.sub!(url_pair.first, url_pair.last)
+        end
+      end
     end
   end
 end

data/lib/tweetwine/io.rb

@@ -36,49 +36,69 @@ module Tweetwine
       confirmation.downcase[0,1] == "y"
     end
 
-    def show(record)
+    def show_status_preview(status)
+      @output.puts <<-END
+
+#{format_status(status)}
+
+      END
+    end
+
+    def show_record(record)
       if record[:status]
-        show_as_status(record)
+        show_record_as_user_with_status(record)
       else
-        show_as_user(record)
+        show_record_as_user(record)
       end
     end
 
-    def show_as_status(record)
-      time_diff_value, time_diff_unit = Util.humanize_time_diff(record[:status][:created_at], Time.now)
-      from_user = record[:user]
-      colorize!(:green, from_user) if @colorize
-      in_reply_to = record[:status][:in_reply_to]
-      in_reply_to = if in_reply_to && !in_reply_to.empty?
-        colorize!(:green, in_reply_to) if @colorize
-        "in reply to #{in_reply_to}, "
-      else
-        ""
-      end
-      status = record[:status][:text]
-      if @colorize
-        colorize_all!(:yellow, status, NICK_REGEX)
-        URI.extract(status, ["http", "https"]).each do |url|
-          colorize_first!(:cyan, status, url)
-        end
-      end
+    private
+
+    def show_record_as_user(record)
       @output.puts <<-END
-#{from_user}, #{in_reply_to}#{time_diff_value} #{time_diff_unit} ago:
-#{status}
+#{format_user(record[:user])}
 
       END
     end
 
-    def show_as_user(record)
-      user = record[:user]
-      colorize!(:green, user) if @colorize
+    def show_record_as_user_with_status(record)
       @output.puts <<-END
-#{user}
+#{format_record_header(record)}
+#{format_status(record[:status][:text])}
 
       END
     end
 
-    private
+    def format_user(user)
+      user = user.dup
+      colorize!(:green, user) if @colorize
+      user
+    end
+
+    def format_status(status)
+      status = status.dup
+      if @colorize
+        colorize_all!(:yellow, status, NICK_REGEX)
+        URI.extract(status, ["http", "https"]).each do |url|
+          colorize_first!(:cyan, status, url)
+        end
+      end
+      status
+    end
+
+    def format_record_header(record)
+      time_diff_value, time_diff_unit = Util.humanize_time_diff(record[:status][:created_at], Time.now)
+      from_user = record[:user].dup
+      colorize!(:green, from_user) if @colorize
+      in_reply_to = record[:status][:in_reply_to]
+      in_reply_to = if in_reply_to && !in_reply_to.empty?
+        in_reply_to = colorize!(:green, in_reply_to.dup) if @colorize
+        "in reply to #{in_reply_to}, "
+      else
+        ""
+      end
+      "#{from_user}, #{in_reply_to}#{time_diff_value} #{time_diff_unit} ago:"
+    end
 
     def colorize_all!(color, str, pattern)
       str.gsub!(pattern) { |s| colorize_str(COLOR_CODES[color.to_sym], s) }

data/lib/tweetwine/meta.rb

@@ -0,0 +1,10 @@
+module Tweetwine
+  module Meta #:nodoc:
+    NAME = "Tweetwine"
+    VERSION = "0.2.1"
+
+    def self.to_s
+      "#{NAME} #{VERSION}"
+    end
+  end
+end

data/lib/tweetwine/options.rb

@@ -0,0 +1,17 @@
+module Tweetwine
+  class Options
+    def initialize(options)
+      @hash = options.to_hash
+    end
+
+    def [](key)
+      @hash[key]
+    end
+
+    def require(key)
+      value = @hash[key]
+      raise RuntimeError, "Option #{key} is required" if value.nil?
+      value
+    end
+  end
+end

data/lib/tweetwine/rest_client_wrapper.rb

@@ -0,0 +1,17 @@
+require "rest_client"
+
+module Tweetwine
+  class ClientError < RuntimeError; end
+
+  class RestClientWrapper
+    instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$)/ }
+
+    protected
+
+    def self.method_missing(name, *args, &block)
+      RestClient.send(name, *args, &block)
+    rescue RestClient::Exception, SystemCallError => e
+      raise ClientError, e.message
+    end
+  end
+end

data/lib/tweetwine/startup_config.rb

@@ -34,10 +34,7 @@ module Tweetwine
 
     def parse_config_file(config_file)
       options = YAML.load(File.read(config_file))
-      options.inject({}) do |result, pair|
-        result[pair.first.to_sym] = pair.last
-        result
-      end
+      Util.symbolize_hash_keys(options)
     end
   end
 end

data/lib/tweetwine/url_shortener.rb

@@ -0,0 +1,37 @@
+module Tweetwine
+  class UrlShortener
+    def initialize(options)
+      require "nokogiri"
+      options = Options.new(options)
+      @method = options[:method].to_sym || :get
+      @service_url = options.require :service_url
+      @url_param_name = options.require :url_param_name
+      @extra_params = options[:extra_params] || {}
+      if @method == :get
+        tmp = []
+        @extra_params.each_pair { |k, v| tmp << "#{k}=#{v}" }
+        @extra_params = tmp
+      end
+      @xpath_selector = options.require :xpath_selector
+    end
+
+    def shorten(url)
+      rest = case @method
+      when :get
+        tmp = @extra_params.dup
+        tmp << "#{@url_param_name}=#{url}"
+        service_url = "#{@service_url}?#{tmp.join('&')}"
+        [service_url]
+      when :post
+        service_url = @service_url
+        params = @extra_params.merge({ @url_param_name.to_sym => url })
+        [service_url, params]
+      else
+        raise "Unrecognized HTTP request method"
+      end
+      response = RestClientWrapper.send(@method, *rest)
+      doc = Nokogiri::HTML(response)
+      doc.xpath(@xpath_selector).first.to_s
+    end
+  end
+end

data/lib/tweetwine/util.rb

@@ -18,6 +18,28 @@ module Tweetwine
       [value, pluralize_unit(value, unit)]
     end
 
+    def self.symbolize_hash_keys(hash)
+      hash.inject({}) do |result, pair|
+        value = pair.last
+        value = symbolize_hash_keys(value) if value.is_a? Hash
+        result[pair.first.to_sym] = value
+        result
+      end
+    end
+
+    def self.parse_int_gt(value, default, min, name_for_error)
+      if value
+        value = value.to_i
+        if value >= min
+          value
+        else
+          raise ArgumentError, "Invalid #{name_for_error} -- must be greater than or equal to #{min}"
+        end
+      else
+        default
+      end
+    end
+
     private
 
     def self.pluralize_unit(value, unit)

data/lib/tweetwine.rb

@@ -1,3 +1,12 @@
-%w{util startup_config io client}.each do |f|
+%w{
+  meta
+  util
+  options
+  startup_config
+  io
+  rest_client_wrapper
+  url_shortener
+  client
+}.each do |f|
   require File.dirname(__FILE__) << "/tweetwine/#{f}"
 end