Merge pull request #157 from RogueException/issues/153

Remove all references to XKCD URLs in Invites

src/Discord.Net/API/Common/Invite.cs

@@ -10,7 +10,5 @@ namespace Discord.API
         public InviteGuild Guild { get; set; }
         [JsonProperty("channel")]
         public InviteChannel Channel { get; set; }
-        [JsonProperty("xkcdpass")]
-        public string XkcdPass { get; set; }
     }
 }

src/Discord.Net/API/DiscordRestApiClient.cs

@@ -519,21 +519,21 @@ namespace Discord.API
         }
 
         //Guild Invites
-        public async Task<Invite> GetInviteAsync(string inviteIdOrXkcd, RequestOptions options = null)
+        public async Task<Invite> GetInviteAsync(string inviteId, RequestOptions options = null)
         {
-            Preconditions.NotNullOrEmpty(inviteIdOrXkcd, nameof(inviteIdOrXkcd));
+            Preconditions.NotNullOrEmpty(inviteId, nameof(inviteId));
 
             //Remove trailing slash
-            if (inviteIdOrXkcd[inviteIdOrXkcd.Length - 1] == '/')
+            if (inviteId[inviteId.Length - 1] == '/')
-                inviteIdOrXkcd = inviteIdOrXkcd.Substring(0, inviteIdOrXkcd.Length - 1);
+                inviteId = inviteId.Substring(0, inviteId.Length - 1);
             //Remove leading URL
-            int index = inviteIdOrXkcd.LastIndexOf('/');
+            int index = inviteId.LastIndexOf('/');
             if (index >= 0)
-                inviteIdOrXkcd = inviteIdOrXkcd.Substring(index + 1);
+                inviteId = inviteId.Substring(index + 1);
 
             try
             {
-                return await SendAsync<Invite>("GET", $"invites/{inviteIdOrXkcd}", options: options).ConfigureAwait(false);
+                return await SendAsync<Invite>("GET", $"invites/{inviteId}", options: options).ConfigureAwait(false);
             }
             catch (HttpException ex) when (ex.StatusCode == HttpStatusCode.NotFound) { return null; }
         }

src/Discord.Net/API/Rest/CreateChannelInviteParams.cs

@@ -16,9 +16,5 @@ namespace Discord.API.Rest
         [JsonProperty("temporary")]
         internal Optional<bool> _temporary { get; set; }
         public bool Temporary { set { _temporary = value; } }
-
-        [JsonProperty("xkcdpass")]
-        internal Optional<bool> _xkcdPass { get; set; }
-        public bool XkcdPass { set { _xkcdPass = value; } }
     }
 }

src/Discord.Net/Entities/Channels/IGuildChannel.cs

@@ -19,8 +19,7 @@ namespace Discord
         /// <param name="maxAge"> The time (in seconds) until the invite expires. Set to null to never expire. </param>
         /// <param name="maxUses"> The max amount  of times this invite may be used. Set to null to have unlimited uses. </param>
         /// <param name="isTemporary"> If true, a user accepting this invite will be kicked from the guild after closing their client. </param>
-        /// <param name="withXkcd"> If true, creates a human-readable link. Not supported if maxAge is set to null. </param>
+        Task<IInviteMetadata> CreateInviteAsync(int? maxAge = 1800, int? maxUses = default(int?), bool isTemporary = false);
-        Task<IInviteMetadata> CreateInviteAsync(int? maxAge = 1800, int? maxUses = default(int?), bool isTemporary = false, bool withXkcd = false);
         /// <summary> Returns a collection of all invites to this channel. </summary>
         Task<IReadOnlyCollection<IInviteMetadata>> GetInvitesAsync();
 

src/Discord.Net/Entities/Guilds/IGuild.cs

@@ -86,8 +86,7 @@ namespace Discord
         /// <param name="maxAge"> The time (in seconds) until the invite expires. Set to null to never expire. </param>
         /// <param name="maxUses"> The max amount  of times this invite may be used. Set to null to have unlimited uses. </param>
         /// <param name="isTemporary"> If true, a user accepting this invite will be kicked from the guild after closing their client. </param>
-        /// <param name="withXkcd"> If true, creates a human-readable link. Not supported if maxAge is set to null. </param>
+        Task<IInviteMetadata> CreateInviteAsync(int? maxAge = 1800, int? maxUses = default(int?), bool isTemporary = false);
-        Task<IInviteMetadata> CreateInviteAsync(int? maxAge = 1800, int? maxUses = default(int?), bool isTemporary = false, bool withXkcd = false);
 
         /// <summary> Gets the role in this guild with the provided id, or null if not found. </summary>
         IRole GetRole(ulong id);

src/Discord.Net/Entities/Invites/IInvite.cs

@@ -8,10 +8,6 @@ namespace Discord
         string Code { get; }
         /// <summary> Gets the url used to accept this invite, using Code. </summary>
         string Url { get; }
-        /// <summary> Gets the human-readable identifier for this code. </summary>
-        string XkcdCode { get; }
-        /// <summary> Gets the url used to accept this invite, using XkcdCode. </summary>
-        string XkcdUrl { get; }
 
         /// <summary> Gets the id of the the channel this invite is linked to. </summary>
         ulong ChannelId { get; }

