gittycent 0.0.3 → 0.0.4

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.0.4. Documentation, better support for repos, minor bug fixes and basic specs.
+
 v0.0.3. Less tagline lameness.
 
 v0.0.2. There was no version 0.0.2!

data/Rakefile

@@ -12,10 +12,4 @@ Echoe.new 'gittycent' do |p|
   ]
 end
 
-desc 'Default: run specs'
-task :default => :spec
-Spec::Rake::SpecTask.new do |t|
-  t.spec_files = FileList["spec/**/*_spec.rb"]
-end
-
 task :test => :spec

data/gittycent.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gittycent}
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Elijah Miller"]
-  s.date = %q{2010-03-13}
+  s.date = %q{2010-05-24}
   s.description = %q{A GitHub wrapper in Ruby.}
   s.email = %q{elijah.miller@gmail.com}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/gittycent.rb"]
@@ -15,14 +15,14 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gittycent", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{gittycent}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A GitHub wrapper in Ruby.}
 
   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
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/lib/gittycent.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'active_support/all'
 require 'httparty'
 require 'pp'
 
@@ -9,6 +10,10 @@ class GitHub
   
   attr_accessor :options
   
+  # Connects to GitHub using login/token. Yields or returns the new 
+  # connection.
+  #
+  #  GitHub.connect(:login => 'jqr', :token => 'somesecretstuff123')
   def self.connect(options)
     connection = new(options)
     if block_given?
@@ -18,20 +23,33 @@ class GitHub
     end
   end
   
-  def self.connect_with_git_config(section = :github, &block)
+  # Simplified method for connecting with git config specified credentials.
+  # Also allows for using an alternate section for easy handling of multiple
+  # credentials. Just like connect this yields or returns the new connection.
+  #
+  #  github = GitHub.connect_with_git_config
+  def self.connect_with_git_config(section = :github, options = {}, &block)
     config = Hash[*`git config -l`.scan(/^(.*?)=(.*)$/).flatten]
-    connect(:login => config["#{section}.user"], :token => config["#{section}.token"], &block)
+    connect(options.merge(:login => config["#{section}.user"], :token => config["#{section}.token"]), &block)
   end
   
+  # Returns a new GitHub connection object, requires :login and :token 
+  # options.
+  #
+  #  github = GitHub.new(:login => 'jqr', :token => 'somesecretstuff123')
   def initialize(options)
     self.options = options
     debug "Login using login #{options[:login]} with token #{options[:token]}"
   end
   
+  # Returns the verbosity level.
   def verbosity
     options[:verbosity] || NONE
   end
   
+  # Finds a GitHub user by login.
+  #
+  #  user = github.user('jqr')
   def user(login)
     if login == options[:login]
       AuthenticatedUser.new(self, :login => options[:login])
@@ -40,15 +58,17 @@ class GitHub
     end
   end
   
+  # Finds GitHub users by a query string.
   def user_search(query)
     get("/user/search/#{query}")['users'].map { |u| User.new(self, u) }
   end
 
+  # Returns the currently authenticated user.
   def authenticated_user
     @authenticated_user ||= user(options[:login])
   end
   
-  def inspect
+  def inspect # :nodoc:
     "#<#{self.class}#{' ' + options[:login] if options[:login].present?}>"
   end
   
@@ -61,6 +81,9 @@ class GitHub
     }
   end
   
+  # Performs a GET request on path, automatically prepending api version and 
+  # format paramters. Will automatically retry if the request rate limiting is 
+  # hit.
   def get(path)
     with_retry do
       url = "http://github.com/api/#{API_VERSION}/#{FORMAT}#{path}"
@@ -73,6 +96,9 @@ class GitHub
     end
   end
   
+  # Performs a POST request on path, automatically prepending api version and 
+  # format paramters. Will automatically retry if the request rate limiting is 
+  # hit.
   def post(path, params = {})
     with_retry do
       url = "http://github.com/api/#{API_VERSION}/#{FORMAT}#{path}"
@@ -98,6 +124,8 @@ class GitHub
     debug object.pretty_inspect
   end
   
+  # Automatically retries a block of code if the returned value is rate 
+  # limited (HTTP Code 403) by GitHub.
   def with_retry
     count = 0
     loop do
