octokit 0.6.4 → 0.6.5

data/.travis.yml

@@ -1,8 +1,8 @@
 rvm:
   - 1.8.7
-  - 1.9.1
   - 1.9.2
+  - 1.9.3
   - jruby
   - rbx
+  - rbx-2.0
   - ree
-  - ruby-head

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 # CHANGELOG
 
+* [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)
 * [0.6.1 - April 6, 2011](https://github.com/pengwynn/octokit/compare/v0.6.0...v0.6.1)

data/README.md

@@ -1,31 +1,23 @@
-Octokit
-=======
+# Octokit
 Simple Ruby wrapper for the GitHub v2 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)
 
-Installation
-------------
+## <a name="installation">Installation</a>
     gem install octokit
 
-Continuous Integration
-----------------------
-[![Build Status](http://travis-ci.org/pengwynn/octokit.png)](http://travis-ci.org/pengwynn/octokit)
+## <a name="ci">Continuous Integration</a>
+[![Build Status](https://secure.travis-ci.org/pengwynn/octokit.png)](http://travis-ci.org/pengwynn/octokit)
 
-Documentation
--------------
+## <a name="documentation">Documentation</a>
 http://rdoc.info/gems/octokit
 
-Examples
--------------
-
+## <a name="examples">Examples</a>
 ### 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">
 
 ### Show who a user follows
-
     Octokit.following("sferik")
     => ["rails", "puls", "wycats", "dhh", "jm3", "joshsusser", "nkallen", "technoweenie", "blaine", "al3x", "defunkt", "schacon", "bmizerany", "rtomayko", "jpr5", "lholden", "140proof", "ephramzerb", "carlhuda", "carllerche", "jnunemaker", "josh", "hoverbird", "jamiew", "jeremyevans", "brynary", "mojodna", "mojombo", "joshbuddy", "igrigorik", "perplexes", "joearasin", "hassox", "nickmarden", "pengwynn", "mmcgrana", "reddavis", "reinh", "mzsanford", "aanand", "pjhyett", "kneath", "tekkub", "adamstac", "timtrueman", "aaronblohowiak", "josevalim", "kaapa", "hurrycane", "jackdempsey", "drogus", "cameronpriest", "danmelton", "marcel", "r", "atmos", "mbleigh", "isaacs", "maxogden", "codeforamerica", "chadk", "laserlemon", "gruber", "lsegal", "bblimke", "wayneeseguin", "brixen", "dkubb", "bhb", "bcardarella", "elliottcable", "fbjork", "mlightner", "dianakimball", "amerine", "danchoi", "develop", "dmfrancisco", "unruthless", "trotter", "hannestyden", "codahale", "ry"]
 
@@ -40,15 +32,21 @@ 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>
 
-Authenticated requests
-----------------------
-Some methods require authentication so you'll need to pass a login and an api_token. You can find your GitHub API token on your [account page](https://github.com/account).
+## <a name="authenticated_requests">Authenticated requests</a>
+For methods that require authentication, you'll need to setup a client with
+your login and password.
+
+    client = Octokit::Client.new(:login => "me", :password => "sekret")
+    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).
 
-    client = Octokit::Client.new(:login => "pengwynn", :token => "OU812")
+    client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
     client.follow!("sferik")
 
-Submitting a Pull Request
--------------------------
+## <a name="pulls">Submitting a Pull Request</a>
 1. Fork the project.
 2. Create a topic branch.
 3. Implement your feature or bug fix.
@@ -59,11 +57,35 @@ Submitting a Pull Request
 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.)
 
-Inspiration
------------
+## <a name="rubies">Supported Rubies</a>
+This library aims to support and is [tested
+against](http://travis-ci.org/pengwynn/octokit) 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/)
+
+If something doesn't work on one of these interpreters, it should be considered
+a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+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.
 
-Copyright
----------
+## <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.

data/lib/octokit/authentication.rb

@@ -1,9 +1,7 @@
 module Octokit
   module Authentication
     def authentication
-      if login && token
-        {:login => "#{login}/token", :password => token}
-      elsif login && password
+      if login && password
         {:login => login, :password => password}
       else
         {}

data/lib/octokit/client.rb

@@ -5,6 +5,7 @@ require 'octokit/request'
 
 require 'octokit/client/commits'
 require 'octokit/client/issues'
+require 'octokit/client/labels'
 require 'octokit/client/network'
 require 'octokit/client/milestones'
 require 'octokit/client/objects'
@@ -18,7 +19,7 @@ require 'octokit/client/users'
 
 module Octokit
   class Client
-    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
 
     def initialize(options={})
       options = Octokit.options.merge(options)
@@ -33,6 +34,7 @@ module Octokit
 
     include Octokit::Client::Commits
     include Octokit::Client::Issues
+    include Octokit::Client::Labels
     include Octokit::Client::Network
     include Octokit::Client::Milestones
     include Octokit::Client::Objects

data/lib/octokit/client/commits.rb

@@ -3,12 +3,13 @@ module Octokit
     module Commits
 
       def commits(repo, branch="master", options={})
-        get("/api/v2/json/commits/list/#{Repository.new(repo)}/#{branch}", options)['commits']
+        options = { :per_page => 35, :sha => branch }.merge options
+        get("/repos/#{Repository.new(repo)}/commits", options, 3)
       end
       alias :list_commits :commits
 
       def commit(repo, sha, options={})
-        get("/api/v2/json/commits/show/#{Repository.new(repo)}/#{sha}", options)['commit']
+        get("/repos/#{Repository.new(repo)}/commits/#{sha}", options, 3)
       end
 
     end

data/lib/octokit/client/issues.rb

@@ -4,7 +4,7 @@ module Octokit
 
       # Search issues within a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param search_term [String] The term to search for
       # @param state [String] :state (open) <tt>open</tt> or <tt>closed</tt>.
       # @return [Array] A list of issues matching the search term and state
@@ -38,7 +38,7 @@ module Octokit
 
       # Create an issue for a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param title [String] A descriptive title
       # @param body [String] A concise description
       # @return [Issue] Your newly created issue
@@ -52,7 +52,7 @@ module Octokit
 
       # Get a single issue from a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
       # @return [Issue] The issue you requested, if it exists
       # @see http://developer.github.com/v3/issues/#get-a-single-issue
@@ -64,7 +64,7 @@ module Octokit
 
       # Close an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
       # @return [Issue] The updated Issue
       # @see http://develop.github.com/p/issues.html
@@ -78,7 +78,7 @@ module Octokit
 
       # Reopen an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
       # @return [Issue] The updated Issue
       # @see http://develop.github.com/p/issues.html
@@ -92,7 +92,7 @@ module Octokit
 
       # Update an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
       # @param title [String] Updated title for the issue
       # @param body [String] Updated body of the issue
@@ -106,60 +106,9 @@ module Octokit
         post("/api/v2/json/issues/edit/#{Repository.new(repo)}/#{number}", options.merge({:title => title, :body => body}))['issue']
       end
 
-      # List available labels for a repository
-      #
-      # @param repository [String, Repository, Hash] A GitHub repository.
-      # @return [Array] A list of the labels currently on the issue
-      # @see http://develop.github.com/p/issues.html
-      # @see http://developer.github.com/v3/issues/labels/
-      # @example List labels for pengwynn/octokit
-      #   Octokit.labels("pengwynn/octokit")
-      def labels(repo, options={})
-        get("repos/#{Repository.new(repo)}/labels", options, 3)
-      end
-
-      # Get single label for a repository
-      #
-      # @param repository [String, Repository, Hash] A GitHub repository.
-      # @param name [String] Name of the label
-      # @return [Label] A single label from the repository
-      # @see http://developer.github.com/v3/issues/labels/#get-a-single-label
-      # @example Get the "V3 Addition" label from pengwynn/octokit
-      #   Octokit.labels("pengwynn/octokit")
-      def label(repo, name, options={})
-        get("repos/#{Repository.new(repo)}/labels/#{URI.encode(name)}", options, 3)
-      end
-      # Add a label to a repository
-      #
-      # @param repository [String, Repository, Hash] A GitHub repository.
-      # @param label [String] A new label
-      # @param color [String] A color, in hex, without the leading #
-      # @return [Array] A list of the labels currently on the issue
-      # @see http://developer.github.com/v3/issues/labels/
-      # @example Add a new label "Version 1.0" with color "#cccccc"
-      #   Octokit.add_label("pengwynn/octokit", "Version 1.0", "cccccc")
-      def add_label(repo, label, color="ffffff", options={})
-        post("repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color}), 3)
-      end
-
-      # Remove a label from a repository
-      #
-      # @param repository [String, Repository, Hash] A GitHub repository.
-      # @param label [String] Label you wish to remove
-      # @param number [Integer] Optional Issue number to remove the label from
-      # @note Leaving the number parameter out will remove this label from all issues
-      # @return [Array] A list of the labels currently on the issue
-      # @see http://develop.github.com/p/issues.html
-      # @see http://developer.github.com/v3/issues/labels/
-      # @example Remove the label "Version 1.0" from the repository
-      #   Octokit.remove_label("pengwynn/octokit", "Version 1.0")
-      def remove_label(repo, label, number=nil, options={})
-        post(["/api/v2/json/issues/label/remove/#{Repository.new(repo)}/#{label}", number].compact.join('/'), options)['labels']
-      end
-
       # Get all comments attached to an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @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
       # @see http://developer.github.com/v3/issues/comments
@@ -171,7 +120,7 @@ module Octokit
 
       # Get a single comment attached to an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @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
       # @see http://developer.github.com/v3/issues/comments/#get-a-single-comment
@@ -183,7 +132,7 @@ module Octokit
 
       # Add a comment to an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [Integer] Issue number
       # @param comment [String] Comment to be added
       # @return [Comment] A JSON encoded Comment
@@ -196,7 +145,7 @@ module Octokit
 
       # Update a single comment on an issue
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [Integer] Comment number
       # @param comment [String] Body of the comment which will replace the existing body.
       # @return [Comment] A JSON encoded Comment
@@ -209,7 +158,7 @@ module Octokit
 
       # Delete a single comment
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [Integer] Comment number
       # @return [Response] A response object with status
       # @see http://developer.github.com/v3/issues/comments/#delete-a-comment

data/lib/octokit/client/labels.rb

@@ -0,0 +1,153 @@
+module Octokit
+  class Client
+    module Labels
+
+      # List available labels for a repository
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @return [Array] A list of the labels across the repository
+      # @see http://developer.github.com/v3/issues/labels/
+      # @example List labels for pengwynn/octokit
+      #   Octokit.labels("pengwynn/octokit")
+      def labels(repo, options={})
+        get("repos/#{Repository.new(repo)}/labels", options, 3)
+      end
+
+      # Get single label for a repository
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param name [String] Name of the label
+      # @return [Label] A single label from the repository
+      # @see http://developer.github.com/v3/issues/labels/#get-a-single-label
+      # @example Get the "V3 Addition" label from pengwynn/octokit
+      #   Octokit.labels("pengwynn/octokit")
+      def label(repo, name, options={})
+        get("repos/#{Repository.new(repo)}/labels/#{URI.encode_www_form_component(name)}", options, 3)
+      end
+
+      # Add a label to a repository
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param label [String] A new label
+      # @param color [String] A color, in hex, without the leading #
+      # @return [Label] A Hashie of the new label
+      # @see http://developer.github.com/v3/issues/labels/
+      # @example Add a new label "Version 1.0" with color "#cccccc"
+      #   Octokit.add_label("pengwynn/octokit", "Version 1.0", "cccccc")
+      def add_label(repo, label, color="ffffff", options={})
+        post("repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color}), 3)
+      end
+
+      # Update a label 
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param label [String] The name of the label which will be updated
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :title An updated label name
+      # @option options [String] :color An updated color value, in hex, without leading #
+      # @return [Label] A Hashie of the updated label
+      # @see http://developer.github.com/v3/issues/labels/#update-a-label
+      # @example Update the label "Version 1.0" with new color "#cceeaa"
+      #   Octokit.update_label("pengwynn/octokit", "Version 1.0", {:color => "cceeaa"})
+      def update_label(repo, label, options={})
+        post("repos/#{Repository.new(repo)}/labels/#{URI.encode_www_form_component(label)}", options, 3)
+      end
+
+      # Delete a label from a repository.  
+      #
+      # This deletes the label from the repository, and removes it from all issues.
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param label [String] String name of the label
+      # @return [Response] A Faraday Response object
+      # @see http://developer.github.com/v3/issues/labels/#delete-a-label
+      # @see http://rubydoc.info/gems/faraday/0.5.3/Faraday/Response
+      # @example Delete the label "Version 1.0" from the repository.
+      #   Octokit.delete_label!("pengwynn/octokit", "Version 1.0")
+      def delete_label!(repo, label, options={})
+        delete("repos/#{Repository.new(repo)}/labels/#{URI.encode_www_form_component(label)}", options, 3, true, true)
+      end
+
+      # Remove a label from an Issue
+      #
+      # This removes the label from the Issue
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param number [String] Number ID of the issue
+      # @param label [String] String name of the label
+      # @return [Array] A list of the labels currently on the issue
+      # @see http://rubydoc.info/gems/faraday/0.5.3/Faraday/Response
+      # @see http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
+      # @example Remove the label "Version 1.0" from the repository.
+      #   Octokit.remove_label("pengwynn/octokit", 23, "Version 1.0")
+      def remove_label(repo, number, label, options={})
+        delete("repos/#{Repository.new(repo)}/issues/#{number}/labels/#{URI.encode_www_form_component(label)}", options, 3, true)
+      end
+
+      # Remove all label from an Issue
+      #
+      # This removes the label from the Issue
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param number [String] Number ID of the issue
+      # @return [Array] A list of the labels currently on the issue
+      # @see http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
+      # @example Remove all labels from Issue #23
+      #   Octokit.remove_all_labels("pengwynn/octokit", 23)
+      def remove_all_labels(repo, number, options={})
+        delete("repos/#{Repository.new(repo)}/issues/#{number}/labels", options, 3, true, true)
+      end
+
+      # List labels for a given issue
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param number [String] Number ID of the issue
+      # @return [Array] A list of the labels currently on the issue
+      # @see http://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
+      # @example List labels for pengwynn/octokit
+      #   Octokit.labels("pengwynn/octokit")
+      def labels_for_issue(repo, number, options={})
+        get("repos/#{Repository.new(repo)}/issues/#{number}/labels", options, 3)
+      end
+
+      # Add label(s) to an Issue
+      #
+      # @param repo [String, Repository, Hash] A Github repository
+      # @param number [String] Number ID of the issue
+      # @param labels [Array] An array of labels to apply to this Issue
+      # @return [Array] A list of the labels currently on the issue
+      # @see http://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
+      # @example Add two labels for pengwynn/octokit
+      #   Octokit.add_labels_to_an_issue("pengwynn/octokit", 10, ['V3 Transition', 'Improvement'])
+      def add_labels_to_an_issue(repo, number, labels)
+        post("repos/#{Repository.new(repo)}/issues/#{number}/labels", labels, 3)
+      end
+
+      # Replace all labels on an Issue
+      #
+      # @param repo [String, Repository, Hash] A Github repository
+      # @param number [String] Number ID of the issue
+      # @param labels [Array] An array of labels to use as replacement
+      # @return [Array] A list of the labels currently on the issue
+      # @see http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
+      # @example Replace labels for pengwynn/octokit Issue #10
+      #   Octokit.replace_all_labels("pengwynn/octokit", 10, ['V3 Transition', 'Improvement'])
+      def replace_all_labels(repo, number, labels, options={})
+        put("repos/#{Repository.new(repo)}/issues/#{number}/labels", labels, 3)
+      end
+
+      # Get labels for every issue in a milestone
+      #
+      # @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 
+      # @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) 
+      end
+
+    end
+  end
+end