github_api2 1.0.0

data/lib/github_api2/client/issues/events.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Events < API
+    # List events for an issue
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.events.list 'user-name', 'repo-name',
+    #    issue_number: 'issue-number'
+    #
+    # List events for a repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.events.list 'user-name', 'repo-name'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+
+      response = if (issue_number = params.delete('issue_number'))
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{issue_number}/events", params)
+      else
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single event
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.events.get 'user-name', 'repo-name', 'event-id'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, :required => [:user, :repo, :id])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events/#{arguments.id}", params)
+    end
+    alias :find :get
+  end # Issues::Events
+end # Github

data/lib/github_api2/client/issues/labels.rb

@@ -0,0 +1,189 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Labels < API
+
+    VALID_LABEL_INPUTS = %w[ name color ].freeze
+
+    # List all labels for a repository
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.issues.labels.list
+    #   github.issues.labels.list { |label| ... }
+    #
+    # Get labels for every issue in a milestone
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.list 'user-name', 'repo-name', milestone_id: 'milestone-id'
+    #
+    # List labels on an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.list 'user-name', 'repo-name', issue_id: 'issue-id'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+      user = arguments.user
+      repo = arguments.repo
+
+      response = if (milestone_id = params.delete('milestone_id'))
+        get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
+      elsif (issue_id = params.delete('issue_id'))
+        get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
+      else
+        get_request("/repos/#{user}/#{repo}/labels", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single label
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.find 'user-name', 'repo-name', 'label-name'
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.issues.labels.get label_name: 'bug'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :label_name])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/labels/#{arguments.label_name}", params)
+    end
+    alias :find :get
+
+    # Create a label
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string
+    # @option params [String] :color
+    #   Required string - 6 character hex code, without leading #
+    #
+    # @example
+    #   github = Github.new user: 'user-name', repo: 'repo-name'
+    #   github.issues.labels.create name: 'API', color: 'FFFFFF'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_LABEL_INPUTS
+        assert_required VALID_LABEL_INPUTS
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/labels", arguments.params)
+    end
+
+    # Update a label
+    #
+    # @param [Hash] params
+    # @option params [String] :name
+    #   Required string
+    # @option params [String] :color
+    #   Required string - 6 character hex code, without leading #
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.update 'user-name', 'repo-name', 'label-name',
+    #     name: 'API', color: "FFFFFF"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :label_name]) do
+        permit VALID_LABEL_INPUTS
+        assert_required VALID_LABEL_INPUTS
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/labels/#{arguments.label_name}", arguments.params)
+    end
+    alias :edit :update
+
+    # Delete a label
+    #
+    # @examples
+    #   github = Github.new
+    #   github.issues.labels.delete 'user-name', 'repo-name', 'label-name'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :label_name])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/labels/#{arguments.label_name}", arguments.params)
+    end
+
+    # Add labels to an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.add 'user-name', 'repo-name', 'issue-number',
+    #     'label1', 'label2', ...
+    #
+    # @api public
+    def add(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/labels", params)
+    end
+    alias :<< :add
+
+    # Remove a label from an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number',
+    #     label_name: 'label-name'
+    #
+    # Remove all labels from an issue
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.remove 'user-name', 'repo-name', 'issue-number'
+    #
+    # @api public
+    def remove(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      user   = arguments.user
+      repo   = arguments.repo
+      number = arguments.number
+
+      if (label_name = params.delete('label_name'))
+        delete_request("/repos/#{user}/#{repo}/issues/#{number}/labels/#{label_name}", params)
+      else
+        delete_request("/repos/#{user}/#{repo}/issues/#{number}/labels", params)
+      end
+    end
+
+    # Replace all labels for an issue
+    #
+    # Sending an empty array ([]) will remove all Labels from the Issue.
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.labels.replace 'user-name', 'repo-name', 'issue-number',
+    #     'label1', 'label2', ...
+    #
+    # @api public
+    def replace(*args)
+      arguments(args, required: [:user, :repo, :number])
+      params = arguments.params
+      params['data'] = arguments.remaining unless arguments.remaining.empty?
+
+      put_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/labels", params)
+    end
+  end # Issues::Labels
+end # Github

data/lib/github_api2/client/issues/milestones.rb

@@ -0,0 +1,146 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+module Github
+  class Client::Issues::Milestones < API
+
+    VALID_MILESTONE_OPTIONS = {
+     'state' => %w[ open closed all ],
+     '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
+    #
+    # @param [Hash] params
+    # @option params [String] :state
+    #   The state of the milestone. Either open, closed, or all. Default: open
+    # @option params [String] :sort
+    #   What to sort results by. Either due_date or completeness.
+    #   Default: due_date
+    # @option params [String] :direction
+    #   The directoin of the sort. Either asc or desc. Default: desc
+    #
+    # @example
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.issues.milestones.list
+    #
+    # @example
+    #  github.issues.milestones.list state: 'open', sort: 'due_date',
+    #    direction: 'asc'
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_MILESTONE_OPTIONS.keys
+        assert_values VALID_MILESTONE_OPTIONS
+      end
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/milestones", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single milestone
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.milestones.get 'user-name', 'repo-name', 'milestone-number'
+    #
+    # @example
+    #   github.issues.milestones.get
+    #     user: 'user-name',
+    #     repo: 'repo-name',
+    #     number: 'milestone-number'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.params)
+    end
+    alias :find :get
+
+    # Create a milestone
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string. The title of the milestone
+    # @option params [String] :state
+    #   The state of the milestone. Either open or closed. Default: open.
+    # @option params [String] :description
+    #   A description of the milestone
+    # @option params [String] :due_on
+    #   The milestone due date. This is a timestamp in ISO 8601 format:
+    #   YYYY-MM-DDTHH:MM:SSZ.
+    #
+    # @example
+    #  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"
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_MILESTONE_INPUTS
+        assert_required %w[ title ]
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/milestones", arguments.params)
+    end
+
+    # Update a milestone
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string. The title of the milestone
+    # @option params [String] :state
+    #   The state of the milestone. Either open or closed. Default: open.
+    # @option params [String] :description
+    #   A description of the milestone
+    # @option params [String] :due_on
+    #   The milestone due date. This is a timestamp in ISO 8601 format:
+    #   YYYY-MM-DDTHH:MM:SSZ.
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.milestones.update 'user-name', 'repo-name', 'number',
+    #     :title => 'hello-world',
+    #     :state => "open or closed",
+    #     :description => "String",
+    #     :due_on => "Time"
+    #
+    # @api public
+    def update(*args)
+      arguments(args, required: [:user, :repo, :number]) do
+        permit VALID_MILESTONE_INPUTS
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.params)
+    end
+
+    # Delete a milestone
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.milestones.delete 'user-name', 'repo-name', 'number'
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/milestones/#{arguments.number}", arguments.params)
+    end
+  end # Issues::Milestones
+end # Github

data/lib/github_api2/client/issues.rb

@@ -0,0 +1,248 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Issues < API
+
+    require_all 'github_api2/client/issues',
+      'assignees',
+      'comments',
+      'events',
+      'labels',
+      'milestones'
+
+    VALID_ISSUE_PARAM_NAMES = %w[
+      assignee
+      body
+      creator
+      direction
+      filter
+      labels
+      milestone
+      mentioned
+      mime_type
+      org
+      resource
+      since
+      sort
+      state
+      title
+    ].freeze
+
+    VALID_ISSUE_PARAM_VALUES = {
+      'filter'    => %w[ assigned created mentioned subscribed all ],
+      'state'     => %w[ open closed all ],
+      'sort'      => %w[ created updated comments ],
+      'direction' => %w[ desc asc ],
+      'since'     => %r{\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z}
+    }
+
+    # Access to Issues::Assignees API
+    namespace :assignees
+
+    # Access to Issues::Comments API
+    namespace :comments
+
+    # Access to Issues::Events API
+    namespace :events
+
+    # Access to Issues::Comments API
+    namespace :labels
+
+    # Access to Issues::Comments API
+    namespace :milestones
+
+    # List your issues
+    #
+    # List all issues across all the authenticated user’s visible repositories
+    # including owned repositories, member repositories,
+    # and organization repositories.
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.issues.list
+    #
+    # List all issues across owned and member repositories for the
+    # authenticated user.
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.issues.list :user
+    #
+    # List all issues for a given organization for the authenticated user.
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.issues.list org: 'org-name'
+    #
+    # List issues for a repository
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.list user: 'user-name', repo: 'repo-name'
+    #
+    # @param [Hash] params
+    # @option params [String] :filter
+    #  * assigned   Issues assigned to you (default)
+    #  * created    Issues created by you
+    #  * mentioned  Issues mentioning you
+    #  * subscribed Issues you've subscribed to updates for
+    #  * all        All issues the user can see
+    # @option params [String] :milestone
+    #  * Integer Milestone number
+    #  * none for Issues with no Milestone.
+    #  * *    for Issues with any Milestone
+    # @option params [String] :state
+    #   open, closed, default: open
+    # @option params [String] :labels
+    #   String list of comma separated Label names. Example: bug,ui,@high
+    # @option params [String] :assignee
+    #  * String User login
+    #  * <tt>none</tt> for Issues with no assigned User.
+    #  * <tt>*</tt>    for Issues with any assigned User.
+    # @option params [String] :creator
+    #   String User login
+    # @option params [String] :mentioned
+    #   String User login
+    # @option params [String] :sort
+    #   created, updated, comments, default: <tt>created</tt>
+    # @option params [String] :direction
+    #   asc, desc, default: desc
+    # @option params [String] :since
+    #   Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+    #
+    # @example
+    #  github = Github.new oauth_token: '...'
+    #  github.issues.list since: '2011-04-12T12:12:12Z',
+    #    filter: 'created',
+    #    state: 'open',
+    #    labels: "bug,ui,bla",
+    #    sort: 'comments',
+    #    direction: 'asc'
+    #
+    # @api public
+    def list(*args)
+      params = arguments(args) do
+        assert_values VALID_ISSUE_PARAM_VALUES
+      end.params
+
+      response = if (org = params.delete('org'))
+        get_request("/orgs/#{org}/issues", params)
+
+      elsif (user_name = params.delete('user')) &&
+            (repo_name = params.delete('repo'))
+
+        list_repo user_name, repo_name
+      elsif args.include? :user
+        get_request("/user/issues", params)
+      else
+        get_request("/issues", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # List issues for a repository
+    #
+    # def list_repo(user_name, repo_name, params)
+    def list_repo(user, repo)
+      get_request("/repos/#{user}/#{repo}/issues", arguments.params)
+    end
+    private :list_repo
+
+    # Get a single issue
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.get 'user-name', 'repo-name', 'number'
+    #
+    def get(*args)
+      arguments(args, required: [:user, :repo, :number])
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}", arguments.params)
+    end
+    alias :find :get
+
+    # Create an issue
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Required string
+    # @option params [String] :body
+    #   Optional string
+    # @option params [String] :assignee
+    #   Optional string - Login for the user that this issue should be
+    #   assigned to. Only users with push access can set the assignee for
+    #   new issues. The assignee is silently dropped otherwise.
+    # @option params [Number] :milestone
+    #   Optional number - Milestone to associate this issue with.
+    #   Only users with push access can set the milestone for new issues.
+    #   The milestone is silently dropped otherwise.
+    # @option params [Array[String]] :labels
+    #   Optional array of strings - Labels to associate with this issue
+    #   Only users with push access can set labels for new issues.
+    #   Labels are silently dropped otherwise.
+    #
+    # @example
+    #  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",
+    #    milestone: 1,
+    #    labels: [
+    #      "Label1",
+    #      "Label2"
+    #    ]
+    #
+    def create(*args)
+      arguments(args, required: [:user, :repo]) do
+        permit VALID_ISSUE_PARAM_NAMES
+        assert_required %w[ title ]
+      end
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/issues", arguments.params)
+    end
+
+    # Edit an issue
+    #
+    # @param [Hash] params
+    # @option params [String] :title
+    #   Optional string
+    # @option params [String] :body
+    #   Optional string
+    # @option params [String] :assignee
+    #   Optional string - Login for the user that this issue should be assigned to.
+    # @option params [String] :state
+    #   Optional string - State of the issue: open or closed
+    # @option params [Number] :milestone
+    #   Optional number - Milestone to associate this issue with
+    # @option params [Array[String]] :labels
+    #   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.
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.edit 'user-name', 'repo-name', 'number'
+    #    title: "Found a bug",
+    #    body: "I'm having a problem with this.",
+    #    assignee: "octocat",
+    #    milestone: 1,
+    #    labels": [
+    #      "Label1",
+    #      "Label2"
+    #    ]
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :number]) do
+        permit VALID_ISSUE_PARAM_NAMES
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}", arguments.params)
+    end
+  end # Issues
+end # Github

