Update docs (#2)

.github/workflows/quality.yaml

@@ -0,0 +1,32 @@
+name: Quality
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.21'
+
+      - uses: golangci/golangci-lint-action@v3
+        with:
+          args: --timeout=5m
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.21'
+
+      - run: go test ./...

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+dylanbutler@outlook.com.au.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -1,86 +1,63 @@
-# Cloud Run Reverse Proxy
+# Reverse Proxy
 
-`reverseproxy` is a Go package that provides a simple reverse proxy implementation with customizable routing rules for Google Cloud Run services. It allows you to route incoming HTTP requests to different backend services based on rules such as path prefixes or client IP addresses. The package also handles OIDC token generation for authenticated communication between services.
-
-## Installation
-
-To install the package, run:
-
-```bash
-go get -u github.com/dbut2/reverse-proxy
-```
+The reverse proxy package provides a wrapper around `httputil.ReverseProxy`, adding the ability to create flexible, rule based routing
 
 ## Usage
 
-### Import the package
+Import reverse-proxy
+```shell
+go get github.com/dbut2/reverse-proxy
+```
 
+In your Go code, add
 ```go
 import "github.com/dbut2/reverse-proxy"
 ```
 
-### Create a reverse proxy
-
-Define your routing rules using the `reverseproxy.Selector` type. You can create rules based on path prefixes or client IP addresses using the `PathRule` and `IPRule` functions. Finally, create a reverse proxy instance with the defined rules using the `New` function.
-
+Creating a reverse proxy with selectors
 ```go
-selectors := []rp.Selector{
-    // Reverse proxy selectors...
-}
-proxy := reverseproxy.New(selectors...)
+proxy := rp.New(
+    rp.Select("https://myapi.com", rp.PathIsAt("/api")),
+    rp.Select("https://example.com", rp.Always()),
+)
 ```
 
-### Run the reverse proxy server
-
-Register the reverse proxy as an HTTP handler and start the server.
+Using selector options
+```go
+proxy := rp.New(
+    rp.Select("https://private-cloud-run-instance.com", rp.IPMatches("12.34.56.78"), rp.WithOIDC()),
+    rp.Select("https://example.com", rp.Always()),
+)
+```
 
+Listen and serve
 ```go
+proxy := rp.New(
+    rp.Select("https://myapi.com", rp.PathIsAt("/api")),
+    rp.Select("https://example.com", rp.Always()),
+)
+
 http.ListenAndServe(":8080", proxy)
 ```
 
-## Example
-
-Below is a complete example demonstrating how to create and use a reverse proxy with customizable routing rules:
+### Example
 
 ```go
 package main
 
 import (
-    "log"
-    "net/http"
-    "os"
+	"net/http"
 
-    "github.com/dbut2/reverse-proxy"
+	"github.com/dbut2/reverse-proxy"
 )
 
 func main() {
-	// Load environment variables
-	publicURL := os.Getenv("PUBLIC_URL")
-	privateURL := os.Getenv("PRIVATE_URL")
-	privateClientIP := os.Getenv("PRIVATE_CLIENT_ID")
-	port := os.Getenv("PORT")
-	if port == "" {
-		port = "8080"
-	}
-
-	// Define routing selectors
-	selectors := []rp.Selector{
-		rp.Select(privateURL, rp.IPRule(privateClientIP)),
-		rp.Select(publicURL, rp.BaseRule()),
-    }
-
-	// Create the reverse proxy with the defined rules
-	proxy := rp.New(selectors...)
-
-	// Register the reverse proxy as an HTTP handler
-	http.HandleFunc("/", proxy.ServeHTTP)
+	proxy := rp.New(
+		rp.Select("https://myapi.com", rp.PathIsAt("/api")),
+		rp.Select("https://example.com", rp.Always()),
+	)
 
-	// Start the HTTP server
-	log.Printf("Starting reverse proxy on :%s\n", port)
-	err := http.ListenAndServe(":"+port, nil)
-	if err != nil {
-		panic(err)
-	}
+	http.ListenAndServe(":8080", proxy)
 }
 ```
 
-Don't forget to set the environment variables `PUBLIC_URL`, `PRIVATE_URL`, `PRIVATE_CLIENT_ID`, and `PORT` before running the example.

go.mod

@@ -1,30 +1,30 @@
 module github.com/dbut2/reverse-proxy
 
-go 1.20
+go 1.21
 
 require (
-	github.com/stretchr/testify v1.8.1
-	google.golang.org/api v0.118.0
+	github.com/stretchr/testify v1.8.4
+	google.golang.org/api v0.138.0
 )
 
 require (
-	cloud.google.com/go/compute v1.19.0 // indirect
+	cloud.google.com/go/compute v1.23.0 // indirect
 	cloud.google.com/go/compute/metadata v0.2.3 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
-	github.com/google/s2a-go v0.1.0 // indirect
-	github.com/googleapis/enterprise-certificate-proxy v0.2.3 // indirect
+	github.com/google/s2a-go v0.1.5 // indirect
+	github.com/googleapis/enterprise-certificate-proxy v0.2.5 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	go.opencensus.io v0.24.0 // indirect
-	golang.org/x/crypto v0.1.0 // indirect
-	golang.org/x/net v0.9.0 // indirect
-	golang.org/x/oauth2 v0.7.0 // indirect
-	golang.org/x/sys v0.7.0 // indirect
-	golang.org/x/text v0.9.0 // indirect
+	golang.org/x/crypto v0.12.0 // indirect
+	golang.org/x/net v0.14.0 // indirect
+	golang.org/x/oauth2 v0.11.0 // indirect
+	golang.org/x/sys v0.11.0 // indirect
+	golang.org/x/text v0.12.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
-	google.golang.org/genproto v0.0.0-20230403163135-c38d8f061ccd // indirect
-	google.golang.org/grpc v1.54.0 // indirect
-	google.golang.org/protobuf v1.30.0 // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20230807174057-1744710a1577 // indirect
+	google.golang.org/grpc v1.57.0 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )