octokit 2.0.0.rc2 → 2.0.0.rc3

data/README.md

@@ -112,6 +112,8 @@ 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.
 
+[travis]: https://travis-ci.org/octokit/octokit.rb
+
 ## Versioning
 
 This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations

data/lib/octokit/client/organizations.rb

@@ -104,7 +104,7 @@ module Octokit
       # @example
       #   @client.org_repos('github', {:type => 'private'})
       def organization_repositories(org, options = {})
-        get "orgs/#{org}/repos", options
+        paginate "orgs/#{org}/repos", options
       end
       alias :org_repositories :organization_repositories
       alias :org_repos :organization_repositories
@@ -125,7 +125,7 @@ module Octokit
       # @example
       #   Octokit.org_members('github')
       def organization_members(org, options = {})
-        get "orgs/#{org}/members", options
+        paginate "orgs/#{org}/members", options
       end
       alias :org_members :organization_members
 

data/lib/octokit/client/search.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param query [String] Search term and qualifiers
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
-      # @option options [String] :direction Sort direction (asc or desc)
+      # @option options [String] :order Sort order (asc or desc)
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
@@ -25,7 +25,7 @@ module Octokit
       # @param query [String] Search term and qualifiers
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
-      # @option options [String] :direction Sort direction (asc or desc)
+      # @option options [String] :order Sort order (asc or desc)
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
@@ -39,7 +39,7 @@ module Octokit
       # @param query [String] Search term and qualifiers
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
-      # @option options [String] :direction Sort direction (asc or desc)
+      # @option options [String] :order Sort order (asc or desc)
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
@@ -54,7 +54,7 @@ module Octokit
       # @param query [String] Search term and qualifiers
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
-      # @option options [String] :direction Sort direction (asc or desc)
+      # @option options [String] :order Sort order (asc or desc)
       # @option options [Fixnum] :page Page of paginated results
       # @option options [Fixnum] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object

data/lib/octokit/client/statuses.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param sha [String] The SHA1 for the commit
       # @return [Array<Sawyer::Resource>] A list of statuses
