forked from Henry-Sarabia/igdb
-
Notifications
You must be signed in to change notification settings - Fork 0
/
gameversionfeature.go
130 lines (105 loc) · 4.15 KB
/
gameversionfeature.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
package igdb
import (
"encoding/json"
"github.com/Henry-Sarabia/sliceconv"
"github.com/pkg/errors"
"strconv"
)
//go:generate gomodifytags -file $GOFILE -struct GameVersionFeature -add-tags json -w
// GameVersionFeature represents features and descriptions of what makes
// each version/edition different from their main game.
// For more information visit: https://api-docs.igdb.com/#game-version-feature
type GameVersionFeature struct {
ID int `json:"id"`
Category VersionFeatureCategory `json:"category"`
Description string `json:"description"`
Position int `json:"position"`
Title string `json:"title"`
Values []GameVersionFeatureValueWrapper `json:"values"`
}
//go:generate stringer -type=VersionFeatureCategory
// VersionFeatureCategory specifies the type of feature for a particular game.
type VersionFeatureCategory int
// Expected VersionFeatureCategory enums from the IGDB.
const (
VersionFeatureBoolean VersionFeatureCategory = iota
VersionFeatureDescription
)
// GameVersionFeatureService handles all the API calls for the IGDB GameVersionFeature endpoint.
type GameVersionFeatureService service
// Get returns a single GameVersionFeature identified by the provided IGDB ID. Provide
// the SetFields functional option if you need to specify which fields to
// retrieve. If the ID does not match any GameVersionFeatures, an error is returned.
func (gs *GameVersionFeatureService) Get(id int, opts ...Option) (*GameVersionFeature, error) {
if id < 0 {
return nil, ErrNegativeID
}
var ft []*GameVersionFeature
opts = append(opts, SetFilter("id", OpEquals, strconv.Itoa(id)))
err := gs.client.post(gs.end, &ft, opts...)
if err != nil {
return nil, errors.Wrapf(err, "cannot get GameVersionFeature with ID %v", id)
}
return ft[0], nil
}
// List returns a list of GameVersionFeatures identified by the provided list of IGDB IDs.
// Provide functional options to sort, filter, and paginate the results.
// Any ID that does not match a GameVersionFeature is ignored. If none of the IDs
// match a GameVersionFeature, an error is returned.
func (gs *GameVersionFeatureService) List(ids []int, opts ...Option) ([]*GameVersionFeature, error) {
for len(ids) < 1 {
return nil, ErrEmptyIDs
}
for _, id := range ids {
if id < 0 {
return nil, ErrNegativeID
}
}
var ft []*GameVersionFeature
opts = append(opts, SetFilter("id", OpContainsAtLeast, sliceconv.Itoa(ids)...))
err := gs.client.post(gs.end, &ft, opts...)
if err != nil {
return nil, errors.Wrapf(err, "cannot get GameVersionFeatures with IDs %v", ids)
}
return ft, nil
}
// Index returns an index of GameVersionFeatures based solely on the provided functional
// options used to sort, filter, and paginate the results. If no GameVersionFeatures can
// be found using the provided options, an error is returned.
func (gs *GameVersionFeatureService) Index(opts ...Option) ([]*GameVersionFeature, error) {
var ft []*GameVersionFeature
err := gs.client.post(gs.end, &ft, opts...)
if err != nil {
return nil, errors.Wrap(err, "cannot get index of GameVersionFeatures")
}
return ft, nil
}
// Count returns the number of GameVersionFeatures available in the IGDB.
// Provide the SetFilter functional option if you need to filter
// which GameVersionFeatures to count.
func (gs *GameVersionFeatureService) Count(opts ...Option) (int, error) {
ct, err := gs.client.getCount(gs.end, opts...)
if err != nil {
return 0, errors.Wrap(err, "cannot count GameVersionFeatures")
}
return ct, nil
}
// Fields returns the up-to-date list of fields in an
// IGDB GameVersionFeature object.
func (gs *GameVersionFeatureService) Fields() ([]string, error) {
f, err := gs.client.getFields(gs.end)
if err != nil {
return nil, errors.Wrap(err, "cannot get GameVersionFeature fields")
}
return f, nil
}
type GameVersionFeatureWrapper struct {
GameVersionFeature
}
func (feat *GameVersionFeatureWrapper) UnmarshalJSON(data []byte) error {
if id, err := strconv.Atoi(string(data)); err == nil {
feat.ID = id
return nil
}
return json.Unmarshal(data, &feat.GameVersionFeature)
}