first_github_commit 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) 2010 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,46 @@
+= First Github Commit
+
+Makes finding the very first commit to a GitHub repo very simple:
+
+  require 'first_github_commit'
+  require 'pp'
+  pp FirstGithubCommit.find('thoughtbot', 'shoulda')
+  =>  {"author"=> { ... }
+       "url"=> "http://github.com/thoughtbot/shoulda/commit/37686ae0dadb3a820db039a9ab3d024983034e7f",
+       "id"=>"37686ae0dadb3a820db039a9ab3d024983034e7f",
+       "committed_date"=>"2007-03-14T11:11:47-07:00",
+       "message"=>"Created trunk and tags (...)",       
+       (...)}
+       
+The data returned is that from the GitHub commit listing API, see http://develop.github.com/p/commits.html
+
+If you also want to know the page number, try this:
+
+  c = FirstGithubCommit.new('thoughtbot', 'shoulda')
+  c.yaml => {"author"=> ... } # Same as above
+  c.page => 14
+  # Get the url for the github commit listing web interface
+  c.github_url => "http://github.com/thoughtbot/shoulda/commits/master?page=14"
+
+The page number is being retrieved by first finding the highest non-available page number.
+Starting from page 100, the limit is being doubled on consecutive requests until the GitHub API
+returns a 404. Then, the chunk is split in half and traversed further until the single page is found.
+
+The web request limit is 30 consecutive requests, after which a FirstGithubCommit::TooManyRequests
+exception will be thrown. 
+
+Set FirstGithubCommit::DEBUG to true to get some debug output about the requests and the traversal.
+
+== 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) 2010 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "first_github_commit"
+    gem.summary = %Q{Find the first commit for a given github repository and return the API info for it}
+    gem.description = %Q{Find the first commit for a given github repository and return the API info for it by traversing the }
+    gem.email = "christoph at olszowka dot de"
+    gem.homepage = "http://github.com/colszowka/first_github_commit"
+    gem.authors = ["Christoph Olszowka"]
+    gem.add_dependency 'redirect_follower', '>= 0.1.1'
+    gem.add_development_dependency "shoulda", ">= 2.10.2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  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 = "first_github_commit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/first_github_commit.gemspec

