stars 0.4.0 → 0.5.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    stars (0.5.0)
+      httparty
+      keep (~> 0.0.3)
+      nokogiri
+      terminal-table
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    httparty (0.7.6)
+      crack (= 0.1.8)
+    keep (0.0.3)
+    mocha (0.9.12)
+    nokogiri (1.4.4)
+    terminal-table (1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 0.9.9)
+  stars!

data/README.markdown

@@ -3,72 +3,58 @@
 
 ## 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.
+Stars are a global currency. You tweet something, you write something, you
+otherwise put yourself out there. Sure, you feel a warm sense of accomplishment
+when you do this, but how do you *really* know if the people like you?
 
-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é.
+**FUCKING STARS, THAT'S HOW**
 
-## 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:
-
-     ★  by @holman
-    +----+-----------+--------------+--------------------------------------------------------+
-    | #  | Stars     | Time         | Your Funnies                                           |
-    +----+-----------+--------------+--------------------------------------------------------+
-    | 1  | *         | 12 hours ago | Today's GitHub todo list: put cupholders in the for... |
-    | 2  | * * *     | 1 day ago    | This bus is going so slowly that my AT&T 3G coverag... |
-    | 3  | * * * * * | 2 days ago   | Every now and then I bust out that I'm from North D... |
-    | 4  | * * *     | 3 days ago   | Was told that "y'alls be stupid" by an adamant stre... |
-    | 5  | * *       | 4 days ago   | Now that we've fixed healthcare forever, who wants ... |
-    | 6  | * * * *   | 4 days ago   | Just wikipedia'd "Justin Bieber" and I still don't ... |
-    | 7  | * * * *   | 5 days ago   | Look. I'm not saying David Copperfield is a little ... |
-    | 8  | *         | 6 days ago   | SFO.  Guys, we're at TERROR ALERT ORANGE. I don't t... |
-    | 9  | *         | 7 days ago   | Dammit. 2012 looks like garbage so far, but if a mo... |
-    | 10 | *         | 10 days ago  | At the MySQL + Rails combined meetup. I don't want ... |
-    | 11 | *         | 10 days ago  | Oh, they're doing a MacGruber movie. This makes sen... |
-    | 12 | * * *     | 10 days ago  | Just got my third free replacement earbuds from the... |
-    | 13 | * x 13    | 11 days ago  | So for the seven of us that are both nerdy *and* va... |
-    | 14 | * * * * * | 11 days ago  | I wouldn't say I'm "saving daylight" as much as I'm... |
-    | 15 | * * *     | 13 days ago  | I pre-ordered an iPad, checked into lunch, and now ... |
-    | 16 | * *       | 13 days ago  | In another life I want to be a pop star heartthrob ... |
-    | 17 | *         | 14 days ago  | Oh hey, a year or so of my beer consumption: http:/... |
-    | 18 | *         | 14 days ago  | Going to totally refork and rework my dotfiles soon... |
-    | 19 | * * *     | 15 days ago  | You change your Facebook pic, that syncs to my iPho... |
-    | 20 | * *       | 17 days ago  | just about finished my thesis on generating free en... |
-    +----+-----------+--------------+--------------------------------------------------------+
-
-
-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.
-
-You can also specify which user you want to run the query against by passing it in as your one argument. This value is saved for the future, too. For example:
+`stars` is a command-line client to check your precious stars at fine
+establishments like [Twitter](http://twitter.com) (via the exquisite
+[Favstar](http://favstar.fm)) and [Convore](http://convore.com). More services
+will be added as they get added.
 
-    stars holman        # generates @holman's stars
-    stars               # generates @holman's stars
-    stars goodtutorials # generates @goodtutorials' stars
-    stars               # generates @goodtutorials' stars
-
-You can also get some knowledge dropped all over your face about a specific toot:
-
-	Type the number of the toot that you want to learn about
-	  (or hit return to view all again, you ego-maniac)   >>
-	14
-
-	  5 stars: I wouldn't say I'm "saving daylight" as much as
-	    I'm sequestering it in a small room underneath my stairs so
-	    its screams can't be heard.
-    
-	    ★   twilighteyes08
-	    ★   itsjustEm
-	    ★   aklw
-	    ★   shariv67
-	    ★   IsJonas
-	    RT  kneath
-
-
-## state of affairs
+## how
 
-Fork this bad boy and shape it as you see fit. I just randomly built some shit that I might like; maybe that process will work for you, too. Send me a pull request if you ship something awesome. Reminder: something is never awesome without tests.
+Install with `gem install stars`, then do a quick `stars`, fill in your
+username for your service, and let it do its sultry magic. This is me lately:
+
+    ★  stars
+    +----+---------+-------+-----------------------------------------+
+    |    | Service | Stars |               The Hotness               |
+    +----+---------+-------+-----------------------------------------+
+    |  1 | Convore |  29   | Number of stars received                |
+    |  2 | Favstar |   5   | we're flawed because we want so much... |
+    |  3 | Favstar |   3   | Cherish your drunken coworker moment... |
+    |  4 | Favstar |   5   | Usually @kneath teaches me that a li... |
+    |  5 | Favstar |   2   | Whew. Done with cohosting #codeconf.... |
+    |  6 | Favstar |   2   | 1) Guys do lightning talk 2) Mention... |
+    |  7 | Favstar |   1   | I am in a suit, and I'm addressing t... |
+    |  8 | Favstar |   3   | @kneath you have to take a picture o... |
+    |  9 | Favstar |   3   | I won't work until GitHub defunds fr... |
+    | 10 | Favstar |   1   | Coordinating my attire for @codeconf... |
+    | 11 | Favstar |   1   | You are the wind beneath my wings! I... |
+    | 12 | Favstar |   1   | One of those rare San Francisco nigh... |
+    | 13 | Favstar |   1   | @GavinStark Me too!                     |
+    | 14 | Favstar |  30   | Why @github hacks on side projects: ... |
+    | 15 | Favstar |   1   | @luckiestmonkey all the borg would g... |
+    +----+---------+-------+-----------------------------------------+
+
+## BONUS ROUND
+
+Plopped a whopper of a comparison on Convore between Python's whitespacing and
+the piddly lawyer in Jurassic Park, and want to see the results *right now,
+dammit??!??!?!?!*? Have no fear! Check your service stars directly with `stars
+<service>`:
+
+    stars convore
+
+## whip it out
+
+`stars` is kind of a silly little project. It's not as well-tested or
+well-documented as I'd like, but so it goes. Fork, send me a pull request, and
+we'll all be friends.
 
 ## 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/).
