technicalpickles-le-git 0.0.6 → 0.2.0

data/README.textile

@@ -4,12 +4,17 @@ bq. French for "Ruby wrapper around the Github API (v2)".
 
 Le Git provides a Ruby wrapper around the "The Github API":http://develop.github.com using "rest-client":http://rdoc.info/projects/adamwiggins/rest-client and "happymapper":http://rdoc.info/projects/jnunemaker/happymapper.
 
-h2. Example usage
+h2. Installing
 
 <pre>
-  require 'rubygems'
-  require 'le_git'
+  gem sources -a http://gems.github.com
+  sudo gem install technicalpickles-le-git
+</pre>
 
+h2. Example usage
+
+<pre>
+  $ irb -rrubygems -rle-git
   >> user = Github::User.find("dancroak")
   => #<Github::User:0x110655c @followers=50, @location="Boston", @repos=18, @language="Ruby", @created=#<DateTime: 42413926183/17280,0,2299161>, type"user", fullname"Dan Croak", actions35, name"dancroak", pushed#<DateTime: 106054886255767/43200000,0,2299161, @username="dancroak", @score=3.8655705, @id="user-198">
 

data/lib/le-git.rb

@@ -0,0 +1,10 @@
+require 'happymapper'
+require 'rest_client'
+
+module Github
+  autoload :User, 'le-git/user'
+  autoload :Repository, 'le-git/repository'
+  autoload :Commit, 'le-git/commit'
+  autoload :Parent, 'le-git/parent'
+  autoload :ApiResources, 'le-git/resources'
+end

data/lib/{le_git → le-git}/commit.rb

@@ -6,12 +6,19 @@ module Github
     element :url,     String
     element :id,      String
     element :tree,    String
+    element 'committed-date', DateTime
+    element 'authored-date', DateTime
+    has_many :parents, Parent
 
-    def self.master(repo_owner, repo_name)
+    def self.branch(repo_owner, repo_name, branch)
       xml = list_commits_resource(repo_owner, repo_name).get
       parse(xml)
     end
 
+    def self.master(repo_owner, repo_name)
+      branch(repo_owner, repo_name, 'master')
+    end
+
     protected
       extend ApiResources
   end

data/lib/le-git/parent.rb

@@ -0,0 +1,6 @@
+module Github
+  class Parent
+    include HappyMapper
+    element :id, String
+  end
+end

data/lib/{le_git → le-git}/repository.rb

@@ -18,7 +18,7 @@ module Github
     end
 
     def commits(branch = "master")
-      Github::Commit.master(owner, name)
+      Github::Commit.branch(owner, name, branch)
     end
 
     protected

data/lib/le-git/resources.rb

@@ -0,0 +1,23 @@
+module Github
+  module ApiResources
+    def api_resource
+      RestClient::Resource.new("http://github.com/api/v2/xml")
+    end
+
+    def search_user_resource(username)
+      api_resource["user/search/#{username}"]
+    end
+
+    def show_repo_resource(name)
+      api_resource["repos/show/#{name}"]
+    end
+
+    def show_user_resource(username)
+      api_resource["user/show/#{username}"]
+    end
+
+    def list_commits_resource(username, repo, branch = 'master')
+      api_resource["commits/list/#{username}/#{repo}/#{branch}"]
+    end
+  end
+end

data/lib/{le_git → le-git}/user.rb

@@ -15,15 +15,28 @@ module Github
     element :pushed,    DateTime
     element :created,   DateTime
     element :location,  String
+    element 'public-gist-count', Integer
+    element 'public-repo-count', Integer
+    element 'following-count', Integer
+    element 'followers-count', Integer
+    element 'created-at', DateTime
+    element :login, String
+    element :email, String
+    element :blog, String
+    element :company, String
 
     def self.find(username)
+      xml = show_user_resource(username).get
+      parse(xml)
+    end
+
+    def self.search(username)
       xml = search_user_resource(username).get
-      users = parse(xml)
-      users.first
+      parse(xml)
     end
 
     def repositories
-      Github::Repository.user(name)
+      Github::Repository.user(login || username)
     end
 
     protected

