github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/issues.rb

@@ -10,11 +10,6 @@ module Github
       :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
@@ -44,6 +39,26 @@ module Github
       super(options)
     end
 
+    # Access to Issues::Comments API
+    def comments
+      @comments ||= ApiFactory.new 'Issues::Comments'
+    end
+
+    # Access to Issues::Events API
+    def events
+      @events ||= ApiFactory.new 'Issues::Events'
+    end
+
+    # Access to Issues::Comments API
+    def labels
+      @labels ||= ApiFactory.new 'Issues::Labels'
+    end
+
+    # Access to Issues::Comments API
+    def milestones
+      @milestones ||= ApiFactory.new 'Issues::Milestones'
+    end
+
     # List your issues
     #
     # = Parameters
@@ -59,25 +74,25 @@ module Github
     # <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',
+    #  github = Github.new :oauth_token => '...'
+    #  github.issues.list :since => '2011-04-12312:12:121',
     #    :filter => 'created',
     #    :state  => 'open',
     #    :labels => "bug,ui,bla",
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
-    def issues(params={})
+    def list(params={})
       _normalize_params_keys(params)
       _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
       # _merge_mime_type(:issue, params)
       _validate_params_values(VALID_ISSUE_PARAM_VALUES, params)
 
-      response = get("/issues", params)
+      response = get_request("/issues", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :list_issues :issues
+    alias :all :list
 
     # List issues for a repository
     #
@@ -100,8 +115,8 @@ module Github
     # <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,
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.issues.list_repo :milestone => 1,
     #    :state  => 'open',
     #    :assignee => '*',
     #    :mentioned => 'octocat',
@@ -109,7 +124,7 @@ module Github
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
-    def repo_issues(user_name=nil, repo_name=nil, params={})
+    def list_repo(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
@@ -118,21 +133,19 @@ module Github
       # _merge_mime_type(:issue, params)
       _validate_params_values(VALID_ISSUE_PARAM_VALUES, params)
 
-      response = get("/repos/#{user}/#{repo}/issues", params)
+      response = get_request("/repos/#{user}/#{repo}/issues", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :repository_issues :repo_issues
-    alias :list_repo_issues :repo_issues
-    alias :list_repository_issues :repo_issues
+    alias :list_repository :list_repo
 
     # Get a single issue
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.issues.get_issue 'user-name', 'repo-name', 'issue-id'
+    #  github = Github.new
+    #  github.issues.find 'user-name', 'repo-name', 'issue-id'
     #
-    def issue(user_name, repo_name, issue_id, params={})
+    def find(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
@@ -140,9 +153,8 @@ module Github
       _normalize_params_keys(params)
       # _merge_mime_type(:issue, params)
 
-      get("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
+      get_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
     end
-    alias :get_issue :issue
 
     # Create an issue
     #
@@ -153,8 +165,8 @@ module Github
     #  <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
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.issues.create
     #    "title" => "Found a bug",
     #    "body" => "I'm having a problem with this.",
     #    "assignee" => "octocat",
@@ -164,7 +176,7 @@ module Github
     #      "Label2"
     #    ]
     #
-    def create_issue(user_name=nil, repo_name=nil, 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?
 
@@ -173,7 +185,7 @@ module Github
       _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
       _validate_inputs(%w[ title ], params)
 
-      post("/repos/#{user}/#{repo}/issues", params)
+      post_request("/repos/#{user}/#{repo}/issues", params)
     end
 
     # Edit an issue
@@ -187,8 +199,8 @@ module Github
     #  <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'
+    #  github = Github.new
+    #  github.issues.edit 'user-name', 'repo-name', 'issue-id'
     #    "title" => "Found a bug",
     #    "body" => "I'm having a problem with this.",
     #    "assignee" => "octocat",
@@ -198,16 +210,16 @@ module Github
     #      "Label2"
     #    ]
     #
-    def edit_issue(user_name, repo_name, issue_id, params={})
+    def edit(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)
       # _merge_mime_type(:issue, params)
-      _filter_params_keys(VALID_MILESTONE_INPUTS, params)
+      _filter_params_keys(VALID_ISSUE_PARAM_NAMES, params)
 
-      patch("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
+      patch_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
     end
 
   end # Issues

data/lib/github_api/issues/comments.rb

@@ -1,123 +1,120 @@
 # encoding: utf-8
 
 module Github
-  class Issues
-    module Comments
-
-      VALID_ISSUE_COMMENT_PARAM_NAME = %w[
-        body
-        resource
-        mime_type
-      ].freeze
-
-      # List comments on an issue
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.comments 'user-name', 'repo-name', 'issue-id'
-      #  @github.issues.comments 'user-name', 'repo-name', 'issue-id' { |com| ... }
-      #
-      def 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?
-        _validate_presence_of issue_id
-
-        _normalize_params_keys(params)
-        # _merge_mime_type(:issue_comment, params)
-
-        response = get("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :issue_comments :comments
-      alias :list_comments :comments
-      alias :list_issue_comments :comments
-
-      # Get a single comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.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(:issue_comment, params)
-
-        get("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
-      end
-      alias :issue_comment :comment
-      alias :get_comment :comment
-
-      # Create a comment
-      #
-      # = Inputs
-      #  <tt>:body</tt> Required string
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.create_comment 'user-name', 'repo-name', 'issue-id',
-      #     "body" => 'a new comment'
-      #
-      def create_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)
-        # _merge_mime_type(:issue_comment, params)
-        _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
-        _validate_inputs(%w[ body ], params)
-
-        post("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
-      end
-      alias :create_issue_comment :create_comment
-
-      # Edit a comment
-      #
-      # = Inputs
-      #  <tt>:body</tt> Required string
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.edit_comment 'user-name', 'repo-name', 'comment-id',
-      #     "body" => 'a new comment'
-      #
-      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(:issue_comment, params)
-        _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
-        _validate_inputs(%w[ body ], params)
-
-        patch("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
-      end
-      alias :edit_issue_comment :edit_comment
-
-      # Delete a comment
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.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(:issue_comment, params)
-
-        delete("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
-      end
-      alias :delete_issue_comment :delete_comment
-
-    end # Comments
-  end # Issues
+  class Issues::Comments < API
+
+    VALID_ISSUE_COMMENT_PARAM_NAME = %w[
+      body
+      resource
+      mime_type
+    ].freeze
+
+    # Creates new Issues::Comments API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List comments on an issue
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.all 'user-name', 'repo-name', 'issue-id'
+    #  github.issues.comments.all 'user-name', 'repo-name', 'issue-id' {|com| .. }
+    #
+    def list(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)
+      # _merge_mime_type(:issue_comment, params)
+
+      response = get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.find '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(:issue_comment, params)
+
+      get_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
+    end
+    alias :find :get
+
+    # Create a comment
+    #
+    # = Inputs
+    #  <tt>:body</tt> Required string
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.create 'user-name', 'repo-name', 'issue-id',
+    #     "body" => 'a new comment'
+    #
+    def create(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)
+      # _merge_mime_type(:issue_comment, params)
+      _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
+      _validate_inputs(%w[ body ], params)
+
+      post_request("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
+    end
+
+    # Edit a comment
+    #
+    # = Inputs
+    #  <tt>:body</tt> Required string
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.edit 'user-name', 'repo-name', 'comment-id',
+    #     "body" => 'a new comment'
+    #
+    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(:issue_comment, params)
+      _filter_params_keys(VALID_ISSUE_COMMENT_PARAM_NAME, params)
+      _validate_inputs(%w[ body ], params)
+
+      patch_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
+    end
+
+    # Delete a comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.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(:issue_comment, params)
+
+      delete_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
+    end
+
+  end # Issues::Comments
 end # Github

data/lib/github_api/issues/events.rb

@@ -1,54 +1,55 @@
 # encoding: utf-8
 
 module Github
-  class Issues
-    module Events
+  class Issues::Events < API
+
+    # Creates new Issues::Events API
+    def initialize(options = {})
+      super(options)
+    end
 
     # List events for an issue
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.issues.events 'user-name', 'repo-name', 'issue-id'
+    #  github = Github.new
+    #  github.issues.events.list 'user-name', 'repo-name', 'issue-id'
     #
     # List events for a repository
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.issues.events 'user-name', 'repo-name'
+    #  github = Github.new
+    #  github.issues.events.list 'user-name', 'repo-name'
     #
-    def events(user_name, repo_name, issue_id=nil, params={})
+    def list(user_name, repo_name, issue_id=nil, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _normalize_params_keys(params)
 
       response = if issue_id
-        get("/repos/#{user}/#{repo}/issues/#{issue_id}/events", params)
+        get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/events", params)
       else
-        get("/repos/#{user}/#{repo}/issues/events", params)
+        get_request("/repos/#{user}/#{repo}/issues/events", params)
       end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :list_events :events
-    alias :issue_events :events
-    alias :repo_events :events
+    alias :all :list
 
     # Get a single event
     #
     # = Examples
-    #  @github = Github.new
-    #  @github.issues.event 'user-name', 'repo-name', 'event-id'
+    #  github = Github.new
+    #  github.issues.events.get 'user-name', 'repo-name', 'event-id'
     #
-    def event(user_name, repo_name, event_id, params={})
+    def get(user_name, repo_name, event_id, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of event_id
       _normalize_params_keys(params)
 
-      get("/repos/#{user}/#{repo}/issues/events/#{event_id}")
+      get_request("/repos/#{user}/#{repo}/issues/events/#{event_id}")
     end
-    alias :get_event :event
+    alias :find :get
 
-    end # Events
-  end # Issues
+  end # Issues::Events
 end # Github