teachers_pet 0.2.0 → 0.3.0

data/lib/teachers_pet/commands/create_student_teams.rb

@@ -0,0 +1,13 @@
+module TeachersPet
+  class Cli
+    option :organization, required: true
+
+    students_option
+    common_options
+
+    desc 'create_student_teams', "Create teams for each student (or student group), and a team for all the instructors."
+    def create_student_teams
+      TeachersPet::Actions::CreateStudentTeams.new(options).run
+    end
+  end
+end

data/lib/teachers_pet/commands/fork_collab.rb

@@ -0,0 +1,12 @@
+module TeachersPet
+  class Cli
+    option :repository, required: true, banner: 'OWNER/REPO'
+    option :dry_run, type: :boolean, default: false
+    common_options
+
+    desc "fork_collab", "Give collaborator access to everyone who has forked a particular repository."
+    def fork_collab
+      TeachersPet::Actions::ForkCollab.new(options).run
+    end
+  end
+end

data/lib/teachers_pet/commands/open_issue.rb

@@ -0,0 +1,18 @@
+module TeachersPet
+  class Cli
+    option :organization, required: true
+    option :repository, required: true
+
+    option :title, desc: "The title of the issue to be created"
+    option :body, banner: 'PATH', desc: "The path to the file containing the issue body (.txt or .md)"
+    option :labels, banner: 'LABEL1,LABEL2'
+
+    students_option
+    common_options
+
+    desc "open_issue", "Opens a single issue in each repository in the organization."
+    def open_issue
+      TeachersPet::Actions::OpenIssue.new(options).run
+    end
+  end
+end

data/lib/teachers_pet/commands/push_files.rb

@@ -0,0 +1,15 @@
+module TeachersPet
+  class Cli
+    option :organization, required: true
+    option :repository, required: true
+
+    students_option
+    common_options
+    option :ssh, banner: 'HOST', default: TeachersPet::Configuration.sshEndpoint
+
+    desc 'push_files', "Run this command from a local Git repository to push the files up to the specified repository for each student. It will add a remote that is the name of each student team to your repository."
+    def push_files
+      TeachersPet::Actions::PushFiles.new(options).run
+    end
+  end
+end

data/lib/teachers_pet/configuration.rb

@@ -19,13 +19,6 @@ module TeachersPet
       @@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'
 
@@ -33,12 +26,6 @@ module TeachersPet
       @@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
 
     # github.com - set to 'github.com'
     # GitHub Enterprise - 'yourserver.com'

data/lib/teachers_pet/version.rb

@@ -1,3 +1,3 @@
 module TeachersPet
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/actions/base_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe TeachersPet::Actions::Base do
+  describe '#read_file' do
+    it "returns a hash of usernames by team name" do
+      action = TeachersPet::Actions::Base.new
+      result = action.read_file(fixture_path('teams'))
+      expect(result).to eq(
+        'studentteam1' => %w(teststudent1 teststudent2)
+      )
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe TeachersPet::Cli do
+  include CommandHelpers
+
+  it "throws an error for unsupported options" do
+    # ...using an arbirtrary command
+
+    # Make sure it short-circuits
+    expect(TeachersPet::Actions::CreateStudentTeams).to_not receive(:new)
+
+    output = capture(:stderr) {
+      TeachersPet::Cli.start(%w(create_student_teams --organization testorg --unsupported-option))
+    }
+    expect(output).to include('--unsupported-option')
+  end
+end

