teachers_pet 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d30fbc91197f42ea30df5cd1a1347cc5da3b082
-  data.tar.gz: 3f740ae9fab9e2a13a09399db11cc6bc84e57529
+  metadata.gz: 34f31b6d378cbb283cead5e47e9a115b04fc48dd
+  data.tar.gz: c67ba2a5cb528af7e6a956b00162bbfe4b6d789b
 SHA512:
-  metadata.gz: 9af701ab906d0122f95778c8c0096dcbd4a9b22326d01b028d18dd1e2e01962944e90c96f19436c4e529a5d56efe749ca2c7911457c36b752e709b4c11acba49
-  data.tar.gz: e6ac88733408986a70c83fb5e7a6cdc131510f8a8a82c9b42d25cf1399c18309d425ada3c37c57f20c9e7deba78ce6c842416686ae90bc2fbacf4bccbb7315b5
+  metadata.gz: 8abd43bf0409d38576a414321598658e8cc04edf95b3e1e3b287887b437e6e5da38ab548c52e544e89e78eb0e63cd3b531bd2f1534495f30777a4b2dead499d4
+  data.tar.gz: 3e3137a1d275ea9381356aaa39bf3e784ecbdb11c88ecb213e96e2f2681350d46cc8240f21752ca2d2730831b4355d0058150a5a3a6488c6644d11c1a02fe649

data/.gitignore

@@ -1,8 +1,14 @@
+# project specific
+/instructors
+/students
+/teams
+
 *.gem
 *.rbc
 .bundle
 .config
 coverage
+Gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg
@@ -16,3 +22,13 @@ tmp
 .yardoc
 _yardoc
 doc/
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+## Development
+
+```bash
+git clone https://github.com/education/teachers_pet.git
+cd teachers_pet
+bundle install
+# then run actions using
+bundle exec ./bin/COMMAND
+```
+
+## Running tests
+
+```bash
+bundle
+# then
+bundle exec rspec
+# or
+bundle exec guard
+```

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, all_on_start: true, cmd: 'bundle exec rspec' do
+  watch(%r{^(lib|spec)/.*})
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 GitHub Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# teachers_pet [![Build Status](https://travis-ci.org/education/teachers_pet.svg?branch=master)](https://travis-ci.org/education/teachers_pet)
+
+Command line tools to help teachers use GitHub in their classrooms.
+
+## Philosophy
+
+Each class is an 'organization' on GitHub. This allows the instructors (GitHub organization Owners) to create, push, pull, and administer all repositories. This achieves two goals:
+
+* Instructors can push code starter code to all students
+* Instructors can easily browse/pull student code at any time during the assignment to assist in questions, check on progress
+
+Each student is given a team in the organization. The team name is the same as the student's GitHub username. The course instructors are also added as team members for each team (see the goals above).
+
+## Installation
+
+[Install Ruby 1.9.3+](https://www.ruby-lang.org/en/installation/), then run
+
+```bash
+gem install teachers_pet
+```
+
+To use the latest-and-greatest code from this repository, see the instructions in [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Basic Setup
+
+* Create an organization (you will be an owner by default). The organization should reflect the name of your course.
+* Create a `students` file (you will be prompted for the path later)
+    * Individual assignments: one username per line
+    * Group assignments: one team per line in the format `teamName username username username`
+* Add the GitHub username of all instructors to an 'instructors' file (one per line)
+* Run `create_teams`
+
+## Passwords / OAuth
+
+The scripts will ask for your GitHub password in order to run. If you have [two factor authentication](https://help.github.com/articles/about-two-factor-authentication) enabled, [create a personal access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use) (replace `github.com` with your host for GitHub Enterprise):
+
+https://github.com/settings/tokens/new?description=teachers_pet&scopes=repo%2Cpublic_repo%2Cwrite%3Aorg%2Crepo%3Astatus%2Cread%3Aorg%2Cuser%2Cadmin%3Aorg
+
+Then, add the following line to your `.bash_profile`:
+
+```bash
+export ghe_oauth="YOUR_TOKEN_HERE"
+```
+
+## Actions
+
+### Creating assignments
+
+For each assignment, run `create_repos` to create a repository for each student. The repositories are technically created per team, but if you use `create_teams` first, then there will be one team per student.
+
+### Collaborator access
+
+Give collaborator access to everyone who has forked your repository.
+
+```bash
+fork_collab
+```
+
+### Pushing starter files
+
+This is the workflow that we use. Create a private repository on GitHub. Clone it to your machine and place in all the necessary starter files (.gitignore and build files, like Makefile are highly recommended). Commit and push this repository to the origin.
+
+While in the directory for the starter file repository, run the `push_repos` script.
+
+This works by creating a git remote for each repository and thing doing a push to that repository.
+
+### Pulling repositories for grading
+
+When grading, use the `clone_repos` script to clone all the repositories in the organization that match the username-repository naming scheme that is generated when `create_repos` is run.
+
+## Related projects
+
+* https://education.github.com/guide
+* https://github.com/hogbait/6170_repo_management
+* https://github.com/mikehelmick/edugit-scripts
+* https://github.com/UCSB-CS-Using-GitHub-In-Courses/github-acad-scripts

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/clone_repos

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'teachers_pet/actions/clone_repos'
+
+TeachersPet::Actions::CloneRepos.new.run

data/bin/create_repos

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'teachers_pet/actions/create_repos'
+
+TeachersPet::Actions::CreateRepos.new.run

data/bin/create_teams

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'teachers_pet/actions/create_teams'
+
+TeachersPet::Actions::CreateTeams.new.run

data/bin/fork_collab

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'teachers_pet/actions/fork_collab'
+
+TeachersPet::Actions::ForkCollab.new.run

data/bin/push_files

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'teachers_pet/actions/push_files'
+
+TeachersPet::Actions::PushFiles.new.run

data/lib/teachers_pet/actions/base.rb

@@ -0,0 +1,160 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..')
+
+require 'configuration'
+
+## Common code for the edugit scripts.
+module TeachersPet
+  module Actions
+    class Base
+      def get_auth_method
+        auth_method = nil
+
+        choose do |menu|
+          menu.prompt = "Login via oAuth or Password? "
+          menu.choice :oAuth do
+            auth_method = 'oauth'
+          end
+          menu.choice :Password do
+            auth_method = 'password'
+          end
+        end
+
+        auth_method
+      end
+
+      def config_github
+        return unless @username.nil?
+        @api_endpoint = ask('What is the API endpoint?') { |q| q.default = Configuration.apiEndpoint }
+        @web_endpoint = ask("What is the Web endpoint?") { |q| q.default = Configuration.webEndpoint }
+
+        @username = ask('What is your username? (You must be an owner for the organization)?') { |q| q.default = ENV['USER'] }
+
+        @authmethod = self.get_auth_method
+
+        if @authmethod == 'oauth'
+            @oauthtoken = ask('What is your oAuth token?') { |q| q.default = ENV['ghe_oauth'] }
+        end
+        if @authmethod == 'password'
+            @password = ask('What is your password?') { |q| q.echo = false }
+        end
+      end
+
+      def init_client
+        self.config_github
+        puts "=" * 50
+        puts "Authenticating to GitHub..."
+        Octokit.configure do |c|
+          c.api_endpoint = @api_endpoint
+          c.web_endpoint = @web_endpoint
+          # Organizations can get big, pull in all pages
+          c.auto_paginate = true
+        end
+
+        if @authmethod == 'password'
+          @client = Octokit::Client.new(:login => @username, :password => @password)
+        end
+        if @authmethod == 'oauth'
+          @client = Octokit::Client.new(:login => @username, :access_token => @oauthtoken)
+        end
+      end
+
+      def read_organization(organization)
+        abort("GitHub client not initialized") if @client.nil?
+        @client.organization(organization)
+      end
+
+      def execute(command)
+        `#{command}`
+      end
+
+      protected
+      def repository?(organization, repo_name)
+        begin
+          @client.repository("#{organization}/#{repo_name}")
+        rescue
+          return false
+        end
+      end
+
+      def get_students_file_path
+        ask("What is the filename of the list of students?") { |q| q.default = TeachersPet::Configuration.studentsFile }
+      end
+
+      def get_instructors_file_path
+        ask("What is the filename of the list of instructors?") { |q| q.default = TeachersPet::Configuration.instructorsFile }
+      end
+
+      def get_existing_repos_by_names(organization)
+        repos = Hash.new
+        response = @client.organization_repositories(organization)
+        print " Org repo names"
+        response.each do |repo|
+          repos[repo[:name]] = repo
+          print " '#{repo[:name]}'"
+        end
+        print "\n";
+        return repos
+      end
+
+      def get_teams_by_name(organization)
+        org_teams = @client.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)
+        @client.team_members(team_id).map do |member|
+          member[:login]
+        end
+      end
+
+      def read_file(filename, type)
+        map = Hash.new
+        puts "Loading #{type}:"
+        File.open(filename).each_line do |team|
+          # Team can be a single user, or a team name and multiple users
+          # Trim whitespace, otherwise issues occur
+          team.strip!
+          items = team.split(' ')
+          items.each do |item|
+            abort("No users can be named 'owners' (in any case)") if 'owners'.eql?(item.downcase)
+          end
+
+          if map[items[0]].nil?
+            map[items[0]] = Array.new
+            puts " -> #{items[0]}"
+            if (items.size > 1)
+              print "  \\-> members: "
+              1.upto(items.size - 1) do |i|
+                print "#{items[i]} "
+                map[items[0]] << items[i]
+              end
+              print "\n"
+            else
+              map[items[0]] << items[0]
+            end
+          end
+        end
+        return map
+      end
+
+      def confirm(message, abort_on_no = true)
+        # confirm
+        confirmed = false
+        choose do |menu|
+          menu.prompt = message
+
+          menu.choice :yes do confirmed = true end
+          menu.choice :no do confirmed = false end
+        end
+        if abort_on_no && !confirmed
+          abort("Creation canceled by user")
+        end
+        return confirmed
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/clone_repos.rb

@@ -0,0 +1,89 @@
+# Author: Mike Helmick
+# Clones all student repositories for a particular assignment
+#
+# Currently this will clone all student repositories into the current
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
+
+require 'rubygems'
+require 'highline/question'
+require 'highline/import'
+require 'highline/compatibility'
+require 'octokit'
+require 'teachers_pet/actions/base'
+
+module TeachersPet
+  module Actions
+    class CloneRepos < Base
+      def read_info
+        @repository = ask('What repository name should be cloned 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
+      end
+
+      def load_files
+        @students = read_file(@student_file, 'Students')
+      end
+
+      def get_clone_method
+        cloneMethod = 'https'
+        choose do |menu|
+          menu.prompt = "Clone via? "
+          menu.choice :ssh do
+            cloneMethod = 'ssh'
+          end
+          menu.choice :https do
+            cloneMethod = 'https'
+          end
+        end
+
+        cloneMethod
+      end
+
+      def create
+        cloneMethod = self.get_clone_method
+
+        confirm("Clone all repositories?")
+
+        # create a repo for each student
+        self.init_client
+
+        org_hash = read_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.
+        org_teams = get_teams_by_name(@organization)
+        # For each student - pull the repository if it exists
+        puts "\nCloning assignment repositories for students..."
+        @students.keys.each do |student|
+          unless org_teams.key?(student)
+            puts("  ** ERROR ** - no team for #{student}")
+            next
+          end
+          repo_name = "#{student}-#{@repository}"
+
+          unless repository?(@organization, repo_name)
+            puts " ** ERROR ** - Can't find expected repository '#{repo_name}'"
+            next
+          end
+
+
+          sshEndpoint = @web_endpoint.gsub("https://","git@").gsub("/",":")
+          command = "git clone #{sshEndpoint}#{@organization}/#{repo_name}.git"
+          if cloneMethod.eql?('https')
+            command = "git clone #{@web_endpoint}#{@organization}/#{repo_name}.git"
+          end
+          puts " --> Cloning: '#{command}'"
+          self.execute(command)
+        end
+      end
+
+      def run
+        self.read_info
+        self.load_files
+        self.create
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/create_repos.rb

@@ -0,0 +1,82 @@
+# 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 'octokit'
+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
+        @add_init_files = confirm('Add .gitignore and README.md files? (skip this if you are pushing starter files.)', false)
+      end
+
+      def load_files
+        @students = read_file(@student_file, 'Students')
+        @instructors = read_file(@instructor_file, 'Instructors')
+      end
+
+      def create
+        confirm("Create #{@students.keys.size} repositories for students and give access to instructors?")
+
+        # create a repo for each student
+        self.init_client
+
+        org_hash = read_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)
+        # For each student - create a repository, and give permissions to their "team"
+        # The repository name is teamName-repository
+        puts "\nCreating assignment repositories for students..."
+        @students.keys.sort.each do |student|
+          unless org_teams.key?(student)
+            puts("  ** ERROR ** - no team for #{student}")
+            next
+          end
+          repo_name = "#{student}-#{@repository}"
+
+          if 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}'"
+          @client.create_repository(repo_name,
+              {
+                :description => "#{@repository} created for #{student}",
+                :private => !TeachersPet::Configuration.reposPublic, ## Current default, repositories are private to the student & instructors
+                :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
+              })
+        end
+      end
+
+      def run
+        self.read_info
+        self.load_files
+        self.create
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/create_teams.rb

@@ -0,0 +1,102 @@
+# Author: Mike Helmick
+# Creates "teams" for an origanization. In this scenario - each team consists of
+# one student, and any instructors for the course.
+
+# The students and instructors files contain 1 userid per line.
+#  - For teams, the students file should be "teamName studentName studentName"
+# We recommend that instructors also be created as students for ease of testing.
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
+
+require 'rubygems'
+require 'highline/question'
+require 'highline/import'
+require 'highline/compatibility'
+require 'octokit'
+
+require 'teachers_pet/actions/base'
+
+module TeachersPet
+  module Actions
+    class CreateTeams < Base
+      def read_info
+        @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
+      end
+
+      def load_files
+        @students = read_file(@student_file, 'Students')
+        @instructors = read_file(@instructor_file, 'Instructors')
+      end
+
+      def create
+        self.init_client
+        confirm("Create teams for #{@students.size} students/teams?")
+
+        existing = Hash.new
+        teams = @client.organization_teams(@organization)
+        teams.each { |team| existing[team[:name]] = team }
+
+        puts "\nDetermining which students need teams created..."
+        todo = Hash.new
+        @students.keys.each do |team|
+          if existing[team].nil?
+            puts " -> #{team}"
+            todo[team] = true
+          end
+        end
+
+        if todo.empty?
+          puts "\nAll teams exist"
+        else
+          puts "\nCreating team..."
+          todo.keys.each do |team|
+            puts " -> '#{team}' ..."
+            @client.create_team(@organization,
+                {
+                  :name => team,
+                  :permission => 'push'
+                })
+          end
+        end
+
+        puts "\nAdjusting team memberships"
+        teams = @client.organization_teams(@organization)
+        teams.each do |team|
+          team_members = get_team_member_logins(team[:id])
+          if team[:name].eql?('Owners')
+            puts "*** OWNERS *** - Ensuring instructors are owners"
+            @instructors.keys.each do |instructor|
+              unless team_members.include?(instructor)
+                @client.add_team_member(team[:id], instructor)
+                puts " -> '#{instructor}' has been made an owner for this course"
+              else
+                puts " -> '#{instructor}' is already an owner"
+              end
+            end
+          elsif @students.key?(team[:name])
+            puts "Validating membership for team '#{team[:name]}'"
+            # If there isn't a team member that is the same name as the team, and we already know
+            # there is a student with the same name, add that student to the team.
+            #unless team_members.include?(team[:name])
+            @students[team[:name]].each do |student|
+              puts "  -> Adding '#{team[:name]}' to the team"
+              @client.add_team_member(team[:id], student)
+            end
+            # Originally, instructors were added to the student's team, but that isn't needed
+            # since instructors are addded to the Owners team that can see all repositories.
+          else
+            puts "*** Team name '#{team[:name]}' does not match any students, ignoring. ***"
+          end
+        end
+      end
+
+      def run
+        self.read_info
+        self.load_files
+        self.create
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/fork_collab.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
+
+require 'rubygems'
+require 'highline/question'
+require 'highline/import'
+require 'highline/compatibility'
+require 'octokit'
+require 'teachers_pet/actions/base'
+
+module TeachersPet
+  module Actions
+    class ForkCollab < Base
+      def read_info
+        @repository = ask("Which repository? (name/owner)")
+      end
+
+      def get_forks
+        @client.forks(@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)
+            puts "#{login} - #{result}"
+          else
+            puts "#{login} - false (Organization)"
+          end
+        end
+      end
+
+      def run
+        self.read_info
+        self.promote
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/push_files.rb

@@ -0,0 +1,75 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
+
+require 'rubygems'
+require 'highline/question'
+require 'highline/import'
+require 'highline/compatibility'
+require 'octokit'
+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 }
+      end
+
+      def load_files
+        @students = read_file(@student_file, 'Students')
+      end
+
+      def push
+        confirm("Push files to student repositories?")
+        self.init_client
+
+        org_hash = read_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)
+
+        # For each student - if an appropraite repository exists,
+        # add it to the list.
+        remotes_to_add = Hash.new
+        @students.keys.sort.each do |student|
+          unless org_teams.key?(student)
+            puts("  ** ERROR ** - no team for #{student}")
+            next
+          end
+          repo_name = "#{student}-#{@repository}"
+
+          unless 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"
+          end
+        end
+
+        puts "Adding remotes and pushing files to student repositories."
+        remotes_to_add.keys.each do |remote|
+          puts "#{remote} --> #{remotes_to_add[remote]}"
+          `git remote add #{remote} #{remotes_to_add[remote]}`
+          `git push #{remote} master`
+        end
+      end
+
+      def run
+        self.read_info
+        self.load_files
+        self.push
+      end
+    end
+  end
+end

