tweetskim 0.1.0 → 0.2.0

data/README.md

@@ -3,73 +3,82 @@ DESCRIPTION:
 ===========
 
 A stripped down, command line-centered way to read tweets
-efficiently. Combine with unix tools and pipelines - read tweets
-however you want.
+efficiently.
+
+Combine with unix tools and pipelines to read tweets
+however *you* want.
 
 
 USAGE:
 ======
 
-`tweetskim`
+`tweetskim [options]`
 
-Prints tweets to stdout: one column for your timeline, one for
-mentions of your account. Use it like any other command line tool -
-pipe to `less` to page output, concat it to file (`tweetskim >
-tweets.txt`), and so on.
+Prints the tweet timeline to stdout, either as plain lines, more readable column
+or extra-readable single html page.
 
+Use it like any other command line tool: page the output (`less
+tweetskim`), concat it to file (`tweetskim > tweets.txt`), search for specific stuff (`tweetskim | grep conference`) and so on.
 
-PREREQUISITES:
-==============
+options
+----
 
-You must have some version of Ruby and RubyGems installed. That's it.
+-a, --show-all
 
+-e, --mentions
 
-INSTALL:
-========
+-i, --inverse-order
 
-`gem install tweetskim`
+-h, --help
 
-(The program will help you set up OAuth/pin authentication with Twitter
-the first time you run it.)
+-m, --mark-all-read
 
+-n, --last-n-tweets N
 
-TODO:
-=====
+-o, --output-mode lines|column|html
 
+-u, --user
 
-options
-----
+-v, --version 
 
-add usage text, handle options
 
--h, --help
+PREREQUISITES:
+==============
 
--m, --mark-all-read
+You must have some version of Ruby and RubyGems installed first. That's it.
 
--l=N, --last-n-tweets=N
 
--a, --show-all
+INSTALL:
+========
 
--i, --inverse-order
+`gem install tweetskim`
 
--t, --html-output
+The program will help you set up OAuth/pincode authentication with Twitter
+the first time you run it.
 
--hm, --hide-mentions
 
--ht, --hide-timeline
+TODO:
+=====
 
--x=USER, --exclude=USER
 
--o=USER, --only=USER
+options
+----
 
+Finish options enumerated above
 
 multiple accounts
 ------
+
 handle explicit, different username options
 
-split out authorization in separate, explicit step- tweetskim authorize USER
+split out authorization in separate, explicit step: tweetskim authorize USER
+
+set tokens per account (if username given)
+
+html output mode
+-----
 
-set tokens per account (if username)
+output single-page html version of tweets, do pretty and readable stuff here
 
 
 LICENSE:

data/bin/tweetskim

@@ -1,21 +1,64 @@
 #!/usr/bin/env ruby
 
 require "tweetskim"
+require "optparse"
 
 
-DEFAULT_MAX_TWEETS = 100
-DEFAULT_COLUMN_WIDTH = 40
+def parse_options
+  options = {}
 
-adapter = Tweetskim::TwitterAdapter.new
-formatter = Tweetskim::Formatter.new
+  OptionParser.new do |o|
+   #TODO o.on("-a", "--show-all", "Show all tweets, not just unread ones (max 300)") { |b| options[:show_all] = b } 
+    o.on("-e", "--mentions", "Show mentions instead of timeline") { |b| options[:mentions] = b }
+    o.on("-i", "--inverse-order", "Inverse/reverse ordered tweets") { |b| options[:inverse_order] = b }
+    o.on("-h", "--help", "Help page") { puts o; exit }
+   #TODO  o.on("-m", "--mark-all-read", "Mark everything up to now as read") { |b| options[:mark_all_read] = b }
+    o.on("-n N", "--last-n-tweets N", "Show only the last N tweets") { |n| options[:last_n_tweets] = n }
+    o.on("-o MODE", "--output-mode MODE", "Output as 'lines', 'column' or 'html'") { |mode| options[:output_mode] = mode }
+   #TODO  o.on("-u USER", "--user USER", "Which twitter user I am. Example: tweetskim -u thomanil") { |u| options[:user] = u }
+    o.on("-v", "--version", "Spit out version") { |b| puts Tweetskim::VERSION; exit }
 
-timeline = adapter.timeline(:count => DEFAULT_MAX_TWEETS)
-mentions = adapter.mentions(:count => DEFAULT_MAX_TWEETS)
+    o.parse!
+  end
 
-timeline_col = formatter.column timeline, {:width => DEFAULT_COLUMN_WIDTH}
-mentions_col = formatter.column mentions, {:width => DEFAULT_COLUMN_WIDTH}
+  return options
+end
 
-timeline_padded = formatter.pad timeline_col, DEFAULT_COLUMN_WIDTH
-mentions_padded = formatter.pad mentions_col, DEFAULT_COLUMN_WIDTH
+def fetch_tweets(options = {})
+  adapter = Tweetskim::TwitterAdapter.new
 
