github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

tpl/data: Allows user-defined HTTP headers with getJSON and getCSV

Browse source 
Updates #5617
This commit is contained in:
Paul Chamberlain 2021-04-26 16:41:37 -04:00 committed by Bjørn Erik Pedersen
parent 06d295427f
commit 150d75738b
2 changed files with 49 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
tpl/data/data.go
View file

@ -58,8 +58,8 @@ type Namespace struct {
// The data separator can be a comma, semi-colon, pipe, etc, but only one character.
// If you provide multiple parts for the URL they will be joined together to the final URL.
// GetCSV returns nil or a slice slice to use in a short code.
func (ns *Namespace) GetCSV(sep string, urlParts ...interface{}) (d [][]string, err error) {
url := joinURL(urlParts)
func (ns *Namespace) GetCSV(sep string, args ...interface{}) (d [][]string, err error) {
url := joinURL(args)
cache := ns.cacheGetCSV
unmarshal := func(b []byte) (bool, error) {
@ -85,6 +85,15 @@ func (ns *Namespace) GetCSV(sep string, urlParts ...interface{}) (d [][]string,
req.Header.Add("Accept", "text/csv")
req.Header.Add("Accept", "text/plain")
// Add custom user headers to the get request
finalArg := args[len(args)-1]
if userHeaders, ok := finalArg.(map[string]interface{}); ok {
for key, val := range userHeaders {
req.Header.Add(key, val.(string))
}
}
err = ns.getResource(cache, unmarshal, req)
if err != nil {
ns.deps.Log.(loggers.IgnorableLogger).Errorsf(constants.ErrRemoteGetCSV, "Failed to get CSV resource %q: %s", url, err)
@ -97,9 +106,9 @@ func (ns *Namespace) GetCSV(sep string, urlParts ...interface{}) (d [][]string,
// GetJSON expects one or n-parts of a URL to a resource which can either be a local or a remote one.
// If you provide multiple parts they will be joined together to the final URL.
// GetJSON returns nil or parsed JSON to use in a short code.
func (ns *Namespace) GetJSON(urlParts ...interface{}) (interface{}, error) {
func (ns *Namespace) GetJSON(args ...interface{}) (interface{}, error) {
var v interface{}
url := joinURL(urlParts)
url := joinURL(args)
cache := ns.cacheGetJSON
req, err := http.NewRequest("GET", url, nil)
@ -118,6 +127,15 @@ func (ns *Namespace) GetJSON(urlParts ...interface{}) (interface{}, error) {
req.Header.Add("Accept", "application/json")
req.Header.Add("User-Agent", "Hugo Static Site Generator")
// Add custom user headers to the get request
finalArg := args[len(args)-1]
if userHeaders, ok := finalArg.(map[string]interface{}); ok {
for key, val := range userHeaders {
req.Header.Add(key, val.(string))
}
}
err = ns.getResource(cache, unmarshal, req)
if err != nil {
ns.deps.Log.(loggers.IgnorableLogger).Errorsf(constants.ErrRemoteGetJSON, "Failed to get JSON resource %q: %s", url, err)

27
tpl/data/data_test.go
View file

@ -119,6 +119,20 @@ func TestGetCSV(t *testing.T) {
c.Assert(got, qt.Not(qt.IsNil), msg)
c.Assert(got, qt.DeepEquals, test.expect, msg)
// Test user-defined headers as well
gotHeader, _ := ns.GetCSV(test.sep, test.url, map[string]interface{}{"Accept-Charset": "utf-8", "Max-Forwards": "10"})
if _, ok := test.expect.(bool); ok {
c.Assert(int(ns.deps.Log.LogCounters().ErrorCounter.Count()), qt.Equals, 1)
// c.Assert(err, msg, qt.Not(qt.IsNil))
c.Assert(got, qt.IsNil)
continue
}
c.Assert(err, qt.IsNil, msg)
c.Assert(int(ns.deps.Log.LogCounters().ErrorCounter.Count()), qt.Equals, 0)
c.Assert(gotHeader, qt.Not(qt.IsNil), msg)
c.Assert(gotHeader, qt.DeepEquals, test.expect, msg)
}
}
@ -206,6 +220,19 @@ func TestGetJSON(t *testing.T) {
c.Assert(int(ns.deps.Log.LogCounters().ErrorCounter.Count()), qt.Equals, 0, msg)
c.Assert(got, qt.Not(qt.IsNil), msg)
c.Assert(got, qt.DeepEquals, test.expect)
// Test user-defined headers as well
gotHeader, _ := ns.GetJSON(test.url, map[string]interface{}{"Accept-Charset": "utf-8", "Max-Forwards": "10"})
if _, ok := test.expect.(bool); ok {
c.Assert(int(ns.deps.Log.LogCounters().ErrorCounter.Count()), qt.Equals, 1)
// c.Assert(err, msg, qt.Not(qt.IsNil))
continue
}
c.Assert(int(ns.deps.Log.LogCounters().ErrorCounter.Count()), qt.Equals, 0, msg)
c.Assert(gotHeader, qt.Not(qt.IsNil), msg)
c.Assert(gotHeader, qt.DeepEquals, test.expect)
}
}