data/lib/teachers_pet/configuration.rb

@@ -0,0 +1,67 @@
+# Configuration for the edugit scripts. Modify this as desired to change
+# your defaults in the prompts
+module TeachersPet
+  class Configuration
+
+    # For github.com: 'https://api.github.com/'
+    # For GitHub Enterprise: 'https://yourServer.com/api/v3'
+    @@API_ENDPOINT = 'https://api.github.com/'
+
+    def self.apiEndpoint
+      @@API_ENDPOINT
+    end
+
+    # For github.com: https://www.github.com/'
+    # For GitHub Enterprise: ''https://yourServer.com/'
+    @@WEB_ENDPOINT = 'https://www.github.com/'
+
+    def self.webEndpoint
+      @@WEB_ENDPOINT
+    end
+
+    # The name of your organization
+    @@ORGANIZATION = 'edugit-test'
+
+    def self.organization
+      @@ORGANIZATION
+    end
+
+    # The name fo the file that contains the team definitions / students
+    @@STUDENTS_FILE = './students'
+
+    def self.studentsFile
+      @@STUDENTS_FILE
+    end
+
+    # The name of the file that contains the GitHub usernames of the instructors
+    @@INSTRUCTORS_FILE = './instructors'
+
+    def self.instructorsFile
+      @@INSTRUCTORS_FILE
+    end
+
+    # The default is to create the repositories as public.
+    # If you are using GitHub enterprise or a paid account, it make sense to make this private
+    @@REPOS_PUBLIC = true
+
+    def self.reposPublic
+      @@REPOS_PUBLIC
+    end
+
+    # github.com - set to 'github.com'
+    # GitHub Enterprise - 'yourserver.com'
+    @@SSH_ENDPOINT = 'github.com'
+
+    def self.sshEndpoint
+      @@SSH_ENDPOINT
+    end
+
+    ## It is best to push remotes vis SSH, you can swith this to false to push as HTTPS
+    @@REMOTE_SSH = true
+
+    def self.remoteSsh
+      @@REMOTE_SSH
+    end
+
+  end
+end

