github_api_v3 0.3.3 → 0.4.0

data/lib/github_api_v3/client/repos.rb

@@ -13,7 +13,7 @@ module GitHub
       # @return [Array]
       # @see http://developer.github.com/v3/repos/#list-all-public-repositories
       def all_repos
-        get '/repositories', auth_params
+        get '/repositories'
       end
 
       # Get one repository.
@@ -25,7 +25,7 @@ module GitHub
       # @example
       #   GitHub.repo('caseyscarborough','github')
       def repo(owner, repo)
-        get "/repos/#{owner}/#{repo}", auth_params
+        get "/repos/#{owner}/#{repo}"
       end
 
       # Get all repositories for a user.
@@ -43,7 +43,7 @@ module GitHub
         if username
           get "/users/#{username}/repos"
         else
-          get '/user/repos', auth_params
+          get '/user/repos'
         end
       end
 
@@ -67,7 +67,7 @@ module GitHub
       # @example
       #   client.create_repo('new-repo', description: 'New repository.', private: true)
       def create_repo(name, options={})
-        post "/user/repos", auth_params, options.merge(name: name)
+        post "/user/repos", body: options.merge(name: name)
       end
 
       # Edit a repository.
@@ -91,7 +91,7 @@ module GitHub
       #   client.edit_repo('caseyscarborough','github', name: 'github', description: 'An awesome repository!')
       def edit_repo(owner, repo, options={})
         options[:name] = repo unless options[:name]
-        patch "/repos/#{owner}/#{repo}", auth_params, options
+        patch "/repos/#{owner}/#{repo}", body: options
       end
 
       # Delete a repository.
@@ -104,7 +104,7 @@ module GitHub
       # @example
       #   client.delete_repo('repo-name')
       def delete_repo(owner, repo)
-        boolean_delete "/repos/#{owner}/#{repo}", auth_params
+        boolean_request :delete, "/repos/#{owner}/#{repo}"
       end
 
       # Get organization repositories.
@@ -115,7 +115,7 @@ module GitHub
       # @example
       #   GitHub.org_repos('rails')
       def org_repos(org)
-        get "/orgs/#{org}/repos", auth_params
+        get "/orgs/#{org}/repos"
       end
 
       # List contributors for a repository.
@@ -127,7 +127,7 @@ module GitHub
       # @example
       #   GitHub.contributors('caseyscarborough','github')
       def contributors(owner, repo)
-        get "/repos/#{owner}/#{repo}/contributors", auth_params
+        get "/repos/#{owner}/#{repo}/contributors"
       end
 
       # List languages for a repository.
@@ -139,7 +139,7 @@ module GitHub
       # @example
       #   GitHub.languages('caseyscarborough','github')
       def languages(owner, repo)
-        get "/repos/#{owner}/#{repo}/languages", auth_params
+        get "/repos/#{owner}/#{repo}/languages"
       end
 
       # def teams(owner, repo)
@@ -155,7 +155,7 @@ module GitHub
       # @example
       #   GitHub.tags('caseyscarborough','github')
       def tags(owner, repo)
-        get "/repos/#{owner}/#{repo}/tags", auth_params
+        get "/repos/#{owner}/#{repo}/tags"
       end
 
       # List branches for a repository.
@@ -167,7 +167,7 @@ module GitHub
       # @example
       #   GitHub.branches('caseyscarborough','github')
       def branches(owner, repo)
-        get "/repos/#{owner}/#{repo}/branches", auth_params
+        get "/repos/#{owner}/#{repo}/branches"
       end
 
       # Get information about a branch.
@@ -179,7 +179,7 @@ module GitHub
       # @example
       #   GitHub.branch('caseyscarborough','github','master')
       def branch(owner, repo, branch)
-        get "/repos/#{owner}/#{repo}/branches/#{branch}", auth_params
+        get "/repos/#{owner}/#{repo}/branches/#{branch}"
       end
 
       # Get list of collaborators for a repository.
