octokit 2.1.1 → 2.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45f3f29fd88cdbbacdaee29a925b50d458d2557b
+  data.tar.gz: 3ddfd44d5073cefef0c7944568cd06f5ece20db3
+SHA512:
+  metadata.gz: 8350be3c9efbd2eb298d4322f37986f2a4c7edb4e4a84e66995f501cae68335fb2d826aaaea87eb78268722d60b23f1f77fcc01f786961c91639e0ddc0989f1e
+  data.tar.gz: d02327fef9bdad88627bf29a49b130e9c865b4661cc1704582aef7f692565b9886ebd60f97bc6b4a9729eddb02aae16a91054cde76e3430fececee80a63bd982

data/README.md

@@ -190,6 +190,37 @@ user = client.users 'defunkt'
 [access scopes]: http://developer.github.com/v3/oauth/#scopes
 [app-creds]: http://developer.github.com/v3/#unauthenticated-rate-limited-requests
 
+## Pagination
+
+Many GitHub API resources are [paginated][]. While you may be tempted to start
+adding `:page` parameters to your calls, the API returns links to the next,
+previous, and last pages for you in the `Link` response header as [Hypermedia
+link relations](docs/hypermedia.md).
+
+```ruby
+issues = Octokit.issues 'rails/rails', :per_page => 100
+issues.concat Octokit.last_response.rels[:next].get.data
+```
+
+### Auto pagination
+
+For smallish resource lists, Octokit provides auto pagination. When this is
+enabled, calls for paginated resources will fetch and concatenate the results
+from every page into a single array:
+
+```ruby
+Octokit.auto_paginate = true
+issues = Octokit.issues 'rails/rails'
+issues.length
+
+# => 702
+```
+
+**Note:** While Octokit auto pagination will set the page size to the maximum
+`100`, and seek to not overstep your rate limit, you probably want to use a
+custom pattern for traversing large lists.
+
+[paginated]: http://developer.github.com/v3/#pagination
 
 ## Configuration and defaults
 

data/lib/octokit/client/authorizations.rb

@@ -21,7 +21,6 @@ module Octokit
         paginate 'authorizations', options
       end
 
-
       # Get a single authorization for the authenticated user.
       #
       # You can only access your own tokens, and only through

data/lib/octokit/client/commit_comments.rb

@@ -90,7 +90,6 @@ module Octokit
       def delete_commit_comment(repo, id, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
-
     end
   end
 end

data/lib/octokit/client/commits.rb

@@ -31,7 +31,7 @@ module Octokit
       alias :list_commits :commits
 
       # Get commits after a specified date
-
+      #
       # @overload commits_since(repo, date, options = {})
       #   @param repo [String, Hash, Repository] A GitHub repository
       #   @param date [String] Date on which we want to compare
@@ -311,7 +311,6 @@ module Octokit
       rescue ArgumentError
         raise ArgumentError, "#{date} is not a valid date"
       end
-
     end
   end
 end

data/lib/octokit/client/contents.rb

@@ -155,7 +155,6 @@ module Octokit
 
         last_response.headers['Location']
       end
-
     end
   end
 end

data/lib/octokit/client/downloads.rb

@@ -84,6 +84,7 @@ module Octokit
       end
 
       private
+
       def create_download_resource(repo, name, size, options={})
         post "repos/#{Repository.new(repo)}/downloads", options.merge({:name => name, :size => size})
       end

data/lib/octokit/client/emojis.rb

@@ -3,6 +3,7 @@ module Octokit
 
     # Methods for the the unpublished Emojis API
     module Emojis
+
       # List all emojis used on GitHub
       #
       # @return [Sawyer::Resource] A list of all emojis on GitHub

data/lib/octokit/client/events.rb

@@ -6,6 +6,7 @@ module Octokit
     # @see http://developer.github.com/v3/activity/events/
     # @see http://developer.github.com/v3/issues/events/
     module Events
+
       # List all public events for GitHub
       #
       # @return [Array<Sawyer::Resource>] A list of all public events from GitHub
@@ -141,7 +142,6 @@ module Octokit
       def issue_event(repo, number, options = {})
         paginate "repos/#{Repository.new(repo)}/issues/events/#{number}", options
       end
-
     end
   end
 end

data/lib/octokit/client/gists.rb

@@ -200,7 +200,6 @@ module Octokit
       def delete_gist_comment(gist_id, gist_comment_id, options = {})
         boolean_from_response(:delete, "gists/#{gist_id}/comments/#{gist_comment_id}", options)
       end
-
     end
   end
 end

data/lib/octokit/client/gitignore.rb

@@ -27,7 +27,7 @@ module Octokit
       # 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 
+      #   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
@@ -39,7 +39,6 @@ module Octokit
       def gitignore_template(template_name, options = {})
         get "gitignore/templates/#{template_name}", options
       end
-
     end
   end
 end

data/lib/octokit/client/labels.rb

@@ -151,7 +151,6 @@ module Octokit
       def labels_for_milestone(repo, number, options = {})
         get "repos/#{Repository.new(repo)}/milestones/#{number}/labels", options
       end
-
     end
   end
 end

data/lib/octokit/client/legacy_search.rb

@@ -37,7 +37,6 @@ module Octokit
       def legacy_search_users(search, options = {})
         get("legacy/user/search/#{search}", options)['users']
       end
-
     end
   end
 end

data/lib/octokit/client/markdown.rb

@@ -22,7 +22,6 @@ module Octokit
 
         post "markdown", options
       end
-
     end
   end
 end

data/lib/octokit/client/milestones.rb

@@ -85,7 +85,6 @@ module Octokit
       def delete_milestone(repository, number, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repository)}/milestones/#{number}", options
       end