@@ -0,0 +1,61 @@
+# 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{first_github_commit}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-06-03}
+  s.description = %q{Find the first commit for a given github repository and return the API info for it by traversing the }
+  s.email = %q{christoph at olszowka dot de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "first_github_commit.gemspec",
+     "lib/first_github_commit.rb",
+     "test/fast_context.rb",
+     "test/helper.rb",
+     "test/ruby_ext.rb",
+     "test/test_first_github_commit.rb"
+  ]
+  s.homepage = %q{http://github.com/colszowka/first_github_commit}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Find the first commit for a given github repository and return the API info for it}
+  s.test_files = [
+    "test/fast_context.rb",
+     "test/helper.rb",
+     "test/ruby_ext.rb",
+     "test/test_first_github_commit.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<redirect_follower>, [">= 0.1.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 2.10.2"])
+    else
+      s.add_dependency(%q<redirect_follower>, [">= 0.1.1"])
+      s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+    end
+  else
+    s.add_dependency(%q<redirect_follower>, [">= 0.1.1"])
+    s.add_dependency(%q<shoulda>, [">= 2.10.2"])
+  end
+end
+

data/lib/first_github_commit.rb

@@ -0,0 +1,94 @@
+require 'redirect_follower'
+require 'yaml'
+
+class FirstGithubCommit
+  class TooManyRequests < StandardError; end;
+
+  attr_reader :user, :repo, :requests_made, :page
+  
+  DEBUG = false
+  MAX_REQUESTS = 30
+  
+  def initialize(user, repo)
+    @user, @repo = user, repo
+    @requests_made = 0
+    @range = (1..100)
+    find_upper_limit
+    find_page_number
+  end
+  
+  def yaml
+    @yaml ||= YAML.load(last_response.body)["commits"].last
+  end
+  
+  def github_url
+    @github_url ||= "http://github.com/#{user}/#{repo}/commits/master?page=#{page}"
+  end
+  
+  def self.find(user, repo)
+    FirstGithubCommit.new(user, repo).yaml
+  end
+  
+  private
+  
+    attr_reader :last_response, :upper_limit, :lower_limit, :range
+    attr_writer :range
+  
+    def upper_limit
+      range.last
+    end
+    
+    def lower_limit
+      range.first
+    end
+  
+    def find_upper_limit
+      while get_page(range.last) and not last_response.kind_of?(Net::HTTPNotFound)
+        debug range.last
+        debug last_response.inspect
+        self.range = (upper_limit..upper_limit*2)
+      end
+    end
+    
+    def find_page_number
+      while last_response.kind_of?(Net::HTTPNotFound) or range.to_a.length > 2
+        self.range = (range.first..((range.last - range.first)/2 + range.first))
+        last_response = get_page(range.last)
+        debug last_response.inspect
+        if last_response.kind_of?(Net::HTTPSuccess)
+          self.range = (range.last..(range.last+range.last-range.first))
+        end
+        debug range.inspect
+      end
+
+      if last_response.kind_of?(Net::HTTPSuccess) 
+        @page = range.last
+      else
+        @page = range.first
+        last_response = get_page(page)
+      end
+      
+      page
+    end
+  
+    def get_page(page_number)
+      raise FirstGithubCommit::TooManyRequests if @requests_made > MAX_REQUESTS
+      @requests_made += 1
+      @last_response = RedirectFollower.new(url_for_page(page_number)).response
+    end
+  
+    def base_url
+      @base_url ||= "http://github.com/api/v2/yaml/commits/list/#{user}/#{repo}/master"
+    end
+    
+    def url_for_page(page_number)
+      base_url + "?page=#{page_number}"
+    end
+    
+    def debug(*args)
+      return nil unless DEBUG == true
+      args.each do |arg|
+        puts arg
+      end
+    end
+end

data/test/fast_context.rb

@@ -0,0 +1,88 @@
+puts "Loading fast_context"
+require 'shoulda/context'
+
+module ShouldaContextExtensions
+  def self.included(base)
+    base.class_eval do
+      #alias_method_chain :build, :fast_context
+      #alias_method_chain :am_subcontext?, :fast_context
+      
+      alias_method :build_without_fast_context, :build
+      alias_method :build, :build_with_fast_context
+      alias_method :am_subcontext_without_fast_context?, :am_subcontext?
+      alias_method :am_subcontext?, :am_subcontext_with_fast_context?
+    end
+  end
+
+  def fast_context(name, &blk)
+    @fast_subcontexts ||= []
+    @fast_subcontexts << Shoulda::FastContext.new(name, self, &blk)
+  end
+
+  def build_with_fast_context
+    build_without_fast_context
+    @fast_subcontexts ||= []
+    @fast_subcontexts.each {|f| f.build }
+  end
+
+  def am_subcontext_with_fast_context?
+    parent.is_a?(Shoulda::Context) || parent.is_a?(Shoulda::FastContext)
+  end
+end
+
+module Shoulda
+  class FastContext < Context
+    def create_test_from_should_hash
+      test_name = ["test:", full_name, "should", "run_fast"].flatten.join(' ').to_sym
+
+      if test_unit_class.instance_methods.include?(test_name.to_s)
+        warn "  * WARNING: '#{test_name}' is already defined"
+      end
+
+      context = self
+      test_unit_class.send(:define_method, test_name) do
+        @shoulda_context = context
+        @current_should = nil
+        begin
+          context.run_parent_setup_blocks(self)
+          context.shoulds.each do |s| 
+            @current_should = s
+            s[:before].bind(self).call if s[:before] 
+          end
+          context.run_current_setup_blocks(self)
+
+          context.shoulds.each {|should| should[:block].bind(self).call }
+        rescue Test::Unit::AssertionFailedError => e
+          error = Test::Unit::AssertionFailedError.new(["FAILED:", context.full_name, "should", "#{@current_should[:name]}:", e.message].flatten.join(' '))
+          error.set_backtrace e.backtrace
+          raise error
+        ensure
+          context.run_all_teardown_blocks(self)
+        end
+      end
+    end
+
+    def build
+      create_test_from_should_hash
+      subcontexts.each {|context| context.build }
+
+      @fast_subcontexts ||= []
+      @fast_subcontexts.each {|f| f.build }
+
+      print_should_eventuallys
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  def self.fast_context(name, &blk)
+    if Shoulda.current_context
+      Shoulda.current_context.fast_context(name, &blk)
+    else
+      context = Shoulda::FastContext.new(name, self, &blk)
+      context.build
+    end
+  end  
+end
+
+Shoulda::Context.send :include, ShouldaContextExtensions

data/test/helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'first_github_commit'
+require 'test/fast_context'
+require 'test/ruby_ext'
+
+class Test::Unit::TestCase
+
+  def self.after_finding(user, repo)
+    fast_context "After finding #{user}/#{repo}" do
+      setup { @yaml = FirstGithubCommit.find(user, repo) }
+      subject { @yaml }
+      
+      yield
+    end
+  end
+  
+  def self.after_initializing_for(user, repo)
+    fast_context "After initializing for #{user}/#{repo}" do
+      setup { @commit = FirstGithubCommit.new(user, repo) }
+      subject { @commit }
+      
+      yield
+    end
+  end
+
+  def self.should_return_a_hash
+    should "return a hash" do
+      assert subject.instance_of?(Hash)
+    end
+  end
+  
+  def self.should_have_value(expected_value, options)
+    should "have #{expected_value} in #{options[:at]}" do
+      assert_equal expected_value, subject.find_nested(options[:at])
+    end
+  end
+end

data/test/ruby_ext.rb

@@ -0,0 +1,11 @@
+class Hash
+  # {'foo' => {:bar => 'baz'}}.find_nested('foo.bar') => 'baz'
+  def find_nested(keys)
+    value = self
+    keys.split('.').each do |key|
+      value = value[key] || value[key.to_sym]
+    end
+    
+    value
+  end
+end

data/test/test_first_github_commit.rb

@@ -0,0 +1,32 @@
+require 'helper'
+require 'pp'
+class TestFirstGithubCommit < Test::Unit::TestCase
+  after_finding 'thoughtbot', 'shoulda' do
+    should_return_a_hash
+    should_have_value 'tsaleh', :at => 'author.name'
+    should_have_value '4b825dc642cb6eb9a060e54bf8d69288fbee4904', :at => "tree"
+    should_have_value "2007-03-14T11:11:47-07:00", :at => "authored_date"
+  end
+  
+  after_finding 'rails', 'rails' do
+    should_return_a_hash
+    should_have_value 'David Heinemeier Hansson', :at => 'author.name'
+    should_have_value 'dhh', :at => "author.login"
+    should_have_value "2004-11-25T14:07:29-08:00", :at => "committed_date"
+  end
+  
+  after_finding 'lifo', 'fast_context' do
+    should_return_a_hash
+    should_have_value 'Pratik Naik', :at => 'author.name'
+    should_have_value 'lifo', :at => "author.login"
+    should_have_value "2009-09-29T04:30:54-07:00", :at => "committed_date"
+  end
+  
+  after_initializing_for 'lifo', 'fast_context' do
+    should("have page 1 for page number") { assert_equal 1, subject.page }
+    should("have yaml hash") { assert subject.yaml.kind_of?(Hash) }
+    should "have 'http://github.com/lifo/fast_context/commits/master?page=1' for github_url" do
+      assert_equal 'http://github.com/lifo/fast_context/commits/master?page=1', subject.github_url
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: first_github_commit
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-03 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redirect_follower
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.10.2
+    version: 
+description: "Find the first commit for a given github repository and return the API info for it by traversing the "
+email: christoph at olszowka dot de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- first_github_commit.gemspec
+- lib/first_github_commit.rb
+- test/fast_context.rb
+- test/helper.rb
+- test/ruby_ext.rb
+- test/test_first_github_commit.rb
+has_rdoc: true
+homepage: http://github.com/colszowka/first_github_commit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Find the first commit for a given github repository and return the API info for it
+test_files: 
+- test/fast_context.rb
+- test/helper.rb
+- test/ruby_ext.rb
+- test/test_first_github_commit.rb