technicalpickles-gemstalker 0.3.0 → 0.3.1

data/{README → README.rdoc}

@@ -1,9 +1,8 @@
-gemstalker
-==========
+= gemstalker
 
 GemStalker is a small library to determine if GitHub has built a gem yet.
 
-    require 'gemstalker'
+    require 'gem_stalker'
 
     stalker = GemStalker.new(:username => 'technicalpickles', :repository => 'jeweler', :version => '0.7.2'
 
@@ -18,7 +17,8 @@ You can also omit the version, and it will take the version from the repository'
 
 Origin code borrowed and inspired by hasmygembuiltyet.org.
 
-COPYRIGHT
-=========
+Contributions from Jeff Rafter.
+
+== COPYRIGHT
 
 Copyright (c) 2009 Josh Nichols. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 0
+:patch: 1
 :major: 0
 :minor: 3

data/bin/gemstalk

@@ -8,8 +8,9 @@ def usage
   puts ""
   puts "  #{File.basename $0} <username> <repository> [version]"
   puts ""
-  puts "Begins stalking a gem at the specified location e.g. stalk techinicalpickles jeweler"
+  puts "Begins stalking a gem at the specified location. Example:" 
   puts ""
+  puts "  #{File.basename $0} techinicalpickles jeweler"
 end
 
 if ARGV.length == 0 || ARGV.include?("-h") || ARGV.include?("--help")
@@ -45,7 +46,7 @@ waiting = false
 puts "Checking to see if the gem has been built:"
 loop do
   if stalker.built?
-    put "." if waiting
+    puts "." if waiting
     puts "=> Zomg, it's built, I'm so telling everyone!" 
     break    
   end
@@ -59,7 +60,7 @@ waiting = false
 puts "Checking to see if it is in the specfile"
 loop do
   if stalker.in_specfile?
-    put "." if waiting
+    puts "." if waiting
     puts "=> Sweeeet, everyone can install it now!"
     break    
   end

data/lib/gem_stalker.rb

@@ -1,9 +1,16 @@
 require 'net/http'
 require 'rubygems/spec_fetcher'
 
+# Small class for determining if a gem has been built on GitHub and if it's installable.
 class GemStalker
   attr_accessor :username, :name, :repository, :version
 
+  # Accepts the following options:
+  #
+  # username::   GitHub username
+  # repository:: repository name
+  # version::    version to stalk. Defaults to checking the repository for a
+  #               gemspec to determine the latest version.
   def initialize(options = {})
     @username   = options[:username]
     @repository = options[:repository]
@@ -11,6 +18,7 @@ class GemStalker
 
   end
 
+  # Is it built yet?
   def built?
     Net::HTTP.start('gems.github.com') {|http|
       response = http.head(gem_path)
@@ -18,6 +26,7 @@ class GemStalker
     }
   end
   
+  # Is RubyGem building enabled for the repository?
   def gem?
     Net::HTTP.start('github.com') {|http|
       res = http.get(master_path)
@@ -26,6 +35,7 @@ class GemStalker
     false
   end
 
+  # Is it in the specs yet? ie is it installable yet?
   def in_specfile?
     fetcher = Gem::SpecFetcher.new
     specs = fetcher.load_specs(URI.parse('http://gems.github.com/'), 'specs')
@@ -34,6 +44,7 @@ class GemStalker
     end
   end
 
+  # Path to edit the repository
   def edit_repo_url
     "http://github.com/#{@username}/#{@repository}/edit"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technicalpickles-gemstalker
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Josh Nichols
@@ -24,7 +24,7 @@ extra_rdoc_files: []
 files: 
 - LICENSE
 - Rakefile
-- README
+- README.rdoc
 - VERSION.yml
 - bin/gemstalk
 - lib/gem_stalker.rb