Merge branch 'develop'

Author: rburke-orthofi

.github/workflows/ci.yml

@@ -1,16 +1,53 @@
-name: CI
+name: Nuget Release Package
 
 on:
+  create:
+    branches: 
+      - release/**
   push:
-    branches: [develop]
-
+    branches:
+    - master
+  pull_request:
+    branches:
+    - master
+    
 jobs:
   build:
+
+    env:
+      BUILD_CONFIG: 'Release'
+      SOLUTION: 'ESI.NET.sln'
+
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
+    - uses: actions/checkout@v2
+    
+    - name: Get Build Version
+      run: |
+        Import-Module .\build\GetBuildVersion.psm1
+        Write-Host $Env:GITHUB_REF
+        $version = GetBuildVersion -VersionString $Env:GITHUB_REF
+        echo "BUILD_VERSION=$version" | Out-File -FilePath $Env:GITHUB_ENV -Encoding utf-8 -Append
+      shell: pwsh
+
+    - name: Setup NuGet
+      uses: NuGet/setup-nuget@v1.0.5
+
+    - name: Restore dependencies
+      run: nuget restore $SOLUTION
+
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 3.1.x
+
     - name: Build
-      run: dotnet build --configuration Release
+      run: dotnet build $SOLUTION --configuration $BUILD_CONFIG -p:Version=$BUILD_VERSION --no-restore
+
+    - name: Run tests
+      run: dotnet test /p:Configuration=$env:BUILD_CONFIG --no-restore --no-build --verbosity normal
 
+    - name: Publish
+      if: startsWith(github.ref, 'refs/heads/release')
+      run: nuget push **\*.nupkg -Source 'https://api.nuget.org/v3/index.json' -ApiKey ${{secrets.NUGET_API_KEY}}

ESI.NET/ESI.NET.csproj

@@ -8,15 +8,14 @@
   </PropertyGroup>
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1;netstandard2.0;net461;net462;net47;net471;net5.0</TargetFrameworks>
+    <TargetFrameworks>netcoreapp3.1;netstandard2.0;net462;net47;net471;net472;net48;net6.0;net7.0</TargetFrameworks>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-    <Version>2021.12.12</Version>
+    <Version>2023.02.11</Version>
     <Authors>Psianna Archeia</Authors>
     <Company>Sukebe Corporation</Company>
     <Description>.NET Wrapper for the Eve Online API</Description>
     <RepositoryUrl>https://github.com/seraphx2/ESI.NET</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <PackageLicenseUrl></PackageLicenseUrl>
     <PackageProjectUrl>https://github.com/seraphx2/ESI.NET</PackageProjectUrl>
     <PackageLicenseFile>LICENSE.txt</PackageLicenseFile>
   </PropertyGroup>
@@ -28,7 +27,7 @@
     <PackageReference Include="Microsoft.Extensions.Options" Version="2.0.0" />
     <PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="2.0.0" />
     <PackageReference Include="Microsoft.IdentityModel.Tokens" Version="6.14.1" />
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
     <PackageReference Include="System.Collections.Immutable" Version="1.5.0" />
     <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="6.14.1" />
     <PackageReference Include="System.Net.Http" Version="4.3.4" />
@@ -37,8 +36,14 @@
   <ItemGroup>
     <None Include="..\LICENSE.txt">
       <Pack>True</Pack>
-      <PackagePath></PackagePath>
+      <PackagePath>LICENSE.txt</PackagePath>
     </None>
   </ItemGroup>
 
-</Project>
+  <ItemGroup>
+    <None Update="GetBuildVersion.psm1">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
+</Project>

ESI.NET/EsiClient.cs

@@ -14,22 +14,22 @@ public class EsiClient : IEsiClient
         readonly EsiConfig config;
 
         /// <summary>
-        /// 
+        /// Initializes a new instance of the <see cref="EsiClient"/> class.
         /// </summary>
-        /// <param name="config"></param>
-        public EsiClient(IOptions<EsiConfig> _config)
+        /// <param name="_config">The configuration parameters of the <see cref="EsiClient"/>.</param>
+        /// <param name="_client">The <see cref="HttpClient"/> to use for HTTP requests.</param>
+        public EsiClient(IOptions<EsiConfig> _config, HttpClient _client = null)
         {
             config = _config.Value;
-            client = new HttpClient(new HttpClientHandler
+            client = _client ?? new HttpClient(new HttpClientHandler
             {
                 AutomaticDecompression = DecompressionMethods.GZip | DecompressionMethods.Deflate
             });
 
             // Enforce user agent value
             if (string.IsNullOrEmpty(config.UserAgent))
                 throw new ArgumentException("For your protection, please provide an X-User-Agent value. This can be your character name and/or project name. CCP will be more likely to contact you rather than just cut off access to ESI if you provide something that can identify you within the New Eden galaxy.");
-            else
-                client.DefaultRequestHeaders.Add("X-User-Agent", config.UserAgent);
+            client.DefaultRequestHeaders.Add("X-User-Agent", config.UserAgent);
 
             client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
             client.DefaultRequestHeaders.AcceptEncoding.Add(new StringWithQualityHeaderValue("gzip"));

ESI.NET/EsiRequest.cs

@@ -12,81 +12,48 @@ internal static class EsiRequest
     {
         internal static string ETag;
 
-        public static async Task<EsiResponse<T>> Execute<T>(HttpClient client, EsiConfig config, RequestSecurity security, RequestMethod method, string endpoint, Dictionary<string, string> replacements = null, string[] parameters = null, object body = null, string token = null)
+        public static async Task<EsiResponse<T>> Execute<T>(HttpClient client, EsiConfig config, RequestSecurity security, HttpMethod httpMethod, string endpoint, Dictionary<string, string> replacements = null, string[] parameters = null, object body = null, string token = null)
         {
-            client.DefaultRequestHeaders.Clear();
-
-            var path = $"{method.ToString()}|{endpoint}";
+            var path = $"{httpMethod}|{endpoint}";
 
             if (replacements != null)
                 foreach (var property in replacements)
                     endpoint = endpoint.Replace($"{{{property.Key}}}", property.Value);
 
             var url = $"{config.EsiUrl}latest{endpoint}?datasource={config.DataSource.ToEsiValue()}";
 
+            //Attach query string parameters
+            if (parameters != null)
+                url += $"&{string.Join("&", parameters)}";
+
+            var request = new HttpRequestMessage(httpMethod, url);
+
             //Attach token to request header if this endpoint requires an authorized character
             if (security == RequestSecurity.Authenticated)
             {
                 if (token == null)
                     throw new ArgumentException("The request endpoint requires SSO authentication and a Token has not been provided.");
-
-                client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
+                request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", token);
             }
 
             if (ETag != null)
             {
-                client.DefaultRequestHeaders.Add("If-None-Match", $"\"{ETag}\"");
+                request.Headers.Add("If-None-Match", $"\"{ETag}\"");
                 ETag = null;
             }
 
-            //Attach query string parameters
-            if (parameters != null)
-                url += $"&{string.Join("&", parameters)}";
-
             //Serialize post body data
-            HttpContent postBody = null;
             if (body != null)
-                postBody = new StringContent(JsonConvert.SerializeObject(body), Encoding.UTF8, "application/json");
-
-            //Get response from client based on request type
-            //This is also where body variables will be created and attached as necessary
-            HttpResponseMessage response = null;
-            switch (method)
-            {
-                case RequestMethod.Delete:
-                    response = await client.DeleteAsync(url).ConfigureAwait(false);
-                    break;
-
-                case RequestMethod.Get:
-                    response = await client.GetAsync(url).ConfigureAwait(false);
-                    break;
-
-                case RequestMethod.Post:
-                    response = await client.PostAsync(url, postBody).ConfigureAwait(false);
-                    break;
+                request.Content = new StringContent(JsonConvert.SerializeObject(body), Encoding.UTF8, "application/json");
 
-                case RequestMethod.Put:
-                    response = await client.PutAsync(url, postBody).ConfigureAwait(false);
-                    break;
-            }
-            
             //Output final object
-            var obj = new EsiResponse<T>(response, path);
-            return obj;
+            return new EsiResponse<T>(await client.SendAsync(request).ConfigureAwait(false), path);
         }
 
         public enum RequestSecurity
         {
             Public,
             Authenticated
         }
-
-        public enum RequestMethod
-        {
-            Delete,
-            Get,
-            Post,
-            Put
-        }
     }
-}
+}

ESI.NET/EsiResponse.cs

@@ -64,7 +64,10 @@ public EsiResponse(HttpResponseMessage response, string path)
                 Message = response.Content.ReadAsStringAsync().Result;
                 Exception = ex;
             }
-            
+            finally
+            {
+                response.Dispose();
+            }
         }
 
         public Guid RequestId { get; set; }
@@ -84,41 +87,41 @@ public EsiResponse(HttpResponseMessage response, string path)
         private readonly ImmutableDictionary<string, string> _noContentMessage = new Dictionary<string, string>()
         {
             //Calendar
-            {"Put|/characters/{character_id}/calendar/{event_id}/", "Event updated"},
+            {"PUT|/characters/{character_id}/calendar/{event_id}/", "Event updated"},
 
             //Contacts
-            {"Put|/characters/{character_id}/contacts/", "Contacts updated"},
-            {"Delete|/characters/{character_id}/contacts/", "Contacts deleted"},
+            {"PUT|/characters/{character_id}/contacts/", "Contacts updated"},
+            {"DELETE|/characters/{character_id}/contacts/", "Contacts deleted"},
 
             //Corporations
-            {"Put|/corporations/{corporation_id}/structures/{structure_id}/", "Structure vulnerability window updated"},
+            {"PUT|/corporations/{corporation_id}/structures/{structure_id}/", "Structure vulnerability window updated"},
 
             //Fittings
-            {"Delete|/characters/{character_id}/fittings/{fitting_id}/", "Fitting deleted"},
+            {"DELETE|/characters/{character_id}/fittings/{fitting_id}/", "Fitting deleted"},
 
             //Fleets
-            {"Put|/fleets/{fleet_id}/", "Fleet updated"},
-            {"Post|/fleets/{fleet_id}/members/", "Fleet invitation sent"},
-            {"Delete|/fleets/{fleet_id}/members/{member_id}/", "Fleet member kicked"},
-            {"Put|/fleets/{fleet_id}/members/{member_id}/", "Fleet invitation sent"},
-            {"Delete|/fleets/{fleet_id}/wings/{wing_id}/", "Wing deleted"},
-            {"Put|/fleets/{fleet_id}/wings/{wing_id}/", "Wing renamed"},
-            {"Delete|/fleets/{fleet_id}/squads/{squad_id}/", "Squad deleted"},
-            {"Put|/fleets/{fleet_id}/squads/{squad_id}/", "Squad renamed"},
+            {"PUT|/fleets/{fleet_id}/", "Fleet updated"},
+            {"POST|/fleets/{fleet_id}/members/", "Fleet invitation sent"},
+            {"DELETE|/fleets/{fleet_id}/members/{member_id}/", "Fleet member kicked"},
+            {"PUT|/fleets/{fleet_id}/members/{member_id}/", "Fleet invitation sent"},
+            {"DELETE|/fleets/{fleet_id}/wings/{wing_id}/", "Wing deleted"},
+            {"PUT|/fleets/{fleet_id}/wings/{wing_id}/", "Wing renamed"},
+            {"DELETE|/fleets/{fleet_id}/squads/{squad_id}/", "Squad deleted"},
+            {"PUT|/fleets/{fleet_id}/squads/{squad_id}/", "Squad renamed"},
 
             //Mail
-            {"Post|/characters/{character_id}/mail/", "Mail created"},
-            {"Post|/characters/{character_id}/mail/labels/", "Label created"},
-            {"Delete|/characters/{character_id}/mail/labels/{label_id}/", "Label deleted"},
-            {"Put|/characters/{character_id}/mail/{mail_id}/", "Mail updated"},
-            {"Delete|/characters/{character_id}/mail/{mail_id}/", "Mail deleted"},
+            {"POST|/characters/{character_id}/mail/", "Mail created"},
+            {"POST|/characters/{character_id}/mail/labels/", "Label created"},
+            {"DELETE|/characters/{character_id}/mail/labels/{label_id}/", "Label deleted"},
+            {"PUT|/characters/{character_id}/mail/{mail_id}/", "Mail updated"},
+            {"DELETE|/characters/{character_id}/mail/{mail_id}/", "Mail deleted"},
 
             //User Interface
-            {"Post|/ui/openwindow/marketdetails/", "Open window request received"},
-            {"Post|/ui/openwindow/contract/", "Open window request received"},
-            {"Post|/ui/openwindow/information/", "Open window request received"},
-            {"Post|/ui/autopilot/waypoint/", "Open window request received"},
-            {"Post|/ui/openwindow/newmail/", "Open window request received"}
+            {"POST|/ui/openwindow/marketdetails/", "Open window request received"},
+            {"POST|/ui/openwindow/contract/", "Open window request received"},
+            {"POST|/ui/openwindow/information/", "Open window request received"},
+            {"POST|/ui/autopilot/waypoint/", "Open window request received"},
+            {"POST|/ui/openwindow/newmail/", "Open window request received"}
         }.ToImmutableDictionary();
     }
-}
+}

ESI.NET/GetBuildVersion.psm1

@@ -0,0 +1,34 @@
+Function GetBuildVersion {
+    Param (
+        [string]$VersionString
+    )
+
+    # Process through regex
+    $VersionString -match "(?<major>\d+)(\.(?<minor>\d+))?(\.(?<patch>\d+))?(\-(?<pre>[0-9A-Za-z\-\.]+))?(\+(?<build>\d+))?" | Out-Null
+
+    if ($matches -eq $null) {
+        return "1.0.0-build"
+    }
+
+    # Extract the build metadata
+    $BuildRevision = [uint64]$matches['build']
+    # Extract the pre-release tag
+    $PreReleaseTag = [string]$matches['pre']
+    # Extract the patch
+    $Patch = [uint64]$matches['patch']
+    # Extract the minor
+    $Minor = [uint64]$matches['minor']
+    # Extract the major
+    $Major = [uint64]$matches['major']
+
+    $Version = [string]$Major + '.' + [string]$Minor + '.' + [string]$Patch;
+    if ($PreReleaseTag -ne [string]::Empty) {
+        $Version = $Version + '-' + $PreReleaseTag
+    }
+
+    if ($BuildRevision -ne 0) {
+        $Version = $Version + '.' + [string]$BuildRevision
+    }
+
+    return $Version
+}

ESI.NET/Logic/AllianceLogic.cs

@@ -19,15 +19,15 @@ public class AllianceLogic
         /// </summary>
         /// <returns></returns>
         public async Task<EsiResponse<int[]>> All()
-            => await Execute<int[]>(_client, _config, RequestSecurity.Public, RequestMethod.Get, "/alliances/");
+            => await Execute<int[]>(_client, _config, RequestSecurity.Public, HttpMethod.Get, "/alliances/");
 
         /// <summary>
         /// /alliances/{alliance_id}/
         /// </summary>
         /// <param name="allianceId"></param>
         /// <returns></returns>
         public async Task<EsiResponse<Alliance>> Information(int alliance_id)
-            => await Execute<Alliance>(_client, _config, RequestSecurity.Public, RequestMethod.Get, "/alliances/{alliance_id}/",
+            => await Execute<Alliance>(_client, _config, RequestSecurity.Public, HttpMethod.Get, "/alliances/{alliance_id}/",
                 replacements: new Dictionary<string, string>()
                 {
                     { "alliance_id", alliance_id.ToString() }
@@ -39,7 +39,7 @@ public async Task<EsiResponse<Alliance>> Information(int alliance_id)
         /// <param name="alliance_id"></param>
         /// <returns></returns>
         public async Task<EsiResponse<int[]>> Corporations(int alliance_id)
-            => await Execute<int[]>(_client, _config, RequestSecurity.Public, RequestMethod.Get, "/alliances/{alliance_id}/corporations/",
+            => await Execute<int[]>(_client, _config, RequestSecurity.Public, HttpMethod.Get, "/alliances/{alliance_id}/corporations/",
                 replacements: new Dictionary<string, string>()
                 {
                     { "alliance_id", alliance_id.ToString() }
@@ -51,7 +51,7 @@ public async Task<EsiResponse<int[]>> Corporations(int alliance_id)
         /// <param name="alliance_id"></param>
         /// <returns></returns>
         public async Task<EsiResponse<Images>> Icons(int alliance_id)
-            => await Execute<Images>(_client, _config, RequestSecurity.Public, RequestMethod.Get, "/alliances/{alliance_id}/icons/",
+            => await Execute<Images>(_client, _config, RequestSecurity.Public, HttpMethod.Get, "/alliances/{alliance_id}/icons/",
                 replacements: new Dictionary<string, string>()
                 {
                     { "alliance_id", alliance_id.ToString() }