tweetwine 0.3.2 → 0.4.0

data/lib/tweetwine/ui.rb

@@ -1,7 +1,5 @@
 # coding: utf-8
 
-require "uri"
-
 module Tweetwine
   class UI
     COLOR_CODES = {
@@ -14,10 +12,11 @@ module Tweetwine
     USERNAME_REGEX = /^(@\w+)|\s+(@\w+)/
 
     def initialize(options = {})
-      @in     = options[:in]      || $stdin
-      @out    = options[:out]     || $stdout
-      @err    = options[:err]     || $stderr
-      @colors = options[:colors]  || false
+      @in       = options[:in]            || $stdin
+      @out      = options[:out]           || $stdout
+      @err      = options[:err]           || $stderr
+      @colors   = options[:colors]        || false
+      @reverse  = options[:show_reverse]  || false
     end
 
     def info(start_msg = "\n", end_msg = " done.")
@@ -57,41 +56,32 @@ module Tweetwine
       END
     end
 
-    def show_record(record)
-      clean_record(record)
-      if record[:status]
-        show_record_as_user_with_status(record)
+    def show_tweets(tweets)
+      tweets = tweets.reverse if @reverse
+      tweets.each { |t| show_tweet(t) }
+    end
+
+    def show_tweet(tweet)
+      if tweet.status?
+        show_regular_tweet(tweet)
       else
-        show_record_as_user(record)
+        show_user_info_tweet(tweet)
       end
     end
 
     private
 
-    def clean_record(record)
-      record.each_pair do |key, value|
-        if value.is_a? Hash
-          clean_record(value)
-        else
-          unless value.nil?
-            value = value.to_s
-            record[key] = value.empty? ? nil : value
-          end
-        end
-      end
-    end
-
-    def show_record_as_user(record)
+    def show_user_info_tweet(tweet)
       @out.puts <<-END
-#{format_user(record[:from_user])}
+#{format_user(tweet.from_user)}
 
       END
     end
 
-    def show_record_as_user_with_status(record)
+    def show_regular_tweet(tweet)
       @out.puts <<-END
-#{format_record_header(record[:from_user], record[:to_user], record[:created_at])}
-#{format_status(record[:status])}
+#{format_header(tweet)}
+#{format_status(tweet.status)}
 
       END
     end
@@ -102,26 +92,31 @@ module Tweetwine
     end
 
     def format_status(status)
-      status = Util.unescape_html(status)
+      status = Support.unescape_html(status)
       if @colors
-        status = colorize_matching(:yellow, status, USERNAME_REGEX)
-        status = colorize_matching(:magenta, status, HASHTAG_REGEX)
-        status = colorize_matching(:cyan, status, URI.extract(status, %w{http https}).uniq)
+        status = colorize_matching(:yellow,   status, USERNAME_REGEX)
+        status = colorize_matching(:magenta,  status, HASHTAG_REGEX)
+        status = colorize_matching(:cyan,     status, Uri.extract(status, %w{http https}).uniq)
       end
       status
     end
 
-    def format_record_header(from_user, to_user, created_at)
-      time_diff_value, time_diff_unit = Util.humanize_time_diff(created_at, Time.now)
+    def format_header(tweet)
+      from_user = tweet.from_user
+      to_user   = tweet.to_user if tweet.reply?
+      rt_user   = tweet.rt_user if tweet.retweet?
       if @colors
         from_user = colorize(:green, from_user)
-        to_user = colorize(:green, to_user) if to_user
+        to_user   = colorize(:green, to_user) if tweet.reply?
+        rt_user   = colorize(:green, rt_user) if tweet.retweet?
       end
-      if to_user
-        "#{from_user}, in reply to #{to_user}, #{time_diff_value} #{time_diff_unit} ago:"
-      else
-        "#{from_user}, #{time_diff_value} #{time_diff_unit} ago:"
+      if tweet.timestamped?
+        time_diff_value, time_diff_unit = Support.humanize_time_diff(tweet.created_at, Time.now)
       end
+      from_part = tweet.retweet?     ? "#{rt_user} RT #{from_user}"                  : from_user
+      to_part   = tweet.reply?       ? ", in reply to #{to_user}"                    : ''
+      time_part = tweet.timestamped? ? ", #{time_diff_value} #{time_diff_unit} ago"  : ''
+      "#{from_part}#{to_part}#{time_part}:"
     end
 
     def colorize_matching(color, str, pattern)
@@ -133,7 +128,7 @@ module Tweetwine
       else
         raise "unknown kind of pattern"
       end
-      Util.str_gsub_by_group(str, regexp) { |s| colorize(color, s) }
+      Support.str_gsub_by_group(str, regexp) { |s| colorize(color, s) }
     end
 
     def colorize(color, str)

data/lib/tweetwine/uri.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+require 'uri'
+
+module Tweetwine
+  module Uri
+    UNSAFE_CHARS_REGEXP = /[^#{URI::PATTERN::UNRESERVED}]/
+
+    class << self
+      def parser
+        if ::URI.const_defined? :Parser
+          @parser ||= ::URI::Parser.new
+        else
+          ::URI
+        end
+      end
+
+      def extract(*args)
+        parser.extract(*args)
+      end
+
+      def parse(*args)
+        parser.parse(*args)
+      end
+
+      def percent_encode(str)
+        parser.escape(str.to_s, UNSAFE_CHARS_REGEXP)
+      end
+    end
+  end
+end

data/lib/tweetwine/version.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+module Tweetwine
+  VERSION = '0.4.0'.freeze
+
+  class << self
+    def version
+      VERSION
+    end
+
+    def summary
+      'Tweetwine shows the latest tweets from the command line quickly.'
+    end
+  end
+end

data/lib/tweetwine.rb

@@ -8,72 +8,12 @@ end unless defined? JSON
 
 gem 'oauth', '~> 0.4.4'
 
-module Tweetwine
-  VERSION = '0.3.2'.freeze
-
-  class << self
-    def version
-      VERSION
-    end
-
-    def summary
-      'Tweetwine shows the latest tweets from the command line quickly.'
-    end
-  end
-
-  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
+require 'tweetwine/version'
 
+module Tweetwine
   lib_path = File.expand_path(File.dirname(__FILE__))
 
+  require "#{lib_path}/tweetwine/exceptions"
   require "#{lib_path}/tweetwine/basic_object"
 
   autoload :CharacterEncoding,  "#{lib_path}/tweetwine/character_encoding"
@@ -84,8 +24,10 @@ module Tweetwine
   autoload :Obfuscate,          "#{lib_path}/tweetwine/obfuscate"
   autoload :OptionParser,       "#{lib_path}/tweetwine/option_parser"
   autoload :Promise,            "#{lib_path}/tweetwine/promise"
+  autoload :Support,            "#{lib_path}/tweetwine/support"
+  autoload :Tweet,              "#{lib_path}/tweetwine/tweet"
   autoload :Twitter,            "#{lib_path}/tweetwine/twitter"
   autoload :UI,                 "#{lib_path}/tweetwine/ui"
+  autoload :Uri,                "#{lib_path}/tweetwine/uri"
   autoload :UrlShortener,       "#{lib_path}/tweetwine/url_shortener"
-  autoload :Util,               "#{lib_path}/tweetwine/util"
 end

data/man/tweetwine.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TWEETWINE" "7" "November 2010" "Tuomas Kareinen" "Tweetwine Manual"
+.TH "TWEETWINE" "7" "February 2011" "Tuomas Kareinen" "Tweetwine Manual"
 .
 .SH "DESCRIPTION"
 Tweetwine shows the latest tweets from the command line quickly\.
@@ -126,6 +126,7 @@ Before actually sending a new status update, it is possible for the software to
 
 username: spoonman
 colors: true
+show_reverse: true
 shorten_urls:
   service_url: http://is\.gd/create\.php
   method: post
@@ -181,7 +182,7 @@ fi
 .IP "" 0
 .
 .SH "COPYRIGHT"
-Tweetwine is Copyright (c) 2009\-2010 Tuomas Kareinen\.
+Tweetwine is copyright \(co 2009\-2011 Tuomas Kareinen\. See \fBLICENSE\.txt\fR\.
 .
 .SH "SEE ALSO"
-\fIhttps://github\.com/tuomas/tweetwine\fR
+\fIhttps://github\.com/tkareine/tweetwine\fR

data/man/tweetwine.7.ronn

@@ -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/release-script.txt

@@ -0,0 +1,10 @@
+In order to release, do
+
+$EDITOR lib/tweetwine/version.rb        # update version number
+$EDITOR CHANGELOG.rdoc                  # describe history summary
+git diff                                # review the changes
+rake gem:build                          # check that tests pass
+git commit -am "Bump to release-<version>"
+git tag release-<version>
+git push --tags origin master
+gem push tweetwine-<version>.gem

data/test/example/authorization_example.rb

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+require "example_helper"
+require "fixture/oauth"
+
+include Tweetwine::Test::Fixture::OAuth
+
+Feature "authorization" do
+  as_a "user"
+  i_want_to "see authorize myself"
+  in_order_to "use the service"
+
+  Scenario "authorize user with OAuth and save access token" do
+    When "I start the application with 'home' command and the command fails due to me being unauthorized" do
+      @command_url = "https://api.twitter.com/1/statuses/home_timeline.json?count=20&page=1"
+      stub_http_request(METHOD, REQUEST_TOKEN_URL).to_return(:body => REQUEST_TOKEN_RESPONSE)
+      stub_http_request(METHOD, ACCESS_TOKEN_URL).to_return(:body => ACCESS_TOKEN_RESPONSE)
+      stub_http_request(:get, @command_url).
+        to_return(:status => [401, 'Unauthorized']).then.
+        to_return(:body => fixture_file('home.json'))
+      in_temp_dir do
+        config_file = 'tweetwine.tmp'
+        @output = start_cli %W{--no-colors -f #{config_file} home}, [PIN], {}
+        @config_contents = YAML.load_file(config_file)
+        @config_mode = file_mode(config_file)
+      end
+    end
+
+    Then "the application authorizes me, saves access token to config file, and tries the command again" do
+      assert_requested(METHOD, REQUEST_TOKEN_URL)
+      assert_requested(METHOD, ACCESS_TOKEN_URL)
+      assert_requested(:get, @command_url, :headers => {'Authorization' => /^OAuth /}, :times => 2)
+      @output[0].should == "Please authorize: #{AUTHORIZE_URL}"
+      @output[1].should =~ /^Enter PIN:/
+      @output[2].should == "F1-kausi alkaa marraskuussa http://bit.ly/1qQwjQ"
+      @config_contents['oauth_access'].empty?.should == false
+      @config_mode.should == 0600
+    end
+  end
+end

data/test/example/example_helper.rb

@@ -48,7 +48,7 @@ module Tweetwine::Test
     end
 
     def read_shorten_config
-      Util.symbolize_hash_keys(YAML.load_file(CONFIG_FILE))[:shorten_urls]
+      Support.symbolize_hash_keys(YAML.load_file(CONFIG_FILE))[:shorten_urls]
     end
   end
 end

data/test/example/global_options_example.rb

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+require "example_helper"
+
+Feature "global options" do
+  as_a "user"
+  i_want_to "set global options"
+  in_order_to "affect general application behavior"
+
+  def setup
+    super
+    stub_http_request(:get, %r{https://api.twitter.com/1/statuses/home_timeline\.json\?count=\d+&page=\d+}).to_return(:body => fixture_file('home.json'))
+  end
+
+  Scenario "colors" do
+    When "I start the application with '--colors' option" do
+      @output = start_cli %w{--colors}
+    end
+
+    Then "the application shows tweets with colors" do
+      @output[0].should  == "\e[32mpelit\e[0m, 11 days ago:"
+      @output[1].should  == "F1-kausi alkaa marraskuussa \e[36mhttp://bit.ly/1qQwjQ\e[0m"
+      @output[2].should  == ""
+      @output[58].should == "\e[32mradar\e[0m, 15 days ago:"
+      @output[59].should == "Four short links: 29 September 2009 \e[36mhttp://bit.ly/dYxay\e[0m"
+    end
+  end
+
+  Scenario "show reverse" do
+    When "I start the application with '--reverse' option" do
+      @output = start_cli %w{--reverse}
+    end
+
+    Then "the application shows tweets in reverse order" do
+      @output[0].should  == "radar, 15 days ago:"
+      @output[1].should  == "Four short links: 29 September 2009 http://bit.ly/dYxay"
+      @output[2].should  == ""
+      @output[58].should == "pelit, 11 days ago:"
+      @output[59].should == "F1-kausi alkaa marraskuussa http://bit.ly/1qQwjQ"
+    end
+  end
+
+  Scenario "num" do
+    When "I start the application with '--num <n>' option" do
+      @num = 2
+      @output = start_cli %W{--num #{@num}}
+    end
+
+    Then "the application requests the specified number of tweets" do
+      assert_requested(:get, %r{/home_timeline\.json\?count=#{@num}&page=\d+})
+    end
+  end
+
+  Scenario "page" do
+    When "I start the application with '--page <p>' option" do
+      @page = 2
+      @output = start_cli %W{--page #{@page}}
+    end
+
+    Then "the application requests the specified page number for tweets" do
+      assert_requested(:get, %r{/home_timeline\.json\?count=\d+&page=#{@page}})
+    end
+  end
+end

data/test/example/search_statuses_example.rb

@@ -3,56 +3,51 @@
 require "example_helper"
 
 Feature "search tweets" do
-  in_order_to "search statuses"
   as_a "authenticated user"
-  i_want_to "see tweets matching the search"
+  i_want_to "search tweets with keywords"
+  in_order_to "see tweets that interest me"
 
-  SEARCH_OR_URL = "http://search.twitter.com/search.json?q=braid%20game&rpp=2&page=1"
-  SEARCH_AND_URL = "http://search.twitter.com/search.json?q=braid%20OR%20game&rpp=2&page=1"
+  SEARCH_BASE_URL = "http://search.twitter.com/search.json"
+  SEARCH_OR_URL  = "#{SEARCH_BASE_URL}?q=braid%20OR%20game&rpp=2&page=1"
+  SEARCH_AND_URL = "#{SEARCH_BASE_URL}?q=braid%20game&rpp=2&page=1"
   SEARCH_FIXTURE = fixture_file('search.json')
 
-  Scenario "search words" do
-    When "I start the application with command 'search' and search words" do
-      stub_http_request(:get, SEARCH_OR_URL).to_return(:body => SEARCH_FIXTURE)
-      @output = start_cli %w{-n 2 search braid game}
-    end
-
-    Then "the application shows tweets matching all the words" do
-      @output[0].should == "thatswhatshesaid, in reply to hatguy, 5 hours ago:"
-      @output[1].should == "@hatguy braid, perhaps the best indie game of 2009"
-      @output[2].should == ""
-      @output[3].should == "jillv, 11 hours ago:"
-      @output[4].should == "braid is even better than of the games i'm in, expect re4"
-    end
+  def setup
+    super
+    stub_http_request(:get, SEARCH_AND_URL).to_return(:body => SEARCH_FIXTURE)
+    stub_http_request(:get, SEARCH_OR_URL).to_return(:body => SEARCH_FIXTURE)
   end
 
   Scenario "search tweets matching all words" do
     When "I start the application with command 'search', option '-a', and search words" do
-      stub_http_request(:get, SEARCH_OR_URL).to_return(:body => SEARCH_FIXTURE)
       @output = start_cli %w{-n 2 search -a braid game}
     end
 
-    Then "the application shows tweets matching all the words" do
-      @output[0].should == "thatswhatshesaid, in reply to hatguy, 5 hours ago:"
-      @output[1].should == "@hatguy braid, perhaps the best indie game of 2009"
-      @output[2].should == ""
-      @output[3].should == "jillv, 11 hours ago:"
-      @output[4].should == "braid is even better than of the games i'm in, expect re4"
+    Then "the application requests tweets matching all the words and shows them" do
+      assert_requested(:get, SEARCH_AND_URL)
+      should_output_tweets
     end
   end
 
   Scenario "search tweets matching any words" do
     When "I start the application with command 'search', option '-o', and search words" do
-      stub_http_request(:get, SEARCH_AND_URL).to_return(:body => SEARCH_FIXTURE)
       @output = start_cli %w{-n 2 search -o braid game}
     end
 
-    Then "the application shows tweets matching any of the words" do
-      @output[0].should == "thatswhatshesaid, in reply to hatguy, 5 hours ago:"
-      @output[1].should == "@hatguy braid, perhaps the best indie game of 2009"
-      @output[2].should == ""
-      @output[3].should == "jillv, 11 hours ago:"
-      @output[4].should == "braid is even better than of the games i'm in, expect re4"
+    Then "the application requests tweets matching any of the words and shows them" do
+      assert_requested(:get, SEARCH_OR_URL)
+      should_output_tweets
+    end
+  end
+
+  Scenario "option '-a' is implied unless specified" do
+    When "I start the application with command 'search' and search words" do
+      @output = start_cli %w{-n 2 search braid game}
+    end
+
+    Then "the application requests tweets matching all the words and shows them" do
+      assert_requested(:get, SEARCH_AND_URL)
+      should_output_tweets
     end
   end
 
@@ -68,4 +63,14 @@ Feature "search tweets" do
       @status.exitstatus.should == CommandLineError.status_code
     end
   end
+
+  private
+
+  def should_output_tweets
+    @output[0].should == "thatswhatshesaid, in reply to hatguy, 5 hours ago:"
+    @output[1].should == "@hatguy braid, perhaps the best indie game of 2009"
+    @output[2].should == ""
+    @output[3].should == "jillv, 11 hours ago:"
+    @output[4].should == "braid is even better than of the games i'm in, expect re4"
+  end
 end

data/test/example/show_followers_example.rb

@@ -3,9 +3,9 @@
 require "example_helper"
 
 Feature "show followers" do
-  in_order_to "to see who follows me"
   as_a "authenticated user"
   i_want_to "see my followers"
+  in_order_to "to see who follows me"
 
   Scenario "show followers" do
     When "I start the application with 'followers' command" do

data/test/example/show_friends_example.rb

@@ -3,9 +3,9 @@
 require "example_helper"
 
 Feature "show friends" do
-  in_order_to "to see who I follow"
   as_a "authenticated user"
   i_want_to "see my friends"
+  in_order_to "to see who I follow"
 
   Scenario "show friends" do
     When "I start the application with 'followers' command" do

data/test/example/show_home_example.rb

@@ -3,54 +3,42 @@
 require "example_helper"
 
 Feature "show tweets from home timeline" do
-  in_order_to "stay up-to-date of other people's doings"
   as_a "authenticated user"
   i_want_to "see my home timeline"
+  in_order_to "stay up-to-date of other people's doings"
 
   def setup
     super
     stub_http_request(:get, "https://api.twitter.com/1/statuses/home_timeline.json?count=20&page=1").to_return(:body => fixture_file('home.json'))
   end
 
-  Scenario "with colorization disabled" do
-    When "I start the application with no command" do
-      @output = start_cli %w{--no-colors}
+  Scenario "show home timeline" do
+    When "I start the application with 'home' command" do
+      @output = start_cli %w{--no-colors home}
     end
 
-    Then "the application shows tweets from home timeline without colors" do
-      @output[0].should == "pelit, 11 days ago:"
-      @output[1].should == "F1-kausi alkaa marraskuussa http://bit.ly/1qQwjQ"
-      @output[2].should == ""
-      @output[58].should == "radar, 15 days ago:"
-      @output[59].should == "Four short links: 29 September 2009 http://bit.ly/dYxay"
+    Then "the application shows tweets from home timeline" do
+      should_output_tweets
     end
   end
 
-  Scenario "with colorization enabled" do
+  Scenario "show home timeline is default command" do
     When "I start the application with no command" do
-      @output = start_cli %w{--colors}
+      @output = start_cli %w{--no-colors}
     end
 
-    Then "the application shows tweets from home timeline with colors" do
-      @output[0].should == "\e[32mpelit\e[0m, 11 days ago:"
-      @output[1].should == "F1-kausi alkaa marraskuussa \e[36mhttp://bit.ly/1qQwjQ\e[0m"
-      @output[2].should == ""
-      @output[58].should == "\e[32mradar\e[0m, 15 days ago:"
-      @output[59].should == "Four short links: 29 September 2009 \e[36mhttp://bit.ly/dYxay\e[0m"
+    Then "the application shows tweets from home timeline" do
+      should_output_tweets
     end
   end
 
-  Scenario "the command for showing the home view is the default command" do
-    When "I start the application with 'home' command" do
-      @output = start_cli %w{--no-colors home}
-    end
+  private
 
-    Then "the application shows tweets from home timeline" do
-      @output[0].should == "pelit, 11 days ago:"
-      @output[1].should == "F1-kausi alkaa marraskuussa http://bit.ly/1qQwjQ"
-      @output[2].should == ""
-      @output[58].should == "radar, 15 days ago:"
-      @output[59].should == "Four short links: 29 September 2009 http://bit.ly/dYxay"
-    end
+  def should_output_tweets
+    @output[0].should == "pelit, 11 days ago:"
+    @output[1].should == "F1-kausi alkaa marraskuussa http://bit.ly/1qQwjQ"
+    @output[2].should == ""
+    @output[58].should == "radar, 15 days ago:"
+    @output[59].should == "Four short links: 29 September 2009 http://bit.ly/dYxay"
   end
 end

data/test/example/show_mentions_example.rb

@@ -3,9 +3,9 @@
 require "example_helper"
 
 Feature "show tweets mentioning the user" do
-  in_order_to "know if someone has mentioned me"
   as_a "authenticated user"
-  i_want_to "see the tweets mentioning me"
+  i_want_to "see tweets mentioning me"
+  in_order_to "know if someone has replied or otherwise mentioned me"
 
   Scenario "show tweets mentioning me" do
     When "I start the application with 'mentions' command" do