github_api 0.1.0.pre

data/lib/github_api/gists/comments.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+
+module Github
+  class Gists
+    module Comments
+
+      REQUIRED_GIST_COMMENT_INPUTS = %w[ body ]
+      
+      # List comments on a gist
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.gists.gist_comments 'gist-id'
+      #
+      def gist_comments(gist_id, params={})
+        _normalize_params_keys(params)
+        get("/gists/#{gist_id}/comments", params)
+      end
+
+      # Get a single comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.gists.gist_comment 'comment-id'
+      #
+      def gist_comment(comment_id, params={})
+        _normalize_params_keys(params)
+        get("/gists/comments/#{comment_id}", params)
+      end
+
+      # Create a comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.gists.create_gist_comment 'gist-id'
+      #
+      def create_gist_comment(gist_id, params={})
+        _normalize_params_keys(params)
+        _filter_params_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
+        
+        raise ArgumentError, "Required inputs are: :body" unless _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
+
+        post("/gists/#{gist_id}/comments", params)
+      end
+
+      # Edit a comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.gists.edit_gist_comment 'comment-id'
+      #
+      def edit_gist_comment(comment_id, params={})
+        _normalize_params_keys(params)
+        _filter_params_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
+        
+        raise ArgumentError, "Required inputs are: :body" unless _validate_inputs(REQUIRED_GIST_COMMENT_INPUTS, params)
+
+        patch("/gists/comments/#{comment_id}", params)
+      end
+
+      # Delete a comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.gists.delete_gist_comment 'comment-id'
+      #
+      def delete_gist_comment(comment_id, params={})
+        _normalize_params_keys(params)
+        delete("/gists/comments/#{comment_id}", params)
+      end
+       
+    end # Comments
+  end # Gists
+end # Github

data/lib/github_api/git_data.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Github
+  class GitData < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/git_data',
+      :Blobs      => 'blobs',
+      :Commits    => 'commits',
+      :References => 'references',
+      :Tags       => 'tags',
+      :Trees      => 'trees'
+
+    include Github::GitData::Blobs
+    include Github::GitData::Commits
+    include Github::GitData::References
+    include Github::GitData::Tags
+    include Github::GitData::Trees
+
+    # Creates new GitData API
+    def initialize(options = {})
+      super(options)
+    end
+
+  end # GitData
+end # Github

data/lib/github_api/git_data/blobs.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Github
+  class GitData
+    module Blobs
+
+    end # Blobs
+  end # GitData
+end # Github

data/lib/github_api/git_data/commits.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Github
+  class GitData
+    module Commits
+
+    end # Commits
+  end # GitData
+end # Github

data/lib/github_api/git_data/references.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Github
+  class GitData
+    module References
+
+    end # References
+  end # GitData
+end # Github

data/lib/github_api/git_data/tags.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Github
+  class GitData
+    module Tags
+
+    end # Tags
+  end # GitData
+end # Github

data/lib/github_api/git_data/trees.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Github
+  class GitData
+    module Trees
+
+    end # Trees
+  end # GitData
+end # Github

data/lib/github_api/issues.rb

