mbleigh-ruby-github 0.0.3

data/History.txt

@@ -0,0 +1,13 @@
+=== 0.0.3 / 2008-04-25
+
+* Now using GitHub's gem library, ditching Rubyforge.
+
+=== 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,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+ruby-github.gemspec
+lib/ruby-github.rb

data/README.txt

@@ -0,0 +1,65 @@
+== Ruby-GitHub
+
+= DESCRIPTION:
+
+Ruby-GitHub is a simple wrapper library for the evolving GitHub API.
+
+= INSTALLATION:
+
+Gem:
+
+The gem is hosted on GitHub so you will need to execute the first line if you have not installed any gems from GitHub before.
+
+  gem sources -a http://gems.github.com/  
+  sudo gem install mbleigh-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,2 @@
+require 'rubygems'
+require './lib/ruby-github.rb'

data/lib/mbleigh-ruby-github.rb

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'json'
+require 'open-uri'
+require 'mash'
+
+module GitHub
+  class API
+    BASE_URL = "http://github.com/api/v1/json"  
+  
+    # 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 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
+  
+    # 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
+  
+  class Repository < Mash
+    def commits
+      ::GitHub::API.commits(user,name)
+    end
+  end
+  
+  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
+  
+  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

data/ruby-github.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "ruby-github"
+  s.version = "0.0.3"
+  s.date = "2008-04-25"
+  s.summary = "Simple Ruby library to access the GitHub API."
+  s.email = "michael@intridea.com"
+  s.homepage = "http://github.com/mbleigh/ruby-github"
+  s.description = "Ruby-GitHub is a small library that provides simple access to GitHub's evolving API."
+  s.has_rdoc = true
+  s.authors = ["Michael Bleigh"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "ruby-github.gemspec", "lib/ruby-github.rb"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.add_dependency("mash", [">= 0.0.3"])
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: mbleigh-ruby-github
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Michael Bleigh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-25 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mash
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.3
+    version: 
+description: Ruby-GitHub is a small library that provides simple access to GitHub's evolving API.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- ruby-github.gemspec
+- lib/ruby-github.rb
+has_rdoc: true
+homepage: http://github.com/mbleigh/ruby-github
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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.0.1
+signing_key: 
+specification_version: 2
+summary: Simple Ruby library to access the GitHub API.
+test_files: []
+