data/rails/init.rb

@@ -1 +1 @@
-require 'le_git'
+require 'le-git'

data/test/github_commit_test.rb

@@ -1,79 +1,103 @@
 require File.join(File.dirname(__FILE__), '/test_helper.rb')
 
 class GithubCommitTest < Test::Unit::TestCase
-  context "given a repository, master commits" do
+  context "parsing a Github::Commit" do
     setup do
-      uri = "http://github.com:80/api/v2/xml/commits/list/dancroak/le-git/master"
-      fixture_path = File.join(File.dirname(__FILE__),
-                               'fixtures',
-                               'master_commits.xml')
+      @xml = <<-END
+        <commit>
+          <message>updating Repository model to use v2 API. associated User &amp; Repository models. filled out complete API for User.</message>
+          <parents type="array">
+            <parent>
+              <id>690c79a261ed5b078c08742b796cb3056f685698</id>
+            </parent>
+          </parents>
+          <url>http://github.com/dancroak/le-git/commit/1f0111c91344062052f65922171d220a06810d4a</url>
+          <author>
+            <name>Dan Croak</name>
+            <email>dcroak@thoughtbot.com</email>
+          </author>
+          <id>1f0111c91344062052f65922171d220a06810d4a</id>
+          <committed-date>2009-05-25T19:11:27-07:00</committed-date>
+          <authored-date>2009-05-25T19:11:27-07:00</authored-date>
+          <tree>d27ed042222fe8a55681e1af260e3eb2847e9f33</tree>
+          <committer>
+            <name>Dan Croak</name>
+            <email>dcroak@thoughtbot.com</email>
+          </committer>
+        </commit>
+      END
 
-      FakeWeb.register_uri(uri, :response => fixture_path)
+      @commit = Github::Commit.parse(@xml)
+    end
 
-      begin
-        @commits = Github::Commit.master("dancroak", "le-git")
-      rescue # can't figure out Net::HTTPBadResponse: wrong status line
-        @commits = Github::Commit.parse(File.read(fixture_path))
-      end
+    test "#message" do
+      @commit.message.should == "updating Repository model to use v2 API. associated User & Repository models. filled out complete API for User."
     end
 
-    test "size" do
-      @commits.size.should == 30
+    test "#parents size" do
+      @commit.parents.size.should == 1
+      @commit.parents.first.id.should == "690c79a261ed5b078c08742b796cb3056f685698"
     end
 
-    context "first commit" do
-      setup do
-        @commit = @commits.first
-      end
+    test "#url" do
+      @commit.url.should == "http://github.com/dancroak/le-git/commit/1f0111c91344062052f65922171d220a06810d4a"
+    end
 
-      test "#message" do
-        @commit.message.should == "updating Repository model to use v2 API. associated User & Repository models. filled out complete API for User."
+    test "#author" do
+      pending "could do has_one :author, User, but it seems to expect the element to be :author" do
+        @commit.author.name.should == "Dan Croak"
+        @commit.author.email.should == "dcroak@thoughtbot.com"
       end
+    end
 
-      test "#parents size" do
-        pending "how to do arrays?" do
-          @commit.parents.size.should == 1
-          @commits.parents.first.id.should == "690c79a261ed5b078c08742b796cb3056f685698"
-        end
-      end
+    test "#id" do
+      @commit.id.should == "1f0111c91344062052f65922171d220a06810d4a"
+    end
 
-      test "#url" do
-        @commit.url.should == "http://github.com/dancroak/le-git/commit/1f0111c91344062052f65922171d220a06810d4a"
-      end
+    test "#commited_date" do
+      @commit.committed_date.should == DateTime.parse("2009-05-25T19:11:27-07:00")
+    end
 
-      test "#author" do
-        pending "how to do arrays?" do
-          @commit.author.name.should == "Dan Croak"
-          @commit.author.email.should == "dcroak@thoughtbot.com"
-        end
-      end
+    test "#authored_date" do
+      @commit.authored_date.should == DateTime.parse("2009-05-25T19:11:27-07:00")
+    end
 
