Merge 11a31c7 into ef690ae

lib/octokit/client.rb

@@ -26,6 +26,7 @@
 require 'octokit/client/emojis'
 require 'octokit/client/statuses'
 require 'octokit/client/say'
+require 'octokit/client/stats'
 require 'octokit/client/rate_limit'
 require 'octokit/client/gitignore'
 require 'octokit/client/github'
@@ -69,6 +70,7 @@ def initialize(options={})
     include Octokit::Client::Emojis
     include Octokit::Client::Statuses
     include Octokit::Client::Say
+    include Octokit::Client::Stats
     include Octokit::Client::RateLimit
     include Octokit::Client::Gitignore
     include Octokit::Client::GitHub

lib/octokit/client/stats.rb

@@ -0,0 +1,81 @@
+module Octokit
+  class Client
+    module Stats
+
+    # Get contributors list with additions, deletions, and commit counts
+    #
+    # @param repo [String, Hash, Repository] A GitHub repository
+    # @return [Array<Hashie::Mash>] Array of contributor stats
+    # @see http://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts
+    # @example Get contributor stats for octokit
+    #   @client.contributors_stats('pengwynn/octokit')
+    def contributors_stats(repo)
+      get_stats(repo, "contributors")
+    end
+    alias :contributor_stats :contributors_stats
+
+    # Get the last year of commit activity data
+    #
+    # @param repo [String, Hash, Repository] A GitHub repository
+    # @return [Array<Hashie::Mash>] The last year of commit activity grouped by
+    #   week. The days array is a group of commits per day, starting on Sunday.
+    # @see http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
+    # @example Get commit activity for octokit
+    #   @client.commit_activity_stats('pengwynn/octokit')
+    def commit_activity_stats(repo)
+      get_stats(repo, "commit_activity")
+    end
+
+    # Get the number of additions and deletions per week
+    #
+    # @param repo [String, Hash, Repository] A GitHub repository
+    # @return [Array<Hashie::Mash>] Weekly aggregate of the number of additions
+    #   and deletions pushed to a repository.
+    # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week
+    # @example Get code frequency stats for octokit
+    #   @client.code_frequency_stats('pengwynn/octokit')
+    def code_frequency_stats(repo)
+      get_stats(repo, "code_frequency")
+    end
+
+    # Get the weekly commit count for the repo owner and everyone else
+    #
+    # @param repo [String, Hash, Repository] A GitHub repository
+    # @return [Hashie::Mash] Total commit counts for the owner and total commit
+    #   counts in all. all is everyone combined, including the owner in the last
+    #   52 weeks. If you’d like to get the commit counts for non-owners, you can
+    #   subtract all from owner.
+    # @see http://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else
+    # @example Get weekly commit counts for octokit
+    #   @client.participation_stats("pengwynn/octokit")
+    def participation_stats(repo)
+      get_stats(repo, "participation")
+    end
+
+    # Get the number of commits per hour in each day
+    #
+    # @param repo [String, Hash, Repository] A GitHub repository
+    # @return [Array<Array>] Arrays containing the day number, hour number, and
+    #   number of commits 
+    # @see http://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day
+    # @example Get octokit punch card
+    #   @octokit.punch_card_stats
+    def punch_card_stats(repo)
+      get_stats(repo, "punch_card")
+    end
+    alias :punch_card :punch_card_stats
+
+    private
+
+    # @private Get stats for a repository
+    #
+    # @param repo [String, Hash, Repository] A GitHub repository
+    # @param metric [String] The metrics you are looking for
+    # @return [Array<Hashie::Mash>] Magical unicorn stats
+    def get_stats(repo, metric)
+      get("repos/#{Repository.new repo}/stats/#{metric}")
+    end
+
+    end
+  end
+end