Merge pull request #9 from seatsio/steve/readme_plus_code_alignment

README and code alignment
seatsio · Aug 7, 2023 · 969087a · 969087a
2 parents e74ec60 + 3680b9e
commit 969087a
Show file tree

Hide file tree

Showing 74 changed files with 1,030 additions and 274 deletions.
diff --git a/README.md b/README.md
diff --git a/charts/charts.go b/charts/charts.go
@@ -173,17 +173,17 @@ func (charts *Charts) RemoveCategory(chartKey string, categoryKey events.Categor
 	return shared.AssertOkWithoutResult(result, err)
 }
 
-type ListCategoriesResponse struct {
+type listCategoriesResponse struct {
 	Categories []events.Category `json:"categories"`
 }
 
-func (charts *Charts) ListCategories(chartKey string) (*ListCategoriesResponse, error) {
-	var response ListCategoriesResponse
+func (charts *Charts) ListCategories(chartKey string) ([]events.Category, error) {
+	var response listCategoriesResponse
 	result, err := charts.Client.R().
 		SetSuccessResult(&response).
 		SetPathParam("chartKey", chartKey).
 		Get("/charts/{chartKey}/categories")
-	return shared.AssertOk(result, err, &response)
+	return shared.AssertOkArray(result, err, &response.Categories)
 }
 
 func (charts *Charts) PublishDraftVersion(chartKey string) error {

diff --git a/charts_test/add_tag_test.go b/charts_test/add_tag_test.go
@@ -11,7 +11,7 @@ func TestAddTag(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	err := client.Charts.AddTag(chartKey, "tag1")
 	require.NoError(t, err)
@@ -29,7 +29,7 @@ func TestSpecialCharacters(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	err := client.Charts.AddTag(chartKey, "'tag1:-'<>")
 	require.NoError(t, err)

diff --git a/charts_test/copy_chart_test.go b/charts_test/copy_chart_test.go
@@ -11,7 +11,7 @@ func TestCopyChart(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	copiedChart, err := client.Charts.Copy(chartKey)
 

diff --git a/charts_test/copy_chart_to_workspace_test.go b/charts_test/copy_chart_to_workspace_test.go
@@ -11,15 +11,15 @@ func TestCopyChartToWorkspace(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 	workspace, err := client.Workspaces.CreateProductionWorkspace("my ws")
 	require.NoError(t, err)
 
 	copiedChart, err := client.Charts.CopyToWorkspace(chartKey, workspace.Key)
 
 	require.Equal(t, "Sample chart", copiedChart.Name)
 
-	workspaceClient := seatsio.NewSeatsioClient(workspace.SecretKey, test_util.BaseUrl)
+	workspaceClient := seatsio.NewSeatsioClient(test_util.BaseUrl, workspace.SecretKey)
 	retrievedChart, err := workspaceClient.Charts.Retrieve(copiedChart.Key)
 	require.NoError(t, err)
 	require.Equal(t, "Sample chart", retrievedChart.Name)

diff --git a/charts_test/copy_draft_version_test.go b/charts_test/copy_draft_version_test.go
@@ -13,9 +13,9 @@ func TestCopyDraftVersion(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
-	client.Events.Create(&events.CreateEventParams{ChartKey: chartKey})
-	client.Charts.Update(chartKey, &charts.UpdateChartParams{Name: "newname"})
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
+	_, _ = client.Events.Create(&events.CreateEventParams{ChartKey: chartKey})
+	_ = client.Charts.Update(chartKey, &charts.UpdateChartParams{Name: "newname"})
 
 	copiedChart, err := client.Charts.CopyDraftVersion(chartKey)
 	require.NoError(t, err)

diff --git a/charts_test/create_chart_test.go b/charts_test/create_chart_test.go
@@ -1,6 +1,7 @@
 package charts
 
 import (
+	"fmt"
 	"github.com/seatsio/seatsio-go"
 	"github.com/seatsio/seatsio-go/charts"
 	"github.com/seatsio/seatsio-go/events"
@@ -12,7 +13,7 @@ import (
 func TestCreateChartWithDefaultParameters(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chart, err := client.Charts.Create(&charts.CreateChartParams{})
 
@@ -34,7 +35,7 @@ func TestCreateChartWithDefaultParameters(t *testing.T) {
 func TestCreateChartWithName(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chart, err := client.Charts.Create(&charts.CreateChartParams{Name: "aChart"})
 
@@ -48,7 +49,7 @@ func TestCreateChartWithName(t *testing.T) {
 func TestCreateChartWithVenueType(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chart, err := client.Charts.Create(&charts.CreateChartParams{VenueType: "BOOTHS"})
 
@@ -62,7 +63,7 @@ func TestCreateChartWithVenueType(t *testing.T) {
 func TestCreateChartWithCategories(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	category1 := events.Category{Key: events.CategoryKey{Key: 1}, Label: "Category 1", Color: "#aaaaaa"}
 	category2 := events.Category{Key: events.CategoryKey{Key: "anotherCat"}, Label: "Category 2", Color: "#bbbbbb", Accessible: true}
@@ -81,15 +82,15 @@ func TestCreateChartWithCategories(t *testing.T) {
 		map[string]interface{}{"key": "anotherCat", "label": "Category 2", "color": "#bbbbbb", "accessible": true})
 }
 
-func TestCreateChartInSpecificWorkspace(t *testing.T) {
+func TestCreateChartInSpecificWorkspaceAsCompanyAdmin(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	defaultClient := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	defaultClient := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	workspace, err := defaultClient.Workspaces.CreateTestWorkspace("anotherWorkspace")
 	require.NoError(t, err)
 
-	workspaceClient := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl, seatsio.ClientSupport.WorkspaceKey(workspace.Key))
+	workspaceClient := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey, seatsio.ClientSupport.WorkspaceKey(workspace.Key))
 	chart, err := workspaceClient.Charts.Create(&charts.CreateChartParams{})
 	require.NoError(t, err)
 
@@ -101,5 +102,34 @@ func TestCreateChartInSpecificWorkspace(t *testing.T) {
 	require.NoError(t, err)
 	require.Len(t, workspaceCharts, 1)
 	require.Equal(t, chart.Key, workspaceCharts[0].Key)
+}
+
+func TestCreateChartInSpecificWorkspaceAsWorkspaceAdmin(t *testing.T) {
+	t.Parallel()
+	company := test_util.CreateTestCompany(t)
+	defaultClient := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
+	workspace, err := defaultClient.Workspaces.CreateTestWorkspace("anotherWorkspace")
+	require.NoError(t, err)
+
+	workspaceClient := seatsio.NewSeatsioClient(test_util.BaseUrl, workspace.SecretKey)
+	chart, err := workspaceClient.Charts.Create(&charts.CreateChartParams{})
+	require.NoError(t, err)
+
+	retrievedDefaultWorkspaceCharts, err := defaultClient.Charts.ListAll()
+	require.NoError(t, err)
+	require.Len(t, retrievedDefaultWorkspaceCharts, 0)
+
+	workspaceCharts, err := workspaceClient.Charts.ListAll()
+	require.NoError(t, err)
+	require.Len(t, workspaceCharts, 1)
+	require.Equal(t, chart.Key, workspaceCharts[0].Key)
+}
+
+func TestCreateChartAndEvent(t *testing.T) {
+	company := test_util.CreateTestCompany(t)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
+	chart, _ := client.Charts.Create(&charts.CreateChartParams{Name: "aChart"})
+	event, _ := client.Events.Create(&events.CreateEventParams{ChartKey: chart.Key})
+	fmt.Printf(`Created a chart with key %s and an event with key: %s`, chart.Key, event.Key)
 }
diff --git a/charts_test/discard_draft_version_test.go b/charts_test/discard_draft_version_test.go
@@ -13,9 +13,9 @@ func TestDiscardDraftVersion(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
-	client.Events.Create(&events.CreateEventParams{ChartKey: chartKey})
-	client.Charts.Update(chartKey, &charts.UpdateChartParams{Name: "newname"})
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
+	_, _ = client.Events.Create(&events.CreateEventParams{ChartKey: chartKey})
+	_ = client.Charts.Update(chartKey, &charts.UpdateChartParams{Name: "newname"})
 
 	err := client.Charts.DiscardDraftVersion(chartKey)
 	require.NoError(t, err)

diff --git a/charts_test/list_all_tags_test.go b/charts_test/list_all_tags_test.go
@@ -10,14 +10,14 @@ import (
 func TestListAllTags(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client.Charts.AddTag(chartKey1, "tag1")
-	client.Charts.AddTag(chartKey1, "tag2")
+	_ = client.Charts.AddTag(chartKey1, "tag1")
+	_ = client.Charts.AddTag(chartKey1, "tag2")
 
 	chartKey2 := test_util.CreateTestChart(t, company.Admin.SecretKey)
-	client.Charts.AddTag(chartKey2, "tag3")
+	_ = client.Charts.AddTag(chartKey2, "tag3")
 
 	list, err := client.Charts.ListAllTags()
 	require.NoError(t, err)

diff --git a/charts_test/list_charts_in_archive_test.go b/charts_test/list_charts_in_archive_test.go
@@ -10,7 +10,7 @@ import (
 func TestListChartsInArchive(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	chartKey2 := test_util.CreateTestChart(t, company.Admin.SecretKey)

diff --git a/charts_test/list_charts_test.go b/charts_test/list_charts_test.go
@@ -14,7 +14,7 @@ var sup = charts.ChartSupport
 func TestListAll(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	chartKey2 := test_util.CreateTestChart(t, company.Admin.SecretKey)
@@ -31,7 +31,7 @@ func TestListAll(t *testing.T) {
 func TestFilter(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	chartKey2 := test_util.CreateTestChart(t, company.Admin.SecretKey)
@@ -52,7 +52,7 @@ func TestFilter(t *testing.T) {
 func TestTag(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	chartKey2 := test_util.CreateTestChart(t, company.Admin.SecretKey)
@@ -72,7 +72,7 @@ func TestTag(t *testing.T) {
 func TestTagAndFilter(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	_ = client.Charts.Update(chartKey1, &charts.UpdateChartParams{Name: "bar"})
@@ -99,7 +99,7 @@ func TestTagAndFilter(t *testing.T) {
 func TestExpand(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	event1, err := client.Events.Create(&events.CreateEventParams{ChartKey: chartKey})
@@ -115,7 +115,7 @@ func TestExpand(t *testing.T) {
 func TestPageSize(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	_ = test_util.CreateTestChart(t, company.Admin.SecretKey)
 	_ = test_util.CreateTestChart(t, company.Admin.SecretKey)
@@ -124,13 +124,12 @@ func TestPageSize(t *testing.T) {
 	chartsPage, err := client.Charts.ListFirstPage()
 	require.NoError(t, err)
 	require.Equal(t, 3, len(chartsPage.Items))
-
 }
 
 func TestListChartsWithValidation(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	test_util.CreateTestChartWithErrors(t, company.Admin.SecretKey)
 
@@ -145,10 +144,10 @@ func TestListChartsWithValidation(t *testing.T) {
 func TestListChartsWithoutValidation(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 	test_util.CreateTestChartWithErrors(t, company.Admin.SecretKey)
 
-	chartsPage, err := client.Charts.ListFirstPage(sup.WithValidation(true))
+	chartsPage, err := client.Charts.ListFirstPage(sup.WithValidation(false))
 	require.NoError(t, err)
 	retrievedCharts := chartsPage.Items
 	require.Equal(t, 1, len(retrievedCharts))

diff --git a/charts_test/manage_categories_test.go b/charts_test/manage_categories_test.go
@@ -1,6 +1,7 @@
 package charts
 
 import (
+	"fmt"
 	"github.com/seatsio/seatsio-go"
 	"github.com/seatsio/seatsio-go/charts"
 	"github.com/seatsio/seatsio-go/events"
@@ -12,7 +13,7 @@ import (
 func TestAddCategory(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	chartKey1 := test_util.CreateTestChart(t, company.Admin.SecretKey)
 
@@ -30,7 +31,7 @@ func TestAddCategory(t *testing.T) {
 func TestRemoveCategory(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	category1 := events.Category{Key: events.CategoryKey{Key: 1}, Label: "Category 1", Color: "#aaaaaa"}
 	category2 := events.Category{Key: events.CategoryKey{Key: "anotherCat"}, Label: "Category 2", Color: "#bbbbbb", Accessible: true}
@@ -50,23 +51,26 @@ func TestRemoveCategory(t *testing.T) {
 func TestListCategories(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	category1 := events.Category{Key: events.CategoryKey{Key: 1}, Label: "Category 1", Color: "#aaaaaa"}
 	category2 := events.Category{Key: events.CategoryKey{Key: "anotherCat"}, Label: "Category 2", Color: "#bbbbbb", Accessible: true}
 	chart, err := client.Charts.Create(&charts.CreateChartParams{Categories: []events.Category{category1, category2}})
 
 	categories, err := client.Charts.ListCategories(chart.Key)
 	require.NoError(t, err)
-	require.Contains(t, categories.Categories, category1)
-	require.Contains(t, categories.Categories, category2)
-	require.Equal(t, 2, len(categories.Categories))
+	require.Contains(t, categories, category1)
+	require.Contains(t, categories, category2)
+	require.Equal(t, 2, len(categories))
+	for _, category := range categories {
+		fmt.Println(category.Label)
+	}
 }
 
 func TestListCategories_unknownChart(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 
 	_, err := client.Charts.ListCategories("someUnknownChart")
 	require.Error(t, err)

diff --git a/charts_test/move_chart_out_of_archive_test.go b/charts_test/move_chart_out_of_archive_test.go
@@ -10,7 +10,7 @@ import (
 func TestMoveOutOfArchive(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
 	_ = client.Charts.MoveToArchive(chartKey)
 

diff --git a/charts_test/move_chart_to_archive_test.go b/charts_test/move_chart_to_archive_test.go
@@ -10,7 +10,7 @@ import (
 func TestMoveToArchive(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 	chartKey := test_util.CreateTestChart(t, company.Admin.SecretKey)
 
 	err := client.Charts.MoveToArchive(chartKey)

diff --git a/charts_test/publish_draft_version_test.go b/charts_test/publish_draft_version_test.go
@@ -12,10 +12,10 @@ import (
 func TestPublishDraftVersion(t *testing.T) {
 	t.Parallel()
 	company := test_util.CreateTestCompany(t)
-	client := seatsio.NewSeatsioClient(company.Admin.SecretKey, test_util.BaseUrl)
+	client := seatsio.NewSeatsioClient(test_util.BaseUrl, company.Admin.SecretKey)
 	chart, err := client.Charts.Create(&charts.CreateChartParams{Name: "oldname"})
-	client.Events.Create(&events.CreateEventParams{ChartKey: chart.Key})
-	client.Charts.Update(chart.Key, &charts.UpdateChartParams{Name: "newname"})
+	_, _ = client.Events.Create(&events.CreateEventParams{ChartKey: chart.Key})
+	_ = client.Charts.Update(chart.Key, &charts.UpdateChartParams{Name: "newname"})
 
 	err = client.Charts.PublishDraftVersion(chart.Key)