github_api 0.4.11 → 0.5.0.rc1

data/lib/github_api/issues/labels.rb

@@ -1,202 +1,205 @@
 # encoding: utf-8
 
 module Github
-  class Issues
-    module Labels
-
-      VALID_LABEL_INPUTS = %w[ name color ].freeze
-
-      # List all labels for a repository
-      #
-      # = Examples
-      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
-      #  @github.issues.labels
-      #  @github.issues.labels { |label| ... }
-      #
-      def labels(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}/labels", params)
-        return response unless block_given?
-        response.each { |el| yield el }
+  class Issues::Labels < API
+
+    VALID_LABEL_INPUTS = %w[ name color ].freeze
+
+    # Creates new Issues::Labels API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # TODO Merge repository, issues and milesonte labels insdie one query
+
+    # List all labels for a repository
+    #
+    # = Examples
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.issues.labels.list
+    #  github.issues.labels.list { |label| ... }
+    #
+    def list(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _normalize_params_keys(params)
+
+      response = get_request("/repos/#{user}/#{repo}/labels", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single label
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.find 'user-name', 'repo-name', 'label-id'
+    #
+    def get(user_name, repo_name, label_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of label_id
+      _normalize_params_keys(params)
+
+      get_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+    end
+    alias :find :get
+
+    # Create a label
+    #
+    # = Inputs
+    #  <tt>:name</tt> - Required string
+    #  <tt>:color</tt> - Required string - 6 character hex code, without leading #
+    #
+    # = Examples
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.issues.labels.create :name => 'API', :color => 'FFFFFF'
+    #
+    def create(user_name, repo_name, 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_LABEL_INPUTS, params)
+      _validate_inputs(VALID_LABEL_INPUTS, params)
+
+      post_request("/repos/#{user}/#{repo}/labels", params)
+    end
+
+    # Update a label
+    #
+    # = Inputs
+    #  <tt>:name</tt> - Required string
+    #  <tt>:color</tt> - Required string-6 character hex code, without leading #
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.labels.update 'user-name', 'repo-name', 'label-id',
+    #    :name => 'API', :color => "FFFFFF"
+    #
+    def update(user_name, repo_name, label_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of label_id
+
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_LABEL_INPUTS, params)
+      _validate_inputs(VALID_LABEL_INPUTS, params)
+
+      patch_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+    end
+    alias :edit :update
+
+    # Delete a label
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.delete 'user-name', 'repo-name', 'label-id'
+    #
+    def delete(user_name, repo_name, label_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+
+      _validate_presence_of label_id
+      _normalize_params_keys params
+
+      delete_request("/repos/#{user}/#{repo}/labels/#{label_id}", params)
+    end
+
+    # List labels on an issue
+    #
+    # = Examples
+    #  @github = Github.new
+    #  @github.issues.labels.issue 'user-name', 'repo-name', 'issue-id'
+    #
+    def 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)
+
+      get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+    end
+
+    # Add labels to an issue
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.add 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
+    #
+    def add(user_name, repo_name, issue_id, *args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      params['data'] = args unless args.empty?
+
+      _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)
+
+      post_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+    end
+    alias :<< :add
+
+    # Remove a label from an issue
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.remove 'user-name', 'repo-name', 'issue-id', 'label-id'
+    #
+    # Remove all labels from an issue
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.remove 'user-name', 'repo-name', 'issue-id'
+    #
+    def remove(user_name, repo_name, issue_id, label_id=nil, 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
+
+      if label_id
+        delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_id}", params)
+      else
+        delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
       end
-      alias :list_labels :labels
-
-      # Get a single label
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.label 'user-name', 'repo-name', 'label-id'
-      #
-      def label(user_name, repo_name, label_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of label_id
-        _normalize_params_keys(params)
-
-        get("/repos/#{user}/#{repo}/labels/#{label_id}", params)
-      end
-      alias :get_label :label
-
-      # Create a label
-      #
-      # = Inputs
-      #  <tt>:name</tt> - Required string
-      #  <tt>:color</tt> - Required string - 6 character hex code, without leading #
-      #
-      # = Examples
-      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
-      #  @github.issues.create_label :name => 'API', :color => 'FFFFFF'
-      #
-      def create_label(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_LABEL_INPUTS, params)
-        _validate_inputs(VALID_LABEL_INPUTS, params)
-
-        post("/repos/#{user}/#{repo}/labels", params)
-      end
-
-      # Update a label
-      #
-      # = Inputs
-      #  <tt>:name</tt> - Required string
-      #  <tt>:color</tt> - Required string - 6 character hex code, without leading #
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.update_label 'user-name', 'repo-name', 'label-id', :name => 'API', :color => "FFFFFF"
-      #
-      def update_label(user_name, repo_name, label_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of label_id
-
-        _normalize_params_keys(params)
-        _filter_params_keys(VALID_LABEL_INPUTS, params)
-        _validate_inputs(VALID_LABEL_INPUTS, params)
-
-        patch("/repos/#{user}/#{repo}/labels/#{label_id}", params)
-      end
-
-      # Delete a label
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.delete_label 'user-name', 'repo-name', 'label-id'
-      #
-      def delete_label(user_name, repo_name, label_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-
-        _validate_presence_of label_id
-        _normalize_params_keys params
-
-        delete("/repos/#{user}/#{repo}/labels/#{label_id}", params)
-      end
-
-      # List labels on an issue
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.labels_for 'user-name', 'repo-name', 'issue-id'
-      #
-      def labels_for(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)
-
-        get("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
-      end
-      alias :issue_labels :labels_for
-
-      # Add labels to an issue
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.add_labels 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
-      #
-      def add_labels(user_name, repo_name, issue_id, *args)
-        params = args.last.is_a?(Hash) ? args.pop : {}
-        params['data'] = args unless args.empty?
-
-        _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)
-
-        post("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
-      end
-      alias :add_issue_labels :add_labels
-
-      # Remove a label from an issue
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.remove_label 'user-name', 'repo-name', 'issue-id', 'label-id'
-      #
-      # Remove all labels from an issue
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.remove_label 'user-name', 'repo-name', 'issue-id'
-      #
-      def remove_label(user_name, repo_name, issue_id, label_id=nil, 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
-
-        if label_id
-          delete("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_id}", params)
-        else
-          delete("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
-        end
-      end
-      alias :remove_label_from_issue :remove_label
-
-      # Replace all labels for an issue 
-      #
-      # Sending an empty array ([]) will remove all Labels from the Issue.
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.replace_labels 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
-      #
-      def replace_labels(user_name, repo_name, issue_id, *args)
-        params = args.last.is_a?(Hash) ? args.pop : {}
-        params['data'] = args unless args.empty?
-
-        _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)
-
-        put("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
-      end
-
-      # Get labels for every issue in a milestone
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.get_label 'user-name', 'repo-name', 'milestone-id'
-      #
-      def milestone_labels(user_name, repo_name, milestone_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of milestone_id
-
-        response = get("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :milestone_issues_labels :milestone_labels
-      alias :list_milestone_labels :milestone_labels
-
-    end # Labels
-  end # Issues
+    end
+
+    # Replace all labels for an issue 
+    #
+    # Sending an empty array ([]) will remove all Labels from the Issue.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels.replace 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
+    #
+    def replace(user_name, repo_name, issue_id, *args)
+      params = args.last.is_a?(Hash) ? args.pop : {}
+      params['data'] = args unless args.empty?
+
+      _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)
+
+      put_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+    end
+
+    # Get labels for every issue in a milestone
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.labels. 'user-name', 'repo-name', 'milestone-id'
+    #
+    def milestone(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+
+      response = get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+  end # Issues::Labels
 end # Github

data/lib/github_api/issues/milestones.rb

@@ -1,138 +1,141 @@
 # encoding: utf-8
 
 module Github
-  class Issues
-    module Milestones
-
-      VALID_MILESTONE_OPTIONS = {
-       'state' => %w[ open closed ],
-       'sort'  => %w[ due_date completeness ],
-       'direction' => %w[ desc asc ]
-      }.freeze # :nodoc:
-
-      VALID_MILESTONE_INPUTS = %w[
-        title
-        state
-        description
-        due_on
-      ].freeze # :nodoc:
-
-      # List milestones for a repository
-      #
-      # = Parameters
-      # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
-      # <tt>:sort</tt> - <tt>due_date</tt>, <tt>completeness</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.milestones
-      #
-      #  or
-      #
-      #  @github.issues.milestones :state => 'open',
-      #     :sort => 'due_date',
-      #     :direction => 'asc'
-      #
-      def milestones(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_OPTIONS.keys, params)
-        _validate_params_values(VALID_MILESTONE_OPTIONS, params)
-
-        response = get("/repos/#{user}/#{repo}/milestones", params)
-        return response unless block_given?
-        response.each { |el| yield el }
-      end
-      alias :list_milestones :milestones
-
-      # Get a single milestone
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.milestone 'user-name', 'repo-name', 'milestone-id'
-      #
-      def milestone(user_name, repo_name, milestone_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of milestone_id
-        _normalize_params_keys(params)
-
-        get("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
-      end
-      alias :get_milestone :milestone
-
-      # Create a milestone
-      #
-      # = Inputs
-      #  <tt>:title</tt> - Required string
-      #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
-      #  <tt>:description</tt> - Optional string
-      #  <tt>:due_on</tt> - Optional string - ISO 8601 time
-      #
-      # = Examples
-      #  @github = Github.new :user => 'user-name', :repo => 'repo-name'
-      #  @github.issues.create_milestone :title => 'hello-world',
-      #    :state => "open or closed",
-      #    :description => "String",
-      #    :due_on => "Time"
-      #
-      def create_milestone(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)
-        _validate_inputs(%w[ title ], params)
-
-        post("/repos/#{user}/#{repo}/milestones", params)
-      end
-
-      # Update a milestone
-      #
-      # = Inputs
-      #  <tt>:title</tt> - Required string
-      #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
-      #  <tt>:description</tt> - Optional string
-      #  <tt>:due_on</tt> - Optional string - ISO 8601 time
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.update_milestone 'user-name', 'repo-name', 'milestone-id',
-      #    :title => 'hello-world',
-      #    :state => "open or closed",
-      #    :description => "String",
-      #    :due_on => "Time"
-      #
-      def update_milestone(user_name, repo_name, milestone_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of milestone_id
-
-        _normalize_params_keys(params)
-        _filter_params_keys(VALID_MILESTONE_INPUTS, params)
-        _validate_inputs(%w[ title ], params)
-
-        patch("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
-      end
-
-      # Delete a milestone
-      #
-      # = Examples
-      #  @github = Github.new
-      #  @github.issues.delete_milestone 'user-name', 'repo-name', 'milestone-id'
-      #
-      def delete_milestone(user_name, repo_name, milestone_id, params={})
-        _update_user_repo_params(user_name, repo_name)
-        _validate_user_repo_params(user, repo) unless user? && repo?
-        _validate_presence_of milestone_id
-        _normalize_params_keys(params)
-
-        delete("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
-      end
-
-    end # Milestones
-  end # Issues
+  class Issues::Milestones < API
+
+    VALID_MILESTONE_OPTIONS = {
+     'state' => %w[ open closed ],
+     'sort'  => %w[ due_date completeness ],
+     'direction' => %w[ desc asc ]
+    }.freeze # :nodoc:
+
+    VALID_MILESTONE_INPUTS = %w[
+      title
+      state
+      description
+      due_on
+    ].freeze # :nodoc:
+
+    # Creates new Issues::Milestones API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List milestones for a repository
+    #
+    # = Parameters
+    # <tt>:state</tt> - <tt>open</tt>, <tt>closed</tt>, default: <tt>open</tt>
+    # <tt>:sort</tt> - <tt>due_date</tt>, <tt>completeness</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.milestones.list
+    #
+    #  or
+    #
+    #  github.issues.milestones.list :state => 'open',
+    #     :sort => 'due_date',
+    #     :direction => 'asc'
+    #
+    def list(user_name, repo_name, 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_OPTIONS.keys, params)
+      _validate_params_values(VALID_MILESTONE_OPTIONS, params)
+
+      response = get_request("/repos/#{user}/#{repo}/milestones", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single milestone
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'
+    #
+    def get(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+      _normalize_params_keys(params)
+
+      get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
+    end
+    alias :find :get
+
+    # Create a milestone
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:due_on</tt> - Optional string - ISO 8601 time
+    #
+    # = Examples
+    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
+    #  github.issues.milestones.create :title => 'hello-world',
+    #    :state => "open or closed",
+    #    :description => "String",
+    #    :due_on => "Time"
+    #
+    def create(user_name, repo_name, 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)
+      _validate_inputs(%w[ title ], params)
+
+      post_request("/repos/#{user}/#{repo}/milestones", params)
+    end
+
+    # Update a milestone
+    #
+    # = Inputs
+    #  <tt>:title</tt> - Required string
+    #  <tt>:state</tt> - Optional string - <tt>open</tt> or <tt>closed</tt>
+    #  <tt>:description</tt> - Optional string
+    #  <tt>:due_on</tt> - Optional string - ISO 8601 time
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.milestones.update 'user-name', 'repo-name', 'milestone-id',
+    #    :title => 'hello-world',
+    #    :state => "open or closed",
+    #    :description => "String",
+    #    :due_on => "Time"
+    #
+    def update(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+
+      _normalize_params_keys(params)
+      _filter_params_keys(VALID_MILESTONE_INPUTS, params)
+      _validate_inputs(%w[ title ], params)
+
+      patch_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
+    end
+
+    # Delete a milestone
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'
+    #
+    def delete(user_name, repo_name, milestone_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of milestone_id
+      _normalize_params_keys(params)
+
+      delete_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}", params)
+    end
+
+  end # Issues::Milestones
 end # Github