octokit 1.23.0 → 1.24.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+# 1.24.0
+
+* Missing issues methods, thanks [@andrew](https://github.com/andrew)
+* Don't bypass SSL verification
+
+View [the full changelog][1.24.0].
+[1.24.0]: https://github.com/pengwynn/octokit/compare/v1.23.0...v1.24.0
+
 # 1.23.0
 
 * [Meta API][]

data/CONTRIBUTING.md

@@ -13,6 +13,6 @@
 10. Add, commit, and push your changes.
 11. [Submit a pull request.][pr]
 
-[fork]: http://help.github.com/fork-a-repo/
+[fork]: https://help.github.com/articles/fork-a-repo
 [branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/
+[pr]: https://help.github.com/articles/using-pull-requests

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
+Copyright (c) 2011-2013 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,9 +1,18 @@
-# Octokit [![Build Status](https://secure.travis-ci.org/pengwynn/octokit.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/pengwynn/octokit.png?travis)][gemnasium] [![Code Climate](https://codeclimate.com/badge.png)][codeclimate]
-Simple Ruby wrapper for the GitHub v3 API.
+# Octokit
+
+[![Gem Version](https://badge.fury.io/rb/octokit.png)][gem]
+[![Build Status](https://secure.travis-ci.org/pengwynn/octokit.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/pengwynn/octokit.png?travis)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/pengwynn/octokit.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/pengwynn/octokit/badge.png?branch=master)][coveralls]
 
+[gem]: https://rubygems.org/gems/octokit
 [travis]: http://travis-ci.org/pengwynn/octokit
 [gemnasium]: https://gemnasium.com/pengwynn/octokit
 [codeclimate]: https://codeclimate.com/github/pengwynn/octokit
+[coveralls]: https://coveralls.io/r/pengwynn/octokit
+
+Simple Ruby wrapper for the GitHub v3 API.
 
 ## Installation
     gem install octokit
@@ -63,6 +72,8 @@ client.follow("sferik")
 
 Alternately, you can authenticate with a [GitHub OAuth2 token][oauth].
 
+[oauth]: http://developer.github.com/v3/oauth
+
 ```ruby
 client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
 client.follow("sferik")
@@ -73,6 +84,8 @@ client.follow("sferik")
 Octokit now supports [`.netrc`][netrc] files for storing your GitHub Basic Auth
 credentials. Given a `~/.netrc` like the following
 
+[netrc]: http://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-File.html
+
 ```
 machine api.github.com login pengwynn password 0ct0c4tz4ev3r!
 ```
@@ -90,6 +103,8 @@ Octokit.user # authenticates as 'pengwynn' user
 You can pass an `:accept` option value to request a particular [media
 type][media-types].
 
+[media-types]: http://developer.github.com/v3/media/
+
 ```ruby
 Octokit.contents 'pengwynn/octokit', :path => 'README.md', :accept => 'application/vnd.github.html'
 ```
@@ -111,11 +126,14 @@ end
 ## Supported Ruby Versions
 
 This library aims to support and is [tested against][travis] the following Ruby
-versions:
+implementations:
 
 * Ruby 1.8.7
 * Ruby 1.9.2
 * Ruby 1.9.3
+* Ruby 2.0.0
+
+If something doesn't work on one of these Ruby versions, it's 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
@@ -124,9 +142,9 @@ 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.
+implementation, you will be 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.
 
 ## Versioning
 
@@ -170,10 +188,7 @@ less-ActiveResourcey alternative.
 [octopi]: https://github.com/fcoury/octopi
 
 ## Copyright
-Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober. See
-[LICENSE][] for details.
+Copyright (c) 2011-2013 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober.
+See [LICENSE][] for details.
 
-[license]: https://github.com/pengwynn/octokit/blob/master/LICENSE.md
-[media-types]: http://developer.github.com/v3/media/
-[oauth]: http://developer.github.com/v3/oauth
-[netrc]: http://www.gnu.org/software/inetutils/manual/html_node/The-_002enetrc-File.html
+[license]: LICENSE.md

data/lib/octokit/client/commits.rb

@@ -206,14 +206,8 @@ module Octokit
       # @example
       #   Octokit.commits_on('pengwynn/octokit', '2012-10-01')
       def commits_on(repo, date, sha_or_branch="master", options={})
-        begin
-          # defaults to 00:00:00
-          start_date = DateTime.parse(date)
-          # addition defaults to n days
-          end_date = start_date + 1
-        rescue ArgumentError
-          raise ArgumentError, "#{date} is not a valid date"
-        end
+        start_date = parse_date(date)
+        end_date = start_date + 1
         params = { :since => iso8601(start_date), :until => iso8601(end_date) }
         commits(repo, sha_or_branch, params.merge(options))
       end
@@ -229,20 +223,8 @@ module Octokit
       # @example
       #   Octokit.commits_on('pengwynn/octokit', '2012-10-01', '2012-11-01')
       def commits_between(repo, start_date, end_date, sha_or_branch="master", options={})
-        begin
-          # defaults to 00:00:00
-          # use a second var for the parsed date so error message is consistent
-          _start_date = DateTime.parse(start_date)
-        rescue ArgumentError
-          raise ArgumentError, "#{start_date} is not a valid date"
-        end
-        begin
-          # defaults to 00:00:00
-          # use a second var for the parsed date so error message is consistent
-          _end_date = DateTime.parse(end_date)
-        rescue ArgumentError
-          raise ArgumentError, "#{end_date} is not a valid date"
-        end
+        _start_date = parse_date(start_date)
+        _end_date = parse_date(end_date)
         if _end_date < _start_date
           raise ArgumentError, "Start date #{start_date} does not precede #{end_date}"
         end
@@ -267,12 +249,11 @@ module Octokit
       # @param date [String] String representation of a date
       # @return [DateTime]
       def parse_date(date)
-        begin
-          date = DateTime.parse(date)
-        rescue ArgumentError
-          raise ArgumentError, "#{date} is not a valid date"
-        end
+        date = DateTime.parse(date)
+      rescue ArgumentError
+        raise ArgumentError, "#{date} is not a valid date"
       end
+
     end
   end
 end

data/lib/octokit/client/gists.rb

@@ -65,7 +65,7 @@ module Octokit
       # @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
+      # @option options [Hash] :files Files that make up this gist. Keys
       #   should be the filename, the value a Hash with a :content key with text
       #   content of the Gist. 
       #
@@ -75,6 +75,10 @@ module Octokit
       # @return
       #   [Hashie::Mash] Newly created gist info
       # @see http://developer.github.com/v3/gists/#edit-a-gist
+      # @example Update a gist
+      #   @client.edit_gist('some_id', {
+      #     :files => {"boo.md" => {"content" => "updated stuff"}}
+      #   })
       def edit_gist(gist, options={})
         patch "gists/#{Gist.new gist}", options
       end

data/lib/octokit/client/issues.rb

@@ -8,7 +8,6 @@ module Octokit
       # @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
-      # @see http://develop.github.com/p/issues.html
       # @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={})
@@ -43,15 +42,60 @@ module Octokit
       end
       alias :issues :list_issues
 
+      # List all issues across owned and member repositories for the authenticated user
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>all</tt>.
+      # @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>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @option options [Integer] :page (1) Page number.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      # @return [Array] A list of issues for a repository.
+      # @see http://developer.github.com/v3/issues/#list-issues
+      # @example List issues for the authenticted user across owned and member repositories
+      #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
+      #   @client.user_issues
+      def user_issues(options={})
+        get('/user/issues', options)
+      end
+      
+      # List all issues for a given organization for the authenticated user
+      #
+      # @param org [String] Organization GitHub username.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>all</tt>.
+      # @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>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @option options [Integer] :page (1) Page number.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      # @return [Array] A list of issues for a repository.
+      # @see http://developer.github.com/v3/issues/#list-issues
+      # @example List issues for the authenticted user across owned and member repositories
+      #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
+      #   @client.user_issues
+      def org_issues(org, options={})
+        get("/orgs/#{org}/issues", options)
+      end
+
       # Create an issue for a repository
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param title [String] A descriptive title
       # @param body [String] A concise description
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Issue] Your newly created issue
-      # @see http://develop.github.com/p/issues.html
+      # @see http://developer.github.com/v3/issues/#create-an-issue
       # @example Create a new Issues for a repository
-      #   Octokit.create_issue("sferik/rails_admin")
+      #   Octokit.create_issue("sferik/rails_admin", 'Updated Docs', 'Added some extra links')
       def create_issue(repo, title, body, options={})
         post("repos/#{Repository.new(repo)}/issues", options.merge({:title => title, :body => body}))
       end
@@ -73,28 +117,32 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Issue] The updated Issue
-      # @see http://develop.github.com/p/issues.html
-      # @note This implementation needs to be adjusted with switch to API v3
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @example Close Issue #25 from pengwynn/octokit
       #   Octokit.close_issue("pengwynn/octokit", "25")
       def close_issue(repo, number, options={})
-        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"}))
+        patch("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"}))
       end
 
       # Reopen an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Issue] The updated Issue
-      # @see http://develop.github.com/p/issues.html
-      # @note This implementation needs to be adjusted with switch to API v3
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @example Reopen Issue #25 from pengwynn/octokit
       #   Octokit.reopen_issue("pengwynn/octokit", "25")
       def reopen_issue(repo, number, options={})
-        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"}))
+        patch("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"}))
       end
 
       # Update an issue
@@ -103,14 +151,16 @@ module Octokit
       # @param number [String] Number ID of the issue
       # @param title [String] Updated title for the issue
       # @param body [String] Updated body of the issue
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @return [Issue] The updated Issue
-      # @see http://develop.github.com/p/issues.html
-      # @note This implementation needs to be adjusted with switch to API v3
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @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("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}))
+        patch("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}))
       end
 
       # Get all comments attached to issues for the repository
@@ -157,11 +207,11 @@ module Octokit
       # Get a single comment attached to an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the issue
+      # @param number [String] Number ID of the comment
       # @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")
+      # @example Get comment #1194549 from an issue on pengwynn/octokit
+      #   Octokit.issue_comments("pengwynn/octokit", 1194549)
       def issue_comment(repo, number, options={})
         get("repos/#{Repository.new(repo)}/issues/comments/#{number}", options)
       end
@@ -186,10 +236,10 @@ module Octokit
       # @param comment [String] Body of the comment which will replace the existing body.
       # @return [Comment] A JSON encoded Comment
       # @see http://developer.github.com/v3/issues/comments/#edit-a-comment
-      # @example Update the comment "I've started this on my 25-issue-comments-v3 fork" on Issue #25 on pengwynn/octokit
-      #   Octokit.update_comment("pengwynn/octokit", 25, "Almost to v1, added this on my fork")
+      # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on pengwynn/octokit
+      #   Octokit.update_comment("pengwynn/octokit", 1194549, "Almost to v1, added this on my fork")
       def update_comment(repo, number, comment, options={})
-        post("repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment}))
+        patch("repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment}))
       end
 
       # Delete a single comment
@@ -198,20 +248,19 @@ module Octokit
       # @param number [Integer] Comment number
       # @return [Boolean] Success
       # @see http://developer.github.com/v3/issues/comments/#delete-a-comment
-      # @example Delete the comment "I've started this on my 25-issue-comments-v3 fork" on Issue #25 on pengwynn/octokit
+      # @example Delete the comment #1194549 on an issue on pengwynn/octokit
       #   Octokit.delete_comment("pengwynn/octokit", 1194549)
       def delete_comment(repo, number, options={})
         boolean_from_response(:delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options)
       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/
+      # @see http://developer.github.com/v3/issues/events/#list-events-for-an-issue
       # @example List all issues events for issue #38 on pengwynn/octokit
       #   Octokit.issue_events("pengwynn/octokit", 38)
       def issue_events(repo, number, options={})

data/lib/octokit/client/labels.rb

@@ -52,7 +52,7 @@ module Octokit
       # @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/#{CGI.escape(label)}", options)
+        patch("repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options)
       end
 
       # Delete a label from a repository.

data/lib/octokit/client/milestones.rb

@@ -65,7 +65,7 @@ module Octokit
       # @example Update a milestone for a repository
       #   Octokit.update_milestone("pengwynn/octokit", 1, {:description => 'Add support for v3 of Github API'})
       def update_milestone(repository, number, options={})
-        post("repos/#{Repository.new(repository)}/milestones/#{number}", options)
+        patch("repos/#{Repository.new(repository)}/milestones/#{number}", options)
       end
       alias :edit_milestone :update_milestone
 

data/lib/octokit/client/notifications.rb

@@ -81,11 +81,9 @@ module Octokit
       # @example
       #   @client.mark_notifications_as_read
       def mark_notifications_as_read(options={})
-        begin
-          request(:put, "notifications", options).status == 205
-        rescue
-          false
-        end
+        request(:put, "notifications", options).status == 205
+      rescue Octokit::Error
+        false
       end
 
       # Mark notifications from a specific repository as read
@@ -110,11 +108,9 @@ module Octokit
       # @example
       #   @client.mark_notifications_as_read("pengwynn/octokit")
       def mark_repository_notifications_as_read(repo, options={})
-        begin
-          request(:put, "repos/#{Repository.new repo}/notifications", options).status == 205
-        rescue
-          false
-        end
+        request(:put, "repos/#{Repository.new repo}/notifications", options).status == 205
+      rescue Octokit::Error
+        false
       end
       alias :mark_repo_notifications_as_read :mark_repository_notifications_as_read
 
@@ -149,11 +145,9 @@ module Octokit
       # @example
       #   @client.mark_thread_as_ready(1, :read => false)
       def mark_thread_as_read(thread_id, options={})
-        begin
-          request(:patch, "notifications/threads/#{thread_id}", options).status == 205
-        rescue
-          false
-        end
+        request(:patch, "notifications/threads/#{thread_id}", options).status == 205
+      rescue Octokit::Error
+        false
       end
 
       # Get thread subscription

data/lib/octokit/client/pulls.rb

@@ -90,7 +90,7 @@ module Octokit
           :state => state
         })
         options.reject! { |_, value| value.nil? }
-        post("repos/#{Repository.new repo}/pulls/#{id}", options)
+        patch("repos/#{Repository.new repo}/pulls/#{id}", options)
       end