-      test "#id" do
-        @commit.id.should == "1f0111c91344062052f65922171d220a06810d4a"
-      end
+    test "#tree" do
+      @commit.tree.should == "d27ed042222fe8a55681e1af260e3eb2847e9f33"
+    end
 
-      test "#commited_date" do
-        pending "HappyMapper can't handle nodes with dashes" do
-          @commit.committed_date.should == Date.parse("2009-05-25T19:11:27-07:00")
-        end
+    test "#committer" do
+      pending "how to do arrays?" do
+        @commit.committer.name.should == "Dan Croak"
+        @commit.committer.email.should == "dcroak@thoughtbot.com"
       end
+    end
+  end
 
-      test "#authored_date" do
-        pending "HappyMapper can't handle nodes with dashes" do
-          @commit.authored_date.should == Date.parse("2009-05-25T19:11:27-07:00")
-        end
-      end
+  context "Commits for a user's repository's branch" do
+    setup do
+      uri = "http://github.com:80/api/v2/xml/commits/list/dancroak/le-git/master"
+      fixture_path = File.join(File.dirname(__FILE__),
+                               'fixtures',
+                               'master_commits.xml')
 
-      test "#tree" do
-        @commit.tree.should == "d27ed042222fe8a55681e1af260e3eb2847e9f33"
-      end
+      FakeWeb.register_uri(uri, :response => fixture_path)
 
-      test "#committer" do
-        pending "how to do arrays?" do
-          @commit.committer.name.should == "Dan Croak"
-          @commit.committer.email.should == "dcroak@thoughtbot.com"
-        end
+      begin
+        @commits = Github::Commit.branch("dancroak", "le-git", "master")
+      rescue # can't figure out Net::HTTPBadResponse: wrong status line
+        @commits = Github::Commit.parse(File.read(fixture_path))
       end
     end
+
+    test "size" do
+      @commits.size.should == 30
+    end
+  end
+
+  test "Commit's for user's repository's master" do
+    commits = Object.new
+    mock(Github::Commit).branch("dancroak", "le-git", "master") { commits }
+    Github::Commit.master("dancroak", "le-git").should == commits
   end
 end

data/test/github_parent_test.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), '/test_helper.rb')
+
+class GithubParentTest < Test::Unit::TestCase
+  context "parsing a Github::Parent" do
+    setup do
+      xml = <<-END
+        <parent>
+          <id>690c79a261ed5b078c08742b796cb3056f685698</id>
+        </parent>
+      END
+
+      @parent = Github::Parent.parse(xml)
+    end
+
+    test "#id" do
+      @parent.id.should == "690c79a261ed5b078c08742b796cb3056f685698"
+    end
+  end
+end
+

data/test/github_repository_test.rb

@@ -1,6 +1,61 @@
 require File.join(File.dirname(__FILE__), '/test_helper.rb')
 
 class GithubRepositoryTest < Test::Unit::TestCase