-
     end
   end
 end

data/lib/octokit/client/notifications.rb

@@ -166,7 +166,6 @@ module Octokit
       def delete_thread_subscription(thread_id, options = {})
         boolean_from_response :delete, "notifications/threads/#{thread_id}/subscription", options
       end
-
     end
   end
 end

data/lib/octokit/client/objects.rb

@@ -5,6 +5,7 @@ module Octokit
     #
     # @see http://developer.github.com/v3/git/
     module Objects
+
       # Get a single tree, fetching information about its root-level objects
       #
       # Pass <tt>:recursive => true</tt> in <tt>options</tt> to fetch information about all of the tree's objects, including those in subdirectories.

data/lib/octokit/client/organizations.rb

@@ -5,6 +5,7 @@ module Octokit
     #
     # @see http://developer.github.com/v3/orgs/
     module Organizations
+
       # Get an organization
       #
       # @param org [String] Organization GitHub username.
@@ -57,7 +58,7 @@ module Octokit
       #
       # Calling this method on a `@client` will return that users organizations.
       # Private organizations are included only if the `@client` is authenticated.
-      # 
+      #
       # @param user [String] Username of the user to get list of organizations.
       # @return [Array<Sawyer::Resource>] Array of hashes representing organizations.
       # @see http://developer.github.com/v3/orgs/#list-user-organizations
@@ -193,17 +194,17 @@ module Octokit
 
       # Create team
       #
-      # Requires authenticated organization owner. 
+      # Requires authenticated organization owner.
       #
       # @param org [String] Organization GitHub username.
       # @option options [String] :name Team name.
       # @option options [Array<String>] :repo_names Repositories for the team.
       # @option options [String, optional] :permission ('pull') Permissions the
-      #   team has for team repositories.  
+      #   team has for team repositories.
       #
-      #   `pull` - team members can pull, but not push to or administer these repositories.    
-      #   `push` - team members can pull and push, but not administer these repositories.  
-      #   `admin` - team members can pull, push and administer these repositories. 
+      #   `pull` - team members can pull, but not push to or administer these repositories.
+      #   `push` - team members can pull and push, but not administer these repositories.
+      #   `admin` - team members can pull, push and administer these repositories.
       # @return [Sawyer::Resource] Hash representing new team.
       # @see http://developer.github.com/v3/orgs/teams/#create-team
       # @example
