Feature/display layout info

src/InvvardDev.EZLayoutDisplay.Desktop/App.config

@@ -21,7 +21,7 @@
   <userSettings>
     <InvvardDev.EZLayoutDisplay.Desktop.Properties.Settings>
       <setting name="ErgodoxLayoutUrl" serializeAs="String">
-        <value>https://configure.ergodox-ez.com/layouts/default/latest/0</value>
+        <value>https://configure.ergodox-ez.com/ergodox-ez/layouts/default/latest/0</value>
       </setting>
       <setting name="HotkeyShowLayout" serializeAs="String">
         <value>{"modifiers":[0,1,2,4],"keycode":32}</value>

src/InvvardDev.EZLayoutDisplay.Desktop/App.xaml

@@ -20,6 +20,23 @@
 
             <SolidColorBrush x:Key="WindowBackgroundBrush" Color="WhiteSmoke" />
 
+            <Style TargetType="Button" x:Key="HyperlinkStyledButton">
+                <Setter Property="Template">
+                    <Setter.Value>
+                        <ControlTemplate TargetType="Button">
+                            <TextBlock Foreground="#FF0066CC"
+                                       Text="{TemplateBinding Content}"
+                                       TextDecorations="Underline"
+                                       FontFamily="Segoe UI"
+                                       FontSize="15"
+                                       Cursor="Hand" />
+                        </ControlTemplate>
+                    </Setter.Value>
+                </Setter>
+                <Setter Property="VerticalAlignment" Value="Center" />
+                <Setter Property="Margin" Value="5,0,0,0" />
+            </Style>
+
             <converter:KeyCodeToCharConverter x:Key="KeyCodeConverter" />
 
             <converter:BoolToVisibilityConverter x:Key="BoolToHiddenConverter"

src/InvvardDev.EZLayoutDisplay.Desktop/InvvardDev.EZLayoutDisplay.Desktop.csproj

@@ -110,6 +110,7 @@
     <Compile Include="Helper\KeyContentTemplateSelector.cs" />
     <Compile Include="Helper\LoggerHelper.cs" />
     <Compile Include="Model\Enum\KeyDisplayType.cs" />
+    <Compile Include="Model\ErgodoxTag.cs" />
     <Compile Include="Model\KeyTemplate.cs" />
     <Compile Include="Model\Messenger\UpdatedLayoutMessage.cs" />
     <Compile Include="Properties\Resources.Designer.cs">
@@ -174,6 +175,10 @@
       <SubType>Designer</SubType>
       <Generator>MSBuild:Compile</Generator>
     </Page>
+    <Page Include="Skins\SettingsSkin.xaml">
+      <SubType>Designer</SubType>
+      <Generator>MSBuild:Compile</Generator>
+    </Page>
     <Page Include="View\AboutWindow.xaml">
       <SubType>Designer</SubType>
       <Generator>MSBuild:Compile</Generator>

src/InvvardDev.EZLayoutDisplay.Desktop/Model/ErgodoxLayer.cs

@@ -34,5 +34,10 @@ public class ErgodoxLayer
         /// </summary>
         [JsonProperty("color")]
         public string Color { get; set; }
+
+        public override string ToString()
+        {
+            return $"{Title} {Position}";
+        }
     }
 }

src/InvvardDev.EZLayoutDisplay.Desktop/Model/ErgodoxLayout.cs

@@ -11,12 +11,24 @@ public class ErgodoxLayout
         [JsonProperty("hashId")]
         public string HashId { get; set; }
 
+        /// <summary>
+        /// Gets or sets the keyboard geometry.
+        /// </summary>
+        [JsonProperty("geometry")]
+        public string Geometry { get; set; }
+
         /// <summary>
         /// Gets or sets the layout title.
         /// </summary>
         [JsonProperty("title")]
         public string Title { get; set; }
 
