tweetwine 0.3.2 → 0.4.0

data/.gitignore

@@ -0,0 +1,6 @@
+/*.gem
+/.bundle/
+/Gemfile.lock
+/coverage/
+/man/
+!/man/*.ronn

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+=== 0.4.0 released 2011-02-22
+
+* Add option <tt>-r</tt> to reverse the order of showing tweets
+* Show retweets as whole tweets
+* Properly display error message on invalid argument to <tt>--page</tt> or
+  <tt>--num</tt> options
+* Fix deprecation warning about <tt>URI.escape</tt> on MRI 1.9.2
+* Minor cleanups
+
 === 0.3.2 released 2010-11-17
 
 * Drop <tt>json</tt> gem dependency from gemspec in order to allow the user to

data/Gemfile

@@ -1,17 +1,9 @@
+# coding: utf-8
+
 source :rubygems
 
+gemspec
+
+# Special handling at runtime.
 gem 'json',     '>= 1.0.0', :platforms => [:ruby_18, :jruby]
 gem 'nokogiri', '~> 1.4.4'
-gem 'oauth',    '~> 0.4.4'
-
-group :test do
-  gem 'contest',        '~> 0.1.2'
-  gem 'coulda',         '~> 0.6.0'
-  gem 'gem-man',        '~> 0.2.0'
-  gem 'mcmire-matchy',  '~> 0.5.2', :require => 'matchy'
-  gem 'mocha',          '=  0.9.8'
-  gem 'open4',          '~> 1.0.1'
-  gem 'ronn',           '~> 0.7.3'
-  gem 'timecop',        '~> 0.3.5'
-  gem 'webmock',        '~> 1.6.1'
-end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 Tuomas Kareinen
+Copyright (c) 2009-2011 Tuomas Kareinen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -77,6 +77,7 @@ enabled via `shorten_urls` field in the configuration file; for example:
 
     username: spoonman
     colors: true
+    show_reverse: true
     shorten_urls:
       service_url: http://is.gd/create.php
       method: post
@@ -124,8 +125,8 @@ snippet to your Bash initialization script (such as `~/.bashrc`):
 
 ## COPYRIGHT
 
-Tweetwine is Copyright (c) 2009-2010 Tuomas Kareinen.
+Tweetwine is copyright © 2009-2011 Tuomas Kareinen. See `LICENSE.txt`.
 
 ## SEE ALSO
 
-<https://github.com/tuomas/tweetwine>
+<https://github.com/tkareine/tweetwine>

data/Rakefile

@@ -4,8 +4,8 @@ require 'rake/clean'
 
 $LOAD_PATH.unshift(File.expand_path('lib', File.dirname(__FILE__)))
 name = 'tweetwine'
-require name
-version = Tweetwine.version.dup
+require "#{name}/version"
+version = Tweetwine.version
 
 namespace :gem do
   CLOBBER.include "#{name}-*.gem"
@@ -42,6 +42,12 @@ namespace :man do
   end
 end
 
+CLOBBER.include 'rdoc'
+desc "Generate RDoc"
+task :rdoc do
+  sh %{rdoc --encoding=UTF-8 --line-numbers --title='#{name} #{version}' --output=rdoc *.rdoc LICENSE.txt lib}
+end
+
 namespace :test do
   def create_test_task(type, options = {})
     base_dir  = options[:base_dir]

data/lib/tweetwine/character_encoding.rb

@@ -52,7 +52,7 @@ module Tweetwine
       def guess_external_encoding_from_env_lang
         lang = ENV['LANG']
         return 'UTF-8' if lang =~ /(utf-8|utf8)\z/i
-        Util.blank?(lang) ? nil : lang
+        Support.presence(lang)
       end
     end
   end

data/lib/tweetwine/cli.rb

@@ -8,6 +8,9 @@ module Tweetwine
       :config_file  => "#{(ENV['HOME'] || ENV['USERPROFILE'])}/.tweetwine",
       :env_lookouts => [:http_proxy],
       :excludes     => [:command],
+      :num_tweets   => 20,
+      :page         => 1,
+      :show_reverse => false,
       :shorten_urls => {:disable => true},
       :username     => ENV['USER']
     }.freeze
@@ -84,12 +87,15 @@ module Tweetwine
             options[:shorten_urls] ||= {}
             options[:shorten_urls][:disable] = true
           end
-          parser.on '-n', '--num <n>',          Integer,  "Number of statuses per page (default #{Twitter::DEFAULT_NUM_STATUSES})." do |arg|
-            options[:num_statuses] = arg
+          parser.on '-n', '--num <n>',          Integer,  "Number of tweets per page (default #{DEFAULT_CONFIG[:num_tweets]})." do |arg|
+            options[:num_tweets] = arg
           end
-          parser.on '-p', '--page <p>',         Integer,  "Page number for statuses (default #{Twitter::DEFAULT_PAGE_NUM})." do |arg|
+          parser.on '-p', '--page <p>',         Integer,  "Page number for tweets (default #{DEFAULT_CONFIG[:page]})." do |arg|
             options[:page] = arg
           end
+          parser.on '-r', '--reverse',                    "Show tweets in reverse order (default #{DEFAULT_CONFIG[:show_reverse]})." do
+            options[:show_reverse] = true
+          end
           parser.on '-u', '--username <user>',  String,   "User to authenticate (default '#{DEFAULT_CONFIG[:username]}')." do |arg|
             options[:username] = arg
           end

data/lib/tweetwine/config.rb

@@ -27,7 +27,7 @@ module Tweetwine
       should_set_file_access_to_user_only = !File.exist?(@file)
       File.open(@file, 'w') do |io|
         io.chmod(0600) if should_set_file_access_to_user_only
-        YAML.dump(Util.stringify_hash_keys(to_file), io)
+        YAML.dump(Support.stringify_hash_keys(to_file), io)
       end
     end
 
@@ -52,14 +52,14 @@ module Tweetwine
     def self.parse_env_vars(env_lookouts)
       env_lookouts.inject({}) do |result, env_var_name|
         env_option = ENV[env_var_name.to_s]
-        result[env_var_name.to_sym] = env_option unless Util.blank?(env_option)
+        result[env_var_name.to_sym] = env_option if Support.present?(env_option)
         result
       end
     end
 
     def self.parse_config_file(config_file)
       options = File.open(config_file, 'r') { |io| YAML.load(io) }
-      Util.symbolize_hash_keys(options)
+      Support.symbolize_hash_keys(options)
     end
   end
 end

data/lib/tweetwine/exceptions.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+module Tweetwine
+  class Error < StandardError
+    @status_code = 42
+
+    # Idea got from Bundler.
+    def self.status_code(code = nil)
+      return @status_code unless code
+      @status_code = code
+    end
+
+    def status_code
+      self.class.status_code
+    end
+  end
+
+  class CommandLineError    < Error; status_code(13); end
+  class UnknownCommandError < Error; status_code(14); end
+
+  class RequiredOptionError < Error
+    status_code(15)
+
+    attr_reader :key, :owner
+
+    def initialize(key, owner)
+      @key, @owner = key, owner
+    end
+
+    def to_s
+      "#{key} is required for #{owner}"
+    end
+  end
+
+  class ConnectionError     < Error; status_code(21); end
+  class TimeoutError        < Error; status_code(22); end
+
+  class HttpError < Error
+    status_code(25)
+
+    attr_reader :http_code, :http_message
+
+    def initialize(code, message)
+      @http_code, @http_message = code.to_i, message
+    end
+
+    def to_s
+      "#{http_code} #{http_message}"
+    end
+  end
+
+  class TranscodeError      < Error; status_code(31); end
+  class AuthorizationError  < Error; status_code(32); end
+end

data/lib/tweetwine/http.rb

@@ -74,7 +74,7 @@ module Tweetwine
       end
 
       def requesting(url)
-        uri = URI.parse(url)
+        uri = Uri.parse(url)
         connection = @http.new(uri.host, uri.port)
         configure_for_ssl(connection) if https_scheme?(uri)
         response = yield connection, uri

data/lib/tweetwine/{util.rb → support.rb}

@@ -1,15 +1,26 @@
 # coding: utf-8
 
-require "cgi"
-require "time"
-require "uri"
+require 'cgi'
+require 'time'
 
 module Tweetwine
-  module Util
+  module Support
     extend self
 
-    def blank?(str)
-      str.nil? || str.empty?
+    def blank?(var)
+      var.nil? || var.empty?
+    end
+
+    def present?(var)
+      !blank?(var)
+    end
+
+    def presence(var)
+      if present? var
+        block_given? ? yield(var) : var
+      else
+        nil
+      end
     end
 
     def humanize_time_diff(from, to)
@@ -69,10 +80,6 @@ module Tweetwine
       dup_str
     end
 
-    def percent_encode(str)
-      URI.escape(str.to_s, /[^#{URI::PATTERN::UNRESERVED}]/)
-    end
-
     def unescape_html(str)
       CGI.unescapeHTML(str.gsub(' ', ' '))
     end
@@ -99,8 +106,8 @@ module Tweetwine
     end
 
     def pluralize_unit(value, unit)
-      if ["hour", "day"].include?(unit) && value > 1
-        unit = unit + "s"
+      if %w{hour day}.include?(unit) && value > 1
+        unit = unit + 's'
       end
       unit
     end

data/lib/tweetwine/tweet.rb

@@ -0,0 +1,69 @@
+# coding: utf-8
+
+module Tweetwine
+  class Tweet
+    attr_reader :from_user, :to_user, :rt_user, :created_at, :status
+
+    def initialize(record, paths)
+      if field_present? record, paths[:retweet]
+        @rt_user = parse_string_field record, paths[:from_user]
+        fields   = Support.find_hash_path record, paths[:retweet]
+      else
+        @rt_user = nil
+        fields   = record
+      end
+      @to_user    = parse_string_field fields, paths[:to_user]
+      @from_user  = parse_string_field fields, paths[:from_user]
+      raise ArgumentError, 'from user record field is required' unless @from_user
+      @created_at = parse_time_field   fields, paths[:created_at]
+      @status     = parse_string_field fields, paths[:status]
+    end
+
+    def timestamped?
+      !@created_at.nil?
+    end
+
+    def retweet?
+      !@rt_user.nil?
+    end
+
+    def status?
+      !@status.nil?
+    end
+
+    def reply?
+      !@to_user.nil?
+    end
+
+    def ==(other)
+      other.is_a?(self.class) &&
+        self.rt_user    == other.rt_user    &&
+        self.to_user    == other.to_user    &&
+        self.from_user  == other.from_user  &&
+        self.created_at == other.created_at &&
+        self.status     == other.status
+    end
+
+    private
+
+    def field_present?(record, path)
+      !!find_field(record, path) { |f| Support.present?(f) }
+    end
+
+    def field_presence(record, path, &block)
+      find_field(record, path) { |f| Support.presence(f, &block) }
+    end
+
+    def parse_string_field(record, path)
+      field_presence(record, path) { |f| f.to_s }
+    end
+
+    def parse_time_field(record, path)
+      field_presence(record, path) { |f| Time.parse(f.to_s) }
+    end
+
+    def find_field(record, path)
+      yield(Support.find_hash_path(record, path)) rescue nil
+    end
+  end
+end

data/lib/tweetwine/twitter.rb

@@ -4,36 +4,56 @@ require "uri"
 
 module Tweetwine
   class Twitter
-    DEFAULT_NUM_STATUSES = 20
-    DEFAULT_PAGE_NUM = 1
     MAX_STATUS_LENGTH = 140
 
-    attr_reader :num_statuses, :page, :username
+    REST_API_STATUS_PATHS = {
+      :from_user  => %w{user screen_name},
+      :to_user    => %w{in_reply_to_screen_name},
+      :retweet    => %w{retweeted_status},
+      :created_at => %w{created_at},
+      :status     => %w{text}
+    }
+
+    REST_API_USER_PATHS = {
+      :from_user  => %w{screen_name},
+      :to_user    => %w{status in_reply_to_screen_name},
+      :retweet    => %w{retweeted_status},
+      :created_at => %w{status created_at},
+      :status     => %w{status text}
+    }
+
+    SEARCH_API_STATUS_PATHS = {
+      :from_user  => %w{from_user},
+      :to_user    => %w{to_user},
+      :retweet    => %w{retweeted_status},
+      :created_at => %w{created_at},
+      :status     => %w{text}
+    }
+
+    attr_reader :num_tweets, :page, :username
 
     def initialize(options = {})
-      @num_statuses = Util.parse_int_gt(options[:num_statuses], DEFAULT_NUM_STATUSES, 1, "number of statuses to show")
-      @page         = Util.parse_int_gt(options[:page], DEFAULT_PAGE_NUM, 1, "page number")
-      @username     = options[:username].to_s
+      @num_tweets = Support.parse_int_gt(options[:num_tweets], CLI::DEFAULT_CONFIG[:num_tweets], 1, "number of tweets to show")
+      @page       = Support.parse_int_gt(options[:page], CLI::DEFAULT_CONFIG[:page], 1, "page number")
+      @username   = options[:username].to_s
+    rescue ArgumentError => e
+      raise CommandLineError, e
     end
 
     def followers
-      response = get_from_rest_api "statuses/followers"
-      show_users_from_rest_api(*response)
+      show_users_from_rest_api(get_from_rest_api("statuses/followers"))
     end
 
     def friends
-      response = get_from_rest_api "statuses/friends"
-      show_users_from_rest_api(*response)
+      show_users_from_rest_api(get_from_rest_api("statuses/friends"))
     end
 
     def home
-      response = get_from_rest_api "statuses/home_timeline"
-      show_statuses_from_rest_api(*response)
+      show_tweets_from_rest_api(get_from_rest_api("statuses/home_timeline"))
     end
 
     def mentions
-      response = get_from_rest_api "statuses/mentions"
-      show_statuses_from_rest_api(*response)
+      show_tweets_from_rest_api(get_from_rest_api("statuses/mentions"))
     end
 
     def search(words = [], operator = nil)
@@ -41,7 +61,7 @@ module Tweetwine
       operator = :and unless operator
       query = operator == :and ? words.join(' ') : words.join(' OR ')
       response = get_from_search_api query
-      show_statuses_from_search_api(*response["results"])
+      show_tweets_from_search_api(response["results"])
     end
 
     def update(msg = nil)
@@ -53,7 +73,7 @@ module Tweetwine
         if CLI.ui.confirm("Really send?")
           response = post_to_rest_api("statuses/update", :status => status_in_utf8)
           CLI.ui.info "Sent status update.\n\n"
-          show_statuses_from_rest_api response
+          show_tweets_from_rest_api([response])
           completed = true
         end
       end
@@ -61,25 +81,24 @@ module Tweetwine
     end
 
     def user(who = username)
-      response = get_from_rest_api(
+      show_tweets_from_rest_api(get_from_rest_api(
         "statuses/user_timeline",
         common_rest_api_query_params.merge!({ :screen_name => who })
-      )
-      show_statuses_from_rest_api(*response)
+      ))
     end
 
     private
 
     def common_rest_api_query_params
       {
-        :count => @num_statuses,
+        :count => @num_tweets,
         :page  => @page
       }
     end
 
     def common_search_api_query_params
       {
-        :rpp  => @num_statuses,
+        :rpp  => @num_tweets,
         :page => @page
       }
     end
@@ -113,7 +132,7 @@ module Tweetwine
     end
 
     def get_from_search_api(query, params = common_search_api_query_params)
-      query = "q=#{Util.percent_encode(query)}&" << format_query_params(params)
+      query = "q=#{Uri.percent_encode(query)}&" << format_query_params(params)
       JSON.parse search_api["search.json?#{query}"].get
     end
 
@@ -133,55 +152,34 @@ module Tweetwine
       CLI.config.save
     end
 
-    def show_statuses_from_rest_api(*responses)
-      show_records(
-        responses,
-        {
-          :from_user  => ["user", "screen_name"],
-          :to_user    => "in_reply_to_screen_name",
-          :created_at => "created_at",
-          :status     => "text"
-        }
-      )
-    end
-
-    def show_users_from_rest_api(*responses)
-      show_records(
-        responses,
-        {
-          :from_user  => "screen_name",
-          :to_user    => ["status", "in_reply_to_screen_name"],
-          :created_at => ["status", "created_at"],
-          :status     => ["status", "text"]
-        }
-      )
-    end
-
-    def show_statuses_from_search_api(*responses)
-      show_records(
-        responses,
-        {
-          :from_user  => "from_user",
-          :to_user    => "to_user",
-          :created_at => "created_at",
-          :status     => "text"
-        }
-      )
-    end
-
-    def show_records(twitter_records, paths)
-      twitter_records.each do |twitter_record|
-        internal_record = [ :from_user, :to_user, :created_at, :status ].inject({}) do |result, key|
-          result[key] = Util.find_hash_path(twitter_record, paths[key])
-          result
+    def show_tweets_from_rest_api(records)
+      show_tweets(records, REST_API_STATUS_PATHS)
+    end
+
+    def show_users_from_rest_api(records)
+      show_tweets(records, REST_API_USER_PATHS)
+    end
+
+    def show_tweets_from_search_api(records)
+      show_tweets(records, SEARCH_API_STATUS_PATHS)
+    end
+
+    def show_tweets(records, paths)
+      tweets = records.map do |record|
+        begin
+          Tweet.new(record, paths)
+        rescue ArgumentError
+          CLI.ui.warn "Invalid tweet. Skipping..."
+          nil
         end
-        CLI.ui.show_record(internal_record)
       end
+      tweets.reject! { |tweet| tweet.nil? }
+      CLI.ui.show_tweets tweets
     end
 
     def create_status_update(status)
-      status = if Util.blank? status
-        CLI.ui.prompt("Status update")
+      status = if Support.blank? status
+        CLI.ui.prompt "Status update"
       else
         status.dup
       end
@@ -192,11 +190,11 @@ module Tweetwine
     end
 
     def shorten_urls_in(status)
-      url_pairs = URI.
-          extract(status, %w{http https}).
-          uniq.
-          map { |full_url| [full_url, CLI.url_shortener.shorten(full_url)] }.
-          reject { |(full_url, short_url)| Util.blank? short_url }
+      url_pairs = Uri.
+        extract(status, %w{http https}).
+        uniq.
+        map { |full_url| [full_url, CLI.url_shortener.shorten(full_url)] }.
+        reject { |(full_url, short_url)| Support.blank? short_url }
       url_pairs.each { |(full_url, short_url)| status.gsub!(full_url, short_url) }
     rescue HttpError, LoadError => e
       CLI.ui.warn "#{e}\nSkipping URL shortening..."
@@ -204,7 +202,7 @@ module Tweetwine
 
     def truncate_status(status)
       status.replace status[0...MAX_STATUS_LENGTH]
-      CLI.ui.warn("Status will be truncated.")
+      CLI.ui.warn "Status will be truncated."
     end
   end
 end