github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/paged_request.rb

@@ -33,7 +33,7 @@ module Github
       Github::PagedRequest.page = params[PARAM_PAGE]
       Github::PagedRequest.per_page = params[PARAM_PER_PAGE]
 
-      Github.api_client.get path, params
+      Github.api_client.get_request path, params
     end
 
   end # PagedRequest

data/lib/github_api/pull_requests.rb

@@ -7,8 +7,6 @@ module Github
     autoload_all 'github_api/pull_requests',
       :Comments => 'comments'
 
-    include Github::PullRequests::Comments
-
     VALID_REQUEST_PARAM_NAMES = %w[
       title
       body
@@ -30,17 +28,22 @@ module Github
       super(options)
     end
 
+    # Access to PullRequests::Comments API
+    def comments
+      @comments ||= ApiFactory.new 'PullRequests::Comments'
+    end
+
     # List pull requests
     #
     # = Examples
-    #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  @github.pull_requests.pull_requests
-    #  @github.pull_requests.pull_requests { |req| ... }
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.pull_requests.list
+    #  github.pull_requests.list { |req| ... }
     #
-    #  @pull_reqs = Github::PullRequests.new
-    #  @pull_reqs.pull_requests 'user-name', 'repo-name'
+    #  pull_reqs = Github::PullRequests.new
+    #  pull_reqs.pull_requests.list 'user-name', 'repo-name'
     #
-    def pull_requests(user_name, repo_name, params={})
+    def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless (user? && repo?)
 
@@ -49,23 +52,22 @@ module Github
       # _merge_mime_type(:pull_request, params)
       _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
 
-      response = get("/repos/#{user}/#{repo}/pulls", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :pulls :pull_requests
-    alias :requests :pull_requests
+    alias :all :list
 
     # Get a single pull request
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.pull_requests.pull_request 'user-name', 'repo-name', 'request-id'
+    #  github = Github.new
+    #  github.pull_requests.get 'user-name', 'repo-name', 'request-id'
     #
     #  @pull_reqs = Github::PullRequests.new
-    #  @pull_reqs.pull_request 'user-name', 'repo-name', 'request-id'
+    #  @pull_reqs.get 'user-name', 'repo-name', 'request-id'
     #
-    def pull_request(user_name, repo_name, request_id, params={})
+    def get(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
@@ -73,9 +75,9 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:pull_request, params)
 
-      get("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
+      get_request("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
     end
-    alias :get_pull_request :pull_request
+    alias :find :get
 
     # Create a pull request
     #
@@ -92,8 +94,8 @@ module Github
     # * <tt>issue</tt> - Required number - Issue number in this repository to turn into a Pull Request.
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.pull_requests.create_request 'user-name', 'repo-name',
+    #  github = Github.new :oauth_token => '...'
+    #  github.pull_requests.create 'user-name', 'repo-name',
     #    "title" => "Amazing new feature",
     #    "body" => "Please pull this in!",
     #    "head" => "octocat:new-feature",
@@ -101,12 +103,12 @@ module Github
     #
     # alternatively
     #
-    #  @github.pull_requests.create_request 'user-name', 'repo-name',
+    #  @github.pull_requests.create 'user-name', 'repo-name',
     #    "issue" => "5",
     #    "head" => "octocat:new-feature",
     #    "base" => "master"
     #
-    def create_request(user_name, repo_name, params={})
+    def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
@@ -114,9 +116,8 @@ module Github
       # _merge_mime_type(:pull_request, params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
 
-      post("/repos/#{user}/#{repo}/pulls", params)
+      post_request("/repos/#{user}/#{repo}/pulls", params)
     end
-    alias :create_pull_request :create_request
 
     # Update a pull request
     #
@@ -126,13 +127,13 @@ module Github
     # * <tt>:state</tt> - Optional string - State of this Pull Request. Valid values are <tt>open</tt> and <tt>closed</tt>.
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.pull_requests.update_request 'user-name', 'repo-name', 'request-id'
+    #  github = Github.new :oauth_token => '...'
+    #  github.pull_requests.update 'user-name', 'repo-name', 'request-id'
     #    "title" => "Amazing new title",
     #    "body" => "Update body",
     #    "state" => "open",
     #
-    def update_request(user_name, repo_name, request_id, params={})
+    def update(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
@@ -142,15 +143,14 @@ module Github
       # _merge_mime_type(:pull_request, params)
       _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
 
-      patch("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
+      patch_request("/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.commits 'user-name', 'repo-name', 'request-id'
+    #  github = Github.new
+    #  github.pull_requests.commits 'user-name', 'repo-name', 'request-id'
     #
     def commits(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
@@ -160,17 +160,16 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:pull_request, params)
 
-      response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/commits", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/commits", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :request_commits :commits
 
     # List pull requests files
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.pull_requests.request_files 'user-name', 'repo-name', 'request-id'
+    #  github = Github.new
+    #  github.pull_requests.files 'user-name', 'repo-name', 'request-id'
     #
     def files(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
@@ -180,17 +179,16 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:pull_request, params)
 
-      response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/files", params)
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/files", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :request_files :files
 
     # Check if pull request has been merged
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.pull_requests.merged? 'user-name', 'repo-name', 'request-id'
+    #  github = Github.new
+    #  github.pull_requests.merged? 'user-name', 'repo-name', 'request-id'
     #
     def merged?(user_name, repo_name, request_id, params={})
       _update_user_repo_params(user_name, repo_name)
@@ -200,7 +198,7 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:pull_request, params)
 
-      get("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
+      get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
       true
     rescue Github::Error::NotFound
       false
@@ -212,8 +210,8 @@ module Github
     #  <tt>:commit_message</tt> - Optional string - The message that will be used for the merge commit
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.pull_requests.merge 'user-name', 'repo-name', 'request-id'
+    #  github = Github.new
+    #  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)
@@ -224,7 +222,7 @@ module Github
       # _merge_mime_type(:pull_request, params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
 
-      put("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
+      put_request("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
     end
 
   end # PullRequests

data/lib/github_api/pull_requests/comments.rb

@@ -1,149 +1,146 @@
 # encoding: utf-8
 
 module Github
-  class PullRequests
-    module Comments
-
-      VALID_REQUEST_COM_PARAM_NAMES = %w[
-        body
-        commit_id
-        path
-        position
-        in_reply_to
-        mime_type
-        resource
-      ].freeze
-
-      # List comments on a pull request
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.pull_requests.comments 'user-name', 'repo-name', 'request-id'
-      #
-      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
-
-        _normalize_params_keys(params)
-        # _merge_mime_type(:pull_comment, params)
-
-        response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
-        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.comment 'user-name', 'repo-name', 'comment-id'
-      #
-      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
-
-        _normalize_params_keys(params)
-        # _merge_mime_type(:pull_comment, params)
-
-        get("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
-      end
-      alias :request_comment :comment
-      alias :get_comment :comment
-
-      # Create a pull request comment
-      #
-      # = Inputs
-      # * <tt>:body</tt> - Required string
-      # * <tt>:commit_id</tt> - Required string - sha of the commit to comment on.
-      # * <tt>:path</tt> - Required string - Relative path of the file to comment on.
-      # * <tt>:position</tt> - Required number - Line index in the diff to comment on
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.pull_requests.create_comment 'user-name','repo-name','request-id',
-      #   "body" => "Nice change",
-      #   "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
-      #   "path" => "file1.txt",
-      #   "position" => 4
-      #
-      # = Alternative Inputs
-      # Instead of passing commit_id, path, and position you can reply to
-      # an existing Pull Request Comment like this
-      # * <tt>:body</tt> - Required string
-      # * <tt>:in_reply_to</tt> - Required number - comment id to reply to.
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.pull_requests.create_comment 'user-name','repo-name','request-id',
-      #    "body" => "Nice change",
-      #    "in_reply_to" => 4
-      #
-      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
-
-        _normalize_params_keys(params)
-        # _merge_mime_type(:pull_comment, params)
-        _filter_params_keys(VALID_REQUEST_COM_PARAM_NAMES, params)
-        # _validate_reply_to(params)
-
-        post("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
-      end
-
-      # Edit a pull request comment
-      #
-      # = Inputs
-      # * <tt>:body</tt> - Required string
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.pull_requests.edit_comment 'user-name', 'repo-name','comment-id',
-      #    "body" => "Nice change"
-      #
-      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
-
-        _normalize_params_keys(params)
-        # _merge_mime_type(:pull_comment, params)
-        _filter_params_keys(VALID_REQUEST_COM_PARAM_NAMES, params)
-
-        patch("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
-      end
-
-      # Delete a pull request comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.pull_requests.delete_comment 'user-name', 'repo-name','comment-id'
-      #
-      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
-
-        _normalize_params_keys(params)
-        # _merge_mime_type(:pull_comment, params)
-
-        delete("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
-      end
-
-    private
-
-      # To let user know that the params supplied are wrong before request is made
-      def _validate_reply_to(params)
-        if params['in_reply_to'] && !_validate_inputs(%w[ body in_reply_to ], params)
-          raise ArgumentError, "Required params are: #{%w[ body in_reply_to].join(',')}"
-
-        elsif !_validate_inputs(VALID_REQUEST_COM_PARAM_NAMES - %w[ in_reply_to ], params)
-          raise ArgumentError, "Required params are: #{VALID_REQUEST_COM_PARAM_NAMES.join(', ')}"
-        end
+  class PullRequests::Comments < API
+
+    VALID_REQUEST_COM_PARAM_NAMES = %w[
+      body
+      commit_id
+      path
+      position
+      in_reply_to
+      mime_type
+      resource
+    ].freeze
+
+    # List comments on a pull request
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.list 'user-name', 'repo-name', 'request-id'
+    #
+    def list(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
+
+      _normalize_params_keys(params)
+      # _merge_mime_type(:pull_comment, params)
+
+      response = get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single comment for pull requests
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.get 'user-name', 'repo-name', 'comment-id'
+    #
+    def get(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
+
+      _normalize_params_keys(params)
+      # _merge_mime_type(:pull_comment, params)
+
+      get_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+    end
+    alias :find :get
+
+    # Create a pull request comment
+    #
+    # = Inputs
+    # * <tt>:body</tt> - Required string
+    # * <tt>:commit_id</tt> - Required string - sha of the commit to comment on.
+    # * <tt>:path</tt> - Required string - Relative path of the file to comment on.
+    # * <tt>:position</tt> - Required number - Line index in the diff to comment on
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.create 'user-name','repo-name','request-id',
+    #   "body" => "Nice change",
+    #   "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+    #   "path" => "file1.txt",
+    #   "position" => 4
+    #
+    # = Alternative Inputs
+    # Instead of passing commit_id, path, and position you can reply to
+    # an existing Pull Request Comment like this
+    # * <tt>:body</tt> - Required string
+    # * <tt>:in_reply_to</tt> - Required number - comment id to reply to.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.create 'user-name','repo-name','request-id',
+    #    "body" => "Nice change",
+    #    "in_reply_to" => 4
+    #
+    def create(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
+
+      _normalize_params_keys(params)
+      # _merge_mime_type(:pull_comment, params)
+      _filter_params_keys(VALID_REQUEST_COM_PARAM_NAMES, params)
+      # _validate_reply_to(params)
+
+      post_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+    end
+
+    # Edit a pull request comment
+    #
+    # = Inputs
+    # * <tt>:body</tt> - Required string
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.edit 'user-name', 'repo-name','comment-id',
+    #    "body" => "Nice change"
+    #
+    def edit(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
+
+      _normalize_params_keys(params)
+      # _merge_mime_type(:pull_comment, params)
+      _filter_params_keys(VALID_REQUEST_COM_PARAM_NAMES, params)
+
+      patch_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+    end
+
+    # Delete a pull request comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.delete 'user-name', 'repo-name','comment-id'
+    #
+    def delete(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
+
+      _normalize_params_keys(params)
+      # _merge_mime_type(:pull_comment, params)
+
+      delete_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", params)
+    end
+
+  private
+
+    # To let user know that the params supplied are wrong before request is made
+    def _validate_reply_to(params)
+      if params['in_reply_to'] && !_validate_inputs(%w[ body in_reply_to ], params)
+        raise ArgumentError, "Required params are: #{%w[ body in_reply_to].join(',')}"
+
+      elsif !_validate_inputs(VALID_REQUEST_COM_PARAM_NAMES - %w[ in_reply_to ], params)
+        raise ArgumentError, "Required params are: #{VALID_REQUEST_COM_PARAM_NAMES.join(', ')}"
       end
+    end
 
-    end # Comments
-  end # PullRequests
+  end # PullRequests::Comments
 end # Github