feat(pin): get a list of pinned objects

Author: richardschneider

src/IpfsApi.csproj

@@ -64,6 +64,9 @@
     <Compile Include="Add.cs" />
     <Compile Include="IpfsException.cs" />
     <Compile Include="MerkleNode.cs" />
+    <Compile Include="PinMode.cs" />
+    <Compile Include="PinnedObject.cs" />
+    <Compile Include="PinnedCollection .cs" />
     <Compile Include="TrustedPeerCollection.cs" />
     <Compile Include="Id.cs" />
     <Compile Include="PeerNode.cs" />

src/IpfsClient.cs

@@ -45,6 +45,7 @@ public IpfsClient()
             var version = Assembly.GetExecutingAssembly().GetName().Version;
             UserAgent = string.Format("net-ipfs/{0}.{1}", version.Major, version.Minor);
             TrustedPeers = new TruestedPeerCollection(this);
+            PinnedObjects = new PinnedCollection(this);
         }
 
         /// <summary>
@@ -83,6 +84,14 @@ public IpfsClient(string host)
         /// </remarks>
         public TruestedPeerCollection TrustedPeers { get; private set; }
 
+        /// <summary>
+        ///   The list of objects that are permanently stored on the local host.
+        /// </summary>
+        /// <remarks>
+        ///   This is equilivent to <c>ipfs pin ls</c>.
+        /// </remarks>
+        public PinnedCollection PinnedObjects { get; private set; }
+
         Uri BuildCommand(string command, string arg = null, params string[] options)
         {
             var url = "/api/v0/" + command;

src/PinMode.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Ipfs.Api
+{
+    /// <summary>
+    ///    The method used to pin an IPFS object.
+    /// </summary>
+    [Flags]
+    public enum PinMode
+    {
+        /// <summary>
+        ///   Pin the specific object, and indirectly pin all its decendants
+        /// </summary>
+        Recursive = 1,
+
+        /// <summary>
+        ///    Pin the specific object.
+        /// </summary>
+        Direct = 2,
+
+        /// <summary>
+        ///    Pinned indirectly by an ancestor (like a refcount)
+        /// </summary>
+        Indirect = 4,
+
+        /// <summary>
+        ///   Any 
+        /// </summary>
+        Any = 7
+    }
+}

src/PinnedCollection .cs

@@ -0,0 +1,135 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.IO;
+using System.Net;
+using Newtonsoft.Json.Linq;
+
+namespace Ipfs.Api
+{
+    /// <summary>
+    ///   A list of pinned object.
+    /// </summary>
+    /// <remarks>
+    ///   This is the list of objects that are permanently stored on the local host.
+    ///   <see cref="https://ipfs.io/ipfs/QmTkzDwWqPbnAh5YiV5VwcTLnGdwSNsNTn2aDxdXBFca7D/example#/ipfs/QmThrNbvLj7afQZhxH72m5Nn1qiVn3eMKWFYV49Zp2mv9B/pin/readme.md"/>ipfs pin</see> command.
+    /// </remarks>
+    /// <returns>
+    ///   A series of <see cref="PinnedObject"/>.
+    ///   </returns>
+    public class PinnedCollection : ICollection<PinnedObject>
+    {
+        IpfsClient ipfs;
+        PinnedObject[] pins;
+
+        internal PinnedCollection(IpfsClient ipfs)
+        {
+            this.ipfs = ipfs;
+        }
+
+        PinnedObject[] Pins
+        {
+            get
+            {
+                if (pins == null)
+                {
+                    Refresh();
+                }
+                return pins;
+            }
+        }
+
+        /// <inheritdoc />
+        public void Add(PinnedObject obj)
+        {
+            if (obj == null)
+                throw new ArgumentNullException();
+
+            throw new NotImplementedException();
+        }
+
+        /// <summary>
+        ///    Remove all the trusted peers.
+        /// </summary>
+        /// <remarks>
+        ///    Equivalent to <c>ipfs bootstrap rm --all</c>.
+        /// </remarks>
+        public void Clear()
+        {
+            throw new NotImplementedException();
+        }
+
+        /// <inheritdoc />
+        public bool Contains(PinnedObject item)
+        {
+            return Pins.Contains(item);
+        }
+
+        /// <inheritdoc />
+        public void CopyTo(PinnedObject[] array, int index)
+        {
+            Pins.CopyTo(array, index);
+        }
+
+        /// <inheritdoc />
+        public int Count
+        {
+            get
+            {
+                return Pins.Length;
+            }
+        }
+
+        /// <inheritdoc />
+        public bool IsReadOnly
+        {
+            get { return false; }
+        }
+
+        /// <summary>
+        ///    Remove the trusted peer.
+        /// </summary>
+        /// <remarks>
+        ///    Equivalent to <c>ipfs bootstrap rm <i>peer</i></c>.
+        /// </remarks>
+        public bool Remove(PinnedObject peer)
+        {
+            if (peer == null)
+                throw new ArgumentNullException();
+
+            throw new NotImplementedException();
+        }
+
+        /// <inheritdoc />
+        public IEnumerator<PinnedObject> GetEnumerator()
+        {
+            return ((IEnumerable<PinnedObject>) Pins).GetEnumerator();
+        }
+
+        /// <inheritdoc />
+        IEnumerator IEnumerable.GetEnumerator()
+        {
+            return Pins.GetEnumerator();
+        }
+
+        /// <summary>
+        ///   Ask IPFS for the pinned the objects.
+        /// </summary>
+        public void Refresh()
+        {
+            var json = ipfs.DoCommand("pin/ls");
+            var keys = (JObject) (JObject.Parse(json)["Keys"]);
+            pins = keys
+                .Properties()
+                .Select(p => new PinnedObject
+                {
+                    Id = p.Name,
+                    Mode = (PinMode)Enum.Parse(typeof(PinMode), (string) keys[p.Name]["Type"], true)
+                })
+                .ToArray();
+         }
+    }
+}

src/PinnedObject.cs

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+namespace Ipfs.Api
+{
+    /// <summary>
+    ///   An IPFS object that is permanently stored on the local host.
+    /// </summary>
+    public class PinnedObject
+    {
+        /// <summary>
+        ///   The <see cref="MultiHash"/> of the object.
+        /// </summary>
+        public string Id { get; set; }
+
+        /// <summary>
+        ///   The method used to pin the object.
+        /// </summary>
+        public PinMode Mode { get; set; }
+
+        /// <inheritdoc />
+        public override string ToString()
+        {
+            return Id + " " + Mode.ToString();
+        }
+
+    }
+}

test/IpfsApiTests.csproj

@@ -68,6 +68,7 @@
     <Compile Include="AddTest.cs" />
     <Compile Include="MerkleNodeTest.cs" />
     <Compile Include="ExceptionAssert.cs" />
+    <Compile Include="PinTest.cs" />
     <Compile Include="TrustedPeersTest.cs" />
     <Compile Include="IdTest.cs" />
     <Compile Include="VersionTest.cs" />

test/PinTest.cs

@@ -0,0 +1,21 @@
+using Ipfs.Api;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+using System.Linq;
+
+namespace Ipfs.Api
+{
+
+    public partial class IpfsClientTest
+    {
+
+        [TestMethod]
+        public void Pin_List()
+        {
+            var ipfs = new IpfsClient();
+            Assert.IsNotNull(ipfs.PinnedObjects);
+            Assert.IsTrue(ipfs.PinnedObjects.Count > 0);
+        }
+
+    }
+}