File: feeds.rb

package info (click to toggle)
ruby-octokit 10.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 24,092 kB
  • sloc: ruby: 13,339; sh: 99; makefile: 7; javascript: 3
file content (32 lines) | stat: -rw-r--r-- 854 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# frozen_string_literal: true

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