hubstats 0.4.4 → 0.5.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWQ3YTBhNDcwNThjYzIwYTQ4OTdiZjViM2RkYzAzYmZhYzIzNDE1Yg==
-  data.tar.gz: !binary |-
-    NjVlNzNhYjQwNzZlNmJmMjM5Nzk0MTQzOGNkZjQwNTE4NjBiNmE4ZQ==
+SHA1:
+  metadata.gz: ac76f0c7427aa69b1fe569a7736e653be077c6ff
+  data.tar.gz: 2ab26da5f449aa74f2c9f8e1d4980a2280e7ebcb
 SHA512:
-  metadata.gz: !binary |-
-    ZTdiMjlkOTY2NDdiMjc2ZDY5MTI3Njg5NjU5ZDE0OWI3MmQxMTI2NDVlOGI2
-    MGQyYmRmODU5MjY2YTRkZGJhMjRhMDg4NjYwMjlmYmY4ODBmMTQ0ZjNiYTEx
-    MjYwNDJhNGRlMWFkOTczZDBmNTNjN2NmZjFiN2QyNjQxOWU0OTU=
-  data.tar.gz: !binary |-
-    Mzk0NGU2YjZjZmEwMGUzYWQ5NjY4OGY3YWNmNThkNjA5ZmUzZWU3ZDU5MjQ0
-    Y2E3NmVmNDNiYTM3MGIwN2E2NWMzYzNmODg5ZWEwZGU4OGZjMTFhM2ZjZWNm
-    ZDJiYzk5MDk2OGUwYWM2ZjE5ZGRhMWU4ZjIzODY2MzNhZDA2OWI=
+  metadata.gz: d4b610a75cc65a56502fc1203947697d98ffcdff52104e3bd72cfb4d56a3b8f53c66506e5bed2c6ec827e76f5d6127076ce344c51339d0d0ed1d759fee64345a
+  data.tar.gz: 648a398af505e04760496ebab015e7da39d3b68b5831a840c1fbb8f42ed8cda798a3bef01d3603eccbc69c8a47dbd4185f9fdf6504a96f44ebaab40083850715

data/.ruby-gemset

@@ -0,0 +1 @@
+hubstats

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+#### v0.5.0
+* Adding teams and team commands, team sorting, and team metrics to Hubstats
+
+  > Emma Sax, Andy Fleener: Brian Bergstrom: https://github.com/sportngin/hubstats/pull/74
+
 #### v0.4.4
 #### v0.4.3
 * Fixes a bug introduced in v0.4.1 that removed the config method from Hubstats

data/README.md

@@ -3,58 +3,98 @@
 Hubstats is a rails plugin which allows you to search and monitor pull requests made across a collection of repositories. It also gives extra statistics about users and pull requests not found on GitHub.
 
 ## Setup
-
-The following setup is designed to only be used when integrating this plugin into a rails application or for when adding new migrations.
+The following setup is designed to only be used when integrating this plugin into a rails application.
 
  Run `rails generate hubstats:install`.
+ 
+ Configure `octokit.yml` with your GitHub information (see below).
 
  Run `rake hubstats:install:migrations`.
 
- Run `rake hubstats:setup` to run the necessary migrations and start pulling data from Github.
+ Run `rake hubstats:setup` to run the necessary migrations and start pulling data from GitHub.
 
  Add 'mount Hubstats::Engine => "/hubstats"' to your apps routes file.
 
 ## Configuration
-
 ### Authentication
+Hubstats needs GitHub credentials to access your repositories, these can be setup in one of two ways:
 
-Hubstats needs Github credentials to access your repos, these can be setup in one of two ways:
-
-#### Configuring the `octokit.yml`
-
-Add your GitHub API token or ClientID and Secret to `octokit.yml`.
+#### GitHub API Tokens
+Add your GitHub API token (called `access_token`) or ClientID and Secret to `octokit.yml`.
 
 #### Environment Variables
-
 Hubstats can also use OAUTH access tokens stored in ENV["GITHUB_API_TOKEN"] or for Application Authentication in ENV["CLIENT_ID"] and ENV["CLIENT_SECRET"], if for some reason you don't want to store them in `octokit.yml`.
 
-### Webhooks
+### Configuring Data to be Received from GitHub
+#### Organizations to Follow
+Hubstats tracks certain repositories and teams that are part of an organization. Therefore, you must whitelist the specific GitHub organization to track in `octokit.yml`. The list of organizations should look something like this:
 