-      # @see http://developer.github.com/v3/repos/status
+      # @see http://developer.github.com/v3/repos/statuses
       def statuses(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/statuses/#{sha}", options
       end
@@ -23,7 +23,7 @@ module Octokit
       # @param sha [String] The SHA1 for the commit
       # @param state [String] The state: pending, success, failure, error
       # @return [Sawyer::Resource] A status
-      # @see http://developer.github.com/v3/repos/status
+      # @see http://developer.github.com/v3/repos/statuses
       def create_status(repo, sha, state, options = {})
         options.merge!(:state => state)
         post "repos/#{Repository.new(repo)}/statuses/#{sha}", options

data/lib/octokit/client/users.rb

@@ -106,7 +106,8 @@ module Octokit
         get "users/#{user}/following", options
       end
 
-      # Check if you are following a user.
+      # Check if you are following a user. Alternatively, check if a given user 
+      # is following a target user.
       #
       # Requries an authenticated client.
       #
@@ -119,12 +120,17 @@ module Octokit
       # @see http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
       # @example
       #   @client.follows?('pengwynn')
+      # @example
+      #   @client.follows?('catsby', 'pengwynn')
       def follows?(*args)
         target = args.pop
         user = args.first
-        user ||= login
-        return if user.nil?
-        boolean_from_response :get, "user/following/#{target}"
+        if user.nil?
+          url = "user/following/#{target}"
+        else
+          url = "users/#{user}/following/#{target}"
+        end
+        boolean_from_response :get, url
       end
 
       # Follow a user.

data/lib/octokit/configurable.rb

@@ -26,7 +26,7 @@ module Octokit
     #   @return [String] GitHub username for Basic Authentication
     # @!attribute middleware
     #   @see https://github.com/lostisland/faraday
-    #   @return [Faraday::RackBuilder] Configure middleware for Faraday
+    #   @return [Faraday::Builder] Configure middleware for Faraday
     # @!attribute netrc
     #   @return [Boolean] Instruct Octokit to get credentials from .netrc file
     # @!attribute netrc_file

data/lib/octokit/default.rb

@@ -19,7 +19,7 @@ module Octokit
     WEB_ENDPOINT = "https://github.com".freeze
 
     # Default Faraday middleware stack
-    MIDDLEWARE = Faraday::RackBuilder.new do |builder|
+    MIDDLEWARE = Faraday::Builder.new do |builder|
       builder.use Octokit::Response::RaiseError
       builder.adapter Faraday.default_adapter
     end

data/lib/octokit/error.rb

@@ -1,18 +1,54 @@
 module Octokit
   # Custom error class for rescuing from all GitHub errors
   class Error < StandardError
+
+    # Returns the appropriate Octokit::Error sublcass based
+    # on status and response message
+    #
+    # @param [Hash]
+    # @returns [Octokit::Error]
+    def self.from_response(response)
+      status = response[:status].to_i
+      body  = response[:body].to_s
+
+      if klass =  case status
+                  when 400 then Octokit::BadRequest
+                  when 401 then Octokit::Unauthorized
+                  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
+                  end
+        klass.new(response)
+      end
+    end
+
     def initialize(response=nil)
       @response = response
       super(build_error_message)
     end
 
-    # private
-    def response_body
-      @response_body ||=
+    private
+
+    def data
+      @data ||=
         if (body = @response[:body]) && !body.empty?
-          if body.is_a?(String)
-            serializer = Sawyer::Serializer.new(Sawyer::Serializer.any_json)
-            serializer.decode(body)
+          if body.is_a?(String) &&
+            @response[:response_headers] &&
+            @response[:response_headers][:content_type] =~ /json/
+
+            Sawyer::Agent.serializer.decode(body)
           else
             body
           end
@@ -21,19 +57,40 @@ module Octokit
         end
     end
 
-    # private
+    def response_message
+      case data
+      when Hash
+        data[:message]
+      when String
+        data
+      end
+    end
+
+    def response_error
+      "Error: #{data[:error]}" if data.is_a?(Hash) && data[:error]
+    end
+
+    def response_error_summary
+      return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
+
+      summary = "\nError summary:\n"
+      summary << data[:errors].map do |hash|
+        hash.map { |k,v| "  #{k}: #{v}" }
+      end.join("\n")
+
+      summary
+    end
+
     def build_error_message
-      return nil  if @response.nil?
+      return nil if @response.nil?
 
-      message = if response_body
-        ": #{response_body['error'] || response_body['message'] || ''}"
-      else
-        ''
-      end
-      errors = unless message.empty?
-        response_body['errors'] ?  ": #{response_body['errors'].map{|e|e['message']}.join(', ')}" : ''
-      end
-      "#{@response[:method].to_s.upcase} #{@response[:url].to_s}: #{@response[:status]}#{message}#{errors}"
+      message =  "#{@response[:method].to_s.upcase} "
+      message << "#{@response[:url].to_s}: "
+      message << "#{@response[:status]} - "
+      message << "#{response_message}" unless response_message.nil?
+      message << "#{response_error}" unless response_error.nil?
+      message << "#{response_error_summary}" unless response_error_summary.nil?
+      message
     end
   end
 
@@ -46,6 +103,14 @@ module Octokit
   # Raised when GitHub returns a 403 HTTP status code
   class Forbidden < Error; end
 
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'rate limit exceeded'
+  class TooManyRequests < Forbidden; end
+
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'login attempts exceeded'
+  class TooManyLoginAttempts < Forbidden; end
+
   # Raised when GitHub returns a 404 HTTP status code
   class NotFound < Error; end
 

data/lib/octokit/response/raise_error.rb

@@ -9,26 +9,12 @@ module Octokit
     # HTTP status codes returned by the API
     class RaiseError < Faraday::Response::Middleware
 
-      # Status code to error mappings
-      # @private
-      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
-      }
-
       private
 
       def on_complete(response)
-        key = response[:status].to_i
-        raise ERROR_MAP[key].new(response) if ERROR_MAP.has_key? key
+        if error = Octokit::Error.from_response(response)
+          raise error
+        end
       end
     end
   end

data/lib/octokit/version.rb

@@ -2,6 +2,6 @@ module Octokit
 
   # Current version
   # @return [String]
