ruby-github 0.0.1 → 0.0.2

data/History.txt

@@ -0,0 +1,9 @@
+=== 0.0.2 / 2008-04-12
+
+* Now using Hoe for Rubyforge distribution
+* Uses the new Mash gem for its API structures
+* GitHub API calls are now through GitHub::API instead of just GitHub
+
+=== 0.0.1 / 2008-04-02
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,5 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/ruby-github.rb

data/README.txt

@@ -0,0 +1,62 @@
+== Ruby-GitHub
+
+= DESCRIPTION:
+
+Ruby-GitHub is a simple wrapper library for the evolving GitHub API.
+
+= INSTALLATION:
+
+RubyGem:
+
+  sudo gem install ruby-github
+
+GitHub Clone:
+
+  git clone git://github.com/mbleigh/ruby-github.git
+
+= DEPENDENCIES:
+
+* Requires the 'json' gem
+* Requires the 'mash' gem
+
+= SYNOPSIS:
+  
+  require 'ruby-github'
+  
+  user = GitHub::API.user('mbleigh')
+  user.name # => "Michael Bleigh"
+  user.repositories # => array of repositories
+  user.repositories.last.name # => "ruby-github"
+  user.repositories.last.url # => "http://GitHub::API.com/mbleigh/ruby-github"
+  user.repositories.last.commits # => requests array of commits (see below)
+
+  commits = GitHub::API.commits('mbleigh','ruby-github')
+  commits.first.message # => "Moved GitHub::API.rb to ruby-GitHub::API.rb..."
+  commits.first.id # => "1d8c21062e11bb1ecd51ab840aa13d906993f3f7"
+
+  # these two lines are equivalent
+  commit = commits.first.detailed
+  commit = GitHub::API.commit('mbleigh', 'ruby-github', '1d8c21062e11bb1ecd51ab840aa13d906993f3f7')
+
+  commit.message # => "Moved GitHub::API.rb to ruby-GitHub::API.rb..."
+  commit.added.collect{|c| c.filename} # => ["init.rb", "lib/ruby-GitHub::API.rb"]
+
+Note that the information is less complete in the 'commits' pull
+than in the pull for an individual commit. calling 'detailed' on
+a commit retreived from a 'commits' call will make a 'commit' call
+for that specific commit.
+
+Here's a one-liner that uses all parts of the Ruby-GitHub library:
+
+latest_commit_filenames = GitHub::API.user('mbleigh').repositories.first.commits.first.detailed.modified.collect(&:filename)
+  
+= RESOURCES:
+
+* GitHub Project: http://GitHub::API.com/mbleigh/ruby-github
+* E-Mail: michael@intridea.com
+
+= KNOWN ISSUES/FUTURE DEVELOPMENT:
+
+Right now this library isn't spec'ed out, that's the top priority moving forward. It
+will likely also have to evolve substantially as the GitHub API becomes more mature.
+If you have any questions or requests, don't hesitate to e-mail me!

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/ruby-github.rb'
+
+Hoe.new('ruby-github', GitHub::VERSION) do |p|
+  p.developer('Michael Bleigh', 'michael@example.com')
+  p.remote_rdoc_dir = ''
+  p.extra_deps = ["mash >= 0.0.2", "json"]
+end
+
+# vim: syntax=Ruby

data/lib/ruby-github.rb

@@ -1,81 +1,57 @@
 require 'rubygems'
 require 'json'
 require 'open-uri'
+require 'mash'
 
-class GitHub
-  def self.grab(user, repo=nil, branch=nil, commit=nil) #:nodoc:
-    url = "http://github.com/api/v1/json/#{user}"
-    
-    if repo
-      url += "/#{repo}"
-      url += commit ? "/commit/#{commit}" : "/commits/#{branch}"
-    end
-    
-    GitHub::Hash.new(JSON.parse(open(url).read),user,repo)
-  end
-  
-  # Fetches information about the specified user name.
-  def self.user(user)
-    self.grab(user).user
-  end
+module GitHub
+  VERSION = "0.0.2"
+  class API
+    BASE_URL = "http://github.com/api/v1/json"  
   
-  # Fetches the commits for a given repository.
-  def self.commits(user,repository,branch="master")
-    self.grab(user,repository,branch).commits
-  end
+    # Fetches information about the specified user name.
+    def self.user(user)
+      url = BASE_URL + "/#{user}"
+      GitHub::User.new(JSON.parse(open(url).read)["user"])
+    end
   
