1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
|
import inspect
import json
import logging
import os.path
import requests
import requests_mock
import pytest
from sodapy import Socrata
from sodapy.constants import DEFAULT_API_PATH, OLD_API_PATH, DATASETS_PATH
PREFIX = "https://"
DOMAIN = "fakedomain.com"
DATASET_IDENTIFIER = "songs"
APPTOKEN = "FakeAppToken"
USERNAME = "fakeuser"
PASSWORD = "fakepassword"
TEST_DATA_PATH = os.path.join(
os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe()))),
"test_data",
)
LOGGER = logging.getLogger(__name__)
def test_client():
client = Socrata(DOMAIN, APPTOKEN)
assert isinstance(client, Socrata)
client.close()
def test_client_warning(caplog):
with caplog.at_level(logging.WARNING):
client = Socrata(DOMAIN, None)
assert "strict throttling limits" in caplog.text
client.close()
def test_context_manager():
with Socrata(DOMAIN, APPTOKEN) as client:
assert isinstance(client, Socrata)
def test_context_manager_no_domain_exception():
with pytest.raises(Exception):
with Socrata(None, APPTOKEN):
pass
def test_context_manager_timeout_exception():
with pytest.raises(TypeError):
with Socrata(DOMAIN, APPTOKEN, timeout="fail"):
pass
def test_client_oauth():
client = Socrata(DOMAIN, APPTOKEN, access_token="AAAAAAAAAAAA")
assert client.session.headers.get("Authorization") == "OAuth AAAAAAAAAAAA"
def test_get():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
response_data = "get_songs.txt"
setup_mock(adapter, "GET", response_data, 200)
response = client.get(DATASET_IDENTIFIER)
assert isinstance(response, list)
assert len(response) == 10
client.close()
def test_get_all():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
setup_mock(adapter, "GET", "bike_counts_page_1.json", 200, query="$offset=0")
setup_mock(adapter, "GET", "bike_counts_page_2.json", 200, query="$offset=1000")
response = client.get_all(DATASET_IDENTIFIER)
assert inspect.isgenerator(response)
data = list(response)
assert len(data) == 1001
assert data[0]["date"] == "2016-09-21T15:45:00.000"
assert data[-1]["date"] == "2016-10-02T01:45:00.000"
client.close()
def test_get_unicode():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
response_data = "get_songs_unicode.txt"
setup_mock(adapter, "GET", response_data, 200)
response = client.get(DATASET_IDENTIFIER)
assert isinstance(response, list)
assert len(response) == 10
client.close()
def test_get_datasets():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
setup_datasets_mock(adapter, "get_datasets.txt", 200, params={"limit": "7"})
response = client.datasets(limit=7)
assert isinstance(response, list)
assert len(response) == 7
def test_get_metadata_and_attachments():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
response_data = "get_song_metadata.txt"
setup_old_api_mock(adapter, "GET", response_data, 200)
response = client.get_metadata(DATASET_IDENTIFIER)
assert isinstance(response, dict)
assert "newBackend" in response
assert "attachments" in response["metadata"]
response = client.download_attachments(DATASET_IDENTIFIER)
assert isinstance(response, list)
assert len(response) == 0
client.close()
def test_update_metadata():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
response_data = "update_song_metadata.txt"
setup_old_api_mock(adapter, "PUT", response_data, 200)
data = {"category": "Education", "attributionLink": "https://testing.updates"}
response = client.update_metadata(DATASET_IDENTIFIER, data)
assert isinstance(response, dict)
assert response.get("category") == data["category"]
assert response.get("attributionLink") == data["attributionLink"]
client.close()
def test_upsert_exception():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(DOMAIN, APPTOKEN, session_adapter=mock_adapter)
response_data = "403_response_json.txt"
setup_mock(adapter, "POST", response_data, 403, reason="Forbidden")
data = [
{
"theme": "Surfing",
"artist": "Wavves",
"title": "King of the Beach",
"year": "2010",
}
]
try:
client.upsert(DATASET_IDENTIFIER, data)
except Exception as e:
assert isinstance(e, requests.exceptions.HTTPError)
else:
raise AssertionError("No exception raised for bad request.")
def test_upsert():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "upsert_songs.txt"
data = [
{
"theme": "Surfing",
"artist": "Wavves",
"title": "King of the Beach",
"year": "2010",
}
]
setup_mock(adapter, "POST", response_data, 200)
response = client.upsert(DATASET_IDENTIFIER, data)
assert isinstance(response, dict)
assert response.get("Rows Created") == 1
client.close()
def test_replace():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "replace_songs.txt"
data = [
{
"theme": "Surfing",
"artist": "Wavves",
"title": "King of the Beach",
"year": "2010",
},
{
"theme": "History",
"artist": "Best Friends Forever",
"title": "Abe Lincoln",
"year": "2008",
},
]
setup_mock(adapter, "PUT", response_data, 200)
response = client.replace(DATASET_IDENTIFIER, data)
assert isinstance(response, dict)
assert response.get("Rows Created") == 2
client.close()
def test_delete():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
uri = "{}{}{}/{}.json".format(PREFIX, DOMAIN, OLD_API_PATH, DATASET_IDENTIFIER)
adapter.register_uri("DELETE", uri, status_code=200)
response = client.delete(DATASET_IDENTIFIER)
assert response.status_code == 200
try:
client.delete("foobar")
except Exception as e:
assert isinstance(e, requests_mock.exceptions.NoMockAddress)
finally:
client.close()
def test_create():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "create_foobar.txt"
setup_mock(adapter, "POST", response_data, 200, dataset_identifier=None)
columns = [
{"fieldName": "foo", "name": "Foo", "dataTypeName": "text"},
{"fieldName": "bar", "name": "Bar", "dataTypeName": "number"},
]
tags = ["foo", "bar"]
response = client.create(
"Foo Bar",
description="test dataset",
columns=columns,
tags=tags,
row_identifier="bar",
)
request = adapter.request_history[0]
request_payload = json.loads(request.text) # can't figure out how to use .json
# Test request payload
for dataset_key in ["name", "description", "columns", "tags"]:
assert dataset_key in request_payload
for column_key in ["fieldName", "name", "dataTypeName"]:
assert column_key in request_payload["columns"][0]
# Test response
assert isinstance(response, dict)
assert len(response.get("id")) == 9
client.close()
def test_set_permission():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "empty.txt"
setup_old_api_mock(adapter, "PUT", response_data, 200)
# Test response
response = client.set_permission(DATASET_IDENTIFIER, "public")
assert response.status_code == 200
# Test request
request = adapter.request_history[0]
query_string = request.url.split("?")[-1]
params = query_string.split("&")
assert len(params) == 2
assert "method=setPermission" in params
assert "value=public.read" in params
client.close()
def test_publish():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "create_foobar.txt"
setup_publish_mock(adapter, "POST", response_data, 200)
response = client.publish(DATASET_IDENTIFIER)
assert isinstance(response, dict)
assert len(response.get("id")) == 9
client.close()
def test_import_non_data_file():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "successblobres.txt"
nondatasetfile_path = "tests/test_data/nondatasetfile.zip"
setup_import_non_data_file(adapter, "POST", response_data, 200)
with open(nondatasetfile_path, "rb") as f:
files = {"file": ("nondatasetfile.zip", f)}
response = client.create_non_data_file({}, files)
assert isinstance(response, dict)
assert response.get("blobFileSize") == 496
client.close()
def test_replace_non_data_file():
mock_adapter = {}
mock_adapter["prefix"] = PREFIX
adapter = requests_mock.Adapter()
mock_adapter["adapter"] = adapter
client = Socrata(
DOMAIN,
APPTOKEN,
username=USERNAME,
password=PASSWORD,
session_adapter=mock_adapter,
)
response_data = "successblobres.txt"
nondatasetfile_path = "tests/test_data/nondatasetfile.zip"
setup_replace_non_data_file(adapter, "POST", response_data, 200)
with open(nondatasetfile_path, "rb") as fin:
file = {"file": ("nondatasetfile.zip", fin)}
response = client.replace_non_data_file(DATASET_IDENTIFIER, {}, file)
assert isinstance(response, dict)
assert response.get("blobFileSize") == 496
client.close()
def setup_publish_mock(
adapter,
method,
response,
response_code,
reason="OK",
dataset_identifier=DATASET_IDENTIFIER,
content_type="json",
):
path = os.path.join(TEST_DATA_PATH, response)
with open(path, "r") as response_body:
body = json.load(response_body)
uri = "{}{}{}/{}/publication.{}".format(
PREFIX, DOMAIN, OLD_API_PATH, dataset_identifier, content_type
)
headers = {"content-type": "application/json; charset=utf-8"}
adapter.register_uri(
method,
uri,
status_code=response_code,
json=body,
reason=reason,
headers=headers,
)
def setup_import_non_data_file(
adapter,
method,
response,
response_code,
reason="OK",
dataset_identifier=DATASET_IDENTIFIER,
content_type="json",
):
path = os.path.join(TEST_DATA_PATH, response)
with open(path, "r") as response_body:
body = json.load(response_body)
uri = "{}{}/api/imports2/?method=blob".format(PREFIX, DOMAIN)
headers = {"content-type": "application/json; charset=utf-8"}
adapter.register_uri(
method,
uri,
status_code=response_code,
json=body,
reason=reason,
headers=headers,
)
def setup_replace_non_data_file(
adapter,
method,
response,
response_code,
reason="OK",
dataset_identifier=DATASET_IDENTIFIER,
content_type="json",
):
path = os.path.join(TEST_DATA_PATH, response)
with open(path, "r") as response_body:
body = json.load(response_body)
uri = "{}{}{}/{}.{}?method=replaceBlob&id={}".format(
PREFIX, DOMAIN, OLD_API_PATH, dataset_identifier, "txt", dataset_identifier,
)
headers = {"content-type": "text/plain; charset=utf-8"}
adapter.register_uri(
method,
uri,
status_code=response_code,
json=body,
reason=reason,
headers=headers,
)
def setup_old_api_mock(
adapter,
method,
response,
response_code,
reason="OK",
dataset_identifier=DATASET_IDENTIFIER,
content_type="json",
):
path = os.path.join(TEST_DATA_PATH, response)
with open(path, "r") as response_body:
try:
body = json.load(response_body)
except ValueError:
body = None
uri = "{}{}{}/{}.{}".format(
PREFIX, DOMAIN, OLD_API_PATH, dataset_identifier, content_type
)
headers = {"content-type": "application/json; charset=utf-8"}
adapter.register_uri(
method,
uri,
status_code=response_code,
json=body,
reason=reason,
headers=headers,
)
def setup_datasets_mock(adapter, response, response_code, reason="OK", params={}):
path = os.path.join(TEST_DATA_PATH, response)
with open(path, "r") as response_body:
body = json.load(response_body)
uri = "{}{}{}".format(PREFIX, DOMAIN, DATASETS_PATH)
if "offset" not in params:
params["offset"] = 0
uri = "{}?{}".format(
uri, "&".join(["{}={}".format(k, v) for k, v in params.items()])
)
headers = {"content-type": "application/json; charset=utf-8"}
adapter.register_uri(
"get", uri, status_code=response_code, json=body, reason=reason, headers=headers
)
def setup_mock(
adapter,
method,
response,
response_code,
reason="OK",
dataset_identifier=DATASET_IDENTIFIER,
content_type="json",
query=None,
):
path = os.path.join(TEST_DATA_PATH, response)
with open(path, "r") as response_body:
body = json.load(response_body)
if dataset_identifier is None: # for create endpoint
uri = "{}{}{}.{}".format(PREFIX, DOMAIN, OLD_API_PATH, "json")
else: # most cases
uri = "{}{}{}{}.{}".format(
PREFIX, DOMAIN, DEFAULT_API_PATH, dataset_identifier, content_type
)
if query:
uri += "?" + query
headers = {"content-type": "application/json; charset=utf-8"}
adapter.register_uri(
method,
uri,
status_code=response_code,
json=body,
reason=reason,
headers=headers,
complete_qs=True,
)
|