data/lib/teachers_pet/version.rb

@@ -1,3 +1,3 @@
 module TeachersPet
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/teachers_pet.rb

@@ -1,2 +1,4 @@
+Dir.glob(File.join(File.dirname(__FILE__), '**', '*.rb'), &method(:require))
+
 module TeachersPet
 end

data/spec/actions/clone_repos_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe TeachersPet::Actions::CloneRepos do
+  let(:action) { TeachersPet::Actions::CloneRepos.new }
+
+  def respond(question, response)
+    action.stub(:ask).with(question).and_return(response)
+  end
+
+  before do
+    # fallback
+    action.stub(:ask){|question| raise("can't ask \"#{question}\"") }
+    action.stub(:choose){ raise("can't choose()") }
+
+    action.stub(:confirm)
+  end
+
+  it "runs" do
+    respond("What repository name should be cloned for each student?", 'testrepo')
+    respond("What is the organization name?", 'testorg')
+    respond("What is the filename of the list of students?", students_list_fixture_path)
+    action.stub(get_clone_method: 'https')
+    respond("What is the organization name?", "testorg")
+    stub_github_config
+
+    request_stubs = []
+
+    request_stubs << stub_get_json('https://testteacher:abc123@api.github.com/orgs/testorg',
+      login: 'testorg',
+      url: 'https://api.github.com/orgs/testorg'
+    )
+    request_stubs << stub_get_json('https://testteacher:abc123@api.github.com/orgs/testorg/teams?per_page=100', student_teams)
+    student_usernames.each do |username|
+      request_stubs << stub_get_json("https://testteacher:abc123@api.github.com/repos/testorg/#{username}-testrepo", {})
+      action.should_receive(:execute).with("git clone https://www.github.com/testorg/#{username}-testrepo.git").once
+    end
+
+    action.run
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+end

