github_metadata 0.1.0 → 0.1.1

data/lib/github_metadata/version.rb

@@ -1,3 +1,3 @@
 class GithubMetadata
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/github_metadata.rb

@@ -5,6 +5,8 @@ require 'nokogiri'
 # A simple scraper that fetches data from github repos that is not
 # available via the API. See README for an introduction and overview.
 class GithubMetadata
+  class RepoNotFound < StandardError; end;
+  
   attr_reader :user, :repo
   
   # Object representation of a github contributor
@@ -19,6 +21,21 @@ class GithubMetadata
     @user, @repo = user, repo
   end
   
+  # Similar to initialization with GithubMetadata.new, but it will immediately try
+  # to fetch the repo document and importantly will swallow GithubMetadata::RepoNotFound 
+  # errors, returning nil instead so you can easily do something like this:
+  #
+  # if metdata = GithubMetadata.fetch('rails', 'rails')
+  #   ...
+  # end
+  def self.fetch(user, repo)
+    instance = new(user, repo)
+    instance.issues
+    instance
+  rescue GithubMetadata::RepoNotFound => err
+    nil
+  end
+  
   # Returns an array of GithubMetadata::Contributor instances, one for each
   # contributor listed on the contributors page of github
   def contributors
@@ -78,6 +95,8 @@ class GithubMetadata
   
     def document
       @document ||= Nokogiri::HTML(open(contributors_url))
+    rescue OpenURI::HTTPError => err
+      raise GithubMetadata::RepoNotFound, err.to_s
     end
     
     def contributors_url

data/spec/github_metadata_spec.rb

@@ -166,4 +166,21 @@ describe GithubMetadata do
     end
   end
 
+  context "initialized with an invalid repo path" do
+    before(:all) do
+      @metadata = GithubMetadata.new('colszowka', 'somefunkyrepo')
+    end
+    subject { @metadata }
+    
+    it "should raise GithubMetadata::RepoNotFound" do
+      lambda { subject.issues }.should raise_error(GithubMetadata::RepoNotFound)
+    end
+  end
+  
+  describe "fetch with invalid repo path" do
+    it "should return nil and swallow the 404" do
+      GithubMetadata.fetch('colszowka', 'anotherfunkyrepo').should be nil
+    end
+  end
+
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Christoph Olszowka