feat: SpaceAPI v15 support
Delete types/v14.go, replace with v15.go.
Rename internal types to not include message version.
I don't currently see the need to support multiple message
versions that have incompatible layouts.
v15 is backwards compatible with v14, so the config example now
specifies both.
Rename the "response" field in the config file to "static" as
dynamic/static makes more sense from the user's perspective.
(Internally it's still SpaceapidConfig.{Dynamic,Response}
to align with type names and usage.)
This commit is contained in:
parent
de506fc8f3
commit
a53a5c3517
10 changed files with 293 additions and 196 deletions
69
types/v14.go
69
types/v14.go
|
|
@ -1,69 +0,0 @@
|
|||
package types
|
||||
|
||||
type SpaceAPIResponseV14 struct {
|
||||
APICompatibility []string `json:"api_compatibility"`
|
||||
Space string `json:"space"`
|
||||
Logo string `json:"logo"`
|
||||
ExtCCC string `json:"ext_ccc"`
|
||||
URL string `json:"url"`
|
||||
Location struct {
|
||||
Address string `json:"address"`
|
||||
Lat float64 `json:"lat"`
|
||||
Lon float64 `json:"lon"`
|
||||
} `json:"location"`
|
||||
State SpaceState `json:"state"`
|
||||
Contact struct {
|
||||
Phone string `json:"phone"`
|
||||
IRC string `json:"irc"`
|
||||
Mastodon string `json:"mastodon"`
|
||||
Email string `json:"email"`
|
||||
ML string `json:"ml"`
|
||||
Matrix string `json:"matrix"`
|
||||
} `json:"contact"`
|
||||
Sensors map[string][]EnvironmentSensor `json:"sensors"`
|
||||
Feeds struct {
|
||||
Blog struct {
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url"`
|
||||
} `json:"blog"`
|
||||
Calendar struct {
|
||||
Type string `json:"type"`
|
||||
URL string `json:"url"`
|
||||
} `json:"calendar"`
|
||||
} `json:"feeds"`
|
||||
Links []struct {
|
||||
Name string `json:"name"`
|
||||
URL string `json:"url"`
|
||||
} `json:"links"`
|
||||
}
|
||||
|
||||
type SpaceState struct {
|
||||
Open bool `json:"open"`
|
||||
LastChange int64 `json:"lastchange"`
|
||||
Message string `json:"message,omitempty"`
|
||||
}
|
||||
|
||||
type EnvironmentSensor struct {
|
||||
Value float64 `json:"value"`
|
||||
Unit string `json:"unit"`
|
||||
Location string `json:"location,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
Description string `json:"description,omitempty"`
|
||||
LastChange int64 `json:"lastchange,omitempty"`
|
||||
}
|
||||
|
||||
type PersistentStateV14 struct {
|
||||
State struct {
|
||||
Open bool `json:"open"`
|
||||
LastChange int64 `json:"lastchange"`
|
||||
Message string `json:"message,omitempty"`
|
||||
} `json:"state"`
|
||||
Sensors map[string][]PersistentEnvironmentSensor `json:"sensors,omitempty"`
|
||||
}
|
||||
|
||||
type PersistentEnvironmentSensor struct {
|
||||
Value float64 `json:"value"`
|
||||
Location string `json:"location,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
LastChange int64 `json:"lastchange"`
|
||||
}
|
||||
164
types/v15.go
Normal file
164
types/v15.go
Normal file
|
|
@ -0,0 +1,164 @@
|
|||
package types
|
||||
|
||||
const CurrentMessageVersion = "15"
|
||||
|
||||
// SpaceAPIResponse represents the contents of the SpaceAPI message
|
||||
//
|
||||
// Currently implemented version: 15
|
||||
type SpaceAPIResponse struct {
|
||||
APICompatibility []string `json:"api_compatibility"` // REQUIRED
|
||||
Space string `json:"space"` // REQUIRED
|
||||
Logo string `json:"logo"` // REQUIRED
|
||||
URL string `json:"url"` // REQUIRED
|
||||
|
||||
// Minimum number of properties: 1
|
||||
Location struct {
|
||||
Address string `json:"address,omitzero"`
|
||||
Lat float64 `json:"lat,omitzero"`
|
||||
Lon float64 `json:"lon,omitzero"`
|
||||
Timezone string `json:"timezone,omitzero"`
|
||||
CountryCode string `json:"country_code,omitzero"`
|
||||
Hint string `json:"hint,omitzero"`
|
||||
// Minimum number of items: 1
|
||||
Areas []SpaceAPILocationAreas `json:"areas,omitempty"`
|
||||
} `json:"location,omitzero"`
|
||||
|
||||
SpaceFed struct {
|
||||
SpaceNet bool `json:"spacenet,omitzero"`
|
||||
SpaceSAML bool `json:"spacesaml,omitzero"`
|
||||
} `json:"spacefed,omitzero"`
|
||||
|
||||
Cam []string `json:"cam,omitempty"`
|
||||
|
||||
State SpaceAPIState `json:"state,omitzero"`
|
||||
|
||||
Events []SpaceAPIEvents `json:"events,omitempty"`
|
||||
|
||||
Contact struct {
|
||||
Phone string `json:"phone,omitzero"`
|
||||
Sip string `json:"sip,omitzero"`
|
||||
// keymasters
|
||||
Keymasters []struct {
|
||||
Name string `json:"name,omitzero"`
|
||||
IRCNick string `json:"irc_nick,omitzero"`
|
||||
Phone string `json:"phone,omitzero"`
|
||||
Email string `json:"email,omitzero"`
|
||||
Twitter string `json:"twitter,omitzero"`
|
||||
Xmpp string `json:"xmpp,omitzero"`
|
||||
Mastodon string `json:"mastodon,omitzero"`
|
||||
Matrix string `json:"matrix,omitzero"`
|
||||
} `json:"keymasters,omitempty"`
|
||||
IRC string `json:"irc,omitzero"`
|
||||
Twitter string `json:"twitter,omitzero"`
|
||||
Mastodon string `json:"mastodon,omitzero"`
|
||||
Facebook string `json:"facebook,omitzero"`
|
||||
Identica string `json:"identica,omitzero"`
|
||||
Foursquare string `json:"foursquare,omitzero"`
|
||||
Email string `json:"email,omitzero"`
|
||||
ML string `json:"ml,omitzero"`
|
||||
XMPP string `json:"xmpp,omitzero"`
|
||||
IssueMail string `json:"issue_mail,omitzero"`
|
||||
Gopher string `json:"gopher,omitzero"`
|
||||
Matrix string `json:"matrix,omitzero"`
|
||||
Mumble string `json:"mumble,omitzero"`
|
||||
} `json:"contact"`
|
||||
|
||||
Sensors map[string][]EnvironmentSensor `json:"sensors,omitempty"`
|
||||
|
||||
Feeds struct {
|
||||
Blog struct {
|
||||
Type string `json:"type,omitzero"`
|
||||
URL string `json:"url"` // REQUIRED
|
||||
} `json:"blog,omitzero"`
|
||||
Wiki struct {
|
||||
Type string `json:"type,omitzero"`
|
||||
URL string `json:"url"` // REQUIRED
|
||||
} `json:"wiki,omitzero"`
|
||||
Calendar struct {
|
||||
Type string `json:"type,omitzero"`
|
||||
URL string `json:"url"` // REQUIRED
|
||||
} `json:"calendar,omitzero"`
|
||||
Flickr struct {
|
||||
Type string `json:"type,omitzero"`
|
||||
URL string `json:"url"` // REQUIRED
|
||||
} `json:"flickr,omitzero"`
|
||||
} `json:"feeds,omitzero"`
|
||||
|
||||
Projects []string `json:"projects,omitempty"`
|
||||
|
||||
Links []struct {
|
||||
Name string `json:"name"` // REQUIRED
|
||||
URL string `json:"url"` // REQUIRED
|
||||
Description string `json:"description,omitzero"`
|
||||
} `json:"links,omitempty"`
|
||||
|
||||
MembershipPlans []struct {
|
||||
Name string `json:"name"` // REQUIRED
|
||||
Value int64 `json:"value"` // REQUIRED
|
||||
Currency string `json:"currency"` // REQUIRED
|
||||
BillingInterval string `json:"billing_interval"` // REQUIRED
|
||||
Description string `json:"description,omitzero"`
|
||||
} `json:"membership_plans,omitempty"`
|
||||
|
||||
LinkedSpaces []struct {
|
||||
Endpoint string `json:"endpoint,omitzero"`
|
||||
Website string `json:"website,omitzero"`
|
||||
} `json:"linked_spaces,omitempty"`
|
||||
|
||||
ExtCCC string `json:"ext_ccc,omitzero"`
|
||||
}
|
||||
|
||||
type SpaceAPILocationAreas struct {
|
||||
Name string `json:"name,omitzero"`
|
||||
Description string `json:"description,omitzero"`
|
||||
SquareMeters float64 `json:"square_meters"` // REQUIRED
|
||||
}
|
||||
|
||||
type SpaceAPIState struct {
|
||||
Open bool `json:"open,omitempty"`
|
||||
LastChange int64 `json:"lastchange,omitempty"`
|
||||
TriggerPerson string `json:"trigger_person,omitempty"`
|
||||
Message string `json:"message,omitempty"`
|
||||
Icon struct {
|
||||
Open string `json:"open,omitempty"` // REQUIRED
|
||||
Closed string `json:"closed,omitempty"` // REQUIRED
|
||||
} `json:"icon,omitzero"`
|
||||
}
|
||||
|
||||
func (s *SpaceAPIState) FromPersistentSpaceState(ps PersistentSpaceState) {
|
||||
s.Open = ps.State.Open
|
||||
s.LastChange = ps.State.LastChange
|
||||
s.Message = ps.State.Message
|
||||
}
|
||||
|
||||
type SpaceAPIEvents struct {
|
||||
Name string `json:"name"` // REQUIRED
|
||||
Type string `json:"type"` // REQUIRED
|
||||
Timestamp int64 `json:"timestamp"` // REQUIRED
|
||||
Extra string `json:"extra,omitzero"`
|
||||
}
|
||||
|
||||
type EnvironmentSensor struct {
|
||||
Value float64 `json:"value"`
|
||||
Unit string `json:"unit"`
|
||||
Location string `json:"location,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
Description string `json:"description,omitempty"`
|
||||
LastChange int64 `json:"lastchange,omitempty"`
|
||||
}
|
||||
|
||||
type PersistentSpaceState struct {
|
||||
State struct {
|
||||
Open bool `json:"open"`
|
||||
LastChange int64 `json:"lastchange"`
|
||||
Message string `json:"message,omitempty"`
|
||||
} `json:"state"`
|
||||
Sensors map[string][]PersistentEnvironmentSensor `json:"sensors,omitempty"`
|
||||
}
|
||||
|
||||
type PersistentEnvironmentSensor struct {
|
||||
Value float64 `json:"value"`
|
||||
Location string `json:"location,omitempty"`
|
||||
Name string `json:"name,omitempty"`
|
||||
LastChange int64 `json:"lastchange"`
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue