octokit 1.19.0 → 1.20.0

data/.travis.yml

@@ -7,3 +7,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - ruby-head
+before_script:
+  - chmod 600 spec/fixtures/.netrc

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+# 1.20.0
+
+* [@joeyw](https://github.com/joeyw) added `.all_users` and `.all_repositories`
+* [@joeyw](https://github.com/joeyw) added `.issues_comments` and `.pull_request_comments`
+* [@x3ro](https://github.com/x3ro) added some date parsing to Commits API
+* .netrc support
+
+View [the full changelog][1.20.0].
+[1.20.0]: https://github.com/pengwynn/octokit/compare/v1.19.0...v1.20.0
+
+
 # 1.19.0
 
 This version has some substantial rewiring internally to support non-JSON

data/README.md

@@ -61,13 +61,30 @@ client = Octokit::Client.new(:login => "me", :password => "sekret")
 client.follow("sferik")
 ```
 
-Alternately, you can authenticate with a [GitHub OAuth2 token][oauth]. 
+Alternately, you can authenticate with a [GitHub OAuth2 token][oauth].
 
 ```ruby
 client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
 client.follow("sferik")
 ```
 
+### Using `.netrc` for stored credentials
+
+Octokit now supports [`.netrc`][netrc] files for storing your GitHub Basic Auth
+credentials. Given a `~/.netrc` like the following
+
+```
+machine api.github.com login pengwynn password 0ct0c4tz4ev3r!
+```
+
+You can make authenticated calls by telling Octokit to use credentials from
+this file:
+
+```ruby
+Octokit.netrc => true # or /path/to/file
+Octokit.user # authenticates as 'pengwynn' user
+```
+
 ## Requesting a specific media type
 
 You can pass an `:accept` option value to request a particular [media
@@ -130,6 +147,22 @@ 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.
 
+## Versioning
+
+This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint][pvc] with two digits of precision. For example:
+
+    spec.add_dependency 'octokit', '~> 1.0'
+
+[semver]: http://semver.org/
+[pvc]: http://docs.rubygems.org/read/chapter/16#page74
+
 ### JSON dependency
 
 Since JSON is included in 1.9 now, we no longer include it as a hard
@@ -162,3 +195,4 @@ Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober. See
 [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

data/lib/faraday/response/raise_octokit_error.rb

@@ -4,29 +4,22 @@ require 'multi_json'
 # @api private
 module Faraday
   class Response::RaiseOctokitError < Response::Middleware
+    ERROR_MAP = {
+      400 => Octokit::BadRequest,
+      401 => Octokit::Unauthorized,
+      403 => Octokit::Forbidden,
+      404 => Octokit::NotFound,
+      406 => Octokit::NotAcceptable,
+      422 => Octokit::UnprocessableEntity,
+      500 => Octokit::InternalServerError,
+      501 => Octokit::NotImplemented,
+      502 => Octokit::BadGateway,
+      503 => Octokit::ServiceUnavailable
+    }
+
     def on_complete(response)
-      case response[:status].to_i
-      when 400
-        raise Octokit::BadRequest, error_message(response)
-      when 401
-        raise Octokit::Unauthorized, error_message(response)
-      when 403
-        raise Octokit::Forbidden, error_message(response)
-      when 404
-        raise Octokit::NotFound, error_message(response)
-      when 406
-        raise Octokit::NotAcceptable, error_message(response)
-      when 422
-        raise Octokit::UnprocessableEntity, error_message(response)
-      when 500
-        raise Octokit::InternalServerError, error_message(response)
-      when 501
-        raise Octokit::NotImplemented, error_message(response)
-      when 502
-        raise Octokit::BadGateway, error_message(response)
-      when 503
-        raise Octokit::ServiceUnavailable, error_message(response)
-      end
+      key = response[:status].to_i
+      raise ERROR_MAP[key], error_message(response) if ERROR_MAP.has_key? key
     end
 
     def error_message(response)

data/lib/octokit.rb

@@ -1,6 +1,7 @@
+require 'netrc'
 require 'octokit/configuration'
-require 'octokit/client'
 require 'octokit/error'
+require 'octokit/client'
 
 module Octokit
   extend Configuration

data/lib/octokit/authentication.rb

@@ -26,5 +26,20 @@ module Octokit
         :client_secret => client_secret
       }
     end
+
+    def login_and_password_from_netrc(rc = false)
+      return unless rc
+
+      info = case rc
+              when TrueClass
+                Netrc.read
+              when String
+                Netrc.read rc
+              end
+      netrc_host = URI.parse(api_endpoint).host
+      creds = info[netrc_host]
+      self.login = creds.shift
+      self.password = creds.shift
+    end
   end
 end

data/lib/octokit/client.rb

@@ -27,6 +27,7 @@ require 'octokit/client/emojis'
 require 'octokit/client/statuses'
 require 'octokit/client/say'
 require 'octokit/client/rate_limit'
+require 'octokit/client/gitignore'
 
 module Octokit
   class Client
@@ -37,6 +38,8 @@ module Octokit
       Configuration::VALID_OPTIONS_KEYS.each do |key|
         send("#{key}=", options[key])
       end
+
+      login_and_password_from_netrc(options[:netrc])
     end
 
     include Octokit::Authentication
@@ -66,5 +69,6 @@ module Octokit
     include Octokit::Client::Statuses
     include Octokit::Client::Say
     include Octokit::Client::RateLimit
+    include Octokit::Client::Gitignore
   end
 end

data/lib/octokit/client/authorizations.rb

@@ -93,7 +93,7 @@ module Octokit
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.delete_authorization(999999)
       def delete_authorization(number, option={})
-        request(:delete, "authorizations/#{number}").status == 204
+        boolean_from_response(:delete, "authorizations/#{number}")
       end
 
       # Check scopes for a token

data/lib/octokit/client/commits.rb

@@ -136,7 +136,7 @@ module Octokit
       # @return [nil] nil
       # @see http://developer.github.com/v3/repos/comments/
       def delete_commit_comment(repo, id, options={})
-        request(:delete, "repos/#{Repository.new(repo)}/comments/#{id}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/comments/#{id}", options)
       end
 
       # Compare two commits
@@ -178,13 +178,7 @@ module Octokit
       # @example
       #   Octokit.commits_since('pengwynn/octokit', '2012-10-01')
       def commits_since(repo, date, sha_or_branch="master", options={})
-        begin
-          date = DateTime.parse(date)
-        rescue ArgumentError
-          raise ArgumentError, "#{date} is not a valid date"
-        end
-
-        params = {:since => iso8601(date) }
+        params = {:since => iso8601(parse_date(date))}
         commits(repo, sha_or_branch, params.merge(options))
       end
 
@@ -198,12 +192,7 @@ module Octokit
       # @example
       #   Octokit.commits_before('pengwynn/octokit', '2012-10-01')
       def commits_before(repo, date, sha_or_branch="master", options={})
-        begin
-          date = DateTime.parse(date)
-        rescue ArgumentError
-          raise ArgumentError, "#{date} is not a valid date"
-        end
-        params = {:until => iso8601(date)}
+        params = {:until => iso8601(parse_date(date))}
         commits(repo, sha_or_branch, params.merge(options))
       end
 
@@ -272,6 +261,18 @@ module Octokit
         end
       end
 
+      # Parses the given string representation of a date, throwing a meaningful exception
+      # (containing the date that failed to parse) in case of failure.
+      #
+      # @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
+      end
     end
   end
 end

data/lib/octokit/client/contents.rb

@@ -2,49 +2,49 @@ module Octokit
   class Client
     module Contents
 
-  # Receive the default Readme for a repository
-  #
-  # @param repo [String, Repository, Hash] A GitHub repository
-  # @param ref [String] The String name of the Commit/Branch/Tag. Defaults to “master”.
-  # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
-  # @return [Hash] The detail of the readme
-  # @see http://developer.github.com/v3/repos/contents/
-  # @example Get the readme file for a repo
-  #   Octokit.readme("pengwynn/octokit")
-  def readme(repo, options={})
-    get("repos/#{Repository.new repo}/readme", options)
-  end
+      # Receive the default Readme for a repository
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
+      # @return [Hash] The detail of the readme
+      # @see http://developer.github.com/v3/repos/contents/
+      # @example Get the readme file for a repo
+      #   Octokit.readme("pengwynn/octokit")
+      def readme(repo, options={})
+        get("repos/#{Repository.new repo}/readme", options)
+      end
 
-  # Receive a listing of a repository folder or the contents of a file
-  #
-  # @param repo [String, Repository, Hash] A GitHub repository
-  # @option options [String] :path A folder or file path
-  # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
-  # @return [Hash] The contents of a file or list of the files in the folder
-  # @see http://developer.github.com/v3/repos/contents/
-  # @example List the contents of lib/octokit.rb
-  #   Octokit.contents("pengwynn/octokit", :path => 'lib/octokit.rb')
-  def contents(repo, options={})
-    repo_path = options.delete :path
-    url = "repos/#{Repository.new repo}/contents/#{repo_path}"
-    get(url, options)
-  end
+      # Receive a listing of a repository folder or the contents of a file
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @option options [String] :path A folder or file path
+      # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
+      # @return [Hash] The contents of a file or list of the files in the folder
+      # @see http://developer.github.com/v3/repos/contents/
+      # @example List the contents of lib/octokit.rb
+      #   Octokit.contents("pengwynn/octokit", :path => 'lib/octokit.rb')
+      def contents(repo, options={})
+        repo_path = options.delete :path
+        url = "repos/#{Repository.new repo}/contents/#{repo_path}"
+        get(url, options)
+      end
 
-  # This method will provide a URL to download a tarball or zipball archive for a repository.
-  #
-  # @param repo [String, Repository, Hash] A GitHub repository.
-  # @option options format [String] Either tarball (default) or zipball.
-  # @option options [String] :ref Optional valid Git reference, defaults to master.
-  # @return [String] Location of the download
-  # @see http://developer.github.com/v3/repos/contents/
-  # @example Get archive link for pengwynn/octokit
-  #   Octokit.archive_link("pengwynn/octokit")
-  def archive_link(repo, options={})
-    repo_ref = options.delete :ref
-    format = (options.delete :format) || 'tarball'
-    url = "repos/#{Repository.new repo}/#{format}/#{repo_ref}"
-    request(:head, url, options).env[:url].to_s
-  end
+      # This method will provide a URL to download a tarball or zipball archive for a repository.
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository.
+      # @option options format [String] Either tarball (default) or zipball.
+      # @option options [String] :ref Optional valid Git reference, defaults to master.
+      # @return [String] Location of the download
+      # @see http://developer.github.com/v3/repos/contents/
+      # @example Get archive link for pengwynn/octokit
+      #   Octokit.archive_link("pengwynn/octokit")
+      def archive_link(repo, options={})
+        repo_ref = options.delete :ref
+        format = (options.delete :format) || 'tarball'
+        url = "repos/#{Repository.new repo}/#{format}/#{repo_ref}"
+        request(:head, url, options).env[:url].to_s
+      end
+
+    end
   end
 end
-end

data/lib/octokit/client/downloads.rb

@@ -6,6 +6,7 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A Github Repository
       # @return [Array] A list of available downloads
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
       # @see http://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository
       # @example List all downloads for Github/Hubot
       #   Octokit.downloads("github/hubot")
@@ -19,6 +20,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param id [Integer] ID of the download
       # @return [Download] A single download from the repository
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
       # @see http://developer.github.com/v3/repos/downloads/#get-a-single-download
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.download("github/hubot")
@@ -33,6 +35,7 @@ module Octokit
       # @option options [String] :description The download description
       # @option options [String] :content_type The content type. Defaults to 'text/plain'
       # @return [Download] A single download from the repository
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
       # @see http://developer.github.com/v3/repos/downloads/#create-a-new-download-part-1-create-the-resource
       # @example Create the "Robawt" download on Github/Hubot
       #   Octokit.create_download("github/hubot", 'Robawt')
@@ -67,12 +70,13 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param id [Integer] ID of the download
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
       # @see http://developer.github.com/v3/repos/downloads/#delete-a-single-download
       # @return [Boolean] Status
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.delete_download("github/hubot", 1234)
       def delete_download(repo, id)
-        request(:delete, "repos/#{Repository.new(repo)}/downloads/#{id}").status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/downloads/#{id}")
       end
 
       private

data/lib/octokit/client/gists.rb

@@ -86,7 +86,7 @@ module Octokit
       # @return [Boolean] Indicates if gist is starred successfully
       # @see http://developer.github.com/v3/gists/#star-a-gist
       def star_gist(gist, options={})
-        request(:put, "gists/#{Gist.new gist}/star", options).status == 204
+        boolean_from_response(:put, "gists/#{Gist.new gist}/star", options)
       end
 
       # Unstar a gist
@@ -95,7 +95,7 @@ module Octokit
       # @return [Boolean] Indicates if gist is unstarred successfully
       # @see http://developer.github.com/v3/gists/#unstar-a-gist
       def unstar_gist(gist, options={})
-        request(:delete, "gists/#{Gist.new gist}/star", options).status == 204
+        boolean_from_response(:delete, "gists/#{Gist.new gist}/star", options)
       end
 
       # Check if a gist is starred
@@ -104,12 +104,7 @@ module Octokit
       # @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)
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:get, "gists/#{Gist.new gist}/star", options)
       end
 
       # Fork a gist
@@ -118,7 +113,7 @@ module Octokit
       # @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
+        post "gists/#{Gist.new gist}/forks", options
       end
 
       # Delete a gist
@@ -127,8 +122,7 @@ module Octokit
       # @return [Boolean] Indicating success of deletion
       # @see http://developer.github.com/v3/gists/#delete-a-gist
       def delete_gist(gist, options={})
-        response = request(:delete, "gists/#{Gist.new gist}", options)
-        response.status == 204
+        boolean_from_response(:delete, "gists/#{Gist.new gist}", options)
       end
 
       # List gist comments
@@ -199,7 +193,7 @@ module Octokit
       # @example
       #   @client.delete_gist_comment('208sdaz3', '586399')
       def delete_gist_comment(gist_id, gist_comment_id, options={})
-        request(:delete, "gists/#{gist_id}/comments/#{gist_comment_id}", options).status == 204
+        boolean_from_response(:delete, "gists/#{gist_id}/comments/#{gist_comment_id}", options)
       end
 
     end

data/lib/octokit/client/gitignore.rb

@@ -0,0 +1,41 @@
+module Octokit
+  class Client
+    module Gitignore
+
+      # Listing available gitignore templates.
+      #
+      # These templates can be passed option when creating a repository.
+      #
+      # @see http://developer.github.com/v3/gitignore/#listing-available-templates
+      # @see http://developer.github.com/v3/repos/#create
+      #
+      # @return [Array<String>] List of templates.
+      #
+      # @example Git all the gitignore templates
+      #   @client.gitignore_templates
+      def gitignore_templates(options={})
+        get "/gitignore/templates", options
+      end
+
+      # Get a gitignore template.
+      #
+      # Use the raw {http://developer.github.com/v3/media/ media type} to get
+      # the raw contents.
+      #
+      # @param template_name [String] Name of the template. Template names are
+      #   case sensitive, make sure to use a valid name from the 
+      #   .gitignore_templates list.
+      #
+      # @see http://developer.github.com/v3/gitignore/#get-a-single-template
+      #
+      # @return [Hash] Gitignore template
+      #
+      # @example Get the Ruby gitignore template
+      #   @client.gitignore_template('Ruby')
+      def gitignore_template(template_name, options={})
+        get "/gitignore/templates/#{template_name}", options
+      end
+
+    end
+  end
+end