Create new methods endpoint

README.md

@@ -13,6 +13,7 @@ Implementation of the BRAPI standard for TERRA-REF instance of the BETYdb databa
 | /germplasm  | cultivars.  |       | 
 | /observations | traits | |
 | /variables | variables | |
+| /methods | methods| |
 
 # Currently implemented endpoints & parameters
 
@@ -91,7 +92,12 @@ See [Swagger documentation](http://terraref.org/brapi/v1/ui) for more details
   	name
   	observationVariableName
   	observationVariableDbID
-  	scale
+ 	scale
+  /methods
+    description
+    name
+    observationVariableDbId
+    observationVariableName
 
 ```
 

api/calls.py

@@ -30,7 +30,8 @@ def search(datatype=None, dataType=None, pageSize=None, page=None):
         calls_get_helper('studies/{studyDbId}/germplasm', versions=VERSIONS_1_23),
         calls_get_helper('studies/{studyDbId}/layouts', versions=VERSIONS_1_23),
         calls_get_helper('trials', versions=VERSIONS_1_23),
-        calls_get_helper('variables', versions=VERSIONS_1_23)
+        calls_get_helper('variables', versions=VERSIONS_1_23),
+        calls_get_helper('methods', versions=VERSIONS_1_23)
     ]
 
     # filter on datatype

api/methods.py

@@ -0,0 +1,49 @@
+import helper
+
+
+def search(observationVariableDbId=None, traitClass=None, pageSize=None, page=None):
+    """Returns information on methods
+    Arguments:
+        observationVariableDbId: specific variable to return information on
+        traitClass: not implemented
+        pageSize: the desired size of return pages
+        page: the number of the page to return (starting at zero)
+    """
+    query = "SELECT id, name, description FROM methods AS m"
+
+    params = []
+
+    where_clause = " WHERE"
+
+    # add a filter on the variable ID
+    if observationVariableDbId:
+        query += where_clause + " m.id = %s "
+        params.append(observationVariableDbId)
+        where_clause = " AND"
+
+    # add a filter on the trait class  - not implemented at this time
+    #if traitClass:
+    # NOTE: this code is invalid for filtering on traitClass, it's just a placeholder
+    #    query += where_clause + " s.id = %s "
+    #    params.append(traitClass)
+    #    where_clause = " AND"
+
+    query += " ORDER BY m.id"
+
+    # count first
+    count = helper.query_count(query, params)
+
+    # execute query
+    result = helper.query_result(query, params, pageSize, page)
+
+    # wrap result
+    data = list()
+    for row in result:
+        data.append({
+             "name": row["name"],
+             "observationVariableName": row["name"],
+             "observationVariableDbId": str(row["id"]),
+             "description": row["description"]
+        })
+
+    return helper.create_result({"data": data}, count, pageSize, page)