github_metadata 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+tmp/*
+coverage
+rdoc
+*.gem
+.bundle

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in github_metadata.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    github_metadata (0.1.0)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    nokogiri (1.4.4)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    simplecov (0.3.7)
+      simplecov-html (>= 0.3.7)
+    simplecov-html (0.3.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  github_metadata!
+  nokogiri
+  rspec (>= 2.0.0)
+  simplecov

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Christoph Olszowka
+
+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.rdoc

@@ -0,0 +1,52 @@
+= Github Metadata
+
+The Github repository API does not include all the information available on the
+web view of a repo. It also has some trouble reporting correctly the availability of 
+a wiki and issues.
+
+The github_metadata gem is here to solve this. Currently it gives you, for any github repo:
+
+  * The availability and (if present) the count of wiki pages
+  * The availability and (if present) the count of issues
+  * The count of pull requests
+  * The list of contributors, with username and real name if available, and thereby also
+    the count of contributors
+    
+By the way: It goes very easy on the github servers in doing so, currently only performing 1 request 
+to fetch all of the information per instance.
+    
+== Usage
+
+  $ gem install github_metadata
+  $ irb
+  > require 'github_metadata'
+  > m = GithubMetadata.new('aslakhellesoy', 'cucumber')
+  > m.has_wiki?
+  => true
+  > m.wiki_pages
+  => 71
+  > m.has_issues?
+  => false
+  > m.contributor_usernames
+  => ['aslakhellesoy', ...]
+  
+Check out the full documentation to see all available methods.
+
+== TODO
+  
+  * Better (any?) error handling
+  * Merge with my very own first_github_commit gem, which retrieves the very first commit to a repo
+  
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2011 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/github_metadata.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "github_metadata/version"
+
+Gem::Specification.new do |s|
+  s.name        = "github_metadata"
+  s.version     = GithubMetadata::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christoph Olszowka"]
+  s.email       = ["christoph at olszowka de"]
+  s.homepage    = ""
+  s.summary     = %q{Extracts additional information from Github repos that isn't available via API}
+  s.description = %q{Extracts additional information like amount of committers, issues and wiki pages from Github repos}
+
+  s.rubyforge_project = "github_metadata"
+  
+  s.add_dependency 'nokogiri'
+  s.add_development_dependency 'rspec', '>= 2.0.0'
+  s.add_development_dependency 'simplecov'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/github_metadata/version.rb

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

data/lib/github_metadata.rb

@@ -0,0 +1,98 @@
+require 'rubygems'
+require 'open-uri'
+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
+  attr_reader :user, :repo
+  
+  # Object representation of a github contributor
+  class Contributor
+    attr_reader :username, :realname
+    def initialize(username, realname=nil)
+      @username, @realname = username, realname
+    end
+  end
+  
+  def initialize(user, repo)
+    @user, @repo = user, repo
+  end
+  
+  # Returns an array of GithubMetadata::Contributor instances, one for each
+  # contributor listed on the contributors page of github
+  def contributors
+    load_contributors unless @contributors
+    @contributors
+  end
+  
+  # Shorthand form for getting an array of all contributor github usernames
+  def contributor_usernames
+    @contributor_usernames ||= contributors.map(&:username)
+  end
+  
+  # Shorthand form for getting an array of all contributor github realnames,
+  # with users that don't have a realname specified filtered out
+  def contributor_realnames
+    @contributor_realnames ||= contributors.map(&:realname).compact
+  end
+  
+  # Will return all contributor real names, falling back to the username when 
+  # real name is not specified
+  def contributor_names
+    @contributor_names ||= contributors.map {|c| c.realname || c.username }
+  end
+  
+  # Returns true when the repo has a wiki
+  def has_wiki?
+    !!wiki_pages
+  end
+  
+  # Returns the amount of wiki pages or nil when no wiki is present
+  def wiki_pages
+    wiki_link = document.at_css('a[highlight="repo_wiki"]')
+    return nil unless wiki_link
+    wiki_link.text[/\d+/].to_i
+  end
+  
+  # Returns true if the repo has issues enabled
+  def has_issues?
+    !!issues
+  end
+  
+  # Returns issue count or nil if issues are disabled
+  def issues
+    issue_link = document.at_css('a[highlight="issues"]')
+    return nil unless issue_link
+    issue_link.text[/\d+/].to_i
+  end
+  
+  # Returns amount of pull requests
+  def pull_requests
+    pull_request_link = document.at_css('a[highlight="repo_pulls"]')
+    return nil unless pull_request_link
+    pull_request_link.text[/\d+/].to_i
+  end
+  
+  private
+  
+    def document
+      @document ||= Nokogiri::HTML(open(contributors_url))
+    end
+    
+    def contributors_url
+      "https://github.com/#{user}/#{repo}/contributors"
+    end
+    
+    def load_contributors
+      @contributors = document.css('#repos #watchers.members li').map do |contributor|
+        line = contributor.text.gsub("\n", '').squeeze(' ').strip.chomp
+        username = line.match(/^([^\ ]+)/)[1]
+        
+        name_match = line.match(/\(([^\)]+)\)/)
+        real_name = name_match ? name_match[1] : nil
+        
+        GithubMetadata::Contributor.new(username, real_name)
+      end
+    end
+end

data/spec/github_metadata_spec.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+require 'spec_helper'
+describe GithubMetadata do
+  context "initialized with aslakhellesoy/cucumber" do
+    before(:all) do
+      @metadata = GithubMetadata.new('aslakhellesoy', 'cucumber')
+      @raw = open("https://github.com/#{@metadata.user}/#{@metadata.repo}/contributors").read
+    end
+    subject { @metadata }
+
+    describe '#user' do
+      specify do
+        subject.user.should == 'aslakhellesoy'
+      end
+    end
+    
+    describe '#repo' do
+      specify do
+        subject.repo.should == 'cucumber'
+      end
+    end
+    
+    specify do
+      subject.should have_wiki
+    end
+    
+    describe '#wiki_pages' do
+      specify do
+        expected = @raw.match(/Wiki \((\d+)\)/)[1].to_i
+        expected.should be > 50
+        subject.wiki_pages.should == expected
+      end
+    end
+    
+    specify do
+      subject.should_not have_issues
+    end
+    
+    describe '#issues' do
+      specify do
+        subject.issues.should == nil
+      end
+    end
+    
+    describe '#pull_requests' do
+      specify do
+        expected = @raw.match(/Pull Requests \((\d+)\)/)[1].to_i
+        subject.pull_requests.should == expected
+      end
+    end
+    
+    describe '#contributors' do
+      specify do
+        expected = @raw.match(/(\d+) contributors/)[1].to_i
+        subject.contributors.length.should == expected
+      end
+    end
+    
+    describe '#contributor_usernames' do
+      specify do
+        subject.contributor_usernames.should include('aslakhellesoy')
+      end
+    end
+    
+    describe '#contributor_realnames' do
+      specify do
+        subject.contributor_realnames.should include('Iain Hecker', 'Elliot Crosby-McCullough', 'Aslak Hellesøy')
+      end
+      
+      specify do
+        subject.contributor_realnames.length.should < subject.contributor_usernames.length
+      end
+    end
+    
+    describe '#contributor_names' do
+      specify do
+        subject.contributor_names.count.should == subject.contributors.count
+      end
+      
+      specify do
+        subject.contributor_names.should include('Iain Hecker', 'Elliot Crosby-McCullough', 'Aslak Hellesøy')
+      end
+      
+      specify do
+        subject.contributor_names.should include('marocchino')
+      end
+    end
+  end
+  
+  context "initialized with colszowka/simplecov" do
+    before(:all) do
+      @metadata = GithubMetadata.new('colszowka', 'simplecov')
+      @raw = open("https://github.com/#{@metadata.user}/#{@metadata.repo}/contributors").read
+    end
+    subject { @metadata }
+
+    describe '#user' do
+      specify do
+        subject.user.should == 'colszowka'
+      end
+    end
+    
+    describe '#repo' do
+      specify do
+        subject.repo.should == 'simplecov'
+      end
+    end
+
+    specify do
+      subject.should_not have_wiki
+    end
+    
+    describe '#wiki_pages' do
+      specify do
+        subject.wiki_pages.should be nil
+      end
+    end
+    
+    specify do
+      subject.should have_issues
+    end
+
+    describe '#issues' do
+      specify do
+        expected = @raw.match(/Issues \((\d+)\)/)[1].to_i
+        subject.issues.should == expected
+      end
+    end
+    
+    describe '#pull_requests' do
+      specify do
+        subject.pull_requests.should be 0
+      end
+    end
+    
+    describe '#contributors' do
+      specify do
+        expected = @raw.match(/(\d+) contributors/)[1].to_i
+        subject.contributors.length.should be expected
+      end
+      
+      it 'should be all instance of Contributor' do
+        subject.contributors.should be_all {|c| c.instance_of?(GithubMetadata::Contributor)}
+      end
+    end
+    
+    describe '#contributor_usernames' do
+      specify do
+        subject.contributor_usernames.should include('colszowka')
+      end
+    end
+    
+    describe '#contributor_realnames' do
+      specify do
+        subject.contributor_realnames.should include('Christoph Olszowka')
+      end
+    end
+    
+    describe '#contributor_names' do
+      specify do
+        subject.contributor_names.count.should be subject.contributors.count
+      end
+      specify do
+        subject.contributor_names.should include('Christoph Olszowka')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start
+require 'github_metadata'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: github_metadata
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Extracts additional information like amount of committers, issues and wiki pages from Github repos
+email: 
+- christoph at olszowka de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- github_metadata.gemspec
+- lib/github_metadata.rb
+- lib/github_metadata/version.rb
+- spec/github_metadata_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: github_metadata
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extracts additional information from Github repos that isn't available via API
+test_files: 
+- spec/github_metadata_spec.rb
+- spec/spec_helper.rb