octokit 1.15.1 → 1.17.0

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 # CHANGELOG
 
+* [1.17.0 - October 8, 2012](https://github.com/pengwynn/octokit/compare/v1.16.0...v1.17.0)
+* [1.16.0 - September 25,2012](https://github.com/pengwynn/octokit/compare/v1.15.1...v1.16.0)
 * [1.15.1 - September 24,2012](https://github.com/pengwynn/octokit/compare/v1.15.0...v1.15.1)
 * [1.15.0 - September 24,2012](https://github.com/pengwynn/octokit/compare/v1.14.0...v1.15.0)
 * [1.14.0 - September 22,2012](https://github.com/pengwynn/octokit/compare/v1.13.0...v1.14.0)

data/lib/octokit/client/commits.rb

@@ -81,6 +81,62 @@ module Octokit
         get("repos/#{Repository.new(repo)}/comments/#{id}", options, 3)
       end
 
+      # Create a commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param sha [String] Sha of the commit to comment on
+      # @param body [String] Message
+      # @param path [String] Relative path of file to comment on
+      # @param line [Integer] Line number in the file to comment on
+      # @param position [Integer] Line index in the diff to comment on
+      # @return [Hashie::Mash] A hash representing the new commit comment
+      # @see http://developer.github.com/v3/repos/comments/
+      # @example Create a commit comment
+      #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
+      #   commit.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
+      #   commit.body # => "My comment message"
+      #   commit.path # => "README.md"
+      #   commit.line # => 10
+      #   commit.position # => 1
+      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options={})
+        params = {
+          :body => body,
+          :commit_id => sha,
+          :path => path,
+          :line => line,
+          :position => position
+        }
+        post("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params), 3)
+      end
+
+      # Update a commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to update
+      # @param body [String] Message
+      # @return [Hashie::Mash] A hash representing the updated commit comment
+      # @see http://developer.github.com/v3/repos/comments/
+      # @example Update a commit comment
+      #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
+      #   commit.id # => 860296
+      #   commit.body # => "Updated commit comment"
+      def update_commit_comment(repo, id, body, options={})
+        params = {
+          :body => body
+        }
+        patch("repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params), 3)
+      end
+
+      # Delete a commit comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param id [String] The ID of the comment to delete
+      # @return [nil] nil
+      # @see http://developer.github.com/v3/repos/comments/
+      def delete_commit_comment(repo, id, options={})
+        delete("repos/#{Repository.new(repo)}/comments/#{id}", options, 3)
+      end
+
       # Compare two commits
       #
       # @param repo [String, Hash, Repository] A GitHub repository

data/lib/octokit/client/gists.rb

@@ -2,32 +2,108 @@ module Octokit
   class Client
     module Gists
 
-      def create_gist(options={})
-        post 'gists', options, 3
+      # List gists for a user or all public gists
+      #
+      # @param username [String] An optional user to filter listing 
+      # @return [Array<Hashie::Mash>] A list of gists
+      # @example Fetch all gists for defunkt
+      #   Octokit.gists('defunkt')
+      # @example Fetch all public gists
+      #   Octokit.gists
+      # @see http://developer.github.com/v3/gists/#list-gists
+      def gists(username=nil, options={})
+        if username.nil?
+          get 'gists', options, 3
+        else
+          get "users/#{username}/gists", options, 3
+        end
       end
+      alias :list_gists :gists
 
-      def delete_gist(gist, options={})
-        response = delete("gists/#{Gist.new gist}", options, 3, true, true)
-        response.status == 204
+      # List public gists
+      #
+      # @return [Array<Hashie::Mash>] A list of gists
+      # @example Fetch all public gists
+      #   Octokit.public_gists
+      # @see http://developer.github.com/v3/gists/#list-gists
+      def public_gists(options={})
+        get 'gists/public', options, 3
       end
 
-      def edit_gist(gist, options={})
-        patch "gists/#{Gist.new gist}", options, 3
+      # List the authenticated user’s starred gists
+      #
+      # @return [Array<Hashie::Mash>] A list of gists
+      def starred_gists(options={})
+        get 'gists/starred', options, 3
       end
 
+      # Get a single gist
+      #
+      # @param gist [String] ID of gist to fetch
+      # @return [Hash::Mash] Gist information
+      # @see http://developer.github.com/v3/gists/#get-a-single-gist
       def gist(gist, options={})
         get "gists/#{Gist.new gist}", options, 3
       end
 
-      def gists(username=nil, options={})
-        if username.nil?
-          get 'gists', options, 3
-        else
-          get "users/#{username}/gists", options, 3
-        end
+      # Create a gist
+      #
+      # @param options [Hash] Gist information.
+      # @option options [String] :description
+      # @option options [Boolean] :public Sets gist visibility
+      # @option options [Array<Hash>] :files Files that make up this gist. Keys
+      #   should be the filename, the value a Hash with a :content key with text
+      #   conent of the Gist.
+      # @return [Hashie::Mash] Newly created gist info
+      # @see http://developer.github.com/v3/gists/#create-a-gist
+      def create_gist(options={})
+        post 'gists', options, 3
       end
 
-      # Returns +true+ if +gist+ is starred, +false+ otherwise.
+      # Edit a gist
+      #
+      # @param options [Hash] Gist information.
+      # @option options [String] :description
+      # @option options [Boolean] :public Sets gist visibility
+      # @option options [Array<Hash>] :files Files that make up this gist. Keys
+      #   should be the filename, the value a Hash with a :content key with text
+      #   conent of the Gist. 
+      #
+      #   NOTE: All files from the previous version of the
+      #   gist are carried over by default if not included in the hash. Deletes
+      #   can be performed by including the filename with a null hash.  
+      # @return
+      #   [Hashie::Mash] Newly created gist info
+      # @see http://developer.github.com/v3/gists/#edit-a-gist
+      def edit_gist(gist, options={})
+        patch "gists/#{Gist.new gist}", options, 3
+      end
+      #
+      # Star a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicates if gist is starred successfully
+      # @see http://developer.github.com/v3/gists/#star-a-gist
+      def star_gist(gist, options={})
+        response = put("gists/#{Gist.new gist}/star", options, 3, true, true)
+        response.status == 204
+      end
+
+      # Unstar a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicates if gist is unstarred successfully
+      # @see http://developer.github.com/v3/gists/#unstar-a-gist
+      def unstar_gist(gist, options={})
+        response = delete("gists/#{Gist.new gist}/star", options, 3, true, true)
+        response.status == 204
+      end
+
+      # Check if a gist is starred
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicates if gist is starred
+      # @see http://developer.github.com/v3/gists/#check-if-a-gist-is-starred
       def gist_starred?(gist, options={})
         begin
           get("gists/#{Gist.new gist}/star", options, 3, true, true)
@@ -37,27 +113,22 @@ module Octokit
         end
       end
 
+      # Fork a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Hashie::Mash] Data for the new gist
+      # @see http://developer.github.com/v3/gists/#fork-a-gist
       def fork_gist(gist, options={})
         post "gists/#{Gist.new gist}/fork", options, 3
       end
 
-      def public_gists(options={})
-        get 'gists', options, 3
-      end
-
-      def starred_gists(options={})
-        get 'gists/starred', options, 3
-      end
-
-      # Returns +true+ or +false+ based on success.
-      def star_gist(gist, options={})
-        response = put("gists/#{Gist.new gist}/star", options, 3, true, true)
-        response.status == 204
-      end
-
-      # Returns +true+ or +false+ based on success.
-      def unstar_gist(gist, options={})
-        response = delete("gists/#{Gist.new gist}/star", options, 3, true, true)
+      # Delete a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicating success of deletion
+      # @see http://developer.github.com/v3/gists/#delete-a-gist
+      def delete_gist(gist, options={})
+        response = delete("gists/#{Gist.new gist}", options, 3, true, true)
         response.status == 204
       end
 

data/lib/octokit/client/issues.rb

@@ -15,13 +15,14 @@ module Octokit
         get("legacy/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options, 3)['issues']
       end
 
-      # List issues for a repository
+      # List issues for a the authenticated user or repository
       #
       # @param repository [String, Repository, Hash] A GitHub repository.
       # @param options [Hash] A customizable set of options.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
       # @option options [String] :assignee User login.
+      # @option options [String] :creator User login.
       # @option options [String] :mentioned User login.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
@@ -31,8 +32,14 @@ module Octokit
       # @see http://developer.github.com/v3/issues/#list-issues-for-this-repository
       # @example List issues for a repository
       #   Octokit.list_issues("sferik/rails_admin")
-      def list_issues(repository, options={})
-        get("repos/#{Repository.new(repository)}/issues", options, 3)
+      # @example List issues for the authenticted user across repositories
+      #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
+      #   @client.list_issues
+      def list_issues(repository = nil, options={})
+        path = ''
+        path = "repos/#{Repository.new(repository)}" if repository
+        path += "/issues"
+        get(path, options, 3)
       end
       alias :issues :list_issues
 

data/lib/octokit/client/organizations.rb

@@ -22,7 +22,12 @@ module Octokit
       alias :list_orgs :organizations
       alias :orgs :organizations
 
-      def organization_repositories(org=nil, options={})
+      # List organization repositories
+      #
+      # @see http://developer.github.com/v3/repos/#list-organization-repositories
+      # @param org [String] Organization handle for which to list repos
+      # @return [Array<Hashie::Mash>] List of repositories
+      def organization_repositories(org, options={})
         get("orgs/#{org}/repos", options, 3)
       end
       alias :org_repositories :organization_repositories

data/lib/octokit/client/pulls.rb

@@ -1,6 +1,43 @@
 module Octokit
   class Client
     module Pulls
+      # List pull requests for a repository
+      #
+      # @see http://developer.github.com/v3/pulls/#list-pull-requests
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Method options
+      # @option options [String] :state `open` or `closed`. Default is `open`.
+      # @return [Array<Hashie::Mash>] Array of pulls
+      # @example
+      #   Octokit.pull_requests('rails/rails')
+      def pull_requests(repo, state='open', options={})
+        get("repos/#{Repository.new(repo)}/pulls", options.merge({:state => state}), 3)
+      end
+      alias :pulls :pull_requests
+
+      # Get a pull request
+      #
+      # @see http://developer.github.com/v3/pulls/#get-a-single-pull-request
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of the pull request to fetch
+      # @return [Hashie::Mash] Pull request info
+      def pull_request(repo, number, options={})
+        get("repos/#{Repository.new(repo)}/pulls/#{number}", options)
+      end
+      alias :pull :pull_request
+
+      # Create a pull request
+      #
+      # @see http://developer.github.com/v3/pulls/#create-a-pull-request
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param base [String] The branch (or git ref) you want your changes
+      #                      pulled into. This should be an existing branch on the current
+      #                      repository. You cannot submit a pull request to one repo that requests
+      #                      a merge to a base of another repo.
+      # @param head [String] The branch (or git ref) where your changes are implemented.
+      # @param title [String] Title for the pull request
+      # @param body [String] The body for the pull request. Supports GFM.
+      # @return [Hashie::Mash] The newly created pull request
       def create_pull_request(repo, base, head, title, body, options={})
         pull = {
           :base  => base,
@@ -11,6 +48,17 @@ module Octokit
         post("repos/#{Repository.new(repo)}/pulls", options.merge(pull))
       end
 
+      # Create a pull request from existing issue
+      #
+      # @see http://developer.github.com/v3/pulls/#alternative-input
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param base [String] The branch (or git ref) you want your changes
+      #                      pulled into. This should be an existing branch on the current
+      #                      repository. You cannot submit a pull request to one repo that requests
+      #                      a merge to a base of another repo.
+      # @param head [String] The branch (or git ref) where your changes are implemented.
+      # @param issue [Integer] Number of Issue on which to base this pull request
+      # @return [Hashie::Mash] The newly created pull request
       def create_pull_request_for_issue(repo, base, head, issue, options={})
         pull = {
           :base  => base,
@@ -20,24 +68,69 @@ module Octokit
         post("repos/#{Repository.new(repo)}/pulls", options.merge(pull))
       end
 
-      def pull_requests(repo, state='open', options={})
-        get("repos/#{Repository.new(repo)}/pulls", options.merge({:state => state}), 3)
-      end
-      alias :pulls :pull_requests
-
-      def pull_request(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/pulls/#{number}", options)
-      end
-      alias :pull :pull_request
 
+      # List commits on a pull request
+      #
+      # @see http://developer.github.com/v3/pulls/#list-commits-on-a-pull-request
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of pull request
+      # @return [Array<Hashie::Mash>] List of commits
       def pull_request_commits(repo, number, options={})
         get("repos/#{Repository.new(repo)}/pulls/#{number}/commits", options)
       end
       alias :pull_commits :pull_request_commits
 
+      # List comments on a pull request
+      #
+      # @see http://developer.github.com/v3/pulls/#list-comments-on-a-pull-request
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of pull request
+      # @return [Array<Hashie::Mash>] List of comments
+      def pull_request_comments(repo, number, options={})
+        # return the comments for a pull request
+        get("repos/#{Repository.new(repo)}/pulls/#{number}/comments", options)
+      end
+      alias :pull_comments   :pull_request_comments
+      alias :review_comments :pull_request_comments
+
+      # List files on a pull request
+      #
+      # @see http://developer.github.com/v3/pulls/#list-files-on-a-pull-request
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of pull request
+      # @return [Array<Hashie::Mash>] List of files
+      def pull_request_files(repo, number, options={})
+        get("repos/#{Repository.new(repo)}/pulls/#{number}/files", options)
+      end
+      alias :pull_files :pull_request_files
+
+      # Merge a pull request
+      #
+      # @see http://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of pull request
+      # @param commit_message [String] Optional commit message for the merge commit
+      # @return [Array<Hashie::Mash>] Merge commit info if successful
       def merge_pull_request(repo, number, commit_message='', options={})
         put("repos/#{Repository.new(repo)}/pulls/#{number}/merge", options.merge({:commit_message => commit_message}))
       end
+
+      # Check pull request merge status
+      #
+      # @see http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param number [Integer] Number of pull request
+      # @return [Boolean] True if the pull request has been merged
+      def pull_merged?(repo, number, options={})
+        begin
+          get("repos/#{Repository.new(repo)}/pulls/#{number}/merged", options)
+          return true
+        rescue Octokit::NotFound
+          return false
+        end
+      end
+      alias :pull_request_merged? :pull_merged?
+
     end
   end
 end

data/lib/octokit/client/repositories.rb

@@ -1,16 +1,40 @@
 module Octokit
   class Client
     module Repositories
+
+      # Legacy repository search
+      #
+      # @see http://developer.github.com/v3/search/#search-repositories
+      # @param q [String] Search keyword
+      # @return [Array<Hashie::Mash>] List of repositories found
       def search_repositories(q, options={})
         get("legacy/repos/search/#{q}", options, 3)['repositories']
       end
       alias :search_repos :search_repositories
 
+      # Get a single repository
+      #
+      # @see http://developer.github.com/v3/repos/#get
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Hashie::Mash] Repository information
       def repository(repo, options={})
         get "repos/#{Repository.new repo}", options, 3
       end
       alias :repo :repository
 
+      # Edit a repository
+      #
+      # @see http://developer.github.com/v3/repos/#edit
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Repository information to update
+      # @option options [String] :name Name of the repo
+      # @option options [String] :description Description of the repo
+      # @option options [String] :homepage Home page of the repo
+      # @option options [String] :private `true` makes the repository private, and `false` makes it public.
+      # @option options [String] :has_issues `true` enables issues for this repo, `false` disables issues.
+      # @option options [String] :has_wiki `true` enables wiki for this repo, `false` disables wiki.
+      # @option options [String] :has_downloads `true` enables downloads for this repo, `false` disables downloads.
+      # @return [Hashie::Mash] Repository information
       def edit_repository(repo, options={})
         patch "repos/#{Repository.new repo}", options, 3
       end
@@ -18,6 +42,14 @@ module Octokit
       alias :update_repository :edit_repository
       alias :update :edit_repository
 
+      # List repositories
+      #
+      # If username is not supplied, repositories for the current
+      # authenticated user are returned
+      #
+      # @see http://developer.github.com/v3/repos/#list-your-repositories
+      # @param username [String] Optional username for which to list repos
+      # @return [Array<Hashie::Mash>] List of repositories
       def repositories(username=nil, options={})
         if username.nil?
           get 'user/repos', options, 3
@@ -29,26 +61,83 @@ module Octokit
       alias :list_repos :repositories
       alias :repos :repositories
 
+      # Star a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Boolean] `true` if successfully starred
       def star(repo, options={})
-        put "user/starred/#{Repository.new repo}", options, 3
+        begin
+          put "user/starred/#{Repository.new repo}", options, 3
+          return true
+        rescue Octokit::NotFound
+          return false
+        end
       end
 
+      # Unstar a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Boolean] `true` if successfully unstarred
       def unstar(repo, options={})
-        delete "user/starred/#{Repository.new repo}", options, 3
+        begin
+          delete "user/starred/#{Repository.new repo}", options, 3
+          return true
+        rescue Octokit::NotFound
+          return false
+        end
       end
 
+      # Watch a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Boolean] `true` if successfully watched
+      # @deprecated Use #star instead
       def watch(repo, options={})
-        put "user/watched/#{Repository.new repo}", options, 3
+        begin
+          put "user/watched/#{Repository.new repo}", options, 3
+          return true
+        rescue Octokit::NotFound
+          return false
+        end
       end
 
+      # Unwatch a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Boolean] `true` if successfully unwatched
+      # @deprecated Use #unstar instead
       def unwatch(repo, options={})
-        delete "user/watched/#{Repository.new repo}", options, 3
+        begin
+          delete "user/watched/#{Repository.new repo}", options, 3
+          return true
+        rescue Octokit::NotFound
+          return false
+        end
       end
 
+      # Fork a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Hashie::Mash] Repository info for the new fork
       def fork(repo, options={})
         post "repos/#{Repository.new repo}/forks", options, 3
       end
 
+      # Create a repository for a user or organization
+      #
+      # @param name [String] Name of the new repo
+      # @option options [String] :description Description of the repo
+      # @option options [String] :homepage Home page of the repo
+      # @option options [String] :private `true` makes the repository private, and `false` makes it public.
+      # @option options [String] :has_issues `true` enables issues for this repo, `false` disables issues.
+      # @option options [String] :has_wiki `true` enables wiki for this repo, `false` disables wiki.
+      # @option options [String] :has_downloads `true` enables downloads for this repo, `false` disables downloads.
+      # @option options [String] :organization Short name for the org under which to create the repo.
+      # @option options [Integer] :team_id The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.
+      # @option options [Boolean] :auto_init `true` to create an initial commit with empty README. Default is `false`.
+      # @option options [String] :gitignore_template Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided.
+      # @return [Hashie::Mash] Repository info for the new repository
+      # @see http://developer.github.com/v3/repos/#create
       def create_repository(name, options={})
         organization = options.delete :organization
         options.merge! :name => name
@@ -62,16 +151,36 @@ module Octokit
       alias :create_repo :create_repository
       alias :create :create_repository
 
+      # Delete repository
+      #
+      # Note: If OAuth is used, 'delete_repo' scope is required
+      #
+      # @see http://developer.github.com/v3/repos/#delete-a-repository
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Boolean] `true` if repository was deleted
       def delete_repository(repo, options={})
-        delete "repos/#{Repository.new repo}", options, 3
+        begin
+          delete "repos/#{Repository.new repo}", options, 3
+          return true
+        rescue Octokit::NotFound
+          return false
+        end
       end
       alias :delete_repo :delete_repository
 
+      # Hide a public repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Hashie::Mash] Updated repository info
       def set_private(repo, options={})
         # GitHub Api for setting private updated to use private attr, rather than public
         update_repository repo, options.merge({ :private => true })
       end
 
+      # Unhide a private repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Hashie::Mash] Updated repository info
       def set_public(repo, options={})
         # GitHub Api for setting private updated to use private attr, rather than public
         update_repository repo, options.merge({ :private => false })

data/lib/octokit/configuration.rb

@@ -5,6 +5,7 @@ module Octokit
   module Configuration
     VALID_OPTIONS_KEYS = [
       :adapter,
+      :faraday_config_block,
       :api_version,
       :api_endpoint,
       :web_endpoint,
@@ -48,6 +49,10 @@ module Octokit
       @web_endpoint = File.join(value, "")
     end
 
+    def faraday_config(&block)
+      @faraday_config_block = block
+    end
+
     def reset
       self.adapter        = DEFAULT_ADAPTER
       self.api_version    = DEFAULT_API_VERSION

data/lib/octokit/connection.rb

@@ -28,13 +28,19 @@ module Octokit
         else
           builder.request :url_encoded
         end
+
         builder.use Faraday::Response::RaiseOctokitError
+
         unless raw
           builder.use FaradayMiddleware::Mashify
           builder.use FaradayMiddleware::ParseJson
         end
+
+        faraday_config_block.call(builder) if faraday_config_block
+
         builder.adapter *adapter
       end
+
       connection.basic_auth authentication[:login], authentication[:password] if authenticate and authenticated?
       connection
     end

data/lib/octokit/version.rb

@@ -1,3 +1,3 @@
 module Octokit
-  VERSION = "1.15.1" unless defined?(Octokit::VERSION)
+  VERSION = "1.17.0" unless defined?(Octokit::VERSION)
 end

data/octokit.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday', '~> 0.8'
   gem.add_dependency 'faraday_middleware', '~> 0.8'
   gem.add_dependency 'hashie', '~> 1.2'
+  gem.add_dependency 'json', '~> 1.7'
   gem.add_dependency 'multi_json', '~> 1.3'
-  gem.add_development_dependency 'json'
   gem.add_development_dependency 'maruku'
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'

data/spec/faraday/response_spec.rb

@@ -32,4 +32,24 @@ describe Faraday::Response do
       end
     end
   end
+
+  [
+    {:message => "Problems parsing JSON"},
+    {:error => "Body should be a JSON Hash"}
+  ].each do |body|
+    context "when the response body contains an error message" do
+
+      before do
+        stub_get('https://api.github.com/users/sferik').
+          to_return(:status => 400, :body => body)
+      end
+
+      it "should raise an error with the error message" do
+        lambda do
+          @client.user('sferik')
+        end.should raise_error(Octokit::BadRequest, /#{body.values.first}/)
+      end
+    end
+  end
+
 end

data/spec/fixtures/v3/commit_comment_create.json

@@ -0,0 +1,19 @@
+{
+  "updated_at": "2012-01-12T10:21:32Z",
+  "path": ".rspec",
+  "body": "Hey Eric,\r\n\r\nI think it's a terrible idea: for a number of reasons (dissections, etc.), test suite should stay deterministic IMO.\r\n",
+  "line": 1,
+  "user": {
+    "avatar_url": "https://secure.gravatar.com/avatar/c1607873b99845b2cd53f8634860d4d4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+    "login": "bbenezech",
+    "gravatar_id": "c1607873b99845b2cd53f8634860d4d4",
+    "id": 26794,
+    "url": "https://api.github.com/users/bbenezech"
+  },
+  "created_at": "2012-01-12T10:21:32Z",
+  "commit_id": "629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3",
+  "position": 4,
+  "id": 860296,
+  "html_url": "https://github.com/sferik/rails_admin/commit/629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3#commitcomment-860296",
+  "url": "https://api.github.com/repos/sferik/rails_admin/comments/860296"
+}

data/spec/fixtures/v3/commit_comment_update.json

@@ -0,0 +1,19 @@
+{
+  "updated_at": "2012-01-12T10:21:32Z",
+  "path": ".rspec",
+  "body": "Hey Eric,\r\n\r\nI think it's a terrible idea. The test suite should stay deterministic IMO.\r\n",
+  "line": 1,
+  "user": {
+    "avatar_url": "https://secure.gravatar.com/avatar/c1607873b99845b2cd53f8634860d4d4?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+    "login": "bbenezech",
+    "gravatar_id": "c1607873b99845b2cd53f8634860d4d4",
+    "id": 26794,
+    "url": "https://api.github.com/users/bbenezech"
+  },
+  "created_at": "2012-01-12T10:21:32Z",
+  "commit_id": "629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3",
+  "position": 4,
+  "id": 860296,
+  "html_url": "https://github.com/sferik/rails_admin/commit/629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3#commitcomment-860296",
+  "url": "https://api.github.com/repos/sferik/rails_admin/comments/860296"
+}

data/spec/fixtures/v3/pull_request_comments.json

@@ -0,0 +1,35 @@
+[
+  {
+    "created_at": "2012-01-31T14:23:41Z",
+    "position": 5,
+    "original_commit_id": "2097821c7c5aa4dc02a2cc54d5ca51968b373f95",
+    "path": "lib/octokit/repository.rb",
+    "original_position": 5,
+    "commit_id": "2097821c7c5aa4dc02a2cc54d5ca51968b373f95",
+    "_links": {
+      "self": {
+        "href": "https://api.github.com/repos/pengwynn/octokit/pulls/comments/401530"
+      },
+      "html": {
+        "href": "https://github.com/pengwynn/octokit/pull/67#discussion_r401530"
+      },
+      "pull_request": {
+        "href": "https://api.github.com/repos/pengwynn/octokit/pulls/67"
+      }
+    },
+    "updated_at": "2012-01-31T14:23:41Z",
+    "user": {
+      "avatar_url": "https://secure.gravatar.com/avatar/dfb3948650131e4f0385c3328187cfca?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png",
+      "gravatar_id": "dfb3948650131e4f0385c3328187cfca",
+      "login": "ctshryock",
+      "url": "https://api.github.com/users/ctshryock",
+      "urls": {
+        "self": "https://api.github.com/users/ctshryock"
+      },
+      "id": 61721
+    },
+    "body": "This is causing a test to fail (`respository_spec.rb`, `\"should render url as string\"`). On line 15 of `configuration.rb` you add `github_url` as an option key, which is then added as to the `Client` in the `attr_accessor` block, but it's an instance method not a class method. ",
+    "url": "https://api.github.com/repos/pengwynn/octokit/pulls/comments/401530",
+    "id": 401530
+  }
+]

data/spec/fixtures/v3/pull_request_files.json

@@ -0,0 +1,35 @@
+[
+  {
+    "filename": "README.md",
+    "raw_url": "https://github.com/pengwynn/octokit/raw/55b0fffd7e73fc9e098beee486b31e0fba343e40/README.md",
+    "blob_url": "https://github.com/pengwynn/octokit/blob/55b0fffd7e73fc9e098beee486b31e0fba343e40/README.md",
+    "status": "modified",
+    "additions": 28,
+    "sha": "050957c6c397050ac809b4350971d15103cdea54",
+    "patch": "@@ -64,6 +64,34 @@ client = Octokit::Client.new(:login => \"me\", :oauth_token => \"oauth2token\")\n client.follow(\"sferik\")\n ```\n \n+## Rate Limiting and Conditional Requests\n+GitHub limits API requests to 5000 per hour.\n+\n+```ruby\n+client = Octokit::Client.new(:login => \"me\", :oauth_token => \"oauth2token\")\n+client.ratelimit_remaining  # 5000\n+client.repositories\n+client.ratelimit_remaining  # 4999\n+```\n+\n+You can make conditional requests which will only return data to you if there\n+have been changes since your last request. Pass either the `since` or `etag`\n+option to any API call to perform a conditional request, and immediately after\n+the request is complete the client will have the attributes `last_modified` and\n+`etag` populated to be used for the next identical API call.\n+\n+```ruby\n+client = Octokit::Client(:login => \"me\", :oauth_token => \"oauth2token\")\n+client.ratelimit_remaining                    # 5000\n+client.repositories                           # (Returns an array of repositories)\n+client.ratelimit_remaining                    # 4999\n+repos_last_modified = client.last_modified\n+\n+client.repositories(nil,\n+              :since => repos_last_modified)  # nil\n+client.ratelimit_remaining                    # 4999\n+```\n+\n ## Using with GitHub Enterprise\n \n To use with [GitHub Enterprise](https://enterprise.github.com/), you'll need to",
+    "deletions": 0,
+    "changes": 28
+  },
+  {
+    "filename": "lib/octokit/client.rb",
+    "raw_url": "https://github.com/pengwynn/octokit/raw/55b0fffd7e73fc9e098beee486b31e0fba343e40/lib/octokit/client.rb",
+    "blob_url": "https://github.com/pengwynn/octokit/blob/55b0fffd7e73fc9e098beee486b31e0fba343e40/lib/octokit/client.rb",
+    "status": "modified",
+    "additions": 1,
+    "sha": "feb96c24ec0a8a0bedf8d55289693e1de59cec40",
+    "patch": "@@ -28,6 +28,7 @@\n module Octokit\n   class Client\n     attr_accessor(*Configuration::VALID_OPTIONS_KEYS)\n+    attr_accessor(:last_modified, :etag)\n \n     def initialize(options={})\n       options = Octokit.options.merge(options)",
+    "deletions": 0,
+    "changes": 1
+  },
+  {
+    "filename": "lib/octokit/request.rb",
+    "raw_url": "https://github.com/pengwynn/octokit/raw/55b0fffd7e73fc9e098beee486b31e0fba343e40/lib/octokit/request.rb",
+    "blob_url": "https://github.com/pengwynn/octokit/blob/55b0fffd7e73fc9e098beee486b31e0fba343e40/lib/octokit/request.rb",
+    "status": "modified",
+    "additions": 6,
+    "sha": "5af4a1f92333ea52d35475fdea108564f617a7eb",
+    "patch": "@@ -39,6 +39,9 @@ def ratelimit_remaining\n     def request(method, path, options, version, authenticate, raw, force_urlencoded)\n       path.sub(%r{^/}, '') #leading slash in path fails in github:enterprise\n       response = connection(authenticate, raw, version, force_urlencoded).send(method) do |request|\n+        request.headers['If-Modified-Since'] = options.delete(:since) unless options[:since].nil?\n+        request.headers['If-None-Match'] = options.delete(:etag) unless options[:etag].nil?\n+\n         case method\n         when :delete, :get\n           if auto_traversal && per_page.nil?\n@@ -58,6 +61,9 @@ def request(method, path, options, version, authenticate, raw, force_urlencoded)\n         request.headers['Host'] = Octokit.request_host if Octokit.request_host\n       end\n \n+      self.last_modified = response.headers['Last-Modified']\n+      self.etag = response.headers['ETag'].gsub('\"', '') unless response.headers['ETag'].nil?\n+\n       if raw\n         response\n       elsif auto_traversal && ( next_url = links(response)[\"next\"] )",
+    "deletions": 0,
+    "changes": 6
+  }
+]

data/spec/octokit/client/commits_spec.rb

@@ -78,6 +78,47 @@ describe Octokit::Client::Commits do
 
   end
 
+  describe ".create_commit_comment" do
+
+    it "should create a commit comment" do
+      stub_post("/repos/sferik/rails_admin/commits/629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3/comments").
+        with(:body => { :body => "Hey Eric,\r\n\r\nI think it's a terrible idea: for a number of reasons (dissections, etc.), test suite should stay deterministic IMO.\r\n", :commit_id => "629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3", :line => 1, :path => ".rspec", :position => 4 },
+             :headers => { "Content-Type" => "application/json" }).
+        to_return(:body => fixture("v3/commit_comment_create.json"))
+      commit_comment = @client.create_commit_comment("sferik/rails_admin", "629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3", "Hey Eric,\r\n\r\nI think it's a terrible idea: for a number of reasons (dissections, etc.), test suite should stay deterministic IMO.\r\n", ".rspec", 1, 4)
+      commit_comment.body.should == "Hey Eric,\r\n\r\nI think it's a terrible idea: for a number of reasons (dissections, etc.), test suite should stay deterministic IMO.\r\n"
+      commit_comment.commit_id.should == "629e9fd9d4df25528e84d31afdc8ebeb0f56fbb3"
+      commit_comment.path.should == ".rspec"
+      commit_comment.line.should == 1
+      commit_comment.position.should == 4
+    end
+
+  end
+
+  describe ".update_commit_comment" do
+
+    it "should update a commit comment" do
+      stub_patch("/repos/sferik/rails_admin/comments/860296").
+        with(:body => { :body => "Hey Eric,\r\n\r\nI think it's a terrible idea. The test suite should stay deterministic IMO.\r\n" },
+          :headers => { "Content-Type" => "application/json" }).
+        to_return(:body => fixture("v3/commit_comment_update.json"))
+        commit_comment = @client.update_commit_comment("sferik/rails_admin", "860296", "Hey Eric,\r\n\r\nI think it's a terrible idea. The test suite should stay deterministic IMO.\r\n")
+        commit_comment.body.should == "Hey Eric,\r\n\r\nI think it's a terrible idea. The test suite should stay deterministic IMO.\r\n"
+    end
+
+  end
+
+  describe ".delete_commit_comment" do
+
+    it "should delete a commit comment" do
+      stub_delete("/repos/sferik/rails_admin/comments/860296").
+        to_return(:status => 204, :body => "")
+      commit_comment = @client.delete_commit_comment("sferik/rails_admin", "860296")
+      commit_comment.should be_false
+    end
+
+  end
+
   describe ".compare" do
 
     it "should return a comparison" do

data/spec/octokit/client/gists_spec.rb

@@ -10,7 +10,7 @@ describe Octokit::Client::Gists do
 
   describe ".public_gists" do
     it "should return public gists" do
-      stub_get("/gists").to_return(:body => fixture("v3/public_gists.json"))
+      stub_get("/gists/public").to_return(:body => fixture("v3/public_gists.json"))
       gists = @client.public_gists
       gists.should_not be_empty
     end

data/spec/octokit/client/issues_spec.rb

@@ -20,13 +20,20 @@ describe Octokit::Client::Issues do
 
   describe ".list_issues" do
 
-    it "should return issues" do
+    it "should return issues for a repository" do
       stub_get("/repos/sferik/rails_admin/issues").
         to_return(:body => fixture("v3/issues.json"))
       issues = @client.issues("sferik/rails_admin")
       issues.first.number.should == 388
     end
 
+    it "should return issues for the authenticated user" do
+      stub_get("/issues").
+        to_return(:body => fixture("v3/issues.json"))
+      issues = @client.issues
+      issues.first.number.should == 388
+    end
+
   end
 
   describe ".create_issue" do

data/spec/octokit/client/pulls_spec.rb

@@ -27,7 +27,7 @@ describe Octokit::Client::Pulls do
         with(:pull => {:base => "master", :head => "pengwynn:octokit", :issue => "15"}).
         to_return(:body => fixture("v3/pull_created.json"))
       pull = @client.create_pull_request_for_issue("pengwynn/octokit", "master", "pengwynn:octokit", "15")
-      pull.number.should == 15 
+      pull.number.should == 15
     end
 
   end
@@ -49,7 +49,7 @@ describe Octokit::Client::Pulls do
       stub_get("https://api.github.com/repos/pengwynn/octokit/pulls/67").
         to_return(:body => fixture("v3/pull_request.json"))
       pull = @client.pull("pengwynn/octokit", 67)
-      pull.number.should == 67 
+      pull.number.should == 67
     end
 
   end
@@ -65,6 +65,17 @@ describe Octokit::Client::Pulls do
 
   end
 
+  describe ".pull_request_comments" do
+
+    it "should return the comments for a pull request" do
+      stub_get("https://api.github.com/repos/pengwynn/octokit/pulls/67/comments").
+        to_return(:body => fixture("v3/pull_request_comments.json"))
+      commits = @client.pull_comments("pengwynn/octokit", 67)
+      commits.first["id"].should == 401530
+    end
+
+  end
+
   describe ".merge_pull_request" do
 
     it "should merge the pull request" do
@@ -76,4 +87,28 @@ describe Octokit::Client::Pulls do
 
   end
 
+  describe ".pull_request_files" do
+
+    it "should list files for a pull request" do
+      stub_get("https://api.github.com/repos/pengwynn/octokit/pulls/142/files").
+        to_return(:body => fixture("v3/pull_request_files.json"))
+
+      files = @client.pull_request_files("pengwynn/octokit", 142)
+      file = files.first
+      file.filename.should == 'README.md'
+      file.additions.should == 28
+    end
+
+  end
+
+  describe ".pull_merged?" do
+
+    it "should see if the pull request has been merged" do
+      stub_get("https://api.github.com/repos/pengwynn/octokit/pulls/67/merged").
+        to_return(:status => 204)
+      merged = @client.pull_merged?("pengwynn/octokit", 67)
+      merged.should be_true
+    end
+  end
+
 end

data/spec/octokit/client/repositories_spec.rb

@@ -73,7 +73,7 @@ describe Octokit::Client::Repositories do
     it "should star a repository" do
       stub_put("/user/starred/sferik/rails_admin").
         to_return(:status => 204)
-      @client.star("sferik/rails_admin").should be_nil
+      @client.star("sferik/rails_admin").should be_true
     end
 
   end
@@ -83,7 +83,7 @@ describe Octokit::Client::Repositories do
     it "should unstar a repository" do
       stub_delete("/user/starred/sferik/rails_admin").
         to_return(:status => 204)
-      @client.unstar("sferik/rails_admin").should be_nil
+      @client.unstar("sferik/rails_admin").should be_true
     end
 
   end
@@ -93,7 +93,7 @@ describe Octokit::Client::Repositories do
     it "should watch a repository" do
       stub_put("/user/watched/sferik/rails_admin").
         to_return(:status => 204)
-      @client.watch("sferik/rails_admin").should be_nil
+      @client.watch("sferik/rails_admin").should be_true
     end
 
   end
@@ -103,7 +103,7 @@ describe Octokit::Client::Repositories do
     it "should unwatch a repository" do
       stub_delete("/user/watched/sferik/rails_admin").
         to_return(:status => 204)
-      @client.unwatch("sferik/rails_admin").should be_nil
+      @client.unwatch("sferik/rails_admin").should be_true
     end
 
   end
@@ -146,7 +146,7 @@ describe Octokit::Client::Repositories do
       stub_delete("/repos/sferik/rails_admin").
         to_return(:status => 204, :body => "")
       result = @client.delete_repository("sferik/rails_admin")
-      result.should be_nil
+      result.should be_true
     end
 
   end

data/spec/octokit/client_spec.rb

@@ -10,6 +10,19 @@ describe Octokit::Client do
     }.should_not raise_exception
   end
 
+  it 'should configure faraday from faraday_config_block' do
+    mw_evaluated = false
+    Octokit.configure do |c|
+      c.faraday_config { |f| mw_evaluated = true }
+    end
+    stub_request(:get, "https://api.github.com/rate_limit").
+      to_return(:status => 200, :body => '', :headers =>
+                { 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 5000})
+    client = Octokit::Client.new()
+    client.rate_limit
+    mw_evaluated.should be_true
+  end
+
 
   describe "auto_traversal" do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 1.15.1
+  version: 1.17.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-24 00:00:00.000000000 Z
+date: 2012-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -78,13 +78,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -92,23 +92,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: maruku
   requirement: !ruby/object:Gem::Requirement
@@ -270,6 +270,8 @@ files:
 - spec/fixtures/v3/comments.json
 - spec/fixtures/v3/commit.json
 - spec/fixtures/v3/commit_comment.json
+- spec/fixtures/v3/commit_comment_create.json
+- spec/fixtures/v3/commit_comment_update.json
 - spec/fixtures/v3/commit_comments.json
 - spec/fixtures/v3/commit_create.json
 - spec/fixtures/v3/commits.json
@@ -315,7 +317,9 @@ files:
 - spec/fixtures/v3/public_keys.json
 - spec/fixtures/v3/pull_created.json
 - spec/fixtures/v3/pull_request.json
+- spec/fixtures/v3/pull_request_comments.json
 - spec/fixtures/v3/pull_request_commits.json
+- spec/fixtures/v3/pull_request_files.json
 - spec/fixtures/v3/pull_request_merged.json
 - spec/fixtures/v3/pull_requests.json
 - spec/fixtures/v3/readme.json
@@ -408,6 +412,8 @@ test_files:
 - spec/fixtures/v3/comments.json
 - spec/fixtures/v3/commit.json
 - spec/fixtures/v3/commit_comment.json
+- spec/fixtures/v3/commit_comment_create.json
+- spec/fixtures/v3/commit_comment_update.json
 - spec/fixtures/v3/commit_comments.json
 - spec/fixtures/v3/commit_create.json
 - spec/fixtures/v3/commits.json
@@ -453,7 +459,9 @@ test_files:
 - spec/fixtures/v3/public_keys.json
 - spec/fixtures/v3/pull_created.json
 - spec/fixtures/v3/pull_request.json
+- spec/fixtures/v3/pull_request_comments.json
 - spec/fixtures/v3/pull_request_commits.json
+- spec/fixtures/v3/pull_request_files.json
 - spec/fixtures/v3/pull_request_merged.json
 - spec/fixtures/v3/pull_requests.json
 - spec/fixtures/v3/readme.json