@@ -235,10 +236,10 @@ module Octokit
       #
       # @param team_id [Integer] Team id.
       # @option options [String] :name Team name.
-      # @option options [String] :permission Permissions the team has for team repositories.  
+      # @option options [String] :permission Permissions the team has for team repositories.
       #
-      #   `pull` - team members can pull, but not push to or administer these repositories.    
-      #   `push` - team members can pull and push, but not administer these repositories.  
+      #   `pull` - team members can pull, but not push to or administer these repositories.
+      #   `push` - team members can pull and push, but not administer these repositories.
       #   `admin` - team members can pull, push and administer these repositories.
       # @return [Sawyer::Resource] Hash representing updated team.
       # @see http://developer.github.com/v3/orgs/teams/#edit-team
@@ -279,7 +280,7 @@ module Octokit
 
       # Add team member
       #
-      # Requires authenticated organization owner or member with team 
+      # Requires authenticated organization owner or member with team
       # `admin` permission.
       #
       # @param team_id [Integer] Team id.
@@ -297,7 +298,7 @@ module Octokit
 
       # Remove team member
       #
-      # Requires authenticated organization owner or member with team 
+      # Requires authenticated organization owner or member with team
       # `admin` permission.
       #
       # @param team_id [Integer] Team id.

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -5,6 +5,7 @@ module Octokit
     #
     # @see http://developer.github.com/v3/repos/hooks/#pubsubhubbub
     module PubSubHubbub
+
       # Subscribe to a pubsub topic
       #
       # @param topic [String] A recoginized and supported pubsub topic
@@ -55,7 +56,7 @@ module Octokit
       #    client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" })
       def subscribe_service_hook(repo, service_name, service_arguments = {})
         topic = "#{Octokit.web_endpoint}#{Repository.new(repo)}/events/push"
-        callback = "github://#{service_name}?#{service_arguments.collect{ |k,v| [ k,v ].join("=") }.join("&") }"
+        callback = "github://#{service_name}?#{service_arguments.collect{ |k,v| [ k,v ].map{ |p| URI.encode_www_form_component(p) }.join("=") }.join("&") }"
         subscribe(topic, callback)
       end
 
@@ -76,7 +77,7 @@ module Octokit
       private
 
       def pub_sub_hubbub_request(options = {})
-        # This method is janky, bypass normal stack so we don'tl 
+        # This method is janky, bypass normal stack so we don'tl
         # serialize request as JSON
         conn = Faraday.new(:url => @api_endpoint) do |http|
           http.headers[:user_agent] = user_agent

data/lib/octokit/client/pull_requests.rb

@@ -5,6 +5,7 @@ module Octokit
     #
     # @see http://developer.github.com/v3/pulls/
     module PullRequests
+
       # List pull requests for a repository
       #
       # @see http://developer.github.com/v3/pulls/#list-pull-requests

data/lib/octokit/client/repositories.rb

@@ -6,7 +6,6 @@ module Octokit
     # @see http://developer.github.com/v3/repos/
     module Repositories
 
-
       # Check if a repository exists
       #
       # @see http://developer.github.com/v3/repos/#get
@@ -647,7 +646,6 @@ module Octokit
       def delete_subscription(repo, options = {})
         boolean_from_response :delete, "repos/#{Repository.new repo}/subscription", options
       end
-
     end
   end
 end

data/lib/octokit/client/service_status.rb

@@ -33,7 +33,6 @@ module Octokit
       def github_status_messages
         get(STATUS_ROOT).rels[:messages].get.data
       end
-
     end
   end
 end

data/lib/octokit/client/stats.rb

@@ -6,82 +6,81 @@ module Octokit
     # @see http://developer.github.com/v3/repos/statistics/
     module Stats
 
