ENH: refs #236. Add an optional "head" param to midas.item.get

Author: zachmullen

modules/api/controllers/components/ApiComponent.php

@@ -737,6 +737,7 @@ function folderDownload($args)
    * Get an item's information
    * @param token (Optional) Authentication token
    * @param id The item id
+   * @param head (Optional) only list the most recent revision
    * @return The item object
    */
   function itemGet($args)
@@ -755,8 +756,16 @@ function itemGet($args)
       }
 
     $itemArray = $item->toArray();
-    $revisions = $item->getRevisions();
     $revisionsArray = array();
+
+    if(array_key_exists('head', $args))
+      {
+      $revisions = array($itemModel->getLastRevision($item));
+      }
+    else //get all revisions
+      {
+      $revisions = $item->getRevisions();
+      }
     foreach($revisions as $revision)
       {
       $bitstreamArray = array();

modules/api/tests/controllers/ApiCallMethodsTest.php

@@ -19,8 +19,8 @@ public function setUp()
     $this->setupDatabase(array('default')); //core dataset
     $this->setupDatabase(array('default'), 'api'); // module dataset
     $this->enabledModules = array('api');
-    $this->_models = array('User', 'Folder');
-    $this->_daos = array('User', 'Folder');
+    $this->_models = array('User', 'Folder', 'Item');
+    $this->_daos = array('User', 'Folder', 'Item');
 
     parent::setUp();
     }
@@ -164,6 +164,46 @@ public function testFolderChildren()
     $this->assertEquals($resp->data->items[1]->description, 'Description 2');
     }
 
+  /** Test the item.get method */
+  public function testItemGet()
+    {
+    $itemsFile = $this->loadData('Item', 'default');
+    $itemDao = $this->Item->load($itemsFile[0]->getKey());
+
+    $this->resetAll();
+    $token = $this->_loginUsingApiKey();
+    $this->params['token'] = $token;
+    $this->params['method'] = 'midas.item.get';
+    $this->params['id'] = $itemsFile[0]->getKey();
+    $this->request->setMethod('POST');
+    $resp = $this->_callJsonApi();
+    $this->_assertStatusOk($resp);
+
+    $this->assertEquals($resp->data->item_id, $itemDao->getKey());
+    $this->assertEquals($resp->data->uuid, $itemDao->getUuid());
+    $this->assertEquals($resp->data->description, $itemDao->getDescription());
+    $this->assertTrue(is_array($resp->data->revisions));
+    $this->assertEquals(count($resp->data->revisions), 2); //make sure we get both revisions
+    $this->assertTrue(is_array($resp->data->revisions[0]->bitstreams));
+    $this->assertEquals($resp->data->revisions[0]->revision, '1');
+    $this->assertEquals($resp->data->revisions[1]->revision, '2');
+
+    // Test the 'head' parameter
+    $this->resetAll();
+    $token = $this->_loginUsingApiKey();
+    $this->params['token'] = $token;
+    $this->params['method'] = 'midas.item.get';
+    $this->params['id'] = $itemsFile[0]->getKey();
+    $this->params['head'] = 'true';
+    $this->request->setMethod('POST');
+    $resp = $this->_callJsonApi();
+    $this->_assertStatusOk($resp);
+
+    $this->assertEquals(count($resp->data->revisions), 1); //make sure we get only one revision
+    $this->assertTrue(is_array($resp->data->revisions[0]->bitstreams));
+    $this->assertEquals($resp->data->revisions[0]->revision, '2');
+    }
+
   /** Test get user's default API key using username and password */
   public function testUserApikeyDefault()
     {