API-1822 add media removal, add README, add null checks for collections

README.md

@@ -193,3 +193,165 @@ Response<List<Tag>> tagsResponse = assetService.getTags().blockingSingle();
 // Get media (request with query)
 Response<List<Media>> mediaResponse = assetService.getMediaList(new MediaQuery().setType(MediaType.IMAGE).setLimit(100).setPage(1)).blockingSingle();
 ```
+
+### Sample Files Functionality Testing
+
+Classes within `sample` contain code to execute corresponding functionalities. The purpose is to demonstrate how methods are called and provide a convenient method to execute functions.
+
+Within `src/main/resources` create an `app.properties` file. This file will be referenced from sample files. 
+
+Make sure all values are populated correctly before running sample files.
+
+Example `app.properties` file content:
+
+```
+# permanent token if using permanent token auth
+PERMANENT_TOKEN=<your auth permanent token>
+# portal url
+BASE_URL=https://portal.bynder.com
+# OAuth info
+REDIRECT_URI=https://google.com
+CLIENT_ID=<your OAuth2 client id>
+CLIENT_SECRET=<your OAuth2 client secret>
+# media id for info
+MEDIA_ID_FOR_INFO=5B8357A7-5DEB-4BC7-9CFBDEE1ECE120A9
+# media id for renaming
+MEDIA_ID_FOR_RENAME=5B8357A7-5DEB-4BC7-9CFBDEE1ECE120A9
+# media id for removal
+MEDIA_ID_FOR_REMOVAL=946A1800-6298-4201-AEB8F2830B07400E
+# collection id to get info for
+GET_COLLECTION_INFO_ID=615F03BB-D986-4786-B2C085D2F0718230
+# collection id to share
+SHARE_COLLECTION_ID=615F03BB-D986-4786-B2C085D2F0718230
+# recipient to receive shared collection
+[email protected]
+# media id to add to collection
+ADD_MEDIA_TO_COLLECTION_MEDIA_ID=C078E8EE-C13A-4DA5-86EC8D6F335364EB
+# collection id for media to be added to
+ADD_MEDIA_TO_COLLECTION_COLLECTION_ID=615F03BB-D986-4786-B2C085D2F0718230
+# collection id to remove asset from
+REMOVE_FROM_COLLECTION_ID=615F03BB-D986-4786-B2C085D2F0718230
+# media id to remove from collection
+REMOVE_MEDIA_ID_FROM_COLLECTION=C078E8EE-C13A-4DA5-86EC8D6F335364EB
+# media id used for creating asset usage
+MEDIA_ID_FOR_ASSET_USAGE=C078E8EE-C13A-4DA5-86EC8D6F335364EB
+# integration id used for asset usage
+INTEGRATION_ID_FOR_ASSET_USAGE=0191a303-9d99-433e-ada4-d244f37e1d7d
+```
+Within each sample file, OAuth credentials are read in from `app.properties`. 
+This will prompt the browser to open to retrieve an access code and then redirected to the redirect URI. 
+Access code is then provided from terminal prompt to retrieve an access token for API calls afterwards.
+
+
+#### Maven
+
+Make sure `mvn` CLI is installed.
+
+From root directory, dependencies can be installed from `pom.xml` using command:
+```bash
+mvn clean install -Dgpg.skip -Dmaven.javadoc.skip
+```
+
+#### Brands Sample
+
+Execute `BrandsSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.BrandsSample"
+```
+
+Methods Used:
+* getBrands()
+
+#### Collections Sample
+
+Execute `CollectionsSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.CollectionsSample"
+```
+
+Methods Used:
+* getCollections(collectionQuery)
+* getCollectionInfo(collectionInfoQuery)
+* createCollection(createCollectionQuery)
+* shareCollection(collectionShareQuery)
+* addMediaToCollection(collectionAddMediaQuery)
+* getCollectionMediaIds(addMediaCollectionInfoQuery)
+* removeMediaFromCollection(collectionRemoveMediaQuery)
+
+#### Media Sample
+
+Execute `MediaSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.MediaSample"
+```
+
+Methods Used:
+
+* getMediaList(mediaQuery)
+* getMediaInfo(mediaInfoQuery)
+* getMediaDownloadUrl(mediaDownloadQuery)
+* modifyMedia(modifyQuery)
+* getMediaInfo(mediaInfoQueryRename)
+* deleteMedia(mediaDeleteQuery)
+
+#### Metaproperties Sample
+
+Execute `MetapropertiesSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.MetapropertiesSample"
+```
+
+Methods Used:
+* getMetaproperties(metapropertyQuery)
+
+#### Smart Filters Sample
+
+Execute `SmartFiltersSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.SmartFiltersSample"
+```
+
+Methods Used:
+* getSmartfilters()
+* smartFilter.getMetaproperties()
+* smartFilter.getLabels()
+
+#### Tags Sample
+
+Execute `TagsSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.TagsSample"
+```
+
+Methods Used:
+* getTags()
+* 
+
+#### Upload Sample
+
+Execute `UploadSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.UploadSample"
+```
+
+Methods Used:
+* uploadFile(uploadQuery)
+
+#### Usage Sample
+
+Execute `UsageSample.java` file with command
+
+```bash
+mvn compile exec:java -Dexec.mainClass="com.bynder.sdk.sample.UsageSample"
+```
+Methods Used:
+* createUsage(usageCreateQuery)
+* getUsage(usageQuery)
+* deleteUsage(usageDeleteQuery)

src/main/java/com/bynder/sdk/sample/CollectionsSample.java

@@ -114,7 +114,7 @@ public static void main(final String[] args) throws URISyntaxException, IOExcept
  .setLoginRequired(false)
  .setSendMail(true)
  .setMessage("test");
- collectionService.shareCollection(collectionShareQuery);
+ collectionService.shareCollection(collectionShareQuery).blockingSingle();
 
  // addMediaToCollection
  String addMediaToCollectionId = appProperties.getProperty("ADD_MEDIA_TO_COLLECTION_COLLECTION_ID");
@@ -129,8 +129,10 @@ public static void main(final String[] args) throws URISyntaxException, IOExcept
  // get info about collection that had media added
  CollectionInfoQuery addMediaCollectionInfoQuery = new CollectionInfoQuery(addMediaToCollectionId);
  List<String> mediaIdsFromCollection = collectionService.getCollectionMediaIds(addMediaCollectionInfoQuery).blockingSingle().body();
- for (String mediaId : mediaIdsFromCollection) {
- LOG.info("media id: " + mediaId);
+ if (mediaIdsFromCollection != null && !mediaIdsFromCollection.isEmpty()) {
+ for (String mediaId : mediaIdsFromCollection) {
+ LOG.info("media id: " + mediaId);
+ }
  }
 
  // removeMediaFromCollection
@@ -139,13 +141,15 @@ public static void main(final String[] args) throws URISyntaxException, IOExcept
  String[] removeMediaIds = new String[] {mediaIdToRemove};
  LOG.info("removing media ids: " + mediaIdToRemove);
  CollectionRemoveMediaQuery collectionRemoveMediaQuery = new CollectionRemoveMediaQuery(removeFromCollectionId, removeMediaIds);
- collectionService.removeMediaFromCollection(collectionRemoveMediaQuery).blockingSingle();
+ collectionService.removeMediaFromCollection(collectionRemoveMediaQuery);
 
  // get updated media ids from collection after removal
  CollectionInfoQuery removeMediaCollectionInfoQuery = new CollectionInfoQuery(removeFromCollectionId);
  List<String> mediaIdsFromCollectionAfterRemoval = collectionService.getCollectionMediaIds(removeMediaCollectionInfoQuery).blockingSingle().body();
- for (String mediaId : mediaIdsFromCollectionAfterRemoval) {
- LOG.info("media id: " + mediaId);
+ if (mediaIdsFromCollectionAfterRemoval != null && !mediaIdsFromCollectionAfterRemoval.isEmpty()) {
+ for (String mediaId : mediaIdsFromCollectionAfterRemoval) {
+ LOG.info("media id: " + mediaId);
+ }
  }
  }
 }

src/main/java/com/bynder/sdk/sample/MediaSample.java

@@ -111,5 +111,11 @@ public static void main(final String[] args) throws URISyntaxException, IOExcept
  LOG.info(updatedFoundMedia.getName());
  LOG.info(updatedFoundMedia.getDescription());
  }
+
+ // remove media
+ String mediaToRemove = appProperties.getProperty("MEDIA_ID_FOR_REMOVAL");
+ MediaDeleteQuery mediaDeleteQuery = new MediaDeleteQuery(mediaToRemove);
+ LOG.info("Removing media id: " + mediaToRemove);
+ assetService.deleteMedia(mediaDeleteQuery).blockingSingle();
  }
 }