-    # Get contributors list with additions, deletions, and commit counts
-    #
-    # @param repo [String, Hash, Repository] A GitHub repository
-    # @return [Array<Sawyer::Resource>] Array of contributor stats
-    # @see http://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts
-    # @example Get contributor stats for octokit
-    #   @client.contributors_stats('octokit/octokit.rb')
-    def contributors_stats(repo, options = {})
-      get_stats(repo, "contributors", options)
-    end
-    alias :contributor_stats :contributors_stats
+      # Get contributors list with additions, deletions, and commit counts
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Array<Sawyer::Resource>] Array of contributor stats
+      # @see http://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts
+      # @example Get contributor stats for octokit
+      #   @client.contributors_stats('octokit/octokit.rb')
+      def contributors_stats(repo, options = {})
+        get_stats(repo, "contributors", options)
+      end
+      alias :contributor_stats :contributors_stats
 
-    # Get the last year of commit activity data
-    #
-    # @param repo [String, Hash, Repository] A GitHub repository
-    # @return [Array<Sawyer::Resource>] The last year of commit activity grouped by
-    #   week. The days array is a group of commits per day, starting on Sunday.
-    # @see http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
-    # @example Get commit activity for octokit
-    #   @client.commit_activity_stats('octokit/octokit.rb')
-    def commit_activity_stats(repo, options = {})
-      get_stats(repo, "commit_activity", options)
-    end
+      # Get the last year of commit activity data
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Array<Sawyer::Resource>] The last year of commit activity grouped by
+      #   week. The days array is a group of commits per day, starting on Sunday.
+      # @see http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
+      # @example Get commit activity for octokit
+      #   @client.commit_activity_stats('octokit/octokit.rb')
+      def commit_activity_stats(repo, options = {})
+        get_stats(repo, "commit_activity", options)
+      end
 
-    # Get the number of additions and deletions per week
-    #
-    # @param repo [String, Hash, Repository] A GitHub repository
-    # @return [Array<Sawyer::Resource>] Weekly aggregate of the number of additions
-    #   and deletions pushed to a repository.
-    # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week
-    # @example Get code frequency stats for octokit
-    #   @client.code_frequency_stats('octokit/octokit.rb')
-    def code_frequency_stats(repo, options = {})
-      get_stats(repo, "code_frequency", options)
-    end
+      # Get the number of additions and deletions per week
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Array<Sawyer::Resource>] Weekly aggregate of the number of additions
+      #   and deletions pushed to a repository.
+      # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week
+      # @example Get code frequency stats for octokit
+      #   @client.code_frequency_stats('octokit/octokit.rb')
+      def code_frequency_stats(repo, options = {})
+        get_stats(repo, "code_frequency", options)
+      end
 
-    # Get the weekly commit count for the repo owner and everyone else
-    #
-    # @param repo [String, Hash, Repository] A GitHub repository
-    # @return [Sawyer::Resource] Total commit counts for the owner and total commit
-    #   counts in all. all is everyone combined, including the owner in the last
-    #   52 weeks. If you’d like to get the commit counts for non-owners, you can
-    #   subtract all from owner.
-    # @see http://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else
-    # @example Get weekly commit counts for octokit
-    #   @client.participation_stats("octokit/octokit.rb")
-    def participation_stats(repo, options = {})
-      get_stats(repo, "participation", options)
-    end
-
-    # Get the number of commits per hour in each day
-    #
-    # @param repo [String, Hash, Repository] A GitHub repository
-    # @return [Array<Array>] Arrays containing the day number, hour number, and
-    #   number of commits 
-    # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day
-    # @example Get octokit punch card
-    #   @octokit.punch_card_stats
-    def punch_card_stats(repo, options = {})
-      get_stats(repo, "punch_card", options)
-    end
-    alias :punch_card :punch_card_stats
+      # Get the weekly commit count for the repo owner and everyone else
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Sawyer::Resource] Total commit counts for the owner and total commit
+      #   counts in all. all is everyone combined, including the owner in the last
+      #   52 weeks. If you’d like to get the commit counts for non-owners, you can
+      #   subtract all from owner.
+      # @see http://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else
+      # @example Get weekly commit counts for octokit
+      #   @client.participation_stats("octokit/octokit.rb")
+      def participation_stats(repo, options = {})
+        get_stats(repo, "participation", options)
+      end
 
