Extract core SDK

[dydx]

Right now the usage of the Vicohome API is really baked into the Cobra framework. I'd like to abstract this usage into an sdk in the pkg folder like we do with auth.

[dydx]

SDK Extraction Plan

Based on an analysis of the current codebase, here's a proposed plan for extracting the Vicohome API interaction logic into a dedicated SDK:

1. Create SDK Package Structure

pkg/
  ├── auth/       (existing)
  ├── cache/      (existing)
  └── sdk/
      ├── client.go     (main client with common HTTP handling)
      ├── devices.go    (device-specific API operations)
      ├── events.go     (event-specific API operations)
      ├── models.go     (shared data structures)
      └── errors.go     (API error handling)

2. Core Components

Client Interface

• Create a Client struct that handles authentication, request creation, and error handling
• Move HTTP request/response boilerplate out of command files
• Implement automatic token refresh using the existing auth package

// client.go
type Client struct {
    BaseURL    string
    httpClient *http.Client
    Language   string
    CountryNo  string
}

func NewClient() (*Client, error) {
    // Initialize with defaults and auth
}

func (c *Client) SendRequest(method, path string, requestBody interface{}) ([]byte, error) {
    // Common request handling with auth.ExecuteWithRetry
}

Model Definitions

• Move model structs (Device, Event, etc.) to models.go
• Make models reusable across different commands
• Add proper JSON serialization/deserialization

Consistent Error Handling

• Create dedicated error types for API errors
• Implement proper error wrapping
• Add contextual information to errors

3. Functional Areas

Devices API

• Extract device listing functionality
• Extract device details retrieval
• Create methods like:
  • ListDevices() ([]Device, error)
  • GetDevice(serialNumber string) (Device, error)

Events API

• Extract event listing functionality
• Extract event retrieval functionality
• Create methods like:
  • ListEvents(startTime, endTime time.Time) ([]Event, error)
  • GetEvent(traceID string) (Event, error)
  • SearchEvents(criteria SearchCriteria) ([]Event, error)

4. CMD Package Refactoring

• Refactor command files to use the SDK
• Command handlers become thin wrappers around SDK calls
• Focus on input parsing, output formatting, and error presentation

5. Testing Strategy

• Add unit tests for each SDK component
• Create mock responses for API testing
• Implement integration tests that can run against a real API

6. Implementation Approach

1. Start by creating the basic client interface
2. Extract models into the SDK package
3. Implement one API endpoint at a time, starting with simplest
4. Refactor corresponding commands to use the SDK
5. Add tests
6. Repeat for each endpoint

Benefits of This Approach

• Separation of concerns: API interaction logic separate from CLI interface
• Code reuse: SDK could be used in other Go projects
• Testability: SDK components easier to test than CLI commands
• Maintainability: Centralized HTTP and error handling

The SDK would follow idiomatic Go patterns and maintain backward compatibility with the existing CLI functionality, while providing a cleaner abstraction for API interactions.