data/spec/actions/create_teams_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe TeachersPet::Actions::CreateTeams do
+  let(:action) { TeachersPet::Actions::CreateTeams.new }
+
+  before do
+    # fallback
+    action.stub(:ask){|question| raise("can't ask \"#{question}\"") }
+    action.stub(:choose){ raise("can't choose()") }
+
+    action.stub(:confirm)
+  end
+
+  it "creates teams if none exist" do
+    respond("What is the organization name?", 'testorg')
+    respond("What is the filename of the list of students?", students_list_fixture_path)
+    respond("What is the filename of the list of instructors?", instructors_list_fixture_path)
+    stub_github_config
+
+    teams_stub = stub_get_json('https://testteacher:abc123@api.github.com/orgs/testorg/teams?per_page=100', [])
+
+    request_stubs = []
+    student_usernames.each do |student|
+      request_stubs << stub_request(:post, 'https://testteacher:abc123@api.github.com/orgs/testorg/teams').
+         with(body: {
+           name: student,
+           permission: 'push'
+         }.to_json)
+    end
+
+    action.run
+
+    expect(teams_stub).to have_been_requested.twice
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+
+  it "handles existing teams"
+end

data/spec/fixtures/instructors

@@ -0,0 +1,3 @@
+testinstructor1
+testinstructor2
+testinstructor3

