Merge branch 'release/1.0.0'

README.md

@@ -18,9 +18,9 @@ dotnet add package GravyIrc
 ```csharp
 public async void TestClient() {
     var user = new User(config.Nick, config.Identity);
-    var client = new Client(user, new TcpClientConnection());
-    client.EventHub.RegistrationCompleted += Client_OnRegistered;
-    client.OnRawDataReceived += Client_OnRawDataReceived;
+    var client = new IrcClient(user, new TcpClientConnection());
+    client.EventHub.Subscribe<RplWelcomeMessage>(Client_OnRegistered);
+    client.EventHub.Subscribe<PrivateMessage>((client, args) => Console.WriteLine(args.IrcMessage.Message));
     await client.ConnectAsync(config.Server, config.Port);
     await client.SendAsync(new NickMessage(config.Nick));
     await client.SendAsync(new UserMessage(config.Nick, config.Identity));
@@ -33,8 +33,4 @@ private async void Client_OnRegistered(object sender, EventArgs e) {
     await client.SendAsync(new ModeMessage(config.Nick, "+B"));
     await JoinDefaultChannels();
 }
-
-private void Client_OnRawDataReceived(Client client, string rawData) {
-    Console.WriteLine(rawData);
-}
 ```

src/GravyIrc/EventHandlers.cs

@@ -3,10 +3,10 @@
 
 namespace GravyIrc
 {
-    public delegate void IrcRawDataHandler(Client client, string rawData);
-    public delegate void ParsedIrcMessageHandler(Client client, ParsedIrcMessage ircMessage);
+    public delegate void IrcRawDataHandler(IrcClient client, string rawData);
+    public delegate void ParsedIrcMessageHandler(IrcClient client, ParsedIrcMessage ircMessage);
 
-    public delegate void IrcMessageEventHandler<T>(Client client, IrcMessageEventArgs<T> e) where T : IrcMessage;
+    public delegate void IrcMessageEventHandler<T>(IrcClient client, IrcMessageEventArgs<T> e) where T : IrcMessage;
 
     public class IrcMessageEventArgs<T> : EventArgs where T : IrcMessage
     {

src/GravyIrc/EventHub.cs

@@ -10,10 +10,10 @@ namespace GravyIrc
     /// </summary>
     public class EventHub
     {
-        private readonly Client client;
+        private readonly IrcClient client;
         private readonly Dictionary<Type, object> eventHandlers = new Dictionary<Type, object>();
 
-        internal EventHub(Client client)
+        internal EventHub(IrcClient client)
         {
             this.client = client;
         }
@@ -99,9 +99,9 @@ public void Trigger(IServerMessage message)
 
         private class ServerMessageEventHandler<TMessage> where TMessage : IrcMessage, IServerMessage
         {
-            private readonly Client client;
+            private readonly IrcClient client;
 
-            internal ServerMessageEventHandler(Client client)
+            internal ServerMessageEventHandler(IrcClient client)
             {
                 this.client = client;
             }

src/GravyIrc/GravyIrc.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <Description>IRC client library for .NET Standard 2.0.  Forked from NetIRC.</Description>
+    <Description>IRC client library for .NET Standard 2.0.  Forked from NetIRC and beefed up a little.</Description>
     <Copyright></Copyright>
     <VersionPrefix>0.1.1</VersionPrefix>
     <Authors>Alex Griffith</Authors>
@@ -15,10 +15,18 @@
     <DebugType Condition="$(codecov) != ''">full</DebugType>
     <DebugType Condition="$(codecov) == ''">portable</DebugType>
     <DebugSymbols>True</DebugSymbols>
-    <Version>0.1.0-alpha2</Version>
+    <Version>1.0.0</Version>
     <Product>GravyIrc</Product>
-    <PackageReleaseNotes>Initial release; testing travis deploy</PackageReleaseNotes>
+    <PackageReleaseNotes>Initial release</PackageReleaseNotes>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PackageIcon>logo.png</PackageIcon>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="..\..\docfx_project\logo.png">
+      <Pack>True</Pack>
+      <PackagePath></PackagePath>
+    </None>
+  </ItemGroup>
+
 </Project>

src/GravyIrc/Client.cs → src/GravyIrc/IrcClient.cs

@@ -9,7 +9,7 @@ namespace GravyIrc
     /// <summary>
     /// The NetIRC IRC client
     /// </summary>
-    public class Client : IDisposable
+    public class IrcClient : IDisposable
     {
         private readonly IConnection connection;
 
@@ -57,7 +57,7 @@ public class Client : IDisposable
         /// </summary>
         /// <param name="user">User who wishes to connect to the server</param>
         /// <param name="connection">IConnection implementation</param>
-        public Client(User user, IConnection connection)
+        public IrcClient(User user, IConnection connection)
         {
             User = user;
 
@@ -72,7 +72,7 @@ public Client(User user, IConnection connection)
             InitializeDefaultEventHubEvents();
         }
 
-        public Client(User user, string password, IConnection connection)
+        public IrcClient(User user, string password, IConnection connection)
             : this(user, connection)
         {
             this.password = password;
@@ -90,13 +90,13 @@ private void InitializeDefaultEventHubEvents()
             EventHub.Subscribe<NickMessage>(EventHub_Nick);
         }
 
-        private void EventHub_Nick(Client client, IrcMessageEventArgs<NickMessage> e)
+        private void EventHub_Nick(IrcClient client, IrcMessageEventArgs<NickMessage> e)
         {
             var user = Peers.GetUser(e.IrcMessage.OldNick);
             user.Nick = e.IrcMessage.NewNick;
         }
 
-        private void EventHub_PrivMsg(Client client, IrcMessageEventArgs<PrivateMessage> e)
+        private void EventHub_PrivMsg(IrcClient client, IrcMessageEventArgs<PrivateMessage> e)
         {
             var user = Peers.GetUser(e.IrcMessage.From);
             var message = new ChatMessage(user, e.IrcMessage.Message);
@@ -113,7 +113,7 @@ private void EventHub_PrivMsg(Client client, IrcMessageEventArgs<PrivateMessage>
             }
         }
 
-        private void EventHub_RplNamReply(Client client, IrcMessageEventArgs<RplNamReplyMessage> e)
+        private void EventHub_RplNamReply(IrcClient client, IrcMessageEventArgs<RplNamReplyMessage> e)
         {
             var channel = Channels.GetChannel(e.IrcMessage.Channel);
             foreach (var nick in e.IrcMessage.Nicks)
@@ -126,15 +126,15 @@ private void EventHub_RplNamReply(Client client, IrcMessageEventArgs<RplNamReply
             }
         }
 
-        private void EventHub_Quit(Client client, IrcMessageEventArgs<QuitMessage> e)
+        private void EventHub_Quit(IrcClient client, IrcMessageEventArgs<QuitMessage> e)
         {
             foreach (var channel in Channels)
             {
                 channel.RemoveUser(e.IrcMessage.Nick);
             }
         }
 
-        private void EventHub_Kick(Client client, IrcMessageEventArgs<KickMessage> e)
+        private void EventHub_Kick(IrcClient client, IrcMessageEventArgs<KickMessage> e)
         {
             var channel = Channels.FirstOrDefault(c => c.Name == e.IrcMessage.Channel);
             if (channel != null)
@@ -150,13 +150,13 @@ private void EventHub_Kick(Client client, IrcMessageEventArgs<KickMessage> e)
             }
         }
 
-        private void EventHub_Part(Client client, IrcMessageEventArgs<PartMessage> e)
+        private void EventHub_Part(IrcClient client, IrcMessageEventArgs<PartMessage> e)
         {
             var channel = Channels.GetChannel(e.IrcMessage.Channel);
             channel.RemoveUser(e.IrcMessage.Nick);
         }
 
-        private void EventHub_Join(Client client, IrcMessageEventArgs<JoinMessage> e)
+        private void EventHub_Join(IrcClient client, IrcMessageEventArgs<JoinMessage> e)
         {
             var channel = Channels.GetChannel(e.IrcMessage.Channel);
             if (e.IrcMessage.Nick != User.Nick)

tests/GravyIrc.Tests/ClientTests.cs

@@ -11,12 +11,12 @@ public class ClientTests
     {
         private static User FakeUser = new User("test", "test");
         private readonly Mock<IConnection> mockConnection;
-        private readonly Client client;
+        private readonly IrcClient client;
 
         public ClientTests()
         {
             mockConnection = new Mock<IConnection>();
-            client = new Client(FakeUser, mockConnection.Object);
+            client = new IrcClient(FakeUser, mockConnection.Object);
         }
 
         [Fact]
@@ -99,7 +99,7 @@ public async Task SendsNickAndUserWhenConnected()
             var nick = "guest";
             var realName = "Ronnie Reagan";
             var user = new User(nick, realName);
-            var client = new Client(user, mockConnection.Object);
+            var client = new IrcClient(user, mockConnection.Object);
 
             await Task.Run(() => client.ConnectAsync("localhost", 6667));
 
@@ -114,7 +114,7 @@ public async Task SendsPassNickAndUserWhenConnected()
             var nick = "guest";
             var realName = "Ronnie Reagan";
             var user = new User(nick, realName);
-            var client = new Client(user, password, mockConnection.Object);
+            var client = new IrcClient(user, password, mockConnection.Object);
 
             await Task.Run(() => client.ConnectAsync("localhost", 6667));
 
@@ -644,7 +644,7 @@ public void NickTriggersOnPropertyChangedOnUser()
             Assert.Equal("Nick", propertyName);
         }
 
-        private void RaiseDataReceived(Mock<IConnection> mockConnection, Client client, string raw)
+        private void RaiseDataReceived(Mock<IConnection> mockConnection, IrcClient client, string raw)
         {
             mockConnection.Raise(c => c.DataReceived += null, client, new DataReceivedEventArgs(raw));
         }