tweetwine 0.2.8 → 0.2.9

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+=== 0.2.9 released 2010-02-24
+
+* HTTP proxy support
+* A Bash completion support script is packed in the gem
+
 === 0.2.8 released 2010-01-17
 
 * Unescape basic HTML encoding when displaying statuses

data/README.rdoc

@@ -2,11 +2,19 @@
 
 A simple but tasty Twitter agent for command line use, made for fun.
 
+== 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
+
 == Installation
 
-Install Tweetwine as a RubyGem from Gemcutter[http://gemcutter.org/]:
+Install Tweetwine as a RubyGem:
 
-  $ sudo gem install tweetwine --source http://gemcutter.org
+  $ gem install tweetwine
 
 The program is compatible with both Ruby 1.8 and 1.9.
 
@@ -76,6 +84,28 @@ The feature can be disabled by
 
 The use of the feature requires <b>nokogiri</b> gem to be installed.
 
+=== HTTP proxy setting
+
+If <tt>$http_proxy</tt> 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 <tt>--http-proxy</tt> and
+<tt>--no-http-proxy</tt> 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
+<tt>tweetwine-completion.bash</tt>, located in <tt>contrib</tt> 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 <tt>~/.bashrc</tt>):
+
+  if [ -f <path_to_tweetwine>/contrib/tweetwine-completion.bash ]; then
+      . <path_to_tweetwine>/contrib/tweetwine-completion.bash
+  fi
+
 == Contacting
 
 Please send feedback by email to Tuomas Kareinen < tkareine (at) gmail (dot)

data/Rakefile

@@ -4,7 +4,7 @@ require "rubygems"
 
 name = "tweetwine"
 require "#{name}"
-version = Tweetwine::VERSION
+version = Tweetwine::VERSION.dup
 
 require "rake/clean"
 
@@ -20,7 +20,15 @@ spec = Gem::Specification.new do |s|
   s.email = "tkareine@gmail.com"
 
   s.platform = Gem::Platform::RUBY
-  s.files = FileList["Rakefile", "MIT-LICENSE.txt", "*.rdoc", "bin/**/*", "example/**/*", "lib/**/*", "test/**/*"].to_a
+  s.files = FileList[
+    "Rakefile",
+    "MIT-LICENSE.txt",
+    "*.rdoc",
+    "bin/**/*",
+    "contrib/**/*",
+    "example/**/*",
+    "lib/**/*",
+    "test/**/*"].to_a
   s.executables = ["tweetwine"]
 
   s.add_dependency("rest-client", ">= 1.0.0")
@@ -47,12 +55,12 @@ end
 
 desc "Install the software as a gem"
 task :install => [:package] do
-  sh %{sudo gem install pkg/#{name}-#{version}.gem}
+  sh %{gem install pkg/#{name}-#{version}.gem}
 end
 
 desc "Uninstall the gem"
 task :uninstall => [:clean] do
-  sh %{sudo gem uninstall #{name}}
+  sh %{gem uninstall #{name}}
 end
 
 require "rake/rdoctask"

data/contrib/tweetwine-completion.bash

@@ -0,0 +1,28 @@
+_tweetwine_completion ()
+{
+    local cur prev cmds gopts
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    cmds="followers friends home mentions search update user"
+    gopts="--auth --colors --num --no-colors --no-url-shorten --page --version"
+
+    case "${prev}" in
+    followers | friends | home | mentions | search | update | user)
+        COMPREPLY=()
+        ;;
+    help)
+        COMPREPLY=( $(compgen -W "${cmds}" -- ${cur}) )
+        ;;
+    *)
+        if [[ "${cur}" == -* ]]; then
+            COMPREPLY=( $(compgen -W "${gopts}" -- ${cur}) )
+        else
+            COMPREPLY=( $(compgen -W "${cmds} help" -- ${cur}) )
+        fi
+        ;;
+    esac
+
+    return 0
+}
+
+complete -F _tweetwine_completion tweetwine

data/example/example_helper.rb

@@ -8,6 +8,7 @@
   timecop
 }.each { |lib| require lib }
 