+[@holman](http://twitter.com/holman) did this. I look great in a Speedo.

data/Rakefile

@@ -1,25 +1,50 @@
 require 'rubygems'
 require 'rake'
+require 'date'
 
-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')
-    gem.add_dependency('nokogiri')
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
 end
 
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -27,29 +52,99 @@ Rake::TestTask.new(:test) do |test|
   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
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
 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.title = "#{name} #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/stars

@@ -1,10 +1,8 @@
 #!/usr/bin/env ruby
- 
 require 'rubygems'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 
 require 'stars'
 
-username = ARGV ? ARGV[0] : nil
-Stars::Client.load!(username)
+Stars::Client.new(ARGV)

data/lib/stars/client.rb

@@ -1,81 +1,98 @@
-# encoding: utf-8
-
+# Client is our interface between user and terminal prompt. This does all of
+# the heavy-lifting for formatting.
+#
 module Stars
   class Client
-
-    def self.load!(new_username=nil)
-      remember_username(new_username) if new_username
-      @recent = Stars::Favstar.new.recent(username)
-      display
-    end
     
-    def self.display
-      system 'clear'
-      puts "\n ★  by @#{username}"
-      puts Stars::Formatter.new(@recent)
-      select_star
-    end
+    attr_reader :posts
+    attr_writer :posts
+    
+    # Initializes a new Client.
+    #
+    # Returns nothing.
+    def initialize(cmd)
+      Stars.config.prompt_for_username(cmd[1]) if cmd[0] == 'add'
 
-    def self.input
-      STDIN.gets
-    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(self.input.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')
+      system "clear"
+      puts "★  stars"
+
+      display(cmd[0])
+      star_loop
     end
-    
-    def self.select_star
+
+    # Run a loop FOREVER until we kill it or we make a selection.
+    #
+    # Returns nothing.
+    def star_loop
       selection = ''
       while true
-        puts "Type the number of the toot that you want to learn about"
+        puts "Type the number of the post that you want to learn about"
         print "  (or hit return to view all again, you ego-maniac)   >> "
-        selection = self.input.chomp
+        selection = $stdin.gets.chomp
         break if ['','q','quit','exit','fuckthis'].include?(selection.downcase)
-        show_selection(selection)
+        show(selection)
       end
       display if selection == ''
     end
-    
-    def self.show_selection(id)
-      id = id.to_i - 1
-      if @recent[id]
-        puts ''
-        puts wrap_text('  ' + @recent[id]['title'], 60)
-        puts parse_who(@recent[id]['guid'])
-        puts ''
+
+    # Displays all of the star tables and information we have.
+    #
+    # Returns nothing.
+    def display(service=nil)
+      Stars.config.prompt_for_service if Stars.installed_services.empty?
+
+      if service
+        posts = service.constantize.posts
       else
-        puts ''
-        puts 'Oops, no such toot.'
-        puts ''
+        posts = Stars.installed_services.collect{ |service| 
+                                  service.constantize.posts }.flatten
       end
+      @posts = Post.filter(posts)
+      puts print_posts(@posts)
     end
-    
-    def self.parse_who(url)
-      Stars::Favstar.new.show(url)
+
+    # Show more information about a particular post.
+    #
+    # id - the Integer id entered by the user, which we map to a Post
+    #
+    # Returns nothing (although does delegate to the Post to show #more).
+    def show(id)
+      post = @posts[id.to_i-1]
+      return puts("\nMake a valid selection. Pretty please?\n") unless post
+      puts post.more
+      display
     end
-    
-    def self.wrap_text(txt, col = 80)
-      txt.gsub(/(.{1,#{col}})( +|$\n?)|(.{1,#{col}})/,
-        "\\1\\3\n    ") 
+
+    # This does the actual printing of posts.
+    #
+    # posts - an Array of Post objects
+    #
+    # It loops through the Array of posts and sends them to `terminal-table`.
+    def print_posts(posts)
+      table do |t|
+        t.headings = headings
+        posts.each_with_index do |post,i|
+          t << [
+                { :value => i+1, :alignment => :right },
+                post.service.capitalize,
+                { :value => post.stars_count, :alignment => :center },
+                post.short_name
+               ]
+        end
+      end      
     end
-  
+
+    # The headings used in the resulting printed table.
+    #
+    # This returns an Array of headings.
+    def headings
+      [ 
+        '',
+        'Service',
+        'Stars',
+        {:value => 'The Hotness', :alignment => :center } 
+      ]
+    end
+
   end
 end

data/lib/stars/config.rb

@@ -0,0 +1,41 @@
+module Stars
+  class Config
+
+    attr_reader :keep
+
+    attr_writer :keep
+    
+    def initialize
+      @keep = Keep.new(config_path)
+    end
+
+    def config_path
+      "#{File.expand_path('~')}/.stars.yml"
+    end
+
+    def username(service)
+      prompt_for_username(service)
+    end
+
+    def prompt_for_service
+      puts "What service do you want to track?"
+      puts "Your options: #{Stars.uninstalled_services.join(', ')}"
+      service = $stdin.gets.chomp.downcase
+      prompt_for_username(service)
+    end
+
+    def prompt_for_username(service)
+      return @keep.get(service) if @keep.present?(service)
+
+      if !Stars.uninstalled_services.empty? and !Stars.uninstalled_services.include?(service.downcase)
+        puts("You need to pick something from: #{Stars.uninstalled_services.join(', ')}")
+        return exit
+      end
+
+      puts "What's your username for #{service}?"
+      username = $stdin.gets.chomp
+      @keep.set(service,username)
+    end
+
+  end
+end

data/lib/stars/core_ext/string.rb

@@ -0,0 +1,6 @@
+class String
+  # Poor man's constantize
+  def constantize
+    Stars.const_get(to_s.capitalize)
+  end
+end

data/lib/stars/post.rb

@@ -0,0 +1,57 @@
+module Stars
+  class Post
+    attr_reader :url
+    attr_reader :service
+    attr_reader :stars_count
+    attr_reader :date
+
+    attr_writer :name
+    attr_writer :service
+    attr_writer :url
+    attr_writer :stars
+    attr_writer :stars_count
+    attr_writer :date
+
+    def initialize(attributes)
+      @name        = attributes[:name]
+      @url         = attributes[:url]
+      @stars       = attributes[:stars]
+      @stars_count = attributes[:stars_count]
+      @service     = attributes[:service]
+      @date        = attributes[:date]
+    end
+
+    # The String name of the Post.
+    #
+    # This returns the String of the content of the Post (which we just call 
+    # "name"). We also strip whitespace, since it tends to screw up things on
+    # the command line.
+    def name
+      @name.gsub("\n",' ')
+    end
+
+    # The shorted String version of `name`.
+    #
+    # Returns a String of the name truncated at 35 characters.
+    def short_name
+      name.size > 35 ? "#{name[0..35]}..." : name
+    end
+
+    def stars
+      @stars
+    end
+
+    def more
+      service.constantize.more(self)
+    end
+
+    # Filter an Array of Post objects.
+    #
+    #   posts - an Array of Post objects to filter
+    #
+    # This returns the Array sorted by the 15 most recent stars.
+    def self.filter(posts)
+      posts.sort{ |a,b| b.date <=> a.date }[0..14]
+    end
+  end
+end

data/lib/stars/services/convore.rb

@@ -0,0 +1,40 @@
+module Stars
+  class Convore < Service
+
+    attr_reader :posts
+
+    def name
+      "convore"
+    end
+
+    def posts
+      [Post.new(:name        => "Number of stars received",
+                :stars_count => stars,
+                :service     => name,
+                :date        => DateTime.now,
+                :url         => "https://convore.com/users/#{Stars.config.username('convore')}")]
+    end
+
+    def html
+      Nokogiri::HTML(open("https://convore.com/users/#{username}"))
+    end
+
+    def stars
+      html.css('.stars-received strong').first.content.to_i
+    end
+
+    def self.more(post)
+return <<-CONVORE
+
+Convore doesn't have a stars API yet. So we're just scraping your total stars 
+for now. Kind of a bummer, isn't it? You should probably send @ericflo a tweet 
+and complain about it. Tell him I didn't send you.
+
+Anyway, you have #{post.stars_count} stars with Convore right now. Check it:
+  #{post.url}
+
+CONVORE
+    end
+
+  end
+end