tweetskim 0.0.2 → 0.1.0

data/{README.rdoc → README.md}

@@ -1,61 +1,79 @@
 
-== DESCRIPTION:
+DESCRIPTION:
+===========
 
-A stripped down, command line-centered way to read tweets efficiently.
+A stripped down, command line-centered way to read tweets
+efficiently. Combine with unix tools and pipelines - read tweets
+however you want.
 
 
-== USAGE:
+USAGE:
+======
 
-TODO
+`tweetskim`
 
+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.
 
-== INSTALL:
 
-gem install tweetskim
+PREREQUISITES:
+==============
 
+You must have some version of Ruby and RubyGems installed. That's it.
 
-== FEATURES/PROBLEMS:
 
-TODO
+INSTALL:
+========
 
+`gem install tweetskim`
 
-== TODO
+(The program will help you set up OAuth/pin authentication with Twitter
+the first time you run it.)
 
-add dependencies to gem spec
 
-two column presentation: add mentions
-    
-usage
-tweet-skim [usernames...]
+TODO:
+=====
+
+
+options
+----
+
+add usage text, handle options
+
+-h, --help
+
 -m, --mark-all-read
+
+-l=N, --last-n-tweets=N
+
 -a, --show-all
--i --inverse-order
--h --html-output
-
-configure
-dotfile
-config accounts, set tokens per account
-option: hide timeline, hide mentions
-
-generate nicely formatted html version in ~/.<APP>/last-generated
-point browser to that
-"mark all as read, go straight to browser
-for multiple accounts: show them tabbed, concated or something else
-super readable, greyscale, only gfx=avatars
-Links to actual tweets to enable interaction using regular twitter web gui
-make the design beautiful
-CSS3 workthrough
-Design & typography books workthrough
-        
-mobile version
-move timeline last read values to central location
-mobile app
-    
-web version
-figure out way to post "mark as read"
-    
-
-== LICENSE:
+
+-i, --inverse-order
+
+-t, --html-output
+
+-hm, --hide-mentions
+
+-ht, --hide-timeline
+
+-x=USER, --exclude=USER
+
+-o=USER, --only=USER
+
+
+multiple accounts
+------
+handle explicit, different username options
+
+split out authorization in separate, explicit step- tweetskim authorize USER
+
+set tokens per account (if username)
+
+
+LICENSE:
+========
 
 (The MIT License)
 

data/bin/tweetskim

@@ -2,5 +2,20 @@
 
 require "tweetskim"
 
-tweet_adapter = Tweetskim::TwitterAdapter.new
-puts tweet_adapter.tweet_column(tweet_adapter.timeline(:count => 100), 40)
+
+DEFAULT_MAX_TWEETS = 100
+DEFAULT_COLUMN_WIDTH = 40
+
+adapter = Tweetskim::TwitterAdapter.new
+formatter = Tweetskim::Formatter.new
+
+timeline = adapter.timeline(:count => DEFAULT_MAX_TWEETS)
+mentions = adapter.mentions(:count => DEFAULT_MAX_TWEETS)
+
+timeline_col = formatter.column timeline, {:width => DEFAULT_COLUMN_WIDTH}
+mentions_col = formatter.column mentions, {:width => DEFAULT_COLUMN_WIDTH}
+
+timeline_padded = formatter.pad timeline_col, DEFAULT_COLUMN_WIDTH
+mentions_padded = formatter.pad mentions_col, DEFAULT_COLUMN_WIDTH
+
+puts formatter.pasted_columns([timeline_padded, mentions_padded])

data/lib/tweetskim/core.rb

@@ -4,15 +4,43 @@ module Tweetskim
   require 'rubygems'
   require 'twitter'
   require 'oauth'
+
+
+  class Formatter
     
