octodoggy 4.6.2

data/lib/octokit/client/deployments.rb

@@ -0,0 +1,62 @@
+module Octokit
+  class Client
+
+    # Methods for the Deployments API
+    #
+    # @see https://developer.github.com/v3/repos/commits/deployments/
+    module Deployments
+
+      # List all deployments for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of deployments
+      # @see https://developer.github.com/v3/repos/deployments/#list-deployments
+      def deployments(repo, options = {})
+        get("#{Repository.path repo}/deployments", options)
+      end
+      alias :list_deployments :deployments
+
+      # Create a deployment for a ref
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param ref [String] The ref to deploy
+      # @option options [String] :task Used by the deployment system to allow different execution paths. Defaults to "deploy".
+      # @option options [String] :payload Meta info about the deployment
+      # @option options [Boolean] :auto_merge Optional parameter to merge the default branch into the requested deployment branch if necessary. Default: true
+      # @option options [Array<String>] :required_contexts Optional array of status contexts verified against commit status checks.
+      # @option options [String] :environment Optional name for the target deployment environment (e.g., production, staging, qa). Default: "production"
+      # @option options [String] :description Optional short description.
+      # @return [Sawyer::Resource] A deployment
+      # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment
+      def create_deployment(repo, ref, options = {})
+        options[:ref] = ref
+        post("#{Repository.path repo}/deployments", options)
+      end
+
+      # List all statuses for a Deployment
+      #
+      # @param deployment_url [String] A URL for a deployment resource
+      # @return [Array<Sawyer::Resource>] A list of deployment statuses
+      # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
+      def deployment_statuses(deployment_url, options = {})
+        deployment = get(deployment_url, :accept => options[:accept])
+        get(deployment.rels[:statuses].href, options)
+      end
+      alias :list_deployment_statuses :deployment_statuses
+
+      # Create a deployment status for a Deployment
+      #
+      # @param deployment_url [String] A URL for a deployment resource
+      # @param state [String] The state: pending, success, failure, error
+      # @option options [String] :target_url The target URL to associate with this status. Default: ""
+      # @option options [String] :description A short description of the status. Maximum length of 140 characters. Default: ""
+      # @return [Sawyer::Resource] A deployment status
+      # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
+      def create_deployment_status(deployment_url, state, options = {})
+        deployment = get(deployment_url, :accept => options[:accept])
+        options[:state] = state.to_s.downcase
+        post(deployment.rels[:statuses].href, options)
+      end
+    end
+  end
+end

data/lib/octokit/client/downloads.rb

@@ -0,0 +1,50 @@
+module Octokit
+  class Client
+
+    # Methods for the Repo Downloads API
+    #
+    # @see https://developer.github.com/v3/repos/downloads/
+    module Downloads
+
+      # List available downloads for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A Github Repository
+      # @return [Array] A list of available downloads
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
+      # @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository
+      # @example List all downloads for Github/Hubot
+      #   Octokit.downloads("github/hubot")
+      def downloads(repo, options={})
+        paginate "#{Repository.path repo}/downloads", options
+      end
+      alias :list_downloads :downloads
+
+      # Get single download for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] ID of the download
+      # @return [Sawyer::Resource] A single download from the repository
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
+      # @see https://developer.github.com/v3/repos/downloads/#get-a-single-download
+      # @example Get the "Robawt" download from Github/Hubot
+      #   Octokit.download("github/hubot")
+      def download(repo, id, options={})
+        get "#{Repository.path repo}/downloads/#{id}", options
+      end
+
+      # Delete a single download for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer] ID of the download
+      # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
+      # @see https://developer.github.com/v3/repos/downloads/#delete-a-download
+      # @return [Boolean] Status
+      # @example Get the "Robawt" download from Github/Hubot
+      #   Octokit.delete_download("github/hubot", 1234)
+      def delete_download(repo, id, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/downloads/#{id}", options
+      end
+
+    end
+  end
+end

data/lib/octokit/client/emojis.rb

@@ -0,0 +1,18 @@
+module Octokit
+  class Client
+
+    # Methods for the Emojis API
+    module Emojis
+
+      # List all emojis used on GitHub
+      #
+      # @return [Sawyer::Resource] A list of all emojis on GitHub
+      # @see https://developer.github.com/v3/emojis/#emojis
+      # @example List all emojis
+      #   Octokit.emojis
+      def emojis(options = {})
+        get "emojis", options
+      end
+    end
+  end
+end

data/lib/octokit/client/events.rb

@@ -0,0 +1,151 @@
+module Octokit
+  class Client
+
+    # Method for the Events API
+    #
+    # @see https://developer.github.com/v3/activity/events/
+    # @see https://developer.github.com/v3/issues/events/
+    module Events
+
+      # List all public events for GitHub
+      #
+      # @return [Array<Sawyer::Resource>] A list of all public events from GitHub
+      # @see https://developer.github.com/v3/activity/events/#list-public-events
+      # @example List all pubilc events
+      #   Octokit.public_events
+      def public_events(options = {})
+        paginate "events", options
+      end
+
+      # List all user events
+      #
+      # @param user [Integer, String] GitHub user login or id.
+      # @return [Array<Sawyer::Resource>] A list of all user events
+      # @see https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
+      # @example List all user events
+      #   Octokit.user_events("sferik")
+      def user_events(user, options = {})
+        paginate "#{User.path user}/events", options
+      end
+
+      # List public user events
+      #
+      # @param user [Integer, String] GitHub user login or id
+      # @return [Array<Sawyer::Resource>] A list of public user events
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
+      # @example List public user events
+      #   Octokit.user_events("sferik")
+      def user_public_events(user, options = {})
+        paginate "#{User.path user}/events/public", options
+      end
+
+      # List events that a user has received
+      #
+      # @param user [Integer, String] GitHub user login or id
+      # @return [Array<Sawyer::Resource>] A list of all user received events
+      # @see https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
+      # @example List all user received events
+      #   Octokit.received_events("sferik")
+      def received_events(user, options = {})
+        paginate "#{User.path user}/received_events", options
+      end
+
+      # List public events a user has received
+      #
+      # @param user [Integer, String] GitHub user login or id
+      # @return [Array<Sawyer::Resource>] A list of public user received events
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
+      # @example List public user received events
+      #   Octokit.received_public_events("sferik")
+      def received_public_events(user, options = {})
+        paginate "#{User.path user}/received_events/public", options
+      end
+
+      # List events for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of events for a repository
+      # @see https://developer.github.com/v3/activity/events/#list-repository-events
+      # @example List events for a repository
+      #   Octokit.repository_events("sferik/rails_admin")
+      def repository_events(repo, options = {})
+        paginate "#{Repository.path repo}/events", options
+      end
+
+      # List public events for a repository's network
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of events for a repository's network
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories
+      # @example List events for a repository's network
+      #   Octokit.repository_network_events("sferik/rails_admin")
+      def repository_network_events(repo, options = {})
+        paginate "networks/#{Repository.new(repo)}/events", options
+      end
+
+      # List all events for an organization
+      #
+      # Requires authenticated client.
+      #
+      # @param org [String] Organization GitHub handle
+      # @return [Array<Sawyer::Resource>] List of all events from a GitHub organization
+      # @see https://developer.github.com/v3/activity/events/#list-events-for-an-organization
+      # @example List events for the lostisland organization
+      #   @client.organization_events("lostisland")
+      def organization_events(org, options = {})
+        paginate "users/#{login}/events/orgs/#{org}", options
+      end
+
+      # List an organization's public events
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @return [Array<Sawyer::Resource>] List of public events from a GitHub organization
+      # @see https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
+      # @example List public events for GitHub
+      #   Octokit.organization_public_events("GitHub")
+      def organization_public_events(org, options = {})
+        paginate "#{Organization.path org}/events", options
+      end
+
+      # Get all Issue Events for a given Repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Array<Sawyer::Resource>] Array of all Issue Events for this Repository
+      # @see https://developer.github.com/v3/issues/events/#list-events-for-a-repository
+      # @see https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
+      # @example Get all Issue Events for Octokit
+      #   Octokit.repository_issue_events("octokit/octokit.rb")
+      def repository_issue_events(repo, options = {})
+        paginate "#{Repository.path repo}/issues/events", options
+      end
+      alias :repo_issue_events :repository_issue_events
+
+      # List events for an Issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Issue number
+      #
+      # @return [Array<Sawyer::Resource>] Array of events for that issue
+      # @see https://developer.github.com/v3/issues/events/#list-events-for-an-issue
+      # @example List all issues events for issue #38 on octokit/octokit.rb
+      #   Octokit.issue_events("octokit/octokit.rb", 38)
+      def issue_events(repo, number, options = {})
+        paginate "#{Repository.path repo}/issues/#{number}/events", options
+      end
+
+      # Get information on a single Issue Event
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Event number
+      #
+      # @return [Sawyer::Resource] A single Event for an Issue
+      # @see https://developer.github.com/v3/issues/events/#get-a-single-event
+      # @example Get Event information for ID 3094334 (a pull request was closed)
+      #   Octokit.issue_event("octokit/octokit.rb", 3094334)
+      def issue_event(repo, number, options = {})
+        paginate "#{Repository.path repo}/issues/events/#{number}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/feeds.rb

@@ -0,0 +1,33 @@
+module Octokit
+  class Client
+
+    # Methods for the Feeds API
+    #
+    # @see https://developer.github.com/v3/activity/feeds/
+    module Feeds
+
+      # List Feeds
+      #
+      # The feeds returned depend on authentication, see the GitHub API docs
+      # for more information.
+      #
+      # @return [Array<Sawyer::Resource>] list of feeds
+      # @see https://developer.github.com/v3/activity/feeds/#list-feeds
+      def feeds
+        get "feeds"
+      end
+
+      # Get a Feed by name
+      #
+      # @param name [Symbol, String] Name of feed to retrieve.
+      # @return [Feed] Parsed feed in the format returned by the configured
+      #   parser.
+      def feed(name, options = {})
+        if rel = feeds._links[name]
+          get rel.href, :accept => rel.type, :options => options
+        end
+      end
+
+    end
+  end
+end

data/lib/octokit/client/gists.rb

@@ -0,0 +1,233 @@
+module Octokit
+  class Client
+
+    # Methods for the Gists API
+    #
+    # @see https://developer.github.com/v3/gists/
+    module Gists
+
+      # List gists for a user or all public gists
+      #
+      # @param user [String] An optional user to filter listing
+      # @return [Array<Sawyer::Resource>] A list of gists
+      # @example Fetch all gists for defunkt
+      #   Octokit.gists('defunkt')
+      # @example Fetch all public gists
+      #   Octokit.gists
+      # @see https://developer.github.com/v3/gists/#list-gists
+      def gists(user=nil, options = {})
+        if user.nil?
+          paginate 'gists', options
+        else
+          paginate "#{User.path user}/gists", options
+        end
+      end
+      alias :list_gists :gists
+
+      # List public gists
+      #
+      # @return [Array<Sawyer::Resource>] A list of gists
+      # @example Fetch all public gists
+      #   Octokit.public_gists
+      # @see https://developer.github.com/v3/gists/#list-gists
+      def public_gists(options = {})
+        paginate 'gists/public', options
+      end
+
+      # List the authenticated user’s starred gists
+      #
+      # @return [Array<Sawyer::Resource>] A list of gists
+      # @see https://developer.github.com/v3/gists/#list-gists
+      def starred_gists(options = {})
+        paginate 'gists/starred', options
+      end
+
+      # Get a single gist
+      #
+      # @param gist [String] ID of gist to fetch
+      # @option options [String] :sha Specific gist revision SHA
+      # @return [Sawyer::Resource] Gist information
+      # @see https://developer.github.com/v3/gists/#get-a-single-gist
+      # @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
+      def gist(gist, options = {})
+        if sha = options.delete(:sha)
+          get "gists/#{Gist.new(gist)}/#{sha}", options
+        else
+          get "gists/#{Gist.new(gist)}", options
+        end
+      end
+
+      # Create a gist
+      #
+      # @param options [Hash] Gist information.
+      # @option options [String] :description
+      # @option options [Boolean] :public Sets gist visibility
+      # @option options [Array<Hash>] :files Files that make up this gist. Keys
+      #   should be the filename, the value a Hash with a :content key with text
+      #   content of the Gist.
+      # @return [Sawyer::Resource] Newly created gist info
+      # @see https://developer.github.com/v3/gists/#create-a-gist
+      def create_gist(options = {})
+        post 'gists', options
+      end
+
+      # Edit a gist
+      #
+      # @param options [Hash] Gist information.
+      # @option options [String] :description
+      # @option options [Hash] :files Files that make up this gist. Keys
+      #   should be the filename, the value a Hash with a :content key with text
+      #   content of the Gist.
+      #
+      #   NOTE: All files from the previous version of the
+      #   gist are carried over by default if not included in the hash. Deletes
+      #   can be performed by including the filename with a null hash.
+      # @return
+      #   [Sawyer::Resource] Newly created gist info
+      # @see https://developer.github.com/v3/gists/#edit-a-gist
+      # @example Update a gist
+      #   @client.edit_gist('some_id', {
+      #     :files => {"boo.md" => {"content" => "updated stuff"}}
+      #   })
+      def edit_gist(gist, options = {})
+        patch "gists/#{Gist.new(gist)}", options
+      end
+
+      # List gist commits
+      #
+      # @param gist [String] Gist ID
+      # @return [Array] List of commits to the gist
+      # @see https://developer.github.com/v3/gists/#list-gist-commits
+      # @example List commits for a gist
+      #   @client.gist_commits('some_id')
+      def gist_commits(gist, options = {})
+        paginate "gists/#{Gist.new(gist)}/commits", options
+      end
+
+      #
+      # Star a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicates if gist is starred successfully
+      # @see https://developer.github.com/v3/gists/#star-a-gist
+      def star_gist(gist, options = {})
+        boolean_from_response :put, "gists/#{Gist.new(gist)}/star", options
+      end
+
+      # Unstar a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicates if gist is unstarred successfully
+      # @see https://developer.github.com/v3/gists/#unstar-a-gist
+      def unstar_gist(gist, options = {})
+        boolean_from_response :delete, "gists/#{Gist.new(gist)}/star", options
+      end
+
+      # Check if a gist is starred
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicates if gist is starred
+      # @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
+      def gist_starred?(gist, options = {})
+        boolean_from_response :get, "gists/#{Gist.new(gist)}/star", options
+      end
+
+      # Fork a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Sawyer::Resource] Data for the new gist
+      # @see https://developer.github.com/v3/gists/#fork-a-gist
+      def fork_gist(gist, options = {})
+        post "gists/#{Gist.new(gist)}/forks", options
+      end
+
+      # List gist forks
+      #
+      # @param gist [String] Gist ID
+      # @return [Array] List of gist forks
+      # @see https://developer.github.com/v3/gists/#list-gist-forks
+      # @example List gist forks
+      #   @client.gist_forks('some-id')
+      def gist_forks(gist, options = {})
+        paginate "gists/#{Gist.new(gist)}/forks", options
+      end
+
+      # Delete a gist
+      #
+      # @param gist [String] Gist ID
+      # @return [Boolean] Indicating success of deletion
+      # @see https://developer.github.com/v3/gists/#delete-a-gist
+      def delete_gist(gist, options = {})
+        boolean_from_response :delete, "gists/#{Gist.new(gist)}", options
+      end
+
+      # List gist comments
+      #
+      # @param gist_id [String] Gist Id.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing comments.
+      # @see https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
+      # @example
+      #   Octokit.gist_comments('3528ae645')
+      def gist_comments(gist_id, options = {})
+        paginate "gists/#{gist_id}/comments", options
+      end
+
+      # Get gist comment
+      #
+      # @param gist_id [String] Id of the gist.
+      # @param gist_comment_id [Integer] Id of the gist comment.
+      # @return [Sawyer::Resource] Hash representing gist comment.
+      # @see https://developer.github.com/v3/gists/comments/#get-a-single-comment
+      # @example
+      #   Octokit.gist_comment('208sdaz3', 1451398)
+      def gist_comment(gist_id, gist_comment_id, options = {})
+        get "gists/#{gist_id}/comments/#{gist_comment_id}", options
+      end
+
+      # Create gist comment
+      #
+      # Requires authenticated client.
+      #
+      # @param gist_id [String] Id of the gist.
+      # @param comment [String] Comment contents.
+      # @return [Sawyer::Resource] Hash representing the new comment.
+      # @see https://developer.github.com/v3/gists/comments/#create-a-comment
+      # @example
+      #   @client.create_gist_comment('3528645', 'This is very helpful.')
+      def create_gist_comment(gist_id, comment, options = {})
+        options.merge!({:body => comment})
+        post "gists/#{gist_id}/comments", options
+      end
+
+      # Update gist comment
+      #
+      # Requires authenticated client
+      #
+      # @param gist_id [String] Id of the gist.
+      # @param gist_comment_id [Integer] Id of the gist comment to update.
+      # @param comment [String] Updated comment contents.
+      # @return [Sawyer::Resource] Hash representing the updated comment.
+      # @see https://developer.github.com/v3/gists/comments/#edit-a-comment
+      # @example
+      #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
+      def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
+        options.merge!({:body => comment})
+        patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
+      end
+
+      # Delete gist comment
+      #
+      # Requires authenticated client.
+      #
+      # @param gist_id [String] Id of the gist.
+      # @param gist_comment_id [Integer] Id of the gist comment to delete.
+      # @return [Boolean] True if comment deleted, false otherwise.
+      # @see https://developer.github.com/v3/gists/comments/#delete-a-comment
+      # @example
+      #   @client.delete_gist_comment('208sdaz3', '586399')
+      def delete_gist_comment(gist_id, gist_comment_id, options = {})
+        boolean_from_response(:delete, "gists/#{gist_id}/comments/#{gist_comment_id}", options)
+      end
+    end
+  end
+end