tweetskim 0.2.0 → 0.3.0

data/README.md

@@ -17,29 +17,25 @@ USAGE:
 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.
+Use it like any other command line tool: page the output (`tweetskim |
+less`), concat it to file (`tweetskim > tweets.txt`), search for specific stuff (`tweetskim | grep conference`) and so on.
 
-options
-----
-
--a, --show-all
+Default behavior if you don't pass any options: Print out last 10
+tweets in your timeline, one on each line.
 
--e, --mentions
+Options:
 
--i, --inverse-order
+-e, --mentions:                  Show mentions instead of timeline
 
--h, --help
+-i, --inverse-order              Inverse/reverse ordered tweets
 
--m, --mark-all-read
+-h, --help                       Help page
 
--n, --last-n-tweets N
+-n, --last-n-tweets N            Show the last N tweets in your timeline
 
--o, --output-mode lines|column|html
+-o, --output-mode MODE           Output as 'lines', 'column' or 'html'
 
--u, --user
-
--v, --version 
+-v, --version                    Current version
 
 
 PREREQUISITES:
@@ -61,10 +57,18 @@ TODO:
 =====
 
 
-options
+mark-read
+----
+
+Support -m mark-as-read flag, to toggle "I've read all up till now,
+next time only show new stuff"
+
+
+show status identifier
 ----
 
-Finish options enumerated above
+option to prefix tweets with their status id and/or direct link (all modes)
+
 
 multiple accounts
 ------

data/bin/tweetskim

@@ -8,11 +8,11 @@ def parse_options
   options = {}
 
   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("-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("-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 }
@@ -24,22 +24,36 @@ def parse_options
   return options
 end
 
+
 def fetch_tweets(options = {})
+  settings = Tweetskim::Settings.new
   adapter = Tweetskim::TwitterAdapter.new
 
+  since_id = "111111"
+  if !options[:show_all]
+    since_id = settings.load_last_read_status_id
+  end
+
+  tweet_count = options[:last_n_tweets] || 15
   if options[:mentions]
-    tweets = adapter.mentions(:count => options[:last_n_tweets] || 300)
+    tweets = adapter.mentions(tweet_count, since_id)
   else
-    tweets = adapter.timeline(:count => options[:last_n_tweets] || 300)
+    tweets = adapter.timeline(tweet_count, since_id)
   end
 
-   if options[:inverse_order]
-     tweets = tweets.reverse
-   end
-
+  if options[:inverse_order]
+    tweets = tweets.reverse
+  end
+  
+  last_tweet = tweets.sort { |t| t.id }.last
+  if options[:mark_all_read] && last_tweet
+    settings.save_last_read_status_id(last_tweet.id)
+  end
+  
   return tweets
 end
 
+
 def write_tweets_to_stdout(tweets, options = {})
   formatter = Tweetskim::Formatter.new
   output_mode = options[:output_mode]
@@ -47,12 +61,11 @@ def write_tweets_to_stdout(tweets, options = {})
   if !output_mode || output_mode == "lines"
     result = formatter.lines(tweets, options)
   elsif output_mode == "column"
-    result = formatter.column(tweets, {:width => 40})
+    result = formatter.column(tweets, {:width => 60})
   elsif output_mode == "html"
     puts "Html mode not done yet."; exit
   else
-    puts "Invalid output mode."
-    exit
+    puts "Invalid output mode."; exit
   end
   
   puts result
@@ -61,4 +74,5 @@ end
 
 options = parse_options
 tweets = fetch_tweets(options)
+#TODO create result first, send that. Dont put errors in stdout.
 write_tweets_to_stdout(tweets, options)

data/lib/tweetskim/core.rb

@@ -7,14 +7,13 @@ 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}"}
+      tweet_texts = tweets.reverse.map {|tweet| "--\\033[1;34m#{tweet.user.name}\\033[0m-- #{tweet.text}"}
       reflowed_tweets = tweet_texts.map {|tweet| `echo "#{tweet}" | fmt -w #{options[:width]}` }
       column = reflowed_tweets.join "\n\n"
     end
@@ -27,24 +26,82 @@ module Tweetskim
       end
       padded_lines.join ""
     end
- 
   end
 
+
+  class Settings
+    SETTINGS_TEMPLATE = {:token => nil,
+      :secret => nil,
+      :last_read_status_id => "0"}
+
+    SETTINGS_FILE_PATH = File.expand_path "~/.tweetskim/default-account"
+
+    def initialize
+      if !Dir[" ~/.tweetskim/"].empty?
+        `mkdir ~/.tweetskim/`
+      end
+    end
+    
+    def load
+      yml_str = `cat #{SETTINGS_FILE_PATH}`
+      YAML::load(yml_str) || SETTINGS_TEMPLATE
+    end
+
+    def save(settings)
+      yml_str = YAML::dump(settings)
+      `echo "#{yml_str}" > #{SETTINGS_FILE_PATH}`
+    end
+    
+    def user_credentials_stored?
+      if File.exists? SETTINGS_FILE_PATH
+        settings = load
+        return (settings[:token] && !settings[:token].empty? &&
+                settings[:secret] && !settings[:secret].empty?)
+      else
+        false
+      end
+    end
+    
+    def save_credentials(token, secret)
+      settings = load
+      settings[:token] = token
+      settings[:secret] = secret
+      save settings
+    end
+
+    def load_credentials
+      settings = load
+      return settings[:token], settings[:secret]
+    end
+
+    def load_last_read_status_id
+      settings = load
+      return settings[:last_read_status_id]
+    end
+
+    def save_last_read_status_id(id)
+      settings = load
+      settings[:last_read_status_id] = id
+      save settings
+    end
+    
+  end
+
+
   
   class TwitterAdapter
