Skip to content

Commit c2bbc20

Browse files
authored
Merge pull request #11 from SlicingDice/feature/many-corrections-client
Make some code corrections on client
2 parents c8d5f1f + 22e7be5 commit c2bbc20

File tree

4 files changed

+111
-81
lines changed

4 files changed

+111
-81
lines changed

pyslicer/api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class SlicingDiceAPI(object):
2020

2121
def __init__(
2222
self, master_key=None, write_key=None, read_key=None,
23-
custom_key=None, use_ssl=False, timeout=60):
23+
custom_key=None, use_ssl=True, timeout=60):
2424
"""Instantiate a new SlicerDicer object.
2525
2626
Keyword arguments:

pyslicer/client.py

Lines changed: 40 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ class SlicingDice(SlicingDiceAPI):
8282
"""
8383
def __init__(
8484
self, write_key=None, read_key=None, master_key=None,
85-
custom_key=None, use_ssl=False, timeout=60):
85+
custom_key=None, use_ssl=True, timeout=60, uses_test_endpoint=False):
8686
"""Instantiate a new SlicingDice object.
8787
8888
Keyword arguments:
@@ -91,9 +91,11 @@ def __init__(
9191
HTTPS requests. Defaults False.(Optional)
9292
timeout(int) -- Define timeout to request,
9393
defaults 30 secs(default 30).
94+
test(bool) -- if true will use tests end-point (default False)
9495
"""
9596
super(SlicingDice, self).__init__(
96-
write_key, read_key, master_key, custom_key, use_ssl, timeout)
97+
master_key, write_key, read_key, custom_key, use_ssl, timeout)
98+
self.uses_test_endpoint = uses_test_endpoint
9799

