Skip to content

Commit a56935f

Browse files
RidleyLarsenRidleyLarsen
committed
Added create Line Item function and tests.
1 parent 87ea217 commit a56935f

File tree

4 files changed

+287
-0
lines changed

4 files changed

+287
-0
lines changed

‎dynatademand/api.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
SCHEMAS = [
99
"project_new",
10+
"lineitem_new",
1011
]
1112

1213

@@ -167,6 +168,25 @@ def get_projects(self):
167168
def get_project_detailed_report(self, project_id):
168169
return self._api_get('/projects/{}/detailedReport'.format(project_id))
169170

171+
def add_line_item(self, project_id, lineitem_data):
172+
'''
173+
A line item is a project entity that exist for a specific market and
174+
language that your survey is aimed at. It defines the target panelists
175+
for the market that the survey is looking for, and the number of
176+
completes required. A line item is our unit of work and is what
177+
gets billed to you.
178+
'''
179+
# Creates a new line item. Uses the "new lineitem" schema.
180+
self._validate_object("lineitem_new", lineitem_data)
181+
response_data = self._api_post('/projects/{}/lineItems'.format(project_id), lineitem_data)
182+
if response_data.get('status').get('message') != 'success':
183+
raise DemandAPIError(
184+
"Could not add line item. Demand API responded with: {}".format(
185+
response_data
186+
)
187+
)
188+
return response_data
189+
170190
def get_line_item(self, project_id, line_item_id):
171191
return self._api_get('/projects/{}/lineItems/{}'.format(project_id, line_item_id))
172192

‎dynatademand/schemas/lineitem_new.json

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
{
2+
"type": "object",
3+
"title": "New Line Item",
4+
"properties": {
5+
"extLineItemId": {
6+
"type": "string",
7+
"description": "A unique identifier for your Line Item"
8+
},
9+
"title": {
10+
"type": "string",
11+
"description": "A Line Item title of your choosing"
12+
},
13+
"countryISOCode": {
14+
"type": "string",
15+
"description": "2 letter ISO Country Code",
16+
"minLength": 2,
17+
"maxLength": 2
18+
},
19+
"languageISOCode": {
20+
"type": "string",
21+
"description": "2 letter ISO Language Code",
22+
"minLength": 2,
23+
"maxLength": 2
24+
},
25+
"surveyURL": {
26+
"type": "string",
27+
"description": "Survey URL to send panelist into. "
28+
},
29+
"surveyTestURL": {
30+
"type": "string",
31+
"description": "Survey Test URL. Required for survey verification"
32+
},
33+
"indicativeIncidence": {
34+
"type": "integer",
35+
"description": "Percent of panelists you expect to qualify for the survey after they go in"
36+
},
37+
"daysInField": {
38+
"type": "integer",
39+
"description": "Number of days the survey should be active in the field. We do not stop the survey after daysInField has expired"
40+
},
41+
"lengthOfInterview": {
42+
"type": "integer",
43+
"description": "Average number of minutes it takes a user to complete your survey"
44+
},
45+
"deliveryType": {
46+
"type": "string",
47+
"default": "BALANCED",
48+
"description": "The plan on how responses will flow into the survey.",
49+
"enum": [
50+
"SLOW",
51+
"BALANCED",
52+
"FAST"
53+
]
54+
},
55+
"sources": {
56+
"type": "array",
57+
"description": "The supplier source that you would like to buy sample from. You can get the list of sources available to your account using the [Get List of Sources](/demand-api-reference/data_endpoints/supplier-sources/get-sources) endpoint",
58+
"default": 100,
59+
"items": {
60+
"type": "object",
61+
"properties": {
62+
"id": {
63+
"type": "integer"
64+
}
65+
}
66+
}
67+
},
68+
"targets": {
69+
"type": "array",
70+
"description": "Total count of survey completes required for this line item",
71+
"items": {
72+
"type": "object",
73+
"properties": {
74+
"count": {
75+
"description": "Total number of counts required for this line item for the specified target type",
76+
"type": "integer"
77+
},
78+
"dailyLimit": {
79+
"description": "Total number of daily counts required for this line item",
80+
"type": "integer"
81+
},
82+
"type": {
83+
"type": "string",
84+
"description": "The type of counts required for this line item.",
85+
"enum": [
86+
"COMPLETE"
87+
]
88+
}
89+
}
90+
}
91+
},
92+
"quotaPlan": {
93+
"type": "object",
94+
"title": "Quota Plan",
95+
"description": "Defines the type of respondents you want to invite for the survey",
96+
"properties": {
97+
"filters": {
98+
"type": "array",
99+
"description": "Filters are minimum set of targeting that every respondent must have in order to qualify for the study. Only attributes that have `isAllowedInFilters = true` is allowed to be used in `filters`",
100+
"items": {
101+
"type": "object",
102+
"properties": {
103+
"attributeId": {
104+
"type": "string",
105+
"description": "The attribute you want to target respondents on"
106+
},
107+
"options": {
108+
"type": "array",
109+
"description": "The options of the attribute you want to target respondents on",
110+
"uniqueItems": true,
111+
"items": {
112+
"type": "string"
113+
}
114+
},
115+
"operator": {
116+
"type": "string",
117+
"enum": [
118+
"exclude",
119+
"include"
120+
],
121+
"default": "include",
122+
"description": "The operator to use for the attribute options."
123+
}
124+
}
125+
}
126+
},
127+
"quotaGroups": {
128+
"type": "array",
129+
"description": "Quota groups define the allocated targeting attributes for panelists within this line item. Only attributes that have `isAllowedInQuotas = true` is allowed in `quotaGroups`.",
130+
"items": {
131+
"type": "object",
132+
"properties": {
133+
"name": {
134+
"type": "string",
135+
"description": "A quota group name of your choosing"
136+
},
137+
"quotaCells": {
138+
"type": "array",
139+
"description": "Quota Cells define the percentage allocation for the required targeting. A quota cell is made up of a collection of quota Nodes",
140+
"items": {
141+
"type": "object",
142+
"properties": {
143+
"quotaNodes": {
144+
"type": "array",
145+
"description": "Quota Nodes define the collection of attributes and options being targeted.",
146+
"items": {
147+
"type": "object",
148+
"properties": {
149+
"attributeId": {
150+
"type": "string",
151+
"description": "The attribute you want to target respondents on"
152+
},
153+
"options": {
154+
"type": "array",
155+
"description": "The options of the attribute you want to target respondents on",
156+
"uniqueItems": true,
157+
"items": {
158+
"type": "string"
159+
}
160+
},
161+
"operator": {
162+
"type": "string",
163+
"enum": [
164+
"exclude",
165+
"include"
166+
],
167+
"default": "include",
168+
"description": "**Deprecated field** The operator to use for the attribute options."
169+
}
170+
}
171+
}
172+
},
173+
"count": {
174+
"type": "integer",
175+
"description": "The count of respondents you want to qualify for the defined quota cell"
176+
}
177+
}
178+
}
179+
}
180+
}
181+
}
182+
}
183+
}
184+
}
185+
},
186+
"required": [
187+
"extLineItemId",
188+
"countryISOCode",
189+
"languageISOCode",
190+
"indicativeIncidence",
191+
"daysInField",
192+
"lengthOfInterview",
193+
"targets"
194+
]
195+
}