+  context "parsing a found Github::Repository" do
+    setup do
+      @xml = <<-END
+        <repository>
+          <description>Rails plugin. Force major browsers (IE, Firefox, Safari) to reload a page, even when triggered by 'back' button.</description>
+          <name>no_cache</name>
+          <private type="boolean">false</private>
+          <url>http://github.com/dancroak/no_cache</url>
+          <fork type="boolean">false</fork>
+          <watchers type="integer">10</watchers>
+          <forks type="integer">0</forks>
+          <owner>dancroak</owner>
+          <homepage>http://giantrobots.thoughtbot.com</homepage>
+        </repository>
+      END
+      @repository = Github::Repository.parse(@xml)
+    end
+
+    test "#description" do
+      @repository.description.should == "Rails plugin. Force major browsers (IE, Firefox, Safari) to reload a page, even when triggered by 'back' button."
+    end
+
+    test "#name" do
+      @repository.name.should == "no_cache"
+    end
+
+    test "#private" do
+      @repository.private.should == false
+    end
+
+    test "#url" do
+      @repository.url.should == "http://github.com/dancroak/no_cache"
+    end
+
+    test "#fork" do
+      @repository.fork.should == false
+    end
+
+    test "#watchers" do
+      @repository.watchers.should == 10
+    end
+
+    test "#forks" do
+      @repository.forks.should == 0
+    end
+
+    test "#owner" do
+      @repository.owner.should == "dancroak"
+    end
+
+    test "#homepage" do
+      @repository.homepage.should == "http://giantrobots.thoughtbot.com"
+    end
+  end
+
   context "a Github::Repository found via user" do
     setup do
       fixture_path = File.join(File.dirname(__FILE__),
@@ -12,6 +67,13 @@ class GithubRepositoryTest < Test::Unit::TestCase
       @repositories = Github::Repository.user("dancroak")
     end
 
+    test "returned kind" do
+      @repositories.class.should == Array
+      @repositories.each do |repository|
+        repository.class.should == Github::Repository
+      end
+    end
+
     test "size" do
       @repositories.size.should == 19
     end
@@ -21,84 +83,19 @@ class GithubRepositoryTest < Test::Unit::TestCase
         @repository = @repositories.first
       end
 
-      test "#description" do
-        @repository.description.should == "Rails plugin. Force major browsers (IE, Firefox, Safari) to reload a page, even when triggered by 'back' button."
+      test "#commits" do
+        commits = Object.new
+        mock(Github::Commit).branch(@repository.owner, @repository.name, 'master') { commits }
+        @repository.commits.should == commits
       end
 
-      test "#name" do
-        @repository.name.should == "no_cache"
-      end
-
-      test "#private" do
-        @repository.private.should == false
-      end
-
-      test "#url" do
-        @repository.url.should == "http://github.com/dancroak/no_cache"
-      end
+      test "#commits(redesign)" do
+        commits = Object.new
+        mock(Github::Commit).branch(@repository.owner, @repository.name, 'redesign') { commits }
+        @repository.commits('redesign').should == commits
 
-      test "#fork" do
-        @repository.fork.should == false
       end
 
-      test "#watchers" do
-        @repository.watchers.should == 10
-      end
-
-      test "#forks" do
-        @repository.forks.should == 0
-      end
-
-      test "#owner" do
-        @repository.owner.should == "dancroak"
-      end
-
-      test "#homepage" do
-        @repository.homepage.should == "http://giantrobots.thoughtbot.com"
-      end
-
-      context "master commits" do
-        setup do
-          uri = "http://github.com:80/api/v2/xml/commits/list/dancroak/le-git/master"
-          fixture_path = File.join(File.dirname(__FILE__),
-                                   'fixtures',
-                                   'master_commits.xml')
-
-          FakeWeb.register_uri(uri, :response => fixture_path)
-
-          begin
-            @commits = @repository.commits
-          rescue # can't figure out Net::HTTPBadResponse: wrong status line
-            @commits = Github::Commit.parse(File.read(fixture_path))
-          end
-        end
-
-        test "size" do
-          @commits.size.should == 30
-        end
-
-        context "first commit" do
-          setup do
-            @commit = @commits.first
-          end
-
-          test "#message" do
-            @commit.message.should == "updating Repository model to use v2 API. associated User & Repository models. filled out complete API for User."
-          end
-
-          test "#url" do
-            @commit.url.should == "http://github.com/dancroak/le-git/commit/1f0111c91344062052f65922171d220a06810d4a"
-          end
-
-          test "#id" do
-            @commit.id.should == "1f0111c91344062052f65922171d220a06810d4a"
-          end
-
-          test "#tree" do
-            @commit.tree.should == "d27ed042222fe8a55681e1af260e3eb2847e9f33"
-          end
-        end
-      end
     end
   end
 end

data/test/github_user_test.rb

@@ -1,21 +1,44 @@
 require File.join(File.dirname(__FILE__), '/test_helper.rb')
 
 class GithubUserTest < Test::Unit::TestCase
-  context "A Github::User" do
+  context "searching users" do
     setup do
-      fixture_path = File.join(File.dirname(__FILE__), 'fixtures', 'user.xml')
-      FakeWeb.register_uri('http://github.com/api/v2/xml/user/search/dancroak',
+      fixture_path = File.join(File.dirname(__FILE__), 'fixtures', 'search_users.xml')
+      FakeWeb.register_uri('http://github.com/api/v2/xml/user/search/tech',
                            :response => fixture_path)
 
-      @user = Github::User.find('dancroak')
+      @users = Github::User.search('tech')
     end
 
-    test "#score" do
-      @user.score.should == 3.8653853
+    test "#size" do
+      @users.size.should == 19
     end
+  end
 
-    test "#name" do
-      @user.name.should == "dancroak"
+  context "parsing a Github::User search result" do
+    setup do
+      @xml = <<-XML
+        <user>
+          <score type="float">2.3766692</score>
+          <name>techcrunch</name>
+          <actions type="integer">35</actions>
+          <language>PHP</language>
+          <followers type="integer">24</followers>
+          <username>techcrunch</username>
+          <type>user</type>
+          <fullname>TechCrunch</fullname>
+          <repos type="integer">2</repos>
+          <id>user-14080</id>
+          <pushed>2009-05-17T09:15:35.542Z</pushed>
+          <created>2008-06-17T19:10:49Z</created>
+          <location>Atherton, CA</location>
+        </user>
+      XML
+      @user = Github::User.parse(@xml)
+    end
+
+    test "#score" do
+      @user.score.should == 2.3766692
     end
 
     test "#actions" do
@@ -23,101 +46,124 @@ class GithubUserTest < Test::Unit::TestCase
     end
 
     test "#language" do
-      @user.language.should == "Ruby"
-    end
-
-    test "#followers" do
-      @user.followers.should == 50
+      @user.language.should == "PHP"
     end
 
     test "#username" do
-      @user.username.should == "dancroak"
-    end
-
-    test "#type" do
-      @user.type.should == "user"
+      @user.username.should == "techcrunch"
     end
 
     test "#fullname" do
-      @user.fullname.should == "Dan Croak"
-    end
-
-    test "#repos" do
-      @user.repos.should == 18
+      @user.fullname.should == "TechCrunch"
     end
 
     test "#id" do
-      @user.id.should == "user-198"
+      @user.id.should == "user-14080"
     end
 
     test "#pushed" do
-      @user.pushed.to_s.should == DateTime.new(2009, 5, 22, 17, 15, 11).to_s
+      @user.pushed.should == DateTime.parse("2009-05-17T09:15:35.542Z")
     end
 
     test "#created" do
-      @user.created.to_s.should == DateTime.new(2008, 2, 13, 2, 48, 35).to_s
+      @user.created.should == DateTime.parse("2008-06-17T19:10:49Z")
     end
 
     test "#location" do
-      @user.location.should == "Boston"
+      @user.location.should == "Atherton, CA"
+    end
+
+  end
+
+  context "parsing a found Github::User" do
+    setup do
+      @xml = <<-XML
+        <user>
+          <name>Dan Croak</name>
+          <company>thoughtbot</company>
+          <following-count type="integer">76</following-count>
+          <public-gist-count type="integer">52</public-gist-count>
+          <public-repo-count type="integer">21</public-repo-count>
+          <blog>http://dancroak.com</blog>
+          <id type="integer">198</id>
+          <followers-count type="integer">52</followers-count>
+          <login>dancroak</login>
+          <location>Boston</location>
+          <email>dcroak@thoughtbot.com</email>
+          <created-at type="datetime">2008-02-12T18:48:35-08:00</created-at>
+        </user>
+      XML
+
+      @user = Github::User.parse(@xml)
+    end
+
+    test "#name" do
+      @user.name.should == "Dan Croak"
     end
 
-    context "GETing #repositories" do
-      setup do
-        fixture_path = File.join(File.dirname(__FILE__),
-                                 'fixtures',
-                                 'user_repositories.xml')
-        FakeWeb.register_uri('http://github.com/api/v2/xml/repos/show/dancroak',
-                             :response => fixture_path)
+    test "#company" do
+      @user.company.should == "thoughtbot"
+    end
+
+    test "#following_count" do
+      @user.following_count.should == 76
+    end
 
-        @repositories = @user.repositories
-      end
+    test "#public_gist_count" do
+      @user.public_gist_count.should == 52
+    end
+
+    test "#public_repo_count" do
+      @user.public_repo_count.should == 21
+    end
 
-      test "size" do
-        @repositories.size.should == 19
-      end
+    test "#blog" do
+      @user.blog.should == "http://dancroak.com"
+    end
 
-      context "first" do
-        setup do
-          @repository = @repositories.first
-        end
+    test "#id" do
+      @user.id.should == "198"
+    end
 
-        test "#description" do
-          @repository.description.should == "Rails plugin. Force major browsers (IE, Firefox, Safari) to reload a page, even when triggered by 'back' button."
-        end
+    test "#followers_count" do
+      @user.followers_count.should == 52
+    end
 
-        test "#name" do
-          @repository.name.should == "no_cache"
-        end
+    test "#login" do
+      @user.login.should == "dancroak"
+    end
 
-        test "#private" do
-          @repository.private.should == false
-        end
+    test "#location" do
+      @user.location.should == "Boston"
+    end
 
-        test "#url" do
-          @repository.url.should == "http://github.com/dancroak/no_cache"
-        end
+    test "#email" do
+      @user.email.should == "dcroak@thoughtbot.com"
+    end
 
-        test "#fork" do
-          @repository.fork.should == false
-        end
+    test "#created_at" do
+      @user.created_at.should == DateTime.parse("2008-02-12T18:48:35-08:00")
+    end
+  end
 
-        test "#watchers" do
-          @repository.watchers.should == 10
-        end
+  context "A found Github::User" do
+    setup do
+      fixture_path = File.join(File.dirname(__FILE__), 'fixtures', 'user.xml')
+      FakeWeb.register_uri('http://github.com/api/v2/xml/user/show/dancroak',
+                           :response => fixture_path)
 
-        test "#forks" do
-          @repository.forks.should == 0
-        end
+      @user = Github::User.find('dancroak')
+    end
 
-        test "#owner" do
-          @repository.owner.should == "dancroak"
-        end
+    test "returned kind" do
+      @user.class.should == Github::User
+    end
 
-        test "#homepage" do
-          @repository.homepage.should == "http://giantrobots.thoughtbot.com"
-        end
-      end
+    test "#repositories" do
+      repositories = Object.new
+      mock(Github::Repository).user(@user.login) { repositories }
+      @user.repositories.should == repositories
     end
+
   end
 end

data/test/test_helper.rb

@@ -14,7 +14,11 @@ CONTEXT_NOISE = %w(context)
 require 'context'
 require 'matchy'
 require 'pending'
+require 'rr'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib') )
-require 'le_git'
+require 'le-git'
 
+class Test::Unit::TestCase
+  include RR::Adapters::TestUnit unless include?(RR::Adapters::TestUnit)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technicalpickles-le-git
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.2.0
 platform: ruby
 authors: 
 - Josh Nichols
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-25 00:00:00 -07:00
+date: 2009-06-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,12 +45,14 @@ extra_rdoc_files:
 files: 
 - LICENSE
 - README.textile
-- lib/le_git.rb
-- lib/le_git/commit.rb
-- lib/le_git/repository.rb
-- lib/le_git/user.rb
+- lib/le-git.rb
+- lib/le-git/commit.rb
+- lib/le-git/parent.rb
+- lib/le-git/repository.rb
+- lib/le-git/resources.rb
+- lib/le-git/user.rb
 - rails/init.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/dancroak/le-git
 post_install_message: 
 rdoc_options: 
@@ -74,10 +76,11 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Ruby wrapper around Github API v2
 test_files: 
 - test/github_commit_test.rb
+- test/github_parent_test.rb
 - test/github_repository_test.rb
 - test/github_user_test.rb
 - test/test_helper.rb

data/lib/le_git.rb

@@ -1,9 +0,0 @@
-require 'happymapper'
-require 'rest_client'
-
-module Github
-  autoload :User, 'le_git/user'
-  autoload :Repository, 'le_git/repository'
-  autoload :Commit, 'le_git/commit'
-  autoload :ApiResources, 'le_git/resources'
-end