-    private
+      # Get the number of commits per hour in each day
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @return [Array<Array>] Arrays containing the day number, hour number, and
+      #   number of commits
+      # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day
+      # @example Get octokit punch card
+      #   @octokit.punch_card_stats
+      def punch_card_stats(repo, options = {})
+        get_stats(repo, "punch_card", options)
+      end
+      alias :punch_card :punch_card_stats
 
-    # @private Get stats for a repository
-    #
-    # @param repo [String, Hash, Repository] A GitHub repository
-    # @param metric [String] The metrics you are looking for
-    # @return [Array<Sawyer::Resource>] Magical unicorn stats
-    def get_stats(repo, metric, options = {})
-      data = get("repos/#{Repository.new repo}/stats/#{metric}", options)
+      private
 
-      last_response.status == 202 ? nil : data
-    end
+      # @private Get stats for a repository
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param metric [String] The metrics you are looking for
+      # @return [Array<Sawyer::Resource>] Magical unicorn stats
+      def get_stats(repo, metric, options = {})
+        data = get("repos/#{Repository.new repo}/stats/#{metric}", options)
 
+        last_response.status == 202 ? nil : data
+      end
     end
   end
 end

data/lib/octokit/client/users.rb

@@ -110,7 +110,7 @@ module Octokit
         get "users/#{user}/following", options
       end
 
-      # Check if you are following a user. Alternatively, check if a given user 
+      # Check if you are following a user. Alternatively, check if a given user
       # is following a target user.
       #
       # Requries an authenticated client.
@@ -182,14 +182,21 @@ module Octokit
       #
       # Requires authenticated client.
       #
-      # @param user [String] Username of repository owner.
-      # @param repo [String] Name of the repository.
+      # @param args [String, Hash, Repository] A GitHub repository
       # @return [Boolean] True if you are following the repo, false otherwise.
       # @see http://developer.github.com/v3/repos/starring/#check-if-you-are-starring-a-repository
       # @example
-      #   @client.starred?('pengwynn', 'octokit')
-      def starred?(user, repo, options = {})
-        boolean_from_response :get, "user/starred/#{user}/#{repo}", options
+      #   @client.starred?('pengwynn/octokit')
+      #   @client.starred?('pengwynn', 'octokit') # deprecated
+      def starred?(*args)
+        arguments = Octokit::Arguments.new(args)
+        options = arguments.options
+        name = name_with_owner = arguments.shift
+        if repo = arguments.shift
+          name_with_owner = "#{name}/#{repo}"
+          warn "`.starred?('#{name}', '#{repo}')` is deprecated. Please use `.starred?('#{name_with_owner}')` instead."
+        end
+        boolean_from_response :get, "user/starred/#{Repository.new name_with_owner}", options
       end
 
       # Get a public key.

data/lib/octokit/error.rb

@@ -13,28 +13,19 @@ module Octokit
       headers = response[:response_headers]
 
       if klass =  case status
-                  when 400 then Octokit::BadRequest
-                  when 401
-                    if Octokit::OneTimePasswordRequired.required_header(headers)
-                      Octokit::OneTimePasswordRequired
-                    else
-                      Octokit::Unauthorized
-                    end
-                  when 403
-                    if body =~ /rate limit exceeded/i
-                      Octokit::TooManyRequests
-                    elsif body =~ /login attempts exceeded/i
-                      Octokit::TooManyLoginAttempts
-                    else
-                      Octokit::Forbidden
-                    end
-                  when 404 then Octokit::NotFound
-                  when 406 then Octokit::NotAcceptable
-                  when 422 then Octokit::UnprocessableEntity
-                  when 500 then Octokit::InternalServerError
-                  when 501 then Octokit::NotImplemented
-                  when 502 then Octokit::BadGateway
-                  when 503 then Octokit::ServiceUnavailable
+                  when 400      then Octokit::BadRequest
+                  when 401      then error_for_401(headers)
+                  when 403      then error_for_403(body)
+                  when 404      then Octokit::NotFound
+                  when 406      then Octokit::NotAcceptable
+                  when 415      then Octokit::UnsupportedMediaType
+                  when 422      then Octokit::UnprocessableEntity
+                  when 400..499 then Octokit::ClientError
+                  when 500      then Octokit::InternalServerError
+                  when 501      then Octokit::NotImplemented
+                  when 502      then Octokit::BadGateway
+                  when 503      then Octokit::ServiceUnavailable
+                  when 500..599 then Octokit::ServerError
                   end
         klass.new(response)
       end
