Skip to content

Commit

Permalink
Rename ProviderClient -> MultipleProviderClient
Browse files Browse the repository at this point in the history
Perhaps an improvement to names, re:

CityofSantaMonica#46
CityofSantaMonica#35
  • Loading branch information
ezheidtmann committed Dec 12, 2018
1 parent b26c7ce commit 6bd9070
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
3 changes: 1 addition & 2 deletions mds/api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
Module implementing the MDS Provider API.
"""

from mds.api.client import ProviderClient

from mds.api.client import MultipleProviderClient
14 changes: 7 additions & 7 deletions mds/api/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def _prepare_trips_params(
}


class SingleProviderClient(ProviderClientBase):
class ProviderClient(ProviderClientBase):
def __init__(self, provider):
self.provider = provider

Expand Down Expand Up @@ -147,13 +147,13 @@ def __next_url(page):
break


class ProviderClient(ProviderClientBase):
class MultipleProviderClient(ProviderClientBase):
"""
Client for MDS Provider APIs
"""
def __init__(self, providers=None, ref=None):
"""
Initialize a new ProviderClient object.
Initialize a new MultipleProviderClient object.
:providers: is a list of Providers this client tracks by default. If None is given, downloads and uses the official Provider registry.
Expand All @@ -164,7 +164,7 @@ def __init__(self, providers=None, ref=None):
"""
self.providers = providers if providers is not None else get_registry(ref)

def _request(self, providers, endpoint, params, paging):
def _request_from_providers(self, providers, endpoint, params, paging):
"""
Internal helper for sending requests.
Expand All @@ -184,7 +184,7 @@ def __describe(res):

results = {}
for provider in providers:
client = SingleProviderClient(provider)
client = ProviderClient(provider)
try:
results[provider] = list(client.request(endpoint, params, paging))
except requests.RequestException as exc:
Expand Down Expand Up @@ -228,7 +228,7 @@ def get_status_changes(
params = self._prepare_status_changes_params(**kwargs)

# make the request(s)
status_changes = self._request(providers, mds.STATUS_CHANGES, params, paging)
status_changes = self._request_from_providers(providers, mds.STATUS_CHANGES, params, paging)

return status_changes

Expand Down Expand Up @@ -272,6 +272,6 @@ def get_trips(
params = self._prepare_trips_params(**kwargs)

# make the request(s)
trips = self._request(providers, mds.TRIPS, params, paging)
trips = self._request_from_providers(providers, mds.TRIPS, params, paging)

return trips
4 changes: 2 additions & 2 deletions mds/tests/test_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from mds.fake.server import make_static_server_app
from mds.providers import Provider
from mds.api import ProviderClient
from mds.api import MultipleProviderClient


def requests_mock_with_app(app, netloc='testserver'):
Expand Down Expand Up @@ -53,7 +53,7 @@ def setUp(self):

def _all_items_from_app(self, app, endpoint='trips', get_method_kwargs={}):
with mock_provider(app) as provider:
client = ProviderClient(providers=[provider])
client = MultipleProviderClient(providers=[provider])
method = getattr(client, f'get_{endpoint}')
pages_by_provider = method(**get_method_kwargs)

Expand Down

0 comments on commit 6bd9070

Please sign in to comment.