Get information about project (#70)

* Get information about project

* Fix inline docs for service class

* Update BaseFixture.cs

* Fix test for user filter

* Use gitversion as msbuild task

* Update appveyor.yml

* Update UserFilter.cs

Author: nvborisenko

appveyor.yml

@@ -1,24 +1,23 @@
 image: Visual Studio 2019
 
+environment:
+  IGNORE_NORMALISATION_GIT_HEAD_MOVE: 1
+
 install:
-  - gitversion /l console /output buildserver
   - dotnet tool install -g codecov.tool
 
 configuration:
   - Release
 
-dotnet_csproj:
-  patch: true
-  version: '$(GitVersion_SemVer)'
-
 build_script:
   - dotnet pack
 
-after_build:
-  - appveyor PushArtifact src\ReportPortal.Client\bin\%configuration%\ReportPortal.Client.%GitVersion_SemVer%.nupkg
-
 test_script:
   - dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=OpenCover /p:CoverletOutput=./Coverage.xml
 
 after_test:
-  - codecov -f test\ReportPortal.Client.IntegrationTests\Coverage.*.xml
+  - codecov -f test\ReportPortal.Client.IntegrationTests\Coverage.*.xml
+
+artifacts:
+  - path: '**\*.nupkg'
+  - path: '**\*.html'

src/ReportPortal.Client/Abstractions/Requests/CreateUserFilterRequest.cs

@@ -31,25 +31,31 @@ public class CreateUserFilterRequest
         public IEnumerable<Condition> Conditions { get; set; }
 
         /// <summary>
-        /// list of parameters of selection
+        /// List of parameters of selection.
         /// </summary>
         [DataMember(Name = "orders")]
         public IEnumerable<FilterOrder> Orders { get; set; }
 
         /// <summary>
-        /// is filter shared
+        /// Indicates if filter is shared.
         /// </summary>
         [DataMember(Name = "share")]
         public bool IsShared { get; set; }
 
         /// <summary>
-        /// filter type
+        /// Filter type.
         /// </summary>
         [DataMember(Name = "type")]
         public string TypeStr { get; set; }
 
         /// <summary>
-        /// user filter type enum
+        /// Owner of the filter.
+        /// </summary>
+        [DataMember(Name = "owner")]
+        public string Owner { get; set; }
+
+        /// <summary>
+        /// User filter type enum.
         /// </summary>
         public UserFilterType UserFilterType
         {

src/ReportPortal.Client/Abstractions/Resources/IProjectResource.cs

@@ -1,10 +1,23 @@
 using ReportPortal.Client.Abstractions.Responses;
+using ReportPortal.Client.Abstractions.Responses.Project;
 using System.Threading.Tasks;
 
 namespace ReportPortal.Client.Abstractions.Resources
 {
     public interface IProjectResource
     {
+        /// <summary>
+        /// Returns information about current accosiated project.
+        /// </summary>
+        /// <returns>Project info.</returns>
+        Task<ProjectResponse> GetAsync();
+
+        /// <summary>
+        /// Returns information about project filtered by name.
+        /// </summary>
+        /// <returns>Project info.</returns>
+        Task<ProjectResponse> GetAsync(string projectName);
+
         /// <summary>
         /// Updates the project preference for user.
         /// </summary>
@@ -13,6 +26,6 @@ public interface IProjectResource
         /// <summary>
         /// Gets all user preferences.
         /// </summary>
-        Task<PreferenceResponse> GetAllPreferences(string projectName, string userName);
+        Task<PreferenceResponse> GetAllPreferencesAsync(string projectName, string userName);
     }
 }

src/ReportPortal.Client/Abstractions/Responses/PreferenceResponse.cs renamed to src/ReportPortal.Client/Abstractions/Responses/Project/PreferenceResponse.cs

@@ -1,7 +1,7 @@
 using System.Collections.Generic;
 using System.Runtime.Serialization;
 
-namespace ReportPortal.Client.Abstractions.Responses
+namespace ReportPortal.Client.Abstractions.Responses.Project
 {
     [DataContract]
     public class PreferenceResponse

src/ReportPortal.Client/Abstractions/Responses/Project/ProjectConfiguration.cs

@@ -0,0 +1,14 @@
+using System.Runtime.Serialization;
+
+namespace ReportPortal.Client.Abstractions.Responses.Project
+{
+    /// <summary>
+    /// Information about project.
+    /// </summary>
+    [DataContract]
+    public class ProjectConfiguration
+    {
+        [DataMember(Name = "subTypes")]
+        public ProjectDefectSubTypesContainer DefectSubTypes { get; set; }
+    }
+}

src/ReportPortal.Client/Abstractions/Responses/Project/ProjectDefectSubType.cs

@@ -0,0 +1,23 @@
+using System.Runtime.Serialization;
+
+namespace ReportPortal.Client.Abstractions.Responses.Project
+{
+    [DataContract]
+    public class ProjectDefectSubType
+    {
+        [DataMember(Name = "id")]
+        public long Id { get; set; }
+
+        [DataMember(Name = "color")]
+        public string Color { get; set; }
+
+        [DataMember(Name = "locator")]
+        public string Locator { get; set; }
+
+        [DataMember(Name = "longName")]
+        public string LongName { get; set; }
+
+        [DataMember(Name = "shortName")]
+        public string ShortName { get; set; }
+    }
+}

src/ReportPortal.Client/Abstractions/Responses/Project/ProjectDefectSubTypesContainer.cs

@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+
+namespace ReportPortal.Client.Abstractions.Responses.Project
+{
+    [DataContract]
+    public class ProjectDefectSubTypesContainer
+    {
+        [DataMember(Name = "PRODUCT_BUG")]
+        public IList<ProjectDefectSubType> ProductBugTypes { get; set; }
+
+        [DataMember(Name = "AUTOMATION_BUG")]
+        public IList<ProjectDefectSubType> AutomationBugTypes { get; set; }
+
+        [DataMember(Name = "SYSTEM_ISSUE")]
+        public IList<ProjectDefectSubType> SystemIssueTypes { get; set; }
+
+        [DataMember(Name = "TO_INVESTIGATE")]
+        public IList<ProjectDefectSubType> ToInvestigateTypes { get; set; }
+
+        [DataMember(Name = "NO_DEFECT")]
+        public IList<ProjectDefectSubType> NoDefectTypes { get; set; }
+    }
+}

src/ReportPortal.Client/Abstractions/Responses/Project/ProjectResponse.cs

@@ -0,0 +1,20 @@
+using System.Runtime.Serialization;
+
+namespace ReportPortal.Client.Abstractions.Responses.Project
+{
+    /// <summary>
+    /// Information about project.
+    /// </summary>
+    [DataContract]
+    public class ProjectResponse
+    {
+        [DataMember(Name = "projectId")]
+        public string Id { get; set; }
+
+        [DataMember(Name = "projectName")]
+        public string Name { get; set; }
+
+        [DataMember(Name = "configuration")]
+        public ProjectConfiguration Configuration { get; set; }
+    }
+}

src/ReportPortal.Client/ReportPortal.Client.csproj

@@ -26,4 +26,11 @@
 
     <None Include="..\..\Logo.png" Pack="true" PackagePath="\" Visible="false" />
   </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="GitVersion.MsBuild" Version="5.8.1">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 </Project>

src/ReportPortal.Client/Resources/ServiceProjectResource.cs

@@ -1,5 +1,6 @@
 using ReportPortal.Client.Abstractions.Resources;
 using ReportPortal.Client.Abstractions.Responses;
+using ReportPortal.Client.Abstractions.Responses.Project;
 using System.Net.Http;
 using System.Threading.Tasks;
 
@@ -12,14 +13,24 @@ public ServiceProjectResource(HttpClient httpClient, string project) : base(http
 
         }
 
+        public Task<ProjectResponse> GetAsync()
+        {
+            return GetAsJsonAsync<ProjectResponse>($"project/{this.ProjectName}");
+        }
+
+        public Task<ProjectResponse> GetAsync(string projectName)
+        {
+            return GetAsJsonAsync<ProjectResponse>($"project/{projectName}");
+        }
+
         public Task<MessageResponse> UpdatePreferencesAsync(string projectName, string userName, long filterId)
         {
             return PutAsJsonAsync<MessageResponse, object>(
                 $"project/{projectName}/preference/{userName}/{filterId}",
                 string.Empty);
         }
 
-        public Task<PreferenceResponse> GetAllPreferences(string projectName, string userName)
+        public Task<PreferenceResponse> GetAllPreferencesAsync(string projectName, string userName)
         {
             return GetAsJsonAsync<PreferenceResponse>($"project/{projectName}/preference/{userName}");
         }