@@ -146,7 +174,7 @@ class GitHub
     def self.loadable_attributes(*attributes)
       (attributes - [identified_by]).each do |attribute|
         define_method(attribute) do
-          if !@attributes.include?(attributes)
+          if !@attributes.include?(attribute)
             load
           end
           @attributes[attribute]
@@ -167,28 +195,27 @@ class GitHub
       login.to_s
     end
     
+    # Returns this user's repositories.
     def repos
       @repos ||= get("/repos/show/#{login}")['repositories'].map { |r| Repo.new(connection, r) }
     end
     
+    # Returns a list of all public repos thi user is watching.
     def watched_repos
       @repos ||= get("/repos/watched/#{login}")['repositories'].map { |r| Repo.new(connection, r) }
     end
     
-    # supported options include: :name, :description, :homepage, :public
-    def create_repo(options)
-      options = options.dup
-      Repo.new(connection, post("/repos/create", options)['repository'])
-    end
-    
+    # Loads lazily-fetched attributes.
     def load
       @attributes = get("/user/show/#{login}")['user'].symbolize_keys
     end
     
+    # Returns all the users that follow this user.
     def followers
       @followers ||= get("/user/show/#{login}/followers")['users'].map { |u| User.new(connection, :login => u) }
     end
 
+    # Returns all the users that this user is following.
     def following
       @following||= get("/user/show/#{login}/following")['users'].map { |u| User.new(connection, :login => u) }
     end
@@ -200,6 +227,20 @@ class GitHub
       :total_private_repo_count, :public_repo_count, :location, :email, 
       :collaborators, :public_gist_count, :blog, :name, :following_count, 
       :disk_usage
+      
+    # Returns a list of all repos this user is watching.
+    def watched_repos
+      super
+    end
+    
+    # Adds a new repository for this user. Supported options include: :name, 
+    # :description, :homepage, :public.
+    #
+    #  repo = user.create_repo(:name => 'hello', :public => false)
+    def create_repo(options)
+      options = options.dup
+      Repo.new(connection, post("/repos/create", options)['repository'])
+    end
   end
   
   class Repo < Connectable
@@ -207,20 +248,23 @@ class GitHub
     self.identified_by = :name
 
     loadable_attributes :owner, :open_issues, :description, :fork, :forks, 
-      :private, :url, :homepage, :watchers
+      :private, :url, :homepage, :watchers, :has_wiki, :has_downloads, :has_issues
 
     def to_s
       name.to_s
     end
     
+    # Returns the owner of this repository.
     def owner
       @owner ||= User.new(connection, :login => @attributes[:owner])
     end
     
+    # Returns a list of all collaborators.
     def collaborators
       @collaborators ||= get("/repos/show/#{owner.login}/#{name}/collaborators")['collaborators'] || []
     end
     
+    # Sets the list of collaborators.
     def collaborators=(value)
       value = value.dup.uniq
       removals = collaborators - value
@@ -236,6 +280,8 @@ class GitHub
       @collaborators = nil
     end
     
+    # Returns the shell commands used to do an initial push of this project to
+    # GitHub.
     def initial_push_command
       "git remote add origin git@github.com:#{owner.login}/#{name}.git &&\n" +
       "git push origin master &&\n" +
@@ -243,18 +289,27 @@ class GitHub
       "git config --add branch.master.merge refs/heads/master" 
     end
     
+    # Returns repositories in this repository's network.
     def network
       @network ||= get("/repos/show/#{owner.login}/#{name}/network")['network'].map { |r| Repo.new(connection, r) }
     end
     
+    # Returns the languages detected.
     def languages
       get("/repos/show/#{owner.login}/#{name}/languages")['languages']
     end
     
+    # Loads lazily-fetched attributes.
+    def load
+      @attributes = get("/repos/show/#{owner.login}/#{name}")['repository'].symbolize_keys
+    end
+    
+    # Returns all tags of this repository.
     def tags
       get("/repos/show/#{owner.login}/#{name}/tags")['tags']
     end
     
+    # Returns all branches of this repository.
     def branches
       get("/repos/show/#{owner.login}/#{name}/branches")['branches']
     end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gittycent
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Elijah Miller
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-13 23:00:00 -05:00
+date: 2010-05-24 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -52,16 +53,20 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
       segments: 
       - 1
       - 2
@@ -69,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gittycent
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A GitHub wrapper in Ruby.