Added Background and BackgroundVerticalOffset to Mod. Added more XML comments. Added LICENSE and README files.
[KerbalStuffWrapper.git] / KerbalStuffReadOnly / Mod.cs
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
// KerbalStuffWrapper
//
// Author:
//      toadicus
//
// Copyright © 2014, toadicus
//
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
//      * Redistributions of source code must retain the above copyright notice, this list of conditions and the
//        following disclaimer.
//      * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//        following disclaimer in the documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// This software uses the CLAP .NET Command-Line Parser, Copyright © 2011 Adrian Aisemberg, SharpRegion.
// Used under license.
//
// This software uses the MiniJSON .NET JSON Parser, Copyright © 2013 Calvin Rien.  Used under license.
//
// This software uses the FormUpload multipart/form-data library,
// http://www.briangrinstead.com/blog/multipart-form-post-in-c.
//
// KerbalStuff is copyright © 2014 Drew DeVault.  Used under license.
//
 
using System;
using System.Collections.Generic;
using System.Linq;
 
namespace KerbalStuff
{
        /// <summary>
        /// Class representing a KerbalStuff Mod as presented by the KerbalStuff API.
        /// </summary>
        public class Mod
        {
                /// <summary>
                /// The number of times all versions of this Mod have been downloaded.
                /// </summary>
                public long Downloads
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The name of the Mod.
                /// </summary>
                public string Name
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The number of followers subscribed to this Mod on KerbalStuff.
                /// </summary>
                public long Followers
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The name of the <see cref="KerbalStuff.User"/> that authors this Mod.
                /// </summary>
                public string Author
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The ID of the default <see cref="KerbalStuff.ModVersion"/> of this Mod.
                /// </summary>
                public long DefaultVersionId
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// A read-only list of the available versions of this Mod.
                /// </summary>
                /// <seealso cref="KerbalStuff.ModVersion"/>
                public IList<ModVersion> Versions
                {
                        get
                        {
                                return (versions == null) ? null : versions.AsReadOnly();
                        }
                }
 
                /// <summary>
                /// The Id of this Mod on KerbalStuff.
                /// </summary>
                public long Id
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The URI of the Mod's background image, relative to the mediacru.sh CDN root.
                /// </summary>
                public string Background
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// Gets the vertical offset of the Mod's background image, in pixels.
                /// </summary>
                /// <value>The background vertical offset.</value>
                public long BackgroundVerticalOffset
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// A short (1000 characters or less) description of this Mod.
                /// </summary>
                public string ShortDescription
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The name or title (128 characters or less) of the License under which this Mod is released.
                /// </summary>
                public string License
                {
                        get;
                        private set;
                }
 
                private List<ModVersion> versions;
 
                /// <summary>
                /// Initializes a new instance of the <see cref="KerbalStuff.Mod"/> class from a Dictionary of JSON objects.
                /// </summary>
                /// <param name="jsonDict">Dictionary containing the deserialized JSON response from KerbalStuff.</param>
                public Mod(Dictionary<string, object> jsonDict) : this()
                {
                        this.Downloads = (long)jsonDict["downloads"];
                        this.Name = (string)jsonDict["name"];
                        this.Followers = (long)jsonDict["followers"];
                        this.Author = (string)jsonDict["author"];
                        this.DefaultVersionId = (long)jsonDict["default_version_id"];
                        this.Id = (long)jsonDict["id"];
                        this.ShortDescription = (string)jsonDict["short_description"];
                        this.Background = (string)jsonDict["background"];
                        this.BackgroundVerticalOffset = (long)jsonDict["bg_offset_y"];
 
                        if (jsonDict.ContainsKey("versions"))
                        {
                                foreach (var ver in (jsonDict["versions"] as List<object>))
                                {
                                        if (ver is Dictionary<string, object>)
                                        {
                                                this.versions.Add(new ModVersion(ver as Dictionary<string, object>));
                                        }
                                }
                        }
                }
 
                /// <summary>
                /// Initializes a new instance of the <see cref="KerbalStuff.Mod"/> class from strings describing the Mod.
                /// Useful for creating new Mods for upload.
                /// </summary>
                /// <seealso cref="KerbalStuff.KerbalStuff.Create"/>
                /// <param name="name">The name of the Mod</param>
                /// <param name="shortDescription">A short (1000 characters or less) description of this Mod.</param>
                /// <param name="version">Version.</param>
                /// <param name="kspVersion">Ksp version.</param>
                /// <param name="license">The name or title (128 characters or less) of the License under which this Mod is released.</param>
                public Mod(string name, string shortDescription, string version, string kspVersion, string license) : this()
                {
                        this.Name = name;
                        this.ShortDescription = shortDescription;
                        this.License = license;
 
                        this.versions.Add(new ModVersion(version, kspVersion));
                }
 
