octodoggy 4.6.2

data/lib/octokit/client/gitignore.rb

@@ -0,0 +1,43 @@
+module Octokit
+  class Client
+
+    # Methods for the Gitignore API
+    #
+    # @see https://developer.github.com/v3/gitignore/
+    module Gitignore
+
+      # Listing available gitignore templates.
+      #
+      # These templates can be passed option when creating a repository.
+      #
+      # @see https://developer.github.com/v3/gitignore/#listing-available-templates
+      #
+      # @return [Array<String>] List of templates.
+      #
+      # @example Git all the gitignore templates
+      #   @client.gitignore_templates
+      def gitignore_templates(options = {})
+        get "gitignore/templates", options
+      end
+
+      # Get a gitignore template.
+      #
+      # Use the raw {http://developer.github.com/v3/media/ media type} to get
+      # the raw contents.
+      #
+      # @param template_name [String] Name of the template. Template names are
+      #   case sensitive, make sure to use a valid name from the
+      #   .gitignore_templates list.
+      #
+      # @see https://developer.github.com/v3/gitignore/#get-a-single-template
+      #
+      # @return [Sawyer::Resource] Gitignore template
+      #
+      # @example Get the Ruby gitignore template
+      #   @client.gitignore_template('Ruby')
+      def gitignore_template(template_name, options = {})
+        get "gitignore/templates/#{template_name}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/hooks.rb

@@ -0,0 +1,297 @@
+module Octokit
+  class Client
+
+    # Methods for the Hooks API
+    module Hooks
+
+      # List all Service Hooks supported by GitHub
+      #
+      # @return [Sawyer::Resource] A list of all hooks on GitHub
+      # @see https://developer.github.com/v3/repos/hooks/#services
+      # @example List all hooks
+      #   Octokit.available_hooks
+      def available_hooks(options = {})
+        get "hooks", options
+      end
+
+      # List repo hooks
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing hooks.
+      # @see https://developer.github.com/v3/repos/hooks/#list-hooks
+      # @example
+      #   @client.hooks('octokit/octokit.rb')
+      def hooks(repo, options = {})
+        paginate "#{Repository.path repo}/hooks", options
+      end
+
+      # Get single hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook to get.
+      # @return [Sawyer::Resource] Hash representing hook.
+      # @see https://developer.github.com/v3/repos/hooks/#get-single-hook
+      # @example
+      #   @client.hook('octokit/octokit.rb', 100000)
+      def hook(repo, id, options = {})
+        get "#{Repository.path repo}/hooks/#{id}", options
+      end
+
+      # Create a hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param name [String] The name of the service that is being called. See
+      #   {https://api.github.com/hooks Hooks} for the possible names.
+      # @param config [Hash] A Hash containing key/value pairs to provide
+      #   settings for this hook. These settings vary between the services and
+      #   are defined in the {https://github.com/github/github-services github-services} repo.
+      # @option options [Array<String>] :events ('["push"]') Determines what
+      #   events the hook is triggered for.
+      # @option options [Boolean] :active Determines whether the hook is
+      #   actually triggered on pushes.
+      # @return [Sawyer::Resource] Hook info for the new hook
+      # @see https://api.github.com/hooks
+      # @see https://github.com/github/github-services
+      # @see https://developer.github.com/v3/repos/hooks/#create-a-hook
+      # @example
+      #   @client.create_hook(
+      #     'octokit/octokit.rb',
+      #     'web',
+      #     {
+      #       :url => 'http://something.com/webhook',
+      #       :content_type => 'json'
+      #     },
+      #     {
+      #       :events => ['push', 'pull_request'],
+      #       :active => true
+      #     }
+      #   )
+      def create_hook(repo, name, config, options = {})
+        options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
+        post "#{Repository.path repo}/hooks", options
+      end
+
+      # Edit a hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook being updated.
+      # @param name [String] The name of the service that is being called. See
+      #   {https://api.github.com/hooks Hooks} for the possible names.
+      # @param config [Hash] A Hash containing key/value pairs to provide
+      #   settings for this hook. These settings vary between the services and
+      #   are defined in the {https://github.com/github/github-services github-services} repo.
+      # @option options [Array<String>] :events ('["push"]') Determines what
+      #   events the hook is triggered for.
+      # @option options [Array<String>] :add_events Determines a list of events
+      #   to be added to the list of events that the Hook triggers for.
+      # @option options [Array<String>] :remove_events Determines a list of events
+      #   to be removed from the list of events that the Hook triggers for.
+      # @option options [Boolean] :active Determines whether the hook is
+      #   actually triggered on pushes.
+      # @return [Sawyer::Resource] Hook info for the updated hook
+      # @see https://api.github.com/hooks
+      # @see https://github.com/github/github-services
+      # @see https://developer.github.com/v3/repos/hooks/#edit-a-hook
+      # @example
+      #   @client.edit_hook(
+      #     'octokit/octokit.rb',
+      #     100000,
+      #     'web',
+      #     {
+      #       :url => 'http://something.com/webhook',
+      #       :content_type => 'json'
+      #     },
+      #     {
+      #       :add_events => ['status'],
+      #       :remove_events => ['pull_request'],
+      #       :active => true
+      #     }
+      #   )
+      def edit_hook(repo, id, name, config, options = {})
+        options = {:name => name, :config => config}.merge(options)
+        patch "#{Repository.path repo}/hooks/#{id}", options
+      end
+
+      # Delete hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook to remove.
+      # @return [Boolean] True if hook removed, false otherwise.
+      # @see https://developer.github.com/v3/repos/hooks/#delete-a-hook
+      # @example
+      #   @client.remove_hook('octokit/octokit.rb', 1000000)
+      def remove_hook(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/hooks/#{id}", options
+      end
+
+      # Test hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook to test.
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/repos/hooks/#test-a-push-hook
+      # @example
+      #   @client.test_hook('octokit/octokit.rb', 1000000)
+      def test_hook(repo, id, options = {})
+        boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/tests", options
+      end
+
+      # Ping hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook to send a ping.
+      # @return [Boolean] Ping requested?
+      # @see https://developer.github.com/v3/repos/hooks/#ping-a-hook
+      # @example
+      #   @client.ping_hook('octokit/octokit.rb', 1000000)
+      def ping_hook(repo, id, options={})
+        boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/pings", options
+      end
+
+      # List org hooks
+      #
+      # Requires client authenticated as admin for the org.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing hooks.
+      # @see https://developer.github.com/v3/orgs/hooks/#list-hooks
+      # @example
+      #   @client.org_hooks('octokit')
+      def org_hooks(org, options = {})
+        paginate "#{Organization.path org}/hooks", options
+      end
+      alias :list_org_hooks :org_hooks
+
+      # Get an org hook
+      #
+      # Requires client authenticated as admin for the org.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param id [Integer] Id of the hook to get.
+      # @return [Sawyer::Resource] Hash representing hook.
+      # @see https://developer.github.com/v3/orgs/hooks/#get-single-hook
+      # @example
+      #   @client.org_hook('octokit', 123)
+      def org_hook(org, id, options = {})
+        get "#{Organization.path org}/hooks/#{id}", options
+      end
+
+      # Create an org hook
+      #
+      # Requires client authenticated as admin for the org.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param config [Hash] A Hash containing key/value pairs to provide
+      #   settings for this hook.
+      # @option options [Array<String>] :events ('["push"]') Determines what
+      #   events the hook is triggered for.
+      # @option options [Boolean] :active Determines whether the hook is
+      #   actually triggered on pushes.
+      # @return [Sawyer::Resource] Hook info for the new hook
+      # @see https://api.github.com/hooks
+      # @see https://developer.github.com/v3/orgs/hooks/#create-a-hook
+      # @example
+      #   @client.create_org_hook(
+      #     'octokit',
+      #     {
+      #       :url => 'http://something.com/webhook',
+      #       :content_type => 'json'
+      #     },
+      #     {
+      #       :events => ['push', 'pull_request'],
+      #       :active => true
+      #     }
+      #   )
+      def create_org_hook(org, config, options = {})
+        options = { :name => "web", :config => config }.merge(options)
+        post "#{Organization.path org}/hooks", options
+      end
+
+      # Update an org hook
+      #
+      # Requires client authenticated as admin for the org.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param id [Integer] Id of the hook to update.
+      # @param config [Hash] A Hash containing key/value pairs to provide
+      #   settings for this hook.
+      # @option options [Array<String>] :events ('["push"]') Determines what
+      #   events the hook is triggered for.
+      # @option options [Boolean] :active Determines whether the hook is
+      #   actually triggered on pushes.
+      # @return [Sawyer::Resource] Hook info for the new hook
+      # @see https://api.github.com/hooks
+      # @see https://developer.github.com/v3/orgs/hooks/#edit-a-hook
+      # @example
+      #   @client.edit_org_hook(
+      #     'octokit',
+      #     123,
+      #     {
+      #       :url => 'http://something.com/webhook',
+      #       :content_type => 'json'
+      #     },
+      #     {
+      #       :events => ['push', 'pull_request'],
+      #       :active => true
+      #     }
+      #   )
+      def edit_org_hook(org, id, config, options = {})
+        options = { :config => config }.merge(options)
+        patch "#{Organization.path org}/hooks/#{id}", options
+      end
+      alias :update_org_hook :edit_org_hook
+
+      # Ping org hook
+      #
+      # Requires client authenticated as admin for the org.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param id [Integer] Id of the hook to update.
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook
+      # @example
+      #   @client.ping_org_hook('octokit', 1000000)
+      def ping_org_hook(org, id, options = {})
+        boolean_from_response :post, "#{Organization.path org}/hooks/#{id}/pings", options
+      end
+
+      # Remove org hook
+      #
+      # Requires client authenticated as admin for the org.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param id [Integer] Id of the hook to update.
+      # @return [Boolean] True if hook removed, false otherwise.
+      # @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook
+      # @example
+      #   @client.remove_org_hook('octokit', 1000000)
+      def remove_org_hook(org, id, options = {})
+        boolean_from_response :delete, "#{Organization.path org}/hooks/#{id}", options
+      end
+
+      # Parse payload string
+      #
+      # @param payload_string [String] The payload
+      # @return [Sawyer::Resource] The payload object
+      # @see https://developer.github.com/v3/activity/events/types/
+      def parse_payload(payload_string)
+        payload_hash = agent.class.decode payload_string
+        Sawyer::Resource.new agent, payload_hash
+      end
+    end
+  end
+end

data/lib/octokit/client/integrations.rb

@@ -0,0 +1,77 @@
+module Octokit
+  class Client
+
+    # Methods for the Integrations API
+    module Integrations
+
+      # Find all installations that belong to an Integration
+      #
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/#find-installations
+      #
+      # @return [Array<Sawyer::Resource>] A list of installations
+      def find_integration_installations(options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        paginate "/integration/installations", opts
+      end
+      alias find_installations find_integration_installations
+
+      # Create a new installation token
+      #
+      # @param installation [Integer] The id of a a GitHub Integration Installation
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/#find-installations
+      #
+      # @return [<Sawyer::Resource>] An installation token
+      def create_integration_installation_access_token(installation, options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        post "/installations/#{installation}/access_tokens", opts
+      end
+      alias create_installation_access_token create_integration_installation_access_token
+
+      # List repositories that are accessible to the authenticated installation
+      #
+      # @param options [Hash] An customizable set of options
+      # @see https://developer.github.com/v3/integrations/installations/#list-repositories
+      #
+      # @return [Array<Sawyer::Resource>] A list of repositories
+      def list_integration_installation_repositories(options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        paginate "/installation/repositories", opts
+      end
+      alias list_installation_repos list_integration_installation_repositories
+
+      # Add a single repository to an installation
+      #
+      # @param installation [Integer] The id of a a GitHub Integration Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/installations/#add-repository-to-installation
+      #
+      # @return [Boolean] Success
+      def add_repository_to_integration_installation(installation, repo, options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        boolean_from_response :put, "/installations/#{installation}/repositories/#{repo}", opts
+      end
+      alias add_repo_to_installation add_repository_to_integration_installation
+
+      # Remove a single repository to an installation
+      #
+      # @param installation [Integer] The id of a a GitHub Integration Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/installations/#remove-repository-from-installation
+      #
+      # @return [Boolean] Success
+      def remove_repository_from_integration_installation(installation, repo, options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        boolean_from_response :delete, "/installations/#{installation}/repositories/#{repo}", opts
+      end
+      alias remove_repo_from_installation remove_repository_from_integration_installation
+    end
+  end
+end

data/lib/octokit/client/issues.rb

@@ -0,0 +1,321 @@
+module Octokit
+  class Client
+
+    # Methods for the Issues API
+    #
+    # @see https://developer.github.com/v3/issues/
+    module Issues
+
+      # List issues for the authenticated user or repository
+      #
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository.
+      # @param options [Sawyer::Resource] A customizable set of options.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</tt>.
+      # @option options [String] :assignee User login.
+      # @option options [String] :creator User login.
+      # @option options [String] :mentioned User login.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
+      # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @option options [Integer] :page (1) Page number.
+      # @return [Array<Sawyer::Resource>] A list of issues for a repository.
+      # @see https://developer.github.com/v3/issues/#list-issues-for-a-repository
+      # @see https://developer.github.com/v3/issues/#list-issues
+      # @example List issues for a repository
+      #   Octokit.list_issues("sferik/rails_admin")
+      # @example List issues for the authenticated user across repositories
+      #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
+      #   @client.list_issues
+      def list_issues(repository = nil, options = {})
+        path = repository ? "#{Repository.new(repository).path}/issues" : "issues"
+        paginate path, options
+      end
+      alias :issues :list_issues
+
+      # List all issues across owned and member repositories for the authenticated user
+      #
+      # @param options [Sawyer::Resource] A customizable set of options.
+      # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</tt>.
+      # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
+      # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @option options [Integer] :page (1) Page number.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      # @return [Array<Sawyer::Resource>] A list of issues for a repository.
+      # @see https://developer.github.com/v3/issues/#list-issues
+      # @example List issues for the authenticated user across owned and member repositories
+      #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
+      #   @client.user_issues
+      def user_issues(options = {})
+        paginate 'user/issues', options
+      end
+
+      # List all issues for a given organization for the authenticated user
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param options [Sawyer::Resource] A customizable set of options.
+      # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</tt>.
+      # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
+      # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
+      # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
+      # @option options [Integer] :page (1) Page number.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      # @return [Array<Sawyer::Resource>] A list of issues.
+      # @see https://developer.github.com/v3/issues/#list-issues
+      # @example List all issues for a given organization for the authenticated user
+      #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
+      #   @client.org_issues("octokit")
+      def org_issues(org, options = {})
+        paginate "#{Organization.path org}/issues", options
+      end
+
+      # Create an issue for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param title [String] A descriptive title
+      # @param body [String] An optional concise description
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
+      # @return [Sawyer::Resource] Your newly created issue
+      # @see https://developer.github.com/v3/issues/#create-an-issue
+      # @example Create a new Issues for a repository
+      #   Octokit.create_issue("sferik/rails_admin", 'Updated Docs', 'Added some extra links')
+      def create_issue(repo, title, body = nil, options = {})
+        options[:labels] = case options[:labels]
+                           when String
+                             options[:labels].split(",").map(&:strip)
+                           when Array
+                             options[:labels]
+                           else
+                             []
+                           end
+        parameters = { :title => title }
+        parameters[:body] = body unless body.nil?
+        post "#{Repository.path repo}/issues", options.merge(parameters)
+      end
+      alias :open_issue :create_issue
+
+      # Get a single issue from a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Sawyer::Resource] The issue you requested, if it exists
+      # @see https://developer.github.com/v3/issues/#get-a-single-issue
+      # @example Get issue #25 from octokit/octokit.rb
+      #   Octokit.issue("octokit/octokit.rb", "25")
+      def issue(repo, number, options = {})
+        get "#{Repository.path repo}/issues/#{number}", options
+      end
+
+      # Close an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
+      # @return [Sawyer::Resource] The updated Issue
+      # @see https://developer.github.com/v3/issues/#edit-an-issue
+      # @example Close Issue #25 from octokit/octokit.rb
+      #   Octokit.close_issue("octokit/octokit.rb", "25")
+      def close_issue(repo, number, options = {})
+        patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "closed"})
+      end
+
+      # Reopen an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :assignee User login.
+      # @option options [Integer] :milestone Milestone number.
+      # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
+      # @return [Sawyer::Resource] The updated Issue
+      # @see https://developer.github.com/v3/issues/#edit-an-issue
+      # @example Reopen Issue #25 from octokit/octokit.rb
+      #   Octokit.reopen_issue("octokit/octokit.rb", "25")
+      def reopen_issue(repo, number, options = {})
+        patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "open"})
+      end
+
+      # Lock an issue's conversation, limiting it to collaborators
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/#lock-an-issue
+      # @example Lock Issue #25 from octokit/octokit.rb
+      #   Octokit.lock_issue("octokit/octokit.rb", "25")
+      def lock_issue(repo, number, options = {})
+        boolean_from_response :put, "#{Repository.path repo}/issues/#{number}/lock", options
+      end
+
+      # Unlock an issue's conversation, opening it to all viewers
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/#unlock-an-issue
+      # @example Unlock Issue #25 from octokit/octokit.rb
+      #   Octokit.close_issue("octokit/octokit.rb", "25")
+      def unlock_issue(repo, number, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/issues/#{number}/lock", options
+      end
+
+      # Update an issue
+      #
+      # @overload update_issue(repo, number, title, body, options)
+      #   @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #   @param number [Integer] Number ID of the issue
+      #   @param title [String] Updated title for the issue
+      #   @param body [String] Updated body of the issue
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [String] :assignee User login.
+      #   @option options [Integer] :milestone Milestone number.
+      #   @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
+      #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
+      #
+      # @overload update_issue(repo, number, options)
+      #   @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #   @param number [Integer] Number ID of the issue
+      #   @param options [Hash] A customizable set of options.
+      #   @option options [String] :title Updated title for the issue
+      #   @option options [String] :body Updated body of the issue
+      #   @option options [String] :assignee User login.
+      #   @option options [Integer] :milestone Milestone number.
+      # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
+      #   @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
+      # @return [Sawyer::Resource] The updated Issue
+      # @see https://developer.github.com/v3/issues/#edit-an-issue
+      #
+      # @example Change the title of Issue #25
+      #   Octokit.update_issue("octokit/octokit.rb", "25", "A new title", "the same body")
+      #
+      # @example Change only the assignee of Issue #25
+      #   Octokit.update_issue("octokit/octokit.rb", "25", :assignee => "pengwynn")
+      def update_issue(repo, number, *args)
+        arguments = Arguments.new(args)
+        opts = arguments.options
+
+        if arguments.length > 0
+          opts[:title] = arguments.shift
+          opts[:body] = arguments.shift
+        end
+
+        patch "#{Repository.path repo}/issues/#{number}", opts
+      end
+
+      # Get all comments attached to issues for the repository
+      #
+      # By default, Issue Comments are ordered by ascending ID.
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param options [Hash] Optional parameters
+      # @option options [String] :sort created or updated
+      # @option options [String] :direction asc or desc. Ignored without sort
+      #   parameter.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      #
+      # @return [Array<Sawyer::Resource>] List of issues comments.
+      #
+      # @see https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
+      #
+      # @example Get the comments for issues in the octokit repository
+      #   @client.issues_comments("octokit/octokit.rb")
+      #
+      # @example Get issues comments, sort by updated descending since a time
+      #   @client.issues_comments("octokit/octokit.rb", {
+      #     :sort => 'desc',
+      #     :direction => 'asc',
+      #     :since => '2010-05-04T23:45:02Z'
+      #   })
+      def issues_comments(repo, options = {})
+        paginate "#{Repository.path repo}/issues/comments", options
+      end
+
+      # Get all comments attached to an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Array<Sawyer::Resource>] Array of comments that belong to an issue
+      # @see https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
+      # @example Get comments for issue #25 from octokit/octokit.rb
+      #   Octokit.issue_comments("octokit/octokit.rb", "25")
+      def issue_comments(repo, number, options = {})
+        paginate "#{Repository.path repo}/issues/#{number}/comments", options
+      end
+
+      # Get a single comment attached to an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the comment
+      # @return [Sawyer::Resource] The specific comment in question
+      # @see https://developer.github.com/v3/issues/comments/#get-a-single-comment
+      # @example Get comment #1194549 from an issue on octokit/octokit.rb
+      #   Octokit.issue_comments("octokit/octokit.rb", 1194549)
+      def issue_comment(repo, number, options = {})
+        paginate "#{Repository.path repo}/issues/comments/#{number}", options
+      end
+
+      # Add a comment to an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Issue number
+      # @param comment [String] Comment to be added
+      # @return [Sawyer::Resource] Comment
+      # @see https://developer.github.com/v3/issues/comments/#create-a-comment
+      # @example Add the comment "Almost to v1" to Issue #23 on octokit/octokit.rb
+      #   Octokit.add_comment("octokit/octokit.rb", 23, "Almost to v1")
+      def add_comment(repo, number, comment, options = {})
+        post "#{Repository.path repo}/issues/#{number}/comments", options.merge({:body => comment})
+      end
+
+      # Update a single comment on an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Comment number
+      # @param comment [String] Body of the comment which will replace the existing body.
+      # @return [Sawyer::Resource] Comment
+      # @see https://developer.github.com/v3/issues/comments/#edit-a-comment
+      # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on octokit/octokit.rb
+      #   Octokit.update_comment("octokit/octokit.rb", 1194549, "Almost to v1, added this on my fork")
+      def update_comment(repo, number, comment, options = {})
+        patch "#{Repository.path repo}/issues/comments/#{number}", options.merge({:body => comment})
+      end
+
+      # Delete a single comment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Comment number
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/comments/#delete-a-comment
+      # @example Delete the comment #1194549 on an issue on octokit/octokit.rb
+      #   Octokit.delete_comment("octokit/octokit.rb", 1194549)
+      def delete_comment(repo, number, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/issues/comments/#{number}", options
+      end
+
+      # Get the timeline for an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the comment
+      # @return [Sawyer::Resource] The timeline for this issue
+      # @see https://developer.github.com/v3/issues/timeline/
+      # @example Get timeline for issue #1435 on octokit/octokit.rb
+      #   Octokit.issue_timeline("octokit/octokit.rb", 1435)
+      def issue_timeline(repo, number, options = {})
+        options = ensure_api_media_type(:issue_timelines, options)
+        paginate "#{Repository.path repo}/issues/#{number}/timeline", options
+      end
+    end
+  end
+end