Merge pull request #94 from umbraco/feature/aprimo-integration

Feature/aprimo integration

Author: acoumb

src/Umbraco.Cms.Integrations.DAM.Aprimo/Models/ViewModels/AprimoMediaWithCropsViewModel.cs

@@ -12,14 +12,35 @@ public class AprimoMediaWithCropsViewModel
         /// </summary>
         /// <param name="name"></param>
         /// <returns>Crop URL</returns>
-        public string GetImageUrl(string name)
+        public string GetCropUrl(string name)
         {
             var crop = Crops.FirstOrDefault(p => p.Name == name);
             if (crop != null)
                 return crop.Url;
 
             return string.Empty;
         }
+
+        /// <summary>
+        /// Get image URL by size
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns>Crop URL</returns>
+        public string GetCropUrl(int? width, int? height)
+        {
+            if (!width.HasValue && !height.HasValue)
+                throw new ArgumentException("Width and height cannot be both NULL.");
+
+            var crop = width.HasValue && height.HasValue 
+                ? Crops.FirstOrDefault(p => p.ResizeWidth == width && p.ResizeHeight == height)
+                : (width.HasValue 
+                    ? Crops.FirstOrDefault(p => p.ResizeWidth == width)
+                    : Crops.FirstOrDefault(p => p.ResizeHeight == height));
+            if (crop != null)
+                return crop.Url;
+
+            return string.Empty;
+        }
     }
 
     public class AprimoMediaItemViewModel

src/Umbraco.Cms.Integrations.DAM.Aprimo/readme.md

@@ -1,4 +1,4 @@
-# Umbraco.Cms.Integrations.DAM.Aprimo
+# Umbraco.Cms.Integrations.DAM.Aprimo
 
 This integration provides a custom media picker for digital assets managed in an Aprimo workspace. It can be used as a property editor for content with a value converter providing a strongly typed model for rendering, as well as a sample rendering component.
 
@@ -78,5 +78,26 @@ Properties available from the strongly-typed model:
 - Crops
 - Asset fields
 
+### Working with Crops
+For the selected media asset you can retrieve the crops details using the `MediaWithCrops` object.
+ 
+It contains the details of the original asset, the list of available crops and a method to retrieve the crop URL based on name and width/height.
+
+For example:
+- get URL for crop item with the name _Social_: `@Model.MediaWithCrops.GetCropUrl("Social")`
+- get URL for crop item with height _1080_: `@Model.MediaWithCrops.GetCropUrl(null, 1080)`
+
+### Working with fields
+The asset's fields are grouped in an object containing their label and a dictionary of values based on the available cultures for that asset.
+
+For example:
+- get values for a field with label _Display Title_: 
+```
+var displayTitle = @Model.Fields.FirstOrDefault(p => p.Label == "Display Title");
+var values = displayTitle != null
+                ? displayTitle.Values 
+                : default(Dictionary<string, string>());
+``` 
+
 ### Version history
 - 1.0.0 - Initial release