RESTWS-760: Order resource does not include drug strength

IamMujuziMoses · IamMujuziMoses · commit 6206bfca6302 · 2025-06-10T19:22:51.000+03:00
diff --git a/omod-1.10/src/main/java/org/openmrs/module/webservices/rest/web/v1_0/resource/openmrs1_10/OrderResource1_10.java b/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()
 	 */
diff --git a/omod-1.10/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/controller/openmrs1_10/OrderController1_10Test.java b/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");
+	}
 }
diff --git a/omod-1.9/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/controller/openmrs1_9/OrderController1_9Test.java b/omod-1.9/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/controller/openmrs1_9/OrderController1_9Test.java
@@ -14,7 +14,6 @@
 import org.apache.commons.beanutils.PropertyUtils;
 import org.junit.Assert;
 import org.junit.Before;
-import org.junit.Ignore;
 import org.junit.Test;
 import org.openmrs.DrugOrder;
 import org.openmrs.Order;
@@ -263,7 +262,6 @@ public void shouldUpdateDrugOrder() throws Exception {
 	 * been updated
 	 */
 	@Test
-	@Ignore("RESTWS-760: Order resource does not include drug strength")
 	public void shouldAllowYouToPostANonUpdatablePropertyWithAnUnchangedValue() throws Exception {
 		MockHttpServletRequest get = request(RequestMethod.GET, getURI() + "/" + DRUG_ORDER_UUID);
 		SimpleObject drugOrder = deserialize(handle(get));
diff --git a/omod-2.3/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/search/openmrs2_3/OrderSearchHandler2_3Test.java b/omod-2.3/src/test/java/org/openmrs/module/webservices/rest/web/v1_0/search/openmrs2_3/OrderSearchHandler2_3Test.java
@@ -9,16 +9,12 @@
  */
 package org.openmrs.module.webservices.rest.web.v1_0.search.openmrs2_3;
 
-import static org.junit.Assert.assertNotNull;
-
 import org.apache.commons.beanutils.PropertyUtils;
 import org.junit.Assert;
 import org.junit.Test;
 import org.openmrs.Order;
 import org.openmrs.module.webservices.rest.SimpleObject;
 import org.openmrs.module.webservices.rest.web.RequestContext;
-import org.openmrs.module.webservices.rest.web.RestTestConstants1_10;
-import org.openmrs.module.webservices.rest.web.RestTestConstants1_8;
 import org.openmrs.module.webservices.rest.web.v1_0.controller.RestControllerTestUtils;
 import org.springframework.mock.web.MockHttpServletRequest;
 import org.springframework.web.bind.annotation.RequestMethod;
@@ -224,15 +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");
     }
-
-	@Test
-	public void search_shouldReturnWithDrugStrengthProperty() throws Exception {
-		MockHttpServletRequest req = request(RequestMethod.GET, getURI());
-		req.setParameter("orderTypes", RestTestConstants1_10.DRUG_ORDER_TYPE_UUID);
-		req.addParameter("patient", RestTestConstants1_8.PATIENT_UUID);
-		
-		SimpleObject result = deserialize(handle(req));
-		List<Object> orders = result.get("results");
-		Assert.assertEquals(PropertyUtils.getProperty(orders.get(1), "strength"), "325.0mg");
-	}
 }
diff --git a/omod-common/src/main/java/org/openmrs/module/webservices/rest/web/resource/impl/BaseDelegatingResource.java b/omod-common/src/main/java/org/openmrs/module/webservices/rest/web/resource/impl/BaseDelegatingResource.java
@@ -29,11 +29,7 @@
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.hibernate.proxy.HibernateProxy;
-import org.openmrs.Drug;
-import org.openmrs.DrugOrder;
 import org.openmrs.OpenmrsObject;
-import org.openmrs.Order;
-import org.openmrs.OrderType;
 import org.openmrs.api.context.Context;
 import org.openmrs.module.ModuleUtil;
 import org.openmrs.module.webservices.rest.SimpleObject;
@@ -387,7 +383,6 @@ public SimpleObject asRepresentation(T delegate, Representation representation)
 			
 			maybeDecorateWithType(simple, delegate);
 			decorateWithResourceVersion(simple, representation);
-			decorateWithStrengthProperty(simple, delegate);
 			
 			return simple;
 		}
@@ -405,7 +400,6 @@ public SimpleObject asRepresentation(T delegate, Representation representation)
 				
 				maybeDecorateWithType(simple, delegate);
 				decorateWithResourceVersion(simple, representation);
-				decorateWithStrengthProperty(simple, delegate);
 				
 				return simple;
 			}
@@ -447,39 +441,6 @@ private void maybeDecorateWithType(SimpleObject simple, T delegate) {
 		if (hasTypesDefined())
 			simple.add(RestConstants.PROPERTY_FOR_TYPE, getTypeName(delegate));
 	}
-
-	/**
-	 * 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, T delegate) {
-		if (delegate instanceof Order) {
-			Order order = (Order) delegate;
-			OrderType drugOrderType;
-			try {
-				 drugOrderType = Context.getOrderService().getOrderTypeByName("Drug order");
-			} catch (NoSuchMethodError nsme) {
-				drugOrderType = Context.getOrderService().getOrderType(2); // DrugOrder for backward compatibility
-			}
-
-			if (order.getOrderType().equals(drugOrderType)) {
-
-				Drug drug = ((DrugOrder) order).getDrug();
-				if (drug != null) {
-					try {
-						simple.add(RestConstants.PROPERTY_FOR_STRENGTH, drug.getStrength() != null ? drug.getStrength() : "[no strength]");
-					} catch (NoSuchMethodError nsme) {
-						simple.add(RestConstants.PROPERTY_FOR_STRENGTH, drug.getDoseStrength() != null ? drug.getDoseStrength() + drug.getUnits() : "[no strength]");
-					}
-				} else {
-					simple.add(RestConstants.PROPERTY_FOR_STRENGTH,"[no strength]");
-				}
-			}
-		}
-	}
 	
 	/**
 	 * If this resources supports subclasses, this method gets the user-friendly type name for the
