teachers_pet 0.2.0 → 0.3.0

data/lib/teachers_pet/actions/create_repos.rb

@@ -1,45 +1,27 @@
-# Author: Mike Helmick
-# Script to create assignment repositories for students under the appropriate organization
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
-
-require 'rubygems'
-require 'highline/question'
-require 'highline/import'
-require 'highline/compatibility'
-require 'teachers_pet/actions/base'
-
 module TeachersPet
   module Actions
     class CreateRepos < Base
       def read_info
-        @repository = ask('What repository name should be created for each student?') { |q| q.validate = /\w+/ }
-        @organization = ask("What is the organization name?") { |q| q.default = TeachersPet::Configuration.organization }
-        @student_file = self.get_students_file_path
-        @instructor_file = self.get_instructors_file_path
-        @public_repos = confirm('Create repositories as public?', false)
-        @add_init_files = confirm('Add .gitignore and README.md files? (skip this if you are pushing starter files.)', false)        
+        @repository = self.repository
+        @organization = self.organization
+        @public_repos = self.public?
       end
 
       def load_files
-        @students = read_file(@student_file, 'Students')
-        @instructors = read_file(@instructor_file, 'Instructors')
+        @students = self.read_students_file
       end
 
       def create
-        pub_private_text = @public_repos ? 'public' : 'private'
-        confirm("Create #{@students.keys.size} #{pub_private_text} repositories for students and give access to instructors?")
-
         # create a repo for each student
         self.init_client
 
-        org_hash = read_organization(@organization)
+        org_hash = self.client.organization(@organization)
         abort('Organization could not be found') if org_hash.nil?
         puts "Found organization at: #{org_hash[:login]}"
 
         # Load the teams - there should be one team per student.
         # Repositories are given permissions by teams
-        org_teams = get_teams_by_name(@organization)
+        org_teams = self.client.get_teams_by_name(@organization)
         # For each student - create a repository, and give permissions to their "team"
         # The repository name is teamName-repository
         puts "\nCreating assignment repositories for students..."
@@ -50,26 +32,21 @@ module TeachersPet
           end
           repo_name = "#{student}-#{@repository}"
 
-          if repository?(@organization, repo_name)
+          if self.client.repository?(@organization, repo_name)
             puts " --> Already exists, skipping '#{repo_name}'"
             next
           end
 
-          git_ignore_template = "C++" ## This is specific to my current class, you'll want to change
-          git_ignore_template = '' unless @add_init_files
           puts " --> Creating '#{repo_name}' public? #{@public_repos}"
-          @client.create_repository(repo_name,
-              {
-                :description => "#{@repository} created for #{student}",
-                :private => !@public_repos,
-                :has_issues => true, # seems like a resonable default
-                :has_wiki => false,
-                :has_downloads => false,
-                :organization => @organization,
-                :team_id => org_teams[student][:id],
-                :auto_init => @add_init_files,
-                :gitignore_template => git_ignore_template
-              })
+          self.client.create_repository(repo_name,
+            description: "#{@repository} created for #{student}",
+            private: !@public_repos,
+            has_issues: true,
+            has_wiki: false,
+            has_downloads: false,
+            organization: @organization,
+            team_id: org_teams[student][:id]
+          )
         end
       end
 

data/lib/teachers_pet/actions/create_student_teams.rb

@@ -0,0 +1,35 @@
+module TeachersPet
+  module Actions
+    class CreateStudentTeams < Base
+      def create_student_teams
+        teams_by_name = self.client.existing_teams_by_name(self.organization)
+
+        students_list = self.read_students_file
+        students_list.each do |key, value|
+          if value
+            # Create one team per group of students
+            team_name = key
+            usernames = value
+          else
+            # Create a team with the same name as the student, with that person as the only member
+            team_name = key
+            usernames = [value]
+          end
+
+          team = teams_by_name[team_name]
+          if team
+            puts "Team @#{organization}/#{team_name} already exists."
+          else
+            team = self.client.create_team(organization, team_name)
+          end
+          self.client.add_users_to_team(organization, team, usernames)
+        end
+      end
+
+      def run
+        self.init_client
+        self.create_student_teams
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/fork_collab.rb

@@ -1,33 +1,19 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
-
-require 'rubygems'
-require 'highline/question'
-require 'highline/import'
-require 'highline/compatibility'
-require 'teachers_pet/actions/base'
-
 module TeachersPet
   module Actions
     class ForkCollab < Base
-      def read_info
-        @repository = ask("Which repository? (owner/repo)")
-      end
-
       def get_forks
-        @client.forks(@repository)
+        self.client.forks(self.repository)
       end
 
       def promote
         self.init_client
-
         forks = self.get_forks
-
-        confirm("Are you sure you want to add #{forks.count} users as collaborators on '#{@repository}'?")
-
         forks.each do |fork|
           login = fork.owner.login
           if fork.owner.type == "User"
