tweetwine 0.2.12 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 0.3.0 released 2010-11-11
+
+* OAuth for authentication and authorization
+* Almost complete rewrite of the implementation with a lot of tests
+* Configurable config file location with <tt>-f</tt> option
+* Ensure encoding status update in UTF-8
+
 === 0.2.12 released 2010-04-17
 
 * Since this is a command line application, provide documentation as gem

data/Gemfile

@@ -0,0 +1,17 @@
+source :rubygems
+
+gem "nokogiri", "~> 1.4.3"
+gem "oauth",    "~> 0.4.4"
+gem "json",     ">= 1.0.0", :platforms => [:ruby_18, :jruby]
+
+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.5.0"
+end

data/README.md

@@ -3,10 +3,13 @@ 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.
+Tweetwine is designed for checking the latest tweets from the command line
+quickly.
+
+The program can show the home timeline of the authenticated user, the latest
+tweets of friends and followers, and the latest tweets that mention the user.
+If that's not enough, Tweetwine can search statuses with arbitrary terms and
+send status updates.
 
 Features:
 
@@ -22,14 +25,14 @@ Install Tweetwine with RubyGems:
 
     $ gem install tweetwine
 
-The program is compatible with both Ruby 1.8 and 1.9.
+The program is tested with Ruby 1.8.7 and 1.9.2.
 
