Add Snapshots api

Author: nicholi

DigitalOcean.API.Tests/Clients/SnapshotsClientTest.cs

@@ -0,0 +1,61 @@
+using System.Collections.Generic;
+using DigitalOcean.API.Clients;
+using DigitalOcean.API.Http;
+using DigitalOcean.API.Models.Responses;
+using NSubstitute;
+using RestSharp;
+using Xunit;
+
+namespace DigitalOcean.API.Tests.Clients {
+    public class SnapshotsClientTest {
+        [Fact]
+        public void CorrectRequestForGetAll() {
+            var factory = Substitute.For<IConnection>();
+            var client = new SnapshotsClient(factory);
+
+            client.GetAll();
+            factory.Received().GetPaginated<Snapshot>("snapshots", null, "snapshots");
+        }
+
+        [Fact]
+        public void CorrectRequestForGetAllDroplet() {
+            var factory = Substitute.For<IConnection>();
+            var client = new SnapshotsClient(factory);
+
+            client.GetAllDroplet();
+            factory.Received().GetPaginated<Snapshot>("snapshots?resource_type=droplet", null, "snapshots");
+        }
+
+        [Fact]
+        public void CorrectRequestForGetAllVolume() {
+            var factory = Substitute.For<IConnection>();
+            var client = new SnapshotsClient(factory);
+
+            client.GetAllVolume();
+            factory.Received().GetPaginated<Snapshot>("snapshots?resource_type=volume", null, "snapshots");
+        }
+
+        [Fact]
+        public void CorrectRequestForGet() {
+            var factory = Substitute.For<IConnection>();
+            var client = new SnapshotsClient(factory);
+
+            client.Get("snapshot:abc123");
+
+            var parameters = Arg.Is<List<Parameter>>(list => (string)list[0].Value == "snapshot:abc123");
+            factory.Received().ExecuteRequest<Snapshot>("snapshots/{snapshot_id}", parameters, null, "snapshot");
+        }
+
+        [Fact]
+        public void CorrectRequestForDelete() {
+            var factory = Substitute.For<IConnection>();
+            var client = new SnapshotsClient(factory);
+
+            client.Delete("snapshot:abc123");
+
+            var parameters = Arg.Is<List<Parameter>>(list => (string)list[0].Value == "snapshot:abc123");
+            factory.Received().ExecuteRaw("snapshots/{snapshot_id}", parameters, null, Method.DELETE);
+        }
+
+    }
+}

DigitalOcean.API/Clients/ISnapshotsClient.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using DigitalOcean.API.Models.Responses;
+
+namespace DigitalOcean.API.Clients {
+    public interface ISnapshotsClient {
+        /// <summary>
+        /// To list all of the snapshots available on your account.
+        /// </summary>
+        Task<IReadOnlyList<Snapshot>> GetAll();
+
+        /// <summary>
+        /// To retrieve only snapshots based on Droplets.
+        /// </summary>
+        Task<IReadOnlyList<Snapshot>> GetAllDroplet();
+
+        /// <summary>
+        /// To retrieve only snapshots based on volumes.
+        /// </summary>
+        Task<IReadOnlyList<Snapshot>> GetAllVolume();
+
+        /// <summary>
+        /// To retrieve information about a snapshot,
+        /// </summary>
+        Task<Snapshot> Get(string snapshotId);
+
+        /// <summary>
+        /// To delete a snapshot.
+        /// </summary>
+        Task Delete(string snapshotId);
+    }
+}

DigitalOcean.API/Clients/SnapshotsClient.cs

