apis

Documentation

Index

• type DeviceAPI
  • func (d *DeviceAPI) HandleGetDevices(w http.ResponseWriter, r *http.Request)
  • func (d *DeviceAPI) HandleUpdateDevice(w http.ResponseWriter, r *http.Request)
• type DeviceDataRequest
• type EpisodeAPI
  • func (e *EpisodeAPI) HandleEpisodeAction(w http.ResponseWriter, r *http.Request)
  • func (e *EpisodeAPI) HandleUploadEpisodeAction(w http.ResponseWriter, r *http.Request)
• type EpisodeActionOutput
• type Pair
  • func (p Pair) String() string
• type PairArray
  • func (p PairArray) String() string
• type SubscriptionAPI
  • func (s *SubscriptionAPI) HandleDeviceSubscriptionChange(w http.ResponseWriter, r *http.Request)
  • func (s *SubscriptionAPI) HandleGetDeviceSubscription(w http.ResponseWriter, r *http.Request)
  • func (s *SubscriptionAPI) HandleGetDeviceSubscriptionChange(w http.ResponseWriter, r *http.Request)
  • func (s *SubscriptionAPI) HandleGetSubscription(w http.ResponseWriter, r *http.Request)
  • func (s *SubscriptionAPI) HandleUploadDeviceSubscription(w http.ResponseWriter, r *http.Request)
  • func (s *SubscriptionAPI) HandleUploadDeviceSubscriptionChange(w http.ResponseWriter, r *http.Request)
• type SubscriptionChangeOutput
• type SubscriptionChanges
• type SyncAPI
  • func NewSyncAPI(data data.DataInterface, verifierSecretKey string) *SyncAPI
  • func (s *SyncAPI) HandleGetSync(w http.ResponseWriter, r *http.Request)
  • func (s *SyncAPI) HandlePostSync(w http.ResponseWriter, r *http.Request)
• type SyncDeviceRequest
• type SyncDeviceStatus
• type UserAPI
  • func NewUserAPI(data data.DataInterface, verifierSecretKey string) *UserAPI
  • func (u *UserAPI) HandleLogin(w http.ResponseWriter, r *http.Request)
  • func (u *UserAPI) HandleUserCreate(w http.ResponseWriter, r *http.Request)

Types

type DeviceAPI

type DeviceAPI struct {
	Store store.Store
	Data  data.DataInterface
}

func (*DeviceAPI) HandleGetDevices

func (d *DeviceAPI) HandleGetDevices(w http.ResponseWriter, r *http.Request)

func (*DeviceAPI) HandleUpdateDevice

func (d *DeviceAPI) HandleUpdateDevice(w http.ResponseWriter, r *http.Request)

DeviceAPI

type DeviceDataRequest

type DeviceDataRequest struct {
	Caption string `json:"caption"`
	Type    string `json:"type"`
}

type EpisodeAPI

type EpisodeAPI struct {
	Store store.Store
	Data  data.DataInterface
}

func (*EpisodeAPI) HandleEpisodeAction

func (e *EpisodeAPI) HandleEpisodeAction(w http.ResponseWriter, r *http.Request)

func (*EpisodeAPI) HandleUploadEpisodeAction

func (e *EpisodeAPI) HandleUploadEpisodeAction(w http.ResponseWriter, r *http.Request)

POST /api/2/episodes/{username}.json

type EpisodeActionOutput

type EpisodeActionOutput struct {
	Actions   []data.EpisodeAction `json:"actions"`
	Timestamp *timestamp.Timestamp `json:"timestamp"`
}

type Pair

type Pair struct {
	// contains filtered or unexported fields
}

func (Pair) String

func (p Pair) String() string

type PairArray

type PairArray struct {
	Pairs []Pair
}

func (PairArray) String

func (p PairArray) String() string

type SubscriptionAPI

type SubscriptionAPI struct {
	Store store.Store
	Data  data.DataInterface
}

func (*SubscriptionAPI) HandleDeviceSubscriptionChange

func (s *SubscriptionAPI) HandleDeviceSubscriptionChange(w http.ResponseWriter, r *http.Request)

TODO: Handle Device Subscription Change

func (*SubscriptionAPI) HandleGetDeviceSubscription

func (s *SubscriptionAPI) HandleGetDeviceSubscription(w http.ResponseWriter, r *http.Request)

func (*SubscriptionAPI) HandleGetDeviceSubscriptionChange

func (s *SubscriptionAPI) HandleGetDeviceSubscriptionChange(w http.ResponseWriter, r *http.Request)

API Endpoint: GET /api/2/subscriptions/{username}/{deviceid}.json

func (*SubscriptionAPI) HandleGetSubscription

func (s *SubscriptionAPI) HandleGetSubscription(w http.ResponseWriter, r *http.Request)

func (*SubscriptionAPI) HandleUploadDeviceSubscription

func (s *SubscriptionAPI) HandleUploadDeviceSubscription(w http.ResponseWriter, r *http.Request)

API Endpoint: POST and PUT /subscriptions/{username}/{deviceid}.{format}

func (*SubscriptionAPI) HandleUploadDeviceSubscriptionChange

func (s *SubscriptionAPI) HandleUploadDeviceSubscriptionChange(w http.ResponseWriter, r *http.Request)

API Endpoint: POST /api/2/subscriptions/{username}/{deviceid}.{format}

type SubscriptionChangeOutput

type SubscriptionChangeOutput struct {
	Timestamp  *timestamp.Timestamp `json:"timestamp"`
	UpdateUrls json.RawMessage      `json:"update_urls"`
}

type SubscriptionChanges

type SubscriptionChanges struct {
	Add       []string             `json:"add"`
	Remove    []string             `json:"remove"`
	Timestamp *timestamp.Timestamp `json:"timestamp"`
}

type SyncAPI

type SyncAPI struct {
	Data data.DataInterface
	// contains filtered or unexported fields
}

func NewSyncAPI

func NewSyncAPI(data data.DataInterface, verifierSecretKey string) *SyncAPI

func (*SyncAPI) HandleGetSync

func (s *SyncAPI) HandleGetSync(w http.ResponseWriter, r *http.Request)

GET /api/2/sync-devices/{username}.json

func (*SyncAPI) HandlePostSync

func (s *SyncAPI) HandlePostSync(w http.ResponseWriter, r *http.Request)

POST /api/2/sync-devices/{username}.json This endpoints takes in a SyncDeviceRequest to link up devices together

type SyncDeviceRequest

type SyncDeviceRequest struct {
	Synchronize     [][]string `json:"synchronize"`
	StopSynchronize []string   `json:"stop-synchronize"`
}

type SyncDeviceStatus

type SyncDeviceStatus struct {
	Synchronized   [][]string `json:"synchronized"`
	NotSynchronize []string   `json:"not-synchronize"`
}

type UserAPI

type UserAPI struct {
	Data data.DataInterface
	// contains filtered or unexported fields
}

func NewUserAPI

func NewUserAPI(data data.DataInterface, verifierSecretKey string) *UserAPI

func (*UserAPI) HandleLogin

func (u *UserAPI) HandleLogin(w http.ResponseWriter, r *http.Request)

HandleLogin uses Basic Auth to check on a user's credentials and return a cookie session that will be used for subsequent calls

func (*UserAPI) HandleUserCreate

func (u *UserAPI) HandleUserCreate(w http.ResponseWriter, r *http.Request)

HandleUserCreate takes in a username and password AND must only be able to be run on the same instance as the API Server