data/spec/fixtures/students

@@ -0,0 +1,3 @@
+teststudent1
+teststudent2
+teststudent3

data/spec/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'csv'
+require 'json'
+require 'webmock/rspec'
+
+require_relative File.join('..', 'lib', 'teachers_pet')
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+
+
+def stub_get_json(url, response)
+  stub_request(:get, url).to_return(
+    headers: {
+      'Content-Type' => 'application/json'
+    },
+    body: response.to_json
+  )
+end
+
+def students_list_fixture_path
+  File.join(File.dirname(__FILE__), 'fixtures', 'students')
+end
+
+def instructors_list_fixture_path
+  File.join(File.dirname(__FILE__), 'fixtures', 'instructors')
+end
+
+def student_usernames
+  CSV.read(students_list_fixture_path).flatten
+end
+
+def student_teams
+  student_usernames.each_with_index.map do |username, i|
+    {
+      url: "https://api.github.com/teams/#{i}",
+      name: username,
+      id: i
+    }
+  end
+end
+
+def respond(question, response)
+  action.stub(:ask).with(question).and_return(response)
+end
+
+def stub_github_config
+  respond("What is the API endpoint?", TeachersPet::Configuration.apiEndpoint)
+  respond("What is the Web endpoint?", TeachersPet::Configuration.webEndpoint)
+  respond("What is your username? (You must be an owner for the organization)?", 'testteacher')
+  action.stub(get_auth_method: 'password')
+  respond("What is your password?", 'abc123')
+end

