feat: address TODOs and write README.md

chore: add TODOs
feat: implement feed agg and browse
2026-08-04 18:00:54 -05:00 · 2026-08-03 07:16:59 -05:00 · 2026-08-03 07:14:33 -05:00 · 2026-08-02 07:49:57 -05:00 · 2026-08-01 14:26:19 -05:00 · 2026-08-01 11:38:23 -05:00
27 changed files with 1519 additions and 10 deletions
@@ -0,0 +1 @@
+.sqls.yml
@@ -1,3 +1,77 @@
 # gator

-This is a blog aggregator that was built as part of a [boot.dev](https://boot.dev) course.
+A blog aggregator CLI built as part of the [boot.dev](https://boot.dev) course. Follow RSS feeds and browse their latest posts right from your terminal.
+
+## Requirements
+
+Before you can run gator you'll need to have the following installed:
+
+- **Go** (1.26 or newer)
+- **PostgreSQL** (a running server, local or remote)
+
+## Installation
+
+Install the gator CLI with `go install`:
+
+```sh
+go install github.com/StevanFreeborn/gator@latest
+```
+
+The binary is placed in `$(go env GOPATH)/bin`. Make sure that directory is on your `PATH`:
+
+```sh
+export PATH="$(go env GOPATH)/bin:$PATH"
+```
+
+## Setup
+
+### 1. Create a database
+
+Create a database for gator in your Postgres server:
+
+```sh
+createdb gator
+```
+
+The schema is managed with [goose](https://github.com/pressly/goose) migrations in `sql/schema`. Install goose and apply the migrations:
+
+```sh
+go install github.com/pressly/goose/v3/cmd/goose@latest
+goose -dir sql/schema postgres "postgres://<user>:<password>@localhost:5432/gator?sslmode=disable" up
+```
+
+### 2. Create the config file
+
+gator reads its configuration from `~/.gatorconfig.json`. Create that file with the connection string for your database:
+
+```json
+{
+  "db_url": "postgres://<user>:<password>@localhost:5432/gator?sslmode=disable",
+  "current_user_name": ""
+}
+```
+
+## Usage
+
+Run gator with `gator <command> <args>`. Start by registering a user, then log in:
+
+```sh
+gator register myusername
+gator login myusername
+```
+
+A few commands you can run:
+
+| Command                        | Description                                                                             |
+| ------------------------------ | --------------------------------------------------------------------------------------- |
+| `gator register <name>`        | Register a new user and log in as them                                                  |
+| `gator login <name>`           | Log in as an existing user                                                              |
+| `gator users`                  | List all registered users                                                               |
+| `gator addfeed <name> <url>`   | Add an RSS feed and follow it                                                           |
+| `gator feeds`                  | List all feeds                                                                          |
+| `gator follow <name-or-url>`   | Follow a feed by name or url                                                            |
+| `gator following`              | List the feeds you're following                                                         |
+| `gator unfollow <name-or-url>` | Unfollow a feed by name or url                                                          |
+| `gator browse [limit]`         | Browse posts from your followed feeds                                                   |
+| `gator agg <duration>`         | Continuously fetch posts every `<duration>` (e.g. `60s`); press `q` or `Ctrl-C` to stop |
+| `gator reset`                  | Delete all users and their data                                                         |
@@ -1,3 +1,10 @@
 module github.com/StevanFreeborn/gator

 go 1.26.3
+
+require (
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/lib/pq v1.12.3 // indirect
+	golang.org/x/sys v0.47.0 // indirect
+	golang.org/x/term v0.45.0 // indirect
+)
@@ -0,0 +1,8 @@
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/lib/pq v1.12.3 h1:tTWxr2YLKwIvK90ZXEw8GP7UFHtcbTtty8zsI+YjrfQ=
+github.com/lib/pq v1.12.3/go.mod h1:/p+8NSbOcwzAEI7wiMXFlgydTwcgTr3OSKMsD2BitpA=
+golang.org/x/sys v0.47.0 h1:o7XGOvZQCADBQQ4Y7VNq2dRWQR7JmOUW8Kxx4ZsNgWs=
+golang.org/x/sys v0.47.0/go.mod h1:4GL1E5IUh+htKOUEOaiffhrAeqysfVGipDYzABqnCmw=
+golang.org/x/term v0.45.0 h1:NwWyBmoJCbfTHpxrWoZ9C6/VxOf7ic219I8xZZFdrf0=
+golang.org/x/term v0.45.0/go.mod h1:9aqxs0blBcrm/n0L9QW0aRVD+ktan8ssZromtqJC43w=
@@ -1,9 +1,21 @@
 package command

 import (
+	"cmp"
+	"context"
 	"fmt"
+	"os"
+	"os/signal"
+	"slices"
+	"strconv"
+	"strings"
+	"syscall"
+	"time"

+	"github.com/StevanFreeborn/gator/internal/database"
+	"github.com/StevanFreeborn/gator/internal/rss"
 	"github.com/StevanFreeborn/gator/internal/state"
+	"github.com/google/uuid"
 )

 type Command struct {
@@ -36,6 +48,16 @@ func NewRegistry() *CommandRegistry {

 	commands := []*Command{
 		loginCommand(),
+		registerCommand(),
+		resetCommand(),
+		usersCommand(),
+		aggCommand(),
+		addFeedCommand(),
+		feedsCommand(),
+		followCommand(),
+		followingCommand(),
+		unfollowCommand(),
+		browseCommand(),
 	}

 	for _, cmd := range commands {
@@ -63,7 +85,13 @@ func loginCommand() *Command {

 		username := s.Arguments[0]

-		err := s.Config.SetUser(username)
+		_, err := s.Database.GetUserByName(context.Background(), username)
+
+		if err != nil {
+			return fmt.Errorf("Failed to login")
+		}
+
+		err = s.Config.SetUser(username)

 		if err != nil {
 			return err
@@ -74,3 +102,318 @@ func loginCommand() *Command {
 		return nil
 	})
 }
+
+func registerCommand() *Command {
+	return newCommand("register", func(s *state.State) error {
+		if len(s.Arguments) == 0 {
+			return fmt.Errorf("Did not receive expected username argument")
+		}
+
+		createUserParams := database.CreateUserParams{
+			ID:        uuid.New(),
+			CreatedAt: time.Now(),
+			UpdatedAt: time.Now(),
+			Name:      s.Arguments[0],
+		}
+
+		createdUser, err := s.Database.CreateUser(context.Background(), createUserParams)
+
+		if err != nil {
+			return err
+		}
+
+		s.Config.SetUser(createdUser.Name)
+
+		fmt.Printf("Successfully registered user '%s':\n", createdUser.Name)
+		fmt.Printf("  Id        => %s\n", createdUser.ID)
+		fmt.Printf("  CreatedAt => %s\n", createdUser.CreatedAt)
+		fmt.Printf("  UpdatedAt => %s\n", createdUser.UpdatedAt)
+		fmt.Printf("Current user set to user '%s':\n", createdUser.Name)
+
+		return nil
+	})
+}
+
+func resetCommand() *Command {
+	return newCommand("reset", func(s *state.State) error {
+		err := s.Database.DeleteAllUsers(context.Background())
+
+		if err != nil {
+			return err
+		}
+
+		fmt.Println("Successfully delete all users")
+
+		return nil
+	})
+}
+
+func usersCommand() *Command {
+	return newCommand("users", func(s *state.State) error {
+		users, err := s.Database.GetAllUsers(context.Background())
+
+		if err != nil {
+			return err
+		}
+
+		slices.SortFunc(users, func(a, b database.User) int {
+			return cmp.Compare(a.Name, b.Name)
+		})
+
+		for _, user := range users {
+			msg := "* %s"
+
+			if user.Name == s.Config.CurrentUserName {
+				msg += " (current)"
+			}
+
+			fmt.Printf(msg+"\n", user.Name)
+		}
+
+		return nil
+	})
+}
+
+func aggCommand() *Command {
+	return newCommand("agg", func(s *state.State) error {
+		if len(s.Arguments) == 0 {
+			return fmt.Errorf("Did not receive expected time between requests argument")
+		}
+
+		timeBetweenRequests := s.Arguments[0]
+		validDuration, err := time.ParseDuration(timeBetweenRequests)
+
+		if err != nil {
+			return fmt.Errorf("Time between requests argument '%s' not valid duration string", timeBetweenRequests)
+		}
+
+		ctx, cancel := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
+		defer cancel()
+
+		restore, err := enableKeypressExit(cancel)
+
+		if err != nil {
+			return err
+		}
+
+		defer restore()
+
+		ticker := time.NewTicker(validDuration)
+		defer ticker.Stop()
+
+		rss.ScrapeNextFeed(ctx, s)
+
+	fetchFeeds:
+		for {
+			select {
+			case <-ctx.Done():
+				fmt.Print("Stopping feed agg command\r\n")
+				break fetchFeeds
+			case <-ticker.C:
+				rss.ScrapeNextFeed(ctx, s)
+			}
+		}
+
+		return nil
+	})
+}
+
+func addFeedCommand() *Command {
+	return newCommand("addfeed", requiresLoggedInUser(func(s *state.State, currentUser database.User) error {
+		if len(s.Arguments) < 2 {
+			return fmt.Errorf("Did not receive expected feed name and url")
+		}
+
+		feedName := s.Arguments[0]
+		feedUrl := s.Arguments[1]
+
+		if strings.TrimSpace(feedName) == "" {
+			return fmt.Errorf("Feed name cannot be empty")
+		}
+
+		canonicalFeedUrl, err := normalizeFeedURL(feedUrl)
+
+		if err != nil {
+			return fmt.Errorf("Feed url '%s' is not a valid url", feedUrl)
+		}
+
+		_, err = s.Database.GetFeedByUrl(context.Background(), canonicalFeedUrl)
+
+		if err == nil {
+			return fmt.Errorf("Feed with url '%s' already exists; use 'follow <name>' to follow it", canonicalFeedUrl)
+		}
+
+		createFeedParams := database.CreateFeedParams{
+			ID:        uuid.New(),
+			UserID:    currentUser.ID,
+			Name:      feedName,
+			Url:       canonicalFeedUrl,
+			CreatedAt: time.Now(),
+			UpdatedAt: time.Now(),
+		}
+
+		createdFeed, err := s.Database.CreateFeed(context.Background(), createFeedParams)
+
+		if err != nil {
+			return err
+		}
+
+		createFollowParams := database.CreateFollowParams{
+			ID:        uuid.New(),
+			CreatedAt: time.Now(),
+			UpdatedAt: time.Now(),
+			UserID:    currentUser.ID,
+			FeedID:    createdFeed.ID,
+		}
+
+		_, err = s.Database.CreateFollow(context.Background(), createFollowParams)
+
+		if err != nil {
+			return err
+		}
+
+		fmt.Printf("Successfully added and followed feed '%s' with url '%s'\n", createdFeed.Name, createdFeed.Url)
+		fmt.Printf("  Id        => %s\n", createdFeed.ID)
+		fmt.Printf("  UserId    => %s\n", createdFeed.UserID)
+		fmt.Printf("  CreatedAt => %s\n", createdFeed.CreatedAt)
+		fmt.Printf("  UpdatedAt => %s\n", createdFeed.UpdatedAt)
+
+		return nil
+	}))
+}
+
+func feedsCommand() *Command {
+	return newCommand("feeds", func(s *state.State) error {
+		feeds, err := s.Database.GetAllFeeds(context.Background())
+
+		if err != nil {
+			return err
+		}
+
+		for _, feed := range feeds {
+			feedsUserName := "Unknown"
+
+			user, err := s.Database.GetUserById(context.Background(), feed.UserID)
+
+			if err == nil {
+				feedsUserName = user.Name
+			}
+
+			fmt.Printf("* %s [%s] (%s)\n", feed.Name, feed.Url, feedsUserName)
+		}
+
+		return nil
+	})
+}
+
+func followCommand() *Command {
+	return newCommand("follow", requiresLoggedInUser(func(s *state.State, currentUser database.User) error {
+		if len(s.Arguments) == 0 {
+			return fmt.Errorf("Did not receive expected url argument")
+		}
+
+		feedIdentifier := s.Arguments[0]
+
+		feed, err := resolveFeedByNameOrURL(s, feedIdentifier)
+
+		if err != nil {
+			return err
+		}
+
+		createFollowParams := database.CreateFollowParams{
+			ID:        uuid.New(),
+			CreatedAt: time.Now(),
+			UpdatedAt: time.Now(),
+			FeedID:    feed.ID,
+			UserID:    currentUser.ID,
+		}
+
+		createdFollow, err := s.Database.CreateFollow(context.Background(), createFollowParams)
+
+		if err != nil {
+			return fmt.Errorf("Unable to follow feed '%s'", feed.Name)
+		}
+
+		fmt.Printf("'%s' successfully followed feed '%s'", createdFollow.UserName, createdFollow.FeedName)
+
+		return nil
+	}))
+}
+
+func followingCommand() *Command {
+	return newCommand("following", requiresLoggedInUser(func(s *state.State, currentUser database.User) error {
+		follows, err := s.Database.GetFollowsForUser(context.Background(), currentUser.ID)
+
+		if err != nil {
+			return fmt.Errorf("Unable to find follows for user")
+		}
+
+		for _, follow := range follows {
+			fmt.Printf("* %s\n", follow.FeedName)
+		}
+
+		return nil
+	}))
+}
+
+func unfollowCommand() *Command {
+	return newCommand("unfollow", requiresLoggedInUser(func(s *state.State, currentUser database.User) error {
+		if len(s.Arguments) == 0 {
+			return fmt.Errorf("Did not receive expected feed url argument")
+		}
+
+		feedIdentifier := s.Arguments[0]
+
+		feed, err := resolveFeedByNameOrURL(s, feedIdentifier)
+
+		if err != nil {
+			return err
+		}
+
+		deleteFollowParams := database.DeleteFollowForUserParams{
+			UserID: currentUser.ID,
+			FeedID: feed.ID,
+		}
+
+		err = s.Database.DeleteFollowForUser(context.Background(), deleteFollowParams)
+
+		if err != nil {
+			return fmt.Errorf("Unable to unfollow feed '%s'", feed.Name)
+		}
+
+		fmt.Printf("Successfully unfollowed feed '%s'", feed.Name)
+
+		return nil
+	}))
+}
+
+func browseCommand() *Command {
+	return newCommand("browse", requiresLoggedInUser(func(s *state.State, currentUser database.User) error {
+		limit := int32(2)
+
+		if len(s.Arguments) > 0 {
+			parsedLimit, err := strconv.ParseInt(s.Arguments[0], 10, 32)
+
+			if err == nil {
+				limit = int32(parsedLimit)
+			}
+		}
+
+		getUserPostsParams := database.GetPostsForUserParams{
+			UserID: currentUser.ID,
+			Limit:  limit,
+		}
+
+		posts, err := s.Database.GetPostsForUser(context.Background(), getUserPostsParams)
+
+		if err != nil {
+			return err
+		}
+
+		for _, post := range posts {
+			fmt.Printf("* %s - %s\n", post.FeedName, post.Title)
+		}
+
+		return nil
+	}))
+}
@@ -0,0 +1,107 @@
+package command
+
+import (
+	"context"
+	"fmt"
+	"net/url"
+	"os"
+	"strings"
+
+	"github.com/StevanFreeborn/gator/internal/database"
+	"github.com/StevanFreeborn/gator/internal/state"
+	"golang.org/x/term"
+)
+
+func normalizeFeedURL(raw string) (string, error) {
+	u, err := url.Parse(raw)
+
+	if err != nil {
+		return "", err
+	}
+
+	u.Scheme = strings.ToLower(u.Scheme)
+	u.Host = strings.ToLower(u.Host)
+
+	if (u.Scheme == "http" && u.Port() == "80") || (u.Scheme == "https" && u.Port() == "443") {
+		u.Host = u.Hostname()
+	}
+
+	if len(u.Path) > 1 {
+		u.Path = strings.TrimSuffix(u.Path, "/")
+	}
+
+	u.Fragment = ""
+
+	return u.String(), nil
+}
+
+func resolveFeedByNameOrURL(s *state.State, identifier string) (database.Feed, error) {
+	if strings.TrimSpace(identifier) == "" {
+		return database.Feed{}, fmt.Errorf("Feed identifier cannot be empty")
+	}
+
+	feeds, err := s.Database.GetAllFeeds(context.Background())
+
+	if err != nil {
+		return database.Feed{}, fmt.Errorf("Failed to load feeds")
+	}
+
+	var matches []database.Feed
+
+	for _, feed := range feeds {
+		if strings.EqualFold(feed.Name, identifier) {
+			matches = append(matches, feed)
+		}
+	}
+
+	if len(matches) == 1 {
+		return matches[0], nil
+	}
+
+	if len(matches) > 1 {
+		return database.Feed{}, fmt.Errorf("Multiple feeds match name '%s'; use a url instead", identifier)
+	}
+
+	normalizedURL, err := normalizeFeedURL(identifier)
+
+	if err != nil {
+		return database.Feed{}, fmt.Errorf("No feed found matching name or url '%s'", identifier)
+	}
+
+	feed, err := s.Database.GetFeedByUrl(context.Background(), normalizedURL)
+
+	if err != nil {
+		return database.Feed{}, fmt.Errorf("No feed found matching name or url '%s'", identifier)
+	}
+
+	return feed, nil
+}
+
+func enableKeypressExit(cancel context.CancelFunc) (func(), error) {
+	oldState, err := term.MakeRaw(int(os.Stdin.Fd()))
+
+	if err != nil {
+		return nil, fmt.Errorf("Failed to enable raw mode: %v", err)
+	}
+
+	go func() {
+		buf := make([]byte, 1)
+
+		for {
+			n, err := os.Stdin.Read(buf)
+
+			if err != nil || n == 0 {
+				return
+			}
+
+			if buf[0] == 'q' || buf[0] == 'Q' || buf[0] == 3 {
+				cancel()
+				return
+			}
+		}
+	}()
+
+	return func() {
+		term.Restore(int(os.Stdin.Fd()), oldState)
+	}, nil
+}
@@ -0,0 +1,20 @@
+package command
+
+import (
+	"context"
+
+	"github.com/StevanFreeborn/gator/internal/database"
+	"github.com/StevanFreeborn/gator/internal/state"
+)
+
+func requiresLoggedInUser(handler func(*state.State, database.User) error) CommandHandler {
+	return func(s *state.State) error {
+		loggedInUser, err := s.GetCurrentUser(context.Background())
+
+		if err != nil {
+			return err
+		}
+
+		return handler(s, loggedInUser)
+	}
+}
@@ -0,0 +1,31 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package database
+
+import (
+	"context"
+	"database/sql"
+)
+
+type DBTX interface {
+	ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
+	PrepareContext(context.Context, string) (*sql.Stmt, error)
+	QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error)
+	QueryRowContext(context.Context, string, ...interface{}) *sql.Row
+}
+
+func New(db DBTX) *Queries {
+	return &Queries{db: db}
+}
+
+type Queries struct {
+	db DBTX
+}
+
+func (q *Queries) WithTx(tx *sql.Tx) *Queries {
+	return &Queries{
+		db: tx,
+	}
+}
@@ -0,0 +1,152 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: feeds.sql
+
+package database
+
+import (
+	"context"
+	"database/sql"
+	"time"
+
+	"github.com/google/uuid"
+)
+
+const createFeed = `-- name: CreateFeed :one
+INSERT INTO feeds (id, created_at, updated_at, name, url, user_id, last_fetched_at)
+VALUES (
+  $1,
+  $2,
+  $3,
+  $4,
+  $5,
+  $6,
+  $7
+)
+RETURNING id, created_at, updated_at, name, url, user_id, last_fetched_at
+`
+
+type CreateFeedParams struct {
+	ID            uuid.UUID
+	CreatedAt     time.Time
+	UpdatedAt     time.Time
+	Name          string
+	Url           string
+	UserID        uuid.UUID
+	LastFetchedAt sql.NullTime
+}
+
+func (q *Queries) CreateFeed(ctx context.Context, arg CreateFeedParams) (Feed, error) {
+	row := q.db.QueryRowContext(ctx, createFeed,
+		arg.ID,
+		arg.CreatedAt,
+		arg.UpdatedAt,
+		arg.Name,
+		arg.Url,
+		arg.UserID,
+		arg.LastFetchedAt,
+	)
+	var i Feed
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Name,
+		&i.Url,
+		&i.UserID,
+		&i.LastFetchedAt,
+	)
+	return i, err
+}
+
+const getAllFeeds = `-- name: GetAllFeeds :many
+SELECT id, created_at, updated_at, name, url, user_id, last_fetched_at FROM feeds
+`
+
+func (q *Queries) GetAllFeeds(ctx context.Context) ([]Feed, error) {
+	rows, err := q.db.QueryContext(ctx, getAllFeeds)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []Feed
+	for rows.Next() {
+		var i Feed
+		if err := rows.Scan(
+			&i.ID,
+			&i.CreatedAt,
+			&i.UpdatedAt,
+			&i.Name,
+			&i.Url,
+			&i.UserID,
+			&i.LastFetchedAt,
+		); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}
+
+const getFeedByUrl = `-- name: GetFeedByUrl :one
+SELECT id, created_at, updated_at, name, url, user_id, last_fetched_at FROM feeds
+WHERE url = $1
+`
+
+func (q *Queries) GetFeedByUrl(ctx context.Context, url string) (Feed, error) {
+	row := q.db.QueryRowContext(ctx, getFeedByUrl, url)
+	var i Feed
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Name,
+		&i.Url,
+		&i.UserID,
+		&i.LastFetchedAt,
+	)
+	return i, err
+}
+
+const getNextFeedToFetch = `-- name: GetNextFeedToFetch :one
+SELECT id, created_at, updated_at, name, url, user_id, last_fetched_at FROM feeds
+ORDER BY last_fetched_at ASC NULLS FIRST
+`
+
+func (q *Queries) GetNextFeedToFetch(ctx context.Context) (Feed, error) {
+	row := q.db.QueryRowContext(ctx, getNextFeedToFetch)
+	var i Feed
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Name,
+		&i.Url,
+		&i.UserID,
+		&i.LastFetchedAt,
+	)
+	return i, err
+}
+
+const markFeedAsFetched = `-- name: MarkFeedAsFetched :exec
+UPDATE feeds
+SET last_fetched_at = $1
+WHERE feeds.id = $2
+`
+
+type MarkFeedAsFetchedParams struct {
+	LastFetchedAt sql.NullTime
+	ID            uuid.UUID
+}
+
+func (q *Queries) MarkFeedAsFetched(ctx context.Context, arg MarkFeedAsFetchedParams) error {
+	_, err := q.db.ExecContext(ctx, markFeedAsFetched, arg.LastFetchedAt, arg.ID)
+	return err
+}
@@ -0,0 +1,135 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: follows.sql
+
+package database
+
+import (
+	"context"
+	"time"
+
+	"github.com/google/uuid"
+)
+
+const createFollow = `-- name: CreateFollow :one
+WITH inserted_follow as (
+  INSERT INTO follows (id, created_at, updated_at, feed_id, user_id)
+  VALUES (
+    $1,
+    $2,
+    $3,
+    $4,
+    $5
+  )
+  RETURNING id, created_at, updated_at, user_id, feed_id
+)
+SELECT inserted_follow.id, inserted_follow.created_at, inserted_follow.updated_at, inserted_follow.user_id, inserted_follow.feed_id,
+  feeds.name as feed_name,
+  users.name as user_name
+FROM inserted_follow
+INNER JOIN users
+  ON inserted_follow.user_id = users.id
+INNER JOIN feeds
+  ON inserted_follow.feed_id = feeds.id
+`
+
+type CreateFollowParams struct {
+	ID        uuid.UUID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	FeedID    uuid.UUID
+	UserID    uuid.UUID
+}
+
+type CreateFollowRow struct {
+	ID        uuid.UUID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	UserID    uuid.UUID
+	FeedID    uuid.UUID
+	FeedName  string
+	UserName  string
+}
+
+func (q *Queries) CreateFollow(ctx context.Context, arg CreateFollowParams) (CreateFollowRow, error) {
+	row := q.db.QueryRowContext(ctx, createFollow,
+		arg.ID,
+		arg.CreatedAt,
+		arg.UpdatedAt,
+		arg.FeedID,
+		arg.UserID,
+	)
+	var i CreateFollowRow
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.UserID,
+		&i.FeedID,
+		&i.FeedName,
+		&i.UserName,
+	)
+	return i, err
+}
+
+const deleteFollowForUser = `-- name: DeleteFollowForUser :exec
+DELETE FROM follows
+WHERE feed_id = $1 AND user_id = $2
+`
+
+type DeleteFollowForUserParams struct {
+	FeedID uuid.UUID
+	UserID uuid.UUID
+}
+
+func (q *Queries) DeleteFollowForUser(ctx context.Context, arg DeleteFollowForUserParams) error {
+	_, err := q.db.ExecContext(ctx, deleteFollowForUser, arg.FeedID, arg.UserID)
+	return err
+}
+
+const getFollowsForUser = `-- name: GetFollowsForUser :many
+SELECT follows.id, follows.created_at, follows.updated_at, follows.user_id, follows.feed_id, feeds.name as feed_name FROM follows
+INNER JOIN feeds
+  ON follows.feed_id = feeds.id
+WHERE follows.user_id = $1
+`
+
+type GetFollowsForUserRow struct {
+	ID        uuid.UUID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	UserID    uuid.UUID
+	FeedID    uuid.UUID
+	FeedName  string
+}
+
+func (q *Queries) GetFollowsForUser(ctx context.Context, userID uuid.UUID) ([]GetFollowsForUserRow, error) {
+	rows, err := q.db.QueryContext(ctx, getFollowsForUser, userID)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []GetFollowsForUserRow
+	for rows.Next() {
+		var i GetFollowsForUserRow
+		if err := rows.Scan(
+			&i.ID,
+			&i.CreatedAt,
+			&i.UpdatedAt,
+			&i.UserID,
+			&i.FeedID,
+			&i.FeedName,
+		); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}
@@ -0,0 +1,48 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+
+package database
+
+import (
+	"database/sql"
+	"time"
+
+	"github.com/google/uuid"
+)
+
+type Feed struct {
+	ID            uuid.UUID
+	CreatedAt     time.Time
+	UpdatedAt     time.Time
+	Name          string
+	Url           string
+	UserID        uuid.UUID
+	LastFetchedAt sql.NullTime
+}
+
+type Follow struct {
+	ID        uuid.UUID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	UserID    uuid.UUID
+	FeedID    uuid.UUID
+}
+
+type Post struct {
+	ID          uuid.UUID
+	CreatedAt   time.Time
+	UpdatedAt   time.Time
+	Title       string
+	Url         string
+	Description string
+	PublishedAt sql.NullTime
+	FeedID      uuid.UUID
+}
+
+type User struct {
+	ID        uuid.UUID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	Name      string
+}
@@ -0,0 +1,136 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: posts.sql
+
+package database
+
+import (
+	"context"
+	"database/sql"
+	"time"
+
+	"github.com/google/uuid"
+)
+
+const createPost = `-- name: CreatePost :one
+INSERT INTO posts (id, created_at, updated_at, title, url, description, published_at, feed_id)
+VALUES (
+  $1,
+  $2,
+  $3,
+  $4,
+  $5,
+  $6,
+  $7,
+  $8
+)
+RETURNING id, created_at, updated_at, title, url, description, published_at, feed_id
+`
+
+type CreatePostParams struct {
+	ID          uuid.UUID
+	CreatedAt   time.Time
+	UpdatedAt   time.Time
+	Title       string
+	Url         string
+	Description string
+	PublishedAt sql.NullTime
+	FeedID      uuid.UUID
+}
+
+func (q *Queries) CreatePost(ctx context.Context, arg CreatePostParams) (Post, error) {
+	row := q.db.QueryRowContext(ctx, createPost,
+		arg.ID,
+		arg.CreatedAt,
+		arg.UpdatedAt,
+		arg.Title,
+		arg.Url,
+		arg.Description,
+		arg.PublishedAt,
+		arg.FeedID,
+	)
+	var i Post
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Title,
+		&i.Url,
+		&i.Description,
+		&i.PublishedAt,
+		&i.FeedID,
+	)
+	return i, err
+}
+
+const getPostsForUser = `-- name: GetPostsForUser :many
+SELECT 
+  posts.id, 
+  posts.created_at, 
+  posts.updated_at, 
+  posts.title, 
+  posts.url, 
+  posts.description, 
+  posts.published_at, 
+  posts.feed_id,
+  feeds.name as feed_name
+FROM posts
+INNER JOIN feeds
+  ON posts.feed_id = feeds.id
+INNER JOIN follows
+  ON posts.feed_id = follows.feed_id
+WHERE follows.user_id = $1
+ORDER BY posts.published_at DESC, posts.title ASC
+LIMIT $2
+`
+
+type GetPostsForUserParams struct {
+	UserID uuid.UUID
+	Limit  int32
+}
+
+type GetPostsForUserRow struct {
+	ID          uuid.UUID
+	CreatedAt   time.Time
+	UpdatedAt   time.Time
+	Title       string
+	Url         string
+	Description string
+	PublishedAt sql.NullTime
+	FeedID      uuid.UUID
+	FeedName    string
+}
+
+func (q *Queries) GetPostsForUser(ctx context.Context, arg GetPostsForUserParams) ([]GetPostsForUserRow, error) {
+	rows, err := q.db.QueryContext(ctx, getPostsForUser, arg.UserID, arg.Limit)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []GetPostsForUserRow
+	for rows.Next() {
+		var i GetPostsForUserRow
+		if err := rows.Scan(
+			&i.ID,
+			&i.CreatedAt,
+			&i.UpdatedAt,
+			&i.Title,
+			&i.Url,
+			&i.Description,
+			&i.PublishedAt,
+			&i.FeedID,
+			&i.FeedName,
+		); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}
@@ -0,0 +1,123 @@
+// Code generated by sqlc. DO NOT EDIT.
+// versions:
+//   sqlc v1.31.1
+// source: users.sql
+
+package database
+
+import (
+	"context"
+	"time"
+
+	"github.com/google/uuid"
+)
+
+const createUser = `-- name: CreateUser :one
+INSERT INTO users (id, created_at, updated_at, name)
+VALUES (
+  $1,
+  $2,
+  $3,
+  $4
+)
+RETURNING id, created_at, updated_at, name
+`
+
+type CreateUserParams struct {
+	ID        uuid.UUID
+	CreatedAt time.Time
+	UpdatedAt time.Time
+	Name      string
+}
+
+func (q *Queries) CreateUser(ctx context.Context, arg CreateUserParams) (User, error) {
+	row := q.db.QueryRowContext(ctx, createUser,
+		arg.ID,
+		arg.CreatedAt,
+		arg.UpdatedAt,
+		arg.Name,
+	)
+	var i User
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Name,
+	)
+	return i, err
+}
+
+const deleteAllUsers = `-- name: DeleteAllUsers :exec
+DELETE FROM users
+`
+
+func (q *Queries) DeleteAllUsers(ctx context.Context) error {
+	_, err := q.db.ExecContext(ctx, deleteAllUsers)
+	return err
+}
+
+const getAllUsers = `-- name: GetAllUsers :many
+SELECT id, created_at, updated_at, name FROM users
+`
+
+func (q *Queries) GetAllUsers(ctx context.Context) ([]User, error) {
+	rows, err := q.db.QueryContext(ctx, getAllUsers)
+	if err != nil {
+		return nil, err
+	}
+	defer rows.Close()
+	var items []User
+	for rows.Next() {
+		var i User
+		if err := rows.Scan(
+			&i.ID,
+			&i.CreatedAt,
+			&i.UpdatedAt,
+			&i.Name,
+		); err != nil {
+			return nil, err
+		}
+		items = append(items, i)
+	}
+	if err := rows.Close(); err != nil {
+		return nil, err
+	}
+	if err := rows.Err(); err != nil {
+		return nil, err
+	}
+	return items, nil
+}
+
+const getUserById = `-- name: GetUserById :one
+SELECT id, created_at, updated_at, name FROM users
+WHERE id = $1
+`
+
+func (q *Queries) GetUserById(ctx context.Context, id uuid.UUID) (User, error) {
+	row := q.db.QueryRowContext(ctx, getUserById, id)
+	var i User
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Name,
+	)
+	return i, err
+}
+
+const getUserByName = `-- name: GetUserByName :one
+SELECT id, created_at, updated_at, name FROM users
+WHERE name = $1
+`
+
+func (q *Queries) GetUserByName(ctx context.Context, name string) (User, error) {
+	row := q.db.QueryRowContext(ctx, getUserByName, name)
+	var i User
+	err := row.Scan(
+		&i.ID,
+		&i.CreatedAt,
+		&i.UpdatedAt,
+		&i.Name,
+	)
+	return i, err
+}
@@ -0,0 +1,128 @@
+package rss
+
+import (
+	"context"
+	"database/sql"
+	"encoding/xml"
+	"fmt"
+	"html"
+	"net/http"
+	"time"
+
+	"github.com/StevanFreeborn/gator/internal/database"
+	"github.com/StevanFreeborn/gator/internal/state"
+	"github.com/google/uuid"
+)
+
+type RSSItem struct {
+	Title       string `xml:"title"`
+	Link        string `xml:"link"`
+	Description string `xml:"description"`
+	PubDate     string `xml:"pubDate"`
+}
+
+type RSSChannel struct {
+	Title       string    `xml:"title"`
+	Link        string    `xml:"link"`
+	Description string    `xml:"description"`
+	Item        []RSSItem `xml:"item"`
+}
+
+type RSSFeed struct {
+	Channel RSSChannel `xml:"channel"`
+}
+
+func fetchFeed(ctx context.Context, feedURL string) (*RSSFeed, error) {
+	var rssFeed RSSFeed
+
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, feedURL, nil)
+	req.Header.Set("User-Agent", "gator")
+
+	if err != nil {
+		return nil, err
+	}
+
+	res, err := http.DefaultClient.Do(req)
+
+	if err != nil {
+		return nil, err
+	}
+
+	defer res.Body.Close()
+
+	err = xml.NewDecoder(res.Body).Decode(&rssFeed)
+
+	if err != nil {
+		return nil, err
+	}
+
+	rssFeed.Channel.Title = html.UnescapeString(rssFeed.Channel.Title)
+	rssFeed.Channel.Description = html.UnescapeString(rssFeed.Channel.Description)
+
+	for _, item := range rssFeed.Channel.Item {
+		item.Title = html.UnescapeString(item.Title)
+		item.Description = html.UnescapeString(item.Description)
+	}
+
+	return &rssFeed, nil
+}
+
+func ScrapeNextFeed(ctx context.Context, s *state.State) {
+	nextFeed, err := s.Database.GetNextFeedToFetch(ctx)
+
+	if err != nil {
+		fmt.Print("Failed to lookup next feed to fetch\r\n")
+		return
+	}
+
+	fmt.Printf("Fetching feed '%s'\r\n", nextFeed.Name)
+
+	fetchedFeed, err := fetchFeed(ctx, nextFeed.Url)
+
+	if err != nil {
+		fmt.Printf("Failed to fetch feed '%s'\r\n", nextFeed.Name)
+		return
+	}
+
+	markFeedParams := database.MarkFeedAsFetchedParams{
+		ID: nextFeed.ID,
+		LastFetchedAt: sql.NullTime{
+			Time:  time.Now(),
+			Valid: true,
+		},
+	}
+
+	err = s.Database.MarkFeedAsFetched(ctx, markFeedParams)
+
+	for _, item := range fetchedFeed.Channel.Item {
+		publishedAt, err := time.Parse(time.RFC3339, item.PubDate)
+		publishedAtValue := sql.NullTime{
+			Time:  publishedAt,
+			Valid: err == nil,
+		}
+
+		createPostParams := database.CreatePostParams{
+			ID:          uuid.New(),
+			CreatedAt:   time.Now(),
+			UpdatedAt:   time.Now(),
+			Title:       item.Title,
+			Url:         item.Link,
+			Description: item.Description,
+			PublishedAt: publishedAtValue,
+			FeedID:      nextFeed.ID,
+		}
+
+		_, err = s.Database.CreatePost(ctx, createPostParams)
+
+		if err != nil {
+			fmt.Printf("  Skipping saving post '%s'\r\n", item.Title)
+			continue
+		}
+
+		fmt.Printf("  Saved post '%s'\r\n", item.Title)
+	}
+
+	if err != nil {
+		fmt.Printf("Failed to mark feed as fetched.\r\n")
+	}
+}
@@ -1,12 +1,22 @@
 package state