@@ -45,6 +36,35 @@ module Octokit
       super(build_error_message)
     end
 
+    # Documentation URL returned by the API for some errors
+    #
+    # @return [String]
+    def documentation_url
+      data[:documentation_url] if data
+    end
+
+    # Returns most appropriate error for 401 HTTP status code
+    # @private
+    def self.error_for_401(headers)
+      if Octokit::OneTimePasswordRequired.required_header(headers)
+        Octokit::OneTimePasswordRequired
+      else
+        Octokit::Unauthorized
+      end
+    end
+
+    # Returns most appropriate error for 403 HTTP status code
+    # @private
+    def self.error_for_403(body)
+      if body =~ /rate limit exceeded/i
+        Octokit::TooManyRequests
+      elsif body =~ /login attempts exceeded/i
+        Octokit::TooManyLoginAttempts
+      else
+        Octokit::Forbidden
+      end
+    end
+
     private
 
     def data
@@ -96,32 +116,41 @@ module Octokit
       message << "#{response_message}" unless response_message.nil?
       message << "#{response_error}" unless response_error.nil?
       message << "#{response_error_summary}" unless response_error_summary.nil?
+      message << " // See: #{documentation_url}" unless documentation_url.nil?
       message
     end
   end
 
+  # Raised on errors in the 400-499 range
+  class ClientError < Error; end
+
   # Raised when GitHub returns a 400 HTTP status code
-  class BadRequest < Error; end
+  class BadRequest < ClientError; end
 
   # Raised when GitHub returns a 401 HTTP status code
-  class Unauthorized < Error; end
+  class Unauthorized < ClientError; end
 
   # Raised when GitHub returns a 401 HTTP status code
   # and headers include "X-GitHub-OTP"
-  class OneTimePasswordRequired < Error
+  class OneTimePasswordRequired < ClientError
+    #@private
     HEADER = /required; (?<delivery>\w+)/i
 
+    #@private
     def self.required_header(headers)
       HEADER.match headers['X-GitHub-OTP'].to_s
     end
 
+    # Delivery method for the user's OTP
+    #
+    # @return [String]
     def password_delivery
       @password_delivery ||= self.class.required_header(@response[:response_headers])[:delivery]
     end
   end
 
   # Raised when GitHub returns a 403 HTTP status code
-  class Forbidden < Error; end
+  class Forbidden < ClientError; end
 
   # Raised when GitHub returns a 403 HTTP status code
   # and body matches 'rate limit exceeded'
@@ -132,23 +161,29 @@ module Octokit
   class TooManyLoginAttempts < Forbidden; end
 
   # Raised when GitHub returns a 404 HTTP status code
-  class NotFound < Error; end
+  class NotFound < ClientError; end
 
   # Raised when GitHub returns a 406 HTTP status code
-  class NotAcceptable < Error; end
+  class NotAcceptable < ClientError; end
+
+  # Raised when GitHub returns a 414 HTTP status code
+  class UnsupportedMediaType < ClientError; end
 
   # Raised when GitHub returns a 422 HTTP status code
-  class UnprocessableEntity < Error; end
+  class UnprocessableEntity < ClientError; end
+
+  # Raised on errors in the 500-599 range
+  class ServerError < Error; end
 
   # Raised when GitHub returns a 500 HTTP status code
-  class InternalServerError < Error; end
+  class InternalServerError < ServerError; end
 
   # Raised when GitHub returns a 501 HTTP status code
