tweetwine 0.2.12 → 0.3.0

data/lib/tweetwine/url_shortener.rb

@@ -2,30 +2,36 @@
 
 module Tweetwine
   class UrlShortener
-    def initialize(http_client, options)
-      @http_client = http_client
-      options = Options.new(options, "URL shortening")
+    def initialize(options)
+      raise "UrlShortener should be disabled" if options[:disable]
       @method = (options[:method] || :get).to_sym
-      @service_url = options.require :service_url
-      @url_param_name = options.require :url_param_name
-      @extra_params = options[:extra_params] || {}
+      unless [:get, :post].include? @method
+        raise CommandLineError, "Unsupported HTTP request method for URL shortening: #{@method}"
+      end
+      @service_url    = require_option options, :service_url
+      @url_param_name = require_option options, :url_param_name
+      @xpath_selector = require_option options, :xpath_selector
+      @extra_params   = options[:extra_params] || {}
       if @method == :get
         tmp = []
         @extra_params.each_pair { |k, v| tmp << "#{k}=#{v}" }
         @extra_params = tmp
       end
-      @xpath_selector = options.require :xpath_selector
     end
 
     def shorten(url)
       require "nokogiri"
-      response = @http_client.send(@method, *get_service_url_and_params(url))
+      response = CLI.http.send(@method, *get_service_url_and_params(url))
       doc = Nokogiri::HTML(response)
       doc.xpath(@xpath_selector).first.to_s
     end
 
     private
 
+    def require_option(options, key)
+      options[key] or raise RequiredOptionError.new(key, :url_shortener)
+    end
+
     def get_service_url_and_params(url_to_shorten)
       case @method
       when :get
@@ -38,7 +44,7 @@ module Tweetwine
         params = @extra_params.merge({ @url_param_name.to_sym => url_to_shorten })
         [service_url, params]
       else
-        raise "Unrecognized HTTP request method"
+        raise "Unrecognized HTTP request method; should have been supported"
       end
     end
   end

data/lib/tweetwine/util.rb

@@ -6,7 +6,13 @@ require "uri"
 
 module Tweetwine
   module Util
-    def self.humanize_time_diff(from, to)
+    extend self
+
+    def blank?(str)
+      str.nil? || str.empty?
+    end
+
+    def humanize_time_diff(from, to)
       from = Time.parse(from.to_s) unless from.is_a? Time
       to = Time.parse(to.to_s) unless to.is_a? Time
 
@@ -22,16 +28,15 @@ module Tweetwine
       [value, pluralize_unit(value, unit)]
     end
 
-    def self.symbolize_hash_keys(hash)
-      hash.inject({}) do |result, pair|
-        value = pair.last
-        value = symbolize_hash_keys(value) if value.is_a? Hash
-        result[pair.first.to_sym] = value
-        result
-      end
+    def stringify_hash_keys(hash)
+      recursive_copy_hash(hash) { |key, value| [key.to_s, value] }
     end
 
-    def self.parse_int_gt(value, default, min, name_for_error)
+    def symbolize_hash_keys(hash)
+      recursive_copy_hash(hash) { |key, value| [key.to_sym, value] }
+    end
+
+    def parse_int_gt(value, default, min, name_for_error)
       if value
         value = value.to_i
         if value >= min
@@ -44,7 +49,7 @@ module Tweetwine
       end
     end
 
-    def self.str_gsub_by_group(str, regexp)
+    def str_gsub_by_group(str, regexp)
       dup_str = str.dup
       str_pos, dup_pos = 0, 0
       while str_pos < str.size && (match_data = regexp.match(str[str_pos..-1]))
@@ -64,15 +69,15 @@ module Tweetwine
       dup_str
     end
 