data/lib/github_api2/client/markdown.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Markdown < API
+
+    # Render an arbitrary Markdown document
+    #
+    # = Parameters
+    #  <tt>:text</tt> - Required string - The Markdown text to render
+    #  <tt>:mode<tt> - Optional string - The rendering mode
+    #    * <tt>markdown</tt> to render a document as plain Markdown, just
+    #                        like README files are rendered.
+    #    * <tt>gfm</tt> to render a document as user-content, e.g. like user
+    #      comments or issues are rendered. In GFM mode, hard line breaks are
+    #      always taken into account, and issue and user mentions are
+    #      linked accordingly.
+    #  <tt>:context<tt> - Optional string - The repository context, only taken
+    #                     into account when rendering as <tt>gfm</tt>
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.markdown.render
+    #    "text": "Hello world github/linguist#1 **cool**, and #1!",
+    #    "mode": "gfm",
+    #    "context": "github/gollum"
+    #
+    def render(*args)
+      arguments(args) do
+        assert_required ['text']
+      end
+      params = arguments.params
+      params['raw'] = true
+
+      post_request("markdown", arguments.params)
+    end
+
+    # Render a Markdown document in raw mode
+    #
+    # = Input
+    #  The raw API it not JSON-based. It takes a Markdown document as plaintext
+    #  <tt>text/plain</tt> or <tt>text/x-markdown</tt> and renders it as plain
+    #  Markdown without a repository context (just like a README.md file is
+    #  rendered – this is the simplest way to preview a readme online)
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.markdown.render_raw "Hello github/linguist#1 **cool**, and #1!",
+    #    "accept": "text/plain",
+    #
+    def render_raw(*args)
+      params = arguments(args).params
+      params['data'] = args.shift
+      params['raw'] = true
+      params['accept'] = params.fetch('accept') { 'text/plain' }
+
+      post_request("markdown/raw", params)
+    end
+
+  end # Markdown
+end # Github