Merge pull request #600 from carolynvs/filter-flavors

Enable paging/filtering flavors

Author: carolynvs

src/corelib/Compute/v2_1/ComputeService.cs

@@ -222,15 +222,15 @@ public ComputeService(IAuthenticationProvider authenticationProvider, string reg
         }
 
         /// <inheritdoc cref="ComputeApi.ListFlavorSummariesAsync{T}" />
-        public async Task<IEnumerable<FlavorSummary>> ListFlavorSummariesAsync(CancellationToken cancellationToken = default(CancellationToken))
+        public async Task<IPage<FlavorSummary>> ListFlavorSummariesAsync(FlavorListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return await _computeApi.ListFlavorSummariesAsync<FlavorSummaryCollection>(cancellationToken).ConfigureAwait(false);
+            return await _computeApi.ListFlavorSummariesAsync<FlavorSummaryCollection>(options, cancellationToken).ConfigureAwait(false);
         }
 
         /// <inheritdoc cref="ComputeApi.ListFlavorsAsync{T}" />
-        public async Task<IEnumerable<Flavor>> ListFlavorsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        public async Task<IPage<Flavor>> ListFlavorsAsync(FlavorListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return await _computeApi.ListFlavorsAsync<FlavorCollection>(cancellationToken).ConfigureAwait(false);
+            return await _computeApi.ListFlavorsAsync<FlavorCollection>(options, cancellationToken).ConfigureAwait(false);
         }
 
         #endregion

src/corelib/Compute/v2_1/FlavorListOptions.cs

@@ -0,0 +1,30 @@
+using System.Collections.Generic;
+
+namespace OpenStack.Compute.v2_1
+{
+    /// <summary>
+    /// Optional filter and paging options when listing flavors.
+    /// </summary>
+    public class FlavorListOptions : PageOptions
+    {
+        /// <summary>
+        /// The minimum disk size provided by the flavor.
+        /// </summary>
+        public int? MininumDiskSize { get; set; }
+
+        /// <summary>
+        /// The minimum amount of RAM provided by the flavor.
+        /// </summary>
+        public int? MininumMemorySize { get; set; }
+
+        /// <summary />
+        protected override IDictionary<string, object> BuildQueryString()
+        {
+            var queryString = base.BuildQueryString();
+            queryString["minDisk"] = MininumDiskSize;
+            queryString["minRam"] = MininumMemorySize;
+
+            return queryString;
+        }
+    }
+}

src/corelib/Compute/v2_1/Serialization/ComputeApi.cs

