octokit 1.18.0 → 1.19.0

data/.document

@@ -2,4 +2,4 @@ lib/**/*.rb
 bin/*
 features/**/*.feature
 -
-LICENSE
+LICENSE.md

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--fail-fast
 --order random

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+# 1.19.0
+
+This version has some substantial rewiring internally to support non-JSON
+[media types][media-types]:
+
+```ruby
+Octokit.contents 'pengwynn/octokit', :path => 'README.md', :accept => 'application/vnd.github.html'
+```
+
+Additionally, all methods that return empty body responses for `GET`, `DELETE`,
+and `PUT`, return a Boolean instead of raw HTTP Response or status code.
+
+This version also introduces a couple of new methods:
+
+* `scopes`: Check the scopes on an OAuth token
+* `octocat`: Your daily dose of GitHub API Zen.
+
+View [the full changelog][1.19.0].
+[1.19.0]: https://github.com/pengwynn/octokit/compare/v1.18.0...v1.19.0
+
+## Previous versions
+
 * [1.18.0 - October 15, 2012](https://github.com/pengwynn/octokit/compare/v1.17.1...v1.18.0)
 * [1.17.1 - October 11, 2012](https://github.com/pengwynn/octokit/compare/v1.17.0...v1.17.1)
 * [1.17.0 - October 8, 2012](https://github.com/pengwynn/octokit/compare/v1.16.0...v1.17.0)
@@ -53,3 +75,6 @@
 * [0.1.1 - December 15, 2009](https://github.com/pengwynn/octokit/compare/v0.1.0...v0.1.1)
 * [0.1.0 - December 12, 2009](https://github.com/pengwynn/octokit/compare/v0.0.1...v0.1.0)
 * [0.0.1 - December 12, 2009](https://github.com/pengwynn/octokit/compare/cb7d5480944229e1a5ddfa9d1113903628765584...v0.0.1)
+
+
+[media-types]: http://developer.github.com/v3/media/

data/README.md

@@ -31,21 +31,27 @@ For convenience, methods that require a repository argument may be passed in
 any of the following forms:
 
 ```ruby
-# String
 Octokit.repo("pengwynn/octokit")
 
-# Hash
 Octokit.repo({:username => "pengwynn", :name => "octokit"})
 
-# or
 Octokit.repo({:username => "pengwynn", :repo => "octokit"})
 
-# Instance of Repository
 Octokit.repo(Repository.new('pengwynn/octokit'))
 
 => <#Hashie::Rash created_at="2009/12/10 13:41:49 -0800" description="Simple Ruby wrapper for the GitHub 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>
 ```
 
+### List the commits for a repository
+
+```ruby
+Octokit.commits("pengwynn/octokit")
+
+Octokit.list_commits("pengwynn/octokit")
+
+=> [#<Hashie::Mash author=#<Hashie::Mash avatar_url="https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png" gravatar_id="7e19cd5486b5d6dc1ef90e671ba52ae0" id=865 login="pengwynn" url="https://api.github.com/users/pengwynn"> commit=#<Hashie::Mash author=#<Hashie::Mash date="2012-10-31T15:17:51Z" email="wynn@github.com" name="Wynn Netherland"> comment_count=0 committer=#<Hashie::Mash date="2012-10-31T15:17:51Z" email="wynn@github.com" name="Wynn Netherland"> message="Fix bug with archive_link for private repo" tree=#<Hashie::Mash sha="49bf2a476aa819f29b0fc1a8805f7567f010006d" url="https://api.github.com/repos/pengwynn/octokit/git/trees/49bf2a476aa819f29b0fc1a8805f7567f010006d"> url="https://api.github.com/repos/pengwynn/octokit/git/commits/8db3df37fad3a021eb8036b007c718149836cb32"> committer=#<Hashie::Mash avatar_url="https://secure.gravatar.com/avatar/7e19cd5486b5d6dc1ef90e671ba52ae0?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png" gravatar_id="7e19cd5486b5d6dc1ef90e671ba52ae0" id=865 login="pengwynn" url="https://api.github.com/users/pengwynn"> parents=[#<Hashie::Mash sha="7a67f4b47791cb77de33e491df87cef06012c79f" url="https://api.github.com/repos/pengwynn/octokit/commits/7a67f4b47791cb77de33e491df87cef06012c79f">] sha="8db3df37fad3a021eb8036b007c718149836cb32" url="https://api.github.com/repos/pengwynn/octokit/commits/8db3df37fad3a021eb8036b007c718149836cb32">, ... , ...]
+```
+
 ## Authenticated Requests
 For methods that require authentication, you'll need to setup a client with
 your login and password.
@@ -55,15 +61,22 @@ 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][account].
+Alternately, you can authenticate with a [GitHub OAuth2 token][oauth]. 
 
-[account]: https://github.com/account
 ```ruby
 client = Octokit::Client.new(:login => "me", :oauth_token => "oauth2token")
 client.follow("sferik")
 ```
 
+## Requesting a specific media type
+
+You can pass an `:accept` option value to request a particular [media
+type][media-types].
+
+```ruby
+Octokit.contents 'pengwynn/octokit', :path => 'README.md', :accept => 'application/vnd.github.html'
+```
+
 ## Using with GitHub Enterprise
 
 To use with [GitHub Enterprise](https://enterprise.github.com/), you'll need to
@@ -133,6 +146,8 @@ contributors:
 
 * [Erik Michaels-Ober](http://github.com/sferik)
 * [Clint Shryock](http://github.com/ctshryock)
+* [Joey Wendt](http://github.com/joeyw)
+
 
 ## Inspiration
 Octokit was inspired by [Octopi][] and aims to be a lightweight,
@@ -144,4 +159,6 @@ less-ActiveResourcey alternative.
 Copyright (c) 2011 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober. See
 [LICENSE][] for details.
 
-[license]: https://github.com/pengwynn/octokit/blob/master/LICENSE
+[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

data/lib/faraday/response/raise_octokit_error.rb

@@ -38,7 +38,10 @@ module Faraday
       else
         ''
       end
-      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
+      errors = unless message.empty?
+        body[:errors] ?  ": #{body[:errors].map{|e|e[:message]}.join(', ')}" : ''
+      end
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}#{errors}"
     end
   end
 end

data/lib/octokit/client.rb

@@ -18,12 +18,15 @@ require 'octokit/client/pulls'
 require 'octokit/client/repositories'
 require 'octokit/client/users'
 require 'octokit/client/events'
+require 'octokit/client/notifications'
 require 'octokit/client/authorizations'
 require 'octokit/client/refs'
 require 'octokit/client/contents'
 require 'octokit/client/markdown'
 require 'octokit/client/emojis'
 require 'octokit/client/statuses'
+require 'octokit/client/say'
+require 'octokit/client/rate_limit'
 
 module Octokit
   class Client
@@ -54,11 +57,14 @@ module Octokit
     include Octokit::Client::Repositories
     include Octokit::Client::Users
     include Octokit::Client::Events
+    include Octokit::Client::Notifications
     include Octokit::Client::Authorizations
     include Octokit::Client::Refs
     include Octokit::Client::Contents
     include Octokit::Client::Markdown
     include Octokit::Client::Emojis
     include Octokit::Client::Statuses
+    include Octokit::Client::Say
+    include Octokit::Client::RateLimit
   end
 end

data/lib/octokit/client/authorizations.rb

@@ -13,8 +13,8 @@ module Octokit
       # @example List authorizations for user ctshryock
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.authorizations
-      def authorizations
-        get('authorizations')
+      def authorizations(options={})
+        get 'authorizations', options
       end
 
 
@@ -28,8 +28,8 @@ module Octokit
       # @example Show authorization for user ctshryock's Travis auth
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.authorization(999999)
-      def authorization(number)
-        get("authorizations/#{number}")
+      def authorization(number, options={})
+        get "authorizations/#{number}", options
       end
 
       # Create an authorization for the authenticated user.
@@ -87,13 +87,26 @@ module Octokit
       #
       # @param number [Number] An existing Authorization ID
       #
-      # @return [Status] A raw status response
+      # @return [Boolean] Success
       # @see http://developer.github.com/v3/oauth/#delete-an-authorization
       # @example Delete an authorization
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.delete_authorization(999999)
-      def delete_authorization(number)
-        delete("authorizations/#{number}", {}, 3, true, true)
+      def delete_authorization(number, option={})
+        request(:delete, "authorizations/#{number}").status == 204
+      end
+
+      # Check scopes for a token
+      #
+      # @param token [String] GitHub OAuth token
+      # @return [Array<String>] OAuth scopes
+      # @see http://developer.github.com/v3/oauth/#scopes
+      def scopes(token=nil)
+        request(:get, "user", :access_token => token).
+          headers[:x_oauth_scopes].
+          split(',').
+          map(&:strip).
+          sort
       end
 
     end

data/lib/octokit/client/commits.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Octokit
   class Client
     module Commits
@@ -13,7 +15,7 @@ module Octokit
       # @see http://developer.github.com/v3/repos/commits/
       def commits(repo, sha_or_branch="master", options={})
         params = { :sha => sha_or_branch, :per_page => 35 }
-        get("repos/#{Repository.new(repo)}/commits", params.merge(options), 3)
+        get("repos/#{Repository.new(repo)}/commits", params.merge(options))
       end
       alias :list_commits :commits
 
@@ -24,7 +26,7 @@ module Octokit
       # @return [Hashie::Mash] A hash representing the commit
       # @see http://developer.github.com/v3/repos/commits/
       def commit(repo, sha, options={})
-        get("repos/#{Repository.new(repo)}/commits/#{sha}", options, 3)
+        get("repos/#{Repository.new(repo)}/commits/#{sha}", options)
       end
 
       # Create a commit
@@ -49,7 +51,7 @@ module Octokit
       def create_commit(repo, message, tree, parents=nil, options={})
         params = { :message => message, :tree => tree }
         params[:parents] = [parents].flatten if parents
-        post("repos/#{Repository.new(repo)}/git/commits", options.merge(params), 3)
+        post("repos/#{Repository.new(repo)}/git/commits", options.merge(params))
       end
 
       # List all commit comments
@@ -58,7 +60,7 @@ module Octokit
       # @return [Array] An array of hashes representing comments
       # @see http://developer.github.com/v3/repos/comments/
       def list_commit_comments(repo, options={})
-        get("repos/#{Repository.new(repo)}/comments", options, 3)
+        get("repos/#{Repository.new(repo)}/comments", options)
       end
 
       # List comments for a single commit
@@ -68,7 +70,7 @@ module Octokit
       # @return [Array] An array of hashes representing comments
       # @see http://developer.github.com/v3/repos/comments/
       def commit_comments(repo, sha, options={})
-        get("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options, 3)
+        get("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options)
       end
 
       # Get a single commit comment
@@ -78,7 +80,7 @@ module Octokit
       # @return [Hashie::Mash] A hash representing the comment
       # @see http://developer.github.com/v3/repos/comments/
       def commit_comment(repo, id, options={})
-        get("repos/#{Repository.new(repo)}/comments/#{id}", options, 3)
+        get("repos/#{Repository.new(repo)}/comments/#{id}", options)
       end
 
       # Create a commit comment
@@ -106,7 +108,7 @@ module Octokit
           :line => line,
           :position => position
         }
-        post("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params), 3)
+        post("repos/#{Repository.new(repo)}/commits/#{sha}/comments", options.merge(params))
       end
 
       # Update a commit comment
@@ -124,7 +126,7 @@ module Octokit
         params = {
           :body => body
         }
-        patch("repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params), 3)
+        patch("repos/#{Repository.new(repo)}/comments/#{id}", options.merge(params))
       end
 
       # Delete a commit comment
@@ -134,18 +136,18 @@ module Octokit
       # @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)
+        request(:delete, "repos/#{Repository.new(repo)}/comments/#{id}", options).status == 204
       end
 
       # Compare two commits
       #
       # @param repo [String, Hash, Repository] A GitHub repository
-      # @param base [String] The sha of the starting commit
-      # @param end [String] The sha of the ending commit
+      # @param start [String] The sha of the starting commit
+      # @param endd [String] The sha of the ending commit
       # @return [Hashie::Mash] A hash representing the comparison
       # @see http://developer.github.com/v3/repos/commits/
       def compare(repo, start, endd, options={})
-        get("repos/#{Repository.new(repo)}/compare/#{start}...#{endd}", options, 3)
+        get("repos/#{Repository.new(repo)}/compare/#{start}...#{endd}", options)
       end
 
       # Merge a branch or sha
@@ -161,9 +163,114 @@ module Octokit
           :base => base,
           :head => head
         }.merge(options)
-        post("repos/#{Repository.new(repo)}/merges", params, 3)
+        post("repos/#{Repository.new(repo)}/merges", params)
+      end
+
+      # Get commits based on time windows
+
+      # Get commits after a specified date
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param date [String] Date on which we want to compare
+      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @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) }
+        commits(repo, sha_or_branch, params.merge(options))
+      end
+
+      # Get commits before a specified date
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param date [String] Date on which we want to compare
+      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @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)}
+        commits(repo, sha_or_branch, params.merge(options))
       end
 
+      # Get commits on a specified date
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param date [String] Date on which we want to compare
+      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @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
+        params = { :since => iso8601(start_date), :until => iso8601(end_date) }
+        commits(repo, sha_or_branch, params.merge(options))
+      end
+
+      # Get commits made between two nominated dates
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param start_date [String] Start Date on which we want to compare
+      # @param end_date [String] End Date on which we want to compare
+      # @param sha_or_branch [String] Commit SHA or branch name from which to start the list
+      # @return [Array] An array of hashes representing commits
+      # @see http://developer.github.com/v3/repos/commits/
+      # @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
+        if _end_date < _start_date
+          raise ArgumentError, "Start date #{start_date} does not precede #{end_date}"
+        end
+        params = {:since => iso8601(_start_date),
+          :until => iso8601(_end_date) }
+        commits(repo, sha_or_branch, params.merge(options))
+      end
+
+      protected
+
+      def iso8601(date)
+        if date.respond_to?(:iso8601)
+          date.iso8601
+        else
+          date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+        end
+      end
 
     end
   end

data/lib/octokit/client/contents.rb

@@ -12,7 +12,7 @@ module Octokit
   # @example Get the readme file for a repo
   #   Octokit.readme("pengwynn/octokit")
   def readme(repo, options={})
-    get("repos/#{Repository.new repo}/readme", options, 3)
+    get("repos/#{Repository.new repo}/readme", options)
   end
 
   # Receive a listing of a repository folder or the contents of a file
@@ -27,7 +27,7 @@ module Octokit
   def contents(repo, options={})
     repo_path = options.delete :path
     url = "repos/#{Repository.new repo}/contents/#{repo_path}"
-    get(url, options, 3)
+    get(url, options)
   end
 
   # This method will provide a URL to download a tarball or zipball archive for a repository.
@@ -43,8 +43,7 @@ module Octokit
     repo_ref = options.delete :ref
     format = (options.delete :format) || 'tarball'
     url = "repos/#{Repository.new repo}/#{format}/#{repo_ref}"
-    headers = get(url, options, 3, false, true).headers
-    return headers['location']
+    request(:head, url, options).env[:url].to_s
   end
   end
 end