‎tests/test_files/examples/lineitem_new.json

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{
2+
"extLineItemId": "lineItem001",
3+
"title": "US College",
4+
"countryISOCode": "US",
5+
"languageISOCode": "en",
6+
"surveyURL": "www.mysurvey.com/live/survey?pid=<#DubKnowledge[1500/Entity id]>&k2=<#Project[Secure Key 2]>&psid=<#IdParameter[Value]>",
7+
"surveyTestURL": "www.mysurvey.com/test/survey?pid=<#DubKnowledge[1500/Entity id]>&k2=<#Project[Secure Key 2]>&psid=<#IdParameter[Value]>",
8+
"indicativeIncidence": 20,
9+
"daysInField": 20,
10+
"lengthOfInterview": 10,
11+
"deliveryType": "BALANCED",
12+
"requiredCompletes": 200,
13+
"quotaPlan": {
14+
"filters": [
15+
{
16+
"attributeId": "4091",
17+
"options": [
18+
"3",
19+
"4"
20+
]
21+
}
22+
],
23+
"quotaGroups": [
24+
{
25+
"name": "Gender Distribution",
26+
"quotaCells": [
27+
{
28+
"quotaNodes": [
29+
{
30+
"attributeId": "11",
31+
"options": [
32+
"1"
33+
]
34+
}
35+
],
36+
"count": 130
37+
},
38+
{
39+
"quotaNodes": [
40+
{
41+
"attributeId": "11",
42+
"options": [
43+
"2"
44+
]
45+
}
46+
],
47+
"count": 70
48+
}
49+
]
50+
}
51+
]
52+
}
53+
}

‎tests/test_line_items.py

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
from mock import patch
1212

1313
from dynatademand.api import DemandAPIClient
14+
from dynatademand.errors import DemandAPIError
1415

1516
BASE_HOST = "http://test-url.example"
1617

@@ -46,3 +47,21 @@ def test_get_line_item_detailed_report(self):
4647
self.api.get_line_item_detailed_report(1, 100)
4748
self.assertEqual(len(responses.calls), 1)
4849
self.assertEqual(responses.calls[0].response.json(), line_item_detailed_report_json)
50+
51+
@responses.activate
52+
def test_add_line_item(self):
53+
# Tests creating a project. This also tests validating the project data as part of `api.create_project`.
54+
with open('./tests/test_files/examples/lineitem_new.json', 'r') as new_lineitem_file:
55+
new_lineitem_data = json.load(new_lineitem_file)
56+
# Success response
57+
responses.add(responses.POST, '{}/sample/v1/projects/24/lineItems'.format(BASE_HOST), json={'status': {'message': 'success'}}, status=200)
58+
# Response with error status
59+
responses.add(responses.POST, '{}/sample/v1/projects/24/lineItems'.format(BASE_HOST), json={'status': {'message': 'error'}}, status=200)
60+
# Test success response
61+
self.api.add_line_item(24, new_lineitem_data)
62+
self.assertEqual(len(responses.calls), 1)
63+
64+
# Test error response
65+
with self.assertRaises(DemandAPIError):
66+
self.api.add_line_item(24, new_lineitem_data)
67+
self.assertEqual(len(responses.calls), 2)

0 commit comments

Comments
 (0)