-  class NotImplemented < Error; end
+  class NotImplemented < ServerError; end
 
   # Raised when GitHub returns a 502 HTTP status code
-  class BadGateway < Error; end
+  class BadGateway < ServerError; end
 
   # Raised when GitHub returns a 503 HTTP status code
-  class ServiceUnavailable < Error; end
+  class ServiceUnavailable < ServerError; end
 end

data/lib/octokit/version.rb

@@ -2,6 +2,6 @@ module Octokit
 
   # Current version
   # @return [String]
-  VERSION = "2.1.1".freeze
+  VERSION = "2.1.2".freeze
 
 end

data/octokit.gemspec

@@ -5,7 +5,7 @@ require 'octokit/version'
 
 Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.add_dependency 'sawyer', '~> 0.3.0'
+  spec.add_dependency 'sawyer', '~> 0.5.0'
   spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
   spec.description = %q{Simple wrapper for the GitHub API}
   spec.email = ['wynn.netherland@gmail.com', 'sferik@gmail.com', 'clint@ctshryock.com']

data/spec/cassettes/Octokit_Client_Users/_starred_/checks_if_the_authenticated_user_has_starred_a_repository_deprecated_.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/user/starred/sferik/rails_admin","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.beta+json"],"User-Agent":["Octokit Ruby Gem 2.1.1"],"Authorization":["token <<ACCESS_TOKEN>>"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":404,"message":"Not Found"},"headers":{"Server":["GitHub.com"],"Date":["Sun, 08 Sep 2013 15:01:28 GMT"],"Content-Type":["application/json; charset=utf-8"],"Transfer-Encoding":["chunked"],"Status":["404 Not Found"],"X-Ratelimit-Limit":["5000"],"X-Ratelimit-Remaining":["4995"],"X-Ratelimit-Reset":["1378654817"],"X-Oauth-Scopes":["user, public_repo, repo, gist"],"X-Accepted-Oauth-Scopes":["repo, public_repo, repo:status, repo:deployment, delete_repo, site_admin"],"X-Github-Media-Type":["github.beta; format=json"],"X-Content-Type-Options":["nosniff"],"Access-Control-Allow-Credentials":["true"],"Access-Control-Expose-Headers":["ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes"],"Access-Control-Allow-Origin":["*"],"X-Github-Request-Id":["fec2764a-0d89-4c63-8645-0c8f89a4294b"]},"body":{"encoding":"UTF-8","base64_string":"eyJtZXNzYWdlIjoiTm90IEZvdW5kIn0=\n"},"http_version":null},"recorded_at":"Sun, 08 Sep 2013 15:01:28 GMT"}],"recorded_with":"VCR 2.4.0"}

data/spec/octokit/client/pub_sub_hubbub_spec.rb

@@ -60,6 +60,18 @@ describe Octokit::Client::PubSubHubbub do
       assert_requested :post, github_url("/hub"), :body => subscribe_request_body, :times => 1,
         :headers => {'Content-type' => 'application/x-www-form-urlencoded'}
     end
+    it "encodes URL parameters" do
+      irc_request_body = {
+        :"hub.callback" => 'github://irc?server=chat.freenode.org&room=%23myproject',
+        :"hub.mode" => 'subscribe',
+        :"hub.topic" => 'https://github.com/joshk/completeness-fu/events/push'
+      }
+      stub_post("/hub").
+        with(irc_request_body).
+        to_return(:status => 204)
+      expect(@client.subscribe_service_hook("joshk/completeness-fu", "irc", { :server => "chat.freenode.org", :room => "#myproject"})).to eql(true)
+      assert_requested :post, "https://api.github.com/hub", :body => irc_request_body, :times => 1
+    end
   end # .subscribe_service_hook
 
   describe "unsubscribe_service_hook", :vcr do

data/spec/octokit/client/users_spec.rb

@@ -93,6 +93,10 @@ describe Octokit::Client::Users do
 
   describe ".starred?", :vcr do
     it "checks if the authenticated user has starred a repository" do