-      
     # 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)
+    def mentions(tweet_count, since_id)
+      client = authenticated_client 
+      mentions = client.mentions({:count => tweet_count.to_i, :since_id => since_id.to_i})
     end
 
-    def timeline(options = {}) 
+    def timeline(tweet_count, since_id) 
       client = authenticated_client
-      timeline = client.home_timeline(options)
+      timeline = client.home_timeline({:count => tweet_count.to_i, :since_id => since_id.to_i})
     end
     
     CONSUMER_KEY = "3oUZhYLZcaqqQePajIjnBg"
@@ -52,11 +109,13 @@ module Tweetskim
 
     # TODO call for specific user
     def authenticated_client
-      if user_tokens_stored?
-        user_token, user_secret = load_user_tokens
+      settings = Tweetskim::Settings.new
+      
+      if settings.user_credentials_stored?
+        user_token, user_secret = settings.load_credentials
       else
         user_token, user_secret = oauth_pin_dance_for_token_and_secret
-        store_user_tokens(user_token, user_secret)
+        settings.save_credentials(user_token, user_secret)
       end
 
       Twitter.configure do |config|
@@ -86,31 +145,14 @@ module Tweetskim
       puts "Please authenticate by following this URL:"
       puts request_token.authorize_url
       
-      print "What was the PIN that Twitter gave you? "
+      puts "What was the PIN that Twitter gave you? "
       pin = gets.chomp
      
       OAuth::RequestToken.new(oauth_consumer, rtoken, rsecret)
       access_token = request_token.get_access_token(:oauth_verifier => pin)
       
       return access_token.token, access_token.secret
-    end
-
-    #TODO store tokens for each user
-    TOKEN_FILE_PATH = File.expand_path "~/.tweetskim/default.tokens"
-    
-    def user_tokens_stored?
-      File.exists? TOKEN_FILE_PATH
-    end
-    
-    def store_user_tokens(token, secret)
-      `mkdir ~/.tweetskim/`
-       `echo "#{token}___#{secret}" > #{TOKEN_FILE_PATH}`
-    end
-
-    def load_user_tokens
-      token, secret = `cat #{TOKEN_FILE_PATH}`.split "___"
-      return token.chomp, secret.chomp
-    end
-        
+    end   
   end
+  
 end

data/lib/tweetskim/version.rb

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

data/test/test_tweetskim.rb

@@ -18,26 +18,10 @@ 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 = <<COLUMN
---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.
-COLUMN
+    expected = "--\e[1;34mMock User\e[0m-- Excepteur sint\noccaecat cupidatat non proident, sunt\nin culpa qui officia deserunt mollit\nanim id est laborum.\n\n\n--\e[1;34mMock User\e[0m-- Duis aute\nirure dolor in reprehenderit in\nvoluptate velit esse cillum dolore eu\nfugiat nulla pariatur.\n\n\n--\e[1;34mMock User\e[0m-- Ut enimad\nminim veniam, quis nostrud exercitation\nullamco laboris nisi ut aliquip ex ea\ncommodo consequat.\n"
 
     actual = @f.column(tweets, {:width => 40})
-        
+    
     assert_equal expected, actual
   end
 
@@ -80,6 +64,14 @@ COL
        
     assert_equal expected, @f.pad(col, 6)
   end
+
+  def test_settings_persistence
+    
+
+    
+  end
+
+
   
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tweetskim
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-03 00:00:00.000000000Z
+date: 2012-03-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
-  requirement: &18929420 !ruby/object:Gem::Requirement
+  requirement: &15805940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18929420
+  version_requirements: *15805940
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &18929000 !ruby/object:Gem::Requirement
+  requirement: &15805520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18929000
+  version_requirements: *15805520
 - !ruby/object:Gem::Dependency
   name: OptionParser
-  requirement: &18928580 !ruby/object:Gem::Requirement
+  requirement: &15805100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18928580
+  version_requirements: *15805100
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &18928160 !ruby/object:Gem::Requirement
+  requirement: &15804680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18928160
+  version_requirements: *15804680
 description: ! 'Usage: tweetskim [username]'
 email:
 - thomas@kjeldahlnilsson.net
@@ -71,7 +71,6 @@ files:
 - lib/tweetskim.rb
 - lib/tweetskim/core.rb
 - lib/tweetskim/version.rb
-- test.txt
 - test/test_helper.rb
 - test/test_tweetskim.rb
 - tweetskim.gemspec

data/test.txt

@@ -1 +0,0 @@
-hepp