tuomas-tweetwine 0.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 released 2009-04-22
+
+* Initial release with minimal functionality.
+* Usable for quickly checking friends' statuses and sending status updates.

data/README.rdoc

@@ -0,0 +1,70 @@
+= Tweetwine
+
+A simple but tasty Twitter agent for command line use, made for fun.
+
+== Installation
+
+Install Tweetwine as a RubyGem from GitHub:
+
+  $ sudo gem install tuomas-tweetwine --source http://gems.github.com
+
+The program is compatible with Ruby 1.9.1.
+
+== Usage
+
+In the command line, run the program by entering
+
+  $ tweetwine [-a username:password] [command]
+
+The program needs the user's username and password for authentication. This
+information can be supplied either as an option to the program or via a
+configuration file. Without option <tt>[-a]</tt>, the program attempts to
+read the configuration file for authentication.
+
+The supported commands are
+
+<tt>friends</tt>:: Fetch friends' statuses (the contents of the user's home).
+<tt>user [name]</tt>:: Fetch a specific user's statuses, identified by the argument; if given no argument, fetch your own statuses.
+<tt>msg [status]</tt>:: Send a status update, but confirm the action first before actually sending. The status update can either be given as an argument or via STDIN if no argument is given.
+
+If <tt>[command]</tt> is not given, it defaults to <tt>friends</tt>.
+
+The configuration file, in <tt>~/.tweetwine</tt>, is in YAML syntax. It can
+contain the following settings:
+
+  username: <your_username>
+  password: <your_password>
+  colorize: true|false 
+
+For all the options, see:
+
+  $ tweetwine -h
+
+== Contacting
+
+Please send feedback by email to Tuomas Kareinen < tkareine (at) gmail (dot)
+com >.
+
+== Legal notes
+
+This software is licensed under the terms of the "MIT license":
+
+Copyright (c) 2009 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 in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,85 @@
+require "rubygems"
+
+full_name = "Tweetwine"
+package_name = "tweetwine"
+version = "0.1.0"
+
+require "lib/#{package_name}"
+
+require "rake/clean"
+
+require "rake/gempackagetask"
+spec = Gem::Specification.new do |s|
+  s.name = package_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", "*.rdoc", "bin/**/*", "lib/**/*", "spec/**/*"].to_a
+  s.executables = ["tweetwine"]
+
+  s.add_dependency("json", ">= 1.1.4")
+  s.add_dependency("rest-client", ">= 0.9.2")
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = FileList["*.rdoc"].to_a
+  s.rdoc_options << "--title"   << "#{full_name} #{version}" \
+                 << "--main"    << "README.rdoc" \
+                 << "--exclude" << "spec" \
+                 << "--line-numbers"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = true
+end
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{spec.name}.gemspec", "w") do |f|
+    f.write spec.to_ruby
+  end
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{package_name}-#{version}.gem}
+end
+
+task :uninstall => [:clean] do
+  sh %{sudo gem uninstall #{package_name}}
+end
+
+require "rake/rdoctask"
+desc "Create documentation"
+Rake::RDocTask.new(:rdoc) do |rd|
+  rd.rdoc_dir = "rdoc"
+  rd.title = "#{full_name} #{version}"
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("*.rdoc", "lib/**/*.rb")
+  rd.options << "--line-numbers"
+end
+
+require "rake/testtask"
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/*_test.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+desc "Find code smells"
+task :roodi do
+  sh %{roodi "**/*.rb"}
+end
+
+desc "Search unfinished parts of source code"
+task :todo do
+  FileList["**/*.rb"].egrep /#.*(TODO|FIXME)/
+end
+
+task :default => :test

data/bin/tweetwine

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "getoptlong"
+require File.dirname(__FILE__) << "/../lib/tweetwine"
+
+include Tweetwine
+
+class HelpNeeded < StandardError; end
+class AlreadyReportedArgumentError < ArgumentError; end
+
+DEFAULT_OPTIONS = {
+  :colorize     => false,
+  :num_statuses => Client::MAX_NUM_STATUSES
+}
+
+def exit_with_error(why = nil)
+  puts "Error: #{why}" if why
+  exit(2)
+end
+
+def exit_with_usage(why = nil)
+  puts "#{why}\n\n" if why
+  puts <<-END
+Usage: tweetwine [options...] [command]
+
+  The program needs the user's username and password for authentication.
+  This information can be given either as an option to the program or via a
+  configuration file. Without option [-a], the program attempts to read the
+  configuration file in YAML format at "~/.tweetwine" for authentication.
+
+  Argument [command] can be one of #{Client::COMMANDS.map {|cmd| "\"#{cmd}\"" }.join(", ")}.
+  If [command] is not given, it defaults to "#{Client::COMMANDS[0]}".
+
+  Options:
+
+  -a, --auth <username>:<password>  Authentication data.
+  -c, --color                       Colorize output with ANSI escape codes.
+  -h, --help                        This help message.
+  -n, --num <num>                   The number of statuses to show, defaults
+                                    to #{DEFAULT_OPTIONS[:num_statuses]}.
+
+  END
+  exit(1)
+end
+
+def parse_args
+  options = DEFAULT_OPTIONS.dup
+
+  opts = GetoptLong.new(
+    [ "--auth",   "-a", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--color",  "-c", GetoptLong::NO_ARGUMENT ],
+    [ "--help",   "-h", GetoptLong::NO_ARGUMENT ],
+    [ "--num",    "-n", GetoptLong::REQUIRED_ARGUMENT ]
+  )
+
+  begin
+    opts.each do |opt, arg|
+      case opt
+      when "--auth"   then options[:username], options[:password] = arg.split(":", 2)
+      when "--color"  then options[:colorize] = true
+      when "--help"   then raise HelpNeeded
+      when "--num"
+        arg = arg.to_i
+        if (1..Client::MAX_NUM_STATUSES).include? arg
+          options[:num_statuses] = arg
+        else
+          raise ArgumentError, "Invalid number of statuses to show -- must be between 1..#{Client::MAX_NUM_STATUSES}"
+        end
+      end
+    end
+  rescue GetoptLong::InvalidOption, GetoptLong::MissingArgument
+    raise AlreadyReportedArgumentError
+  end
+
+  unless options[:username]
+    begin
+      config = Tweetwine::Config.load(ENV["HOME"] + "/.tweetwine")
+      options[:username], options[:password] = [config.username, config.password]
+      options[:colorize] = config.colorize if config.colorize?
+    rescue Exception => e
+      raise ArgumentError, "No auth info given as argument and no configuration file (~/.tweetwine) found."
+    end
+  end
+
+  command = if ARGV.empty? then Client::COMMANDS[0] else ARGV.shift end
+  raise ArgumentError, "Unknown command." unless Client::COMMANDS.include? command
+
+  [options, command, ARGV]
+end
+
+begin
+  options, command, args = parse_args
+  client = Client.new(options)
+  client.send(command.to_sym, *args)
+rescue HelpNeeded, AlreadyReportedArgumentError
+  exit_with_usage
+rescue ArgumentError => e
+  exit_with_usage e.message
+rescue ClientError => e
+  exit_with_error e.message
+end

data/lib/tweetwine/client.rb

@@ -0,0 +1,81 @@
+require "json"
+require "rest_client"
+
+module Tweetwine
+  class ClientError < RuntimeError; end
+
+  class Client
+    COMMANDS = %w{friends user msg}
+
+    MAX_NUM_STATUSES = 20
+    MAX_STATUS_LENGTH = 140
+
+    def initialize(options)
+      @username, password = options[:username].to_s, options[:password].to_s
+      @base_url = "https://#{@username}:#{password}@twitter.com/"
+      @colorize = options[:colorize] || false
+      @num_statuses = options[:num_statuses] || MAX_NUM_STATUSES
+    end
+
+    def friends
+      print_statuses JSON.parse(get("statuses/friends_timeline.json?count=#{@num_statuses}"))
+    end
+
+    def user(user = @username)
+      print_statuses JSON.parse(get("statuses/user_timeline/#{user}.json?count=#{@num_statuses}"))
+    end
+
+    def msg(status = nil)
+      unless status
+        printf "New status: "
+        status = $stdin.gets
+      end
+      if confirm_user_action("Really send?")
+        msg = status[0...MAX_STATUS_LENGTH]
+        body = {:status => msg }
+        status = JSON.parse(post("statuses/update.json", body))
+        puts "Sent status update.\n\n"
+        print_statuses([status])
+      else
+        puts "Cancelled."
+      end
+    end
+
+    private
+
+    def get(rest_url)
+      rest_client_action(:get, @base_url + rest_url)
+    end
+
+    def post(rest_url, body)
+      rest_client_action(:post, @base_url + rest_url, body)
+    end
+
+    def rest_client_action(action, *args)
+      RestClient.send(action, *args)
+    rescue RestClient::Exception => e
+      raise ClientError, e.message
+    end
+
+    def confirm_user_action(msg)
+      printf "#{msg} [yN] "
+      confirmation = $stdin.gets.strip
+      confirmation.downcase[0,1] == "y"
+    end
+
+    def print_statuses(statuses)
+      statuses.each do |status|
+        time_diff_value, time_diff_unit = Util.humanize_time_diff(Time.now, status["created_at"])
+        from_user = status["user"]["screen_name"]
+        from_user = Util.colorize(:green, from_user) if @colorize
+        text = status["text"]
+        text = Util.colorize(:red, text, /@\w+/) if @colorize
+        puts <<-END
+#{from_user}, #{time_diff_value} #{time_diff_unit} ago:
+#{text}
+
+        END
+      end
+    end
+  end
+end

data/lib/tweetwine/config.rb

@@ -0,0 +1,25 @@
+require "yaml"
+
+module Tweetwine
+  class Config
+    def self.load(file)
+      new(file)
+    end
+
+    private_class_method :new
+
+    def initialize(file)
+      @config = YAML.load(File.read(file))
+    end
+
+    def method_missing(sym)
+      key = sym.to_s
+      if key[-1,1] == "?"
+        result = @config.has_key? key[0...-1]
+      else
+        result = @config[key]
+      end
+      result
+    end
+  end
+end

data/lib/tweetwine/util.rb

@@ -0,0 +1,49 @@
+require "time"
+
+module Tweetwine
+  module Util
+    COLOR_CODES = {
+      :green  => "\033[32m",
+      :red    => "\033[31m"
+    }
+
+    def self.colorize(color, str, matcher = nil)
+      color_code = COLOR_CODES[color.to_sym]
+
+      unless matcher
+        colorize_str(color_code, str)
+      else
+        str.gsub(matcher) { |s| colorize_str(color_code, s) }
+      end
+    end
+
+    def self.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
+
+      difference = (to - from).to_i.abs
+
+      value, unit = case difference
+      when 0..59 then [difference, "sec"]
+      when 60..3599 then [(difference/60.0).round, "min"]
+      when 3600..86399 then [(difference/3600.0).round, "hour"]
+      else [(difference/86400.0).round, "day"]
+      end
+
+      [value, pluralize_unit(value, unit)]
+    end
+
+    private
+
+    def self.colorize_str(color_code, str)
+      "#{color_code}#{str}\033[0m"
+    end
+
+    def self.pluralize_unit(value, unit)
+      if ["hour", "day"].include?(unit) && value > 1
+        unit = unit + "s"
+      end
+      unit
+    end
+  end
+end

data/lib/tweetwine.rb

@@ -0,0 +1,3 @@
+%w{util config client}.each do |f|
+  require File.dirname(__FILE__) << "/tweetwine/#{f}"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: tuomas-tweetwine
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tuomas Kareinen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: tweetwine
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: A simple but tasty Twitter agent for command line use, made for fun.
+email: tkareine@gmail.com
+executables: 
+- tweetwine
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- Rakefile
+- CHANGELOG.rdoc
+- README.rdoc
+- bin/tweetwine
+- lib/tweetwine
+- lib/tweetwine/client.rb
+- lib/tweetwine/config.rb
+- lib/tweetwine/util.rb
+- lib/tweetwine.rb
+has_rdoc: true
+homepage: http://github.com/tuomas/tweetwine
+post_install_message: 
+rdoc_options: 
+- --title
+- Tweetwine 0.1.0
+- --main
+- README.rdoc
+- --exclude
+- spec
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple Twitter agent for command line use
+test_files: []
+