github_api 0.4.4 → 0.4.5

data/features/error_codes.feature

@@ -10,4 +10,4 @@ Feature: Handles HTTP error codes
       And I pass the following request options:
         | name       |
         | basic_auth |
-    Then request should fail with "Github::Unauthorised" within a cassette named "errors/repos/create"
+    Then request should fail with "Github::Error::Unauthorized" within a cassette named "errors/repos/create"

data/lib/github_api/error.rb

@@ -1,38 +1,31 @@
 # encoding: utf-8
 
 module Github
-  class Error < StandardError
-    attr_reader :response_message, :response_headers
-
-    def initialize(message, headers)
-      @response_message = message
-      super message
-    end
-
-    def inspect
-      %(#<#{self.class}>)
+  module Error
+    class GithubError < StandardError
+      attr_reader :response_message, :response_headers
+
+      def initialize(message)
+        super message
+        @response_message = message
+      end
+
+#       def inspect
+#         %(#<#{self.class}>)
+#       end
     end
   end # Error
-
-  # Raised when Github returns the HTTP status code 400
-  class BadRequest < Error; end
-
-  # Raised when Github returns the HTTP status code 401
-  class Unauthorised < Error; end
-
-  # Raised when Github returns the HTTP status code 403
-  class Forbidden < Error; end
-
-  # Raised when Github returns the HTTP status code 404
-  class ResourceNotFound < Error; end
-
-  # Raised when Github returns the HTTP status code 422
-  class UnprocessableEntity < Error; end
-
-  # Raised when Github returns the HTTP status code 500
-  class InternalServerError < Error; end
-
-  # Raised when Github returns the HTTP status code 503
-  class ServiceUnavailable < Error; end
-
 end # Github
+
+%w[
+  service_error
+  not_found
+  forbidden
+  bad_request
+  unauthorized
+  service_unavailable
+  internal_server_error
+  unprocessable_entity
+].each do |error|
+  require "github_api/error/#{error}"
+end

data/lib/github_api/error/bad_request.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github
+  module Error
+    # Raised when Github returns the HTTP status code 400
+    class BadRequest < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end
+end # Github

data/lib/github_api/error/forbidden.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 403
+  module Error
+    class Forbidden < GithubError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/internal_server_error.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 500
+  module Error
+    class InternalServerError < GithubError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/not_found.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 404
+  module Error
+    class NotFound < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/service_error.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 404
+  module Error
+    class ServiceError < GithubError
+      attr_accessor :http_headers
+
+      def initialize(env)
+        super(generate_message(env))
+        @http_headers = env[:response_headers]
+      end
+
+      def generate_message(env)
+        "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]} #{env[:body]}"
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/service_unavailable.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 404
+  module Error
+    class ServiceUnavailable < GithubError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/unauthorized.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 401
+  module Error
+    class Unauthorized < GithubError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/error/unprocessable_entity.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Github #:nodoc
+  # Raised when Github returns the HTTP status code 422
+  module Error
+    class UnprocessableEntity < GithubError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # Github

data/lib/github_api/gists.rb

@@ -187,7 +187,7 @@ module Github
 
       get("/gists/#{gist_id}/star", params)
       true
-    rescue Github::ResourceNotFound
+    rescue Github::Error::NotFound
       false
     end
 

data/lib/github_api/orgs/members.rb

@@ -37,7 +37,7 @@ module Github
         _normalize_params_keys(params)
         get("/orgs/#{org_name}/members/#{member_name}", params)
         true
-      rescue Github::ResourceNotFound
+      rescue Github::Error::NotFound
         false
       end
       alias :is_member? :member?
@@ -84,7 +84,7 @@ module Github
         _normalize_params_keys(params)
         get("/orgs/#{org_name}/public_members/#{member_name}", params)
         true
-      rescue Github::ResourceNotFound
+      rescue Github::Error::NotFound
         false
       end
 

data/lib/github_api/orgs/teams.rb

@@ -142,7 +142,7 @@ module Github
         _normalize_params_keys(params)
         get("/teams/#{team_name}/members/#{member_name}", params)
         true
-      rescue Github::ResourceNotFound
+      rescue Github::Error::NotFound
         false
       end
 
@@ -204,7 +204,7 @@ module Github
         _normalize_params_keys(params)
         get("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
         true
-      rescue Github::ResourceNotFound
+      rescue Github::Error::NotFound
         false
       end
       alias :team_repository? :team_repo?

data/lib/github_api/pull_requests.rb

@@ -40,7 +40,7 @@ module Github
     #  @pull_reqs = Github::PullRequests.new
     #  @pull_reqs.pull_requests 'user-name', 'repo-name'
     #
-    def pull_requests(user_name=nil, repo_name=nil, params={})
+    def pull_requests(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless (user? && repo?)
 
@@ -53,6 +53,8 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :pulls :pull_requests
+    alias :requests :pull_requests
 
     # Get a single pull request
     #
@@ -73,6 +75,7 @@ module Github
 
       get("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
     end
+    alias :get_pull_request :pull_request
 
     # Create a pull request
     #
@@ -103,7 +106,7 @@ module Github
     #    "head" => "octocat:new-feature",
     #    "base" => "master"
     #
-    def create_request(user_name=nil, repo_name=nil, params={})
+    def create_request(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
@@ -113,6 +116,7 @@ module Github
 
       post("/repos/#{user}/#{repo}/pulls", params)
     end
+    alias :create_pull_request :create_request
 
     # Update a pull request
     #
@@ -140,14 +144,15 @@ module Github
 
       patch("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
     end
+    alias :update_pull_request :update_request
 
     # List commits on a pull request
     #
     # = Examples
     #  @github = Github.new
-    #  @github.pull_requests.request_commits 'user-name', 'repo-name', 'request-id'
+    #  @github.pull_requests.commits 'user-name', 'repo-name', 'request-id'
     #
-    def request_commits(user_name, repo_name, request_id, params={})
+    def commits(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of request_id
@@ -159,6 +164,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :request_commits :commits
 
     # List pull requests files
     #
@@ -166,7 +172,7 @@ module Github
     #  @github = Github.new
     #  @github.pull_requests.request_files 'user-name', 'repo-name', 'request-id'
     #
-    def request_files(user_name, repo_name, request_id, params={})
+    def files(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of request_id
@@ -178,6 +184,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
+    alias :request_files :files
 
     # Check if pull request has been merged
     #
@@ -195,7 +202,7 @@ module Github
 
       get("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
       true
-    rescue Github::ResourceNotFound
+    rescue Github::Error::NotFound
       false
     end
 
@@ -206,7 +213,7 @@ module Github
     #
     # = Examples
     #  @github = Github.new
-    #  @github.pull_requests.request_files 'user-name', 'repo-name', 'request-id'
+    #  @github.pull_requests.merge 'user-name', 'repo-name', 'request-id'
     #
     def merge(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)

data/lib/github_api/pull_requests/comments.rb

@@ -18,9 +18,9 @@ module Github
       #
       # = Examples
       #  @github = Github.new
-      #  @github.pull_requests.request_comments 'user-name', 'repo-name', 'request-id'
+      #  @github.pull_requests.comments 'user-name', 'repo-name', 'request-id'
       #
-      def request_comments(user_name, repo_name, request_id, params={})
+      def comments(user_name, repo_name, request_id, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of request_id
@@ -32,13 +32,14 @@ module Github
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :request_comments :comments
 
       # Get a single comment for pull requests
       # = Examples
       #  @github = Github.new
-      #  @github.pull_requests.request_comment 'user-name', 'repo-name', 'comment-id'
+      #  @github.pull_requests.comment 'user-name', 'repo-name', 'comment-id'
       #
-      def request_comment(user_name, repo_name, comment_id, params={})
+      def comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of comment_id
@@ -48,6 +49,8 @@ module Github
 
         get("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
       end
+      alias :request_comment :comment
+      alias :get_comment :comment
 
       # Create a pull request comment
       #
@@ -59,7 +62,8 @@ module Github
       #
       # = Examples
       #  @github = Github.new
-      #  @github.pull_requests.create_request_comment 'user-name', 'repo-name', 'request-id', "body" => "Nice change",
+      #  @github.pull_requests.create_comment 'user-name','repo-name','request-id',
+      #   "body" => "Nice change",
       #   "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
       #   "path" => "file1.txt",
       #   "position" => 4
@@ -72,10 +76,11 @@ module Github
       #
       # = Examples
       #  @github = Github.new
-      #  @github.pull_requests.create_request_comment 'user-name', 'repo-name', 'request-id', "body" => "Nice change",
-      #   "in_reply_to" => 4
+      #  @github.pull_requests.create_comment 'user-name','repo-name','request-id',
+      #    "body" => "Nice change",
+      #    "in_reply_to" => 4
       #
-      def create_request_comment(user_name, repo_name, request_id, params={})
+      def create_comment(user_name, repo_name, request_id, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of request_id
@@ -83,7 +88,7 @@ module Github
         _normalize_params_keys(params)
         _merge_mime_type(:pull_comment, params)
         _filter_params_keys(VALID_REQUEST_COM_PARAM_NAMES, params)
-        _validate_reply_to(params)
+        # _validate_reply_to(params)
 
         post("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
       end
@@ -95,9 +100,10 @@ module Github
       #
       # = Examples
       #  @github = Github.new
-      #  @github.pull_requests.edit_request_comment 'user-name', 'repo-name', 'comment-id', "body" => "Nice change",
+      #  @github.pull_requests.edit_comment 'user-name', 'repo-name','comment-id',
+      #    "body" => "Nice change"
       #
-      def edit_request_comment(user_name, repo_name, comment_id, params={})
+      def edit_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of comment_id
@@ -113,10 +119,9 @@ module Github
       #
       # = Examples
       #  @github = Github.new
-      #  @github.pull_requests.delete_request_comment 'user-name', 'repo-name',
-      #     'comment-id'
+      #  @github.pull_requests.delete_comment 'user-name', 'repo-name','comment-id'
       #
-      def delete_request_comment(user_name, repo_name, comment_id, params={})
+      def delete_comment(user_name, repo_name, comment_id, params={})
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of comment_id

data/lib/github_api/repos/collaborators.rb

@@ -37,7 +37,7 @@ module Github
 
         get("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
         true
-      rescue Github::ResourceNotFound
+      rescue Github::Error::NotFound
         false
       end
 

data/lib/github_api/repos/watching.rb

@@ -59,7 +59,7 @@ module Github
         _normalize_params_keys(params)
         get("/user/watched/#{user_name}/#{repo_name}", params)
         true
-      rescue Github::ResourceNotFound
+      rescue Github::Error::NotFound
         false
       end