-  VERSION = "2.0.0.rc2".freeze
+  VERSION = "2.0.0.rc3".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.1.0'
+  spec.add_dependency 'sawyer', '~> 0.3.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/_follows_/checks_if_given_user_is_following_target_user.json

@@ -0,0 +1 @@
+{"http_interactions":[{"request":{"method":"get","uri":"https://api.github.com/users/sferik/following/pengwynn","body":{"encoding":"US-ASCII","base64_string":""},"headers":{"Accept":["application/vnd.github.beta+json"],"User-Agent":["Octokit Ruby Gem 2.0.0.rc2"],"Authorization":["token <<ACCESS_TOKEN>>"],"Accept-Encoding":["gzip;q=1.0,deflate;q=0.6,identity;q=0.3"]}},"response":{"status":{"code":204,"message":"No Content"},"headers":{"Server":["GitHub.com"],"Date":["Tue, 13 Aug 2013 14:34:49 GMT"],"Status":["204 No Content"],"X-Ratelimit-Limit":["5000"],"X-Ratelimit-Remaining":["4997"],"X-Ratelimit-Reset":["1376407750"],"X-Oauth-Scopes":["repo, user, gist, delete_repo"],"X-Accepted-Oauth-Scopes":["user, user:email, user:follow, 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":["*"],"Vary":["Accept-Encoding"]},"body":{"encoding":"US-ASCII","base64_string":""},"http_version":null},"recorded_at":"Tue, 13 Aug 2013 14:34:50 GMT"}],"recorded_with":"VCR 2.4.0"}

data/spec/helper.rb

@@ -7,6 +7,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 SimpleCov.start
 
+require 'json'
 require 'octokit'
 require 'rspec'
 require 'webmock/rspec'

data/spec/octokit/client/legacy_search_spec.rb

@@ -32,9 +32,9 @@ describe Octokit::Client::LegacySearch do
     it "should not raise URI::InvalidURIError and returns success" do
       VCR.eject_cassette
       VCR.turn_off!
-      stub_get("https://api.github.com/legacy/user/search/follower:>0")
-      expect { @client.legacy_search_users("follower:>0") }.to_not raise_error
-      assert_requested :get, github_url("/legacy/user/search/follower:%3E0")
+      stub_get("https://api.github.com/legacy/user/search/followers:>0")
+      expect { @client.legacy_search_users("followers:>0") }.to_not raise_error(URI::InvalidURIError)
+      assert_requested :get, github_url("/legacy/user/search/followers:%3E0")
       VCR.turn_on!
     end
   end # .legacy_searcy_users

data/spec/octokit/client/users_spec.rb

@@ -65,11 +65,16 @@ describe Octokit::Client::Users do
     end
   end # .following
 
-  describe ".follows?", :vcr do
+  describe ".follows?", :vcr, :match_requests_on => [:uri] do
     it "checks if the authenticated user follows another" do
       follows = @client.follows?("sferik")
       assert_requested :get, github_url("/user/following/sferik")
     end
+
+    it "checks if given user is following target user" do
+      follows = @client.follows?("sferik", "pengwynn")
+      assert_requested :get, github_url("/users/sferik/following/pengwynn")
+    end
   end # .follows?
 
   describe ".follow", :vcr do

data/spec/octokit/client_spec.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'json'
 
 describe Octokit::Client do
 
@@ -250,6 +251,7 @@ describe Octokit::Client do
 
   describe ".root" do
     it "fetches the API root" do
+      Octokit.reset!
       VCR.use_cassette 'root' do
         root = Octokit.client.root
         expect(root.rels[:issues].href).to eq "https://api.github.com/issues"
@@ -367,30 +369,103 @@ describe Octokit::Client do
   end
 
   context "error handling" do
-    before(:each) do
+    before do
       Octokit.reset!
+      VCR.turn_off!
+    end
+
+    after do
+      VCR.turn_on!
     end
 
-    it "raises on 404", :vcr do
-      expect { Octokit.get('/user') }.to raise_error Octokit::Unauthorized
+    it "raises on 404" do
+      stub_get('/booya').to_return(:status => 404)
+      expect { Octokit.get('/booya') }.to raise_error Octokit::NotFound
     end
 
     it "raises on 500" do
-      VCR.turn_off!
       stub_get('/boom').to_return(:status => 500)
       expect { Octokit.get('/boom') }.to raise_error Octokit::InternalServerError
-      VCR.turn_on!
     end
 
-    it "includes an error message" do
+    it "includes a message" do
       stub_get('/boom').
-        to_return(:status => 422, :body => '{"message":"No repository found for hub.topic: https://github.com/joshk/not_existing_project/events/push"}')
+        to_return \
+        :status => 422,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {:message => "No repository found for hubtopic"}.to_json
       begin
         Octokit.get('/boom')
       rescue Octokit::UnprocessableEntity => e
-        expect(e.message).to include "GET https://api.github.com/boom: 422"
+        expect(e.message).to include \
+          "GET https://api.github.com/boom: 422 - No repository found"
       end
     end
+
+    it "includes an error" do
+      stub_get('/boom').
+        to_return \
+        :status => 422,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {:error => "No repository found for hubtopic"}.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include \
+          "GET https://api.github.com/boom: 422 - Error: No repository found"
+      end
+    end
+
+    it "includes an error summary" do
+      stub_get('/boom').
+        to_return \
+        :status => 422,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {
+          :message => "Validation Failed",
+          :errors => [
+            :resource => "Issue",
+            :field    => "title",
+            :code     => "missing_field"
+          ]
+        }.to_json
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include \
+          "GET https://api.github.com/boom: 422 - Validation Failed"
+        expect(e.message).to include "  resource: Issue"
+        expect(e.message).to include "  field: title"
+        expect(e.message).to include "  code: missing_field"
+      end
+    end
+
+    it "knows the difference between Forbidden and rate limiting" do
+      stub_get('/some/admin/stuffs').to_return(:status => 403)
+      expect { Octokit.get('/some/admin/stuffs') }.to raise_error Octokit::Forbidden
+
+      stub_get('/users/mojomobo').to_return \
+        :status => 403,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {:message => "API rate limit exceeded"}.to_json
+      expect { Octokit.get('/users/mojomobo') }.to raise_error Octokit::TooManyRequests
+
+      stub_get('/user').to_return \
+        :status => 403,
+        :headers => {
+          :content_type => "application/json",
+        },
+        :body => {:message => "Maximum number of login attempts exceeded"}.to_json
+      expect { Octokit.get('/user') }.to raise_error Octokit::TooManyLoginAttempts
+    end
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0.rc3
   prerelease: 6
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -36,7 +36,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.3.0
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -360,6 +360,7 @@ files:
 - spec/cassettes/Octokit_Client_Users/_followers/returns_the_authenticated_user_s_followers.json
 - spec/cassettes/Octokit_Client_Users/_following/returns_following_for_a_user.json
 - spec/cassettes/Octokit_Client_Users/_following/returns_the_authenticated_user_s_following.json
+- spec/cassettes/Octokit_Client_Users/_follows_/checks_if_given_user_is_following_target_user.json
 - spec/cassettes/Octokit_Client_Users/_follows_/checks_if_the_authenticated_user_follows_another.json
 - spec/cassettes/Octokit_Client_Users/_keys/returns_public_keys_for_the_authenticated_user.json
 - spec/cassettes/Octokit_Client_Users/_remove_email/removes_an_email_address.json
@@ -703,6 +704,7 @@ test_files:
 - spec/cassettes/Octokit_Client_Users/_followers/returns_the_authenticated_user_s_followers.json
 - spec/cassettes/Octokit_Client_Users/_following/returns_following_for_a_user.json
 - spec/cassettes/Octokit_Client_Users/_following/returns_the_authenticated_user_s_following.json
+- spec/cassettes/Octokit_Client_Users/_follows_/checks_if_given_user_is_following_target_user.json
 - spec/cassettes/Octokit_Client_Users/_follows_/checks_if_the_authenticated_user_follows_another.json
 - spec/cassettes/Octokit_Client_Users/_keys/returns_public_keys_for_the_authenticated_user.json
 - spec/cassettes/Octokit_Client_Users/_remove_email/removes_an_email_address.json