gop

README

GOP

---

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• Authors
• Acknowledgments

🧐 About

GOP: "Git Object Proxy" is a generic library used to implement moduling systems in programming languages. GOP defines two main interfaces that can be used to retrieve and cache resources from different sources. See revision2.md to see design doc.

🏁 Getting Started

See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them.

• Go 1.13: currently google cloud functions only support upto the go 1.13 runtime

🔧 Running the tests

go test ./... -short

🎈 Usage

go run ./cmd/servegop

• This will run a gop server on localhost:8080

🚀 Deployment

• example

⛏️ Built Using

• Google Cloud Functions - Deployment
• Google Cloud Storage - Asset caching
• Golang - Server

✍️ Authors

• @joshcarp

🎉 Acknowledgements

• Go Modules: Athens Project: https://github.com/gomods/athens

Documentation

Index

• func CORSEnabledFunction(w http.ResponseWriter, r *http.Request)
• func HandleErr(w http.ResponseWriter, err error)
• func ServeHTTP(w http.ResponseWriter, r *http.Request)
• type GopperService
  • func NewGopper(cachelocation, fsType, tokenEnv string) (*GopperService, error)
  • func (a GopperService) Retrieve(resource string) ([]byte, bool, error)

Functions

func CORSEnabledFunction

func CORSEnabledFunction(w http.ResponseWriter, r *http.Request)

func HandleErr

func HandleErr(w http.ResponseWriter, err error)

func ServeHTTP

func ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is a http.HandlerFunc, can be used in deployments like cloud functions

Types

type GopperService

type GopperService struct {
	gop3.Gopper
	gop3.Retriever
	gop3.Resolver
}

GopperService is an implementation of Gopper that will fall back to a git retriever if the file can't be found in

its data source

func NewGopper

func NewGopper(cachelocation, fsType, tokenEnv string) (*GopperService, error)

NewGopper returns a GopperService for a config; This Gopper can use an os filesystem, memory filesystem or a gcs bucket

func (GopperService) Retrieve

func (a GopperService) Retrieve(resource string) ([]byte, bool, error)

Retrieve attempts to retrieve a file from GopperService.Gopper, if this fails then it will fall back to using a

git retriever