Merge pull request #42 from apiarian/pin-list

pin/ls command exposed through Pins() method

Author: Kubuxu

shell.go

@@ -307,6 +307,41 @@ func (s *Shell) Unpin(path string) error {
 	return nil
 }
 
+const (
+	DirectPin    = "direct"
+	RecursivePin = "recursive"
+	IndirectPin  = "indirect"
+)
+
+type PinInfo struct {
+	Type string
+}
+
+// Pins returns a map of the pin hashes to their info (currently just the
+// pin type, one of DirectPin, RecursivePin, or IndirectPin. A map is returned
+// instead of a slice because it is easier to do existence lookup by map key
+// than unordered array searching. The map is likely to be more useful to a
+// client than a flat list.
+func (s *Shell) Pins() (map[string]PinInfo, error) {
+	resp, err := s.newRequest("pin/ls").Send(s.httpcli)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Close()
+
+	if resp.Error != nil {
+		return nil, resp.Error
+	}
+
+	raw := struct{ Keys map[string]PinInfo }{}
+	err = json.NewDecoder(resp.Output).Decode(&raw)
+	if err != nil {
+		return nil, err
+	}
+
+	return raw.Keys, nil
+}
+
 type PeerInfo struct {
 	Addrs []string
 	ID    string

shell_test.go

@@ -92,6 +92,40 @@ func TestFileList(t *testing.T) {
 	}
 }
 
+func TestPins(t *testing.T) {
+	is := is.New(t)
+	s := NewShell(shellUrl)
+
+	// Add a thing, which pins it by default
+	h, err := s.Add(bytes.NewBufferString("go-ipfs-api pins test 9F3D1F30-D12A-4024-9477-8F0C8E4B3A63"))
+	is.Nil(err)
+
+	pins, err := s.Pins()
+	is.Nil(err)
+
+	_, ok := pins[h]
+	is.True(ok)
+
+	err = s.Unpin(h)
+	is.Nil(err)
+
+	pins, err = s.Pins()
+	is.Nil(err)
+
+	_, ok = pins[h]
+	is.False(ok)
+
+	err = s.Pin(h)
+	is.Nil(err)
+
+	pins, err = s.Pins()
+	is.Nil(err)
+
+	info, ok := pins[h]
+	is.True(ok)
+	is.Equal(info.Type, RecursivePin)
+}
+
 func TestPatch_rmLink(t *testing.T) {
 	is := is.New(t)
 	s := NewShell(shellUrl)