@@ -0,0 +1,201 @@
+# encoding: utf-8
+
+module Github
+  class Issues < API
+    extend AutoloadHelper
+
+    autoload_all 'github_api/issues',
+      :Comments   => 'comments',
+      :Events     => 'events',
+      :Labels     => 'labels',
+      :Milestones => 'milestones'
+
+    include Github::Issues::Comments
+    include Github::Issues::Events
+    include Github::Issues::Labels
+    include Github::Issues::Milestones
+
+    VALID_ISSUE_PARAM_NAMES = %w[
+      filter
+      state
+      labels
+      sort
+      direction
+      since
+      milestone
+      assignee
+      mentioned
+      title
+      body
+    ]
+
+    VALID_ISSUE_PARAM_VALUES = {
+      'filter'    => %w[ assigned created mentioned subscribed ],
+      'state'     => %w[ open closed ],
+      'sort'      => %w[ created updated comments ],
+      'direction' => %w[ desc asc ],
+      'since'     => %r{\d{4}-\d{2}-\d{5}:\d{2}:\d{3}}
+    }
+
+    # Creates new Issues API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List your issues
+    #
+    # = Parameters
+    # <tt>:filter</tt>
+    #  * <tt>assigned</tt>: Issues assigned to you (default)
+    #  * <tt>created</tt>: Issues assigned to you (default)
+    #  * <tt>mentioned</tt>: Issues assigned to you (default)
+    #  * <tt>subscribed</tt>: Issues assigned to you (default)
+    # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
+    # <tt>:labels</tt> - String list of comma separated Label names. Example: bug,ui,@high
+    # <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>, default: <tt>created</tt>
+    # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
+    # <tt>:since</tt> - Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+    #
+    # = Examples
+    #  @github = Github.new :oauth_token => '...'
+    #  @github.issues.issues :since => '2011-04-12312:12:121', 
+    #    :filter => 'created',
+    #    :state  => 'open',
+    #    :labels => "bug,ui,bla",
+    #    :sort   => 'comments',
+    #    :direction => 'asc'
+    #
+    def issues(params={})
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
+      _validate_params_values(VALID_ISSUE_PARAM_VALUES, params)
+
+      response = get("/issues", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # List issues for a repository
+    #
+    # = Parameters
+    # <tt>:milestone</tt>
+    #  * Integer Milestone number
+    #  * <tt>none</tt> for Issues with no Milestone.
+    #  * <tt>*</tt> for Issues with any Milestone
+    # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
+    # <tt>:assignee</tt>
+    #  * String User login
+    #  * <tt>none</tt> for Issues with no assigned User.
+    #  * <tt>*</tt> for Issues with any assigned User.
+    # <tt>:mentioned</tt> String User login
+    # <tt>:labels</tt> - String list of comma separated Label names. Example: bug,ui,@high
+    # <tt>:sort</tt> - <tt>created</tt>, <tt>updated</tt>, <tt>comments</tt>, default: <tt>created</tt>
+    # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
+    # <tt>:since</tt> - Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+    # <tt></tt>, default: <tt>due_date</tt>
+    # <tt>:direction</tt> - <tt>asc</tt>, <tt>desc</tt>, default: <tt>desc</tt>
+    #
+    # = Examples
+    #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  @github.issues.repo_issues :milestone => 1,
+    #    :state  => 'open',
+    #    :assignee => '*',
+    #    :mentioned => 'octocat',
+    #    :labels => "bug,ui,bla",
+    #    :sort   => 'comments',
+    #    :direction => 'asc'
+    #
+    def repo_issues(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)
+      _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
+      _validate_params_values(VALID_ISSUE_PARAM_VALUES, params)
+
+      response = get("/repos/#{user}/#{repo}/issues", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get a single issue
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.get_issue 'user-name', 'repo-name', 'issue-id'
+    #
+    def get_issue(user_name, repo_name, issue_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _normalize_params_keys(params)
+
+      get("/repos/#{user}/#{repo}/issues/#{issue_id}")
+    end
+
+    # Create an issue
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:body</tt> - Optional string
+    #  <tt>:assignee</tt> - Optional string - Login for the user that this issue should be assigned to.
+    #  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
+    #  <tt>:labels</tt> - Optional array of strings - Labels to associate with this issue
+    # = Examples
+    #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  @github.issues.create_issue
+    #    "title" => "Found a bug",
+    #    "body" => "I'm having a problem with this.",
+    #    "assignee" => "octocat",
+    #    "milestone" => 1,
+    #    "labels" => [
+    #      "Label1",
+    #      "Label2"
+    #    ]
+    #
+    def create_issue(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)
+      _filter_params_keys(VALID_MILESTONE_INPUTS, params)
+
+      raise ArgumentError, "Required params are: :title" unless _validate_inputs(%w[ title ], params)
+
+      post("/repos/#{user}/#{repo}/issues", params)
+    end
+
+    # Edit an issue
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Optional string
+    #  <tt>:body</tt> - Optional string
+    #  <tt>:assignee</tt> - Optional string - Login for the user that this issue should be assigned to.
+    #  <tt>:state</tt> - Optional string - State of the issue:<tt>open</tt> or <tt>closed</tt>
+    #  <tt>:milestone</tt> - Optional number - Milestone to associate this issue with
+    #  <tt>:labels</tt> - Optional array of strings - Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue.
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.create_issue 'user-name', 'repo-name', 'issue-id'
+    #    "title" => "Found a bug",
+    #    "body" => "I'm having a problem with this.",
+    #    "assignee" => "octocat",
+    #    "milestone" => 1,
+    #    "labels" => [
+    #      "Label1",
+    #      "Label2"
+    #    ]
+    #
+    def edit_issue(user_name, repo_name, issue_id, params={})
+      _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)
+      _filter_params_keys(VALID_MILESTONE_INPUTS, params)
+
+      patch("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
+    end
+
+  end # Issues
+end # Github

data/lib/github_api/issues/comments.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module Github
+  class Issues
+    module Comments
+
+      VALID_ISSUE_COMMENT_PARAM_NAME = %w[ body ]
+
+      # List comments on an issue
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.issue_comments 'user-name', 'repo-name', 'issue-id'
+      #
+      def issue_comments(user_name, repo_name, issue_id, params={})
+        _update_user_repo_params(user_name, repo_name)
+        _validate_user_repo_params(user, repo) unless user? && repo?
+        _normalize_params_keys(params)
+
+        get("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
+      end
+
+      # Get a single comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.issue_comment 'user-name', 'repo-name', 'comment-id'
+      #
+      def issue_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)
+
+        get("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
+      end
+
+      # Create a comment
+      #
+      # = Inputs
+      #  <tt>:body</tt> Required string
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.create_issue_comment 'user-name', 'repo-name', 'issue-id',
+      #     "body" => 'a new comment'
+      #
+      def create_issue_comment(user_name, repo_name, issue_id, params={})
+        _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)
+        _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
+
+        post("/repos/#{user}/#{repo}/issues/#{issue_id}/comments")
+      end
+
+      # Edit a comment
+      #
+      # = Inputs
+      #  <tt>:body</tt> Required string
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.edit_issue_comment 'user-name', 'repo-name', 'comment-id',
+      #     "body" => 'a new comment'
+      #
+      def edit_issue_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)
+        _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
+
+        patch("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
+      end
+
+      # Delete a comment
+      #
+      # = Examples
+      #  @github = Github.new
+      #  @github.issues.delete_issue_comment 'user-name', 'repo-name', 'comment-id'
+      #
+      def delete_issue_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}/issues/comments/#{comment_id}")
+      end
+
+    end # Comments
+  end # Issues
+end # Github