tweetwine 0.2.11 → 0.2.12

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 0.2.12 released 2010-04-17
+
+* Since this is a command line application, provide documentation as gem
+  manual
+* Fix highlighting of URLs when partial URLs match
+* Improve test code structure
+
 === 0.2.11 released 2010-02-28
 
 * Fix compatibility with rest-client 1.4.0

data/{MIT-LICENSE.txt → LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2010 Tuomas Kareinen.
+Copyright (c) 2009-2010 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

@@ -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/Rakefile

@@ -1,94 +1,75 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+# coding: utf-8
 
-require "rubygems"
+require "rake/clean"
 
+$LOAD_PATH.unshift(File.expand_path("../lib/", __FILE__))
 name = "tweetwine"
-require "#{name}"
+require "#{name}/meta"
 version = Tweetwine::VERSION.dup
 
-require "rake/clean"
+namespace :gem do
+  CLOBBER.include "#{name}-*.gem"
 
-require "rake/gempackagetask"
-spec = Gem::Specification.new do |s|
-  s.name = name
-  s.version = version
-  s.homepage = "http://github.com/tuomas/tweetwine"
-  s.summary = "A simple Twitter agent for command line use"
-  s.description = "A simple but tasty Twitter agent for command line use, made for fun."
-
-  s.author = "Tuomas Kareinen"
-  s.email = "tkareine@gmail.com"
-
-  s.platform = Gem::Platform::RUBY
-  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")
-
-  s.has_rdoc = true
-  s.extra_rdoc_files = FileList["MIT-LICENSE.txt", "*.rdoc"].to_a
-  s.rdoc_options << "--title"   << "#{name} #{version}" \
-                 << "--main"    << "README.rdoc" \
-                 << "--exclude" << "test" \
-                 << "--line-numbers"
-end
+  file "#{name}.gem" => :"man:build" do |f|
+    sh %{gem build #{name}.gemspec}
+  end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = true
-end
+  desc "Package the software as a gem"
+  task :build => [:"test:all", "#{name}.gem"]
 
-desc "Generate a gemspec file"
-task :gemspec do
-  File.open("#{spec.name}.gemspec", "w") do |f|
-    f.write spec.to_ruby
+  desc "Install the software as a gem"
+  task :install => :build do
+    sh %{gem install #{name}-#{version}.gem}
   end
-end
 
-desc "Install the software as a gem"
-task :install => [:package] do
-  sh %{gem install pkg/#{name}-#{version}.gem}
+  desc "Uninstall the gem"
+  task :uninstall => :clean do
+    sh %{gem uninstall #{name}}
+  end
 end
 
-desc "Uninstall the gem"
-task :uninstall => [:clean] do
-  sh %{gem uninstall #{name}}
-end
+namespace :man do
+  CLOBBER.include "man/#{name}.?", "man/#{name}.?.html"
 
-require "rake/rdoctask"
-desc "Create documentation"
-Rake::RDocTask.new(:rdoc) do |rd|
-  rd.rdoc_dir = "rdoc"
-  rd.title = "#{name} #{version}"
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("MIT-LICENSE.txt", "*.rdoc", "lib/**/*.rb")
-  rd.options << "--line-numbers"
-end
+  desc "Build the manual"
+  task :build 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
 
-require "rake/testtask"
-desc "Run tests"
-Rake::TestTask.new(:test) do |t|
-  t.test_files = FileList["test/**/*_test.rb"]
-  t.verbose = true
-  t.warning = true
-  t.ruby_opts << "-rrubygems"
-  t.libs << "test"
+  desc "Show the manual section 7"
+  task :show7 => :build do
+    sh "man man/#{name}.7"
+  end
 end
 
-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"
+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"
+  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
+
+  desc "Run all tests"
+  task :all => [:unit, :example]
 end
 
 desc "Find code smells"
@@ -96,9 +77,9 @@ task :roodi do
   sh %{roodi "**/*.rb"}
 end
 
-desc "Search unfinished parts of source code"
+desc "Show parts of the project tagged as incomplete"
 task :todo do
-  FileList["**/*.rb", "**/*.rdoc", "**/*.txt"].egrep /(TODO|FIXME)/
+  FileList["**/*.*"].egrep /(TODO|FIXME)/
 end
 
-task :default => [:test, :example]
+task :default => :"test:all"

data/bin/tweetwine

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# coding: utf-8
 
 EXIT_SIGINT = 6
 

data/example/example_helper.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 %w{
   coulda
   matchy
@@ -37,7 +39,7 @@ module Tweetwine
 
     def fixture(filename)
       contents = nil
-      filepath = File.dirname(__FILE__) << "/fixtures/" << filename
+      filepath = File.dirname(__FILE__) << "/fixture/" << filename
       File.open(filepath) do |f|
         contents = f.readlines.join("\n")
       end

data/example/search_statuses_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "http://search.twitter.com/search.json?q=braid%20game&rpp=2&page=1", :body => fixture("search.json"))

data/example/show_followers_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/followers/#{TEST_USER}.json", :body => fixture("users.json"))

data/example/show_friends_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/friends/#{TEST_USER}.json", :body => fixture("users.json"))

data/example/show_home_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/home_timeline.json?count=20&page=1", :body => fixture("home.json"))

data/example/show_mentions_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/mentions.json?count=20&page=1", :body => fixture("mentions.json"))

data/example/show_metadata_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 Feature "show metadata" do

data/example/show_user_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/user_timeline/#{TEST_USER}.json?count=20&page=1", :body => fixture("user.json"))

data/example/update_status_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:post, "https://#{TEST_AUTH}@twitter.com/statuses/update.json", :body => fixture("update.json"))

data/example/use_http_proxy_example.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "example_helper"
 
 FakeWeb.register_uri(:get, "https://#{TEST_AUTH}@twitter.com/statuses/home_timeline.json?count=20&page=1", :body => fixture("home.json"))

data/lib/tweetwine/cli.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "optparse"
 
 module Tweetwine

data/lib/tweetwine/client.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "json"
 require "uri"
 

data/lib/tweetwine/io.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+
+require "strscan"
 require "uri"
 
 module Tweetwine
@@ -92,11 +95,9 @@ module Tweetwine
     def format_status(status)
       status = Util.unescape_html(status)
       if @colors
-        status = colorize_all_by_group(:yellow, status, USERNAME_REGEX)
-        status = colorize_all_by_group(:magenta, status, HASHTAG_REGEX)
-        URI.extract(status, ["http", "https"]).uniq.each do |url|
-          status = colorize_all(:cyan, status, url)
-        end
+        status = colorize_matching(:yellow, status, USERNAME_REGEX)
+        status = colorize_matching(:magenta, status, HASHTAG_REGEX)
+        status = colorize_matching(:cyan, status, URI.extract(status, ["http", "https"]).uniq)
       end
       status
     end
@@ -114,12 +115,16 @@ module Tweetwine
       end
     end
 
-    def colorize_all(color, str, pattern)
-      str.gsub(pattern) { |s| colorize_str(COLOR_CODES[color.to_sym], s) }
-    end
-
-    def colorize_all_by_group(color, str, pattern)
-      Util.str_gsub_by_group(str, pattern) { |s| colorize_str(COLOR_CODES[color.to_sym], s) }
+    def colorize_matching(color, str, pattern)
+      regexp = case pattern
+      when Array
+        Regexp.union(pattern.map { |p| Regexp.new(Regexp.escape(p)) })
+      when Regexp
+        pattern
+      else
+        raise "Unknown kind of pattern"
+      end
+      Util.str_gsub_by_group(str, regexp) { |s| colorize(color, s) }
     end
 
     def colorize(color, str)

data/lib/tweetwine/meta.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 module Tweetwine
-  VERSION = "0.2.11".freeze
+  VERSION = "0.2.12".freeze
 end

data/lib/tweetwine/options.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 module Tweetwine
   class Options
     def initialize(options, source = nil)

data/lib/tweetwine/retrying_http.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "rest_client"
 
 module Tweetwine

data/lib/tweetwine/startup_config.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "yaml"
 
 module Tweetwine

data/lib/tweetwine/url_shortener.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 module Tweetwine
   class UrlShortener
     def initialize(http_client, options)

data/lib/tweetwine/util.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require "cgi"
 require "time"
 require "uri"
@@ -44,19 +46,20 @@ module Tweetwine
 
     def self.str_gsub_by_group(str, regexp)
       dup_str = str.dup
-      index, dup_index = 0, 0
-      while index < str.size && (match_data = regexp.match(str[index..-1]))
+      str_pos, dup_pos = 0, 0
+      while str_pos < str.size && (match_data = regexp.match(str[str_pos..-1]))
         matching_group_indexes = indexes_of_filled_matches(match_data)
 
         matching_group_indexes.each do |i|
           replacement = (yield match_data[i]).to_s
-          dup_str[dup_index + match_data.begin(i), match_data[i].size] = replacement
+          dup_str[dup_pos + match_data.begin(i), match_data[i].size] = replacement
           replacement_delta = replacement.size - match_data[i].size
-          dup_index += replacement_delta
+          dup_pos += replacement_delta
         end
+
         skip_delta = match_data.end(0)
-        index += skip_delta
-        dup_index += skip_delta
+        str_pos += skip_delta
+        dup_pos += skip_delta
       end
       dup_str
     end

data/lib/tweetwine.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 %w{
   meta
   util

data/man/tweetwine.1

@@ -0,0 +1,109 @@
+.\" generated with Ronn/v0.5
+.\" http://github.com/rtomayko/ronn/
+.
+.TH "TWEETWINE" "1" "April 2010" "Tuomas Kareinen" "Tweetwine Manual"
+.
+.SH "NAME"
+\fBtweetwine\fR \-\- a simple Twitter command line agent
+.
+.SH "SYNOPSIS"
+.
+.nf
+
+tweetwine [ <GLOBAL_OPTIONS> ]
+tweetwine [ <GLOBAL_OPTIONS> ] <COMMAND> [ <COMMAND_OPTIONS> ]
+.
+.fi
+.
+.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
+\fICOMMAND\fR is one of
+.
+.IP "\(bu" 4
+\fBfollowers\fR,
+.
+.IP "\(bu" 4
+\fBfriends\fR,
+.
+.IP "\(bu" 4
+\fBhome\fR,
+.
+.IP "\(bu" 4
+\fBmentions\fR,
+.
+.IP "\(bu" 4
+\fBsearch\fR,
+.
+.IP "\(bu" 4
+\fBupdate\fR, or
+.
+.IP "\(bu" 4
+\fBuser\fR.
+.
+.IP "" 0
+.
+.P
+The default is \fBhome\fR.
+.
+.SH "OPTIONS"
+Options given from command line override corresponding settings from
+configuration (\fB~/.tweetwine\fR).
+.
+.P
+\fIGLOBAL_OPTIONS\fR are:
+.
+.TP
+\fB\-a\fR, \fB\-\-auth USERNAME:PASSWORD\fR
+Authentication.
+.
+.TP
+\fB\-c\fR, \fB\-\-[no\-]colors\fR
+Colorize output with ANSI escape codes.
+.
+.TP
+\fB\-n\fR, \fB\-\-num N\fR
+The number of statuses in page, default 20.
+.
+.TP
+\fB\-\-[no\-]http\-proxy URL\fR
+Use proxy for HTTP and HTTPS.
+.
+.TP
+\fB\-\-no\-url\-shorten\fR
+Do not shorten URLs for status update.
+.
+.TP
+\fB\-p\fR, \fB\-\-page N\fR
+The page number for statuses, default 1.
+.
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show version information and exit.
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show help message and exit.
+.
+.P
+In order to see \fICOMMAND_OPTIONS\fR, enter:
+.
+.IP "" 4
+.
+.nf
+
+$ tweetwine help <COMMAND>
+.
+.fi
+.
+.IP "" 0
+.
+.SH "COPYRIGHT"
+Tweetwine is Copyright (c) 2009\-2010 Tuomas Kareinen
+.
+.SH "SEE ALSO"
+tweetwine(7), \fIhttp://github.com/tuomas/tweetwine\fR