-  # Fetches a single commit for a repository.
-  def self.commit(user,repository,commit)
-    self.grab(user,repository,nil,commit).commit
-  end
-end
-
-class GitHub::Hash < Hash #:nodoc: all
-  def initialize(hash = nil, user = nil, repo = nil, obj = nil)
-    super(obj)
-    
-    @user = user
-    @repo = repo
-    
-    if hash && hash.is_a?(Hash)
-      hash.each do |k,v| 
-        v = ::GitHub::Hash.new(v,user,repo,obj) if v.is_a?(Hash) && !v.is_a?(::GitHub::Hash)
-        if v.is_a?(Array)
-          v = v.collect{|potential_hash|
-            potential_hash = ::GitHub::Hash.new(potential_hash,user,repo,obj) if potential_hash.is_a?(Hash) && !potential_hash.is_a?(::GitHub::Hash)
-            potential_hash
-          }
-        end
-        self[k] = v
-      end
+    # Fetches the commits for a given repository.
+    def self.commits(user,repository,branch="master")
+      url = BASE_URL + "/#{user}/#{repository}/commits/#{branch}"
+      JSON.parse(open(url).read)["commits"].collect{ |c| 
+        GitHub::Commit.new(c.merge(:user => user, :repository => repository))
+      }
     end
-  end
   
-  def id
-    self["id"] ? self["id"] : super
+    # Fetches a single commit for a repository.
+    def self.commit(user,repository,commit)
+      url = BASE_URL + "/#{user}/#{repository}/commit/#{commit}"
+      GitHub::Commit.new(JSON.parse(open(url).read).merge(:user => user, :repository => repository))
+    end
   end
   
-  def [](key)
-    key = key.to_s
-    super
+  class Repository < Mash
+    def commits
+      ::GitHub::API.commits(user,name)
+    end
   end
   
-  def []=(key,value)
-    key = key.to_s
-    super
+  class User < Mash
+    def initialize(hash = nil)
+      @user = hash["login"] if hash
+      super
+    end
+    
+    def repositories=(repo_array)
+      puts self.inspect
+      self["repositories"] = repo_array.collect{|r| ::GitHub::Repository.new(r.merge(:user => login || @user))}
+    end
   end
   
-  def method_missing(method_name, *args)
-    if (match = method_name.to_s.match(/(.*)=$/)) && args.size == 1
-      self[match[1]] = args.first
-    elsif keys.include?(method_name.to_s)
-      self[method_name]
-    elsif method_name.to_s == "commits" && self["name"] && self["url"]
-      GitHub.commits(@user, name)
-    elsif method_name.to_s == "detailed" && self["id"] && self["message"]
-      GitHub.commit(@user,@repo,self["id"])
-    else
-      super
+  class Commit < Mash
+    # if a method only available to a detailed commit is called,
+    # automatically fetch it from the API
+    def detailed
+      ::GitHub::API.commit(user,repository,id)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-github
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -9,9 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-02 00:00:00 -04:00
+date: 2008-04-12 00:00:00 -04:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mash >= 0.0.2
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: json
   version_requirement: 
@@ -21,24 +30,38 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: 
-email: michael@intridea.com
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: Ruby-GitHub is a simple wrapper library for the evolving GitHub API.
+email: 
+- michael@example.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
-- LICENSE
+- History.txt
+- Manifest.txt
+- README.txt
 files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
 - lib/ruby-github.rb
-- README
-- LICENSE
 has_rdoc: true
-homepage: http://intridea.com/tags/ruby-github
+homepage: 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -55,10 +78,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: ruby-github
 rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
-summary: A simple Ruby library for accessing information through the GitHub API.
+summary: Ruby-GitHub is a simple wrapper library for the evolving GitHub API.
 test_files: []
 

data/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2008 Michael Bleigh and Intridea, Inc.
-
-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

@@ -1,35 +0,0 @@
-== Ruby-GitHub
-
-Ruby-GitHub is a simple wrapper library for the evolving GitHub API.
-
-= Usage
-  
-  require 'ruby-github'
-  
-user = GitHub.user('mbleigh')
-user.name # => "Michael Bleigh"
-user.repositories # => array of repositories
-user.repositories.last.name # => "ruby-github"
-user.repositories.last.url # => "http://github.com/mbleigh/ruby-github"
-user.repositories.last.commits # => array of commits (see below)
-
-commits = GitHub.commits('mbleigh','ruby-github')
-commits.first.message # => "Moved github.rb to ruby-github.rb..."
-commits.first.id # => "1d8c21062e11bb1ecd51ab840aa13d906993f3f7"
-
-# these two lines are equivalent
-commit = commits.first.detailed
-commit = GitHub.commit('mbleigh','ruby-github','1d8c21062e11bb1ecd51ab840aa13d906993f3f7')
-
-commit.message # => "Moved github.rb to ruby-github.rb..."
-commit.added.collect{|c| c.filename} # => ["init.rb", "lib/ruby-github.rb"]
-
-Note that the information is less complete in the 'commits' pull
-than in the pull for an individual commit. calling 'detailed' on
-a commit retreived from a 'commits' call will make a 'commit' call
-for that specific commit.
-  
-= Resources
-
-* GitHub Project: http://github.com/mbleigh/ruby-github
-* E-Mail: michael@intridea.com