pulling updates from master

Merge branch 'master' of https://github.com/openmrs/openmrs-module-attachments into ATT-1

Author: Wandji69

api-2.0/src/main/java/org/openmrs/module/attachments/obs/AttachmentComplexData2_0.java

@@ -22,8 +22,9 @@ public AttachmentComplexData2_0(String instructions, String title, Object data,
 		} else {
 			this.setMimeType(AttachmentsConstants.UNKNOWN_MIME_TYPE);
 		}
-		if (!StringUtils.isEmpty(instructions))
+		if (!StringUtils.isEmpty(instructions)) {
 			this.instructions = instructions;
+		}
 	}
 
 	public AttachmentComplexData2_0(String title, Object data) {

api-2.0/src/main/java/org/openmrs/module/attachments/obs/ComplexViewHelper2_0.java

@@ -1,22 +1,39 @@
 package org.openmrs.module.attachments.obs;
 
+import static org.openmrs.obs.ComplexObsHandler.RAW_VIEW;
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.openmrs.Obs;
 import org.openmrs.annotation.OpenmrsProfile;
+import org.openmrs.api.ObsService;
 import org.openmrs.module.attachments.AttachmentsConstants;
 import org.openmrs.obs.ComplexObsHandler;
+import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
 @Component(AttachmentsConstants.COMPONENT_COMPLEXVIEW_HELPER)
 @OpenmrsProfile(openmrsPlatformVersion = "2.0.0")
 public class ComplexViewHelper2_0 implements ComplexViewHelper {
 
+	private final Log log = LogFactory.getLog(getClass());
+	
+	@Autowired
+	private ObsService obsService;
+	
 	@Override
 	public String getView(Obs obs, String view) {
-		// TODO: Obs obs will help the 2.x implementation support fetching the
-		// supported views for that obs,
-		// See:
-		// https://issues.openmrs.org/browse/ATT-34
 
-		return ComplexObsHandler.RAW_VIEW;
+		ComplexObsHandler handler = obsService.getHandler(obs);
+		
+		if (handler.supportsView(view)) {
+			return view;
+		} else {
+			log.warn("The requested view '" + view + "' is not supported by the complex obs handler '"
+			        + handler.getClass().getCanonicalName() + "', reverting to the default view '" + RAW_VIEW + "'.");
+		}
+		
+		return RAW_VIEW;
+		
 	}
 }

api/src/main/java/org/openmrs/module/attachments/obs/AbstractAttachmentHandler.java

@@ -1,10 +1,13 @@
 package org.openmrs.module.attachments.obs;
 
+import static org.openmrs.module.attachments.AttachmentsConstants.ATT_VIEW_ORIGINAL;
+import static org.openmrs.module.attachments.AttachmentsConstants.ATT_VIEW_THUMBNAIL;
 import static org.openmrs.module.attachments.obs.ImageAttachmentHandler.THUMBNAIL_MAX_HEIGHT;
 import static org.openmrs.module.attachments.obs.ImageAttachmentHandler.THUMBNAIL_MAX_WIDTH;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.Arrays;
 
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.lang.StringUtils;
@@ -26,6 +29,8 @@
  */
 public abstract class AbstractAttachmentHandler implements ComplexObsHandler {
 
+	private static final String[] supportedViews = { ATT_VIEW_ORIGINAL, ATT_VIEW_THUMBNAIL };
+	
 	public final static String NO_THUMBNAIL_SUFFIX = "___nothumb__";
 
 	public final static String THUMBNAIL_SUFFIX = "_thumb";
@@ -75,6 +80,14 @@ protected ComplexDataHelper getComplexDataHelper() {
 	 */
 	abstract protected ValueComplex saveComplexData(Obs obs, AttachmentComplexData complexData) throws IOException;
 
+	public String[] getSupportedViews() {
+		return supportedViews;
+	}
+	
+	public boolean supportsView(String view) {
+		return Arrays.asList(getSupportedViews()).contains(view);
+	}
+	
 	protected void setParent(ComplexObsHandler complexObsHandler) {
 		this.parent = complexObsHandler;
 	}

api/src/main/java/org/openmrs/module/attachments/obs/BaseComplexData.java

@@ -43,6 +43,8 @@ public static byte[] getByteArray(ComplexData complexData) {
 		}
 		if (data instanceof byte[]) {
 			return (byte[]) data;
+		} else if (data instanceof String) {
+			return ((String) data).getBytes();
 		} else if (RenderedImage.class.isAssignableFrom(data.getClass())) {
 			RenderedImage image = (RenderedImage) data;
 

api/src/test/resources/testdata/test-dataset.xml

@@ -0,0 +1,24 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!--
+
+    This Source Code Form is subject to the terms of the Mozilla Public License,
+    v. 2.0. If a copy of the MPL was not distributed with this file, You can
+    obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+    the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+
+    Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+    graphic logo is a trademark of OpenMRS Inc.
+
+-->
+<dataset>
+  <concept concept_id="84069" retired="false" datatype_id="13" class_id="5" is_set="false" creator="1" date_created="2005-01-01 00:00:00.0" uuid="3fe44002-35b8-445e-9d46-692c56e6bdde"/>
+  <concept_description concept_description_id="84069" concept_id="84069" description="TestBytesViewHandler Concept Complex" locale="en_GB" creator="1" date_created="2004-08-12 00:00:00.0" uuid="3a951971-34e9-4c88-954c-68d188f2c4de"/>
+
+  <concept_complex concept_id="84069" handler="TestAttachmentBytesViewHandler" />
+
+  <concept_name concept_id="84069" name="TestAttachmentBytesViewHandler Concept Complex" locale="en_GB" creator="1" date_created="2008-08-15 13:52:53.0" concept_name_id="8007" concept_name_type="FULLY_SPECIFIED" locale_preferred="0" voided="false" uuid="86f4f6ff-2bfb-4a17-a96b-ca633a96dd13"/>
+
+  <!-- This obs just exists so that there is a reference to an attachment associated with TestAttachmentBytesViewHandler to fetch it via REST -->
+  <obs obs_id="84044" person_id="2" concept_id="84069" obs_datetime="2008-02-09 00:00:00.0" location_id="1" value_complex="m3ks | instructions.none" creator="1" date_created="2006-02-10 15:57:35.0" voided="false" uuid="bbec1b32-dbf1-4b7a-bd2b-8898543c1367"/>
+
+</dataset>

omod-1.10/src/main/java/org/openmrs/module/attachments/rest/AttachmentBytesResource1_10.java

@@ -1,5 +1,11 @@
 package org.openmrs.module.attachments.rest;
 
+import static org.openmrs.module.attachments.AttachmentsContext.getContentFamily;
+
+import java.io.IOException;
+
+import javax.servlet.http.HttpServletResponse;
+
 import org.apache.commons.io.FilenameUtils;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
@@ -8,6 +14,7 @@
 import org.openmrs.module.attachments.AttachmentsConstants;
 import org.openmrs.module.attachments.AttachmentsContext;
 import org.openmrs.module.attachments.obs.AttachmentComplexData;
+import org.openmrs.module.attachments.obs.ComplexViewHelper;
 import org.openmrs.module.attachments.obs.ValueComplex;
 import org.openmrs.module.webservices.rest.web.RestConstants;
 import org.openmrs.module.webservices.rest.web.response.GenericRestException;
@@ -19,11 +26,7 @@
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
-
-import javax.servlet.http.HttpServletResponse;
-import java.io.IOException;
-
-import static org.openmrs.module.attachments.AttachmentsContext.getContentFamily;
+import org.springframework.web.bind.annotation.RequestParam;
 
 @Controller
 @RequestMapping(value = "/rest/" + RestConstants.VERSION_1 + "/" + AttachmentsConstants.ATTACHMENT_URI)
@@ -35,7 +38,8 @@ public class AttachmentBytesResource1_10 extends BaseRestController {
 	protected final Log log = LogFactory.getLog(getClass());
 
 	@RequestMapping(value = AttachmentsConstants.ATTACHMENT_BYTES_URI, method = RequestMethod.GET)
-	public void getFile(@PathVariable("uuid") String uuid, HttpServletResponse response) throws ResponseException {
+	public void getFile(@PathVariable("uuid") String uuid, @RequestParam(required = false, value = "view") String view,
+	        HttpServletResponse response) throws ResponseException {
 		// Getting the Core/Platform complex data object
 		Obs obs = context.getObsService().getObsByUuid(uuid);
 
@@ -44,7 +48,9 @@ public void getFile(@PathVariable("uuid") String uuid, HttpServletResponse respo
 			        + "Obs UUID: " + obs.getUuid());
 		}
 
-		Obs complexObs = Context.getObsService().getComplexObs(obs.getObsId(), null);
+		ComplexViewHelper viewHelper = context.getComplexViewHelper();
+		
+		Obs complexObs = Context.getObsService().getComplexObs(obs.getObsId(), viewHelper.getView(obs, view));
 		ComplexData complexData = complexObs.getComplexData();
 
 		// Switching to our complex data object
@@ -54,7 +60,7 @@ public void getFile(@PathVariable("uuid") String uuid, HttpServletResponse respo
 
 		String mimeType = attComplexData.getMimeType();
 
-		// The attachment meta data is sent as HTTP headers.
+		// The attachment metadata is sent as HTTP headers.
 		response.setContentType(mimeType);
 		response.addHeader("Content-Family", getContentFamily(mimeType).name());
 		response.addHeader("File-Name", attComplexData.getTitle());

omod-1.10/src/test/java/org/openmrs/module/attachments/rest/AttachmentController1_10Test.java renamed to omod-1.10/src/test/java/org/openmrs/module/attachments/rest/AttachmentRestController1_10Test.java

@@ -34,7 +34,7 @@
 import org.springframework.mock.web.MockMultipartFile;
 import org.springframework.mock.web.MockMultipartHttpServletRequest;
 
-public class AttachmentController1_10Test extends MainResourceControllerTest {
+public class AttachmentRestController1_10Test extends MainResourceControllerTest {
 
 	@Autowired
 	protected ObsService obsService;

omod-2.0/pom.xml

@@ -205,6 +205,9 @@
     </resources>
 
     <testResources>
+      <testResource>
+        <directory>../api/src/test/resources</directory>
+      </testResource>
       <testResource>
         <directory>src/test/resources</directory>
         <includes>

omod-2.0/src/test/java/org/openmrs/module/attachments/obs/TestAttachmentBytesViewHandler.java

@@ -0,0 +1,51 @@
+package org.openmrs.module.attachments.obs;
+
+import static org.openmrs.module.attachments.obs.ValueComplex.INSTRUCTIONS_DEFAULT;
+
+import org.openmrs.Obs;
+import org.openmrs.obs.ComplexData;
+import org.openmrs.obs.handler.BinaryDataHandler;
+
+public class TestAttachmentBytesViewHandler extends AbstractAttachmentHandler {
+	
+	public static final String DEFAULT_VIEW = "VIEW_1";
+	
+	public static final String DEFAULT_VIEW_DATA = "This is a string content for VIEW_1.";
+	
+	public static final String ALTERNATE_VIEW = "VIEW_2";
+	
+	public static final String ALTERNATE_VIEW_DATA = "This is a string content for VIEW_2.";
+	
+	private static final String[] supportedViews = { DEFAULT_VIEW, ALTERNATE_VIEW };
+	
+	@Override
+	protected void setParentComplexObsHandler() {
+		setParent(new BinaryDataHandler());
+	}
+	
+	@Override
+	protected ComplexData readComplexData(Obs obs, ValueComplex valueComplex, String view) {
+		
+		if (ALTERNATE_VIEW.equals(view)) {
+			return new AttachmentComplexData2_0(INSTRUCTIONS_DEFAULT, "extra_view", ALTERNATE_VIEW_DATA, "text/plain");
+		}
+		
+		return new AttachmentComplexData2_0(INSTRUCTIONS_DEFAULT, "default_view", DEFAULT_VIEW_DATA, "text/plain");
+		
+	}
+	
+	@Override
+	protected boolean deleteComplexData(Obs obs, AttachmentComplexData complexData) {
+		return false;
+	}
+	
+	@Override
+	protected ValueComplex saveComplexData(Obs obs, AttachmentComplexData complexData) {
+		return null;
+	}
+	
+	@Override
+	public String[] getSupportedViews() {
+		return supportedViews;
+	}
+}