def test_get_no_result(self):
client = Client(self.test_entry_point)
mock_connector = Mock(**{'get.return_value': None})
client.connector = mock_connector
result = client.get(self.data_url)
self.assertEqual(result, None)
self.assertEqual(client.document, None)
def test_gain_bad_url_raise_no_token(self):
client = Client(self.test_entry_point)
bad_vals_no_href = {'rels': ['urn:collectiondoc:form:issuetoken'],
'hints': {'docs':
'http://docs.pmp.io/wiki/Authentication-Model#token-management',
'allow': ['POST']},
'title': 'Issue OAuth2 Token',
'nohref': ''}
bad_vals = {'rels': ['urn:collectiondoc:form:issuetoken'],
'hints': {'docs':
'http://docs.pmp.io/wiki/Authentication-Model#token-management',
'allow': ['POST']},
'title': 'Issue OAuth2 Token',
'href': ''}
with patch.object(NavigableDoc,
'options',
return_value=bad_vals_no_href) as mocker:
with self.assertRaises(NoToken):
client.gain_access('client-id', 'client-secret')
with patch.object(NavigableDoc,
'options',
return_value=bad_vals) as mocker:
with self.assertRaises(NoToken):
client.gain_access('client-id', 'client-secret')
def test_delete(self):
client = Client(self.test_entry_point)
response = Mock(**{"json.return_value": self.home_values})
with patch.object(requests, 'get', return_value=response):
client.gain_access('client-id', 'client-secret')
document = client.get(self.data_url)
item = NavigableDoc(document.items[5])
self.assertTrue(client.delete(item))
def test_home(self):
client = Client(self.test_entry_point)
mock_connector = Mock(**{'get.return_value': self.home_values})
client.connector = mock_connector
result = client.home()
self.assertTrue(result)
self.assertTrue(result.links)
self.assertEqual(len(result.links), 7)
def test_save(self):
client = Client(self.test_entry_point)
response = Mock(**{"json.return_value": self.home_values})
with patch.object(requests, 'get', return_value=response):
client.gain_access('client-id', 'client-secret')
put_url = "http://127.0.0.1:8080/?json_response={}"
success = os.path.join(self.fixture_dir, 'successful_put.json')
self.assertTrue(client.save(put_url.format(success), self.data_doc))
def test_prev(self):
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
client.get(self.data_url)
with patch.object(Client, 'get') as mock_get:
self.assertEqual(client.prev(), None)
def test_load_last_page_in_history(self):
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
client.current_page = self.test_entry_point
client.history.append(self.data_url)
client.get(self.data_url)
self.assertEqual(client.history, [])
self.assertEqual(client.forward_stack, [self.test_entry_point])
def test_gain_access_makes_pager(self):
client = Client(self.test_entry_point)
resp = requests.get(self.test_entry_point).json()
expected_doc = NavigableDoc(resp)
with patch.object(PmpAuth, 'get_access_token2',
return_value=self.home_values) as mocker:
client.gain_access('client-id', 'client-secret')
self.assertEqual(expected_doc.links, client.document.links)
self.assertEqual(expected_doc.items, client.document.items)
self.assertEqual(expected_doc.querylinks, client.document.querylinks)
def test_gain_access_find_correct_urn(self):
client = Client(self.test_entry_point)
with open(self.auth_doc, 'r') as jfile:
values = json.loads(jfile.read())
expected_url = 'http://127.0.0.1:8080/auth/access_token?json_response'
expected_url += '=fixtures/authdetails.json'
with patch.object(PmpAuth, 'get_access_token2',
return_value=values) as mocker:
client.gain_access('client-id', 'client-secret')
mocker.assert_called_with(expected_url)
def test_get_makes_history(self):
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
# current page should be set to None until first request
self.assertEqual(client.current_page, None)
client.get(self.data_url)
self.assertEqual(client.current_page, self.data_url)
self.assertEqual(client.history, [])
def test_history_collected(self):
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
client.current_page = self.data_url
# History won't be collected until our second page
client.get(self.test_url)
self.assertNotEqual(client.history, [])
self.assertEqual(client.history[-1], self.data_url)
def test_client_pager(self):
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
client.get(self.data_url)
self.assertNotEqual(client.pager, None)
self.assertTrue(client.pager.navigable)
self.assertEqual(client.pager.next, self.nav_values['next'])
self.assertEqual(client.pager.prev, None)
self.assertEqual(client.pager.first, self.nav_values['first'])
self.assertEqual(client.pager.last, self.nav_values['last'])
self.assertEqual(client.pager.current, self.nav_values['current'])
def test_back(self):
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
client.current_page = self.test_entry_point
client.get(self.data_url)
with patch.object(Client, 'get') as mock_get:
client.back()
mock_get.assert_called_with(self.test_entry_point)
def test_query(self):
# Repeat the three previous tests as end-to-end test
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_get = Mock(return_value=values)
client.get = mock_get
client.document = NavigableDoc(values)
result = client.query('urn:collectiondoc:query:docs',
params={'tag': 'sometag'})
self.assertTrue(result)
self.assertEqual(len(client.document.items), 10)
with self.assertRaises(BadQuery):
client.query('urn:collectiondoc:query:docs',
params={'badtag': 'sometag'})
def test_history_end2end(self):
# Repeat the three previous tests as end-to-end test
client = Client(self.test_entry_point)
with open(self.data_doc, 'r') as jfile:
values = json.loads(jfile.read())
mock_connector = Mock(**{'get.return_value': values})
client.connector = mock_connector
# current page should be set to None until first request
self.assertEqual(client.current_page, None)
client.get(self.data_url)
self.assertEqual(client.current_page, self.data_url)
self.assertEqual(client.history, [])
# History won't be collected until our second page
client.get(self.test_url)
self.assertNotEqual(client.history, [])
self.assertEqual(client.history[-1], self.data_url)
# History will empty if we request last page in history stack
client.get(self.data_url)
self.assertEqual(client.history, [])
self.assertEqual(client.forward_stack, [self.test_url])
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Created on Sun Feb 3 11:06:53 2019
@author: Olukolade Adelabi
This program was made to retreive information from NPR's Public Media Platform
created using a Python PMP SDK https://github.com/KPBS/py3-pmp-wrapper
"""
## IMPORT ##
from pmp_api.pmp_client import Client
## API CREDENTIALS VARIABLES ##
client = Client("https://api.pmp.io")
CLIENT_ID = '4e88e60d-0ffa-493d-bed9-8686e7b2e892'
CLIENT_SECRET = 'e0c46a55c8790cbea20a6917'
## AUTHENTICATE ACCESS ##
client.gain_access(CLIENT_ID, CLIENT_SECRET)
## GET STORY POST ##
print("Visit https://support.pmp.io/ to gather a GUID")
GUID = input("Please enter the GUID of the post(s) you are looking for: ")
document = client.query('urn:collectiondoc:query:docs', params={"guid": GUID})
collect = document.collectiondoc
## Check for type ##
is_audio = "https://api.pmp.io/profiles/audio"
is_image = "https://api.pmp.io/profiles/image"
def test_gain_access_with_server(self):
client = Client(self.test_entry_point)
response = Mock(**{"json.return_value": self.home_values})
with patch.object(requests, 'get', return_value=response):
# We have to patch the first request for the homedoc...
client.gain_access('client-id', 'client-secret')
def test_get_without_connector_raise_no_auth_token(self):
client = Client(self.test_url)
with self.assertRaises(NoToken):
client.get(self.test_url)