-Hubstats uses GitHub webhooks to keep itself updated. It requires you to set a secret as well as an endpoint to push to.
+```
+org_list:
+ - sportngin
+ ```
+ 
+#### Repositories to Follow
+If you only want Hubstats to watch certain repositories, you can set it to watch a list of specific repositories in `octokit.yml`. Otherwise, the default will be for Hubstats to watch an entire organization's list of repositories. The list of repositories should look like either:
+
+```
+repo_list:
+ - sportngin/repo_one
+ - sportngin/repo_two
+ - sportngin/repo_three
+```
+
+#### Teams to Follow
+If you want Hubstats to watch certain teams to give back GitHub team metrics, then you must whitelist a list of teams in the `octokit.yml`. If no list of teams is added, then there will be no team metrics. The list of teams should look something like:
+
+```
+team_list:
+ - Team One
+ - Team Two
+ - Team Three
+```
+
+Also, the GitHub API token in `octokit.yml` must be a member of all of the teams listed in order to receive webhooks and populate team data.
+
+#### Users to Ignore
+If there are specific users that should not show up on any lists or in any metrics, then they can be placed on the `ignore_users_list` part of the `octokit.yml`. This list is referenced when making the list of users in teams. The list of users to ignore should look like:
+
+```
+ignore_users_list:
+ - user_login_one
+ - user_login_two
+ - user_login_three
+```
 
-To generate a secret run:
+### Webhooks
+Hubstats uses GitHub webhooks to keep its data updated. It requires you to set a secret as well as an endpoint to push to.
 
+To generate a secret run:
  ```
  ruby -rsecurerandom -e 'puts SecureRandom.hex(20)'
  ``` 
-
 Set the endpoint to be:
 
  www.yourdomain.com/hubstats/handler
 
-### Repositories 
-
-Hubstats needs to know what repos for it to watch. You can set it to watch either an entire organization or a list of specific repos in octokit.yml.
-
 ## Testing
-
-All of the automated tests are written in RSpec. Since hubstats is a plugin, not an application, we need to install the plugin into a Rails application to run. The `test` directory is a dummy rails application for manually testing the UI by serving hubstats locally. When developing and using the `test/dummy` locally, then the test will automatically sync with any updated code, so it doesn't need to be re-served when changes are made with the normal Rails application. When in the development process, one just needs to run `bundle exec rails s` once from the command line (while in `test/dummy`) to serve the plugin. http://guides.rubyonrails.org/plugins.html will give more information on the implementation of a Rails plugin. 
+All of the automated tests are written in RSpec. To run these tests, run the following commands, assuming that there are two already existent local databases titled `hubstats_development` and `hubstats_test`:
+```
+cd test/dummy/
+rake db:test:prepare
+bundle exec rspec
+```
+To test what Hubstats would actually look like on a web browser, we need to install the plugin into a Rails application to run. This is because Hubstats is a plugin, not an application. The `test` directory is also a dummy rails application for manually testing the UI by serving Hubstats locally. When developing and using the `test/dummy` locally, then the test will automatically sync with any updated code, so it doesn't need to be re-served when changes are made with the normal Rails application. When in the development process, one just needs to run:
+```
+cd test/dummy/
+bundle exec rails s
+```
+to serve the plugin. http://guides.rubyonrails.org/plugins.html will give more information on the implementation of a Rails plugin. 
 
 ## TL:DR
-
   Run `rails generate hubstats:install`.
   
-  Configure `octokit.yml` with your Github information.
+  Configure `octokit.yml` with your GitHub information (see above).
   
   Run `rake hubstats:install:migrations`.
   
@@ -62,4 +102,6 @@ All of the automated tests are written in RSpec. Since hubstats is a plugin, not
   
   Add 'mount Hubstats::Engine => "/hubstats"' to your routes file.
 
+<hr>
+
 This project rocks and uses MIT-LICENSE.

data/app/assets/javascripts/hubstats/pull_requests.js

@@ -35,6 +35,11 @@ $(document).ready(function() {
     var ids = $("#users").val();
     updateQueryStringParameter(queryParameters,"users",ids);
   });