+        /// <summary>
+        /// Gets or sets the keyboard tags.
+        /// </summary>
+        [JsonProperty("tags", NullValueHandling = NullValueHandling.Ignore)]
+        public List<ErgodoxTag> Tags { get; set; }
+
         /// <summary>
         /// Gets or sets the list of <see cref="Revision"/>.
         /// </summary>

src/InvvardDev.EZLayoutDisplay.Desktop/Model/ErgodoxTag.cs

@@ -0,0 +1,13 @@
+using Newtonsoft.Json;
+
+namespace InvvardDev.EZLayoutDisplay.Desktop.Model
+{
+    public class ErgodoxTag
+    {
+        /// <summary>
+        /// Gets or sets the tag name.
+        /// </summary>
+        [JsonProperty("name")]
+        public string Name { get; set; }
+    }
+}

src/InvvardDev.EZLayoutDisplay.Desktop/Model/Revision.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using Newtonsoft.Json;
 
 namespace InvvardDev.EZLayoutDisplay.Desktop.Model
@@ -11,6 +12,18 @@ public class Revision
         [JsonProperty("hashId")]
         public string HashId { get; set; }
 
+        /// <summary>
+        /// Gets or sets the keyboard layout HEX file URL.
+        /// </summary>
+        [JsonProperty("hexUrl")]
+        public string HexUrl { get; set; }
+
+        /// <summary>
+        /// Gets or sets the keyboard layout sources zip URL.
+        /// </summary>
+        [JsonProperty("zipUrl")]
+        public string SourcesUrl { get; set; }
+
         /// <summary>
         /// Gets or sets the keyboard model.
         /// </summary>

src/InvvardDev.EZLayoutDisplay.Desktop/Properties/Settings.settings

@@ -3,7 +3,7 @@
   <Profiles />
   <Settings>
     <Setting Name="ErgodoxLayoutUrl" Type="System.String" Scope="User">
-      <Value Profile="(Default)">https://configure.ergodox-ez.com/layouts/default/latest/0</Value>
+      <Value Profile="(Default)">https://configure.ergodox-ez.com/ergodox-ez/layouts/default/latest/0</Value>
     </Setting>
     <Setting Name="HotkeyShowLayout" Type="System.String" Scope="User">
       <Value Profile="(Default)">{"modifiers":[0,1,2,4],"keycode":32}</Value>

src/InvvardDev.EZLayoutDisplay.Desktop/Service/Design/LayoutService.cs

