Add support for 'primary_photo_extras' in 'flickr.photosets.getList'

boncey · boncey · commit e93942540bb0 · 2014-11-09T16:24:41.000Z
diff --git a/Flickr4Java/src/main/java/com/flickr4java/flickr/photosets/PhotosetsInterface.java b/Flickr4Java/src/main/java/com/flickr4java/flickr/photosets/PhotosetsInterface.java
@@ -313,7 +313,23 @@ public Photoset getInfo(String photosetId) throws FlickrException {
      * @throws FlickrException
      */
     public Photosets getList(String userId) throws FlickrException {
-        return getList(userId, 0, 0);
+        return getList(userId, 0, 0, null);
+    }
+
+    /**
+     * Get a list of all photosets for the specified user.
+     * 
+     * This method does not require authentication. But to get a Photoset into the list, that contains just private photos, the call needs to be authenticated.
+     * 
+     * @param userId
+     *            The User id
+     * @param primaryPhotoExtras
+     *            A comma-delimited list of extra information to fetch for the primary photo
+     * @return The Photosets collection
+     * @throws FlickrException
+     */
+    public Photosets getList(String userId, String primaryPhotoExtras) throws FlickrException {
+        return getList(userId, 0, 0, primaryPhotoExtras);
     }
 
     /**
@@ -327,10 +343,12 @@ public Photosets getList(String userId) throws FlickrException {
      *            The number of photosets per page
      * @param page
      *            The page offset
+     * @param primaryPhotoExtras
+     *            A comma-delimited list of extra information to fetch for the primary photo
      * @return The Photosets collection
      * @throws FlickrException
      */
-    public Photosets getList(String userId, int perPage, int page) throws FlickrException {
+    public Photosets getList(String userId, int perPage, int page, String primaryPhotoExtras) throws FlickrException {
         Map<String, Object> parameters = new HashMap<String, Object>();
         parameters.put("method", METHOD_GET_LIST);
 
@@ -346,6 +364,10 @@ public Photosets getList(String userId, int perPage, int page) throws FlickrExce
             parameters.put("page", String.valueOf(page));
         }
 
+        if (primaryPhotoExtras != null) {
+            parameters.put("primary_photo_extras", primaryPhotoExtras);
+        }
+
         Response response = transportAPI.get(transportAPI.getPath(), parameters, apiKey, sharedSecret);
         if (response.isError()) {
             throw new FlickrException(response.getErrorCode(), response.getErrorMessage());
@@ -368,7 +390,13 @@ public Photosets getList(String userId, int perPage, int page) throws FlickrExce
             owner.setId(photosetElement.getAttribute("owner"));
             photoset.setOwner(owner);
 
-            Photo primaryPhoto = new Photo();
+            Element primaryPhotoExtrasEl = XMLUtilities.getChild(photosetElement, "primary_photo_extras");
+            Photo primaryPhoto;
+            if (primaryPhotoExtrasEl != null) {
+                primaryPhoto = PhotoUtils.createPhoto(primaryPhotoExtrasEl);
+            } else {
+                primaryPhoto = new Photo();
+            }
             primaryPhoto.setId(photosetElement.getAttribute("primary"));
             primaryPhoto.setSecret(photosetElement.getAttribute("secret")); // TODO verify that this is the secret for the photo
             primaryPhoto.setServer(photosetElement.getAttribute("server")); // TODO verify that this is the server for the photo
diff --git a/Flickr4Java/src/test/java/com/flickr4java/flickr/test/PhotosetsInterfaceTest.java b/Flickr4Java/src/test/java/com/flickr4java/flickr/test/PhotosetsInterfaceTest.java
@@ -20,6 +20,7 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 
@@ -118,10 +119,17 @@ public void testGetList() throws FlickrException {
     }
 
     @Test
-    public void testGetList2() throws FlickrException {
+    public void testGetListWithExtras() throws FlickrException {
         PhotosetsInterface iface = flickr.getPhotosetsInterface();
-        Photosets photosets = iface.getList("26095690@N00");
+        Photosets photosets = iface.getList(testProperties.getNsid(), "last_update, owner_name");
         assertNotNull(photosets);
+        Collection<Photoset> photosetsList = photosets.getPhotosets();
+        assertFalse(photosetsList.isEmpty());
+        Photoset photoset = photosetsList.iterator().next();
+        assertNotNull(photoset.getPrimaryPhoto().getLastUpdate());
+        assertNotNull(photoset.getPrimaryPhoto().getOwner());
+        assertNotNull(photoset.getPrimaryPhoto().getOwner().getUsername());
+        assertTrue(photoset.getPrimaryPhoto().getOwner().getUsername().length() > 0);
     }
 
     @Test
