github_api 0.2.0 → 0.2.1

data/lib/github_api/issues/comments.rb

@@ -4,7 +4,11 @@ module Github
   class Issues
     module Comments
 
-      VALID_ISSUE_COMMENT_PARAM_NAME = %w[ body ]
+      VALID_ISSUE_COMMENT_PARAM_NAME = %w[
+        body
+        resource
+        mime_type
+      ].freeze
 
       # List comments on an issue
       #
@@ -16,7 +20,9 @@ module Github
         _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _validate_presence_of issue_id
+
         _normalize_params_keys(params)
+        _merge_mime_type(:issue_comment, params)
 
         get("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
       end
@@ -31,9 +37,11 @@ module Github
         _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(:issue_comment, params)
 
-        get("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
+        get("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
       end
 
       # Create a comment
@@ -52,9 +60,10 @@ module Github
         _validate_presence_of issue_id
 
         _normalize_params_keys(params)
+        _merge_mime_type(:issue_comment, params)
         _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
 
-        post("/repos/#{user}/#{repo}/issues/#{issue_id}/comments")
+        post("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
       end
 
       # Edit a comment
@@ -73,6 +82,7 @@ module Github
         _validate_presence_of comment_id
 
         _normalize_params_keys(params)
+        _merge_mime_type(:issue_comment, params)
         _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
 
         patch("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
@@ -90,8 +100,9 @@ module Github
         _validate_presence_of comment_id
 
         _normalize_params_keys(params)
+        _merge_mime_type(:issue_comment, params)
 
-        delete("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
+        delete("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
       end
 
     end # Comments

data/lib/github_api/mime_type.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module Github
+  module MimeType
+
+    attr_accessor :accepts
+
+    RESOURCE_LOOKUP = {
+      :json           => 'json',
+      :issue          => 'vnd.github-issue.',
+      :issue_comment  => 'vnd.github-issuecomment.',
+      :commit_comment => 'vnd.github-commitcomment.',
+      :pull_request   => 'vnd.github-pull.',
+      :pull_comment   => 'vnd.github-pullcomment.',
+      :gist_comment   => 'vnd.github-gistcomment.',
+      :blob           => 'vnd.github-blob.'
+    }
+
+    MIME_LOOKUP = {
+      :json => 'json',
+      :blob => 'raw',
+      :raw  => 'raw+json',
+      :text => 'text+json',
+      :html => 'html+json',
+      :full => 'full+json'
+    }
+
+    def parse(resource = nil, mime_type = :json)
+      resource  = lookup_resource(resource) if resource
+      mime_type = lookup_mime(mime_type)
+      self.accepts = "application/#{resource || ''}#{mime_type}"
+    end
+
+    def lookup_resource(name)
+      RESOURCE_LOOKUP.fetch(name)
+    end
+
+    def lookup_mime(name)
+      MIME_LOOKUP.fetch(name)
+    end
+
+    def _normalize_name(name)
+      puts "NAME: #{name}"
+      case name
+      when String
+        name.strip.downcase.to_sym
+      when Symbol
+        name
+      else
+        raise ArgumentError, 'Provided MIME Type is not a valid or recognized entry'
+      end
+    end
+
+  end # MimeType
+end # Github

data/lib/github_api/pull_requests.rb

@@ -17,6 +17,8 @@ module Github
       state
       issue
       commit_message
+      mime_type
+      resource
     ].freeze
 
     VALID_REQUEST_PARAM_VALUES = {
@@ -44,6 +46,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
+      _merge_mime_type(:pull_request, params)
       _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
 
       response = get("/repos/#{user}/#{repo}/pulls", params)
@@ -64,7 +67,9 @@ module Github
       _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_request, params)
 
       get("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
     end
@@ -103,6 +108,7 @@ module Github
       _validate_user_repo_params(user, repo) unless user? && repo?
 
       _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
 
       post("/repos/#{user}/#{repo}/pulls", params)
@@ -129,6 +135,7 @@ module Github
 
       _normalize_params_keys(params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
+      _merge_mime_type(:pull_request, params)
       _validate_params_values(VALID_REQUEST_PARAM_VALUES, params)
 
       patch("/repos/#{user}/#{repo}/pulls/#{request_id}", params)
@@ -144,7 +151,9 @@ module Github
       _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_request, params)
 
       response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/commits", params)
       return response unless block_given?
@@ -161,7 +170,9 @@ module Github
       _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_request, params)
 
       response = get("/repos/#{user}/#{repo}/pulls/#{request_id}/files", params)
       return response unless block_given?
@@ -178,7 +189,9 @@ module Github
       _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_request, params)
 
       get("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)
       true
@@ -201,6 +214,7 @@ module Github
       _validate_presence_of request_id
 
       _normalize_params_keys(params)
+      _merge_mime_type(:pull_request, params)
       _filter_params_keys(VALID_REQUEST_PARAM_NAMES, params)
 
       put("/repos/#{user}/#{repo}/pulls/#{request_id}/merge", params)

data/lib/github_api/pull_requests/comments.rb

@@ -10,6 +10,8 @@ module Github
         path
         position
         in_reply_to
+        mime_type
+        resource
       ].freeze
 
       # List comments on a pull request
@@ -22,7 +24,9 @@ module Github
         _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?
@@ -38,7 +42,9 @@ module Github
         _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
@@ -75,6 +81,7 @@ module Github
         _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)
 
@@ -96,6 +103,7 @@ module Github
         _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)
@@ -112,7 +120,9 @@ module Github
         _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

data/lib/github_api/repos/collaborators.rb

@@ -3,56 +3,78 @@
 module Github
   class Repos
     module Collaborators
-      
+
       # Add collaborator
       #
       # Examples:
       #  @github = Github.new
-      #  @github.collaborators.add_collaborator('user', 'repo', 'collaborator') 
+      #  @github.collaborators.add_collaborator 'user', 'repo', 'collaborator'
       #
       #  @repos = Github::Repos.new
-      #  @repos.add_collaborator('user', 'repo', 'collaborator')
+      #  @repos.add_collaborator 'user', 'repo', 'collaborator'
       #
-      def add_collaborator(user, repo, collaborator)
-        put("/repos/#{user}/#{repo}/collaborators/#{collaborator}")
+      def add_collaborator(user_name, repo_name, collaborator, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of collaborator
+        _normalize_params_keys(params)
+
+        put("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
       end
-      
-      
+      alias :add_collab :add_collaborator
+
       # Checks if user is a collaborator for a given repository
       #
       # Examples:
       #  @github = Github.new
       #  @github.collaborators.collaborator?('user', 'repo', 'collaborator')
       #
-      def collaborator?(user_name, repo_name, collaborator)
-        get("/repos/#{user}/#{repo}/collaborators/#{collaborator}")
+      def collaborator?(user_name, repo_name, collaborator, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of collaborator
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
+        true
+      rescue Github::ResourceNotFound
+        false
       end
 
       # List collaborators
       #
       # Examples:
       #   @github = Github.new
-      #   @github.repos.collaborators('user-name', 'repo-name')
-      #   @github.repos.collaborators('user-name', 'repo-name') { |cbr| .. }
+      #   @github.repos.collaborators 'user-name', 'repo-name'
+      #   @github.repos.collaborators 'user-name', 'repo-name' { |cbr| .. }
       #
-      def collaborators(user_name=nil, repo_name=nil)
-        _update_user_repo_params(user_name, repo_name)      
+      def collaborators(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless (user? && repo?)
-        
-        response = get("/repos/#{user}/#{repo}/collaborators")
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/collaborators", params)
         return response unless block_given?
         response.each { |el| yield el }
       end
-      
+      alias :list_collaborators :collaborators
+      alias :collabs :collaborators
+
       # Removes collaborator
       #
       # Examples:
       #  @github = Github.new
-      #  @github.collaborators.remove('user', 'repo', 'collaborator')
+      #  @github.repos.remove_collaborator 'user', 'repo', 'collaborator'
       #
-      def remove_collabolator(user, repo, collaborator) 
-        delete("/repos/#{user}/#{repo}/collaborators/#{user}")
+      def remove_collaborator(user_name, repo_name, collaborator, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of collaborator
+        _normalize_params_keys(params)
+
+        delete("/repos/#{user}/#{repo}/collaborators/#{collaborator}", params)
       end
+      alias :remove_collab :remove_collaborator
 
     end # Collaborators
   end # Repos

data/lib/github_api/repos/commits.rb

@@ -3,42 +3,76 @@
 module Github
   class Repos
     module Commits
-      
-      REQUIRED_COMMENT_PARAMS = %w[ body commit_id line path position ]
+
+      REQUIRED_COMMENT_PARAMS = %w[
+        body
+        commit_id
+        line
+        path
+        position
+      ].freeze
 
       # Creates a commit comment
       #
+      # = Inputs
+      # * <tt>:body</tt> - Required string.
+      # * <tt>:comment_id</tt> - Required string - Sha of the commit to comment on.
+      # * <tt>:line</tt> - Required number - Line number in the file 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.repos.create_comment(...)
+      #  @github.repos.create_comment 'user-name', 'repo-name', 'sha-key', 
+      #    "body" => "Nice change",
+      #    "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
+      #    "line" => 1,
+      #    "path" =>  "file1.txt",
+      #    "position" =>  4
       #
-      def create_comment(user_name=nil, repo_name=nil, params={})
-        raise ArgumentError, "Expected following inputs to the method: #{REQUIRED_COMMENT_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_COMMENT_PARAMS, inputs)
+      def create_comment(user_name, repo_name, sha, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of sha
+
+        _normalize_params_keys(params)
+        _filter_params_keys(REQUIRED_COMMENT_PARAMS, params)
 
-        post("/repos/#{user}/#{repo}/commits/#{sha}/comments", inputs)
+        raise ArgumentError, "Expected following inputs to the method: #{REQUIRED_COMMENT_PARAMS.join(', ')}" unless _validate_inputs(REQUIRED_COMMENT_PARAMS, params)
+
+        post("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
       end
-      
+      alias :create_commit_comment :create_comment
+
       # Deletes a commit comment
       #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.delete_comment(...)
+      #  @github.repos.delete_comment 'user-name', 'repo-name', 'comment-id'
       #
-      def delete_comment(user, repo, comment_id)
-        delete("/repos/#{user}/#{repo}/comments/#{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)
+
+        delete("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end
+      alias :delete_commit_comment :delete_comment
 
       # List commits on a repository
       #
       # = Parameters
-      #  :sha   Optional string. Sha or branch to start listing commits from.
-      #  :path  Optional string. Only commits containing this file path will be returned
+      # * <tt>:sha</tt>   Optional string. Sha or branch to start listing commits from.
+      # * <tt>:path</tt>  Optional string. Only commits containing this file path will be returned
+      #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.commits('user-name', 'repo-name', { :sha => ... })
+      #  @github.repos.commits 'user-name', 'repo-name', :sha => '...'
+      #  @github.repos.commits 'user-name', 'repo-name', :sha => '...' { |commit| ... }
       #
       def commits(user_name=nil, repo_name=nil, params={})
-        _update_user_repo_params(user_name, repo_name)      
+        _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
         _normalize_params_keys(params)
         _filter_params_keys(%w[ sha path], params)
@@ -47,69 +81,100 @@ module Github
         return response unless block_given?
         response.each { |el| yield el }
       end
+      alias :list_commits :commits
+      alias :list_repo_commits :commits
+      alias :list_repository_commits :commits
 
       # List commit comments for a repository
-      # 
+      #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.list_repo_comments('user-name', 'repo-name')
+      #  @github.repos.repo_comments 'user-name', 'repo-name'
+      #  @github.repos.repo_comments 'user-name', 'repo-name' { |com| ... }
       #
-      def list_repo_comments(user_name=nil, repo_name=nil)
-        _update_user_repo_params(user_name, repo_name)      
+      def repo_comments(user_name=nil, repo_name=nil, params={})
+        _update_user_repo_params(user_name, repo_name)
         _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
 
         response = get("/repos/#{user}/#{repo}/comments")
         return response unless block_given?
         response.each { |el| yield el }
       end
-      
+      alias :list_repo_comments :repo_comments
+      alias :list_repository_comments :repo_comments
+
       # List comments for a single commit
       #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.list_commit_comments('user-name', 'repo-name', '6dcb09b5b57875f334f61aebed695e2e4193db5e')
+      #  @github.repos.commit_comments 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed695e2e4193db5e'
       #
-      def list_commit_comments(user, repo, sha)
-        get("/repos/#{user}/#{repo}/commits/#{sha}/comments")
+      def commit_comments(user_name, repo_name, sha, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of sha
+        _normalize_params_keys(params)
+
+        response = get("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
+        return response unless block_given?
+        response.each { |el| yield el }
       end
-      
+      alias :list_commit_comments :commit_comments
+
       # Gets a single commit
-      # 
-      # Examples: 
+      #
+      # = Examples
       #  @github = Github.new
-      #  @github.repos.get_commit('user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
+      #  @github.repos.commit 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6')
       #
-      def get_commit(user, repo, sha)
-        get("/repos/#{user}/#{repo}/commits/#{sha}")
+      def commit(user_name, repo_name, sha, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _validate_presence_of sha
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/commits/#{sha}", params)
       end
+      alias :get_commit :commit
 
       # Gets a single commit comment
-      # 
+      #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.get_comment 'user-name', 'repo-name', 'comment-id'
+      #  @github.repos.commit_comment 'user-name', 'repo-name', 'comment-id'
       #
-      def get_comment(user, repo, comment_id)
-        get("/repos/#{user}/#{repo}/comments/#{comment_id}")
-      end
+      def commit_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)
 
-      # Gets a single commit
-      #
-      def get_commit(user, repo, sha)
-        get("/repos/#{user}/#{repo}/commits/#{sha}")
+        get("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end
-      
+      alias :get_commit_comment :commit_comment
+
       # Update a commit comment
       #
+      # = Inputs
+      # * <tt>:body</tt> - Required string.
+      #
       # = Examples
       #  @github = Github.new
-      #  @github.repos.update_comment(...)
+      #  @github.repos.update_comment 'user-name', 'repo-name', 'comment-id',
+      #    "body" => "Nice change"
       #
-      def update_comment(user, repo, comment_id)
-        raise ArgumentError, "expected following inputs to the method: 'body'" unless _validate_inputs(["body"], inputs)
-        patch("/repos/#{user}/#{repo}/comments/#{comment_id}")
+      def update_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)
+        raise ArgumentError, "expected following inputs to the method: 'body'" unless _validate_inputs(["body"], params)
+
+        patch("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
       end
-      
+
     end # Commits
   end # Repos
 end # Github