+FakeWeb.clean_registry
 FakeWeb.allow_net_connect = false
 Timecop.freeze(Time.parse("2009-10-14 01:56:15 +0300"))
 
@@ -18,6 +19,7 @@ module Tweetwine
     TEST_USER = "fooman"
     TEST_PASSWD = "barpwd"
     TEST_AUTH = "#{TEST_USER}:#{TEST_PASSWD}"
+    TEST_PROXY_URL = "http://proxy.net:8080"
 
     def launch_app(args, &blk)
       lib = File.dirname(__FILE__) << "/../lib"

data/example/show_metadata_example.rb

@@ -47,8 +47,10 @@ Usage: tweetwine [global_options...] [command] [command_options...]
     -c, --colors                     Colorize output with ANSI escape codes
     -n, --num N                      The number of statuses in page, default 20
         --no-colors                  Do not use ANSI colors
+        --no-http-proxy              Do not 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
+        --http-proxy URL             Use proxy for HTTP and HTTPS
     -v, --version                    Show version information and exit
     -h, --help                       Show this help message and exit
       END

data/example/use_http_proxy_example.rb

@@ -0,0 +1,45 @@
+require "example_helper"
+
+FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/home_timeline.json?count=20&page=1", :body => fixture("home.json"))
+
+Feature "using HTTP proxy setting" do
+  in_order_to "tweet behind an HTTP proxy"
+  as_a "authenticated user"
+  i_want_to "tweet as before"
+
+  Scenario "Proxy is enabled via environment variable" do
+    When "application is launched" do
+      ENV['http_proxy'] = TEST_PROXY_URL
+      @output = launch_cli(%W{-a #{TEST_AUTH} --no-colors})
+    end
+
+    Then "the latest statuses in the home view are shown via proxy" do
+      RestClient.proxy.should == TEST_PROXY_URL
+      @output[0].should == "pelit, 11 days ago:"
+    end
+  end
+
+  Scenario "Proxy is enabled via command line option" do
+    When "application is launched with --http-proxy" do
+      ENV['http_proxy'] = nil
+      @output = launch_cli(%W{-a #{TEST_AUTH} --no-colors --http-proxy #{TEST_PROXY_URL}})
+    end
+
+    Then "the latest statuses in the home view are shown via proxy" do
+      RestClient.proxy.should == TEST_PROXY_URL
+      @output[0].should == "pelit, 11 days ago:"
+    end
+  end
+
+  Scenario "Proxy is disabled via command line option" do
+    When "application is launched with --no-http-proxy" do
+      ENV['http_proxy'] = TEST_PROXY_URL
+      @output = launch_cli(%W{-a #{TEST_AUTH} --no-colors --no-http-proxy})
+    end
+
+    Then "the latest statuses in the home view are shown via proxy" do
+      RestClient.proxy.should == nil
+      @output[0].should == "pelit, 11 days ago:"
+    end
+  end
+end

data/lib/tweetwine/cli.rb

@@ -36,7 +36,7 @@ module Tweetwine
     def initialize(args, exec_name, config_file, extra_opts = {}, &dependencies_blk)
       @global_option_parser = create_global_option_parser(exec_name)
       @config = StartupConfig.new(Client::COMMANDS + [:help], Client::DEFAULT_COMMAND, extra_opts)
-      @config.parse(args, config_file, &@global_option_parser)
+      @config.parse(args, config_file, [:http_proxy], &@global_option_parser)
       @client = Client.new(dependencies_blk.call(@config.options), @config.options) if @config.command != :help
     end
 
@@ -119,6 +119,11 @@ Usage: #{exec_name} [global_options...] [command] [command_options...]
               :desc   => "Do not use ANSI colors",
               :action => lambda { |arg| parsed[:colors] = false }
             },
+            {
+              :long   => "--no-http-proxy",
+              :desc   => "Do not use proxy for HTTP and HTTPS",
+              :action => lambda { |arg| parsed[:http_proxy] = nil }
+            },
             {
               :long   => "--no-url-shorten",
               :desc   => "Do not shorten URLs for status update",
@@ -131,6 +136,12 @@ Usage: #{exec_name} [global_options...] [command] [command_options...]
               :desc   => "The page number for statuses, default #{Client::DEFAULT_PAGE_NUM}",
               :action => lambda { |arg| parsed[:page_num] = arg }
             },
+            {
+              :long   => "--http-proxy URL",
+              :type   => String,
+              :desc   => "Use proxy for HTTP and HTTPS",
+              :action => lambda { |arg| parsed[:http_proxy] = arg }
+            },
             {
               :short  => "-v",
               :long   => "--version",

data/lib/tweetwine/client.rb

@@ -18,6 +18,7 @@ module Tweetwine
       @io = dependencies.io
       @username = options[:username].to_s
       raise ArgumentError, "No authentication data given" if @username.empty?
+      RetryingHttp.proxy = options[:http_proxy] if options[:http_proxy]
       @http_client = dependencies.http_client
       @http_resource = @http_client.as_resource("https://twitter.com", :user => @username, :password => options[:password])
       @num_statuses = Util.parse_int_gt(options[:num_statuses], DEFAULT_NUM_STATUSES, 1, "number of statuses_to_show")

data/lib/tweetwine/meta.rb

@@ -1,3 +1,3 @@
 module Tweetwine
-  VERSION = "0.2.8"
+  VERSION = "0.2.9".freeze
 end

data/lib/tweetwine/retrying_http.rb

@@ -4,6 +4,10 @@ module Tweetwine
   class HttpError < RuntimeError; end
 
   module RetryingHttp
+    def self.proxy=(url)
+      RestClient.proxy = url
+    end
+
     class Base
       MAX_RETRIES = 3
       RETRY_BASE_WAIT_TIMEOUT = 4

data/lib/tweetwine/startup_config.rb

@@ -11,8 +11,8 @@ module Tweetwine
       @options, @command = default_opts, nil
     end
 
-    def parse(args = [], config_file = nil, &cmd_option_parser)
-      options = @options.merge(parse_options(args, config_file, &cmd_option_parser))
+    def parse(args = [], config_file = nil, env_lookouts = [], &cmd_option_parser)
+      options = @options.merge(parse_options(args, config_file, env_lookouts, &cmd_option_parser))
       command = if args.empty? then @default_command else args.shift.to_sym end
       raise ArgumentError, "Unknown command" unless @supported_commands.include? command
       @options, @command = options, command
@@ -21,10 +21,11 @@ module Tweetwine
 
     private
 
-    def parse_options(args, config_file, &cmd_option_parser)
+    def parse_options(args, config_file, env_lookouts, &cmd_option_parser)
       cmd_options = if cmd_option_parser then parse_cmdline_args(args, &cmd_option_parser) else {} end
       config_options = if config_file && File.exists?(config_file) then parse_config_file(config_file) else {} end
-      config_options.merge(cmd_options)
+      env_options = if env_lookouts then parse_env_vars(env_lookouts) else {} end
+      env_options.merge(config_options.merge(cmd_options))
     end
 
     def parse_cmdline_args(args, &cmd_option_parser)
@@ -35,5 +36,13 @@ module Tweetwine
       options = YAML.load(File.read(config_file))
       Util.symbolize_hash_keys(options)
     end
+
+    def 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 if env_option && !env_option.empty?
+        result
+      end
+    end
   end
 end

data/test/retrying_http_test.rb

@@ -8,6 +8,22 @@ end
 module Tweetwine
 module RetryingHttp
 
+class ModuleTest < Test::Unit::TestCase
+  context "When using HTTP proxy" do
+    setup do
+      RetryingHttp.proxy = "http://proxy.net:8080"
+    end
+
+    should "pass HTTP proxy configuration to RestClient" do
+      assert_equal "http://proxy.net:8080", RestClient.proxy
+    end
+
+    teardown do
+      RetryingHttp.proxy = nil
+    end
+  end
+end
+
 class ClientTest < Test::Unit::TestCase
   context "A Client instance" do
     setup do

data/test/startup_config_test.rb

@@ -26,7 +26,10 @@ class StartupConfigTest < Test::Unit::TestCase
 
     context "at runtime" do
       setup do
-        @config = StartupConfig.new([:default_action, :another_action], :default_action, {:defopt => 42})
+        @config = StartupConfig.new(
+          [:default_action, :another_action],
+          :default_action,
+          {:defopt => 42})
       end
 
       should "use the default command when given no command as a cmdline argument" do
@@ -48,7 +51,7 @@ class StartupConfigTest < Test::Unit::TestCase
         end
       end
 
-      context "when given cmdline args and no config file" do
+      context "when given cmdline args and no config file and no environment variables" do
         setup do
           @cmd_args = %w{--opt bar --another_opt baz another_action left overs}
           @config.parse(@cmd_args) do |args|
@@ -61,7 +64,7 @@ class StartupConfigTest < Test::Unit::TestCase
           assert_equal "baz", @config.options[:nopt]
         end
 
-        should "override default options with the options given as cmdline args" do
+        should "override the default value for the option given as a cmdline arg" do
           assert_equal 56, @config.options[:defopt]
         end
 
@@ -78,7 +81,7 @@ class StartupConfigTest < Test::Unit::TestCase
         end
       end
 
-      context "when given no cmdline args and a config file" do
+      context "when given a config file and no cmdline args and no environment variables" do
         setup do
           @config.parse([], TEST_CONFIG_FILE)
         end
@@ -87,24 +90,69 @@ class StartupConfigTest < Test::Unit::TestCase
           assert_equal false, @config.options[:colors]
         end
 
-        should "override default options with the options given from the config file" do
+        should "override the default value for the option given from the config file" do
           assert_equal 78, @config.options[:defopt]
         end
       end
 
-      context "when given an option both as a cmdline option and in a config file" do
+      context "when given an environment variable and no cmdline args no config file" do
         setup do
-          @config.parse(%w{--colors}, TEST_CONFIG_FILE) do |args|
+          ENV['colors'] = "baba"
+          ENV['defopt'] = "zaza"
+          ENV['blank'] = ""
+          @config.parse([], nil, [:colors, :defopt])
+        end
+
+        should "have the parsed option defined" do
+          assert_equal "baba", @config.options[:colors]
+        end
+
+        should "override default value for the option given as an environment variable" do
+          assert_equal "zaza", @config.options[:defopt]
+        end
+
+        should "not pass blank environment variable" do
+          assert_equal nil, @config.options[:blank]
+        end
+
+        teardown do
+          ENV['colors'] = ENV['defopt'] = ENV['blank'] = nil
+        end
+      end
+
+      context "when given an option as a cmdline option and in a config file and as an environment variable" do
+        setup do
+          @config.parse(%w{--colors}, TEST_CONFIG_FILE, [:colors, :defopt]) do |args|
             args.clear
             {:defopt => 56, :colors => true}
           end
         end
 
-        should "the command line option should override the config file option" do
+        should "the command line option should override all other option sources" do
           assert_equal true, @config.options[:colors]
           assert_equal 56, @config.options[:defopt]
         end
       end
+
+      context "when given an option from a config file and as an environment variable" do
+        setup do
+          ENV['colors'] = "baba"
+          ENV['defopt'] = "zaza"
+          @config.parse(%w{}, TEST_CONFIG_FILE, [:colors, :defopt]) do |args|
+            args.clear
+            {}
+          end
+        end
+
+        should "the config file option should override environment variable" do
+          assert_equal false, @config.options[:colors]
+          assert_equal 78, @config.options[:defopt]
+        end
+
+        teardown do
+          ENV['colors'] = ENV['defopt'] = nil
+        end
+      end
     end
   end
 end

data/test/util_test.rb

@@ -111,50 +111,47 @@ class UtilTest < Test::Unit::TestCase
   end
 
   context "for percent-encoding strings" do
-    should "not encode safe characters" do
-      assert_equal "a", Util.percent_encode("a")
-      assert_equal "B", Util.percent_encode("B")
-      assert_equal "3", Util.percent_encode("3")
-      assert_equal ".", Util.percent_encode(".")
-      assert_equal "-", Util.percent_encode("-")
-      assert_equal "_", Util.percent_encode("_")
+    %w{a B 3 . - _}.each do |char|
+      should "not encode safe characters, case '#{char}'" do
+        assert_equal char, Util.percent_encode(char)
+      end
     end
 
     should "encode space character with percent-encoding, not with '+' character" do
       assert_equal "%20", Util.percent_encode(" ")
     end
 
-    should "encode unsafe characters that URI.encode leaves by default unencoded" do
-      assert_equal "&",   URI.encode("&")
-      assert_equal "%26", Util.percent_encode("&")
-      assert_equal "?",   URI.encode("?")
-      assert_equal "%3F", Util.percent_encode("?")
-      assert_equal "/",   URI.encode("/")
-      assert_equal "%2F", Util.percent_encode("/")
-      assert_equal ":",   URI.encode(":")
-      assert_equal "%3A", Util.percent_encode(":")
-      assert_equal ",",   URI.encode(",")
-      assert_equal "%2C", Util.percent_encode(",")
+    [
+      %w{& %26},
+      %w{? %3F},
+      %w{/ %2F},
+      %w{: %3A},
+      %w{, %2C}
+    ].each do |input, expected|
+      should "encode unsafe characters that URI.encode leaves by default unencoded, case '#{input}'" do
+        assert_equal input, URI.encode(input)
+        assert_equal expected, Util.percent_encode(input)
+      end
     end
   end
 
   context "for unescaping HTML" do
-    should "not affect already unescaped characters" do
-      assert_equal "a", Util.unescape_html("a")
-      assert_equal "B", Util.unescape_html("B")
-      assert_equal "3", Util.unescape_html("3")
-      assert_equal ".", Util.unescape_html(".")
-      assert_equal "-", Util.unescape_html("-")
-      assert_equal "_", Util.unescape_html("_")
-      assert_equal "+", Util.unescape_html("+")
-    end
-
-    should "unescape HTML-escaped characters" do
-      assert_equal "<",  Util.unescape_html("&lt;")
-      assert_equal ">",  Util.unescape_html("&gt;")
-      assert_equal "&",  Util.unescape_html("&amp;")
-      assert_equal "\"", Util.unescape_html("&quot;")
-      assert_equal " ",  Util.unescape_html("&nbsp;")
+    %w{a B 3 . - _ +}.each do |char|
+      should "not affect already unescaped characters, case '#{char}'" do
+        assert_equal char, Util.unescape_html(char)
+      end
+    end
+
+    [
+      %w{&lt;   <},
+      %w{&gt;   >},
+      %w{&amp;  &},
+      %w{&quot; "},
+      %W{&nbsp; \ }
+    ].each do |input, expected|
+      should "unescape HTML-escaped characters, case '#{input}'" do
+        assert_equal expected, Util.unescape_html(input)
+      end
     end
   end
 

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: tweetwine
 version: !ruby/object:Gem::Version 
-  version: 0.2.8
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Tuomas Kareinen
@@ -9,19 +14,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-17 00:00:00 +02:00
+date: 2010-02-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rest-client
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: A simple but tasty Twitter agent for command line use, made for fun.
 email: tkareine@gmail.com
 executables: 
@@ -38,6 +47,7 @@ files:
 - CHANGELOG.rdoc
 - README.rdoc
 - bin/tweetwine
+- contrib/tweetwine-completion.bash
 - example/example_helper.rb
 - example/fixtures/home.json
 - example/fixtures/mentions.json
@@ -53,6 +63,7 @@ files:
 - example/show_metadata_example.rb
 - example/show_user_example.rb
 - example/update_status_example.rb
+- example/use_http_proxy_example.rb
 - lib/tweetwine/cli.rb
 - lib/tweetwine/client.rb
 - lib/tweetwine/io.rb
@@ -80,7 +91,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- tweetwine 0.2.8
+- tweetwine 0.2.9
 - --main
 - README.rdoc
 - --exclude
@@ -92,18 +103,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A simple Twitter agent for command line use