@@ -0,0 +1,56 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using DigitalOcean.API.Http;
+using DigitalOcean.API.Models.Responses;
+using RestSharp;
+
+namespace DigitalOcean.API.Clients {
+    public class SnapshotsClient : ISnapshotsClient {
+        private readonly IConnection _connection;
+
+        public SnapshotsClient(IConnection connection) {
+            _connection = connection;
+        }
+
+        /// <summary>
+        /// To list all of the snapshots available on your account.
+        /// </summary>
+        public Task<IReadOnlyList<Snapshot>> GetAll() {
+            return _connection.GetPaginated<Snapshot>("snapshots", null, "snapshots");
+        }
+
+        /// <summary>
+        /// To retrieve only snapshots based on Droplets.
+        /// </summary>
+        public Task<IReadOnlyList<Snapshot>> GetAllDroplet() {
+            return _connection.GetPaginated<Snapshot>("snapshots?resource_type=droplet", null, "snapshots");
+        }
+
+        /// <summary>
+        /// To retrieve only snapshots based on volumes.
+        /// </summary>
+        public Task<IReadOnlyList<Snapshot>> GetAllVolume() {
+            return _connection.GetPaginated<Snapshot>("snapshots?resource_type=volume", null, "snapshots");
+        }
+
+        /// <summary>
+        /// To retrieve information about a snapshot,
+        /// </summary>
+        public Task<Snapshot> Get(string snapshotId) {
+            var parameters = new List<Parameter> {
+                new Parameter { Name = "snapshot_id", Value = snapshotId, Type = ParameterType.UrlSegment }
+            };
+            return _connection.ExecuteRequest<Snapshot>("snapshots/{snapshot_id}", parameters, null, "snapshot");
+        }
+
+        /// <summary>
+        /// To delete a snapshot.
+        /// </summary>
+        public Task Delete(string snapshotId) {
+            var parameters = new List<Parameter> {
+                new Parameter { Name = "snapshot_id", Value = snapshotId, Type = ParameterType.UrlSegment }
+            };
+            return _connection.ExecuteRaw("snapshots/{snapshot_id}", parameters, null, Method.DELETE);
+        }
+    }
+}

DigitalOcean.API/DigitalOceanClient.cs

@@ -29,6 +29,7 @@ public DigitalOceanClient(string token) {
 			Keys = new KeysClient(_connection);
             Regions = new RegionsClient(_connection);
             Sizes = new SizesClient(_connection);
+            Snapshots = new SnapshotsClient(_connection);
             Tags = new TagsClient(_connection);
         }
 
@@ -52,6 +53,7 @@ public IRateLimit Rates {
         public IProjectResourcesClient ProjectResources { get; private set; }
 		public IRegionsClient Regions { get; private set; }
         public ISizesClient Sizes { get; private set; }
+        public ISnapshotsClient Snapshots { get; private set; }
         public ITagsClient Tags { get; private set; }
 
 		#endregion

DigitalOcean.API/IDigitalOceanClient.cs

@@ -17,6 +17,7 @@ public interface IDigitalOceanClient {
         IProjectResourcesClient ProjectResources { get; }
         IRegionsClient Regions { get; }
         ISizesClient Sizes { get; }
+        ISnapshotsClient Snapshots { get; }
 
         IRateLimit Rates { get; }
         ITagsClient Tags { get; }

DigitalOcean.API/Models/Responses/Snapshot.cs

@@ -0,0 +1,56 @@
+using System;
+using System.Collections.Generic;
+
+namespace DigitalOcean.API.Models.Responses {
+    /// <summary>
+    /// Snapshots are saved instances of a Droplet or a block storage volume, which is reflected in the resource_type attribute.
+    /// In order to avoid problems with compressing filesystems, each defines a min_disk_size attribute which is the minimum size of the
+    /// Droplet or volume disk when creating a new resource from the saved snapshot.
+    /// </summary>
+    public class Snapshot {
+        /// <summary>
+        /// The unique identifier for the snapshot.
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        /// A human-readable name for the snapshot.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// A time value given in ISO8601 combined date and time format that represents when the snapshot was created.
+        /// </summary>
+        public DateTime CreatedAt { get; set; }
+
+        /// <summary>
+        /// An array of the regions that the image is available in. The regions are represented by their identifying slug values.
+        /// </summary>
+        public List<string> Regions { get; set; }
+
+        /// <summary>
+        /// A unique identifier for the resource that the action is associated with.
+        /// </summary>
+        public string ResourceId { get; set; }
+
+        /// <summary>
+        /// The type of resource that the action is associated with.
+        /// </summary>
+        public string ResourceType { get; set; }
+
+        /// <summary>
+        /// The minimum size in GB required for a volume or Droplet to use this snapshot.
+        /// </summary>
+        public int MinDiskSize { get; set; }
+
+        /// <summary>
+        /// The billable size of the snapshot in gigabytes.
+        /// </summary>
+        public double SizeGigabytes { get; set; }
+
+        /// <summary>
+        /// An array of Tags the snapshot has been tagged with
+        /// </summary>
+        public List<string> Tags { get; set; }
+    }
+}