-            result = @client.add_collab(@repository, login)
+            unless self.dry_run?
+              result = self.client.add_collab(self.repository, login)
+            end
             puts "#{login} - #{result}"
           else
             puts "#{login} - false (Organization)"
@@ -36,7 +22,6 @@ module TeachersPet
       end
 
       def run
-        self.read_info
         self.promote
       end
     end

data/lib/teachers_pet/actions/open_issue.rb

@@ -1,49 +1,34 @@
-# Opens a single issue in each repository.  The body of the issue is loaded
-# from a file and the user is prompted for the title.
-
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
-
-require 'rubygems'
-require 'highline/question'
-require 'highline/import'
-require 'teachers_pet/actions/base'
-
 module TeachersPet
   module Actions
     class OpenIssue < Base
       def read_info
-        @repository = ask("What repository will the issue be raised in?") { |q| q.validate = /\w+/ }
-        @organization = ask("What is the organization name?") { |q| q.default = TeachersPet::Configuration.organization }
-        
-        @issue = {}
-        @issue[:title] = ask("What is the title of the issue?")
-        @issue_file = ask("What is the path to the file containing the issue body?")
-        
-        # Add labels to issue
-        options = {}
-        options[:labels] = ask("Optionally add any labels, seperated by commas:")
-        @issue[:options] = options
-
-        @student_file = self.get_students_file_path
-        @instructor_file = self.get_instructors_file_path
+        @repository = self.repository
+        @organization = self.organization
+
+        @issue = {
+          title: self.title,
+          options: {
+            labels: self.labels
+          }
+        }
+        @issue_file = self.body
       end
 
       def load_files
-        @students = read_file(@student_file, 'Students')
-        @instructors = read_file(@instructor_file, 'Instructors')
+        @students = self.read_students_file
         @issue[:body] = File.open(@issue_file).read
       end
 
       def create
-        confirm("Create issue '#{@issue[:title]}' in #{@students.keys.size} student repositories - '#{@repository}'?")
+        # confirm("Create issue '#{@issue[:title]}' in #{@students.keys.size} student repositories - '#{@repository}'?")
         self.init_client
 
-        org_hash = read_organization(@organization)
+        org_hash = self.client.organization(@organization)
         abort('Organization could not be found') if org_hash.nil?
         puts "Found organization at: #{org_hash[:login]}"
 
-        org_teams = get_teams_by_name(@organization)
-        
+        org_teams = self.client.get_teams_by_name(@organization)
+
         puts "\nCreating issue in repositories..."
         @students.keys.sort.each do |student|
           unless org_teams.key?(student)
@@ -52,13 +37,13 @@ module TeachersPet
           end
           repo_name = "#{student}-#{@repository}"
 
-          unless repository?(@organization, repo_name)
+          unless self.client.repository?(@organization, repo_name)
             puts " --> Repository not found, skipping '#{repo_name}'"
             next
           end
 
           # Create the issue with octokit
-          @client.create_issue("#{@organization}/#{repo_name}", @issue[:title], @issue[:body], @issue[:options])
+          self.client.create_issue("#{@organization}/#{repo_name}", @issue[:title], @issue[:body], @issue[:options])
         end
       end
 

data/lib/teachers_pet/actions/push_files.rb

@@ -1,40 +1,26 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
-
-require 'rubygems'
-require 'highline/question'
-require 'highline/import'
-require 'highline/compatibility'
-require 'teachers_pet/actions/base'
-
-# This script should be run within a working directory that is a git repository.
-# It will add a remote that is the name of each student team to your repository
-
 module TeachersPet
   module Actions
     class PushFiles < Base
       def read_info
-        @repository = ask('What repository name should pushed to for each student?') { |q| q.validate = /\w+/ }
-
-        @organization = ask("What is the organization name?") { |q| q.default = TeachersPet::Configuration.organization }
-        @student_file = self.get_students_file_path
-        @sshEndpoint = ask('What is the ssh endpoint?') { |q| q.default = TeachersPet::Configuration.sshEndpoint }
+        @repository = self.repository
+        @organization = self.organization
+        @sshEndpoint = self.ssh
       end
 
       def load_files
-        @students = read_file(@student_file, 'Students')
+        @students = self.read_students_file
       end
 
       def push
-        confirm("Push files to student repositories?")
         self.init_client
 
-        org_hash = read_organization(@organization)
+        org_hash = self.client.organization(@organization)
         abort('Organization could not be found') if org_hash.nil?
         puts "Found organization at: #{org_hash[:url]}"
 
         # Load the teams - there should be one team per student.
         # Repositories are given permissions by teams
-        org_teams = get_teams_by_name(@organization)
+        org_teams = self.client.get_teams_by_name(@organization)
 
         # For each student - if an appropraite repository exists,
         # add it to the list.
