tweetwine 0.2.11 → 0.2.12

data/man/tweetwine.1.ronn

@@ -0,0 +1,69 @@
+tweetwine(1) -- a simple Twitter command line agent
+===================================================
+
+## SYNOPSIS
+
+    tweetwine [ <GLOBAL_OPTIONS> ]
+    tweetwine [ <GLOBAL_OPTIONS> ] <COMMAND> [ <COMMAND_OPTIONS> ]
+
+## DESCRIPTION
+
+Tweetwine supports showing the home timeline of the authenticated user, the
+latest statuses of friends and followers, and the latest statuses that mention
+the user. If that's not enough, statuses can be searched with arbitrary terms.
+In addition, new statuses can be sent.
+
+<COMMAND> is one of
+
+  * `followers`,
+  * `friends`,
+  * `home`,
+  * `mentions`,
+  * `search`,
+  * `update`, or
+  * `user`.
+
+The default is `home`.
+
+## OPTIONS
+
+Options given from command line override corresponding settings from
+configuration (`~/.tweetwine`).
+
+<GLOBAL_OPTIONS> are:
+
+  * `-a`, `--auth USERNAME:PASSWORD`:
+    Authentication.
+
+  * `-c`, `--[no-]colors`:
+    Colorize output with ANSI escape codes.
+
+  * `-n`, `--num N`:
+    The number of statuses in page, default 20.
+
+  * `--[no-]http-proxy URL`:
+    Use proxy for HTTP and HTTPS.
+
+  * `--no-url-shorten`:
+    Do not shorten URLs for status update.
+
+  * `-p`, `--page N`:
+    The page number for statuses, default 1.
+
+  * `-v`, `--version`:
+    Show version information and exit.
+
+  * `-h`, `--help`:
+    Show help message and exit.
+
+In order to see <COMMAND_OPTIONS>, enter:
+
+    $ tweetwine help <COMMAND>
+
+## COPYRIGHT
+
+Tweetwine is Copyright (c) 2009-2010 Tuomas Kareinen
+
+## SEE ALSO
+
+tweetwine(7), <http://github.com/tuomas/tweetwine>

data/man/tweetwine.7

@@ -0,0 +1,216 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "TWEETWINE" "7" "April 2010" "Tuomas Kareinen" "Tweetwine Manual"
+.
+.SH "NAME"
+\fBtweetwine\fR \-\- a simple Twitter command line agent
+.
+.SH "DESCRIPTION"
+Tweetwine supports showing the home timeline of the authenticated user, the
+latest statuses of friends and followers, and the latest statuses that mention
+the user. If that's not enough, statuses can be searched with arbitrary terms.
+In addition, new statuses can be sent.
+.
+.P
+Features:
+.
+.IP "\(bu" 4
+Simple to use command line interface, with Bash completion support
+.
+.IP "\(bu" 4
+ANSI coloring of statuses, but in discreet manner
+.
+.IP "\(bu" 4
+Supports shortening URLs in a status update with a configurable shortening
+service
+.
+.IP "\(bu" 4
+Configuration file for preferred settings
+.
+.IP "" 0
+.
+.SH "INSTALL"
+Install Tweetwine with RubyGems:
+.
+.IP "" 4
+.
+.nf
+
+$ gem install tweetwine
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The program is compatible with both Ruby 1.8 and 1.9.
+.
+.P
+The program requires \fIrest\-client\fR
+gem to be installed. In addition, the program needs \fIjson\fR gem on Ruby 1.8.
+.
+.P
+Documentation is provided as gem man pages. Use \fIgem\-man\fR to see them:
+.
+.IP "" 4
+.
+.nf
+
+$ gem man tweetwine
+.
+.fi
+.
+.IP "" 0
+.
+.SH "BASIC USAGE AND CONFIGURATION"
+In the command line, run the program by entering
+.
+.IP "" 4
+.
+.nf
+
+$ tweetwine [ <GLOBAL_OPTIONS> ] [ <COMMAND> ] [ <COMMAND_OPTIONS> ]
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The program needs the user's username and password for authentication. This
+information can be supplied either via a configuration file or as an option
+(\fB\-a USERNAME:PASSWORD\fR) to the program. It is recommended to use the former
+method over the latter.
+.
+.P
+The configuration file, in \fB~/.tweetwine\fR, is in YAML syntax. The program
+recognizes the following basic settings:
+.
+.IP "" 4
+.
+.nf
+
+username: <your_username>
+password: <your_password>
+colors: true|false
+.
+.fi
+.
+.IP "" 0
+.
+.P
+For all the global options and commands, see:
+.
+.IP "" 4
+.
+.nf
+
+$ tweetwine help
+.
+.fi
+.
+.IP "" 0
+.
+.P
+For information about a specific command and its options, enter:
+.
+.IP "" 4
+.
+.nf
+
+$ tweetwine help <COMMAND>
+.
+.fi
+.
+.IP "" 0
+.
+.SS "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 \fBshorten_urls\fR key in configuration file; for example:
+.
+.IP "" 4
+.
+.nf
+
+username: spoonman
+password: withyourhands
+colors: 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
+.
+.fi
+.
+.IP "" 0
+.
+.P
+The supported methods (in \fBmethod\fR) are \fBget\fR and \fBpost\fR. 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 \fBextra_params\fR key, as a hash.
+.
+.P
+The \fBxpath_selector\fR is needed to extract the shortened URL from the result.
+.
+.P
+URL shortening can be disabled by
+.
+.IP "\(bu" 4
+not defining \fBshorten_urls\fR key in the configuration file,
+.
+.IP "\(bu" 4
+setting key \fBenable\fR to \fBfalse\fR, or
+.
+.IP "\(bu" 4
+using the command line option \fB\-\-no\-url\-shorten\fR.
+.
+.IP "" 0
+.
+.P
+\fINOTE:\fR The use of the feature requires \fInokogiri\fR gem
+to be installed.
+.
+.SS "HTTP proxy setting"
+If \fB$http_proxy\fR environment variable is set, Tweetwine attempts to use the
+URL in the environment variable as HTTP proxy for all its HTTP connections.
+This setting can be overridden with \fB\-\-http\-proxy\fR and \fB\-\-no\-http\-proxy\fR
+command line options.
+.
+.SS "Bash command line completion support"
+Bash shell supports command line completion via tab character. If you want to
+enable Tweetwine specific completion with Bash, source the file \fBtweetwine\-completion.bash\fR, located in \fBcontrib\fR directory:
+.
+.IP "" 4
+.
+.nf
+
+. contrib/tweetwine\-completion.bash
+.
+.fi
+.
+.IP "" 0
+.
+.P
+In order to do this automatically when your shell starts, insert the following
+snippet to your Bash initialization script (such as \fB~/.bashrc\fR):
+.
+.IP "" 4
+.
+.nf
+
+if [ \-f <path_to_tweetwine>/contrib/tweetwine\-completion.bash ]; then
+    . <path_to_tweetwine>/contrib/tweetwine\-completion.bash
+fi
+.
+.fi
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Tweetwine is Copyright (c) 2009\-2010 Tuomas Kareinen
+.
+.SH "SEE ALSO"
+tweetwine(1), \fIhttp://github.com/tuomas/tweetwine\fR

