RESTWS-760: Order resource does not include drug strength

Author: IamMujuziMoses

omod-1.10/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_10/OrderResource1_10.java

@@ -16,23 +16,27 @@
 import io.swagger.models.properties.StringProperty;
 import org.apache.commons.lang.StringUtils;
 import org.openmrs.CareSetting;
+import org.openmrs.Drug;
+import org.openmrs.DrugOrder;
 import org.openmrs.Order;
 import org.openmrs.OrderType;
 import org.openmrs.Patient;
 import org.openmrs.api.context.Context;
 import org.openmrs.module.webservices.docs.swagger.core.property.EnumProperty;
+import org.openmrs.module.webservices.rest.SimpleObject;
 import org.openmrs.module.webservices.rest.web.ConversionUtil;
 import org.openmrs.module.webservices.rest.web.RequestContext;
 import org.openmrs.module.webservices.rest.web.RestConstants;
 import org.openmrs.module.webservices.rest.web.annotation.Resource;
 import org.openmrs.module.webservices.rest.web.api.RestService;
+import org.openmrs.module.webservices.rest.web.representation.CustomRepresentation;
 import org.openmrs.module.webservices.rest.web.representation.DefaultRepresentation;
 import org.openmrs.module.webservices.rest.web.representation.FullRepresentation;
 import org.openmrs.module.webservices.rest.web.representation.Representation;
 import org.openmrs.module.webservices.rest.web.resource.api.PageableResult;
 import org.openmrs.module.webservices.rest.web.resource.impl.DelegatingResourceDescription;
-import org.openmrs.module.webservices.rest.web.resource.impl.EmptySearchResult;
 import org.openmrs.module.webservices.rest.web.resource.impl.NeedsPaging;
+import org.openmrs.module.webservices.rest.web.response.ConversionException;
 import org.openmrs.module.webservices.rest.web.response.InvalidSearchException;
 import org.openmrs.module.webservices.rest.web.response.ObjectNotFoundException;
 import org.openmrs.module.webservices.rest.web.response.ResourceDoesNotSupportOperationException;
@@ -311,7 +315,42 @@ public int compare(Order o1, Order o2) {
 		});
 		return sortedList;
 	}
-	
+
+	/**
+	 * If this resource is a DrugOrder, then we add a strength property to the input, and return it
+	 *
+	 * @param simple simplified representation which will be decorated with the strength property
+	 *
+	 * @param delegate the DrugOrder object that simple represents
+	 */
+	private void decorateWithStrengthProperty(SimpleObject simple, Order delegate) {
+		OrderType drugOrderType = Context.getOrderService().getOrderTypeByName("Drug order");
+		if (delegate.getOrderType().equals(drugOrderType)) {
+			Drug drug = ((DrugOrder) delegate).getDrug();
+			if (drug != null) {
+				simple.add(RestConstants.PROPERTY_FOR_STRENGTH, drug.getStrength() != null ? drug.getStrength() : "[no strength]");
+			} else {
+				simple.add(RestConstants.PROPERTY_FOR_STRENGTH,"[no strength]");
+			}
+		}
+	}
+
+	/**
+	 * @see org.openmrs.module.webservices.rest.web.resource.impl.BaseDelegatingResource#asRepresentation(Object, Representation)
+	 */
+	@Override
+	public SimpleObject asRepresentation(Order delegate, Representation representation) throws ConversionException {
+		DelegatingResourceDescription repDescription;
+		if (representation instanceof CustomRepresentation) {
+			repDescription = ConversionUtil.getCustomRepresentationDescription((CustomRepresentation) representation);
+			return convertDelegateToRepresentation(delegate, repDescription);
+		}
+
+		SimpleObject simple = super.asRepresentation(delegate, representation);
+		decorateWithStrengthProperty(simple, delegate);
+		return simple;
+	}
+
 	/**
 	 * @see org.openmrs.module.webservices.rest.web.resource.impl.BaseDelegatingResource#getResourceVersion()
 	 */

omod-1.10/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/controller/openmrs1_10/OrderController1_10Test.java

@@ -598,4 +598,16 @@ public void doSearch_shouldReturnExceptionIfNoPatientUuidIsSpecified() throws Ex
 		);
 		handle(req);
 	}
+
+	@Test
+	public void doSearch_shouldReturnWithDrugStrengthProperty() throws Exception {
+		MockHttpServletRequest req = newGetRequest(getURI(),
+				new Parameter("orderTypes", RestTestConstants1_10.DRUG_ORDER_TYPE_UUID),
+				new Parameter("patient", PATIENT_UUID)
+		);
+
+		SimpleObject orders = deserialize(handle(req));
+		List<Object> results = orders.get("results");
+		assertEquals(PropertyUtils.getProperty(results.get(0), "strength"), "325.0mg");
+	}
 }

omod-2.3/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/search/openmrs2_3/OrderSearchHandler2_3Test.java

@@ -220,5 +220,4 @@ public void getSearchConfig_shouldReturnOrdersByAccessionNumber() throws Excepti
         Assert.assertEquals(1, orders.size());
         Assert.assertEquals(PropertyUtils.getProperty(orders.get(0), "uuid"), "e1f95924-697a-11e3-bd76-0800271c1b75");
     }
-
 }

omod-common/src/main/java/org/openmrs/module/webservices/rest/web/RestConstants.java

@@ -155,6 +155,11 @@ public class RestConstants {
 	public static String REPRESENTATION_FULL = "full";
 
 	public static String REPRESENTATION_CUSTOM_PREFIX = "custom:";
+
+	/**
+	 * Used in DrugOrder object representations to indicate the specific strength an instance has
+	 */
+	public static String PROPERTY_FOR_STRENGTH = "strength";
 
 	// The URI prefix through which clients consuming web services will connect
 	// to the web application