Sha256: bfaa9ccf2ee6bb643c25f74485d215f37092f8539ed6d54f4070671bdfb9534b

Contents?: true

Size: 1.49 KB

Versions: 8

Compression:

Stored size: 1.49 KB

Contents

module Octokit
  class Client
    module Events
      # List all public events for GitHub
      #
      # @return [Array] A list of all public events from GitHub
      # @see http://developer.github.com/v3/events
      # @example List all pubilc events
      #   Octokit.public_events
      def public_events(options={})
        get("/events", options, 3)
      end
      
      # List all user events
      #
      # @return [Array] A list of all user events
      # @see http://developer.github.com/v3/events
      # @example List all user events
      #   Octokit.user_events("sferik")
      def user_events(user, options={})
        get("/users/#{user}/events", options, 3)
      end

      # List events that a user has received
      #
      # @return [Array] A list of all user received events
      # @see http://developer.github.com/v3/received_events
      # @example List all user received events
      #   Octokit.received_events("sferik")
      def received_events(user, options={})
        get("/users/#{user}/received_events", options, 3)
      end

      # List events for a repository
      #
      # @param repo [String, Repository, Hash] A GitHub repository
      # @return [Array] A list of events for a repository
      # @see http://developer.github.com/v3/events
      # @example List events for a repository
      #   Octokit.repository_events("sferik/rails_admin")
      def repository_events(repo, options={})
        get("/repos/#{Repository.new(repo)}/events", options, 3)
      end
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
octokit-1.8.0 lib/octokit/client/events.rb
octokit-1.7.0 lib/octokit/client/events.rb
octokit-1.6.1 lib/octokit/client/events.rb
octokit-1.6.0 lib/octokit/client/events.rb
octokit-1.5.0 lib/octokit/client/events.rb
octokit-1.4.0 lib/octokit/client/events.rb
octokit-1.3.0 lib/octokit/client/events.rb
octokit-1.2.1 lib/octokit/client/events.rb