diff --git a/cmd/holiday-api/Dockerfile b/cmd/holiday-api/Dockerfile index 902d90a..eca1809 100644 --- a/cmd/holiday-api/Dockerfile +++ b/cmd/holiday-api/Dockerfile @@ -7,6 +7,8 @@ WORKDIR /go/src/github.com/Luzifer/go-holidays/cmd/holiday-api RUN set -ex \ && apk add --update git ca-certificates \ + && go get -u github.com/jteeuwen/go-bindata/... \ + && go generate \ && go install -ldflags "-X main.version=$(git describe --tags || git rev-parse --short HEAD || echo dev)" \ && apk del --purge git diff --git a/cmd/holiday-api/assets.go b/cmd/holiday-api/assets.go new file mode 100644 index 0000000..876286f --- /dev/null +++ b/cmd/holiday-api/assets.go @@ -0,0 +1,192 @@ +// Code generated by go-bindata. +// sources: +// index.html +// DO NOT EDIT! + +package main + +import ( + "fmt" + "io/ioutil" + "os" + "path/filepath" + "strings" +) + +// bindataRead reads the given file from disk. It returns an error on failure. +func bindataRead(path, name string) ([]byte, error) { + buf, err := ioutil.ReadFile(path) + if err != nil { + err = fmt.Errorf("Error reading asset %s at %s: %v", name, path, err) + } + return buf, err +} + +type asset struct { + bytes []byte + info os.FileInfo +} + +// indexHtml reads file data from disk. It returns an error on failure. +func indexHtml() (*asset, error) { + path := filepath.Join(rootDir, "index.html") + name := "index.html" + bytes, err := bindataRead(path, name) + if err != nil { + return nil, err + } + + fi, err := os.Stat(path) + if err != nil { + err = fmt.Errorf("Error reading asset info %s at %s: %v", name, path, err) + } + + a := &asset{bytes: bytes, info: fi} + return a, err +} + +// Asset loads and returns the asset for the given name. +// It returns an error if the asset could not be found or +// could not be loaded. +func Asset(name string) ([]byte, error) { + cannonicalName := strings.Replace(name, "\\", "/", -1) + if f, ok := _bindata[cannonicalName]; ok { + a, err := f() + if err != nil { + return nil, fmt.Errorf("Asset %s can't read by error: %v", name, err) + } + return a.bytes, nil + } + return nil, fmt.Errorf("Asset %s not found", name) +} + +// MustAsset is like Asset but panics when Asset would return an error. +// It simplifies safe initialization of global variables. +func MustAsset(name string) []byte { + a, err := Asset(name) + if err != nil { + panic("asset: Asset(" + name + "): " + err.Error()) + } + + return a +} + +// AssetInfo loads and returns the asset info for the given name. +// It returns an error if the asset could not be found or +// could not be loaded. +func AssetInfo(name string) (os.FileInfo, error) { + cannonicalName := strings.Replace(name, "\\", "/", -1) + if f, ok := _bindata[cannonicalName]; ok { + a, err := f() + if err != nil { + return nil, fmt.Errorf("AssetInfo %s can't read by error: %v", name, err) + } + return a.info, nil + } + return nil, fmt.Errorf("AssetInfo %s not found", name) +} + +// AssetNames returns the names of the assets. +func AssetNames() []string { + names := make([]string, 0, len(_bindata)) + for name := range _bindata { + names = append(names, name) + } + return names +} + +// _bindata is a table, holding each asset generator, mapped to its name. +var _bindata = map[string]func() (*asset, error){ + "index.html": indexHtml, +} + +// AssetDir returns the file names below a certain +// directory embedded in the file by go-bindata. +// For example if you run go-bindata on data/... and data contains the +// following hierarchy: +// data/ +// foo.txt +// img/ +// a.png +// b.png +// then AssetDir("data") would return []string{"foo.txt", "img"} +// AssetDir("data/img") would return []string{"a.png", "b.png"} +// AssetDir("foo.txt") and AssetDir("notexist") would return an error +// AssetDir("") will return []string{"data"}. +func AssetDir(name string) ([]string, error) { + node := _bintree + if len(name) != 0 { + cannonicalName := strings.Replace(name, "\\", "/", -1) + pathList := strings.Split(cannonicalName, "/") + for _, p := range pathList { + node = node.Children[p] + if node == nil { + return nil, fmt.Errorf("Asset %s not found", name) + } + } + } + if node.Func != nil { + return nil, fmt.Errorf("Asset %s not found", name) + } + rv := make([]string, 0, len(node.Children)) + for childName := range node.Children { + rv = append(rv, childName) + } + return rv, nil +} + +type bintree struct { + Func func() (*asset, error) + Children map[string]*bintree +} +var _bintree = &bintree{nil, map[string]*bintree{ + "index.html": &bintree{indexHtml, map[string]*bintree{}}, +}} + +// RestoreAsset restores an asset under the given directory +func RestoreAsset(dir, name string) error { + data, err := Asset(name) + if err != nil { + return err + } + info, err := AssetInfo(name) + if err != nil { + return err + } + err = os.MkdirAll(_filePath(dir, filepath.Dir(name)), os.FileMode(0755)) + if err != nil { + return err + } + err = ioutil.WriteFile(_filePath(dir, name), data, info.Mode()) + if err != nil { + return err + } + err = os.Chtimes(_filePath(dir, name), info.ModTime(), info.ModTime()) + if err != nil { + return err + } + return nil +} + +// RestoreAssets restores an asset under the given directory recursively +func RestoreAssets(dir, name string) error { + children, err := AssetDir(name) + // File + if err != nil { + return RestoreAsset(dir, name) + } + // Dir + for _, child := range children { + err = RestoreAssets(dir, filepath.Join(name, child)) + if err != nil { + return err + } + } + return nil +} + +func _filePath(dir, name string) string { + cannonicalName := strings.Replace(name, "\\", "/", -1) + return filepath.Join(append([]string{dir}, strings.Split(cannonicalName, "/")...)...) +} + diff --git a/cmd/holiday-api/index.html b/cmd/holiday-api/index.html new file mode 100644 index 0000000..ee91d18 --- /dev/null +++ b/cmd/holiday-api/index.html @@ -0,0 +1,98 @@ + + + + + + + + holiday-api Documentation + + + + + + + + + + +
+
+# holiday-api Documentation + +This instance of `holiday-api` is a convenient wrapper around my [go-holiday library](https://github.com/Luzifer/go-holidays) which contains holidays for different countries. With this wrapper you can request a JSON output for a specific country or state within a country using [ISO 3166-1 alpha-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). For some countries (for example Germany) the corresponding state code extension is supported. + +## Usage + +The supported URL scheme is `/{country-code}/{year}` while `{year}` is optional and if not set the current year is used. + +Examples: +- [`/us`](/us) - Federal holidays for the United States for the current year +- [`/de/2017`](/de/2017) - National holidays in Germany for 2017 +- [`/de-by/2017`](/de-by/2017) - Holidays for Bavaria for 2017 (Uses [ISO 3166-2:DE](https://en.wikipedia.org/wiki/ISO_3166-2:DE) codes) + +No request limits are enforced so please play nice with the API. + +## Response + +The API will respond with +- `HTTP 200` and a JSON array if the query was successful +- `HTTP 404` if your URL is nvalid. +- `HTTP 500` if the requested country-code is not included / supported + +### JSON format + +Each entry consists of four keys: +- `name`: Name of the holiday in English language +- `localized_name`: A mapping of different localizations (key is an ISO 3166-1 alpha-2 country code) +- `date`: A string representation of the date in `YYYY-MM-DD` notation +- `parsed_date`: The date as a DateTime string with timezone of the server running the API + +```json +[ + { + name: "New Year's Day", + localized_name: { + de: "Neujahrstag" + }, + date: "2017-01-01", + parsed_date: "2017-01-01T00:00:00Z" + }, + { + name: "Good Friday", + localized_name: { + de: "Karfreitag" + }, + date: "2017-04-14", + parsed_date: "2017-04-14T00:00:00Z" + } +] +``` +## Contributions + +If you are fluent in writing Go and know about holidays of a country not yet available inside the library please get in touch with me. Either using an issue or a pull-request in the [repository](https://github.com/Luzifer/go-holidays) or using any method on my website: [ahlers.me](https://ahlers.me/) +
+
+ + + + + + + + + + + diff --git a/cmd/holiday-api/main.go b/cmd/holiday-api/main.go index 417787b..a7c4ae7 100644 --- a/cmd/holiday-api/main.go +++ b/cmd/holiday-api/main.go @@ -1,5 +1,7 @@ package main +//go:generate go-bindata -pkg $GOPACKAGE -o assets.go index.html + import ( "encoding/json" "fmt" @@ -38,6 +40,7 @@ func main() { r := mux.NewRouter() r.HandleFunc("/{country-code:[a-z-]+}/{year:[0-9]{4}}", handleHolidays) r.HandleFunc("/{country-code:[a-z-]+}", handleHolidays) + r.HandleFunc("/", handleReadme) http.ListenAndServe(cfg.Listen, r) } @@ -66,3 +69,8 @@ func handleHolidays(res http.ResponseWriter, r *http.Request) { res.Header().Set("Content-Type", "application/json") json.NewEncoder(res).Encode(holidays) } + +func handleReadme(res http.ResponseWriter, r *http.Request) { + readme, _ := Asset("index.html") + res.Write(readme) +}