twtr 0.1.0

data/History.txt

@@ -0,0 +1,3 @@
+== 0.1.0 2008-05-22
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ryota Maruko
+
+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/README.txt

@@ -0,0 +1,90 @@
+= twtr
+* twtr.rubyforge.org
+
+== DESCRIPTION:
+twtr is a twitter client for Linux, OSX and Windows Console.
+
+== DESCRIPTION:
+    twtr is a imprementaion of twitter client.
+    Features are
+     * Command line application.
+     * Simple Twitter library.
+     * Http Proxy available.
+     * Double Byte Encoding. e.g) ShiftJIS, EUC-JP, etc.
+
+== SYNOPSIS:
+* command line
+    twtr [subcommand] [options]
+    ex)
+      $ twtr setting              # => (Re)set config file.
+      $ twtr ft                   # => Show friends timeline.
+      $ twtr pt -P 2              # => Show public timeline (page 2).
+      $ twtr ut -i bob            # => Show someone's timeline.
+      $ twtr rp                   # => Show replies.
+      $ twtr up -m "hello world"  # => Update message.
+
+* ruby code
+		require "twtr"
+		tc = Twtr::Client.new(
+					"account" => {"user" => "bob", "password" => "secret"},
+					"proxy" => {"host" => "proxy.domain", "port" => 8080},
+				 )
+
+		result_json = tc.update({:status => "hello world! from twtr", :format => :json})
+
+		result_xml = tc.friends_timeline({:page => 2, :format => :xml}) 
+
+
+== SUBCMMAND:
+    setting (reset)         # (Re)Set twtr configuration info.
+    friends_timeline (ft)   # Show friends timeline.
+    putlic_timeline (pt)    # Show public timeline.
+    user_timeline (ut)      # Show user timeline. -i, --id  option required.
+    replies (rp)            # Show replies.
+    update (up)             # Updates your status. -m, --message option required.
+
+
+* twtr lib.
+require "twtr"
+tc = Twtr::Client.new(
+			Twtr::Config.load("/path/to/twtr.yml")
+		 )
+
+tc.message("hello!")
+#=> [[foo, "hello1"]]
+
+tc.timeline(:friends)
+#=> [["foo", "hello!"],["bar","what's up?"],["bar","I'm Home."]]
+
+tc.timeline(:timeline)
+#=> [["superman", "hello!"],["badman","what's up?"],["ultraman","I'm Home."],["foo","hello!"]]
+
+
+== INSTALL:
+
+* gem install twtr
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Ryota Maruko
+
+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/bin/twtr

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+TWTR_BASE = File.expand_path("#{File.dirname(__FILE__)}/..")
+require "#{TWTR_BASE}/lib/twtr.rb"
+
+console = Twtr::Console.new()
+console.run(ARGV)

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'twtr/version'
+
+AUTHOR = 'Ryota Maruko'  # can also be an array of Authors
+EMAIL = ""
+DESCRIPTION = "twtr is a twitter client for Linux, OSX and Windows Console."
+GEM_NAME = 'twtr' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'twtr' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Twtr::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'twtr documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/twtr.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Twtr
+  def self.is_win?
+    (RUBY_PLATFORM.downcase =~ /mswin(?!ce)|mingw|cygwin|bccwin/) ? true : false
+  end
+
+  require "kconv"
+  require "cgi"
+  require "rexml/document"
+  require "twtr/version"
+  require "twtr/config"
+  require "twtr/console"
+  require "twtr/client"
+  require "twtr/errors"
+end

data/lib/twtr/client.rb