data/teachers_pet.gemspec

@@ -1,20 +1,29 @@
-require File.expand_path("../lib/teachers_pet/version", __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teachers_pet/version'
 
 Gem::Specification.new do |s|
   s.name          = 'teachers_pet'
   s.version       = TeachersPet::VERSION
-  s.summary       = "Command line tools for teachers"
-  s.description   = "A simple hello world gem"
+  s.summary       = "Command line tools to help teachers use GitHub in their classrooms"
   s.authors       = ["John Britton"]
   s.email         = 'public@johndbritton.com'
-  s.homepage      = 'http://github.com/johndbritton/teachers_pet'
+  s.homepage      = 'http://github.com/education/teachers_pet'
   s.license       = 'MIT'
 
-  s.files         = `git ls-files`.split $/
+  s.bindir        = 'bin'
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.bindir        = 'bin'
-  s.executables  << 'forkcollab'
+  s.add_dependency 'highline', '~> 1.6.21'
+  s.add_dependency 'octokit', '~> 3.1.0'
 
-  s.add_dependency 'octokit'
+  s.add_development_dependency 'bundler', '~> 1.5'
+  s.add_development_dependency 'guard-rspec', '~> 4.2'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.14'
+  s.add_development_dependency 'webmock', '~> 1.17'
 end

metadata

@@ -1,42 +1,154 @@
 --- !ruby/object:Gem::Specification
 name: teachers_pet
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - John Britton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.21
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.21
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A simple hello world gem
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+description: 
 email: public@johndbritton.com
 executables:
-- forkcollab
+- clone_repos
+- create_repos
+- create_teams
+- fork_collab
+- push_files
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- bin/forkcollab
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/clone_repos
+- bin/create_repos
+- bin/create_teams
+- bin/fork_collab
+- bin/push_files
 - lib/teachers_pet.rb
+- lib/teachers_pet/actions/base.rb
+- lib/teachers_pet/actions/clone_repos.rb
+- lib/teachers_pet/actions/create_repos.rb
+- lib/teachers_pet/actions/create_teams.rb
+- lib/teachers_pet/actions/fork_collab.rb
+- lib/teachers_pet/actions/push_files.rb
+- lib/teachers_pet/configuration.rb
 - lib/teachers_pet/version.rb
+- spec/actions/clone_repos_spec.rb
+- spec/actions/create_teams_spec.rb
+- spec/fixtures/instructors
+- spec/fixtures/students
+- spec/spec_helper.rb
 - teachers_pet.gemspec
-homepage: http://github.com/johndbritton/teachers_pet
+homepage: http://github.com/education/teachers_pet
 licenses:
 - MIT
 metadata: {}
@@ -46,18 +158,24 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Command line tools for teachers
-test_files: []
+summary: Command line tools to help teachers use GitHub in their classrooms
+test_files:
+- spec/actions/clone_repos_spec.rb
+- spec/actions/create_teams_spec.rb
+- spec/fixtures/instructors
+- spec/fixtures/students
+- spec/spec_helper.rb
+has_rdoc: 

data/bin/forkcollab

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'io/console'
-require 'octokit'
-
-puts "Create a personal access token: https://github.com/settings/applications"
-print "Token: "
-token = STDIN.noecho(&:gets).chomp
-puts
-
-print "Repository (name/owner): "
-nwo = gets.chomp
-
-client = Octokit::Client.new :access_token => token
-
-forks = client.forks(nwo)
-
-puts "Are you sure you want to add #{forks.count} users as collaborators on '#{nwo}'?"
-print "Please type the name of the repository to confirm: "
-confirm = gets.chomp
-
-if confirm == nwo
-  forks.each do |fork|
-    if fork.owner.type == "User"
-      result = client.add_collab(nwo, fork.owner)
-      puts "#{fork.owner.login} - #{result}"
-    else
-      puts "#{fork.owner.login} - false (Organization)"
-    end
-  end
-end