Merge pull request #1 from cpanato/fix-lints

Fix lints

Author: cpanato

.golangci.yml

@@ -0,0 +1,38 @@
+---
+version: "2"
+run:
+  issues-exit-code: 1
+  timeout: 5m
+linters:
+  enable:
+    - asciicheck
+    - errorlint
+    - forbidigo
+    - gocritic
+    - gosec
+    - importas
+    - makezero
+    - misspell
+    - nilnesserr
+    - prealloc
+    - revive
+    - tparallel
+    - unconvert
+    - unparam
+    - usestdlibvars
+    - whitespace
+
+issues:
+  max-issues-per-linter: 0
+  max-same-issues: 0
+  uniq-by-line: false
+formatters:
+  enable:
+    - gofmt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

incidentio/actions.go

@@ -5,6 +5,7 @@ type ActionsService struct {
 	client *Client
 }
 
+// Action represents an action in Incident.io.
 type Action struct {
 	ID          string     `json:"id"`
 	IncidentID  string     `json:"incident_id"`

incidentio/custom_fields.go

@@ -10,6 +10,7 @@ type CustomFieldsService struct {
 	client *Client
 }
 
+// CustomField represents a custom field in Incident.io.
 type CustomField struct {
 	ID          string `json:"id"`
 	Name        string `json:"name"`

incidentio/doc.go

@@ -0,0 +1,2 @@
+// Package incidentio provides a client for the Incident.io API.
+package incidentio

incidentio/incident_roles.go

@@ -5,6 +5,7 @@ import (
 	"net/http"
 )
 
+// CreateRoleAssignment represents the payload for creating a role assignment in an incident.
 type CreateRoleAssignment struct {
 	IncidentRoleID string `json:"incident_role_id"`
 	UserID         string `json:"user_id"`
@@ -16,6 +17,7 @@ type IncidentRoleAssignment struct {
 	Assignee *User         `json:"assignee"`
 }
 
+// Severity represents the severity of an incident.
 type Severity struct {
 	ID          string    `json:"id"`
 	Name        string    `json:"name"`
@@ -25,6 +27,7 @@ type Severity struct {
 	UpdatedAt   Timestamp `json:"updated_at"`
 }
 
+// IncidentRole represents a role that can be assigned to users in an incident.
 type IncidentRole struct {
 	ID          string    `json:"id"`
 	Name        string    `json:"name"`

incidentio/incident_type.go

@@ -10,6 +10,7 @@ type IncidentTypesService struct {
 	client *Client
 }
 
+// IncidentType represents an incident type in Incident.io.
 type IncidentType struct {
 	ID          string    `json:"id"`
 	Name        string    `json:"name"`

incidentio/incidentio.go

@@ -126,7 +126,7 @@ func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*htt
 	if err != nil {
 		return nil, err
 	}
-	defer resp.Body.Close()
+	defer resp.Body.Close() //nolint: errcheck
 
 	err = CheckResponse(resp)
 	if err != nil {
@@ -135,7 +135,7 @@ func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*htt
 
 	if v != nil && resp.StatusCode != http.StatusNoContent {
 		if w, ok := v.(io.Writer); ok {
-			io.Copy(w, resp.Body)
+			_, _ = io.Copy(w, resp.Body)
 		} else {
 			err = json.NewDecoder(resp.Body).Decode(v)
 		}
@@ -153,7 +153,7 @@ func CheckResponse(r *http.Response) error {
 	errorResponse := &ErrorResponse{Response: r}
 	data, err := io.ReadAll(r.Body)
 	if err == nil && data != nil {
-		json.Unmarshal(data, errorResponse)
+		_ = json.Unmarshal(data, errorResponse)
 	}
 
 	return errorResponse
@@ -186,17 +186,18 @@ type ListOptions struct {
 	After    string `url:"after,omitempty"`
 }
 
-// Common types used across the API
-
+// ExternalResource represents a common type used across the API
 type ExternalResource struct {
 	ExternalID  string `json:"external_id"`
 	DisplayName string `json:"display_name"`
 }
 
+// Timestamp is a wrapper around time.Time to handle JSON serialization
 type Timestamp struct {
 	time.Time
 }
 
+// UnmarshalJSON parses a JSON string
 func (t *Timestamp) UnmarshalJSON(data []byte) error {
 	var s string
 	if err := json.Unmarshal(data, &s); err != nil {
@@ -210,6 +211,7 @@ func (t *Timestamp) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+// MarshalJSON formats the Timestamp as a JSON string in RFC3339 format.
 func (t Timestamp) MarshalJSON() ([]byte, error) {
-	return json.Marshal(t.Time.Format(time.RFC3339))
+	return json.Marshal(t.Format(time.RFC3339))
 }

incidentio/incidents.go

@@ -51,7 +51,7 @@ type CreateIncidentOptions struct {
 }
 
 // List returns a list of incidents.
-func (s *IncidentsService) List(ctx context.Context, opts *ListOptions) ([]*Incident, *http.Response, error) {
+func (s *IncidentsService) List(ctx context.Context, _ *ListOptions) ([]*Incident, *http.Response, error) {
 	u := "v2/incidents"
 
 	req, err := s.client.NewRequest("GET", u, nil)

incidentio/incidents_test.go

@@ -3,6 +3,7 @@ package incidentio
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"net/http"
 	"net/http/httptest"
@@ -14,7 +15,7 @@ import (
 
 // Test helpers
 
-func setup() (client *Client, mux *http.ServeMux, serverURL string, teardown func()) {
+func setup() (client *Client, mux *http.ServeMux, serverURL string, teardown func()) { //nolint: unparam
 	mux = http.NewServeMux()
 	server := httptest.NewServer(mux)
 
@@ -76,7 +77,7 @@ func TestIncidentsService_List(t *testing.T) {
 			]
 		}`
 
-		fmt.Fprint(w, response)
+		_, _ = fmt.Fprint(w, response)
 	})
 
 	ctx := context.Background()
@@ -144,7 +145,7 @@ func TestIncidentsService_Get(t *testing.T) {
 			}
 		}`
 
-		fmt.Fprint(w, response)
+		_, _ = fmt.Fprint(w, response)
 	})
 
 	ctx := context.Background()
@@ -251,7 +252,7 @@ func TestIncidentsService_Create(t *testing.T) {
 		}`
 
 		w.WriteHeader(http.StatusCreated)
-		fmt.Fprint(w, response)
+		_, _ = fmt.Fprint(w, response)
 	})
 
 	ctx := context.Background()
@@ -315,7 +316,7 @@ func TestIncidentsService_Update(t *testing.T) {
 			}
 		}`
 
-		fmt.Fprint(w, response)
+		_, _ = fmt.Fprint(w, response)
 	})
 
 	ctx := context.Background()
@@ -363,7 +364,7 @@ func TestIncidentsService_ErrorHandling(t *testing.T) {
 	client, mux, _, teardown := setup()
 	defer teardown()
 
-	mux.HandleFunc("/v2/incidents/not-found", func(w http.ResponseWriter, r *http.Request) {
+	mux.HandleFunc("/v2/incidents/not-found", func(w http.ResponseWriter, _ *http.Request) {
 		w.WriteHeader(http.StatusNotFound)
 		response := `{
 			"type": "validation_error",
@@ -379,7 +380,7 @@ func TestIncidentsService_ErrorHandling(t *testing.T) {
 				}
 			]
 		}`
-		fmt.Fprint(w, response)
+		_, _ = fmt.Fprint(w, response)
 	})
 
 	ctx := context.Background()
@@ -389,7 +390,8 @@ func TestIncidentsService_ErrorHandling(t *testing.T) {
 		t.Error("Expected error, got nil")
 	}
 
-	errResp, ok := err.(*ErrorResponse)
+	errResp := &ErrorResponse{}
+	ok := errors.As(err, &errResp)
 	if !ok {
 		t.Errorf("Error type = %T, want *ErrorResponse", err)
 	}
@@ -467,18 +469,18 @@ func TestTimestamp_UnmarshalJSON(t *testing.T) {
 				t.Errorf("Timestamp.UnmarshalJSON() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if !tt.wantErr && !ts.Time.Equal(tt.want) {
+			if !tt.wantErr && !ts.Equal(tt.want) {
 				t.Errorf("Timestamp.UnmarshalJSON() = %v, want %v", ts.Time, tt.want)
 			}
 		})
 	}
 }
 
 func TestErrorResponse_Error(t *testing.T) {
-	req, _ := http.NewRequest("GET", "https://api.incident.io/v2/incidents/123", nil)
+	req, _ := http.NewRequest(http.MethodGet, "https://api.incident.io/v2/incidents/123", nil)
 	resp := &http.Response{
 		Request:    req,
-		StatusCode: 404,
+		StatusCode: http.StatusNotFound,
 	}
 
 	err := &ErrorResponse{

incidentio/schedules.go

@@ -171,7 +171,7 @@ type UpdateOverrideOptions struct {
 }
 
 // List returns a list of schedules.
-func (s *SchedulesService) List(ctx context.Context, opts *ScheduleListOptions) ([]*Schedule, *http.Response, error) {
+func (s *SchedulesService) List(ctx context.Context, _ *ScheduleListOptions) ([]*Schedule, *http.Response, error) {
 	u := "v2/schedules"
 
 	req, err := s.client.NewRequest("GET", u, nil)
@@ -291,7 +291,7 @@ func (s *SchedulesService) ListEntries(ctx context.Context, scheduleID string, o
 }
 
 // ListOverrides returns overrides for a schedule.
-func (s *SchedulesService) ListOverrides(ctx context.Context, scheduleID string, opts *ListOptions) ([]*Override, *http.Response, error) {
+func (s *SchedulesService) ListOverrides(ctx context.Context, scheduleID string, _ *ListOptions) ([]*Override, *http.Response, error) {
 	u := fmt.Sprintf("v2/schedules/%s/overrides", scheduleID)
 
 	req, err := s.client.NewRequest("GET", u, nil)
@@ -381,70 +381,3 @@ func (s *SchedulesService) DeleteOverride(ctx context.Context, scheduleID, overr
 
 	return s.client.Do(ctx, req, nil)
 }
-
-// ExampleCreateSchedule shows how to create a new schedule
-func ExampleCreateSchedule(client *Client) {
-	ctx := context.Background()
-
-	// Define the schedule configuration
-	config := &ScheduleConfig{
-		Rotations: []RotationConfig{
-			{
-				ID:   "weekly-rotation",
-				Name: "Weekly Rotation",
-				Layers: []LayerConfig{
-					{
-						ID:   "layer-1",
-						Name: "Primary On-Call",
-						Users: []LayerUser{
-							{UserID: "01FCNDV6P870EA6S7TK1DSYDG0"},
-							{UserID: "01FCQSP07Z74QMMYPDDGQB9FTG"},
-						},
-					},
-				},
-				HandoverStartAt: Timestamp{time.Now()},
-				HandoversAt:     Timestamp{time.Now().Add(7 * 24 * time.Hour)},
-			},
-		},
-	}
-
-	opts := &CreateScheduleOptions{
-		Name:     "Engineering On-Call",
-		Timezone: "America/New_York",
-		Config:   config,
-	}
-
-	schedule, _, err := client.Schedules.Create(ctx, opts)
-	if err != nil {
-		fmt.Printf("Error creating schedule: %v\n", err)
-		return
-	}
-
-	fmt.Printf("Created schedule: %s\n", schedule.ID)
-}
-
-// ExampleListScheduleEntries shows how to list schedule entries for a time window
-func ExampleListScheduleEntries(client *Client) {
-	ctx := context.Background()
-
-	// Get entries for the next 7 days
-	opts := &ScheduleEntriesOptions{
-		EntryWindow: &TimeWindow{
-			StartAt: time.Now(),
-			EndAt:   time.Now().Add(7 * 24 * time.Hour),
-		},
-	}
-
-	entries, _, err := client.Schedules.ListEntries(ctx, "schedule-id", opts)
-	if err != nil {
-		fmt.Printf("Error listing entries: %v\n", err)
-		return
-	}
-
-	for _, entry := range entries {
-		fmt.Printf("User %s is on-call from %s to %s\n",
-			entry.UserID,
-			entry.Interval.StartAt.Format(time.RFC3339),
-			entry.Interval.EndAt.Format(time.RFC3339))
-	}
-}