Implement support for async activities export

README.md

@@ -193,9 +193,11 @@ api.MetricsRetrieveLTV(&MetricsFilter{})
 api.MetricsListCustomerSubscriptions(&Cursor{}, "customerUUID")
 api.MetricsListCustomerActivities(&Cursor{}, "customerUUID")
 
-api.MetricsListActivities(&cm.MetricsListActivitiesParams{StartDate: "2016-09-16T09:28:10Z", AnchorCursor: cm.AnchorCursor{PerPage: 5, StartAfter: "b45b1d3f-3823-424f-ab47-5a1d0c00a7f6"}})
-```
+api.MetricsListActivities(&cm.MetricsListActivitiesParams{StartDate: "2016-09-16", AnchorCursor: cm.AnchorCursor{PerPage: 5, StartAfter: "b45b1d3f-3823-424f-ab47-5a1d0c00a7f6"}})
 
+api.MetricsCreateActivitiesExport(&cm.CreateMetricsActivitiesExportParam{StartDate: "2016-09-16",Type: "contraction"})
+api.MetricsRetrieveActivitiesExport("activitiesExportUUID")
+```
 
 ### Account
 

chartmogul.go

@@ -125,6 +125,8 @@ type IApi interface {
 	MetricsListCustomerSubscriptions(cursor *Cursor, customerUUID string) (*MetricsCustomerSubscriptions, error)
 	MetricsListCustomerActivities(cursor *Cursor, customerUUID string) (*MetricsCustomerActivities, error)
 	MetricsListActivities(MetricsListActivitiesParams *MetricsListActivitiesParams) (*MetricsActivities, error)
+	MetricsCreateActivitiesExport(CreateMetricsActivitiesExportParam *CreateMetricsActivitiesExportParam) (*MetricsActivitiesExport, error)
+	MetricsRetrieveActivitiesExport(activitiesExportUUID string) (*MetricsActivitiesExport, error)
 
 	// Account
 	RetrieveAccount() (*Account, error)

metrics_activities_exports.go

@@ -0,0 +1,52 @@
+package chartmogul
+
+// MetricsActivitiesExport represents Metrics API activity export in ChartMogul.
+type MetricsActivitiesExport struct {
+	ID        string `json:"id"`
+	Status    string `json:"status"`
+	FileURL   string `json:"file_url"`
+	Params    Params `json:"params"`
+	ExpiresAt string `json:"expires_at"`
+	CreatedAt string `json:"created_at"`
+}
+
+// Params provides information on the requested export.
+type Params struct {
+	Kind   string       `json:"kind"`
+	Params NestedParams `json:"params,omitempty"`
+}
+
+// NestedParams represents the params of the requested type of export.
+type NestedParams struct {
+	ActivityType string `json:"activity_type,omitempty"`
+	StartDate    string `json:"start_date,omitempty"`
+	EndDate      string `json:"end_date,omitempty"`
+}
+
+// CreateMetricsActivitiesExportParam to create a MetricsActivitiesExport.
+type CreateMetricsActivitiesExportParam struct {
+	Type      string `json:"type,omitempty"`
+	StartDate string `json:"start-date,omitempty"`
+	EndDate   string `json:"end-date,omitempty"`
+}
+
+const (
+	metricsActivitiesExportEndpoint       = "activities_export"
+	singleMetricsActivitiesExportEndpoint = "activities_export/:uuid"
+)
+
+// MetricsCreateActivitiesExport requests creation of an activities export in Chartmogul.
+//
+// See https://dev.chartmogul.com/v1.0/reference#activities_export
+func (api API) MetricsCreateActivitiesExport(CreateMetricsActivitiesExportParam *CreateMetricsActivitiesExportParam) (*MetricsActivitiesExport, error) {
+	result := &MetricsActivitiesExport{}
+	return result, api.create(metricsActivitiesExportEndpoint, CreateMetricsActivitiesExportParam, result)
+}
+
+// MetricsRetrieveActivitiesExport returns one activities export as in API.
+//
+// See https://dev.chartmogul.com/v1.0/reference#activities_export
+func (api API) MetricsRetrieveActivitiesExport(activitiesExportUUID string) (*MetricsActivitiesExport, error) {
+	result := &MetricsActivitiesExport{}
+	return result, api.retrieve(singleMetricsActivitiesExportEndpoint, activitiesExportUUID, result)
+}

metrics_activities_exports_test.go

@@ -0,0 +1,111 @@
+package chartmogul
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/davecgh/go-spew/spew"
+)
+
+// Tests creation on an activity export.
+func TestCreateActivitiesExport(t *testing.T) {
+	server := httptest.NewServer(
+		http.HandlerFunc(
+			func(w http.ResponseWriter, r *http.Request) {
+				if r.Method != "POST" {
+					t.Errorf("Unexpected method %v", r.Method)
+				}
+				if r.RequestURI != "/v/activities_export" {
+					t.Errorf("Unexpected URI %v", r.RequestURI)
+				}
+				w.WriteHeader(http.StatusOK)
+				//nolint
+				w.Write([]byte(`{
+							      "id": "7f554dba-4a41-4cb2-9790-2045e4c3a5b1",
+							      "status": "pending",
+							      "file_url": null,
+							      "params": {
+							        "kind": "activities",
+							        "params": {
+							          "activity_type": "contraction",
+							          "start_date": "2020-01-01",
+							          "end_date": "2020-12-31"
+							        }
+							      },
+							      "expires_at": null,
+							      "created_at": "2021-07-12T14:46:56+00:00"
+							    }`))
+			}))
+	defer server.Close()
+	SetURL(server.URL + "/v/%v")
+
+	var tested IApi = &API{
+		AccountToken: "token",
+		AccessKey:    "key",
+	}
+	activitiesExport, err := tested.MetricsCreateActivitiesExport(&CreateMetricsActivitiesExportParam{
+		StartDate: "2020-01-01",
+		EndDate:   "2020-12-31",
+		Type:      "contraction",
+	})
+
+	if err != nil {
+		spew.Dump(err)
+		t.Fatal("Not expected to fail")
+	}
+	if activitiesExport.ID != "7f554dba-4a41-4cb2-9790-2045e4c3a5b1" || activitiesExport.Status != "pending" {
+		spew.Dump(activitiesExport)
+		t.Fatal("Unexpected result")
+	}
+}
+
+// Tests retrieval of an activity export
+func TestRetrieveActivitiesExport(t *testing.T) {
+	server := httptest.NewServer(
+		http.HandlerFunc(
+			func(w http.ResponseWriter, r *http.Request) {
+				if r.Method != "GET" {
+					t.Errorf("Unexpected method %v", r.Method)
+				}
+				if r.RequestURI != "/v/activities_export/7f554dba-4a41-4cb2-9790-2045e4c3a5b1" {
+					t.Errorf("Unexpected URI %v", r.RequestURI)
+				}
+				w.WriteHeader(http.StatusOK)
+				//nolint
+				w.Write([]byte(`{
+							      "id": "7f554dba-4a41-4cb2-9790-2045e4c3a5b1",
+							      "status": "succeeded",
+							      "file_url": "https://chartmogul-customer-export.s3.eu-west-1.amazonaws.com/activities-acme-corp-91e1ca88-d747-4e25-83d9-2b752033bdba.zip",
+							      "params": {
+							        "kind": "activities",
+							        "params": {
+							          "activity_type": "contraction",
+							          "start_date": "2020-01-01",
+							          "end_date": "2020-12-31"
+							        }
+							      },
+							      "expires_at": "2021-07-19T14:46:58+00:00",
+							      "created_at": "2021-07-12T14:46:56+00:00"
+							    }`))
+			}))
+	defer server.Close()
+	SetURL(server.URL + "/v/%v")
+
+	var tested IApi = &API{
+		AccountToken: "token",
+		AccessKey:    "key",
+	}
+
+	var activitiesExportID = "7f554dba-4a41-4cb2-9790-2045e4c3a5b1"
+	activitiesExport, err := tested.MetricsRetrieveActivitiesExport(activitiesExportID)
+
+	if err != nil {
+		spew.Dump(err)
+		t.Fatal("Not expected to fail")
+	}
+	if activitiesExport.ID != activitiesExportID || activitiesExport.Status != "succeeded" {
+		spew.Dump(activitiesExport)
+		t.Fatal("Unexpected result")
+	}
+}