stars 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Zach Holman
+ 
+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.markdown

@@ -0,0 +1,45 @@
+# stars
+### you're so vain / you probably think these stars are about you
+
+## why
+
+[Favstar](http://favstar.fm) is about opening another line of dialogue between you and your Twitter followers. Like the one where someone likes what you tweet but is too nervous to tell you to your face and they star your tweets instead, so instead you shake them down in the kitchen after a long tequila bender and steal their precious stars and keep them for yourself.
+
+So anyway, I spend a lot of time on the command line, and switching over to the browser just to view [my stars](http://favstar.fm/users/holman) is so passé.
+
+## how
+
+Install with `gem install stars`, then do a quick `stars`, fill in your Twitter username, and let it do its sultry magic. This is me lately:
+
+    +-------+-------------+--------------------------------------------------------+
+    | Stars | Time        | Your Funnies                                           |
+    +-------+-------------+--------------------------------------------------------+
+    | *     | 10 days ago | "Any Flash developers I meet I try to arrange their... |
+    | * *   | 10 days ago | Why doesn't digg do fulltext RSS feeds on their dev... |
+    | *     | 10 days ago | I can't wait until the US relaxes its patent system... |
+    | *     | 9 days ago  | If this happens to be Twitter's 10,000,000,000th tw... |
+    | *     | 8 days ago  | Are any of you ladies from my dreams?  No really, i... |
+    | * *   | 7 days ago  | I have a severe sore throat.  Or, if I said that ou... |
+    | * *   | 7 days ago  | Way too many Scientology ads on Muni buses.  It wor... |
+    | *     | 7 days ago  | Napping didn't fix this cold; I feel a bit worse. M... |
+    | *     | 6 days ago  | God I leave the room for one minute and the girls o... |
+    | *     | 6 days ago  | Man, Avatar really fucked Up.                          |
+    | *     | 5 days ago  | I'd play out here, but the west coast is all about ... |
+    | *     | 5 days ago  | I just want to know who moved my Maps app to my iPh... |
+    | *     | 5 days ago  | just about finished my thesis on generating free en... |
+    | * *   | 3 days ago  | You change your Facebook pic, that syncs to my iPho... |
+    | *     | 2 days ago  | Going to totally refork and rework my dotfiles soon... |
+    | *     | 2 days ago  | Oh hey, a year or so of my beer consumption: http:/... |
+    | *     | 1 day ago   | In another life I want to be a pop star heartthrob ... |
+    | * *   | 1 day ago   | I pre-ordered an iPad, checked into lunch, and now ... |
+    +-------+-------------+--------------------------------------------------------+
+
+You can tell from the relative dearth of stars that I'm in my *screw followers I'm important so here's what I had for lunch* phase. Don't worry; I'll become a star whore again and tweet pop culture references in relation to presidential penile size soon enough.
+
+## state of affairs
+
+This was a one-night hack thing; ideally it'd be cool to allow some username switching, maybe retain some "this was read" state, and improve the formatting (if only "★" worked better in a fixed-width environment, AMIRITE?). All in due time. I mean, for you to fork and do it yourself, I mean.
+
+## who
+
+[@holman](http://twitter.com/holman) did this. Follow me and star my stuff incessantly so we can prove to Dean Allen that stars are as important as currency, much [to his logically-argued dismay](http://favrd.textism.com/).

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stars"
+    gem.summary = %Q{Recent favstar faves on your command line}
+    gem.description = %Q{Recent favstar faves on your command line.}
+    gem.email = "github.com@zachholman.com"
+    gem.homepage = "http://github.com/holman/stars"
+    gem.authors = ["Zach Holman"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_dependency('httparty')
+    gem.add_dependency('terminal-table')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stars #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/stars

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+ 
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'stars'
+
+Stars::Client.load!

data/lib/stars/client.rb

@@ -0,0 +1,32 @@
+module Stars
+  class Client
+  
+    def self.load!
+      favstar = Stars::Favstar.new(username)
+      puts Stars::Formatter.new(favstar.recent)
+    end
+  
+    def self.username
+      File.exists?(config_path) ? File.read(config_path) : prompt_for_username
+    end
+  
+    def self.prompt_for_username
+      puts ""
+      puts ""
+      puts " ★   stars."
+      puts ""
+      puts "Type your Twitter username:"
+      remember_username(gets.chomp)
+    end
+  
+    def self.remember_username(username)
+      File.open(config_path, 'w') {|f| f.write(username) }
+      username
+    end
+  
+    def self.config_path
+      File.join(ENV['HOME'], '.stars')
+    end
+  
+  end
+end

data/lib/stars/favstar.rb

@@ -0,0 +1,16 @@
+module Stars
+  class Favstar
+    include HTTParty
+    base_uri 'favstar.fm'
+    format :xml
+    attr_accessor :username
+  
+    def initialize(username)
+      @username = username
+    end
+
+    def recent
+      self.class.get("/users/#{@username}/rss")['rss']['channel']['item']
+    end
+  end
+end

data/lib/stars/formatter.rb

@@ -0,0 +1,70 @@
+require 'terminal-table/import'
+
+module Stars
+  class Formatter
+    
+    attr_accessor :tweets
+
+    def initialize(tweets)
+      @tweets = tweets
+    end
+  
+    # I hate clients that don't retain line breaks, but in this case I'm boss.
+    def trim(text)
+      truncated = text.gsub("\n"," ")[0..50]
+      truncated + (truncated.size == text.size ? '' : '...')
+    end
+  
+    def format(tweet)
+      stars,text = split_stars(tweet['title'])
+      [stars,relative_time(tweet['pubDate']),text]
+    end
+  
+    def split_stars(text)
+      stars = text.match(/[\d+]./)[0].to_i
+      strip_point = text.index(':') + 2
+      text  = text[strip_point..text.size] 
+      [characterize(stars),trim(text)]
+    end
+  
+    def characterize(number)
+      if number > 5
+        "* x #{number}"
+      else
+        number.times.collect{'*'}.join(' ')
+      end
+    end
+  
+    def line_break
+      "\n"
+    end
+  
+    def to_s
+      tweets = @tweets.reverse.collect{|tweet| format tweet}
+      table(['Stars','Time','Your Funnies'], *tweets).render
+    end
+  
+    def relative_time(time)
+      post_date = Time.parse(time)
+      timespan = Time.now - Time.parse(time)
+
+      case timespan
+      when 0..59
+        "just now"
+      when 60..(3600-1)
+        "#{pluralize((timespan/60).to_i, 'minute', 'minutes')} ago"
+      when 3600..(3600*24-1)
+        "#{pluralize((timespan/3600).to_i, 'hour', 'hours')} ago"
+      when (3600*24)..(3600*24*30)
+        "#{pluralize((timespan/(3600*24)).to_i, 'day', 'days')} ago"
+      else
+        post_date.strftime("%m/%d/%Y")
+      end
+    end
+  
+    # ActiveSupport pluralize
+    def pluralize(count, singular, plural = nil)
+      "#{count || 0} " + ((count == 1 || count == '1') ? singular : (plural || singular.pluralize))
+    end
+  end
+end

data/lib/stars.rb

@@ -0,0 +1,8 @@
+module Stars ; end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/stars')
+
+require 'httparty'
+require 'client'
+require 'favstar'
+require 'formatter'

data/stars.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{stars}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zach Holman"]
+  s.date = %q{2010-03-14}
+  s.default_executable = %q{stars}
+  s.description = %q{Recent favstar faves on your command line.}
+  s.email = %q{github.com@zachholman.com}
+  s.executables = ["stars"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "bin/stars",
+     "lib/stars.rb",
+     "lib/stars/client.rb",
+     "lib/stars/favstar.rb",
+     "lib/stars/formatter.rb",
+     "stars.gemspec",
+     "test/helper.rb",
+     "test/test_client.rb",
+     "test/test_favstar.rb",
+     "test/test_formatter.rb",
+     "test/test_stars.rb"
+  ]
+  s.homepage = %q{http://github.com/holman/stars}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Recent favstar faves on your command line}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_client.rb",
+     "test/test_favstar.rb",
+     "test/test_formatter.rb",
+     "test/test_stars.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_runtime_dependency(%q<terminal-table>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<terminal-table>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<terminal-table>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'test/unit'
+require 'redgreen'
+require 'rr'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'stars'
+
+class Test::Unit::TestCase
+  
+  include RR::Adapters::TestUnit
+  
+  def favstar_tweet_hash
+    [
+      {
+       "title"=>"2 stars: I pre-ordered an iPad, checked into lunch, and now you want me to follow someone just because it's Friday? I CAN'T KEEP UP WITH YOU GUYS", 
+       "pubDate"=>"Fri, 12 Mar 2010 20:43:40 +0000", 
+       "guid"=>"http://favstar.fm/users/holman/status/10389110831?2", 
+       "description"=>"Has been faved by 2 people<br /><br /><a href=\"http://favstar.fm/users/holman/status/10389110831\">This tweet</a>
+       &nbsp;&nbsp;&nbsp;<a href=\"http://favstar.fm/users/holman/recent\">All Recent</a>", 
+       "link"=>"http://favstar.fm/users/holman/status/10389110831"
+      }, 
+      {
+       "title"=>"1 star: In another life I want to be a pop star heartthrob who also codes Perl in his free time. That'll confuse those impressionable teen fangirls.", 
+       "pubDate"=>"Fri, 12 Mar 2010 20:13:46 +0000", 
+       "guid"=>"http://favstar.fm/users/holman/status/10387998839?1", 
+       "description"=>"Has been faved by 1 person<br /><br /><a href=\"http://favstar.fm/users/holman/status/10387998839\">This tweet</a>
+       &nbsp;&nbsp;&nbsp;<a href=\"http://favstar.fm/users/holman/recent\">All Recent</a>", 
+       "link"=>"http://favstar.fm/users/holman/status/10387998839"
+       }
+    ]
+  end
+  
+end

data/test/test_client.rb

@@ -0,0 +1,31 @@
+require 'helper'
+
+class TestClient < Test::Unit::TestCase
+
+  def test_load
+    mock(Stars::Formatter).new.with_any_args
+    mock(Stars::Client).puts.with_any_args
+    Stars::Client.load!
+  end
+  
+  def test_username_when_exists
+    mock(File).exists?.with_any_args.returns(true)
+    mock(File).read.with_any_args
+    Stars::Client.username
+  end
+  
+  def test_username_when_nonexistant
+    mock(File).exists?.with_any_args.returns(false)
+    mock(Stars::Client).prompt_for_username
+    Stars::Client.username
+  end
+  
+  def test_write_home_config
+    assert_equal Stars::Client.remember_username('holman'), 'holman'
+  end
+  
+  def test_config_path
+    assert Stars::Client.config_path.index('.stars')
+  end
+  
+end

data/test/test_favstar.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestFavstar < Test::Unit::TestCase
+
+  def setup
+    @favstar = Stars::Favstar.new('holman')
+  end
+
+  def test_sets_username
+    assert_equal @favstar.username, 'holman'
+  end
+  
+  def test_parties_hard
+    mock(Stars::Favstar).get('/users/holman/rss') { 
+      {'rss' => {'channel' => {'item' => 'etc'} } }
+    }
+    @favstar.recent
+  end
+
+end

data/test/test_formatter.rb

@@ -0,0 +1,66 @@
+require 'helper'
+
+class TestFormatter < Test::Unit::TestCase
+
+  def setup
+    @formatter = Stars::Formatter.new(favstar_tweet_hash)
+  end
+
+  def test_trim_breaks
+    tweet = "Line breaks\nare for lovers"
+    assert_equal @formatter.trim(tweet), 'Line breaks are for lovers'
+  end
+  
+  def test_trim_length
+    tweet = "This is a tweet that is long enough to certainly "+
+            "need at least SOME truncating lol lol sigh."
+    assert_equal @formatter.trim(tweet), 
+                 'This is a tweet that is long enough to certainly ne...'
+  end
+  
+  def test_format
+    format = @formatter.format(favstar_tweet_hash[0])
+    assert_equal format.size, 3
+    assert_equal format[0], '* *'
+  end
+
+  def test_split_stars
+    tweet = "12 stars: A short tweet. Hey, a number: 5."
+    assert_equal @formatter.split_stars(tweet),
+                 ['* x 12', 'A short tweet. Hey, a number: 5.']
+  end
+  
+  def test_characterize_with_lots_of_stars
+    assert_equal @formatter.characterize(12),
+                 '* x 12'
+  end
+  
+  def test_characterize_with_a_few_stars
+    assert_equal @formatter.characterize(4),
+                 '* * * *'
+  end
+  
+  def test_line_break
+    assert_equal @formatter.line_break, "\n"
+  end
+  
+  def test_to_s
+    # just make sure it doesn't blow up for now
+    @formatter.to_s
+  end
+  
+  def test_relative_time
+    assert_equal @formatter.relative_time((Time.now - 2).to_s),
+                 "just now"
+    assert_equal @formatter.relative_time((Time.now - 360).to_s),
+                 "6 minutes ago"
+    assert_equal @formatter.relative_time((Time.now - 10000).to_s),
+                 "2 hours ago"
+  end
+  
+  def test_pluralizer
+    assert_equal @formatter.pluralize(1, 'day', 'day'), '1 day'
+    assert_equal @formatter.pluralize(2, 'day', 'days'), '2 days'
+  end
+
+end

data/test/test_stars.rb

@@ -0,0 +1,9 @@
+require 'helper'
+
+class TestStars < Test::Unit::TestCase
+  
+  def test_model
+    assert defined?(Stars)
+  end
+  
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: stars
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Zach Holman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-14 00:00:00 -08:00
+default_executable: stars
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: terminal-table
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Recent favstar faves on your command line.
+email: github.com@zachholman.com
+executables: 
+- stars
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/stars
+- lib/stars.rb
+- lib/stars/client.rb
+- lib/stars/favstar.rb
+- lib/stars/formatter.rb
+- stars.gemspec
+- test/helper.rb
+- test/test_client.rb
+- test/test_favstar.rb
+- test/test_formatter.rb
+- test/test_stars.rb
+has_rdoc: true
+homepage: http://github.com/holman/stars
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Recent favstar faves on your command line
+test_files: 
+- test/helper.rb
+- test/test_client.rb
+- test/test_favstar.rb
+- test/test_formatter.rb
+- test/test_stars.rb