Merge pull request #17 from github/zrdaley/os

Open source the gh-classroom CLI

Author: zrdaley

.gitignore

@@ -0,0 +1,23 @@
+/bin
+/share/man/man1
+/gh-classroom
+.envrc
+/dist
+/site
+.github/**/node_modules
+/CHANGELOG.md
+/script/build
+
+# VS Code
+.vscode
+
+# IntelliJ
+.idea
+
+# macOS
+.DS_Store
+
+# vim
+*.swp
+
+vendor/

CODE-OF-CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CODEOWNERS

@@ -0,0 +1,4 @@
+# For more information, see [docs](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-syntax)
+
+# This repository is maintained by:
+* @github/classroom-reviewers

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+## Contributing
+
+[fork]: https://github.com/github/gh-classroom/fork
+[pr]: https://github.com/github/gh-classroom/compare
+[style]: https://github.com/github/gh-classroom/blob/main/.golangci.yaml
+[release-docs]: https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license
+[good-commit-msg]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are [released][release-docs] to the public under the [project's open source license](./LICENSE.txt).
+
+Please note that this project is released with a [Contributor Code of Conduct](./CODE-OF-CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## Prerequisites for running and testing code
+
+These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
+
+1. install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go)
+1. [install golangci-lint](https://golangci-lint.run/usage/install/#local-installation)
+
+## Submitting a pull request
+
+1. [Fork][fork] and clone the repository
+1. Configure and install the dependencies: `go mod tidy`
+1. Make sure the tests pass on your machine: `go test -v ./...`
+1. Make sure linter passes on your machine: `golangci-lint run`
+1. Create a new branch: `git checkout -b my-branch-name`
+1. Make your change, add tests, and make sure the tests and linter still pass
+1. Push to your fork and [submit a pull request][pr]
+1. Please be patient while waiting for your pull request to be reviewed and merged.
+
+Here are a few things you can do that will increase the likelihood of your pull request being accepted:
+
+- Write tests.
+- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
+- Write a [good commit message][good-commit-msg].
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
+- [GitHub Help](https://help.github.com)

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright GitHub
+
+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.

README.md

@@ -1,28 +1,48 @@
-# gh-classroom
-GitHub Classroom CLI Extension is a powerful and easy-to-use command line tool that enhances the functionality of the GitHub CLI, specifically tailored for educators using GitHub Classroom. 
+## GitHub Classroom CLI
 
-## Installation
+GitHub Classroom CLI Extension is a powerful and easy-to-use command line tool that enhances the functionality of the GitHub CLI, specifically tailored for educators using GitHub Classroom.
 
-Install the CLI
+## Background
 
+- **This project does not currently have a roadmap**
+- If you would like to add additional features, please read our [contribution guidelines](./CONTRIBUTING.md)
+- To report a security vulnerability, please read our [security guidelines](./SECURITY.md)
+
+## Requirements
+
+### Installation 
+- Install [Homebrew](https://brew.sh/)
+- Install the gh cli
 ```bash
 brew install gh
 ```
-
-Install this extension
-
+- Install this extension
 ```bash
 gh extension install github/gh-classroom
 ```
 
-## Commands
+### Commands
 
 For more information and a list of available commands
 
 ```bash
 gh classroom -h
 ```
 
-## Contributions
+## License
+
+This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
+
+## Maintainers
+
+See [CODEOWNERS](./CODEOWNERS)
+
+## Support
+
+See [SUPPORT](./SUPPORT.md)
+
+## Additional Resources
 
-At this time we are not open to contributions but hang tight as we are working towards that goal!
+- [Classroom](https://classroom.github.com)
+- [About Extensions](https://docs.github.com/en/github-cli/github-cli/creating-github-cli-extensions)
+- [Extensions Deep Dive](https://github.blog/2023-01-13-new-github-cli-extension-tools/)

SECURITY.md

@@ -0,0 +1,31 @@
+Thanks for helping make GitHub safe for everyone.
+
+# Security
+
+GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
+
+Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation. 
+
+## Reporting Security Issues
+
+If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
+
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to opensource-security[@]github.com.
+
+Please include as much of the information listed below as you can to help us better understand and resolve the issue:
+
+  * The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
+  * Full paths of source file(s) related to the manifestation of the issue
+  * The location of the affected source code (tag/branch/commit or direct URL)
+  * Any special configuration required to reproduce the issue
+  * Step-by-step instructions to reproduce the issue
+  * Proof-of-concept or exploit code (if possible)
+  * Impact of the issue, including how an attacker might exploit the issue
+
+This information will help us triage your report more quickly.
+
+## Policy
+
+See [GitHub's Safe Harbor Policy](https://docs.github.com/en/github/site-policy/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
+
+For help or questions about using this project, please open an issue.
+
+- **github/gh-classroom** is under active development and maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support, feature requests, and community questions in a timely manner.
+
+## GitHub Support Policy
+
+Support for this project is limited to the resources listed above.

cmd/gh-classroom/accepted-assignments/accepted_assignments.go

@@ -0,0 +1,116 @@
+package accepted
+
+import (
+	"fmt"
+	"log"
+	"strconv"
+	"strings"
+
+	"github.com/cli/cli/pkg/iostreams"
+	"github.com/cli/cli/v2/pkg/cmdutil"
+	"github.com/cli/go-gh"
+	"github.com/cli/go-gh/pkg/browser"
+	"github.com/cli/go-gh/pkg/tableprinter"
+	"github.com/cli/go-gh/pkg/term"
+	"github.com/github/gh-classroom/cmd/gh-classroom/shared"
+	"github.com/github/gh-classroom/pkg/classroom"
+	"github.com/spf13/cobra"
+)
+
+func NewCmdAcceptedAssignments(f *cmdutil.Factory) *cobra.Command {
+	var web bool
+	var assignmentId int
+	var page int
+	var perPage int
+
+	cmd := &cobra.Command{
+		Use:   "accepted-assignments",
+		Short: "List your student's accepted assignments",
+		Run: func(cmd *cobra.Command, args []string) {
+			term := term.FromEnv()
+			io := iostreams.System()
+			cs := io.ColorScheme()
+
+			client, err := gh.RESTClient(nil)
+			var assignment classroom.Assignment
+			if err != nil {
+				log.Fatal(err)
+			}
+
+			if assignmentId == 0 {
+				classroom, err := shared.PromptForClassroom(client)
+				classroomId := classroom.Id
+				if err != nil {
+					log.Fatal(err)
+				}
+
+				assignment, err = shared.PromptForAssignment(client, classroomId)
+				assignmentId = assignment.Id
+				if err != nil {
+					log.Fatal(err)
+				}
+			}
+
+			if web {
+				if term.IsTerminalOutput() {
+					fmt.Fprintln(cmd.ErrOrStderr(), "Opening in your browser.")
+				}
+				browser := browser.New("", cmd.OutOrStdout(), cmd.OutOrStderr())
+				err := browser.Browse(assignment.Url())
+				if err != nil {
+					log.Fatal(err)
+				}
+				return
+			}
+
+			acceptedAssignments, err := classroom.ListAcceptedAssignments(client, assignmentId, page, perPage)
+			if err != nil {
+				log.Fatal(err)
+			}
+
+			fmt.Fprintf(cmd.OutOrStdout(), "Assignment: %v \n", acceptedAssignments.Assignment.Title)
+			fmt.Fprintf(cmd.OutOrStdout(), "ID: %v \n\n", acceptedAssignments.Assignment.Id)
+
+			t := tableprinter.New(cmd.OutOrStdout(), term.IsTerminalOutput(), 14)
+			t.AddField("ID", tableprinter.WithTruncate(nil))
+			t.AddField("Submitted", tableprinter.WithTruncate(nil))
+			t.AddField("Passing", tableprinter.WithTruncate(nil))
+			t.AddField("Commit Count", tableprinter.WithTruncate(nil))
+			t.AddField("Grade", tableprinter.WithTruncate(nil))
+			t.AddField("Feedback Pull Request URL", tableprinter.WithTruncate(nil))
+			if assignment.IsGroupAssignment() {
+				t.AddField("Group Members", tableprinter.WithTruncate(nil))
+			} else {
+				t.AddField("Student", tableprinter.WithTruncate(nil))
+			}
+			t.AddField("Repository", tableprinter.WithTruncate(nil))
+			t.EndRow()
+
+			for _, acceptedAssignment := range acceptedAssignments.AcceptedAssignments {
+				var students []string
+				for _, student := range acceptedAssignment.Students {
+					students = append(students, student.Login)
+				}
+				t.AddField(cs.Green(strconv.Itoa(acceptedAssignment.Id)), tableprinter.WithTruncate(nil))
+				t.AddField(strconv.FormatBool(acceptedAssignment.Submitted), tableprinter.WithTruncate(nil))
+				t.AddField(strconv.FormatBool(acceptedAssignment.Passing), tableprinter.WithTruncate(nil))
+				t.AddField(strconv.Itoa(acceptedAssignment.CommitCount), tableprinter.WithTruncate(nil))
+				t.AddField(acceptedAssignment.Grade, tableprinter.WithTruncate(nil))
+				t.AddField(acceptedAssignment.FeedbackPullRequestUrl, tableprinter.WithTruncate(nil))
+				t.AddField(strings.Join(students, ", "), tableprinter.WithTruncate(nil))
+				t.AddField(acceptedAssignment.RepositoryUrl(), tableprinter.WithTruncate(nil))
+				t.EndRow()
+			}
+			err = t.Render()
+			if err != nil {
+				log.Fatal(err)
+			}
+		},
+	}
+
+	cmd.Flags().BoolVar(&web, "web", false, "Open the assignment in a browser")
+	cmd.Flags().IntVarP(&assignmentId, "assignment-id", "a", 0, "ID of the assignment")
+	cmd.Flags().IntVar(&page, "page", 1, "Page number")
+	cmd.Flags().IntVar(&perPage, "per-page", 30, "Number of accepted assignments per page")
+	return cmd
+}