@@ -191,7 +191,7 @@ module GitHub
       # @example
       #   GitHub.collaborators('caseyscarborough','github')
       def collaborators(owner, repo)
-        get "/repos/#{owner}/#{repo}/collaborators", auth_params
+        get "/repos/#{owner}/#{repo}/collaborators"
       end
 
       # Determine if a user is a collaborator to a repository.
@@ -204,7 +204,7 @@ module GitHub
       # @example
       #   GitHub.collaborator?('caseyscarborough','github','caseyscarborough')
       def collaborator?(owner, repo, user)
-        boolean_get "/repos/#{owner}/#{repo}/collaborators/#{user}", auth_params
+        boolean_request :get, "/repos/#{owner}/#{repo}/collaborators/#{user}"
       end
 
       # Add a collaborator to a repository.
@@ -217,7 +217,7 @@ module GitHub
       # @return [Boolean] True if successful, false if not.
       # @see http://developer.github.com/v3/repos/collaborators/#add-collaborator
       def add_collaborator(owner, repo, user)
-        boolean_put "/repos/#{owner}/#{repo}/collaborators/#{user}", auth_params
+        boolean_request :put, "/repos/#{owner}/#{repo}/collaborators/#{user}"
       end
 
       # Remove a collaborator from a repository.
@@ -230,7 +230,7 @@ module GitHub
       # @return [Boolean] True if successful, false if not.
       # @see http://developer.github.com/v3/repos/collaborators/#remove-collaborator
       def remove_collaborator(owner, repo, user)
-        boolean_delete "/repos/#{owner}/#{repo}/collaborators/#{user}", auth_params
+        boolean_request :delete, "/repos/#{owner}/#{repo}/collaborators/#{user}"
       end
 
       # List Stargazers for a repository.
@@ -242,7 +242,7 @@ module GitHub
       # @example
       #   GitHub.stargazers('caseyscarborough','github')
       def stargazers(owner, repo)
-        get "/repos/#{owner}/#{repo}/stargazers", auth_params
+        get "/repos/#{owner}/#{repo}/stargazers"
       end
 
       # Star a repository.
@@ -254,7 +254,7 @@ module GitHub
       # @return [Boolean] True if successful, false if not.
       # @see http://developer.github.com/v3/activity/starring/#star-a-repository
       def star(owner, repo)
-        boolean_put "/user/starred/#{owner}/#{repo}", auth_params
+        boolean_request :put, "/user/starred/#{owner}/#{repo}"
       end
 
       # Unstar a repository.
@@ -266,7 +266,7 @@ module GitHub
       # @return [Boolean] True if successful, false if not.
       # @see http://developer.github.com/v3/activity/starring/#unstar-a-repository
       def unstar(owner, repo)
-        boolean_delete "/user/starred/#{owner}/#{repo}", auth_params
+        boolean_request :delete, "/user/starred/#{owner}/#{repo}"
       end
 
       # List Watchers for a repository.
@@ -276,7 +276,7 @@ module GitHub
       # @return [Array] List of users.
       # @see http://developer.github.com/v3/activity/watching/#list-watchers
       def watchers(owner, repo)
-        get "/repos/#{owner}/#{repo}/subscribers", auth_params
+        get "/repos/#{owner}/#{repo}/subscribers"
       end
 
       # Get subscription information.
@@ -290,7 +290,7 @@ module GitHub
       # @example
       #   client.subscription('caseyscarborough','github')
       def subscription(owner, repo)
-        get "/repos/#{owner}/#{repo}/subscription", auth_params
+        get "/repos/#{owner}/#{repo}/subscription"
       end
 
       # Set a repository subscription.
@@ -306,7 +306,7 @@ module GitHub
       def subscribe(owner, repo, options={})
         options[:subscribed] = true unless options[:subscribed]
         options[:ignored] = false unless options[:ignored]
-        put "/repos/#{owner}/#{repo}/subscription", auth_params, options
+        put "/repos/#{owner}/#{repo}/subscription", body: options
       end
 
       # Delete a repository subscription.