@@ -46,13 +32,13 @@ module TeachersPet
           end
           repo_name = "#{student}-#{@repository}"
 
-          unless repository?(@organization, repo_name)
+          unless self.client.repository?(@organization, repo_name)
             puts("  ** ERROR ** - no repository called #{repo_name}")
           end
           if TeachersPet::Configuration.remoteSsh
             remotes_to_add[student] = "git@#{@sshEndpoint}:#{@organization}/#{repo_name}.git"
           else
-            remotes_to_add[student] = "#{@web_endpoint}#{@organization}/#{repo_name}.git"
+            remotes_to_add[student] = "#{self.web}#{@organization}/#{repo_name}.git"
           end
         end
 

data/lib/teachers_pet/cli.rb

@@ -0,0 +1,22 @@
+require 'thor'
+
+module TeachersPet
+  class Cli < Thor
+    # TODO figure out a way to display options as groups
+
+    def self.common_options
+      check_unknown_options!
+
+      option :username, default: ENV['USER']
+      option :password
+      option :token, default: ENV['TEACHERS_PET_GITHUB_TOKEN'], desc: "Provide a token instead of a username+password to authenticate via OAuth. See https://github.com/education/teachers_pet#authentication."
+
+      option :api, banner: 'ORIGIN', default: Configuration.apiEndpoint, desc: "The API endpoint of your GitHub Enterprise instance, if you have one."
+      option :web, banner: 'ORIGIN', default: Configuration.webEndpoint, desc: "The URL of your GitHub Enterprise instance, if you have one."
+    end
+
+    def self.students_option
+      option :students, default: TeachersPet::Configuration.studentsFile, banner: 'PATH', desc: "The path to the file containing the list of students"
+    end
+  end
+end

data/lib/teachers_pet/client_decorator.rb

@@ -0,0 +1,59 @@
+module TeachersPet
+  class ClientDecorator < SimpleDelegator
+    def repository?(organization, repo_name)
+      begin
+        self.repository("#{organization}/#{repo_name}")
+      rescue
+        return false
+      end
+    end
+
+    def get_teams_by_name(organization)
+      org_teams = self.organization_teams(organization)
+      teams = Hash.new
+      org_teams.each do |team|
+        teams[team[:name]] = team
+      end
+      return teams
+    end
+
+    def get_team_member_logins(team_id)
+      self.team_members(team_id).map do |member|
+        member[:login]
+      end
+    end
+
+    def existing_teams_by_name(organization)
+      results = Hash.new
+      teams = self.organization_teams(organization)
+      teams.each do |team|
+        results[team[:name]] = team
+      end
+
+      results
+    end
+
+    def create_team(organization, name)
+      puts "Creating team @#{organization}/#{name} ..."
+      super(organization,
+        name: name,
+        permission: 'push'
+      )
+    end
+
+    def add_users_to_team(organization, team, usernames)
+      # Minor optimization, mostly for testing
+      if usernames.any?
+        team_members = self.get_team_member_logins(team[:id])
+        usernames.each do |username|
+          if team_members.include?(username)
+            puts " -> @#{username} is already on @#{organization}/#{team[:name]}"
+          else
+            self.add_team_member(team[:id], username)
+            puts " -> @#{username} has been added to @#{organization}/#{team[:name]}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/teachers_pet/commands/add_to_team.rb

@@ -0,0 +1,12 @@
+module TeachersPet
+  class Cli
+    option :organization, required: true
+    option :members, required: true, banner: 'PATH', desc: "The path to the file containing the list of members to add. The filename will be used as the name of the team, e.g. `path/to/instructors.csv` will use the 'instructors' team."
+    common_options
+
+    desc 'add_to_team', "Adds each user in the list to the team specified my the filename. Creates the team on the specified organization if it doesn't already exist."
+    def add_to_team
+      TeachersPet::Actions::AddToTeam.new(options).run
+    end
+  end
+end

data/lib/teachers_pet/commands/clone_repos.rb

@@ -0,0 +1,15 @@
+module TeachersPet
+  class Cli
+    option :organization, required: true
+    option :repository, required: true
+    option :clone_method, default: 'https', desc: "'https' or 'ssh'"
+
+    students_option
+    common_options
+
+    desc 'clone_repos', "Clone all student repositories for a particular assignment into the current directory."
+    def clone_repos
+      TeachersPet::Actions::CloneRepos.new(options).run
+    end
+  end
+end

data/lib/teachers_pet/commands/create_repos.rb

@@ -0,0 +1,15 @@
+module TeachersPet
+  class Cli
+    option :organization, required: true
+    option :repository, required: true
+    option :public, type: :boolean, default: false, desc: "Make the repositories public"
+
+    students_option
+    common_options
+
+    desc 'create_repos', "Create assignment repositories for students."
+    def create_repos
+      TeachersPet::Actions::CreateRepos.new(options).run
+    end
+  end
+end