Add /object/links to http-api

Author: fbaiodias

src/http-api/resources/object.js

@@ -214,3 +214,32 @@ exports.data = {
     })
   }
 }
+
+exports.links = {
+  // uses common parseKey method that returns a `key`
+  parseArgs: exports.parseKey,
+
+  // main route handler which is called after the above `parseArgs`, but only if the args were valid
+  handler: (request, reply) => {
+    const key = request.pre.args.key
+
+    ipfs.object.links(key, (err, links) => {
+      if (err) {
+        log.error(err)
+        return reply({
+          Message: 'Failed to get object: ' + err,
+          Code: 0
+        }).code(500)
+      }
+
+      return reply({
+        Hash: bs58.encode(key).toString(),
+        Links: links.map((link) => ({
+          Name: link.name,
+          Hash: bs58.encode(link.hash).toString(),
+          Size: link.size
+        }))
+      })
+    })
+  }
+}

src/http-api/routes/object.js

@@ -61,4 +61,15 @@ module.exports = (server) => {
       handler: resources.object.data.handler
     }
   })
+
+  api.route({
+    method: '*',
+    path: '/api/v0/object/links',
+    config: {
+      pre: [
+        { method: resources.object.links.parseArgs, assign: 'args' }
+      ],
+      handler: resources.object.links.handler
+    }
+  })
 }

tests/test-http-api/test-object.js

@@ -223,6 +223,49 @@ describe('object', () => {
         })
       })
     })
+
+    describe('/object/links', () => {
+      it('returns 400 for request without argument', (done) => {
+        api.inject({
+          method: 'GET',
+          url: '/api/v0/object/links'
+        }, (res) => {
+          expect(res.statusCode).to.equal(400)
+          expect(res.result).to.be.a('string')
+          done()
+        })
+      })
+
+      it('returns 500 for request with invalid argument', (done) => {
+        api.inject({
+          method: 'GET',
+          url: '/api/v0/object/links?arg=invalid'
+        }, (res) => {
+          expect(res.statusCode).to.equal(500)
+          expect(res.result.Code).to.equal(0)
+          expect(res.result.Message).to.be.a('string')
+          done()
+        })
+      })
+
+      it('returns value', (done) => {
+        const expectedResult = {
+          Hash: 'QmZZmY4KCu9r3e7M2Pcn46Fc5qbn6NpzaAGaYb22kbfTqm',
+          Links: [
+            { Name: 'some link', Hash: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39V', Size: 8 }
+          ]
+        }
+
+        api.inject({
+          method: 'GET',
+          url: '/api/v0/object/links?arg=QmZZmY4KCu9r3e7M2Pcn46Fc5qbn6NpzaAGaYb22kbfTqm'
+        }, (res) => {
+          expect(res.statusCode).to.equal(200)
+          expect(res.result).to.deep.equal(expectedResult)
+          done()
+        })
+      })
+    })
   })
 
   describe('using js-ipfs-api', () => {
@@ -351,5 +394,36 @@ describe('object', () => {
         })
       })
     })
+
+    describe('ipfs.object.links', () => {
+      it('returns error for request without argument', (done) => {
+        ctl.object.links(null, (err, result) => {
+          expect(err).to.exist
+          done()
+        })
+      })
+
+      it('returns error for request with invalid argument', (done) => {
+        ctl.object.links('invalid', (err, result) => {
+          expect(err).to.exist
+          done()
+        })
+      })
+
+      it('returns value', (done) => {
+        const expectedResult = {
+          Hash: 'QmZZmY4KCu9r3e7M2Pcn46Fc5qbn6NpzaAGaYb22kbfTqm',
+          Links: [
+            { Name: 'some link', Hash: 'QmXg9Pp2ytZ14xgmQjYEiHjVjMFXzCVVEcRTWJBmLgR39V', Size: 8 }
+          ]
+        }
+
+        ctl.object.links('QmZZmY4KCu9r3e7M2Pcn46Fc5qbn6NpzaAGaYb22kbfTqm', (err, result) => {
+          expect(err).to.not.exist
+          expect(result).to.deep.equal(expectedResult)
+          done()
+        })
+      })
+    })
   })
 })