github_api 0.11.3 → 0.12.0

data/lib/github_api/client/gitignore.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module Github
+  # When you create a new GitHub repository via the API, you can specify a
+  # .gitignore template to apply to the repository upon creation.
+  class Client::Gitignore < API
+    # List all templates available to pass as an option
+    # when creating a repository.
+    #
+    # @see https://developer.github.com/v3/gitignore/#listing-available-templates
+    #
+    # @example
+    #  github = Github.new
+    #  github.gitignore.list
+    #  github.gitignore.list { |template| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+
+      response = get_request("/gitignore/templates", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single template
+    #
+    # @see https://developer.github.com/v3/gitignore/#get-a-single-template
+    #
+    # @example
+    #  github = Github.new
+    #  github.gitignore.get "template-name"
+    #
+    # Use the raw media type to get the raw contents.
+    #
+    # @examples
+    #  github = Github.new
+    #  github.gitignore.get "template-name", accept: 'applicatin/vnd.github.raw'
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:name])
+      params = arguments.params
+
+      if (media = params.delete('accept'))
+        params['accept'] = media
+        params['raw'] = true
+      end
+
+      get_request("/gitignore/templates/#{arguments.name}", params)
+    end
+    alias :find :get
+  end # Client::Gitignore
+end # Github

data/lib/github_api/client/issues.rb

@@ -0,0 +1,246 @@
+# encoding: utf-8
+
+module Github
+  class Client::Issues < API
+
+    require_all 'github_api/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_api/client/issues/assignees.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Github
+  class Client::Issues::Assignees < API
+    # Lists all the available assignees (owner + collaborators)
+    # to which issues may be assigned.
+    #
+    # @example
+    #  Github.issues.assignees.list 'owner', 'repo'
+    #  Github.issues.assignees.list 'owner', 'repo' { |assignee| ... }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:owner, :repo])
+
+      response = get_request("/repos/#{arguments.owner}/#{arguments.repo}/assignees", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Check to see if a particular user is an assignee for a repository.
+    #
+    # @example
+    #  Github.issues.assignees.check 'user', 'repo', 'assignee'
+    #
+    # @example
+    #  github = Github.new user: 'user-name', repo: 'repo-name'
+    #  github.issues.assignees.check 'assignee'
+    #
+    # @api public
+    def check(*args)
+      arguments(args, required: [:owner, :repo, :assignee])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.owner}/#{arguments.repo}/assignees/#{arguments.assignee}",params)
+      true
+    rescue Github::Error::NotFound
+      false
+    end
+  end # Issues::Assignees
+end # Github

data/lib/github_api/client/issues/comments.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+module Github
+  class Client::Issues::Comments < API
+
+    VALID_ISSUE_COMMENT_PARAM_NAME = %w[
+      body
+      resource
+      mime_type
+    ].freeze
+
+    # List comments on an issue
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.all 'owner-name', 'repo-name', number: 'id'
+    #  github.issues.comments.all 'owner-name', 'repo-name', number: 'id' {|com| .. }
+    # @example
+    #  github.issues.comments.all owner: 'username', repo: 'repo-name', number: 'id'
+    #
+    # List comments in a repository
+    #
+    # @param [Hash] params
+    # @option params [String] :sort
+    #   Optional string, created or updated
+    # @option params [String] :direction
+    #   Optional string, asc or desc. Ignored with sort parameter.
+    # @option params [String] :since
+    #   Optional string of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
+    #
+    # @example
+    #   github = Github.new
+    #   github.issues.comments.all 'user-name', 'repo-name'
+    #   github.issues.comments.all 'user-name', 'repo-name' {|com| .. }
+    #
+    # @api public
+    def list(*args)
+      arguments(args, required: [:user, :repo])
+      params = arguments.params
+
+      response = if (number = params.delete('number'))
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{number}/comments", params)
+      else
+        get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments", params)
+      end
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single comment
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.find 'user-name', 'repo-name', 'id'
+    #
+    # @example
+    #  github.issues.comments.find owner: 'user-name', repo: 'repo-name', id: 'id'
+    #
+    def get(*args)
+      arguments(args, required: [:user, :repo, :id])
+      params = arguments.params
+
+      get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", params)
+    end
+    alias :find :get
+
+    # Create a comment
+    #
+    # @param [Hash] params
+    # @option [String] :body
+    #   Required string
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.create 'user-name', 'repo-name', 'number',
+    #     body: 'a new comment'
+    #
+    # @example
+    #   github.issues.comments.create
+    #     user: 'owner-name',
+    #     repo: 'repo-name',
+    #     number: 'comment-number',
+    #     body: 'a new comment body'
+    #
+    # @api public
+    def create(*args)
+      arguments(args, required: [:user, :repo, :number]) do
+        permit VALID_ISSUE_COMMENT_PARAM_NAME
+        assert_required %w[ body ]
+      end
+      params = arguments.params
+
+      post_request("/repos/#{arguments.user}/#{arguments.repo}/issues/#{arguments.number}/comments", params)
+    end
+
+    # Edit a comment
+    #
+    # @param [Hash] params
+    # @option params [String] :body
+    #   Required string
+    #
+    # @example
+    #  github = Github.new
+    #  github.issues.comments.edit 'owner-name', 'repo-name', 'id',
+    #     body: 'a new comment'
+    #
+    # @example
+    #   github.issues.comments.edit
+    #     user: 'owner-name',
+    #     repo: 'repo-name',
+    #     id: 'comment-id',
+    #     body: 'a new comment body'
+    #
+    # @api public
+    def edit(*args)
+      arguments(args, required: [:user, :repo, :id]) do
+        permit VALID_ISSUE_COMMENT_PARAM_NAME
+        assert_required %w[ body ]
+      end
+
+      patch_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", arguments.params)
+    end
+
+    # Delete a comment
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.delete 'owner-name', 'repo-name', 'comment-id'
+    #
+    # @example
+    #   github.issues.comments.delete
+    #     user: 'owner-name',
+    #     repo: 'repo-name',
+    #     id: 'comment-id',
+    #
+    # @api public
+    def delete(*args)
+      arguments(args, required: [:user, :repo, :id])
+
+      delete_request("/repos/#{arguments.user}/#{arguments.repo}/issues/comments/#{arguments.id}", arguments.params)
+    end
+  end # Issues::Comments
+end # Github