-import "github.com/StevanFreeborn/gator/internal/config"
+import (
+	"context"
+
+	"github.com/StevanFreeborn/gator/internal/config"
+	"github.com/StevanFreeborn/gator/internal/database"
+)

 type State struct {
+	Database  *database.Queries
 	Config    *config.Config
 	Arguments []string
 }

-func NewState(c *config.Config, args []string) *State {
-	return &State{Config: c, Arguments: args}
+func NewState(d *database.Queries, c *config.Config, args []string) *State {
+	return &State{Database: d, Config: c, Arguments: args}
+}
+
+func (s *State) GetCurrentUser(ctx context.Context) (database.User, error) {
+	return s.Database.GetUserByName(ctx, s.Config.CurrentUserName)
 }
@@ -1,12 +1,15 @@
 package main

 import (
+	"database/sql"
 	"fmt"
 	"os"

 	"github.com/StevanFreeborn/gator/internal/command"
 	"github.com/StevanFreeborn/gator/internal/config"
+	"github.com/StevanFreeborn/gator/internal/database"
 	"github.com/StevanFreeborn/gator/internal/state"
+	_ "github.com/lib/pq"
 )

 func main() {
@@ -19,19 +22,28 @@ func main() {

 	if err != nil {
 		fmt.Printf("Error reading config file: %s", err)
+		os.Exit(1)
+	}
+
+	db, err := sql.Open("postgres", c.DbUrl)
+
+	if err != nil {
+		fmt.Printf("Error connecting to database: %s", err)
+		os.Exit(1)
 	}

 	cmd := os.Args[1]
 	args := os.Args[2:]

-	s := state.NewState(c, args)
+	dbQueries := database.New(db)
+	s := state.NewState(dbQueries, c, args)

 	registry := command.NewRegistry()
 	err = registry.RunCommand(cmd, s)

 	if err != nil {
 		fmt.Printf("Error running '%s' command: %s\n", cmd, err)
-		os.Exit(2)
+		os.Exit(1)
 	}

 	os.Exit(0)
@@ -0,0 +1,28 @@
+-- name: CreateFeed :one
+INSERT INTO feeds (id, created_at, updated_at, name, url, user_id, last_fetched_at)
+VALUES (
+  $1,
+  $2,
+  $3,
+  $4,
+  $5,
+  $6,
+  $7
+)
+RETURNING *;
+
+-- name: GetAllFeeds :many
+SELECT id, created_at, updated_at, name, url, user_id, last_fetched_at FROM feeds;
+
+-- name: GetFeedByUrl :one
+SELECT id, created_at, updated_at, name, url, user_id, last_fetched_at FROM feeds
+WHERE url = $1;
+
+-- name: GetNextFeedToFetch :one
+SELECT id, created_at, updated_at, name, url, user_id, last_fetched_at FROM feeds
+ORDER BY last_fetched_at ASC NULLS FIRST;
+
+-- name: MarkFeedAsFetched :exec
+UPDATE feeds
+SET last_fetched_at = $1
+WHERE feeds.id = $2;
@@ -0,0 +1,30 @@
+-- name: CreateFollow :one
+WITH inserted_follow as (
+  INSERT INTO follows (id, created_at, updated_at, feed_id, user_id)
+  VALUES (
+    $1,
+    $2,
+    $3,
+    $4,
+    $5
+  )
+  RETURNING *
+)
+SELECT inserted_follow.*,
+  feeds.name as feed_name,
+  users.name as user_name
+FROM inserted_follow
+INNER JOIN users
+  ON inserted_follow.user_id = users.id
+INNER JOIN feeds
+  ON inserted_follow.feed_id = feeds.id;
+
+-- name: GetFollowsForUser :many
+SELECT follows.*, feeds.name as feed_name FROM follows
+INNER JOIN feeds
+  ON follows.feed_id = feeds.id
+WHERE follows.user_id = $1;
+
+-- name: DeleteFollowForUser :exec
+DELETE FROM follows
+WHERE feed_id = $1 AND user_id = $2;
@@ -0,0 +1,33 @@
+-- name: CreatePost :one
+INSERT INTO posts (id, created_at, updated_at, title, url, description, published_at, feed_id)
+VALUES (
+  $1,
+  $2,
+  $3,
+  $4,
+  $5,
+  $6,
+  $7,
+  $8
+)
+RETURNING *;
+
+-- name: GetPostsForUser :many
+SELECT 
+  posts.id, 
+  posts.created_at, 
+  posts.updated_at, 
+  posts.title, 
+  posts.url, 
+  posts.description, 
+  posts.published_at, 
+  posts.feed_id,
+  feeds.name as feed_name
+FROM posts
+INNER JOIN feeds
+  ON posts.feed_id = feeds.id
+INNER JOIN follows
+  ON posts.feed_id = follows.feed_id
+WHERE follows.user_id = $1
+ORDER BY posts.published_at DESC, posts.title ASC
+LIMIT $2;
@@ -0,0 +1,23 @@
+-- name: CreateUser :one
+INSERT INTO users (id, created_at, updated_at, name)
+VALUES (
+  $1,
+  $2,
+  $3,
+  $4
+)
+RETURNING *;
+
+-- name: GetUserByName :one
+SELECT id, created_at, updated_at, name FROM users
+WHERE name = $1;
+
+-- name: GetUserById :one
+SELECT id, created_at, updated_at, name FROM users
+WHERE id = $1;
+
+-- name: GetAllUsers :many
+SELECT id, created_at, updated_at, name FROM users;
+
+-- name: DeleteAllUsers :exec
+DELETE FROM users;
@@ -1,8 +1,9 @@
-- TODO: Finish writing SQL migration
-- for users table
 -- +goose Up
 CREATE TABLE users (
-  id UUID 
+  id UUID PRIMARY KEY,
+  created_at TIMESTAMP NOT NULL,
+  updated_at TIMESTAMP NOT NULL,
+  name TEXT UNIQUE NOT NULL
 );

 -- +goose Down
@@ -0,0 +1,13 @@
+-- +goose Up
+CREATE TABLE feeds (
+  id UUID PRIMARY KEY,
+  created_at TIMESTAMP NOT NULL,
+  updated_at TIMESTAMP NOT NULL,
+  name TEXT NOT NULL,
+  url TEXT UNIQUE NOT NULL,
+  user_id UUID NOT NULL,
+  FOREIGN KEY(user_id) REFERENCES users(id) ON DELETE CASCADE
+);
+
+-- +goose Down
+DROP TABLE feeds;
@@ -0,0 +1,14 @@
+-- +goose Up
+CREATE TABLE follows (
+  id UUID PRIMARY KEY,
+  created_at TIMESTAMP NOT NULL,
+  updated_at TIMESTAMP NOT NULL,
+  user_id UUID NOT NULL,
+  feed_id UUID NOT NULL,
+  FOREIGN KEY(user_id) REFERENCES users(id) ON DELETE CASCADE,
+  FOREIGN KEY(feed_id) REFERENCES feeds(id) ON DELETE CASCADE,
+  CONSTRAINT unique_user_feed UNIQUE(user_id, feed_id)
+);
+
+-- +goose Down
+DROP TABLE follows;
@@ -0,0 +1,8 @@
+-- +goose Up
+ALTER TABLE feeds
+ADD COLUMN last_fetched_at TIMESTAMP NULL;
+
+-- +goose Down
+ALTER TABLE feeds
+DROP COLUMN last_fetched_at;
+
@@ -0,0 +1,16 @@
+-- +goose Up
+CREATE TABLE posts (
+  id UUID PRIMARY KEY,
+  created_at TIMESTAMP NOT NULL,
+  updated_at TIMESTAMP NOT NULL,
+  title TEXT NOT NULL,
+  url TEXT NOT NULL,
+  description TEXT NOT NULL,
+  published_at TIMESTAMP NULL,
+  feed_id UUID NOT NULL,
+  FOREIGN KEY(feed_id) REFERENCES feeds(id) ON DELETE CASCADE,
+  CONSTRAINT unique_url UNIQUE(url)
+);
+
+-- +goose Down
+DROP TABLE posts;
@@ -0,0 +1,8 @@
+version: "2"
+sql:
+  - schema: "sql/schema"
+    queries: "sql/queries"
+    engine: "postgresql"
+    gen:
+      go:
+        out: "internal/database"
Author	SHA1	Message	Date
Stevan Freeborn	ecaa816f1c	feat: address TODOs and write README.md	2026-08-04 18:00:54 -05:00
Stevan Freeborn	79090b3d39	chore: add TODOs	2026-08-03 07:16:59 -05:00
Stevan Freeborn	667f5f112b	feat: implement feed agg and browse	2026-08-03 07:14:33 -05:00
Stevan Freeborn	f51b1b941a	feat: added new commands - added follow command - added unfollow command - following command - introduced logged in user middleware	2026-08-02 07:49:57 -05:00
Stevan Freeborn	c012f6008c	feat: implemented many commands - added register command - added reset command - added users command - added agg command - added feeds command	2026-08-01 14:26:19 -05:00
Stevan Freeborn	fb53b052b0	chore: update gitignore	2026-08-01 11:38:23 -05:00
Stevan Freeborn	c1325925ed	feat: add users table migration	2026-08-01 11:35:49 -05:00