File: community_profile.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 (21 lines) | stat: -rw-r--r-- 765 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
# frozen_string_literal: true

module Octokit
  class Client
    # Methods for the Community Profile API
    #
    # @see https://developer.github.com/v3/repos/community/
    module CommunityProfile
      # Get community profile metrics for a repository
      #
      # @param repo [Integer, String, Hash, Repository] A GitHub repository
      # @return [Sawyer::Resource] Community profile metrics
      # @see https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics
      # @example Get community profile metrics for octokit/octokit.rb
      #   @client.community_profile('octokit/octokit.rb')
      def community_profile(repo, options = {})
        get "#{Repository.path repo}/community/profile", options
      end
    end
  end
end