data/spec/commands/add_to_team_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe 'add_to_team' do
+  include CommandHelpers
+
+  it "adds users to the team matching the filename" do
+    request_stubs = []
+
+    request_stubs << stub_get_json('https://testteacher:abc123@api.github.com/orgs/testorg/teams?per_page=100', [
+      {
+        id: 101,
+        name: 'instructors'
+      }
+    ])
+
+    users = instructor_usernames
+    request_stubs << stub_get_json('https://testteacher:abc123@api.github.com/teams/101/members?per_page=100', [
+      {
+        login: users.first
+      }
+    ])
+
+    users[1..-1].each do |instructor|
+      request_stubs << stub_request(:put, "https://testteacher:abc123@api.github.com/teams/101/members/#{instructor}")
+    end
+
+    teachers_pet(:add_to_team,
+      organization: 'testorg',
+      members: instructors_list_fixture_path,
+
+      username: 'testteacher',
+      password: 'abc123'
+    )
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+
+  it "creates the team if it doesn't already exist"
+
+  it "treats the team names case-insensitively"
+end

data/spec/commands/clone_repos_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'clone_repos' do
+  include CommandHelpers
+
+  it "runs" do
+    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", {})
+      expect_any_instance_of(TeachersPet::Actions::CloneRepos).to receive(:execute).with("git clone https://www.github.com/testorg/#{username}-testrepo.git").once
+    end
+
+    teachers_pet(:clone_repos,
+      repository: 'testrepo',
+      organization: 'testorg',
+
+      students: students_list_fixture_path,
+
+      username: 'testteacher',
+      password: 'abc123'
+    )
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+end

data/spec/commands/create_repos_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe 'create_repos' do
+  include CommandHelpers
+
+  def common_test(create_as_public)
+    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|
+      # Check for the repos existing already
+      stub_request(:get, "https://testteacher:abc123@api.github.com/repos/testorg/#{username}-testrepo").
+        to_return(status: 404)
+    end
+
+    student_usernames.each do |username|
+      # actually create the repo
+      team_id = 0
+      student_teams.each do |st|
+        if st[:name].eql?(username)
+          team_id = st[:id]
+        end
+      end
+      stub_request(:post, "https://testteacher:abc123@api.github.com/orgs/testorg/repos").
+        with(body: "{\"description\":\"testrepo created for #{username}\",\"private\":#{!create_as_public},\"has_issues\":true,\"has_wiki\":false,\"has_downloads\":false,\"team_id\":#{team_id},\"name\":\"#{username}-testrepo\"}")
+    end
+
+    teachers_pet(:create_repos,
+      repository: 'testrepo',
+      organization: 'testorg',
+      public: create_as_public,
+
+      students: students_list_fixture_path,
+
+      username: 'testteacher',
+      password: 'abc123'
+    )
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+
+  it "create repos public" do
+    common_test(true)
+  end
+
+  it "create repos private" do
+    common_test(false)
+  end
+end

data/spec/commands/create_student_teams_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe 'create_student_teams' do
+  include CommandHelpers
+
+  def stub_owners_only
+    stub_get_json('https://testteacher:abc123@api.github.com/orgs/testorg/teams?per_page=100', [
+      {
+        id: 101,
+        name: 'Owners'
+      }
+    ])
+  end
+
+  it "creates one team per student" do
+    request_stubs = []
+    request_stubs << stub_owners_only
+
+    student_usernames.each_with_index do |student, i|
+      # Creates team
+      request_stubs << stub_request(:post, 'https://testteacher:abc123@api.github.com/orgs/testorg/teams').
+         with(body: {
+           name: student,
+           permission: 'push'
+         }.to_json).to_return(body: {
+            id: i,
+            name: student
+         })
+
+      # Checks for existing team members
+      # TODO No need to retrieve members for a new team
+      request_stubs << stub_get_json("https://testteacher:abc123@api.github.com/teams/#{i}/members?per_page=100", [])
+
+      # Add student to their team
+      request_stubs << stub_request(:put, "https://testteacher:abc123@api.github.com/teams/#{i}/members/#{student}")
+    end
+
+    teachers_pet(:create_student_teams,
+      organization: 'testorg',
+
+      students: students_list_fixture_path,
+      instructors: empty_list_fixture_path,
+
+      username: 'testteacher',
+      password: 'abc123'
+    )
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+
+  it "creates teams for groups of students" do
+    request_stubs = []
+    stub_owners_only
+
+    # Creates team
+    request_stubs << stub_request(:post, 'https://testteacher:abc123@api.github.com/orgs/testorg/teams').
+       with(body: {
+         name: 'studentteam1',
+         permission: 'push'
+       }.to_json).to_return(body: {
+          id: 1,
+          name: 'studentteam1'
+       })
+
+    # Checks for existing team members
+    # TODO No need to retrieve members for a new team
+    request_stubs << stub_get_json('https://testteacher:abc123@api.github.com/teams/1/members?per_page=100', [])
+
+    %w(teststudent1 teststudent2).each do |student|
+      # Add student to their team
+      request_stubs << stub_request(:put, "https://testteacher:abc123@api.github.com/teams/1/members/#{student}")
+    end
+
+    teachers_pet(:create_student_teams,
+      organization: 'testorg',
+
+      students: fixture_path('teams'),
+      instructors: empty_list_fixture_path,
+
+      username: 'testteacher',
+      password: 'abc123'
+    )
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+end