-  class TwitterAdapter
-    
-    def trial 
-     4
+    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]}` }
+      column = reflowed_tweets.join "\n\n"
     end
 
-   
-    
+    def pad(column, width)
+      padded_lines = []
+      column.each_line do |line|
+        chopped_line = line.chop
+        padded_lines.push `printf "%-#{width}s\n" "#{chopped_line}"`        
+      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
+
+  
+  class TwitterAdapter
+      
     # TODO call for each user in config
     # implicit for the user authenticated in client. Different user =
     # different client
@@ -25,13 +53,6 @@ module Tweetskim
       client = authenticated_client
       timeline = client.home_timeline(options)
     end
-
-
-    def tweet_column(tweets, column_width)
-      tweet_texts = tweets.reverse.map {|tweet| "--#{tweet.user.name}-- #{tweet.text}"}
-      reflowed_tweets = tweet_texts.map {|tweet| `echo "#{tweet}" | fmt -w #{column_width}` }
-      reflowed_tweets.join "\n\n"
-    end
     
     CONSUMER_KEY = "3oUZhYLZcaqqQePajIjnBg"
     CONSUMER_SECRET = "mAYecEGPwy7BlkibFGHCACtY5x1Mm0YOvczxsll4OY"
@@ -72,7 +93,7 @@ module Tweetskim
       puts "Please authenticate by following this URL:"
       puts request_token.authorize_url
       
-      print "What was the PIN Twitter gave you? "
+      print "What was the PIN that Twitter gave you? "
       pin = gets.chomp
      
       OAuth::RequestToken.new(oauth_consumer, rtoken, rsecret)
@@ -82,7 +103,7 @@ module Tweetskim
     end
 
     #TODO store tokens for each user
-    TOKEN_FILE_PATH = File.expand_path "~/.tweetskim/tokens"
+    TOKEN_FILE_PATH = File.expand_path "~/.tweetskim/default.tokens"
     
     def user_tokens_stored?
       File.exists? TOKEN_FILE_PATH

data/lib/tweetskim/version.rb

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

data/test/test_helper.rb

@@ -1,3 +1,5 @@
 require 'stringio'
 require 'test/unit'
+require 'mocha'
+
 require File.dirname(__FILE__) + '/../lib/tweetskim'

data/test/test_tweetskim.rb

@@ -3,28 +3,89 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 class TestTweetskim < Test::Unit::TestCase
 
   def setup
-    @t = Tweetskim::TwitterAdapter.new
-  end
-  
-  def test_something
-    assert_equal 4, @t.trial
+    @f = Tweetskim::Formatter.new
   end
 
-  def test_twitter_integration_get_mentions
-    assert_equal 10, @t.mentions[0...10].count
+  def t(text)
+    status = Twitter::Status.new
+    status.stubs(:text).returns text
+    user = Twitter::User.new
+    user.stubs(:name).returns "Mock User"
+    status.stubs(:user).returns user
+    return status
   end
+  
+  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
+--Mock User-- Excepteur sint occaecat
+cupidatat non proident, sunt in culpa
+qui officia deserunt mollit anim id
+est laborum.
+
+
+--Mock User-- Duis aute irure dolor in
+reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur.
+
+
+--Mock User-- Ut enimad minim veniam,
+quis nostrud exercitation ullamco
+laboris nisi ut aliquip ex ea commodo
+consequat.
+FORMATTED
 
-  def test_twitter_integration_get_timeline
-    assert_equal 10, @t.timeline[0...10].count
+    actual = @f.column(tweets, {:width => 40})
+        
+    assert_equal expected, actual
   end
 
-  
-  def test_column_creation
-    tweet_str = ["Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. ", "Ut enimad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.", "Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. ", "Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."]
+  def test_whitespace_padding
 
-#    tweets = tweet_str.map { |str| Twitter::Status.new :text => str }
+    col = <<COL
+aaaaaa
+aaaaa
+aaaa
+aaa
+aa
+a
+
+COL
     
-    puts @t.tweet_column( @t.timeline, 40)
+    expected = <<COL
+aaaaaa
+aaaaa 
+aaaa  
+aaa   
+aa    
+a     
+      
+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,5 +22,6 @@ Gem::Specification.new do |s|
   # s.add_development_dependency "rspec"
   s.add_runtime_dependency "twitter"
   s.add_runtime_dependency "oauth"
-  
+
+  s.add_development_dependency "mocha"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweetskim
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.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: &18244880 !ruby/object:Gem::Requirement
+  requirement: &13731040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18244880
+  version_requirements: *13731040
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &18244460 !ruby/object:Gem::Requirement
+  requirement: &13730620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18244460
+  version_requirements: *13730620
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &13730200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *13730200
 description: ! 'Usage: tweetskim [username]'
 email:
 - thomas@kjeldahlnilsson.net
@@ -43,7 +54,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - bin/tweetskim
 - lib/tweetskim.rb