@@ -858,47 +858,57 @@ protected ComputeApi(IServiceType serviceType, IAuthenticationProvider authentic
         /// <summary>
         /// Lists summary information for available flavors.
         /// </summary>
-        /// <typeparam name="T">The return type.</typeparam>
+        /// <typeparam name="TPage">The return type.</typeparam>
+        /// <param name="queryString">Options for paging and filtering.</param>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
-        public virtual async Task<T> ListFlavorSummariesAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
-            where T : IEnumerable<IServiceResource>
+        public virtual async Task<TPage> ListFlavorSummariesAsync<TPage>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where TPage : IPageBuilder<TPage>, IEnumerable<IServiceResource>
         {
-            return await BuildListFlavorSummariesRequest(cancellationToken)
-                .SendAsync()
-                .ReceiveJson<T>()
+            Url initialRequestUrl = await BuildListFlavorSummariesURL(queryString, cancellationToken).ConfigureAwait(false);
+            return await Endpoint.GetResourcePageAsync<TPage>(initialRequestUrl, cancellationToken)
                 .PropogateOwnerToChildren(this).ConfigureAwait(false);
         }
 
         /// <summary>
         /// Builds the <see cref="ListFlavorSummariesAsync{T}"/> request.
         /// </summary>
+        /// <param name="queryString">Options for paging and filtering.</param>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
-        public virtual Task<PreparedRequest> BuildListFlavorSummariesRequest(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task<Url> BuildListFlavorSummariesURL(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return Endpoint.PrepareListResourcesRequest("flavors", cancellationToken);
+            Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
+
+            return endpoint
+                .AppendPathSegment("flavors")
+                .SetQueryParams(queryString?.Build());
         }
 
         /// <summary>
         /// Lists available flavors.
         /// </summary>
-        /// <typeparam name="T">The return type.</typeparam>
+        /// <typeparam name="TPage">The return type.</typeparam>
+        /// <param name="queryString">Options for paging and filtering.</param>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
-        public virtual async Task<T> ListFlavorsAsync<T>(CancellationToken cancellationToken = default(CancellationToken))
-            where T : IEnumerable<IServiceResource>
+        public virtual async Task<TPage> ListFlavorsAsync<TPage>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where TPage : IPageBuilder<TPage>, IEnumerable<IServiceResource>
         {
-            return await BuildListFlavorsRequest(cancellationToken)
-                .SendAsync()
-                .ReceiveJson<T>()
+            Url initialRequestUrl = await BuildListFlavorsURL(queryString, cancellationToken).ConfigureAwait(false);
+            return await Endpoint.GetResourcePageAsync<TPage>(initialRequestUrl, cancellationToken)
                 .PropogateOwnerToChildren(this).ConfigureAwait(false);
         }
 
         /// <summary>
-        /// Builds the <see cref="ListFlavorsAsync{T}"/> request.
+        /// Builds the <see cref="ListFlavorsAsync{T}"/> URL.
         /// </summary>
+        /// <param name="queryString">Options for paging and filtering.</param>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
-        public virtual Task<PreparedRequest> BuildListFlavorsRequest(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task<Url> BuildListFlavorsURL(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return Endpoint.PrepareListResourcesRequest("flavors/detail", cancellationToken);
+            Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
+
+            return endpoint
+                .AppendPathSegment("flavors/detail")
+                .SetQueryParams(queryString?.Build());
         }
 
         #endregion

src/corelib/Compute/v2_1/Serialization/FlavorCollection.cs

@@ -8,23 +8,28 @@ namespace OpenStack.Compute.v2_1.Serialization
     /// Represents a collection of flavor resources of the <see cref="ComputeService"/>.
     /// </summary>
     /// <exclude />
-    public class FlavorCollection<T> : ResourceCollection<T>
-        where T : IServiceResource
+    public class FlavorCollection<TPage, TItem> : Page<TPage, TItem, PageLink>
+        where TPage : FlavorCollection<TPage, TItem>
+        where TItem : IServiceResource
     {
-        /// <summary />
+        /// <summary/>
         [JsonProperty("flavors")]
-        protected IList<T> Flavors => Items;
+        protected IList<TItem> Flavors => Items;
+
+        /// <summary/>
+        [JsonProperty("flavors_links")]
+        protected IList<PageLink> FlavorLinks => Links;
     }
 
     /// <summary>
     /// Represents a collection of flavor summary resources of the <see cref="ComputeService"/>.
     /// </summary>
     /// <exclude />
-    public class FlavorSummaryCollection : FlavorCollection<FlavorSummary>
+    public class FlavorSummaryCollection : FlavorCollection<FlavorSummaryCollection, FlavorSummary>
     { }
 
-    /// <inheritdoc cref="FlavorCollection{T}" />
+    /// <inheritdoc cref="FlavorCollection{TPage, TItem}" />
     /// <exclude />
-    public class FlavorCollection : FlavorCollection<Flavor>
+    public class FlavorCollection : FlavorCollection<FlavorCollection, Flavor>
     { }
 }

src/corelib/Compute/v2_1/Serialization/ImageCollection.cs

@@ -28,7 +28,7 @@ public class ImageCollection<TPage, TItem> : Page<TPage, TItem, PageLink>
     public class ImageSummaryCollection : ImageCollection<ImageSummaryCollection, ImageSummary>
     { }
 
-    /// <inheritdoc cref="FlavorCollection{T}" />
+    /// <inheritdoc cref="ImageCollection{TPage, TItem}" />
     /// <exclude />
     public class ImageCollection : ImageCollection<ImageCollection, Image>
     { }

src/corelib/OpenStack.csproj

@@ -97,6 +97,7 @@
     <Compile Include="Compute\v2_1\AddressType.cs" />
     <Compile Include="Compute\v2_1\Flavor.cs" />
     <Compile Include="Compute\v2_1\FlavorReference.cs" />
+    <Compile Include="Compute\v2_1\FlavorListOptions.cs" />
     <Compile Include="Compute\v2_1\NamespaceDoc.cs" />
     <Compile Include="Compute\v2_1\Operator\ComputeServiceExtensions.cs" />
     <Compile Include="Compute\v2_1\Operator\EvacuateServerRequest.cs" />