separate server & cli apps & update readme

Author: utkuufuk

.github/workflows/ci.yml

@@ -22,8 +22,11 @@ jobs:
     - name: Check go.mod
       run: go mod tidy && git diff --no-patch --exit-code
 
-    - name: Build
-      run: go build ./cmd/github-service
+    - name: Build Server
+      run: go build ./cmd/server
+
+    - name: Build CLI
+      run: go build ./cmd/cli
 
     - name: Run tests
       run: go test ./...

Procfile

@@ -1 +1 @@
-web: bin/github-service
+web: bin/server

README.md

@@ -1,2 +1,46 @@
-## Deploying to Heroku
-The Heroku app is updated whenever a new commit is pushed to the `master` branch.
+# github-service
+A simple service to query GitHub issues & pull requests.
+* See [Server Mode](#server-mode) for using it as an [entrello](https://github.com/utkuufuk/entrello) service
+* See [CLI Mode](#cli-mode) for using it as a CLI tool
+
+## Configuration
+Put your environment variables in a file called `.env`. See `.env.example` for reference.
+
+## Server Mode
+Start the server:
+```sh
+go run ./cmd/server
+```
+
+### List of Endpoints
+#### `GET <SERVER_URL>/entrello`
+Fetch self-assigned issues from personal repositories.
+
+#### `GET <SERVER_URL>/entrello/prlo`
+Fetch pull requests that meet all of the following conditions:
+- belongs to the configured organization
+- belongs to one of the configured subscribed repositories
+- neither created by nor assigned to the configured user
+- not draft
+
+#### `GET <SERVER_URL>/entrello/prlmy`
+Fetch pull requests that meet all of the following conditions:
+- belongs to the configured organization
+- created by the configured user
+
+#### `GET <SERVER_URL>/entrello/prlme`
+Fetch pull requests that meet all of the following conditions:
+- belongs to the configured organization
+- assigned to the configured user
+- not created by configured user
+
+## CLI Mode
+The result set of each endpoint listed above can be alternatively retrieved using the corresponding CLI command.
+
+### List of Commands
+```sh
+go run ./cmd/cli
+go run ./cmd/cli prlo
+go run ./cmd/cli prlmy
+go run ./cmd/cli prlme
+```

cmd/cli/main.go

@@ -0,0 +1,42 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/utkuufuk/entrello/pkg/trello"
+	"github.com/utkuufuk/github-service/internal/github"
+)
+
+func main() {
+	client := github.GetClient()
+
+	if len(os.Args) == 1 {
+		displayCards(client.FetchAssignedIssues)
+		return
+	}
+
+	switch os.Args[1] {
+	case "prlo":
+		displayCards(client.FetchOtherPullRequests)
+	case "prlmy":
+		displayCards(client.FetchMyPullRequests)
+	case "prlme":
+		displayCards(client.FetchOtherPullRequestsAssignedToMe)
+	default:
+		log.Fatalf("Uncrecognized command: %s", os.Args[2])
+	}
+}
+
+func displayCards(query func(ctx context.Context) ([]trello.Card, error)) {
+	cards, err := query(context.Background())
+	if err != nil {
+		log.Fatalf(err.Error())
+	}
+
+	for _, c := range cards {
+		fmt.Printf("%s - %s\n", c.Name, c.Desc)
+	}
+}

cmd/github-service/main.go

@@ -0,0 +1,42 @@
+package main
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/utkuufuk/entrello/pkg/trello"
+	"github.com/utkuufuk/github-service/internal/config"
+	"github.com/utkuufuk/github-service/internal/github"
+)
+
+func main() {
+	client := github.GetClient()
+	http.HandleFunc("/entrello", handleGetRequest(client.FetchAssignedIssues))
+	http.HandleFunc("/entrello/prlo", handleGetRequest(client.FetchOtherPullRequests))
+	http.HandleFunc("/entrello/prlme", handleGetRequest(client.FetchMyPullRequests))
+	http.HandleFunc("/entrello/prlmy", handleGetRequest(client.FetchOtherPullRequestsAssignedToMe))
+	http.ListenAndServe(fmt.Sprintf(":%d", config.Port), nil)
+}
+
+func handleGetRequest(
+	fetchCards func(ctx context.Context) ([]trello.Card, error),
+) func(w http.ResponseWriter, r *http.Request) {
+	return func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != http.MethodGet {
+			w.WriteHeader(http.StatusMethodNotAllowed)
+			return
+		}
+
+		cards, err := fetchCards(r.Context())
+		if err != nil {
+			w.WriteHeader(http.StatusInternalServerError)
+			fmt.Fprintf(w, "could not fetch github cards for entrello: %v", err)
+			return
+		}
+
+		w.Header().Set("Content-Type", "application/json")
+		json.NewEncoder(w).Encode(cards)
+	}
+}

cmd/server/main.go

@@ -37,25 +37,23 @@ func (c Client) FetchAssignedIssues(ctx context.Context) ([]trello.Card, error)
 	return entrello.CreateCardsFromIssues(nonPullRequestIssues)
 }
 
-func (c Client) FetchOtherPullRequests() func(ctx context.Context) ([]trello.Card, error) {
-	return func(ctx context.Context) ([]trello.Card, error) {
-		pullRequests := make([]*github.PullRequest, 0)
-		for _, repo := range config.SubscribedRepos {
-			prs, _, err := c.client.PullRequests.List(ctx, config.OrgName, repo, nil)
-			if err != nil {
-				return nil, fmt.Errorf("could not retrieve pull requests from %s/%s: %w", config.OrgName, repo, err)
-			}
-			pullRequests = append(pullRequests, prs...)
+func (c Client) FetchOtherPullRequests(ctx context.Context) ([]trello.Card, error) {
+	pullRequests := make([]*github.PullRequest, 0)
+	for _, repo := range config.SubscribedRepos {
+		prs, _, err := c.client.PullRequests.List(ctx, config.OrgName, repo, nil)
+		if err != nil {
+			return nil, fmt.Errorf("could not retrieve pull requests from %s/%s: %w", config.OrgName, repo, err)
 		}
+		pullRequests = append(pullRequests, prs...)
+	}
 
-		otherPullRequests := make([]*github.PullRequest, 0)
-		for _, i := range pullRequests {
-			if !*i.Draft && *i.User.Login != config.UserName && (i.Assignee == nil || *i.Assignee.Login != config.UserName) {
-				otherPullRequests = append(otherPullRequests, i)
-			}
+	otherPullRequests := make([]*github.PullRequest, 0)
+	for _, i := range pullRequests {
+		if !*i.Draft && *i.User.Login != config.UserName && (i.Assignee == nil || *i.Assignee.Login != config.UserName) {
+			otherPullRequests = append(otherPullRequests, i)
 		}
-		return entrello.CreateCardsFromPullRequests(otherPullRequests)
 	}
+	return entrello.CreateCardsFromPullRequests(otherPullRequests)
 }
 
 func (c Client) FetchOtherPullRequestsAssignedToMe(ctx context.Context) ([]trello.Card, error) {