98100
def _count_query_wrapper(self, url, query):
99101
"""Validate count query and make request.
@@ -125,10 +127,9 @@ def _data_extraction_wrapper(self, url, query):
125127
req_type="post",
126128
key_level=0)
127129

128-
@staticmethod
129-
def _wrapper_test(test):
130+
def _wrapper_test(self):
130131
base_url = SlicingDice.BASE_URL
131-
if test:
132+
if self.uses_test_endpoint:
132133
base_url += "/test"
133134
return base_url
134135

@@ -159,15 +160,14 @@ def get_projects(self):
159160
key_level=2
160161
)
161162

162-
def create_field(self, data, test=False):
163+
def create_field(self, data):
163164
"""Create field in Slicing Dice
164165
165166
Keyword arguments:
166167
data -- A dictionary in the Slicing Dice field
167168
format.
168-
test(bool) -- if true will use tests end-point (default False)
169169
"""
170-
base_url = self._wrapper_test(test)
170+
base_url = self._wrapper_test()
171171
sd_data = validators.FieldValidator(data)
172172
if sd_data.validator():
173173
url = base_url + URLResources.FIELD
@@ -177,32 +177,27 @@ def create_field(self, data, test=False):
177177
json_data=ujson.dumps(data),
178178
key_level=1)
179179

180-
def get_fields(self, test=False):
181-
"""Get a list of fields
182-
183-
Keyword arguments:
184-
test(bool) -- if true will use tests end-point (default False)
185-
"""
186-
base_url = self._wrapper_test(test)
180+
def get_fields(self):
181+
"""Get a list of fields"""
182+
base_url = self._wrapper_test()
187183
url = base_url + URLResources.FIELD
188184
return self._make_request(
189185
url=url,
190186
req_type="get",
191187
key_level=2)
192188

193-
def index(self, data, auto_create_fields=False, test=False):
189+
def index(self, data, auto_create_fields=False):
194190
"""Make a index in Slicing Dice API
195191
196192
Keyword arguments:
197193
data -- A dictionary in the Slicing Dice index
198194
format.
199195
auto_create_fields(bool) -- if true SlicingDice API will automatically
200196
create nonexistent fields (default False)
201-
test(bool) -- if true will use tests end-point (default False)
202197
"""
203198
if auto_create_fields:
204199
data["auto-create-fields"] = True
205-
base_url = self._wrapper_test(test)
200+
base_url = self._wrapper_test()
206201
sd_data = validators.IndexValidator(data)
207202
if sd_data.validator():
208203
url = base_url + URLResources.INDEX
@@ -212,48 +207,42 @@ def index(self, data, auto_create_fields=False, test=False):
212207
req_type="post",
213208
key_level=1)
214209

215-
def count_entity(self, query, test=False):
210+
def count_entity(self, query):
216211
"""Make a count entity query
217212
218213
Keyword arguments:
219214
query -- A dictionary in the Slicing Dice query
220-
test(bool) -- if true will use tests end-point (default False)
221215
"""
222-
base_url = self._wrapper_test(test)
216+
base_url = self._wrapper_test()
223217
url = base_url + URLResources.QUERY_COUNT_ENTITY
224218
return self._count_query_wrapper(url, query)
225219

226-
def count_entity_total(self, test=False):
227-
"""Make a count entity total query
228-
229-
test(bool) -- if true will use tests end-point (default False)
230-
"""
231-
base_url = self._wrapper_test(test)
220+
def count_entity_total(self):
221+
"""Make a count entity total query"""
222+
base_url = self._wrapper_test()
232223
url = base_url + URLResources.QUERY_COUNT_ENTITY_TOTAL
233224
return self._make_request(
234225
url=url,
235226
req_type="get",
236227
key_level=0)
237228

238-
def count_event(self, query, test=False):
229+
def count_event(self, query):
239230
"""Make a count event query
240231
241232
Keyword arguments:
242233
data -- A dictionary query
243-
test(bool) -- if true will use tests end-point (default False)
244234
"""
245-
base_url = self._wrapper_test(test)
235+
base_url = self._wrapper_test()
246236
url = base_url + URLResources.QUERY_COUNT_EVENT
247237
return self._count_query_wrapper(url, query)
248238

249-
def aggregation(self, query, test=False):
239+
def aggregation(self, query):
250240
"""Make a aggregation query
251241
252242
Keyword arguments:
253243
query -- An aggregation query
254-
test(bool) -- if true will use tests end-point (default False)
255244
"""
256-
base_url = self._wrapper_test(test)
245+
base_url = self._wrapper_test()
257246
url = base_url + URLResources.QUERY_AGGREGATION
258247
if "query" not in query:
259248
raise exceptions.InvalidQueryException(
@@ -268,14 +257,13 @@ def aggregation(self, query, test=False):
268257
req_type="post",
269258
key_level=0)
270259

271-
def top_values(self, query, test=False):
260+
def top_values(self, query):
272261
"""Make a top values query
273262
274263
Keyword arguments:
275264
query -- A dictionary query
276-
test(bool) -- if true will use tests end-point (default False)
277265
"""
278-
base_url = self._wrapper_test(test)
266+
base_url = self._wrapper_test()
279267
url = base_url + URLResources.QUERY_TOP_VALUES
280268
sd_query_top_values = validators.QueryValidator(query)
281269
if sd_query_top_values.validator():
@@ -285,14 +273,13 @@ def top_values(self, query, test=False):
285273
req_type="post",
286274
key_level=0)
287275

288-
def exists_entity(self, ids, test=False):
276+
def exists_entity(self, ids):
289277
"""Make a exists entity query
290278
291279
Keyword arguments:
292280
ids -- A list with entity to check if exists
293-
test(bool) -- if true will use tests end-point (default False)
294281
"""
295-
base_url = self._wrapper_test(test)
282+
base_url = self._wrapper_test()
296283
url = base_url + URLResources.QUERY_EXISTS_ENTITY
297284
if len(ids) > 100:
298285
raise exceptions.MaxLimitException(
@@ -306,90 +293,83 @@ def exists_entity(self, ids, test=False):
306293
req_type="post",
307294
key_level=0)
308295

309-
def get_saved_query(self, query_name, test=False):
296+
def get_saved_query(self, query_name):
310297
"""Get a saved query
311298
312299
Keyword arguments:
313300
query_name(string) -- The name of the saved query
314-
test(bool) -- if true will use tests end-point (default False)
315301
"""
316-
base_url = self._wrapper_test(test)
302+
base_url = self._wrapper_test()
317303
url = base_url + URLResources.QUERY_SAVED + query_name
318304
return self._make_request(
319305
url=url,
320306
req_type="get",
321307
key_level=0)
322308

323-
def get_saved_queries(self, test=False):
309+
def get_saved_queries(self):
324310
"""Get all saved queries
325311
326312
Keyword arguments:
327313
query_name(string) -- The name of the saved query
328-
test(bool) -- if true will use tests end-point (default False)
329314
"""
330-
base_url = self._wrapper_test(test)
315+
base_url = self._wrapper_test()
331316
url = base_url + URLResources.QUERY_SAVED
332317
return self._make_request(
333318
url=url,
334319
req_type="get",
335320
key_level=2)
336321

337-
def delete_saved_query(self, query_name, test=False):
322+
def delete_saved_query(self, query_name):
338323
"""Delete a saved query
339324
340325
Keyword arguments:
341326
query_name(string) -- The name of the saved query
342-
test(bool) -- if true will use tests end-point (default False)
343327
"""
344-
base_url = self._wrapper_test(test)
328+
base_url = self._wrapper_test()
345329
url = base_url + URLResources.QUERY_SAVED + query_name
346330
return self._make_request(
347331
url=url,
348332
req_type="delete",
349333
key_level=2
350334
)
351335

352-
def create_saved_query(self, query, test=False):
336+
def create_saved_query(self, query):
353337
"""Get a list of queries saved
354338
355339
Keyword arguments:
356340
query -- A dictionary query
357-
test(bool) -- if true will use tests end-point (default False)
358341
"""
359-
base_url = self._wrapper_test(test)
342+
base_url = self._wrapper_test()
360343
url = base_url + URLResources.QUERY_SAVED
361344
return self._saved_query_wrapper(url, query)
362345

363-
def update_saved_query(self, name, query, test=False):
346+
def update_saved_query(self, name, query):
364347
"""Get a list of queries saved
365348
366349
Keyword arguments:
367350
name -- The name of the saved query to update
368351
query -- A dictionary query
369-
test(bool) -- if true will use tests end-point (default False)
370352
"""
371-
base_url = self._wrapper_test(test)
353+
base_url = self._wrapper_test()
372354
url = base_url + URLResources.QUERY_SAVED + name
373355
return self._saved_query_wrapper(url, query, True)
374356

375-
def result(self, query, test=False):
357+
def result(self, query):
376358
"""Get a data extraction result
377359
378360
Keyword arguments:
379361
query -- A dictionary query
380-
test(bool) -- if true will use tests end-point (default False)
381362
"""
382-
base_url = self._wrapper_test(test)
363+
base_url = self._wrapper_test()
383364
url = base_url + URLResources.QUERY_DATA_EXTRACTION_RESULT
384365
return self._data_extraction_wrapper(url, query)
385366

386-
def score(self, query, test=False):
367+
def score(self, query):
387368
"""Get a data extraction score
388369
389370
Keyword arguments:
390371
query -- A dictionary query
391-
test(bool) -- if true will use tests end-point (default False)
392372
"""
393-
base_url = self._wrapper_test(test)
373+
base_url = self._wrapper_test()
394374
url = base_url + URLResources.QUERY_DATA_EXTRACTION_SCORE
395375
return self._data_extraction_wrapper(url, query)

0 commit comments

Comments
 (0)