data/man/tweetwine.7.ronn

@@ -0,0 +1,122 @@
+tweetwine -- a simple Twitter command line agent
+================================================
+
+## DESCRIPTION
+
+Tweetwine supports showing the home timeline of the authenticated user, the
+latest statuses of friends and followers, and the latest statuses that mention
+the user. If that's not enough, statuses can be searched with arbitrary terms.
+In addition, new statuses can be sent.
+
+Features:
+
+* Simple to use command line interface, with Bash completion support
+* ANSI coloring of statuses, but in discreet manner
+* Supports shortening URLs in a status update with a configurable shortening
+  service
+* Configuration file for preferred settings
+
+## INSTALL
+
+Install Tweetwine with RubyGems:
+
+    $ gem install tweetwine
+
+The program is compatible with both Ruby 1.8 and 1.9.
+
+The program requires [rest-client](http://github.com/archiloque/rest-client)
+gem to be installed. In addition, the program needs
+[json](http://json.rubyforge.org/) gem on Ruby 1.8.
+
+Documentation is provided as gem man pages. Use
+[gem-man](http://github.com/defunkt/gem-man) to see them:
+
+    $ gem man tweetwine
+
+## BASIC USAGE AND CONFIGURATION
+
+In the command line, run the program by entering
+
+    $ tweetwine [ <GLOBAL_OPTIONS> ] [ <COMMAND> ] [ <COMMAND_OPTIONS> ]
+
+The program needs the user's username and password for authentication. This
+information can be supplied either via a configuration file or as an option
+(`-a USERNAME:PASSWORD`) to the program. It is recommended to use the former
+method over the latter.
+
+The configuration file, in `~/.tweetwine`, is in YAML syntax. The program
+recognizes the following basic settings:
+
+    username: <your_username>
+    password: <your_password>
+    colors: true|false
+
+For all the global options and commands, see:
+
+    $ tweetwine help
+
+For information about a specific command and its options, enter:
+
+    $ tweetwine help <COMMAND>
+
+### 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 `shorten_urls` key in configuration file; for example:
+
+    username: spoonman
+    password: withyourhands
+    colors: 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 (in `method`) are `get` and `post`. 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
+`extra_params` key, as a hash.
+
+The `xpath_selector` is needed to extract the shortened URL from the result.
+
+URL shortening can be disabled by
+
+* not defining `shorten_urls` key in the configuration file,
+* setting key `enable` to `false`, or
+* using the command line option `--no-url-shorten`.
+
+*NOTE:* The use of the feature requires [nokogiri](http://nokogiri.org/) gem
+to be installed.
+
+### HTTP proxy setting
+
+If `$http_proxy` environment variable is set, Tweetwine attempts to use the
+URL in the environment variable as HTTP proxy for all its HTTP connections.
+This setting can be overridden with `--http-proxy` and `--no-http-proxy`
+command line options.
+
+### Bash command line completion support
+
+Bash shell supports command line completion via tab character. If you want to
+enable Tweetwine specific completion with Bash, source the file
+`tweetwine-completion.bash`, located in `contrib` directory:
+
+    . contrib/tweetwine-completion.bash
+
+In order to do this automatically when your shell starts, insert the following
+snippet to your Bash initialization script (such as `~/.bashrc`):
+
+    if [ -f <path_to_tweetwine>/contrib/tweetwine-completion.bash ]; then
+        . <path_to_tweetwine>/contrib/tweetwine-completion.bash
+    fi
+
+## COPYRIGHT
+
+Tweetwine is Copyright (c) 2009-2010 Tuomas Kareinen
+
+## SEE ALSO
+
+tweetwine(1), <http://github.com/tuomas/tweetwine>

data/test/cli_test.rb

@@ -1,8 +1,10 @@
+# coding: utf-8
+
 require "test_helper"
 
 module Tweetwine
 
-class CLITest < Test::Unit::TestCase
+class CLITest < TweetwineTestCase
   context "A CLI, upon initialization" do
     should "disallow using #new to create a new instance" do
       assert_raise(NoMethodError) { CLI.new("-v", "test", "") {} }

data/test/client_test.rb

@@ -1,9 +1,11 @@
+# coding: utf-8
+
 require "test_helper"
 require "json"
 
 module Tweetwine
 
-class ClientTest < Test::Unit::TestCase
+class ClientTest < TweetwineTestCase
   context "A client instance" do
     setup do
       @io = mock()

data/test/io_test.rb

@@ -1,8 +1,10 @@
+# coding: utf-8
+
 require "test_helper"
 
 module Tweetwine
 
-class IOTest < Test::Unit::TestCase
+class IOTest < TweetwineTestCase
   context "An IO instance" do
     setup do
       @input = mock()
@@ -216,42 +218,47 @@ Lulz, so happy! \e[35m#{hashtags[0]}\e[0m \e[35m#{hashtags[1]}\e[0m
         @io.show_record(record)
       end
 
-      should "highlight HTTP and HTTPS URLs in a status" do
-        from_user = "barman"
-        links = %w{http://bit.ly/18rU_Vx http://is.gd/1qLk3 https://is.gd/2rLk4}
-        record = {
-          :from_user  => from_user,
-          :status     => "Three links: #{links[0]} #{links[1]} and #{links[2]}",
-          :created_at => Time.at(1),
-          :to_user    => nil
-        }
-        Util.expects(:humanize_time_diff).returns([2, "secs"])
-        @output.expects(:puts).with(<<-END
+      %w{http://is.gd/1qLk3 http://is.gd/1qLk3?id=foo}.each do |url|
+        should "highlight HTTP and HTTPS URLs in a status, given #{url}" do
+          from_user = "barman"
+          record = {
+            :from_user  => from_user,
+            :status     => "New Rails³ - #{url}",
+            :created_at => Time.at(1),
+            :to_user    => nil
+          }
+          Util.expects(:humanize_time_diff).returns([2, "secs"])
+          @output.expects(:puts).with(<<-END
 \e[32m#{from_user}\e[0m, 2 secs ago:
-Three links: \e[36m#{links[0]}\e[0m \e[36m#{links[1]}\e[0m and \e[36m#{links[2]}\e[0m
+New Rails³ - \e[36m#{url}\e[0m
 
-        END
-        )
-        @io.show_record(record)
+          END
+          )
+          @io.show_record(record)
+        end
       end
 
-      should "highlight HTTP and HTTPS URLs in a status, even if duplicates" do
-        from_user = "barman"
-        link = "http://is.gd/1qLk3"
-        record = {
-          :from_user  => from_user,
-          :status     => "Duplicate links: #{link} and #{link}",
-          :created_at => Time.at(1),
-          :to_user    => nil
-        }
-        Util.expects(:humanize_time_diff).returns([2, "secs"])
-        @output.expects(:puts).with(<<-END
+      [
+        %w{http://is.gd/1qLk3 http://is.gd/1qLk3},
+        %w{http://is.gd/1qLk3 http://is.gd/1q}
+      ].each do |(first_url, second_url)|
+        should "highlight HTTP and HTTPS URLs in a status, given #{first_url} and #{second_url}" do
+          from_user = "barman"
+          record = {
+            :from_user  => from_user,
+            :status     => "Links: #{first_url} and #{second_url} np",
+            :created_at => Time.at(1),
+            :to_user    => nil
+          }
+          Util.expects(:humanize_time_diff).returns([2, "secs"])
+          @output.expects(:puts).with(<<-END
 \e[32m#{from_user}\e[0m, 2 secs ago:
-Duplicate links: \e[36m#{link}\e[0m and \e[36m#{link}\e[0m
+Links: \e[36m#{first_url}\e[0m and \e[36m#{second_url}\e[0m np
 
-        END
-        )
-        @io.show_record(record)
+          END
+          )
+          @io.show_record(record)
+        end
       end
 
       should "highlight usernames in a status" do

data/test/options_test.rb

@@ -1,8 +1,10 @@
+# coding: utf-8
+
 require "test_helper"
 
 module Tweetwine
 
-class OptionsTest < Test::Unit::TestCase
+class OptionsTest < TweetwineTestCase
   context "An Options instance" do
     should "get the value corresponding to a key or nil (the default value)" do
       assert_equal "alpha", Options.new({:a => "alpha"})[:a]

data/test/retrying_http_test.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "test_helper"
 require "rest_client"
 
@@ -6,9 +8,8 @@ class Object
 end
 
 module Tweetwine
-module RetryingHttp
 
-class ModuleTest < Test::Unit::TestCase
+class RetryingHttpModuleTest < TweetwineTestCase
   context "When using HTTP proxy" do
     setup do
       RetryingHttp.proxy = "http://proxy.net:8080"
@@ -24,11 +25,11 @@ class ModuleTest < Test::Unit::TestCase
   end
 end
 
-class ClientTest < Test::Unit::TestCase
+class RetryingHttpClientTest < TweetwineTestCase
   context "A Client instance" do
     setup do
       @io = mock()
-      @client = Client.new(@io)
+      @client = RetryingHttp::Client.new(@io)
     end
 
     should "wrap RestClient.get" do
@@ -68,10 +69,10 @@ class ClientTest < Test::Unit::TestCase
       should "retry connection a maximum of certain number of times, case #{error_class}" do
         retrying_calls = sequence("Retrying Client calls")
         io_calls = sequence("IO")
-        (Client::MAX_RETRIES + 1).times do
+        (RetryingHttp::Client::MAX_RETRIES + 1).times do
           RestClient.expects(:get).with("https://unresponsive.org").in_sequence(retrying_calls).raises(error_class)
         end
-        Client::MAX_RETRIES.times do
+        RetryingHttp::Client::MAX_RETRIES.times do
           @io.expects(:warn).in_sequence(io_calls)
         end
         assert_raise(HttpError) { @client.get("https://unresponsive.org") }
@@ -85,12 +86,12 @@ class ClientTest < Test::Unit::TestCase
   end
 end
 
-class ResourceTest < Test::Unit::TestCase
+class RetryingHttpResourceTest < TweetwineTestCase
   context "A Resource instance" do
     setup do
       @io = mock()
       @wrapped = mock()
-      @resource = Resource.new(@wrapped)
+      @resource = RetryingHttp::Resource.new(@wrapped)
       @resource.io = @io
     end
 
@@ -131,10 +132,10 @@ class ResourceTest < Test::Unit::TestCase
       should "retry connection a maximum of certain number of times, case #{error_class}" do
         retrying_calls = sequence("Retrying Resource calls")
         io_calls = sequence("IO")
-        (Resource::MAX_RETRIES + 1).times do
+        (RetryingHttp::Resource::MAX_RETRIES + 1).times do
           @wrapped.expects(:get).in_sequence(retrying_calls).raises(error_class)
         end
-        Resource::MAX_RETRIES.times do
+        RetryingHttp::Resource::MAX_RETRIES.times do
           @io.expects(:warn).in_sequence(io_calls)
         end
         assert_raise(HttpError) { @resource.get }
@@ -144,4 +145,3 @@ class ResourceTest < Test::Unit::TestCase
 end
 
 end
-end

data/test/startup_config_test.rb

@@ -1,9 +1,11 @@
+# coding: utf-8
+
 require "test_helper"
 
 module Tweetwine
 
-class StartupConfigTest < Test::Unit::TestCase
-  TEST_CONFIG_FILE = File.dirname(__FILE__) << "/fixtures/test_config.yaml"
+class StartupConfigTest < TweetwineTestCase
+  TEST_CONFIG_FILE = Helper.fixture_file("test_config.yaml")
 
   context "A StartupConfig instance" do
     context "upon initialization" do