-    def self.percent_encode(str)
+    def percent_encode(str)
       URI.escape(str.to_s, /[^#{URI::PATTERN::UNRESERVED}]/)
     end
 
-    def self.unescape_html(str)
+    def unescape_html(str)
       CGI.unescapeHTML(str.gsub('&nbsp;', ' '))
     end
 
-    def self.find_hash_path(hash, path)
+    def find_hash_path(hash, path)
       return nil if hash.nil?
       path = [path] unless path.is_a? Array
       path.inject(hash) do |result, key|
@@ -83,14 +88,24 @@ module Tweetwine
 
     private
 
-    def self.pluralize_unit(value, unit)
+    def recursive_copy_hash(hash, &pair_modifier)
+      hash.inject({}) do |result, pair|
+        value = pair.last
+        value = recursive_copy_hash(value, &pair_modifier) if value.is_a? Hash
+        key, value = pair_modifier.call(pair.first, value)
+        result[key] = value
+        result
+      end
+    end
+
+    def pluralize_unit(value, unit)
       if ["hour", "day"].include?(unit) && value > 1
         unit = unit + "s"
       end
       unit
     end
 
-    def self.indexes_of_filled_matches(match_data)
+    def indexes_of_filled_matches(match_data)
       if match_data.size > 1
         (1...match_data.size).to_a.reject { |i| match_data[i].nil? }
       else

data/lib/tweetwine.rb

@@ -1,15 +1,75 @@
 # coding: utf-8
 
-%w{
-  meta
-  util
-  options
-  startup_config
-  io
-  retrying_http
-  url_shortener
-  client
-  cli
-}.each do |f|
-  require "tweetwine/#{f}"
+gem 'oauth', '~> 0.4.4'
+
+module Tweetwine
+  VERSION = '0.3.0'.freeze
+
+  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
+
+  lib_path = File.expand_path(File.dirname(__FILE__))
+
+  require "#{lib_path}/tweetwine/basic_object"
+
+  autoload :CharacterEncoding,  "#{lib_path}/tweetwine/character_encoding"
+  autoload :CLI,                "#{lib_path}/tweetwine/cli"
+  autoload :Config,             "#{lib_path}/tweetwine/config"
+  autoload :Http,               "#{lib_path}/tweetwine/http"
+  autoload :OAuth,              "#{lib_path}/tweetwine/oauth"
+  autoload :Obfuscate,          "#{lib_path}/tweetwine/obfuscate"
+  autoload :OptionParser,       "#{lib_path}/tweetwine/option_parser"
+  autoload :Promise,            "#{lib_path}/tweetwine/promise"
+  autoload :Twitter,            "#{lib_path}/tweetwine/twitter"
+  autoload :UI,                 "#{lib_path}/tweetwine/ui"
+  autoload :UrlShortener,       "#{lib_path}/tweetwine/url_shortener"
+  autoload :Util,               "#{lib_path}/tweetwine/util"
 end

data/man/tweetwine.7

@@ -1,16 +1,16 @@
-.\" generated with Ronn/v0.5
-.\" http://github.com/rtomayko/ronn/
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "TWEETWINE" "7" "April 2010" "Tuomas Kareinen" "Tweetwine Manual"
+.TH "TWEETWINE" "7" "November 2010" "Tuomas Kareinen" "Tweetwine Manual"
 .
 .SH "NAME"
-\fBtweetwine\fR \-\- a simple Twitter command line agent
+\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.
+Tweetwine is designed for checking the latest tweets from the command line quickly\.
+.
+.P
+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\.
 .
 .P
 Features:
@@ -22,8 +22,7 @@ Simple to use command line interface, with Bash completion support
 ANSI coloring of statuses, but in discreet manner
 .
 .IP "\(bu" 4
-Supports shortening URLs in a status update with a configurable shortening
-service
+Supports shortening URLs in a status update with a configurable shortening service
 .
 .IP "\(bu" 4
 Configuration file for preferred settings
@@ -44,14 +43,13 @@ $ gem install tweetwine
 .IP "" 0
 .
 .P
-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\.
 .
 .P
-The program requires \fIrest\-client\fR
-gem to be installed. In addition, the program needs \fIjson\fR gem on Ruby 1.8.
+The program requires oauth \fIhttp://oauth\.rubyforge\.org/\fR gem to be installed\. In addition, the program needs json \fIhttp://json\.rubyforge\.org/\fR gem on Ruby 1\.8\.
 .
 .P
-Documentation is provided as gem man pages. Use \fIgem\-man\fR to see them:
+This documentation page is also provided as a manual page\. Use gem\-man \fIhttp://github\.com/defunkt/gem\-man\fR to see it:
 .
 .IP "" 4
 .
@@ -70,139 +68,115 @@ In the command line, run the program by entering
 .
 .nf
 
-$ tweetwine [ <GLOBAL_OPTIONS> ] [ <COMMAND> ] [ <COMMAND_OPTIONS> ]
+$ 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:
+For all the global options and commands, see:
 .
 .IP "" 4
 .
 .nf
 
-username: <your_username>
-password: <your_password>
-colors: true|false
+$ tweetwine help
 .
 .fi
 .
 .IP "" 0
 .
 .P
-For all the global options and commands, see:
+For information about a specific command and its options, enter:
 .
 .IP "" 4
 .
 .nf
 
-$ tweetwine help
+$ tweetwine help <command>
 .
 .fi
 .
 .IP "" 0
 .
 .P
-For information about a specific command and its options, enter:
+In order to use to use the program, you must authorize it to access your account on Twitter\. This is done with OAuth \fIhttp://dev\.twitter\.com/pages/oauth_faq\fR 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 \fB~/\.tweetwine\fR\. The file serves as your configuration file\.
+.
+.P
+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\.
+.
+.P
+The configuration file is in YAML syntax\. In addition to the OAuth access token, the program recognizes the following settings:
 .
 .IP "" 4
 .
 .nf
 
-$ tweetwine help <COMMAND>
+colors: true|false
+username: <your_username>
 .
 .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:
+.SS "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 \fBshorten_urls\fR field in the configuration file; for example:
 .
 .IP "" 4
 .
 .nf
 
 username: spoonman
-password: withyourhands
 colors: true
 shorten_urls:
-  enable: true
-  service_url: http://is.gd/create.php
+  service_url: http://is\.gd/create\.php
   method: post
   url_param_name: URL
-  xpath_selector: //input[@id='short_url']/@value
+  xpath_selector: //input[@id=\'short_url\']/@value
+  disable: false    # optional
 .
 .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.
+The supported HTTP request methods (in \fBmethod\fR field) 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 field, as a hash\.
 .
 .P
-The \fBxpath_selector\fR is needed to extract the shortened URL from the result.
+The \fBxpath_selector\fR field is needed to locate the HTML element which contains the shortened URL from the HTTP response\.
 .
 .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
+URL shortening can be disabled by not defining \fBshorten_urls\fR field in the configuration file, or by setting optional field \fBdisable\fR to true\. In order to disable shortening only temporarily, use the command line option \fB\-\-no\-url\-shorten\fR\.
 .
 .P
-\fINOTE:\fR The use of the feature requires \fInokogiri\fR gem
-to be installed.
+\fINOTE:\fR The use of URL shortening requires nokogiri \fIhttp://nokogiri\.org/\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.
+If \fB$http_proxy\fR environment variable is set, Tweetwine attempts to use the URL in the environment variable as HTTP proxy for 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:
+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
+\&\. 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):
+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
+if [ \-f <path_to_tweetwine>/contrib/tweetwine\-completion\.bash ]; then
+    \. <path_to_tweetwine>/contrib/tweetwine\-completion\.bash
 fi
 .
 .fi
@@ -210,7 +184,7 @@ fi
 .IP "" 0
 .
 .SH "COPYRIGHT"
-Tweetwine is Copyright (c) 2009\-2010 Tuomas Kareinen
+Tweetwine is Copyright (c) 2009\-2010 Tuomas Kareinen\.
 .
 .SH "SEE ALSO"
-tweetwine(1), \fIhttp://github.com/tuomas/tweetwine\fR
+\fIhttp://github\.com/tuomas/tweetwine\fR

data/man/tweetwine.7.ronn

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