data/spec/commands/fork_collab_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe 'fork_collab' do
+  include CommandHelpers
+
+  context 'through CLI' do
+    it "requires the repository be specified" do
+      expect {
+        teachers_pet(:fork_collab)
+      }.to raise_error(Thor::RequiredArgumentMissingError, /--repository/)
+    end
+
+    it "passes the options to the action" do
+      expect_to_be_run_with(TeachersPet::Actions::ForkCollab,
+        'api' => 'https://api.github.com/',
+        'dry_run' => false,
+        'password' => 'abc123',
+        'repository' => 'testorg/testrepo',
+        'username' => ENV['USER'],
+        'web' => 'https://www.github.com/'
+      )
+      teachers_pet(:fork_collab, repository: 'testorg/testrepo', password: 'abc123')
+    end
+
+    it "succeeds for basic auth" do
+      request_stubs = []
+      request_stubs << stub_get_json('https://testteacher:abc123@api.github.com/repos/testorg/testrepo/forks?per_page=100', [
+        {
+          owner: {
+            login: 'teststudent',
+            type: 'User'
+          }
+        }
+      ])
+      request_stubs << stub_request(:put, 'https://testteacher:abc123@api.github.com/repos/testorg/testrepo/collaborators/teststudent')
+
+      teachers_pet(:fork_collab,
+        repository: 'testorg/testrepo',
+        username: 'testteacher',
+        password: 'abc123'
+      )
+
+      request_stubs.each do |request_stub|
+        expect(request_stub).to have_been_requested.once
+      end
+    end
+
+    it "succeeds for OAuth" do
+      request_stubs = []
+      request_stubs << stub_get_json('https://api.github.com/repos/testorg/testrepo/forks?per_page=100', [
+        {
+          owner: {
+            login: 'teststudent',
+            type: 'User'
+          }
+        }
+      ]).with(headers: {'Authorization' => 'token tokentokentoken'})
+
+      request_stubs << stub_request(:put, 'https://api.github.com/repos/testorg/testrepo/collaborators/teststudent').
+        with(headers: {'Authorization' => 'token tokentokentoken'})
+
+      teachers_pet(:fork_collab,
+        repository: 'testorg/testrepo',
+        token: 'tokentokentoken'
+      )
+
+      request_stubs.each do |request_stub|
+        expect(request_stub).to have_been_requested.once
+      end
+    end
+
+    it "prints the users on a dry run" do
+      request_stub = stub_get_json('https://testteacher:abc123@api.github.com/repos/testorg/testrepo/forks?per_page=100', [
+        {
+          owner: {
+            login: 'teststudent',
+            type: 'User'
+          }
+        }
+      ])
+
+      output = capture(:stdout) do
+        teachers_pet(:fork_collab,
+          repository: 'testorg/testrepo',
+          username: 'testteacher',
+          password: 'abc123',
+          dry_run: true
+        )
+      end
+
+      expect(output).to include('teststudent')
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+end