teachers_pet 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34f31b6d378cbb283cead5e47e9a115b04fc48dd
-  data.tar.gz: c67ba2a5cb528af7e6a956b00162bbfe4b6d789b
+  metadata.gz: 910209118ec442713281982a1e518e1444cc59a9
+  data.tar.gz: 5db06d1c2a2df29f5fa6f9ceeec71d37c7b5c5a0
 SHA512:
-  metadata.gz: 8abd43bf0409d38576a414321598658e8cc04edf95b3e1e3b287887b437e6e5da38ab548c52e544e89e78eb0e63cd3b531bd2f1534495f30777a4b2dead499d4
-  data.tar.gz: 3e3137a1d275ea9381356aaa39bf3e784ecbdb11c88ecb213e96e2f2681350d46cc8240f21752ca2d2730831b4355d0058150a5a3a6488c6644d11c1a02fe649
+  metadata.gz: 7f158b180312b392af4c134264be6b7f250f950ac89012f067bf5605604eaf056702bf4d8474fe8f40efff5f1428b3937f74b947e8300af42b2e6abe71dcc8c7
+  data.tar.gz: 27c399025cd1d07af44e005fb35117b632a92a04d17428fe5c9dbbf996ed8a05b53bb7976b4ea57ec95c5c5ea1aa50ae676d5562d7ad06405307ed6f1941e5d3

data/README.md