+      starred = @client.starred?("sferik/rails_admin")
+      assert_requested :get, github_url("/user/starred/sferik/rails_admin")
+    end
+    it "checks if the authenticated user has starred a repository (deprecated)" do
       starred = @client.starred?("sferik", "rails_admin")
       assert_requested :get, github_url("/user/starred/sferik/rails_admin")
     end

data/spec/octokit/client_spec.rb

@@ -478,6 +478,45 @@ describe Octokit::Client do
         :body => {:message => "Maximum number of login attempts exceeded"}.to_json
       expect { Octokit.get('/user') }.to raise_error Octokit::TooManyLoginAttempts
     end
+
+    it "raises on unknown client errors" do
+      stub_get('/user').to_return \
+        :status => 418,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {:message => "I'm a teapot"}.to_json
+      expect { Octokit.get('/user') }.to raise_error Octokit::ClientError
+    end
+
+    it "raises on unknown server errors" do
+      stub_get('/user').to_return \
+        :status => 509,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {:message => "Bandwidth exceeded"}.to_json
+      expect { Octokit.get('/user') }.to raise_error Octokit::ServerError
+    end
+
+    it "handles documentation URLs in error messages" do
+      stub_get('/user').to_return \
+        :status => 415,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {
+          :message => "Unsupported Media Type",
+          :documentation_url => "http://developer.github.com/v3"
+        }.to_json
+      begin
+        Octokit.get('/user')
+      rescue Octokit::UnsupportedMediaType => e
+        msg = "415 - Unsupported Media Type"
+        expect(e.message).to include(msg)
+        expect(e.documentation_url).to eq("http://developer.github.com/v3")
+      end
+    end
   end
 
   it "knows the difference between unauthorized and needs OTP" do

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 2.1.1
-  prerelease: 
+  version: 2.1.2
 platform: ruby
 authors:
 - Wynn Netherland
@@ -11,12 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -24,7 +22,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -32,19 +29,17 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sawyer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.5.0
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -370,6 +365,7 @@ files:
 - spec/cassettes/Octokit_Client_Users/_starred/returns_starred_repositories_for_a_user.json
 - spec/cassettes/Octokit_Client_Users/_starred/returns_starred_repositories_for_the_authenticated_user.json
 - spec/cassettes/Octokit_Client_Users/_starred_/checks_if_the_authenticated_user_has_starred_a_repository.json
+- spec/cassettes/Octokit_Client_Users/_starred_/checks_if_the_authenticated_user_has_starred_a_repository_deprecated_.json
 - spec/cassettes/Octokit_Client_Users/_subscriptions/returns_the_repositories_a_user_watches_for_notifications.json
 - spec/cassettes/Octokit_Client_Users/_subscriptions/returns_the_repositories_the_authenticated_user_watches_for_notifications.json
 - spec/cassettes/Octokit_Client_Users/_unfollow/unfollows_a_user.json
@@ -426,27 +422,26 @@ files:
 homepage: https://github.com/octokit/octokit.rb
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby toolkit for working with the GitHub API
 test_files:
 - spec/cassettes/delete_authorization.json
@@ -717,6 +712,7 @@ test_files:
 - spec/cassettes/Octokit_Client_Users/_starred/returns_starred_repositories_for_a_user.json
 - spec/cassettes/Octokit_Client_Users/_starred/returns_starred_repositories_for_the_authenticated_user.json
 - spec/cassettes/Octokit_Client_Users/_starred_/checks_if_the_authenticated_user_has_starred_a_repository.json
+- spec/cassettes/Octokit_Client_Users/_starred_/checks_if_the_authenticated_user_has_starred_a_repository_deprecated_.json
 - spec/cassettes/Octokit_Client_Users/_subscriptions/returns_the_repositories_a_user_watches_for_notifications.json
 - spec/cassettes/Octokit_Client_Users/_subscriptions/returns_the_repositories_the_authenticated_user_watches_for_notifications.json
 - spec/cassettes/Octokit_Client_Users/_unfollow/unfollows_a_user.json