                private Mod()
                {
                        this.versions = new List<ModVersion>();
                }
 
                /// <summary>
                /// Returns a <see cref="System.String"/> that represents the current <see cref="KerbalStuff.Mod"/>.
                /// </summary>
                public override string ToString()
                {
                        return string.Format(
                                "Mod: {1}\n" +
                                "id: {6}\n" +
                                "author: {3}\n" +
                                "downloads: {0}\n" +
                                "followers: {2}\n" +
                                "short_description: {7}\n" +
                                "default_version_id: {4}\n" +
                                "versions:\n[\n{5}\n]\n",
                                Downloads,
                                Name,
                                Followers,
                                Author,
                                DefaultVersionId,
                                string.Join("\n", Versions.Select(v => v.ToString()).ToArray()),
                                Id,
                                ShortDescription
                        );
                }
        }
 
        /// <summary>
        /// Class representing a single version of a KerbalStuff Mod as presented by the KerbalStuff API.
        /// </summary>
        public class ModVersion
        {
                /// <summary>
                /// An optional log describing the changes made in this ModVersion 
                /// </summary>
                public string ChangeLog
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The primary version of KSP for which this ModVersion was developed.
                /// </summary>
                public string KspVersion
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The path of the download archive for this ModVersion, relative to the KerbalStuff
                /// root.
                /// </summary>
                /// <seealso cref="KerbalStuff.KerbalStuff.RootUri"/>
                public string DownloadPath
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The Id of this ModVersion on KerbalStuff.
                /// </summary>
                public long Id
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// The human-friendly (or not) name or number of this ModVersion.
                /// </summary>
                /// <value>The friendly version.</value>
                public string FriendlyVersion
                {
                        get;
                        private set;
                }
 
                /// <summary>
                /// Initializes a new instance of the <see cref="KerbalStuff.ModVersion"/> class from a Dictionary of JSON
                /// objects.
                /// </summary>
                /// <param name="jsonDict">Dictionary containing the deserialized JSON response from KerbalStuff.</param>
                public ModVersion(Dictionary<string, object> jsonDict) : this()
                {
                        this.ChangeLog = (string)jsonDict["changelog"];
                        this.KspVersion = (string)jsonDict["ksp_version"];
                        this.DownloadPath = (string)jsonDict["download_path"];
                        this.Id = (long)jsonDict["id"];
                        this.FriendlyVersion = (string)jsonDict["friendly_version"];
                }
 
                /// <summary>
                /// Initializes a new instance of the <see cref="KerbalStuff.ModVersion"/> class from strings describing the
                /// Version.
                /// </summary>
                /// <param name="version">The human-friendly (or not) name or number of this ModVersion.</param>
                /// <param name="kspVersion">The primary version of KSP for which this ModVersion was developed.</param>
                /// <param name="changeLog">An optional log describing the changes made in this ModVersion </param>
                public ModVersion(string version, string kspVersion, string changeLog) : this(version, kspVersion)
                {
                        this.ChangeLog = changeLog;
                }
 
                /// <summary>
                /// Initializes a new instance of the <see cref="KerbalStuff.ModVersion"/> class from strings describing the
                /// Version.
                /// </summary>
                /// <param name="version">The human-friendly (or not) name or number of this ModVersion.</param>
                /// <param name="kspVersion">The primary version of KSP for which this ModVersion was developed.</param>
                public ModVersion(string version, string kspVersion) : this()
                {
                        this.FriendlyVersion = version;
                        this.KspVersion = kspVersion;
                }
 
                private ModVersion() {}
 
                /// <summary>
                /// Returns a <see cref="System.String"/> that represents the current <see cref="KerbalStuff.ModVersion"/>.
                /// </summary>
                public override string ToString()
                {
                        return string.Format(
                                "ModVersion {4}:\nid: {3}\nksp_version: {1}\ndownload_path: {2}\nchangelog: {0}",
                                ChangeLog,
                                KspVersion,
                                DownloadPath,
                                Id,
                                FriendlyVersion
                        );
                }
        }
}