+
+  $("#teams").change(function() {
+    var ids = $("#teams").val();
+    updateQueryStringParameter(queryParameters,"teams",ids);
+  });
 });
 
 /**

data/app/assets/javascripts/hubstats/select2.js

@@ -5,6 +5,7 @@
 $(document).ready(function() { 
   usersIDs = queryParameters["users"] ? queryParameters["users"].replace("%2C", ",") : "";
   reposIDs = queryParameters["repos"] ? queryParameters["repos"].replace("%2C", ",") : "";
+  teamsIDs = queryParameters["teams"] ? queryParameters["teams"].replace("%2C", ",") : "";
 
   $("#repos").select2({
     placeholder: "Repositories",
@@ -45,8 +46,48 @@ $(document).ready(function() {
         });
       }
     }
-  }).select2('val', []); 
+  }).select2('val', []);
 
+  $("#teams").select2({
+    placeholder: "Teams",
+    multiple: true,
+    ajax: {
+      url: getPath("team"),
+      dataType: 'json',
+      quietMillis: 100,
+      data: function (term) {
+        return {
+          query: term
+        };
+      },
+      results: function (data) {
+        return {
+          results: $.map(data, function (team) {
+            return {
+              text: team.name,
+              id: team.id
+            }
+          })
+        };
+      }
+    },
+    initSelection: function(element, callback) {
+      if (teamsIDs !== "") {
+        $.ajax(getPath("team"), {
+          data: { id: teamsIDs },
+          dataType: "json"
+        }).done(function (data) { callback(
+            $.map(data, function (team) {
+              return {
+                text: team.name,
+                id: team.id
+              }
+            })
+          ); 
+        });
+      }
+    }
+  }).select2('val', []); 
 
   $("#users").select2({
     placeholder: "Users",
@@ -96,7 +137,9 @@ $(document).ready(function() {
  */
 function getPath (model) {
   if (model == 'user') {
-    return $("#brand").attr('data-user-path');}
-  else if (model == 'repo')
+    return $("#brand").attr('data-user-path');
+  } else if (model == 'repo') {
     return $("#brand").attr('data-repo-path');
+  } else if (model == 'team')
+    return $("#brand").attr('data-team-path');
 };

data/app/assets/javascripts/hubstats/users.js

@@ -37,6 +37,14 @@ $(document).ready(function() {
   $("#deletions").on("click", function(){
     toggleOrder(queryParameters,$(this).attr('id'));
   });
+
+  $("#repocount").on("click", function(){
+    toggleOrder(queryParameters,$(this).attr('id'));
+  });
+
+  $("#usercount").on("click", function(){
+    toggleOrder(queryParameters,$(this).attr('id'));
+  });
 });
 
 /* toggleOrder

data/app/assets/stylesheets/hubstats/application.css

@@ -36,12 +36,14 @@
   top: 8px;
 }
 
+/*For the footer*/
 .footer-main-text {
   font-size: 18px;
   color: #B0B0B0;
   text-align: center;
 }
 