@@ -319,7 +319,7 @@ module GitHub
       # @example
       #   client.unsubscribe('caseyscarborough','github')
       def unsubscribe(owner, repo)
-        boolean_delete "/repos/#{owner}/#{repo}/subscription", auth_params
+        boolean_request :delete, "/repos/#{owner}/#{repo}/subscription"
       end
       
     end

data/lib/github_api_v3/client/stats.rb

@@ -25,7 +25,7 @@ module GitHub
       # @return [Array] Contributor list.
       # @see http://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts
       def contributors_list(owner, repo)
-        get "/repos/#{owner}/#{repo}/stats/contributors", auth_params
+        get "/repos/#{owner}/#{repo}/stats/contributors"
       end
 
       # Get the last year of commit activity data.
@@ -35,7 +35,7 @@ module GitHub
       # @return [Array] Commit activity list.
       # @see http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
       def commit_activity(owner, repo)
-        get "/repos/#{owner}/#{repo}/stats/commit_activity", auth_params
+        get "/repos/#{owner}/#{repo}/stats/commit_activity"
       end
 
       # Get the number of additions and deletions per week.
@@ -45,7 +45,7 @@ module GitHub
       # @return [Array]
       # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week
       def code_frequency(owner, repo)
-        get "/repos/#{owner}/#{repo}/stats/code_frequency", auth_params
+        get "/repos/#{owner}/#{repo}/stats/code_frequency"
       end
 
       # Get the weekly commit count for the repo owner and everyone else.
@@ -55,7 +55,7 @@ module GitHub
       # @return [Array] Contributor list.
       # @see http://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else
       def participation(owner, repo)
-        get "/repos/#{owner}/#{repo}/stats/participation", auth_params
+        get "/repos/#{owner}/#{repo}/stats/participation"
       end
 
       # Get the number of commits per hour in each day.
@@ -65,7 +65,7 @@ module GitHub
       # @return [Array]
       # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day
       def punch_card(owner, repo)
-        get "/repos/#{owner}/#{repo}/stats/punch_card", auth_params
+        get "/repos/#{owner}/#{repo}/stats/punch_card"
       end
 
     end

data/lib/github_api_v3/client/users.rb

@@ -21,7 +21,7 @@
         if username
           get "/users/#{username}"
         else
-          get '/user', auth_params
+          get '/user'
         end
       end
 
@@ -41,7 +41,7 @@
       #   client = GitHub::Client.new(login: 'username', access_token: 'abcdefghijklmnopqrstuvwxyz12345')
       #   client.emails # => ["email@example.com", "email2@example.com"]
       def emails
-        get '/user/emails', auth_params
+        get '/user/emails'
       end
 
       # Follow a user.
@@ -54,7 +54,7 @@
       # @example
       #   client.follow('caseyscarborough')
       def follow(username)
-        boolean_put "/user/following/#{username}", auth_params
+        boolean_request :put, "/user/following/#{username}"
       end
 
       # Checks to see if a user is following another user.
@@ -66,8 +66,7 @@
       # @example
       #   GitHub.follows?('caseyscarborough', 'matz')
       def follows?(username, target_username)
-        response = self.class.get "/users/#{username}/following/#{target_username}"
-        response.code == 204
+        boolean_request :get, "/users/#{username}/following/#{target_username}"
       end
 
       # List a user's followers.
@@ -87,7 +86,7 @@
         if username
           get "/users/#{username}/followers"
         else
-          get '/user/followers', auth_params
+          get '/user/followers'
         end
       end
 
@@ -111,8 +110,7 @@
       # @example
       #   client.following?('caseyscarborough')
       def following?(username)
-        response = self.class.get "/user/following/#{username}", query: auth_params
-        response.code == 204
+        boolean_request :get, "/user/following/#{username}"
       end
 
       # Unfollow a user.
@@ -124,7 +122,7 @@
       # @example
       #   client.unfollow('matz')
       def unfollow(username)
