octokit 0.6.5 → 1.0.0

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format=nested
---backtrace
+--order random

data/.travis.yml

@@ -4,5 +4,4 @@ rvm:
   - 1.9.3
   - jruby
   - rbx
-  - rbx-2.0
   - ree

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # CHANGELOG
 
+* [0.6.5 - October 15, 2011](https://github.com/pengwynn/octokit/compare/v0.6.4...v0.6.5)
 * [0.6.4 - July 2, 2011](https://github.com/pengwynn/octokit/compare/v0.6.3...v0.6.4)
 * [0.6.3 - May 5, 2011](https://github.com/pengwynn/octokit/compare/v0.6.2...v0.6.3)
 * [0.6.2 - April 26, 2011](https://github.com/pengwynn/octokit/compare/v0.6.1...v0.6.2)

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 platforms :jruby do
   gem "jruby-openssl", "~> 0.7"

data/README.md

@@ -1,18 +1,18 @@
-# Octokit
-Simple Ruby wrapper for the GitHub v2 API.
+# Octokit [![Build Status](https://secure.travis-ci.org/pengwynn/octokit.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/pengwynn/octokit.png?travis)][gemnasium]
+Simple Ruby wrapper for the GitHub v2 & v3 API.
 
-![The Puppeteer](https://github.com/pengwynn/octokit/raw/master/puppeteer.jpg "The Puppeteer") by [![Cameron McEfee)](https://secure.gravatar.com/avatar/a79ff2bb7da84e275361857d2feb2b1b?s=20 "Cameron McEfee")](https://github.com/cameronmcefee)
+[travis]: http://travis-ci.org/pengwynn/octokit
+[gemnasium]: https://gemnasium.com/pengwynn/octokit
 
-## <a name="installation">Installation</a>
+## <a name="installation"></a>Installation
     gem install octokit
 
-## <a name="ci">Continuous Integration</a>
-[![Build Status](https://secure.travis-ci.org/pengwynn/octokit.png)](http://travis-ci.org/pengwynn/octokit)
+## <a name="documentation"></a>Documentation
+[http://rdoc.info/gems/octokit][documentation]
 
-## <a name="documentation">Documentation</a>
-http://rdoc.info/gems/octokit
+[documentation]: http://rdoc.info/gems/octokit
 
-## <a name="examples">Examples</a>
+## <a name="examples"></a>Examples
 ### Show a user
     Octokit.user("sferik")
     => <#Hashie::Rash blog="http://twitter.com/sferik" company="Code for America" created_at="2008/05/14 13:36:12 -0700" email="sferik@gmail.com" followers_count=177 following_count=83 gravatar_id="1f74b13f1e5c6c69cb5d7fbaabb1e2cb" id=10308 location="San Francisco" login="sferik" name="Erik Michaels-Ober" permission=nil public_gist_count=16 public_repo_count=30 type="User">
@@ -32,7 +32,7 @@ For convenience, methods that require a repoistory argument may be passed in any
     Octokit.repo("pengwynn/octokit")
     => <#Hashie::Rash created_at="2009/12/10 13:41:49 -0800" description="Simple Ruby wrapper for the GitHub v2 API and feeds" fork=false forks=25 has_downloads=true has_issues=true has_wiki=true homepage="http://wynnnetherland.com/projects/octokit" integrate_branch="master" language="Ruby" name="octokit" open_issues=8 owner="pengwynn" private=false pushed_at="2011/05/05 10:48:57 -0700" size=1804 url="https://github.com/pengwynn/octokit" watchers=92>
 
-## <a name="authenticated_requests">Authenticated requests</a>
+## <a name="authenticated_requests"></a>Authenticated Requests
 For methods that require authentication, you'll need to setup a client with
 your login and password.
 
@@ -40,34 +40,42 @@ your login and password.
     client.follow!("sferik")
 
 Alternately, you can authenticate with a GitHub OAuth2 token. Note: this is
-**NOT** the GitHub API token on your [account
-page](https://github.com/account).
+**NOT** the GitHub API token on your [account page][account].
+
+[account]: https://github.com/account
 
     client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
     client.follow!("sferik")
 
-## <a name="pulls">Submitting a Pull Request</a>
+## <a name="pulls"></a>Submitting a Pull Request
 1. Fork the project.
 2. Create a topic branch.
 3. Implement your feature or bug fix.
 4. Add documentation for your feature or bug fix.
-5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100% documented, go back to step 4.
+5. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
+   back to step 4.
 6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 6.
+7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
+   to step 6.
 8. Commit and push your changes.
-9. Submit a pull request. Please do not include changes to the version or gemspec. (If you want to create your own version for some reason, please do so in a separate commit.)
+9. Submit a pull request. Please do not include changes to the version or
+   gemspec. (If you want to create your own version for some reason, please do
+   so in a separate commit.)
 
-## <a name="rubies">Supported Rubies</a>
-This library aims to support and is [tested
-against](http://travis-ci.org/pengwynn/octokit) the following Ruby
+## <a name="versions"></a>Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
 * Ruby 1.8.7
-* Ruby 1.9.1
 * Ruby 1.9.2
-* [JRuby](http://www.jruby.org/)
-* [Rubinius](http://rubini.us/)
-* [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/)
+* Ruby 1.9.3
+* [JRuby][]
+* [Rubinius][]
+* [Ruby Enterprise Edition][ree]
+
+[jruby]: http://www.jruby.org/
+[rubinius]: http://rubini.us/
+[ree]: http://www.rubyenterpriseedition.com/
 
 If something doesn't work on one of these interpreters, it should be considered
 a bug.
@@ -83,9 +91,14 @@ implementation, you will be personally responsible for providing patches in a
 timely fashion. If critical issues for a particular implementation exist at the
 time of a major release, support for that Ruby version may be dropped.
 
-## <a name="inspiration">Inspiration</a>
-Octokit was inspired by [Octopi](https://github.com/fcoury/octopi) and aims to be a lightweight, less-ActiveResourcey alternative.
+## <a name="inspiration"></a>Inspiration
+Octokit was inspired by [Octopi][] and aims to be a lightweight,
+less-ActiveResourcey alternative.
+
+[octopi]: https://github.com/fcoury/octopi
+
+## <a name="copyright"></a>Copyright
+Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober. See
+[LICENSE][] for details.
 
-## <a name="copyright">Copyright</a>
-Copyright (c) 2011 [Wynn Netherland](http://wynnnetherland.com), [Adam Stacoviak](http://adamstacoviak.com/), [Erik Michaels-Ober](https://github.com/sferik).
-See [LICENSE](https://github.com/pengwynn/octokit/blob/master/LICENSE) for details.
+[license]: https://github.com/pengwynn/octokit/blob/master/LICENSE

data/Rakefile

@@ -8,3 +8,14 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :test => :spec
 task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/faraday/response/raise_octokit_error.rb

@@ -30,8 +30,10 @@ module Faraday
     end
 
     def error_message(response)
-      message = if body = response[:body]
-        body = ::MultiJson.decode(body) if body.is_a? String
+      message = if ( body = response[:body] ) && !body.empty?
+        if body.is_a? String
+          body = ::MultiJson.decode body, :symbolize_keys => true
+        end
         ": #{body[:error] || body[:message] || ''}"
       else
         ''

data/lib/octokit/client.rb

@@ -16,6 +16,7 @@ require 'octokit/client/pulls'
 require 'octokit/client/repositories'
 require 'octokit/client/timelines'
 require 'octokit/client/users'
+require 'octokit/client/events'
 
 module Octokit
   class Client
@@ -45,5 +46,6 @@ module Octokit
     include Octokit::Client::Repositories
     include Octokit::Client::Timelines
     include Octokit::Client::Users
+    include Octokit::Client::Events
   end
 end

data/lib/octokit/client/commits.rb

@@ -12,6 +12,18 @@ module Octokit
         get("/repos/#{Repository.new(repo)}/commits/#{sha}", options, 3)
       end
 
+      def list_commit_comments(repo, options={})
+        get("/repos/#{Repository.new(repo)}/comments", options, 3)
+      end
+
+      def commit_comments(repo, sha, options={})
+        get("/repos/#{Repository.new(repo)}/commits/#{sha}/comments", options, 3)
+      end
+
+      def commit_comment(repo, id, options={})
+        get("/repos/#{Repository.new(repo)}/comments/#{id}", options, 3)
+      end
+
     end
   end
 end

data/lib/octokit/client/events.rb

@@ -0,0 +1,26 @@
+module Octokit
+  class Client
+    module Events
+      # List all public events for GitHub
+      #
+      # @return [Array] A list of all public events from GitHub
+      # @see http://developer.github.com/v3/events
+      # @example List all pubilc events
+      #   Octokit.public_events
+      def public_events(options={})
+        get("/events", options, 3)
+      end
+
+      # List events for a repository
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @return [Array] A list of events for a repository
+      # @see http://developer.github.com/v3/events
+      # @example List events for a repository
+      #   Octokit.repository_events("sferik/rails_admin")
+      def repository_events(repo, options={})
+        get("/repos/#{Repository.new(repo)}/events", options, 3)
+      end
+    end
+  end
+end

data/lib/octokit/client/issues.rb

@@ -12,7 +12,7 @@ module Octokit
       # @example Search for 'test' in the open issues for sferik/rails_admin
       #   Octokit.search_issues("sferik/rails_admin", 'test', 'open')
       def search_issues(repo, search_term, state='open', options={})
-        get("/api/v2/json/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options)['issues']
+        get("/api/v2/json/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options, 2)['issues']
       end
 
       # List issues for a repository
@@ -46,7 +46,7 @@ module Octokit
       # @example Create a new Issues for a repository
       #   Octokit.create_issue("sferik/rails_admin")
       def create_issue(repo, title, body, options={})
-        post("/api/v2/json/issues/open/#{Repository.new(repo)}", options.merge({:title => title, :body => body}))['issue']
+        post("/repos/#{Repository.new(repo)}/issues", options.merge({:title => title, :body => body}), 3)
       end
       alias :open_issue :create_issue
 
@@ -59,7 +59,7 @@ module Octokit
       # @example Get issue #25 from pengwynn/octokit
       #   Octokit.issue("pengwynn/octokit", "25")
       def issue(repo, number, options={})
-        get("/api/v2/json/issues/show/#{Repository.new(repo)}/#{number}", options)['issue']
+        get("/repos/#{Repository.new(repo)}/issues/#{number}", options, 3)
       end
 
       # Close an issue
@@ -73,7 +73,7 @@ module Octokit
       # @example Close Issue #25 from pengwynn/octokit
       #   Octokit.close_issue("pengwynn/octokit", "25")
       def close_issue(repo, number, options={})
-        post("/api/v2/json/issues/close/#{Repository.new(repo)}/#{number}", options)['issue']
+        post("/repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"}), 3)
       end
 
       # Reopen an issue
@@ -87,7 +87,7 @@ module Octokit
       # @example Reopen Issue #25 from pengwynn/octokit
       #   Octokit.reopen_issue("pengwynn/octokit", "25")
       def reopen_issue(repo, number, options={})
-        post("/api/v2/json/issues/reopen/#{Repository.new(repo)}/#{number}", options)['issue']
+        post("/repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"}), 3)
       end
 
       # Update an issue
@@ -103,7 +103,7 @@ module Octokit
       # @example Change the title of Issue #25
       #   Octokit.update_issue("pengwynn/octokit", "25", "A new title", "the same body"")
       def update_issue(repo, number, title, body, options={})
-        post("/api/v2/json/issues/edit/#{Repository.new(repo)}/#{number}", options.merge({:title => title, :body => body}))['issue']
+        post("/repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}), 3)
       end
 
       # Get all comments attached to an issue
@@ -122,7 +122,7 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
-      # @return [Array] Array of comments that belong to an issue
+      # @return [Comment] The specific comment in question
       # @see http://developer.github.com/v3/issues/comments/#get-a-single-comment
       # @example Get comments for issue #25 from pengwynn/octokit
       #   Octokit.issue_comments("pengwynn/octokit", "25")
@@ -167,6 +167,34 @@ module Octokit
       def delete_comment(repo, number, options={})
         delete("/repos/#{Repository.new(repo)}/issues/comments/#{number}", options, 3, true, true)
       end
+
+
+      # List events for an Issue
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Issue number
+      #
+      # @return [Array] Array of events for that issue
+      # @see http://developer.github.com/v3/issues/events/
+      # @example List all issues events for issue #38 on pengwynn/octokit
+      #   Octokit.issue_events("pengwynn/octokit", 38)
+      def issue_events(repo, number, options={})
+        get("/repos/#{Repository.new(repo)}/issues/#{number}/events", options, 3)
+      end
+
+      # Get information on a single Issue Event
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Event number
+      #
+      # @return [Event] A single Event for an Issue
+      # @see http://developer.github.com/v3/issues/events/#get-a-single-event
+      # @example Get Event information for ID 3094334 (a pull request was closed)
+      #   Octokit.issue_event("pengwynn/octokit", 3094334)
+      def issue_event(repo, number, options={})
+        get("/repos/#{Repository.new(repo)}/issues/events/#{number}", options, 3)
+      end
+
     end
   end
 end

data/lib/octokit/client/labels.rb

@@ -38,7 +38,7 @@ module Octokit
         post("repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color}), 3)
       end
 
-      # Update a label 
+      # Update a label
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param label [String] The name of the label which will be updated
@@ -53,7 +53,7 @@ module Octokit
         post("repos/#{Repository.new(repo)}/labels/#{URI.encode_www_form_component(label)}", options, 3)
       end
 
-      # Delete a label from a repository.  
+      # Delete a label from a repository.
       #
       # This deletes the label from the repository, and removes it from all issues.
       #
@@ -140,12 +140,12 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the milestone
-      # @return [Array] A list of the labels across the milestone 
+      # @return [Array] A list of the labels across the milestone
       # @see  http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
       # @example List all labels for milestone #2 on pengwynn/octokit
       #   Octokit.labels_for_milestone("pengwynn/octokit", 2)
-      def labels_for_milestone(repo, number, options={}) 
-        get("repos/#{Repository.new(repo)}/milestones/#{number}/labels", options, 3) 
+      def labels_for_milestone(repo, number, options={})
+        get("repos/#{Repository.new(repo)}/milestones/#{number}/labels", options, 3)
       end
 
     end

data/lib/octokit/client/objects.rb

@@ -2,27 +2,31 @@ module Octokit
   class Client
     module Objects
       def tree(repo, tree_sha, options={})
-        get("/api/v2/json/tree/show/#{Repository.new(repo)}/#{tree_sha}", options)['tree']
+        get("repos/#{Repository.new(repo)}/git/trees/#{tree_sha}", options)
       end
 
-      def blob(repo, tree_sha, path, options={})
-        get("/api/v2/json/blob/show/#{Repository.new(repo)}/#{tree_sha}/#{path}", options)['blob']
+      def blob(repo, tree_sha, options={})
+        get("repos/#{Repository.new(repo)}/git/blobs/#{tree_sha}", options)
       end
 
+      # Depreciated 
       def blobs(repo, tree_sha, options={})
-        get("/api/v2/json/blob/all/#{Repository.new(repo)}/#{tree_sha}", options)['blobs']
+        get("/api/v2/json/blob/all/#{Repository.new(repo)}/#{tree_sha}", options, 2)['blobs']
       end
 
+      # Depreciated 
       def blob_metadata(repo, tree_sha, options={})
-        get("/api/v2/json/blob/full/#{Repository.new(repo)}/#{tree_sha}", options)['blobs']
+        get("/api/v2/json/blob/full/#{Repository.new(repo)}/#{tree_sha}", options, 2)['blobs']
       end
       alias :blob_meta :blob_metadata
 
+      # Depreciated
       def tree_metadata(repo, tree_sha, options={})
-        get("/api/v2/json/tree/full/#{Repository.new(repo)}/#{tree_sha}", options)['tree']
+        get("/api/v2/json/tree/full/#{Repository.new(repo)}/#{tree_sha}", options, 2)['tree']
       end
       alias :tree_meta :tree_metadata
 
+      # Depreciated
       def raw(repo, sha, options={})
         get("/api/v2/json/blob/show/#{Repository.new(repo)}/#{sha}", options, 2, true, true).body
       end

data/lib/octokit/client/organizations.rb

@@ -2,86 +2,90 @@ module Octokit
   class Client
     module Organizations
       def organization(org, options={})
-        get("/api/v2/json/organizations/#{org}", options)['organization']
+        get("orgs/#{org}", options, 3)
       end
       alias :org :organization
 
       def update_organization(org, values, options={})
-        put("/api/v2/json/organizations/#{org}", options.merge({:organization => values}))['organization']
+        patch("orgs/#{org}", options.merge({:organization => values}), 3)
       end
       alias :update_org :update_organization
 
       def organizations(user=nil, options={})
         if user
-          get("/api/v2/json/user/show/#{user}/organizations", options)
+          get("users/#{user}/orgs", options, 3)
         else
-          get("/api/v2/json/organizations", options)
-        end['organizations']
+          get("user/orgs", options, 3)
+        end
       end
       alias :list_organizations :organizations
       alias :list_orgs :organizations
       alias :orgs :organizations
 
       def organization_repositories(org=nil, options={})
-        if org
-          get("/api/v2/json/organizations/#{org}/public_repositories", options)
+        if org.nil?
+          # Depreciated
+          get("/api/v2/json/organizations/repositories", options, 2)
         else
-          get("/api/v2/json/organizations/repositories", options)
-        end['repositories']
+          get("orgs/#{org}/repos", options, 3)
+        end
       end
       alias :org_repositories :organization_repositories
       alias :org_repos :organization_repositories
 
       def organization_members(org, options={})
-        get("/api/v2/json/organizations/#{org}/public_members", options)['users']
+        get("orgs/#{org}/members", options, 3)
       end
       alias :org_members :organization_members
 
       def organization_teams(org, options={})
-        get("/api/v2/json/organizations/#{org}/teams", options)['teams']
+        get("orgs/#{org}/teams", options, 3)
       end
       alias :org_teams :organization_teams
 
       def create_team(org, values, options={})
-        post("/api/v2/json/organizations/#{org}/teams", options.merge({:team => values}))['team']
+        post("orgs/#{org}/teams", options.merge({:team => values}), 3)
       end
 
       def team(team_id, options={})
-        get("/api/v2/json/teams/#{team_id}", options)['team']
+        get("teams/#{team_id}", options, 3)
       end
 
       def update_team(team_id, values, options={})
-        put("/api/v2/json/teams/#{team_id}", options.merge({:team => values}))['team']
+        patch("teams/#{team_id}", options.merge({:team => values}), 3)
       end
 
       def delete_team(team_id, options={})
-        delete("/api/v2/json/teams/#{team_id}", options)['team']
+        delete("teams/#{team_id}", options, 3, true, true)
       end
 
       def team_members(team_id, options={})
-        get("/api/v2/json/teams/#{team_id}/members", options)['users']
+        get("teams/#{team_id}/members", options, 3)
       end
 
       def add_team_member(team_id, user, options={})
-        post("/api/v2/json/teams/#{team_id}/members", options.merge({:name => user}))['user']
+        # There's a bug in this API call. The docs say to leave the body blank,
+        # but it fails if the body is both blank and the content-length header
+        # is not 0.
+        put("teams/#{team_id}/members/#{user}", options.merge({:name => user}), 3, true, raw=true).status == 204
       end
 
       def remove_team_member(team_id, user, options={})
-        delete("/api/v2/json/teams/#{team_id}/members", options.merge({:name => user}))['user']
+        delete("teams/#{team_id}/members/#{user}", options, 3, true, raw=true).status == 204
       end
 
       def team_repositories(team_id, options={})
-        get("/api/v2/json/teams/#{team_id}/repositories", options)['repositories']
+        get("teams/#{team_id}/repos", options, 3)
       end
       alias :team_repos :team_repositories
 
       def add_team_repository(team_id, repo, options={})
-        post("/api/v2/json/teams/#{team_id}/repositories", options.merge(:name => Repository.new(repo)))['repositories']
+        put("teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo)), 3, true, raw=true).status == 204
       end
       alias :add_team_repo :add_team_repository
 
       def remove_team_repository(team_id, repo, options={})
-        delete("/api/v2/json/teams/#{team_id}/repositories", options.merge(:name => Repository.new(repo)))['repositories']
+        delete("teams/#{team_id}/repos/#{Repository.new(repo)}", options, 3, true, raw=true).status == 204
       end
       alias :remove_team_repo :remove_team_repository
     end