@@ -8,6 +8,16 @@ namespace InvvardDev.EZLayoutDisplay.Desktop.Service.Design
 {
     public class LayoutService : ILayoutService
     {
+        public async Task<ErgodoxLayout> GetLayoutInfo(string layoutHashId)
+        {
+            Debug.WriteLine("Layout retrieved.");
+
+            var layoutInfo = new ErgodoxLayout();
+            layoutInfo.Title = "Layout title v1.0";
+
+            return await new Task<ErgodoxLayout>(() => layoutInfo);
+        }
+
         /// <inheritdoc />
         public async Task<ErgodoxLayout> GetErgodoxLayout(string layoutHashId)
         {

src/InvvardDev.EZLayoutDisplay.Desktop/Service/Implementation/LayoutService.cs

@@ -15,50 +15,37 @@ namespace InvvardDev.EZLayoutDisplay.Desktop.Service.Implementation
     public class LayoutService : ILayoutService
     {
         private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
+
         private readonly string GetLayoutBody =
             "{{\"operationName\":\"getLayout\",\"variables\":{{\"hashId\":\"{0}\"}},\"query\":\"query getLayout($hashId: String!) {{\\n Layout(hashId: $hashId) {{\\n ...LayoutData\\n }}\\n}}\\n\\nfragment LayoutData on Layout {{\\n hashId\\n title\\n revisions {{\\n hashId\\n model\\n layers {{\\n hashId\\n keys\\n position\\n title\\n color\\n }}\\n}}\\n}}\\n\"}}";
 
+        private readonly string GetLayoutInfoRequestBody =
+            "{{\"operationName\":\"getLayout\",\"variables\":{{\"hashId\":\"{0}\"}},\"query\":\"query getLayout($hashId: String!) {{\\n Layout(hashId: $hashId) {{\\n ...LayoutData\\n __typename\\n }}\\n}}\\n\\nfragment LayoutData on Layout {{\\n geometry\\n hashId\\n title\\n tags {{\\n id\\n hashId\\n name\\n }}\\n revisions {{\\n hexUrl\\n model\\n zipUrl\\n layers {{\\n position\\n title\\n }}\\n }}\\n __typename\\n}}\\n\"}}";
+
         private const string GetLayoutRequestUri = "https://oryx.ergodox-ez.com/graphql";
 
         #region ILayoutService implementation
 
         /// <inheritdoc />
-        public async Task<ErgodoxLayout> GetErgodoxLayout(string layoutHashId)
+        public async Task<ErgodoxLayout> GetLayoutInfo(string layoutHashId)
         {
             Logger.TraceMethod();
             Logger.DebugInputParam(nameof(layoutHashId), layoutHashId);
 
-            if (string.IsNullOrWhiteSpace(layoutHashId))
-            {
-                Logger.Error("Layout {0} was not found", layoutHashId);
-                // ReSharper disable once LocalizableElement
-                throw new ArgumentNullException(nameof(layoutHashId), $"Layout hash ID '{layoutHashId}' was not found.");
-            }
-
-            DataRoot layout;
-
-            using (HttpClient client = new HttpClient())
-            {
-                var body = string.Format(GetLayoutBody, layoutHashId);
-                Logger.Debug("Request body : {@body}", body);
-
-                var response = await client.PostAsync(GetLayoutRequestUri, new StringContent(body, Encoding.UTF8, "application/json"));
-                Logger.Debug("Response : {@response}", response);
-
-                var result = await response.Content.ReadAsStringAsync();
-                Logger.Debug("Content result : {@result}", result);
+            var info = await QueryData(layoutHashId, GetLayoutInfoRequestBody);
+
+            return info;
+        }
 
-                layout = JsonConvert.DeserializeObject<DataRoot>(result);
-                Logger.Debug("Deserialized layout : {@layout}", layout);
+        /// <inheritdoc />
+        public async Task<ErgodoxLayout> GetErgodoxLayout(string layoutHashId)
+        {
+            Logger.TraceMethod();
+            Logger.DebugInputParam(nameof(layoutHashId), layoutHashId);
 
-                if (layout?.LayoutRoot?.Layout == null)
-                {
-                    Logger.Error("Layout {0} does not exist", layoutHashId);
-                    throw new ArgumentException(layoutHashId, $"Hash ID \"{layoutHashId}\" does not exist");
-                }
-            }
+            var layout = await QueryData(layoutHashId, GetLayoutBody);
 
-            return layout.LayoutRoot.Layout;
+            return layout;
         }
 
         /// <inheritdoc />
@@ -80,11 +67,60 @@ public async Task<IEnumerable<KeyTemplate>> GetLayoutTemplate()
             IEnumerable<KeyTemplate> layoutTemplate = await ReadLayoutDefinition();
 
             return layoutTemplate;
+        }
+
+        #endregion
+
+        #region Private methods
+
+        private async Task<ErgodoxLayout> QueryData(string layoutHashId, string graphQlQuery)
+        {
+            ValidateLayoutHashId(layoutHashId);
+
+            var requestBody = string.Format(graphQlQuery, layoutHashId);
+
+            var layout = await HttpClientCall(requestBody);
+
+            if (layout?.LayoutRoot?.Layout == null)
+            {
+                Logger.Error("Layout {0} does not exist", layoutHashId);
+
+                throw new ArgumentException(layoutHashId, $"Hash ID \"{layoutHashId}\" does not exist");
+            }
+
+            return layout.LayoutRoot.Layout;
         }
 
-        #endregion
+        private static void ValidateLayoutHashId(string layoutHashId)
+        {
+            if (!string.IsNullOrWhiteSpace(layoutHashId)) return;
 
-        #region Private methods
+            Logger.Error("Layout {0} was not found", layoutHashId);
+
+            // ReSharper disable once LocalizableElement
+            throw new ArgumentNullException(nameof(layoutHashId), $"Layout hash ID '{layoutHashId}' was not found.");
+        }
+
+        private async Task<DataRoot> HttpClientCall(string requestBody)
+        {
+            DataRoot layout;
+
+            using (HttpClient client = new HttpClient())
+            {
+                Logger.Debug("Request body : {@body}", requestBody);
+
+                var response = await client.PostAsync(GetLayoutRequestUri, new StringContent(requestBody, Encoding.UTF8, "application/json"));
+                Logger.Debug("Response : {@response}", response);
+
+                var result = await response.Content.ReadAsStringAsync();
+                Logger.Debug("Content result : {@result}", result);
+
+                layout = JsonConvert.DeserializeObject<DataRoot>(result);
+                Logger.Debug("Deserialized layout : {@layout}", layout);
+            }
+
+            return layout;
+        }
 
         private async Task<IEnumerable<KeyTemplate>> ReadLayoutDefinition()
         {
@@ -93,16 +129,17 @@ private async Task<IEnumerable<KeyTemplate>> ReadLayoutDefinition()
             if (Resources.layoutDefinition.Length <= 0)
             {
                 Logger.Warn("Layout definition is empty");
+
                 return new List<KeyTemplate>();
             }
 
             var layoutTemplate = await Task.Run(() => {
-                                              var json = Encoding.Default.GetString(Resources.layoutDefinition);
+                                                    var json = Encoding.Default.GetString(Resources.layoutDefinition);
 
-                                              var layoutDefinition = JsonConvert.DeserializeObject<IEnumerable<KeyTemplate>>(json);
+                                                    var layoutDefinition = JsonConvert.DeserializeObject<IEnumerable<KeyTemplate>>(json);
 
-                                              return layoutDefinition;
-                                          });
+                                                    return layoutDefinition;
+                                                });
 
             Logger.DebugOutputParam(nameof(layoutTemplate), layoutTemplate);
 

src/InvvardDev.EZLayoutDisplay.Desktop/Service/Interface/ILayoutService.cs

@@ -6,6 +6,13 @@ namespace InvvardDev.EZLayoutDisplay.Desktop.Service.Interface
 {
     public interface ILayoutService
     {
+        /// <summary>
+        /// Gets the <see cref="ErgodoxLayout"/> basic info.
+        /// </summary>
+        /// <param name="layoutHashId">The layout hash ID to get.</param>
+        /// <returns>The <see cref="ErgodoxLayout"/>.</returns>
+        Task<ErgodoxLayout> GetLayoutInfo(string layoutHashId);
+
         /// <summary>
         /// Gets the <see cref="ErgodoxLayout"/>.
         /// </summary>

src/InvvardDev.EZLayoutDisplay.Desktop/Skins/AboutSkin.xaml

@@ -29,21 +29,4 @@
         <Setter Property="Margin" Value="5,0,0,0" />
     </Style>
 
-    <Style TargetType="Button" x:Key="HyperlinkStyledButton">
-        <Setter Property="Template">
-            <Setter.Value>
-                <ControlTemplate TargetType="Button">
-                    <TextBlock Foreground="#FF0066CC"
-                               Text="{TemplateBinding Content}"
-                               TextDecorations="Underline"
-                               FontFamily="Segoe UI"
-                               FontSize="15"
-                               Cursor="Hand" />
-                </ControlTemplate>
-            </Setter.Value>
-        </Setter>
-        <Setter Property="VerticalAlignment" Value="Center" />
-        <Setter Property="Margin" Value="5,0,0,0" />
-    </Style>
-
 </ResourceDictionary>