-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.
+The program requires [oauth](http://oauth.rubyforge.org/) 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:
+This documentation page is also provided as a manual page. Use
+[gem-man](http://github.com/defunkt/gem-man) to see it:
 
     $ gem man tweetwine
 
@@ -37,19 +40,7 @@ Documentation is provided as gem man pages. Use
 
 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
+    $ tweetwine [global_options..] [command] [command_options...]
 
 For all the global options and commands, see:
 
@@ -57,46 +48,65 @@ For all the global options and commands, see:
 
 For information about a specific command and its options, enter:
 
-    $ tweetwine help <COMMAND>
+    $ tweetwine help <command>
+
+In order to use to use the program, you must authorize it to access your
+account on Twitter. This is done with
+[OAuth](http://dev.twitter.com/pages/oauth_faq) protocol, and it is required
+when the program is launched for the first time. After that, Tweetwine
+remembers the access you granted by storing the access token into
+`~/.tweetwine`. The file serves as your configuration file.
 
-### URL shortening for status update
+Because the access token is sensitive information, Tweetwine obfuscates it
+when storing it into the configuration file. While this prevents simple plain
+text reading attempts of the access token, it is not secure. You should
+restrict access to the file only to yourself. If the configuration file does
+not exist before running the program, Tweetwine sets the file accessible only
+to you when storing the access token.
 
-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:
+The configuration file is in YAML syntax. In addition to the OAuth access
+token, the program recognizes the following settings:
+
+    colors: true|false
+    username: <your_username>
+
+### URL shortening for a status update
+
+Before actually sending a new status update, it is possible for the software
+to shorten the URLs in the tweet by using an external web service. This can be
+enabled via `shorten_urls` field in the 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
+      disable: false    # optional
 
-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.
+The supported HTTP request methods (in `method` field) 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` field, as a hash.
 
-URL shortening can be disabled by
+The `xpath_selector` field is needed to locate the HTML element which contains
+the shortened URL from the HTTP response.
 
-* not defining `shorten_urls` key in the configuration file,
-* setting key `enable` to `false`, or
-* using the command line option `--no-url-shorten`.
+URL shortening can be disabled by not defining `shorten_urls` field in the
+configuration file, or by setting optional field `disable` to true. In order
+to disable shortening only temporarily, use the command line option
+`--no-url-shorten`.
 
-*NOTE:* The use of the feature requires [nokogiri](http://nokogiri.org/) gem
-to be installed.
+*NOTE:* The use of URL shortening 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.
+URL in the environment variable as HTTP proxy for its HTTP connections. This
+setting can be overridden with `--http-proxy` and `--no-http-proxy` command
+line options.
 
 ### Bash command line completion support
 
@@ -115,8 +125,8 @@ snippet to your Bash initialization script (such as `~/.bashrc`):
 
 ## COPYRIGHT
 
-Tweetwine is Copyright (c) 2009-2010 Tuomas Kareinen
+Tweetwine is Copyright (c) 2009-2010 Tuomas Kareinen.
 
 ## SEE ALSO
 
-tweetwine(1), <http://github.com/tuomas/tweetwine>
+<http://github.com/tuomas/tweetwine>

data/Rakefile

@@ -4,18 +4,18 @@ require "rake/clean"
 
 $LOAD_PATH.unshift(File.expand_path("../lib/", __FILE__))
 name = "tweetwine"
-require "#{name}/meta"
+require name
 version = Tweetwine::VERSION.dup
 
 namespace :gem do
   CLOBBER.include "#{name}-*.gem"
 
-  file "#{name}.gem" => :"man:build" do |f|
+  file "#{name}-#{version}.gem" do |f|
     sh %{gem build #{name}.gemspec}
   end
 
   desc "Package the software as a gem"
-  task :build => [:"test:all", "#{name}.gem"]
+  task :build => [:"man:build", :"test:all", "#{name}-#{version}.gem"]
 
   desc "Install the software as a gem"
   task :install => :build do
@@ -36,37 +36,28 @@ namespace :man do
     sh "ronn -br5 --manual='#{name.capitalize} Manual' --organization='Tuomas Kareinen' man/*.ronn"
   end
 
-  desc "Show the manual section 1"
-  task :show1 => :build do
-    sh "man man/#{name}.1"
-  end
-
   desc "Show the manual section 7"
-  task :show7 => :build do
+  task :show => :build do
     sh "man man/#{name}.7"
   end
 end
 
 namespace :test do
-  require "rake/testtask"
-
-  desc "Run unit tests"
-  Rake::TestTask.new(:unit) do |t|
-    t.test_files = FileList["test/**/*_test.rb"]
-    t.verbose = true
-    t.warning = true
-    t.ruby_opts << "-rrubygems"
-    t.libs << "test"
+  def create_test_task(type, file_glob, options = {})
+    test_dir  = file_glob[%r{(\w+)/}, 1]
+    test_desc = options[:desc] || "Run #{type} tests"
+    includes  = (options[:includes] || ['lib', test_dir]).map { |dir| "-I #{dir}" }.join(' ')
+    warn_opt  = options[:warn] ? "-w" : ""
+
+    desc test_desc
+    task type do
+      tests = FileList[file_glob].map { |f| "\"#{f[test_dir.size+1 .. -4]}\"" }.join(' ')
+      sh %{bundle exec ruby #{warn_opt} #{includes} -e 'ARGV.each { |f| require f }' #{tests}}
+    end
   end
 
-  desc "Run integration/example tests"
-  Rake::TestTask.new(:example) do |t|
-    t.test_files = FileList["example/**/*_example.rb"]
-    t.verbose = true
-    t.warning = false
-    t.ruby_opts << "-rrubygems"
-    t.libs << "example"
-  end
+  create_test_task :unit,     'test/**/*_test.rb',        :warn => true
+  create_test_task :example,  'example/**/*_example.rb',  :warn => false, :includes => %w{lib test example}, :desc => "Run integration/example tests"
 
   desc "Run all tests"
   task :all => [:unit, :example]

data/bin/tweetwine

@@ -1,16 +1,15 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 
-EXIT_SIGINT = 6
-
-trap("INT") do
-  puts "\nAbort"
-  exit(EXIT_SIGINT)
-end
-
 require "tweetwine"
-
-exec_name = File.basename($0)
-config_file = ENV["HOME"] + "/.#{exec_name}"
-
-Tweetwine::CLI.launch(ARGV, exec_name, config_file)
+include Tweetwine
+
+begin
+  CLI.start ARGV
+rescue Error => e
+  CLI.ui.error e.message
+  exit e.status_code
+rescue Interrupt
+  puts "Abort."
+  exit 1
+end

data/contrib/tweetwine-completion.bash

@@ -1,10 +1,9 @@
-_tweetwine_completion ()
-{
+_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"
+    gopts="--colors --help --http-proxy --num --no-colors --no-http-proxy --no-url-shorten --page --version"
 
     case "${prev}" in
     followers | friends | home | mentions | search | update | user)

data/example/application_behavior_example.rb

@@ -0,0 +1,173 @@
+# coding: utf-8
+
+require "example_helper"
+require "fixture/oauth"
+
+include Tweetwine::Test::Fixture::OAuth
+
+Feature "application behavior" do
+  in_order_to "know about the application"
+  as_a "user"
+  i_want_to "see helpful messages"
+
+  %w{-v version ver v}.each do |arg|
+    Scenario "show version with '#{arg}'" do
+      When "I start the application with '#{arg}'" do
+        @status = start_app [arg] do |_, _, stdout|
+          @output = stdout.readlines.join
+        end
+      end
+
+      Then "the application shows version and exists with success status" do
+        @output.should =~ /\d+\.\d+\.\d+$/
+        @status.exitstatus.should == 0
+      end
+    end
+  end
+
+  %w{-h help}.each do |arg|
+    Scenario "show general help with '#{arg}'" do
+      When "I start the application with '#{arg}'" do
+        @status = start_app [arg] do |_, _, stdout|
+          @output = stdout.readlines.join
+        end
+      end
+
+      Then "the application shows help and exists with success status" do
+        @output.should == <<-END
+A simple but tasty Twitter agent for command line use, made for fun.
+
+Usage: #{CLI::EXEC_NAME} [global_options...] [<command>] [command_options...]
+
+  Global options:
+
+    -c, --colors                     Enable ANSI colors for output.
+    -f, --config <file>              Configuration file (default #{CLI::DEFAULT_CONFIG[:config_file]}).
+    -h, --help                       Show this help and exit.
+        --http-proxy <url>           Enable HTTP(S) proxy.
+        --no-colors                  Disable ANSI colors for output.
+        --no-http-proxy              Disable HTTP(S) proxy.
+        --no-url-shorten             Disable URL shortening.
+    -n, --num <n>                    Number of statuses per page (default 20).
+    -p, --page <p>                   Page number for statuses (default 1).
+    -u, --username <user>            User to authenticate (default '#{USER}').
+    -v, --version                    Show version and exit.
+
+  Commands:
+
+    followers     Show authenticated user's followers and their latest tweets.
+    friends       Show authenticated user's friends and their latest tweets.
+    help          Show help and exit. Try it with <command> argument.
+    home          Show authenticated user's home timeline (the default command).
+    mentions      Show latest tweets that mention or are replies to the authenticated user.
+    search        Search latest public tweets.
+    update        Send new tweet.
+    user          Show user's timeline.
+    version       Show program version and exit.
+        END
+        @status.exitstatus.should == 0
+      end
+    end
+
+    %w{followers friends help home mentions search update user version}.each do |command|
+      Scenario "show command specific help with '#{arg} #{command}'" do
+        When "I start the application with '#{arg} #{command}'" do
+          @status = start_app [arg, command] do |_, _, stdout|
+            @output = stdout.readlines.join
+          end
+        end
+
+        Then "the application shows help about the command and exits with success status" do
+          cmd_class = Tweetwine::CLI.const_get("#{command.capitalize}Command")
+          expected_about = cmd_class.about
+          expected_usage = "Usage: tweetwine #{command} #{cmd_class.usage}".strip
+          @output.should == <<-END
+#{expected_about}
+
+#{expected_usage}
+          END
+          @status.exitstatus.should == 0
+        end
+      end
+    end
+
+    Scenario "show help command's help with '#{arg} <invalid_command>'" do
+      When "I start the application with '#{arg} invalid'" do
+        @status = start_app [arg, 'invalid'] do |_, _, stdout, stderr|
+          @stdout = stdout.readlines.join
+          @stderr = stderr.readlines.join
+        end
+      end
+
+      Then "the application shows help about help command and exits with failure status" do
+        @stderr.should == "ERROR: unknown command: invalid\n\n"
+        @stdout.should == <<-END
+Show help and exit. Try it with <command> argument.
+
+Usage: tweetwine help [<command>]
+
+  If <command> is given, show specific help about that command. If no
+  <command> is given, show general help.
+        END
+        @status.exitstatus.should == CommandLineError.status_code
+      end
+    end
+  end
+
+  Scenario "show error and exit with failure status when invalid option" do
+    When "I start the application with invalid option" do
+      @status = start_app %w{-X} do |_, _, _, stderr|
+        @output = stderr.readlines.join.chomp
+      end
+    end
+
+    Then "the application exists with failure status" do
+      @output.should == 'ERROR: invalid option: -X'
+      @status.exitstatus.should == CommandLineError.status_code
+    end
+  end
+
+  Scenario "show error and exit with failure status when invalid command" do
+    When "I start the application with invalid command" do
+      @status = start_app %w{invalid} do |_, _, _, stderr|
+        @output = stderr.readlines.join.chomp
+      end
+    end
+
+    Then "the application exists with failure status" do
+      @output.should == 'ERROR: unknown command: invalid'
+      @status.exitstatus.should == UnknownCommandError.status_code
+    end
+  end
+
+  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("home.json"))
+      @output = nil
+      @config_contents = nil
+      @config_mode = nil
+      config_file = 'tweetwine.tmp'
+      in_temp_dir do
+        @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/example/example_helper.rb

@@ -3,51 +3,67 @@
 %w{
   coulda
   matchy
-  fakeweb
   open4
   stringio
+  tempfile
   time
   timecop
+  webmock/test_unit
 }.each { |lib| require lib }
 
-FakeWeb.clean_registry
-FakeWeb.allow_net_connect = false
 Timecop.freeze(Time.parse("2009-10-14 01:56:15 +0300"))
 
 require "tweetwine"
+require "test_helper"
 
 module Tweetwine
-  module ExampleHelpers
-    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"
-      executable = File.dirname(__FILE__) << "/../bin/tweetwine"
-      launch_cmd = "ruby -rubygems -I#{lib} -- #{executable} #{args}"
-      Open4::popen4(launch_cmd, &blk)
-    end
+  module Example
+    module Helper
+      include WebMock::API
+      include Test::Helper
 
-    def launch_cli(args, *input)
-      input, output = StringIO.new(input.join("\n")), StringIO.new
-      extra_opts = { :input => input, :output => output }
-      CLI.launch(args, "test", nil, extra_opts)
-      output.string.split("\n")
-    end
+      CONFIG_FILE = File.expand_path('../fixture/config.yaml', __FILE__)
+      PROXY_HOST = "proxy.net"
+      PROXY_PORT = 8123
+      PROXY_URL = "http://#{PROXY_HOST}:#{PROXY_PORT}"
+      USER = "fooman"
+
+      def start_app(args, &blk)
+        lib = File.dirname(__FILE__) << "/../lib"
+        executable = File.dirname(__FILE__) << "/../bin/tweetwine"
+        launch_cmd = "env USER='#{USER}' ruby -rubygems -I#{lib} -- #{executable} -f #{CONFIG_FILE} #{args.join(' ')}"
+        Open4::popen4(launch_cmd, &blk)
+      end
+
+      def start_cli(args, input = [], options = {:config_file => CONFIG_FILE})
+        input, output = StringIO.new(input.join("\n")), StringIO.new
+        options.merge!({ :in => input, :out => output })
+        CLI.start(args, options)
+        output.string.split("\n")
+      end
+
+      def fixture(filename)
+        filepath = File.expand_path("../fixture/#{filename}", __FILE__)
+        File.open(filepath) do |f|
+          f.readlines.join("\n")
+        end
+      end
+
+      def in_temp_dir
+        Dir.mktmpdir do |tmp_dir|
+          Dir.chdir(tmp_dir) do |dir|
+            yield dir
+          end
+        end
+      end
 
-    def fixture(filename)
-      contents = nil
-      filepath = File.dirname(__FILE__) << "/fixture/" << filename
-      File.open(filepath) do |f|
-        contents = f.readlines.join("\n")
+      def read_shorten_config
+        Util.symbolize_hash_keys(YAML.load_file(CONFIG_FILE))[:shorten_urls]
       end
-      contents
     end
   end
 end
 
 include Coulda
 include Tweetwine
-include Tweetwine::ExampleHelpers
+include Tweetwine::Example::Helper

data/example/fixture/config.yaml

@@ -0,0 +1,8 @@
+--- 
+username: fooman
+colors: false
+shorten_urls: 
+  service_url: http://is.gd/create.php
+  method: post
+  url_param_name: URL
+  xpath_selector: //input[@id='short_url']/@value

data/example/fixture/shorten_rubygems.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <input type="text" id="short_url" value="http://is.gd/gGazV" />
+  </body>
+</html>

data/example/fixture/shorten_rubylang.html

@@ -0,0 +1,5 @@
+<html>
+  <body>
+    <input type="text" id="short_url" value="http://is.gd/gGaM3" />
+  </body>
+</html>

data/example/fixture/update_utf8.json

@@ -0,0 +1 @@
+{"favorited":false,"geo":null,"in_reply_to_screen_name":null,"source":"<a href=\"http://apiwiki.twitter.com/\" rel=\"nofollow\">API</a>","in_reply_to_user_id":null,"in_reply_to_status_id":null,"user":{"profile_background_tile":false,"description":"just testing","verified":false,"profile_background_color":"1a1b1f","following":false,"profile_sidebar_fill_color":"24252b","profile_image_url":"","followers_count":0,"statuses_count":1,"time_zone":"Helsinki","profile_sidebar_border_color":"1a1b1f","url":"http://www.twitter.com/fooman","screen_name":"fooman","friends_count":0,"protected":false,"notifications":false,"favourites_count":0,"created_at":"Wed Oct 10 12:00:00 +0000 2009","profile_text_color":"6b6b6b","location":"Finland","name":"Fooman","profile_background_image_url":"http://s.twimg.com/a/1258674567/images/themes/theme5/bg.gif","id":29700570,"geo_enabled":false,"utc_offset":7200,"profile_link_color":"0070cc"},"created_at":"Sat Oct 13 14:23:41 +0000 2009","truncated":false,"id":5919326888,"text":"résumé"}

data/example/fixture/update_with_urls.json

@@ -0,0 +1 @@
+{"favorited":false,"geo":null,"in_reply_to_screen_name":null,"source":"<a href=\"http://apiwiki.twitter.com/\" rel=\"nofollow\">API</a>","in_reply_to_user_id":null,"in_reply_to_status_id":null,"user":{"profile_background_tile":false,"description":"just testing","verified":false,"profile_background_color":"1a1b1f","following":false,"profile_sidebar_fill_color":"24252b","profile_image_url":"","followers_count":0,"statuses_count":1,"time_zone":"Helsinki","profile_sidebar_border_color":"1a1b1f","url":"http://www.twitter.com/fooman","screen_name":"fooman","friends_count":0,"protected":false,"notifications":false,"favourites_count":0,"created_at":"Wed Oct 10 12:00:00 +0000 2009","profile_text_color":"6b6b6b","location":"Finland","name":"Fooman","profile_background_image_url":"http://s.twimg.com/a/1258674567/images/themes/theme5/bg.gif","id":29700570,"geo_enabled":false,"utc_offset":7200,"profile_link_color":"0070cc"},"created_at":"Sat Oct 13 14:23:41 +0000 2009","truncated":false,"id":5919326889,"text":"ruby links: http://is.gd/gGazV http://is.gd/gGaM3"}