src/Discord.Net/IDiscordClient.cs

@@ -31,7 +31,7 @@ namespace Discord
         Task<IReadOnlyCollection<IUserGuild>> GetGuildSummariesAsync();
         Task<IGuild> CreateGuildAsync(string name, IVoiceRegion region, Stream jpegIcon = null);
         
-        Task<IInvite> GetInviteAsync(string inviteIdOrXkcd);
+        Task<IInvite> GetInviteAsync(string inviteId);
 
         Task<IUser> GetUserAsync(ulong id);
         Task<IUser> GetUserAsync(string username, string discriminator);

src/Discord.Net/Rest/DiscordRestClient.cs

@@ -201,9 +201,9 @@ namespace Discord.Rest
         }
 
         /// <inheritdoc />
-        public virtual async Task<IInvite> GetInviteAsync(string inviteIdOrXkcd)
+        public virtual async Task<IInvite> GetInviteAsync(string inviteId)
         {
-            var model = await ApiClient.GetInviteAsync(inviteIdOrXkcd).ConfigureAwait(false);
+            var model = await ApiClient.GetInviteAsync(inviteId).ConfigureAwait(false);
             if (model != null)
                 return new Invite(this, model);
             return null;

src/Discord.Net/Rest/Entities/Channels/GuildChannel.cs

@@ -76,14 +76,13 @@ namespace Discord
             var models = await Discord.ApiClient.GetChannelInvitesAsync(Id).ConfigureAwait(false);
             return models.Select(x => new InviteMetadata(Discord, x)).ToImmutableArray();
         }
-        public async Task<IInviteMetadata> CreateInviteAsync(int? maxAge, int? maxUses, bool isTemporary, bool withXkcd)
+        public async Task<IInviteMetadata> CreateInviteAsync(int? maxAge, int? maxUses, bool isTemporary)
         {
             var args = new CreateChannelInviteParams
             {
                 MaxAge = maxAge ?? 0,
                 MaxUses = maxUses ?? 0,
-                Temporary = isTemporary,
+                Temporary = isTemporary
-                XkcdPass = withXkcd
             };
             var model = await Discord.ApiClient.CreateChannelInviteAsync(Id, args).ConfigureAwait(false);
             return new InviteMetadata(Discord, model);

src/Discord.Net/Rest/Entities/Guilds/Guild.cs

@@ -220,7 +220,7 @@ namespace Discord
             var models = await Discord.ApiClient.GetGuildInvitesAsync(Id).ConfigureAwait(false);
             return models.Select(x => new InviteMetadata(Discord, x)).ToImmutableArray();
         }
-        public async Task<IInviteMetadata> CreateInviteAsync(int? maxAge = 1800, int? maxUses = null, bool isTemporary = false, bool withXkcd = false)
+        public async Task<IInviteMetadata> CreateInviteAsync(int? maxAge = 1800, int? maxUses = null, bool isTemporary = false)
         {
             if (maxAge <= 0) throw new ArgumentOutOfRangeException(nameof(maxAge));
             if (maxUses <= 0) throw new ArgumentOutOfRangeException(nameof(maxUses));
@@ -229,8 +229,7 @@ namespace Discord
             {
                 MaxAge = maxAge ?? 0,
                 MaxUses = maxUses ?? 0,
-                Temporary = isTemporary,
+                Temporary = isTemporary
-                XkcdPass = withXkcd
             };
             var model = await Discord.ApiClient.CreateChannelInviteAsync(DefaultChannelId, args).ConfigureAwait(false);
             return new InviteMetadata(Discord, model);

src/Discord.Net/Rest/Entities/Invites/Invite.cs

@@ -10,15 +10,13 @@ namespace Discord
     {
         public string ChannelName { get; private set; }
         public string GuildName { get; private set; }
-        public string XkcdCode { get; private set; }
 
         public ulong ChannelId { get; private set; }
         public ulong GuildId { get; private set; }
         public override DiscordRestClient Discord { get; }
 
         public string Code => Id;
-        public string Url => $"{DiscordConfig.InviteUrl}/{XkcdCode ?? Code}";
+        public string Url => $"{DiscordConfig.InviteUrl}/{Code}";
-        public string XkcdUrl => XkcdCode != null ? $"{DiscordConfig.InviteUrl}/{XkcdCode}" : null;
 
         public Invite(DiscordRestClient discord, Model model)
             : base(model.Code)
@@ -31,7 +29,6 @@ namespace Discord
         {
             if (source == UpdateSource.Rest && IsAttached) return;
 
-            XkcdCode = model.XkcdPass;
             GuildId = model.Guild.Id;
             ChannelId = model.Channel.Id;
             GuildName = model.Guild.Name;
@@ -47,7 +44,7 @@ namespace Discord
             await Discord.ApiClient.DeleteInviteAsync(Code).ConfigureAwait(false);
         }
 
-        public override string ToString() => XkcdUrl ?? Url;
+        public override string ToString() => Url;
-        private string DebuggerDisplay => $"{XkcdUrl ?? Url} ({GuildName} / {ChannelName})";
+        private string DebuggerDisplay => $"{Url} ({GuildName} / {ChannelName})";
     }
 }