-        boolean_delete "/user/following/#{username}", auth_params
+        boolean_request :delete, "/user/following/#{username}"
       end
 
       # Get a list of public keys for a user.
@@ -141,7 +139,7 @@
         if username
           get "/users/#{username}/keys"
         else
-          get '/user/keys', auth_params
+          get '/user/keys'
         end
       end
 
@@ -154,7 +152,7 @@
       # @example
       #   client.key(123)
       def key(id)
-        get "/user/keys/#{id}", auth_params
+        get "/user/keys/#{id}"
       end
 
       # Create a public key.
@@ -168,7 +166,7 @@
       # @example
       #   client.create_key('octocat@octomac', 'ssh-rsa AAA...')
       def create_key(title, key)
-        post '/user/keys', auth_params, {title: title, key: key}
+        post '/user/keys', body: {title: title, key: key}
       end
 
       # Update a public key
@@ -183,7 +181,7 @@
       # @example
       #   client.update_key(1, 'octocat@octomac', 'ssh-rsa AAA...')
       def update_key(id, title, key)
-        patch "/user/keys/#{id}", auth_params, {title: title, key: key}
+        patch "/user/keys/#{id}", body: {title: title, key: key}
       end
 
       # Remove a public key from a user's account.
@@ -195,7 +193,7 @@
       # @example
       #   client.delete_key(123)
       def delete_key(id)
-        boolean_delete "/user/keys/#{id}", auth_params
+        boolean_request :delete, "/user/keys/#{id}"
       end
 
       # List notifications.
@@ -211,7 +209,7 @@
       # @example
       #   client.notifications
       def notifications(options={})
-        get "/notifications", auth_params.merge(options)
+        get "/notifications", params: options
       end
 
       # List notifications for a repository.
@@ -229,7 +227,7 @@
       # @example
       #   client.repo_notifications('caseyscarborough','github')
       def repo_notifications(owner, repo, options={})
-        get "/repos/#{owner}/#{repo}/notifications", auth_params
+        get "/repos/#{owner}/#{repo}/notifications"
       end
 
       # List repositories a user is starring.
@@ -247,7 +245,7 @@
         if username
           get "/users/#{username}/starred"
         else
-          get "/user/starred", auth_params
+          get "/user/starred"
         end
       end
 
@@ -262,7 +260,7 @@
       # @example
       #   client.starring?('caseyscarborough','github')
       def starring?(owner, repo)
-        boolean_get "/user/starred/#{owner}/#{repo}", auth_params
+        boolean_request :get, "/user/starred/#{owner}/#{repo}"
       end
 
       # List repositories a user is watching.
@@ -278,7 +276,7 @@
         if username
           get "/users/#{username}/subscriptions"
         else
-          get "/user/subscriptions", auth_params
+          get "/user/subscriptions"
         end
       end
 
@@ -295,10 +293,22 @@
         if username
           get "/users/#{username}/orgs"
         else
-          get "/user/orgs", auth_params
+          get "/user/orgs"
         end
       end
 
+      # Get the current client's rate limit info.
+      #
+      # @return [Hash] The rate limit information.
+      # @see http://developer.github.com/v3/rate_limit/
+      # @example Unauthenticated client's rate limit.
+      #   GitHub.rate_limit
+      # @example Authenticated client's rate limit.
+      #   client.rate_limit
+      def rate_limit
+        get "/rate_limit"
+      end
+
     end
   
   end

data/lib/github_api_v3/client.rb

@@ -1,3 +1,4 @@
+require 'base64'
 require 'json'
 require 'github_api_v3/client/events'
 require 'github_api_v3/client/feeds'
@@ -5,6 +6,7 @@ require 'github_api_v3/client/gists'
 require 'github_api_v3/client/gitignore'
 require 'github_api_v3/client/issues'
 require 'github_api_v3/client/markdown'
+require 'github_api_v3/client/oauth'
 require 'github_api_v3/client/orgs'
 require 'github_api_v3/client/pull_requests'
 require 'github_api_v3/client/repos'
@@ -29,13 +31,14 @@ module GitHub
     include GitHub::Client::Gists
     include GitHub::Client::Issues
     include GitHub::Client::Markdown
+    include GitHub::Client::OAuth
     include GitHub::Client::Orgs
     include GitHub::Client::PullRequests
     include GitHub::Client::Repos
     include GitHub::Client::Stats
     include GitHub::Client::Users
 
-    attr_reader :login, :access_token
+    attr_accessor :login, :access_token, :password
 
     def initialize(options={})
       @login = options[:login]
@@ -48,98 +51,48 @@ module GitHub
       # Perform a get request.
       #
       # @return [Hash, Array, String]
-      def get(url, params={})
-        response = self.class.get url, query: params
+      def get(url, options={})
+        response = request :get, url, options
         handle_response(response)
         response.parsed_response
       end
 
-      # Perform a get request with boolean return type.
-      #
-      # @return [Boolean]
-      def boolean_get(url, params={})
-        response = self.class.get url, query: params
-        response.code == 204
-      rescue GitHub::NotFound
-        false
-      end
-
       # Perform a put request.
       #
       # @return [Hash, Array, String]
-      def put(url, params={}, body={})
-        response = self.class.put url, query: params, body: body.to_json
+      def put(url, options={})
+        response = request :put, url, options
         handle_response(response)
         response.parsed_response
       end
 
-      # Perform a put request with boolean return type.
-      #
-      # @return [Boolean]
-      def boolean_put(url, params={}, body={})
-        response = self.class.put url, query: params, body: body.to_json
-        response.code == 204
-      rescue GitHub::NotFound
-        false
-      end
-
       # Perform a post request.
       #
       # @return [Hash, Array, String]
-      def post(url, params={}, body={})
-        response = self.class.post url, query: params, body: body.to_json
+      def post(url, options={})
+        response = request :post, url, options
         handle_response(response)
         response.parsed_response
       end
 
-      # Perform a post request with boolean return type.
-      #
-      # @return [Boolean]
-      def boolean_post(url, params={}, body={})
-        response = self.class.post url, query: params, body: body.to_json
-        response.code == 204
-      rescue GitHub::NotFound
-        false
-      end
-
       # Perform a patch request.
       #
       # @return [Hash, Array, String]
-      def patch(url, params={}, body={})
-        response = self.class.patch url, query: params, body: body.to_json
+      def patch(url, options={})
+        response = request :patch, url, options
         handle_response(response)
         response.parsed_response
       end
 
-      # Perform a patch request with boolean return type.
-      #
-      # @return [Boolean]
-      def boolean_patch(url, params={}, body={})
-        response = self.class.patch url, query: params, body: body.to_json
-        response.code == 204
-      rescue GitHub::NotFound
-        false
-      end
-
       # Perform a delete request.
       #
       # @return [Hash, Array, String]
-      def delete(url, params={})
-        response = self.class.delete url, query: params
+      def delete(url, options={})
+        response = request :delete, url, options
         handle_response(response)
         response.parsed_response
       end
 
-      # Perform a delete request with boolean return type.
-      #
-      # @return [Boolean]
-      def boolean_delete(url, params={})
-        response = self.class.delete url, query: params
-        response.code == 204
-      rescue GitHub::NotFound
-        false
-      end
-
       # Return a hash with client's login and password.
       #
       # @return [Hash]
@@ -154,6 +107,51 @@ module GitHub
         @login.nil? ? {} : { login: @login, access_token: @access_token }
       end
 