+/*For the footer*/
 .footer-text {
   font-size: 12px;
   color: #A0A0A0;
@@ -107,7 +109,7 @@
 
 /*For the lists of repos, pull requests, deploys, comments, and users*/
 
-.pulls, .comments, .users, .repos, .deploys {
+.pulls, .comments, .users, .repos, .teams, .deploys {
   margin: 15px 0px 15px 0px;
   border: 1px solid #ccc;
   border-radius: 5px;
@@ -125,6 +127,7 @@
 .row .single-comment,
 .row .single-user,
 .row .single-repo,
+.row .single-team,
 .row .single-deploy {
   padding:5px;
   margin: 0px;
@@ -148,6 +151,7 @@
 .single-pull > .pull-info,
 .single-user > .user-info,
 .single-repo > .repo-info,
+.single-team > .team-info,
 .single-deploy > .deploy-info, {
   padding: 0px;
 }

data/app/controllers/hubstats/pull_requests_controller.rb

@@ -14,8 +14,8 @@ module Hubstats
       pull_requests = PullRequest.all_filtered(params, @start_date, @end_date)
       @labels = Hubstats::Label.count_by_pull_requests(pull_requests).order("pull_request_count DESC")
 
-      @pull_requests = Hubstats::PullRequest.includes(:user, :repo)
-        .belonging_to_users(params[:users]).belonging_to_repos(params[:repos])
+      @pull_requests = Hubstats::PullRequest.includes(:user, :repo, :team)
+        .belonging_to_users(params[:users]).belonging_to_repos(params[:repos]).belonging_to_teams(params[:teams])
         .group_by(params[:group]).with_label(params[:label])
         .state_based_order(@start_date, @end_date, params[:state], params[:order])
         .paginate(:page => params[:page], :per_page => 15)
@@ -40,6 +40,5 @@ module Hubstats
         deletions: @pull_request.deletions.to_i
       }
     end
-
   end
 end

data/app/controllers/hubstats/repos_controller.rb

@@ -46,16 +46,10 @@ module Hubstats
     #
     # Returns - the stats for the entirety of Hubstats and all repos
     def dashboard
-      if params[:query] ## For select 2
-        @repos = Hubstats::Repo.where("name LIKE ?", "%#{params[:query]}%").order("name ASC")
-      elsif params[:id]
-        @repos = Hubstats::Repo.where(id: params[:id].split(",")).order("name ASC")
-      else
-        @repos = Hubstats::Repo.with_all_metrics(@start_date, @end_date)
-          .with_id(params[:repos])
-          .custom_order(params[:order])
-          .paginate(:page => params[:page], :per_page => 15)
-      end
+      @repos = Hubstats::Repo.with_all_metrics(@start_date, @end_date)
+        .with_id(params[:repos])
+        .custom_order(params[:order])
+        .paginate(:page => params[:page], :per_page => 15)
 
       @user_count = Hubstats::User.with_pulls_or_comments_or_deploys(@start_date, @end_date).only_active.length
       @deploy_count = Hubstats::Deploy.deployed_in_date_range(@start_date, @end_date).count(:all)
@@ -74,8 +68,9 @@ module Hubstats
       end
     end
 
-    # stats
-    # Will assign all of the stats for both the show page and the dashboard page.
+    # Public - Will assign all of the stats for both the show page and the dashboard page.
+    #
+    # Returns - the data in two hashes
     def stats
       @additions ||= 0
       @deletions ||= 0

data/app/controllers/hubstats/teams_controller.rb

@@ -0,0 +1,62 @@
+require_dependency "hubstats/application_controller"
+
+module Hubstats
+  class TeamsController < Hubstats::BaseController
+
+    # Public - Shows all of the teams by filter params lists them with metrics between the start date and end date.
+    #
+    # Returns - the team data
+    def index
+      if params[:query] ## For select 2
+        @teams = Hubstats::Team.where("name LIKE ?", "%#{params[:query]}%").order("name ASC")
+      elsif params[:id]
+        @teams = Hubstats::Team.where(id: params[:id].split(",")).order("name ASC")
+      else
+        @teams = Hubstats::Team.where(hubstats: true).with_all_metrics(@start_date, @end_date)
+          .with_id(params[:teams])
+          .custom_order(params[:order])
+          .paginate(:page => params[:page], :per_page => 15)
+      end
+
+      respond_to do |format|
+        format.html # index.html.erb
+        format.json { render :json => @teams}
+      end
+    end
+
+    # Public - Will show the specific team along with the basic stats about that team, including all users
+    # and merged PRs a team member has done within the @start_date and @end_date.
+    #
+    # Returns - the data of the specific team
+    def show
+      @team = Hubstats::Team.where(id: params[:id]).first
+      @pull_requests = Hubstats::PullRequest.belonging_to_team(@team.id).merged_in_date_range(@start_date, @end_date).order("updated_at DESC").limit(20)
+      @pull_count = Hubstats::PullRequest.belonging_to_team(@team.id).merged_in_date_range(@start_date, @end_date).count(:all)
+      @users = @team.users.where("login NOT IN (?)", Hubstats.config.github_config["ignore_users_list"]).order("login ASC")
+      @user_count = @users.length
+      @comment_count = Hubstats::Comment.belonging_to_team(@users.pluck(:id)).created_in_date_range(@start_date, @end_date).count(:all)
+      @net_additions = Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_team(@team.id).sum(:additions).to_i -
+                       Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_team(@team.id).sum(:deletions).to_i
+      @additions = Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_team(@team.id).average(:additions)
+      @deletions = Hubstats::PullRequest.merged_in_date_range(@start_date, @end_date).belonging_to_team(@team.id).average(:deletions)      
+
+      stats
+    end
+
+    # Public - Shows the basic stats for the teams show page.
+    #
+    # Returns - the data in two hashes
+    def stats
+      @additions ||= 0
+      @deletions ||= 0
+      @stats_basics = {
+        pull_count: @pull_count,
+        user_count: @user_count,
+        comment_count: @comment_count,
+        avg_additions: @additions.round.to_i,
+        avg_deletions: @deletions.round.to_i,
+        net_additions: @net_additions
+      }
+    end
+  end
+end

data/app/controllers/hubstats/users_controller.rb

@@ -14,14 +14,14 @@ module Hubstats
         @users = Hubstats::User.where(id: params[:id].split(",")).order("login ASC")
       elsif params[:repos]
         @users = Hubstats::User.only_active.with_contributions(@start_date, @end_date, params[:repos])
-            .with_id(params[:users])
-            .custom_order(params[:order])
-            .paginate(:page => params[:page], :per_page => 15)
+          .with_id(params[:users])
+          .custom_order(params[:order])
+          .paginate(:page => params[:page], :per_page => 15)
       else
         @users = Hubstats::User.only_active.with_all_metrics(@start_date, @end_date)
-            .with_id(params[:users])
-            .custom_order(params[:order])
-            .paginate(:page => params[:page], :per_page => 15)
+          .with_id(params[:users])
+          .custom_order(params[:order])
+          .paginate(:page => params[:page], :per_page => 15)
       end
       
       respond_to do |format|
@@ -49,8 +49,9 @@ module Hubstats
       stats
     end
 
-    # stats
-    # Shows the basic stats for both the user show page.
+    # Public - Shows the basic stats for the user show page.
+    #
+    # Returns - the data in a hash
     def stats
       @additions ||= 0
       @deletions ||= 0