@@ -0,0 +1,116 @@
+module Twtr
+  class Client
+    require 'net/http'
+
+    HOST = "twitter.com"
+    PORT = 80
+
+    DEFAULT_FORMAT = :xml
+    DEFAULT_METHOD = :get
+    
+    SEC_SLEEP = 1 # wait update.
+
+    ATTR_NAMES = [:account_user, :account_password,
+                  :proxy_host, :proxy_port]
+
+    ATTR_NAMES.each {|name| attr_accessor name }
+    
+    def initialize(config = nil)
+      @account_user = @account_password = @proxy_host = @proxy_port = nil
+      ATTR_NAMES.each {|name| load_config(name, config) } if config
+    end
+    
+    def load_config(attr_name, config)
+      if val = config_from_attr(attr_name, config)
+        self.instance_variable_set("@#{attr_name}", val )
+      end
+    end
+    
+    def config_from_attr(attr_name, config)
+      section, name = attr_name.to_s.split("_")
+      val ||= (config[section] && config[section][name])
+      val ||= (config[section.to_sym] && config[section.to_sym][name.to_sym])
+      val
+    end
+
+    def public_timeline(options={})
+      get_status("/statuses/public_timeline", options)
+    end
+
+    def friends_timeline(options={})
+      get_status("/statuses/friends_timeline", options)
+    end
+
+    def user_timeline(options={})
+      id = options.delete(:id) || @account_user
+      get_status("/statuses/user_timeline/#{id}", options)
+    end
+    
+    def replies(options={})
+      get_status("/statuses/replies", options)
+    end
+
+    def update(options={})
+      source = post_status("/statuses/update",options)
+      friends_timeline()
+    end
+    
+    def test(options={})
+      request_status("/help/test", options)
+    end
+    
+    def post_status(path,options = {})
+      options[:method] = :post
+      sleep(SEC_SLEEP)
+      request_status(path, options)
+    end
+
+    def get_status(path, options = {})
+      options[:method] = :get
+      request_status(path, options)
+    end
+    
+    def request_status(path, options = {})
+      format = options.delete(:format) || DEFAULT_FORMAT
+      method = options.delete(:method) || DEFAULT_METHOD
+      case method
+      when :get
+        res = get("#{path}.#{format}", options)
+      when :post
+        res = post("#{path}.#{format}", options)
+      end
+      
+      raise Twtr::ResponseErrorException.new("#{res.code}: #{HTTP_ERRORS[res.code]}") \
+                                              if Twtr::HTTP_ERRORS.has_key?(res.code)
+      res.body
+    end
+
+    def get(path, params = {})
+      query = params.to_a.map {|pair| "#{pair.shift}=#{CGI.escape(pair.pop.to_s)}" if pair.last}         
+      path = path.gsub(/^#{HOST}/,'')
+      path += "?#{query.join('&')}" unless query.empty?
+      req = Net::HTTP::Get.new(path)
+      request(req)
+    end
+
+    def post(path, params = {})
+      req = Net::HTTP::Post.new(path)
+      req.set_form_data(params) unless params.empty?
+      request(req)
+    end
+
+    def request(req)
+      req.basic_auth(@account_user, @account_password) if @account_user
+      if(@proxy_host)
+        @proxy_host.gsub!(%r|http://|,'')
+        Net::HTTP::Proxy(@proxy_host, @proxy_port.to_i).start(HOST, PORT) do |http|
+          http.request(req)
+        end
+      else
+        Net::HTTP.start(HOST, PORT){|http| http.request(req)}
+      end
+    end
+
+  end
+
+end

data/lib/twtr/config.rb

@@ -0,0 +1,30 @@
+require 'erb'
+require 'yaml'
+require 'yaml/store'
+require 'fileutils'
+
+
+module Twtr
+  module Config
+    
+    def self.load(config_file)
+      if File.exist?(config_file)
+        config = YAML::load(ERB.new(IO.read(config_file)).result)
+      else
+        raise Twtr::ConfigFileNotFoundException.new("#{config_file} not found!")
+      end
+    end
+  
+    def self.save(config_file, config = {})
+      FileUtils.mkdir_p(File.dirname(config_file))
+      store = YAML::Store.new(config_file)
+      store.transaction do |yaml|
+        %W(account proxy).each do |name|
+          yaml.delete(name) if yaml[name]
+          yaml[name] = config[name] if config[name]
+        end
+      end
+    end
+    
+  end
+end

data/lib/twtr/console.rb

@@ -0,0 +1,172 @@
+require "optparse"
+
+module Twtr
+DESCRIPTION=<<-_TEXT_
+Twtr Copyright (c) 2008 Ryota Maruko
+DESCRIPTION
+    twtr is a imprementaion of twitter client.
+    Features are
+     * Command line application.
+     * Simple Twitter library.
+     * Http Proxy available.
+     * Double Byte Encoding. e.g) ShiftJIS, EUC-JP, etc.
+
+SYNOPSIS
+    twtr [subcommand] [options]
+    ex)
+      $ twtr setting              # => (Re)set config file.
+      $ twtr ft                   # => Show friends timeline.
+      $ twtr pt -P 2              # => Show public timeline (page 2).
+      $ twtr ut -i bob            # => Show someone's timeline.
+      $ twtr rp                   # => Show replies.
+      $ twtr up -m "hello world"  # => Update message.
+
+SUBCMMAND
+    setting (reset)         # (Re)Set twtr configuration info.
+    friends_timeline (ft)   # Show friends timeline.
+    putlic_timeline (pt)    # Show public timeline.
+    user_timeline (ut)      # Show user timeline. -i, --id  option required.
+    replies (rp)            # Show replies.
+    update (up)             # Updates your status. -m, --message option required.
+_TEXT_
+
+  class Console
+    CONFIG_FILE = Twtr.is_win? ? File.expand_path("#{ENV['HOMEPATH']}/twtr/twtr.yml") \
+                               : File.expand_path("~/.twtr/twtr.yml")
+    DEFAULT_DISPLAY_COUNT = 20
+    COUNT_WITH_UPDATE = 5
+    DEFAULT_DISPLAY_ENCODE = Twtr.is_win? ? :sjis : :utf8
+    
+    SUBCOMMANDS = {
+      :public_timeline => :public_timeline,
+      :pt => :public_timeline,
+      :friends_timeline => :friends_timeline,
+      :ft => :friends_timeline,
+      :user_timeline => :user_timeline,
+      :ut => :user_timeline,
+      :replies => :replies,
+      :rp => :replies,
+      :update => :update,
+      :up => :update,
+      :setting => :setting,
+      :reset => :setting,
+    }
+    
+    def run(args)
+      begin
+        parse(args)            
+      rescue Exception => e
+        puts e.message
+      end
+
+      if @subcommand
+        @configfile ||= CONFIG_FILE
+          (edit_config(); return) if @subcommand == :setting
+        
+        begin
+          client = Twtr::Client.new(Twtr::Config.load(@configfile))
+          show_status( client.send(@subcommand, @params) )
+        rescue Twtr::ConfigFileNotFoundException => e
+          puts e.message
+          edit_config() 
+        rescue Exception => e
+          puts e.message
+        end    
+      end
+    end
+    
+    def edit_config()
+      puts ">> #{@configfile}"
+      print "Edit twtr config? [y/N]:"; replay = gets
+      exit if replay.to_s.chomp != 'y'
+
+      config = {}
+
+      account = {}
+      print "Twitter username: "; user = gets
+      print "Twitter password: "; password = gets     
+      account["user"] = user.to_s.chomp
+      account["password"] = password.to_s.chomp
+      config["account"] = account      
+
+      proxy = {}
+      print "Proxy host (option): "; proxy_host = gets
+      print "Proxy port (option): "; proxy_port = gets
+      proxy["host"] = proxy_host.chomp if proxy_host && !proxy_host.chomp.empty? 
+      proxy["port"] = proxy_port.chomp if proxy_port && !proxy_port.chomp.empty?
+      config["proxy"] = proxy unless proxy.empty? 
+  
+      Twtr::Config.save(@configfile, config)
+    end
+    
+    def parse(args)
+      @params = {}
+      args << '-h' if args.empty?
+      args.options do |opt|
+
+        opt.on('-v','--version','Show the version number and quit') do |val|
+          puts("twtr #{Twtr::VERSION::STRING}")
+        end
+        
+        opt.on('-h','--help','Show this help message and quit.') do |val|
+          show_help(opt)
+        end
+
+        opt.on('-c','--count=number', 'Display number statuses.') do |val|
+          @params.merge!({:count => val})
+          @display_count = val.to_i
+        end
+        
+        opt.on('-i','--id=userid','The ID or screen name of the user.') do |val|
+          @params.merge!({:id => val})
+        end
+
+        opt.on('-m','--message=message','Post message.') do |val|
+          @display_count ||= COUNT_WITH_UPDATE
+          @params.merge!({:source => "twtr", :status => val.toutf8})
+        end
+
+        opt.on('-p', '--page=number',"Gets the 20 next statuses.") do |val|
+          @params.merge!({:page => val.to_i})
+        end
+        
+        opt.on('-C', '--config=path/to/configfile',"Use another config. (default: #{CONFIG_FILE})") do |val|
+          @configfile = val
+        end
+
+        opt.parse!
+      end
+    
+      return unless args[0]
+      @subcommand = parse_subcommand(args.shift)
+    end
+    
+    def parse_subcommand(cmd)
+      cmd = cmd.to_sym
+      if SUBCOMMANDS.has_key?(cmd)
+        @subcommand = SUBCOMMANDS[cmd]
+      else
+        raise UnknownSubcommandException.new("Unkown Subcommand [#{cmd}]. Please type 'twtr -h'.")
+      end
+    end
+    
+    def show_help(opt)
+      puts "\n#{Twtr::DESCRIPTION}\n#{opt}"
+    end
+    
+    def show_status(source)
+      @display_count ||= DEFAULT_DISPLAY_COUNT
+      doc = REXML::Document.new(source)
+      return if(!doc || !doc.elements['statuses'])
+      count = 0
+      doc.elements['statuses'].each_element do |e|
+        msg = e.elements['user/screen_name'].text + ': ' + e.elements['text'].text
+        msg = msg.tosjis if Twtr.is_win?
+        print "#{msg}\n"
+        break if((count+=1) >= @display_count)
+      end
+      puts ""
+    end
+    
+  end
+end