@@ -19,6 +19,12 @@ Each student is given a team in the organization. The team name is the same as t
 gem install teachers_pet
 ```
 
+If you've used this tool before, get the newest version using
+
+```ruby
+gem update teachers_pet
+```
+
 To use the latest-and-greatest code from this repository, see the instructions in [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## Basic Setup
@@ -64,6 +70,14 @@ While in the directory for the starter file repository, run the `push_repos` scr
 
 This works by creating a git remote for each repository and thing doing a push to that repository.
 
+### Opening issues
+
+After running `create_repos`, instructors can open issues in repos with `open_issue`.  This action requires an `issue.md` file containing the body of the issue.  The issue title and optional tags are added at runtime.
+
+One issue will be opened in every repo defined by the `students` file and repository name given by the user.
+
+Open issues in student repos as a way to list requirements of the assignment, goals, or instructions for patching.
+
 ### 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.

data/bin/open_issue

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

data/lib/teachers_pet/actions/base.rb

@@ -1,6 +1,7 @@
 $LOAD_PATH << File.join(File.dirname(__FILE__), '..')
 
 require 'configuration'
+require 'octokit'
 
 ## Common code for the edugit scripts.
 module TeachersPet

data/lib/teachers_pet/actions/clone_repos.rb

@@ -9,7 +9,6 @@ require 'rubygems'
 require 'highline/question'
 require 'highline/import'
 require 'highline/compatibility'
-require 'octokit'
 require 'teachers_pet/actions/base'
 
 module TeachersPet

data/lib/teachers_pet/actions/create_repos.rb

@@ -7,7 +7,6 @@ require 'rubygems'
 require 'highline/question'
 require 'highline/import'
 require 'highline/compatibility'
-require 'octokit'
 require 'teachers_pet/actions/base'
 
 module TeachersPet
@@ -18,7 +17,8 @@ module TeachersPet
         @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)
+        @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)        
       end
 
       def load_files
@@ -27,7 +27,8 @@ module TeachersPet
       end
 
       def create
-        confirm("Create #{@students.keys.size} repositories for students and give access to instructors?")
+        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
@@ -56,11 +57,11 @@ module TeachersPet
 
           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}'"
+          puts " --> Creating '#{repo_name}' public? #{@public_repos}"
           @client.create_repository(repo_name,
               {
                 :description => "#{@repository} created for #{student}",
-                :private => !TeachersPet::Configuration.reposPublic, ## Current default, repositories are private to the student & instructors
+                :private => !@public_repos,
                 :has_issues => true, # seems like a resonable default
                 :has_wiki => false,
                 :has_downloads => false,

data/lib/teachers_pet/actions/create_teams.rb

@@ -12,7 +12,6 @@ require 'rubygems'
 require 'highline/question'
 require 'highline/import'
 require 'highline/compatibility'
-require 'octokit'
 
 require 'teachers_pet/actions/base'
 

data/lib/teachers_pet/actions/fork_collab.rb

@@ -4,14 +4,13 @@ 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)")
+        @repository = ask("Which repository? (owner/repo)")
       end
 
       def get_forks

data/lib/teachers_pet/actions/open_issue.rb

@@ -0,0 +1,72 @@
+# 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
+      end
+
+      def load_files
+        @students = read_file(@student_file, 'Students')
+        @instructors = read_file(@instructor_file, 'Instructors')
+        @issue[:body] = File.open(@issue_file).read
+      end
+
+      def create
+        confirm("Create issue '#{@issue[:title]}' in #{@students.keys.size} student repositories - '#{@repository}'?")
+        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]}"
+
+        org_teams = get_teams_by_name(@organization)
+        
+        puts "\nCreating issue in repositories..."
+        @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 " --> 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])
+        end
+      end
+
+      def run
+        self.read_info
+        self.load_files
+        self.create
+      end
+    end
+  end
+end

data/lib/teachers_pet/actions/push_files.rb

@@ -4,7 +4,6 @@ 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.

data/lib/teachers_pet/configuration.rb

@@ -40,14 +40,6 @@ module TeachersPet
       @@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'

data/lib/teachers_pet/version.rb

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

data/spec/actions/create_repos_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe TeachersPet::Actions::CreateRepos do
+  let(:action) { TeachersPet::Actions::CreateRepos.new }
+
+  before do
+    # fallback
+    action.stub(:ask){|question| raise("can't ask \"#{question}\"") }
+    action.stub(:choose){ raise("can't choose()") }
+
+    action.stub(:confirm)
+  end
+
+  def common_test(create_as_public)
+    respond("What repository name should be created 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)
+    respond("What is the filename of the list of instructors?", instructors_list_fixture_path)
+    confirm("Create repositories as public?", create_as_public)
+    confirm("Add .gitignore and README.md files? (skip this if you are pushing starter files.)", false)
+    mode = create_as_public ? 'public' : 'private'
+    respond("Create 3 #{mode} repositories for students and give access to instructors?", "1")
+    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|
+      # Check for the repos existing already
+      stub_request(:get, "https://testteacher:abc123@api.github.com/repos/testorg/#{username}-testrepo").
+         to_return(:status => 404, :body => "", :headers => {})
+    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},\"auto_init\":false,\"gitignore_template\":\"\",\"name\":\"#{username}-testrepo\"}").
+         to_return(:status => 200)
+    end
+
+    action.run
+
+    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/actions/open_issue_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe TeachersPet::Actions::OpenIssue do
+  let(:action) { TeachersPet::Actions::OpenIssue.new }
+
+  before do
+    # fallback
+    action.stub(:ask){|question| raise("can't ask \"#{question}\"") }
+    action.stub(:choose){ raise("can't choose()") }
+
+    action.stub(:confirm)
+  end
+
+  def common_test(labels)
+    
+    issue_title = "Issue Test"
+    
+    # Respond to action prompts
+    respond("What repository will the issue be raised in?", 'testrepo')
+    respond("What is the organization name?", 'testorg')
+    respond("What is the title of the issue?", 'Issue Test')
+    respond("What is the path to the file containing the issue body?", issue_fixture_path)
+    respond("Optionally add any labels, seperated by commas:", labels)
+    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)
+    respond("Create issue '#{issue_title}' in #{File.open(students_list_fixture_path).readlines.size} student repositories - 'testrepo'?", "1")
+    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|
+      # Action checks that repos exist already
+      stub_request(:get, "https://testteacher:abc123@api.github.com/repos/testorg/#{username}-testrepo").
+         to_return(:status => 200, :body => "", :headers => {})
+    end
+
+    # create the issue in each repo
+    student_usernames.each do |username|
+      team_id = 0
+      student_teams.each do |st|
+        if st[:name].eql?(username)
+          team_id = st[:id]
+        end
+      end
+      issue_body = File.read(issue_fixture_path).gsub("\n", "\\n")
+      labels_list = labels.split(",").map(&:strip).to_s.delete(' ')
+      stub_request(:post, "https://testteacher:abc123@api.github.com/repos/testorg/#{username}-testrepo/issues").
+         with(:body => "{\"labels\":#{labels_list},\"title\":\"Issue Test\",\"body\":\"#{issue_body}\"}").
+         to_return(:status => 201)
+    end
+
+    action.run
+
+    request_stubs.each do |request_stub|
+      expect(request_stub).to have_been_requested.once
+    end
+  end
+
+  it "open issue no labels" do
+    common_test("")
+  end
+
+  it "open issue with labels" do
+    common_test("bug, feature")
+  end
+end

data/spec/fixtures/issue.md

@@ -0,0 +1,4 @@
+# This is a test
+* Testing
+* An
+* Issue

data/spec/spec_helper.rb

@@ -29,6 +29,10 @@ def instructors_list_fixture_path
   File.join(File.dirname(__FILE__), 'fixtures', 'instructors')
 end
 
+def issue_fixture_path
+  File.join(File.dirname(__FILE__), 'fixtures', 'issue.md')
+end
+
 def student_usernames
   CSV.read(students_list_fixture_path).flatten
 end
@@ -47,6 +51,10 @@ def respond(question, response)
   action.stub(:ask).with(question).and_return(response)
 end
 
+def confirm(question, response)
+  action.stub(:confirm).with(question, false).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)

data/teachers_pet.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
+  s.required_ruby_version = '>= 1.9.3'
+
   s.add_dependency 'highline', '~> 1.6.21'
   s.add_dependency 'octokit', '~> 3.1.0'
 

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: teachers_pet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Britton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-05-16 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: 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'
   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: 
@@ -115,13 +115,14 @@ executables:
 - create_repos
 - create_teams
 - fork_collab
+- open_issue
 - push_files
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CONTRIBUTING.md
 - Gemfile
 - Guardfile
@@ -132,6 +133,7 @@ files:
 - bin/create_repos
 - bin/create_teams
 - bin/fork_collab
+- bin/open_issue
 - bin/push_files
 - lib/teachers_pet.rb
 - lib/teachers_pet/actions/base.rb
@@ -139,12 +141,16 @@ files:
 - 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/open_issue.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_repos_spec.rb
 - spec/actions/create_teams_spec.rb
+- spec/actions/open_issue_spec.rb
 - spec/fixtures/instructors
+- spec/fixtures/issue.md
 - spec/fixtures/students
 - spec/spec_helper.rb
 - teachers_pet.gemspec
@@ -158,24 +164,26 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Command line tools to help teachers use GitHub in their classrooms
 test_files:
 - spec/actions/clone_repos_spec.rb
+- spec/actions/create_repos_spec.rb
 - spec/actions/create_teams_spec.rb
+- spec/actions/open_issue_spec.rb
 - spec/fixtures/instructors
+- spec/fixtures/issue.md
 - spec/fixtures/students
 - spec/spec_helper.rb
-has_rdoc: