octodoggy 4.6.2

data/lib/octokit/client/labels.rb

@@ -0,0 +1,156 @@
+require 'cgi'
+
+module Octokit
+  class Client
+
+    # Methods for the Issue Labels API
+    #
+    # @see https://developer.github.com/v3/issues/labels/
+    module Labels
+
+      # List available labels for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of the labels across the repository
+      # @see https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository
+      # @example List labels for octokit/octokit.rb
+      #   Octokit.labels("octokit/octokit.rb")
+      def labels(repo, options = {})
+        paginate "#{Repository.path repo}/labels", options
+      end
+
+      # Get single label for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param name [String] Name of the label
+      # @return [Sawyer::Resource] A single label from the repository
+      # @see https://developer.github.com/v3/issues/labels/#get-a-single-label
+      # @example Get the "V3 Addition" label from octokit/octokit.rb
+      #   Octokit.labels("octokit/octokit.rb", "V3 Addition")
+      def label(repo, name, options = {})
+        get "#{Repository.path repo}/labels/#{name}", options
+      end
+
+      # Add a label to a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param label [String] A new label
+      # @param color [String] A color, in hex, without the leading #
+      # @return [Sawyer::Resource] The new label
+      # @see https://developer.github.com/v3/issues/labels/#create-a-label
+      # @example Add a new label "Version 1.0" with color "#cccccc"
+      #   Octokit.add_label("octokit/octokit.rb", "Version 1.0", "cccccc")
+      def add_label(repo, label, color="ffffff", options = {})
+        post "#{Repository.path repo}/labels", options.merge({:name => label, :color => color})
+      end
+
+      # Update a label
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param label [String] The name of the label which will be updated
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :name An updated label name
+      # @option options [String] :color An updated color value, in hex, without leading #
+      # @return [Sawyer::Resource] The updated label
+      # @see https://developer.github.com/v3/issues/labels/#update-a-label
+      # @example Update the label "Version 1.0" with new color "#cceeaa"
+      #   Octokit.update_label("octokit/octokit.rb", "Version 1.0", {:color => "cceeaa"})
+      def update_label(repo, label, options = {})
+        patch "#{Repository.path repo}/labels/#{label}", options
+      end
+
+      # Delete a label from a repository.
+      #
+      # This deletes the label from the repository, and removes it from all issues.
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param label [String] String name of the label
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/labels/#delete-a-label
+      # @example Delete the label "Version 1.0" from the repository.
+      #   Octokit.delete_label!("octokit/octokit.rb", "Version 1.0")
+      def delete_label!(repo, label, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/labels/#{label}", options
+      end
+
+      # Remove a label from an Issue
+      #
+      # This removes the label from the Issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @param label [String] String name of the label
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
+      # @see https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
+      # @example Remove the label "Version 1.0" from the repository.
+      #   Octokit.remove_label("octokit/octokit.rb", 23, "Version 1.0")
+      def remove_label(repo, number, label, options = {})
+        delete "#{Repository.path repo}/issues/#{number}/labels/#{label}", options
+      end
+
+      # Remove all label from an Issue
+      #
+      # This removes the label from the Issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Boolean] Success of operation
+      # @see https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
+      # @example Remove all labels from Issue #23
+      #   Octokit.remove_all_labels("octokit/octokit.rb", 23)
+      def remove_all_labels(repo, number, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/issues/#{number}/labels", options
+      end
+
+      # List labels for a given issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
+      # @see https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
+      # @example List labels for octokit/octokit.rb, issue # 1
+      #   Octokit.labels_for_issue("octokit/octokit.rb", 1)
+      def labels_for_issue(repo, number, options = {})
+        paginate "#{Repository.path repo}/issues/#{number}/labels", options
+      end
+
+      # Add label(s) to an Issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A Github repository
+      # @param number [Integer] Number ID of the issue
+      # @param labels [Array] An array of labels to apply to this Issue
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
+      # @see https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
+      # @example Add two labels for octokit/octokit.rb
+      #   Octokit.add_labels_to_an_issue("octokit/octokit.rb", 10, ['V3 Transition', 'Improvement'])
+      def add_labels_to_an_issue(repo, number, labels)
+        post "#{Repository.path repo}/issues/#{number}/labels", labels
+      end
+
+      # Replace all labels on an Issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A Github repository
+      # @param number [Integer] Number ID of the issue
+      # @param labels [Array] An array of labels to use as replacement
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
+      # @see https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
+      # @example Replace labels for octokit/octokit.rb Issue #10
+      #   Octokit.replace_all_labels("octokit/octokit.rb", 10, ['V3 Transition', 'Improvement'])
+      def replace_all_labels(repo, number, labels, options = {})
+        put "#{Repository.path repo}/issues/#{number}/labels", labels
+      end
+
+      # Get labels for every issue in a milestone
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the milestone
+      # @return [Array<Sawyer::Resource>] A list of the labels across the milestone
+      # @see  http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
+      # @example List all labels for milestone #2 on octokit/octokit.rb
+      #   Octokit.labels_for_milestone("octokit/octokit.rb", 2)
+      def labels_for_milestone(repo, number, options = {})
+        paginate "#{Repository.path repo}/milestones/#{number}/labels", options
+      end
+    end
+  end
+end

data/lib/octokit/client/legacy_search.rb

@@ -0,0 +1,42 @@
+module Octokit
+  class Client
+
+    # Methods for the Legacy Search API
+    #
+    # @see https://developer.github.com/v3/search/
+    module LegacySearch
+
+      # Legacy repository search
+      #
+      # @see https://developer.github.com/v3/search/#search-repositories
+      # @param q [String] Search keyword
+      # @return [Array<Sawyer::Resource>] List of repositories found
+      def legacy_search_repositories(q, options = {})
+        get("legacy/repos/search/#{q}", options)['repositories']
+      end
+
+      # Legacy search issues within a repository
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param search_term [String] The term to search for
+      # @param state [String] :state (open) <tt>open</tt> or <tt>closed</tt>.
+      # @return [Array<Sawyer::Resource>] A list of issues matching the search term and state
+      # @example Search for 'test' in the open issues for sferik/rails_admin
+      #   Octokit.search_issues("sferik/rails_admin", 'test', 'open')
+      def legacy_search_issues(repo, search_term, state='open', options = {})
+        get("legacy/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options)['issues']
+      end
+
+      # Search for user.
+      #
+      # @param search [String] User to search for.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users.
+      # @see https://developer.github.com/v3/search/#search-users
+      # @example
+      #   Octokit.search_users('pengwynn')
+      def legacy_search_users(search, options = {})
+        get("legacy/user/search/#{search}", options)['users']
+      end
+    end
+  end
+end

data/lib/octokit/client/licenses.rb

@@ -0,0 +1,45 @@
+module Octokit
+  class Client
+
+    # Methods for licenses API
+    #
+    module Licenses
+
+      # List all licenses
+      #
+      # @see https://developer.github.com/v3/licenses/#list-all-licenses
+      # @return [Array<Sawyer::Resource>] A list of licenses
+      # @example
+      #   Octokit.licenses
+      def licenses(options = {})
+        options = ensure_api_media_type(:licenses, options)
+        paginate "licenses", options
+      end
+
+      # List an individual license
+      #
+      # @see https://developer.github.com/v3/licenses/#get-an-individual-license
+      # @param license_name [String] The license name
+      # @return <Sawyer::Resource> An individual license
+      # @example
+      #   Octokit.license 'mit'
+      def license(license_name, options = {})
+        options = ensure_api_media_type(:licenses, options)
+        get "licenses/#{license_name}", options
+      end
+
+      # Returns the contents of the repository’s license file, if one is detected.
+      #
+      # @see https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to 'master'.
+      # @return [Sawyer::Resource] The detail of the license file
+      # @example
+      #   Octokit.license_contents 'benbalter/licensee'
+      def repository_license_contents(repo, options = {})
+        options = ensure_api_media_type(:licenses, options)
+        get "#{Repository.path repo}/license", options
+      end
+    end
+  end
+end

data/lib/octokit/client/markdown.rb

@@ -0,0 +1,27 @@
+module Octokit
+  class Client
+
+    # Methods for the Markdown API
+    #
+    # @see https://developer.github.com/v3/markdown/
+    module Markdown
+
+      # Render an arbitrary Markdown document
+      #
+      # @param text [String] Markdown source
+      # @option options [String] (optional) :mode (`markdown` or `gfm`)
+      # @option options [String] (optional) :context Repo context
+      # @return [String] HTML renderization
+      # @see https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document
+      # @example Render some GFM
+      #   Octokit.markdown('Fixed in #111', :mode => "gfm", :context => "octokit/octokit.rb")
+      def markdown(text, options = {})
+        options[:text] = text
+        options[:repo] = Repository.new(options[:repo]) if options[:repo]
+        options[:accept] = 'application/vnd.github.raw'
+
+        post "markdown", options
+      end
+    end
+  end
+end

data/lib/octokit/client/meta.rb

@@ -0,0 +1,21 @@
+module Octokit
+  class Client
+
+    # Methods for the Meta API
+    #
+    # @see https://developer.github.com/v3/meta/
+    module Meta
+
+      # Get meta information about GitHub.com, the service.
+      # @see https://developer.github.com/v3/meta/#meta
+      # @return [Sawyer::Resource] Hash with meta information.
+      # @example Get GitHub meta information
+      #   @client.github_meta
+      def meta(options = {})
+        get "meta", options
+      end
+      alias :github_meta :meta
+
+    end
+  end
+end

data/lib/octokit/client/milestones.rb

@@ -0,0 +1,87 @@
+module Octokit
+  class Client
+
+    # Methods for the Issues Milestones API
+    #
+    # @see https://developer.github.com/v3/issues/milestones/
+    module Milestones
+
+      # List milestones for a repository
+      #
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
+      # @param options [Hash] 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] :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>.
+      # @return [Array<Sawyer::Resource>] A list of milestones for a repository.
+      # @see https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
+      # @example List milestones for a repository
+      #   Octokit.list_milestones("octokit/octokit.rb")
+      def list_milestones(repository, options = {})
+        paginate "#{Repository.path repository}/milestones", options
+      end
+      alias :milestones :list_milestones
+
+      # Get a single milestone for a repository
+      #
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :milestone Milestone number.
+      # @return [Sawyer::Resource] A single milestone from a repository.
+      # @see https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
+      # @example Get a single milestone for a repository
+      #   Octokit.milestone("octokit/octokit.rb", 1)
+      def milestone(repository, number, options = {})
+        get "#{Repository.path repository}/milestones/#{number}", options
+      end
+
+      # Create a milestone for a repository
+      #
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
+      # @param title [String] A unique title.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :description A meaningful description
+      # @option options [Time] :due_on Set if the milestone has a due date
+      # @return [Sawyer::Resource] A single milestone object
+      # @see https://developer.github.com/v3/issues/milestones/#create-a-milestone
+      # @example Create a milestone for a repository
+      #   Octokit.create_milestone("octokit/octokit.rb", "0.7.0", {:description => 'Add support for v3 of Github API'})
+      def create_milestone(repository, title, options = {})
+        post "#{Repository.path repository}/milestones", options.merge({:title => title})
+      end
+
+      # Update a milestone for a repository
+      #
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [String, Integer] ID of the milestone
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :title A unique title.
+      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :description A meaningful description
+      # @option options [Time] :due_on Set if the milestone has a due date
+      # @return [Sawyer::Resource] A single milestone object
+      # @see https://developer.github.com/v3/issues/milestones/#update-a-milestone
+      # @example Update a milestone for a repository
+      #   Octokit.update_milestone("octokit/octokit.rb", 1, {:description => 'Add support for v3 of Github API'})
+      def update_milestone(repository, number, options = {})
+        patch "#{Repository.path repository}/milestones/#{number}", options
+      end
+      alias :edit_milestone :update_milestone
+
+      # Delete a single milestone for a repository
+      #
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :milestone Milestone number.
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/milestones/#delete-a-milestone
+      # @example Delete a single milestone from a repository
+      #   Octokit.delete_milestone("octokit/octokit.rb", 1)
+      def delete_milestone(repository, number, options = {})
+        boolean_from_response :delete, "#{Repository.path repository}/milestones/#{number}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/notifications.rb

@@ -0,0 +1,171 @@
+module Octokit
+  class Client
+
+    # Methods for the Notifications API
+    #
+    # @see https://developer.github.com/v3/activity/notifications/
+    module Notifications
+
+      # List your notifications
+      #
+      # @param options [Hash] Optional parameters
+      # @option options [Boolean] :all 'true' to show notifications marked as
+      #   read.
+      # @option options [Boolean] :participating 'true' to show only
+      #   notifications in which the user is directly participating or
+      #   mentioned.
+      # @option options [String] :since Time filters out any notifications
+      #   updated before the given time. The time should be passed in as UTC in
+      #   the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      # @return [Array<Sawyer::Resource>] Array of notifications.
+      # @see https://developer.github.com/v3/activity/notifications/#list-your-notifications
+      # @example Get users notifications
+      #   @client.notifications
+      # @example Get all notifications since a certain time.
+      #   @client.notifications({all: true, since: '2012-10-09T23:39:01Z'})
+      def notifications(options = {})
+        paginate "notifications", options
+      end
+
+      # List your notifications in a repository
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Optional parameters
+      # @option options [Boolean] :all 'true' to show notifications marked as
+      #   read.
+      # @option options [Boolean] :participating 'true' to show only
+      #   notifications in which the user is directly participating or
+      #   mentioned.
+      # @option options [String] :since Time filters out any notifications
+      #   updated before the given time. The time should be passed in as UTC in
+      #   the ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      # @return [Array<Sawyer::Resource>] Array of notifications.
+      # @see https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository
+      # @example Get your notifications for octokit/octokit.rb
+      #   @client.repository_notifications('octokit/octokit.rb')
+      # @example Get your notifications for octokit/octokit.rb since a time.
+      #   @client.repository_notifications({since: '2012-10-09T23:39:01Z'})
+      def repository_notifications(repo, options = {})
+        paginate "#{Repository.path repo}/notifications", options
+      end
+      alias :repo_notifications :repository_notifications
+
+      # Mark notifications as read
+      #
+      # @param options [Hash] Optional parameters
+      # @option options [Boolean] :unread Changes the unread status of the
+      #   threads.
+      # @option options [Boolean] :read Inverse of 'unread'.
+      # @option options [String] :last_read_at ('Now') Describes the last point
+      #   that notifications were checked. Anything updated since this time
+      #   will not be updated. The time should be passed in as UTC in the
+      #   ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      # @return [Boolean] True if marked as read, false otherwise
+      # @see https://developer.github.com/v3/activity/notifications/#mark-as-read
+      #
+      # @example
+      #   @client.mark_notifications_as_read
+      def mark_notifications_as_read(options = {})
+        request :put, "notifications", options
+
+        last_response.status == 205
+      end
+
+      # Mark notifications from a specific repository as read
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param options [Hash] Optional parameters
+      # @option options [Boolean] :unread Changes the unread status of the
+      #   threads.
+      # @option options [Boolean] :read Inverse of 'unread'.
+      # @option options [String] :last_read_at ('Now') Describes the last point
+      #   that notifications were checked. Anything updated since this time
+      #   will not be updated. The time should be passed in as UTC in the
+      #   ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ. Ex. '2012-10-09T23:39:01Z'
+      # @return [Boolean] True if marked as read, false otherwise
+      # @see https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository
+      # @example
+      #   @client.mark_notifications_as_read("octokit/octokit.rb")
+      def mark_repository_notifications_as_read(repo, options = {})
+        request :put, "#{Repository.path repo}/notifications", options
+
+        last_response.status == 205
+      end
+      alias :mark_repo_notifications_as_read :mark_repository_notifications_as_read
+
+      # List notifications for a specific thread
+      #
+      # @param thread_id [Integer] Id of the thread.
+      # @return [Array<Sawyer::Resource>] Array of notifications.
+      # @see https://developer.github.com/v3/activity/notifications/#view-a-single-thread
+      #
+      # @example
+      #   @client.notification_thread(1000)
+      def thread_notifications(thread_id, options = {})
+        get "notifications/threads/#{thread_id}", options
+      end
+
+      # Mark thread as read
+      #
+      # @param thread_id [Integer] Id of the thread to update.
+      # @param options [Hash] Optional parameters.
+      # @option options [Boolean] :unread Changes the unread status of the
+      #   threads.
+      # @option options [Boolean] :read Inverse of 'unread'.
+      # @return [Boolean] True if updated, false otherwise.
+      # @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
+      # @example
+      #   @client.mark_thread_as_read(1, :read => false)
+      def mark_thread_as_read(thread_id, options = {})
+        request :patch, "notifications/threads/#{thread_id}", options
+
+        last_response.status == 205
+      end
+
+      # Get thread subscription
+      #
+      # @param thread_id [Integer] Id of the thread.
+      # @return [Sawyer::Resource] Subscription.
+      # @see https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription
+      # @example
+      #   @client.thread_subscription(1)
+      def thread_subscription(thread_id, options = {})
+        get "notifications/threads/#{thread_id}/subscription", options
+      end
+
+      # Update thread subscription
+      #
+      # This lets you subscribe to a thread, or ignore it. Subscribing to a
+      # thread is unnecessary if the user is already subscribed to the
+      # repository. Ignoring a thread will mute all future notifications (until
+      # you comment or get @mentioned).
+      #
+      # @param thread_id [Integer] Id of the thread.
+      # @param options
+      # @option options [Boolean] :subscribed Determines if notifications
+      #   should be received from this repository.
+      # @option options [Boolean] :ignored Deterimines if all notifications
+      #   should be blocked from this repository.
+      # @return [Sawyer::Resource] Updated subscription.
+      # @see https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription
+      # @example Subscribe to notifications
+      #   @client.update_thread_subscription(1, :subscribed => true)
+      # @example Ignore notifications from a repo
+      #   @client.update_thread_subscription(1, :ignored => true)
+      def update_thread_subscription(thread_id, options = {})
+        put "notifications/threads/#{thread_id}/subscription", options
+      end
+
+      # Delete a thread subscription
+      #
+      # @param thread_id [Integer] Id of the thread.
+      # @return [Boolean] True if delete successful, false otherwise.
+      # @see https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription
+      # @example
+      #   @client.delete_thread_subscription(1)
+      def delete_thread_subscription(thread_id, options = {})
+        boolean_from_response :delete, "notifications/threads/#{thread_id}/subscription", options
+      end
+    end
+  end
+end