+      def basic_auth_headers
+        encoded_auth = Base64.encode64("#{@login}:#{@password}")
+        { 'Authorization' => "Basic #{encoded_auth}" }
+      end
+
+      # Send an HTTP request.
+      #
+      # @param method [Symbol] The request type, such as :get, :put, or :post.
+      # @param url [String] The URL to send the request to.
+      # @param options [Hash] Optional parameters.
+      # @option options [Hash] :params URL parameters.
+      # @option options [Hash] :headers Headers to send with the request.
+      # @option options [Hash] :body Body of the request.
+      # @return [Array, Hash]
+      # @example POST request
+      #   request :post, 'http://example.com/users', params: { name: 'Casey' }, body: { example: 'example' }
+      def request(method, url, options={})
+        params  = options[:params]  || {}
+        headers = options[:headers] || {}
+        body    = options[:body]    || {}
+
+        params.merge!(auth_params)
+        headers.merge!(basic_auth_headers) if @login && @password
+
+        self.class.send(method, url, query: params, body: body.to_json, headers: headers)
+      end
+
+      # Get a boolean response from an HTTP request.
+      #
+      # @param method [Symbol] The request type, such as :get, :put, or :post.
+      # @param url [String] The URL to send the request to.
+      # @param options [Hash] Optional parameters.
+      # @option options [Hash] :params URL parameters.
+      # @option options [Hash] :headers Headers to send with the request.
+      # @option options [Hash] :body Body of the request.
+      # @return [Boolean]
+      # @example DELETE Request
+      #   boolean_request :delete, 'http://example.com/users'
+      def boolean_request(method, url, options={})
+        response = request(method, url, options)
+        response.code == 204
+      rescue GitHub::NotFound
+        false
+      end
+
       # Handle HTTP responses.
       #
       # Raise proper exceptions based on the response code.
@@ -161,11 +159,22 @@ module GitHub
       # @return [HTTParty::Response]
       def handle_response(response)
         case response.code
+        when 400 then raise BadRequest
         when 401 then raise Unauthorized
-        when 403 then raise RateLimitExceeded
+        when 403 
+          if response.body =~ /rate limit/i
+            raise RateLimitExceeded
+          elsif response.body =~ /login attempts/i
+            raise LoginAttemptsExceeded
+          else
+            raise Forbidden
+          end
         when 404 then raise NotFound
-        when 400..500 then raise ClientError
-        when 500..600 then raise ServerError, response.code
+        when 400...500 then raise ClientError
+        when 500 then raise InternalServerError
+        when 502 then raise BadGateway
+        when 503 then raise ServiceUnavailable
+        when 500...600 then raise ServerError, response.code
         else
           response
         end

data/lib/github_api_v3/error.rb

@@ -3,6 +3,9 @@ module GitHub
   # Default GitHub error.
   class GitHubError < StandardError; end
 
+  # Raised when a 400 HTTP status code is received.
+  class BadRequest < GitHubError; end
+
   # Raised when a 404 HTTP status code is received.
   class NotFound < GitHubError; end
 
@@ -15,10 +18,25 @@ module GitHub
   # Raised when a 403 HTTP status code is received.
   class RateLimitExceeded < GitHubError; end
 
-  # Raised when a 500..600 HTTP status code is received.
+  # Raised when a 403 HTTP status code is received.
+  class LoginAttemptsExceeded < GitHubError; end
+
+  # Raised when a 403 HTTP status code is received.
+  class Forbidden < GitHubError; end
+
+  # Raised when a 500 HTTP status code is received.
+  class InternalServerError < GitHubError; end
+
+  # Raised when a 502 HTTP status code is received.
+  class BadGateway < GitHubError; end
+
+  # Raised when a 503 HTTP status code is received.
+  class ServiceUnavailable < GitHubError; end
+
+  # Raised when a 500...600 HTTP status code is received.
   class ServerError < GitHubError; end
 
-  # Raised when a 400..500 HTTP status code is received.
+  # Raised when a 400...500 HTTP status code is received.
   class ClientError < GitHubError; end
   
 end

data/lib/github_api_v3/version.rb

@@ -1,3 +1,3 @@
 module GitHub
-  VERSION = '0.3.3'
+  VERSION = '0.4.0'
 end

data/lib/github_api_v3.rb

@@ -8,8 +8,8 @@ module GitHub
 
   class << self
     
-    def client
-      @client = Client.new unless @client
+    def client(options={})
+      @client = Client.new(options) unless @client
       @client
     end