-puts formatter.pasted_columns([timeline_padded, mentions_padded])
+  if options[:mentions]
+    tweets = adapter.mentions(:count => options[:last_n_tweets] || 300)
+  else
+    tweets = adapter.timeline(:count => options[:last_n_tweets] || 300)
+  end
+
+   if options[:inverse_order]
+     tweets = tweets.reverse
+   end
+
+  return tweets
+end
+
+def write_tweets_to_stdout(tweets, options = {})
+  formatter = Tweetskim::Formatter.new
+  output_mode = options[:output_mode]
+
+  if !output_mode || output_mode == "lines"
+    result = formatter.lines(tweets, options)
+  elsif output_mode == "column"
+    result = formatter.column(tweets, {:width => 40})
+  elsif output_mode == "html"
+    puts "Html mode not done yet."; exit
+  else
+    puts "Invalid output mode."
+    exit
+  end
+  
+  puts result
+end
+
+
+options = parse_options
+tweets = fetch_tweets(options)
+write_tweets_to_stdout(tweets, options)

data/lib/tweetskim/core.rb

@@ -7,7 +7,12 @@ module Tweetskim
 
 
   class Formatter
-    
+
+    def lines(tweets, options = {})
+      tweet_texts = tweets.reverse.map {|tweet| "--#{tweet.user.name}-- #{tweet.text}\n"}
+      lines = tweet_texts.join("")
+    end
+      
     def column(tweets, options = {})
       tweet_texts = tweets.reverse.map {|tweet| "--#{tweet.user.name}-- #{tweet.text}"}
       reflowed_tweets = tweet_texts.map {|tweet| `echo "#{tweet}" | fmt -w #{options[:width]}` }
@@ -22,20 +27,7 @@ module Tweetskim
       end
       padded_lines.join ""
     end
-      
-    def pasted_columns(columns)
-      col_tmp_files = []
-
-      columns.each_with_index do |col, i|
-        filepath = "/tmp/tweetskim-col#{i}.txt"
-        `rm #{filepath}; echo "#{col}" > #{filepath}`
-        col_tmp_files.push filepath
-      end
-
-      col_tmp_files = col_tmp_files.join " "
-      `paste #{col_tmp_files}`.chomp "\t\n"
-    end
-      
+ 
   end
 
   
@@ -44,6 +36,7 @@ module Tweetskim
     # TODO call for each user in config
     # implicit for the user authenticated in client. Different user =
     # different client
+    
     def mentions(options = {})
       client = authenticated_client # 
       mentions = client.mentions(options)

data/lib/tweetskim/version.rb

@@ -1,3 +1,3 @@
 module Tweetskim
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/test_tweetskim.rb

@@ -18,7 +18,7 @@ class TestTweetskim < Test::Unit::TestCase
   def test_column_creation
     tweets = [t("Ut enimad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat."), t("Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. "), t("Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.")]
     
-    expected = <<FORMATTED
+    expected = <<COLUMN
 --Mock User-- Excepteur sint occaecat
 cupidatat non proident, sunt in culpa
 qui officia deserunt mollit anim id
@@ -34,13 +34,28 @@ cillum dolore eu fugiat nulla pariatur.
 quis nostrud exercitation ullamco
 laboris nisi ut aliquip ex ea commodo
 consequat.
-FORMATTED
+COLUMN
 
     actual = @f.column(tweets, {:width => 40})
         
     assert_equal expected, actual
   end
 
+  def test_line_creation
+    tweets = [t("Ut enimad minim veniam, quis nostrud."), t("Duis aute irure dolor in reprehenderit"), t("Excepteur sint occaecat cupidatat non proident")]
+
+    expected = <<LINES
+--Mock User-- Excepteur sint occaecat cupidatat non proident
+--Mock User-- Duis aute irure dolor in reprehenderit
+--Mock User-- Ut enimad minim veniam, quis nostrud.
+LINES
+
+    actual = @f.lines(tweets);
+
+    assert_equal expected, actual
+  end
+
+
   def test_whitespace_padding
 
     col = <<COL
@@ -66,27 +81,5 @@ COL
     assert_equal expected, @f.pad(col, 6)
   end
   
-
-  def test_column_pasting
-    first_col = <<COL
-aaa
-aaa
-aaa
-COL
-    second_col = <<COL
-bbb
-bbb
-bbb
-COL
-
-    expected = <<COL
-aaa\tbbb
-aaa\tbbb
-aaa\tbbb
-COL
-
-    assert_equal expected, @f.pasted_columns([first_col, second_col])
-  end
-  
 end
 

data/tweetskim.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "twitter"
   s.add_runtime_dependency "oauth"
-
+  s.add_runtime_dependency "OptionParser"
+  
   s.add_development_dependency "mocha"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweetskim
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
-  requirement: &13731040 !ruby/object:Gem::Requirement
+  requirement: &18929420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13731040
+  version_requirements: *18929420
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &13730620 !ruby/object:Gem::Requirement
+  requirement: &18929000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *13730620
+  version_requirements: *18929000
+- !ruby/object:Gem::Dependency
+  name: OptionParser
+  requirement: &18928580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18928580
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &13730200 !ruby/object:Gem::Requirement
+  requirement: &18928160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *13730200
+  version_requirements: *18928160
 description: ! 'Usage: tweetskim [username]'
 email:
 - thomas@kjeldahlnilsson.net