Add Warmer API

See olivere#182 on GitHub.
See
https://www.elastic.co/guide/en/elasticsearch/reference/2.1/indices-warmers.html
for documentation.

Author: olivere

README.md

@@ -275,7 +275,7 @@ See the [wiki](https://github.com/olivere/elastic/wiki) for more details.
 - [x] Get Settings
 - [ ] Analyze
 - [x] Index Templates
-- [ ] Warmers
+- [x] Warmers
 - [x] Indices Stats
 - [ ] Indices Segments
 - [ ] Indices Recovery

client.go

@@ -22,7 +22,7 @@ import (
 
 const (
 	// Version is the current version of Elastic.
-	Version = "3.0.10"
+	Version = "3.0.11"
 
 	// DefaultUrl is the default endpoint of Elasticsearch on the local machine.
 	// It is used e.g. when initializing a new Client without a specific URL.
@@ -1294,6 +1294,21 @@ func (c *Client) PutMapping() *PutMappingService {
 	return NewPutMappingService(c)
 }
 
+// GetWarmer gets one or more warmers by name.
+func (c *Client) GetWarmer() *IndicesGetWarmerService {
+	return NewIndicesGetWarmerService(c)
+}
+
+// PutWarmer registers a warmer.
+func (c *Client) PutWarmer() *IndicesPutWarmerService {
+	return NewIndicesPutWarmerService(c)
+}
+
+// DeleteWarmer deletes one or more warmers.
+func (c *Client) DeleteWarmer() *IndicesDeleteWarmerService {
+	return NewIndicesDeleteWarmerService(c)
+}
+
 // -- cat APIs --
 
 // TODO cat aliases

indices_delete_warmer.go

@@ -0,0 +1,131 @@
+// Copyright 2012-2015 Oliver Eilhard. All rights reserved.
+// Use of this source code is governed by a MIT-license.
+// See http://olivere.mit-license.org/license.txt for details.
+
+package elastic
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/url"
+	"strings"
+
+	"gopkg.in/olivere/elastic.v3/uritemplates"
+)
+
+// IndicesDeleteWarmerService allows to delete a warmer.
+// See https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-warmers.html.
+type IndicesDeleteWarmerService struct {
+	client        *Client
+	pretty        bool
+	index         []string
+	name          []string
+	masterTimeout string
+}
+
+// NewIndicesDeleteWarmerService creates a new IndicesDeleteWarmerService.
+func NewIndicesDeleteWarmerService(client *Client) *IndicesDeleteWarmerService {
+	return &IndicesDeleteWarmerService{
+		client: client,
+		index:  make([]string, 0),
+		name:   make([]string, 0),
+	}
+}
+
+// Index is a list of index names the mapping should be added to
+// (supports wildcards); use `_all` or omit to add the mapping on all indices.
+func (s *IndicesDeleteWarmerService) Index(indices ...string) *IndicesDeleteWarmerService {
+	s.index = append(s.index, indices...)
+	return s
+}
+
+// Name is a list of warmer names to delete (supports wildcards);
+// use `_all` to delete all warmers in the specified indices.
+func (s *IndicesDeleteWarmerService) Name(name ...string) *IndicesDeleteWarmerService {
+	s.name = append(s.name, name...)
+	return s
+}
+
+// MasterTimeout specifies the timeout for connection to master.
+func (s *IndicesDeleteWarmerService) MasterTimeout(masterTimeout string) *IndicesDeleteWarmerService {
+	s.masterTimeout = masterTimeout
+	return s
+}
+
+// Pretty indicates that the JSON response be indented and human readable.
+func (s *IndicesDeleteWarmerService) Pretty(pretty bool) *IndicesDeleteWarmerService {
+	s.pretty = pretty
+	return s
+}
+
+// buildURL builds the URL for the operation.
+func (s *IndicesDeleteWarmerService) buildURL() (string, url.Values, error) {
+	// Build URL
+	path, err := uritemplates.Expand("/{index}/_warmer/{name}", map[string]string{
+		"index": strings.Join(s.index, ","),
+		"name":  strings.Join(s.name, ","),
+	})
+	if err != nil {
+		return "", url.Values{}, err
+	}
+
+	// Add query string parameters
+	params := url.Values{}
+	if s.pretty {
+		params.Set("pretty", "1")
+	}
+	if s.masterTimeout != "" {
+		params.Set("master_timeout", s.masterTimeout)
+	}
+	if len(s.name) > 0 {
+		params.Set("name", strings.Join(s.name, ","))
+	}
+	return path, params, nil
+}
+
+// Validate checks if the operation is valid.
+func (s *IndicesDeleteWarmerService) Validate() error {
+	var invalid []string
+	if len(s.index) == 0 {
+		invalid = append(invalid, "Index")
+	}
+	if len(s.name) == 0 {
+		invalid = append(invalid, "Name")
+	}
+	if len(invalid) > 0 {
+		return fmt.Errorf("missing required fields: %v", invalid)
+	}
+	return nil
+}
+
+// Do executes the operation.
+func (s *IndicesDeleteWarmerService) Do() (*DeleteWarmerResponse, error) {
+	// Check pre-conditions
+	if err := s.Validate(); err != nil {
+		return nil, err
+	}
+
+	// Get URL for request
+	path, params, err := s.buildURL()
+	if err != nil {
+		return nil, err
+	}
+
+	// Get HTTP response
+	res, err := s.client.PerformRequest("DELETE", path, params, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	// Return operation response
+	ret := new(DeleteWarmerResponse)
+	if err := json.Unmarshal(res.Body, ret); err != nil {
+		return nil, err
+	}
+	return ret, nil
+}
+
+// DeleteWarmerResponse is the response of IndicesDeleteWarmerService.Do.
+type DeleteWarmerResponse struct {
+	Acknowledged bool `json:"acknowledged"`
+}

indices_delete_warmer_test.go

@@ -0,0 +1,48 @@
+// Copyright 2012-2015 Oliver Eilhard. All rights reserved.
+// Use of this source code is governed by a MIT-license.
+// See http://olivere.mit-license.org/license.txt for details.
+
+package elastic
+
+import "testing"
+
+func TestDeleteWarmerBuildURL(t *testing.T) {
+	client := setupTestClientAndCreateIndex(t)
+
+	tests := []struct {
+		Indices  []string
+		Names    []string
+		Expected string
+	}{
+		{
+			[]string{"test"},
+			[]string{"warmer_1"},
+			"/test/_warmer/warmer_1",
+		},
+		{
+			[]string{"*"},
+			[]string{"warmer_1"},
+			"/%2A/_warmer/warmer_1",
+		},
+		{
+			[]string{"_all"},
+			[]string{"warmer_1"},
+			"/_all/_warmer/warmer_1",
+		},
+		{
+			[]string{"index-1", "index-2"},
+			[]string{"warmer_1", "warmer_2"},
+			"/index-1%2Cindex-2/_warmer/warmer_1%2Cwarmer_2",
+		},
+	}
+
+	for _, test := range tests {
+		path, _, err := client.DeleteWarmer().Index(test.Indices...).Name(test.Names...).buildURL()
+		if err != nil {
+			t.Fatal(err)
+		}
+		if path != test.Expected {
+			t.Errorf("expected %q; got: %q", test.Expected, path)
+		}
+	}
+}