@@ -7,5 +7,6 @@ *.iml *.iws *.egg-info +*.egg dist build .gitignore @@ -11,7 +11,7 @@ class Activity(object): """ - def __init__(self, at=None, action=None, activity_id=None, url=None, sources=None, places=None, actors=None, + def __init__(self, at=None, action=None, activity_id=None, url=None, sources=None, keywords=None, places=None, actors=None, destination_urls=None, tags=None, tos=None, regarding_urls=None, payload=None): """Initialize the class. @@ -25,6 +25,8 @@ class Activity(object): @param url URL of activity @type sources List of strings @param sources Sources of the activity + @type keywords List of Strings + @param keywords Keywords about an activity @type places List of Places @param places Place of the activity @type actors List of Actors @@ -49,6 +51,7 @@ class Activity(object): self.activity_id = activity_id self.url = url self.sources = sources + self.keywords = keywords self.places = places self.actors = actors self.destination_urls = destination_urls @@ -66,7 +69,6 @@ class Activity(object): '2008-07-01T05:02:03+00:00'. """ - return self.at.strftime("%Y-%m-%dT%H:%M:%S.000Z") def set_at_from_string(self, string): @@ -78,7 +80,6 @@ class Activity(object): Sets 'at' attribute from an ISO8601 formatted string. """ - self.at = iso8601.parse_date(string) def from_xml(self, xml): @@ -90,7 +91,6 @@ class Activity(object): Sets all of the member variables to new values, based on the passed in XML. """ - root_node = fromstring(xml) self.from_xml_node(root_node) @@ -103,7 +103,6 @@ class Activity(object): Returns a XML representation of this object. """ - activity_node = Element("activity") if self.at is not None: @@ -131,6 +130,12 @@ class Activity(object): source_node = Element("source") source_node.text = source activity_node.append(source_node) + + if self.keywords is not None and len(self.keywords) > 0: + for keyword in self.keywords: + keyword_node = Element("keyword") + keyword_node.text = keyword + activity_node.append(keyword_node) if self.places is not None and len(self.places) > 0: for a_place in self.places: @@ -214,6 +219,15 @@ class Activity(object): else: self.sources = None + keyword_nodes = xml_node.findall("keyword") + if keyword_nodes is not None: + self.keywords = [] + for keyword_node in keyword_nodes: + keyword = keyword_node.text + self.keywords.append(keyword) + else: + self.keywords = None + place_nodes = xml_node.findall("place") if place_nodes is not None: self.places = [] @@ -280,6 +294,7 @@ class Activity(object): ", " + str(self.activity_id) + \ ", " + str(self.url) + \ ", " + str(self.sources) + \ + ", " + str(self.keywords) + \ ", " + str(self.places) + \ ", " + str(self.actors) + \ ", " + str(self.destination_urls) + \ gnip/activity.py @@ -60,25 +60,28 @@ class Payload(object): if payload_xml_node is not None: title_node = payload_xml_node.find("title") - if title_node is not None: self.title = title_node.text else: self.title = None body_node = payload_xml_node.find("body") - if body_node is not None: self.body = body_node.text else: self.body = None media_url_nodes = payload_xml_node.findall("mediaURL") - if media_url_nodes is not None: self.media_urls = [] for media_url_node in media_url_nodes: - media_url = xml_objects.URL(value=media_url_node.text, meta_url=media_url_node.get("metaURL")) + media_url = xml_objects.MediaURL(value=media_url_node.text, + height=media_url_node.get("height"), + width=media_url_node.get("width"), + duration=media_url_node.get("duration"), + type=media_url_node.get("type"), + mimetype=media_url_node.get("mimeType") + ) self.media_urls.append(media_url) else: self.media_urls = None @@ -111,8 +114,16 @@ class Payload(object): for media_url in self.media_urls: media_url_node = Element("mediaURL") media_url_node.text = media_url.value - if media_url.meta_url is not None: - media_url_node.set("metaURL", media_url.meta_url) + if media_url.height is not None: + media_url_node.set("height", media_url.height) + if media_url.width is not None: + media_url_node.set("width", media_url.width) + if media_url.duration is not None: + media_url_node.set("duration", media_url.duration) + if media_url.type is not None: + media_url_node.set("type", media_url.type) + if media_url.mimetype is not None: + media_url_node.set("mimeType", media_url.mimetype) payload_node.append(media_url_node) if self.__raw is not None: gnip/payload.py @@ -26,6 +26,51 @@ class URL(object): ret = 1 return ret +class MediaURL(object): + """Gnip Media URL container class. + + value: string representation of the media URL + height: string the height + width: string the width + duration: string the duration of the linked media + type: string the Gnip normalized type of the linked media + mimeType: string the mimeType of the linked media + """ + + def __init__(self, value=None, height=None, width=None, duration=None, type=None, mimetype=None): + self.value = value + self.height = height + self.width = width + self.duration = duration + self.type = type + self.mimetype = mimetype + + def __str__(self): + return "[" + str(self.value) + ", " \ + + str(self.height) + ", "\ + + str(self.width) + ", "\ + + str(self.duration) + ", "\ + + str(self.type) + ", "\ + + str(self.mimetype) \ + + "]" + + def __cmp__(self, other): + if isinstance(other, MediaURL): + ret = cmp(self.value, other.value) + if ret == 0: + ret = cmp(self.height, other.height) + if ret == 0: + ret = cmp(self.width, other.width) + if ret == 0: + ret = cmp(self.duration, other.duration) + if ret == 0: + ret = cmp(self.type, other.type) + if ret == 0: + ret = cmp(self.mimetype, other.mimetype) + else: + ret = 1 + return ret + class Actor(object): """Gnip Actor container class gnip/xml_objects.py @@ -75,10 +75,9 @@ class ActivityTestCase(unittest.TestCase): self.testTitleValue = "the_title" self.testBodyValue = "the_body" - self.testMediaURLMetaURL1 = "mediaURL_metaURL_1" - self.testMediaUrlValue1 = "the_mediaURL_1" - self.testMediaURLMetaURL2 = "mediaURL_metaURL_2" - self.testMediaUrlValue2 = "the_mediaURL_2" + self.testMediaURL0 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + self.testMediaURL1 = MediaURL("http://www.example.com/somevideo.qt") + self.testRaw = "the_raw" def testTimeStringConversionFromDatetime(self): @@ -228,10 +227,8 @@ class ActivityTestCase(unittest.TestCase): self.assertEqual(an_activity.payload.title, self.testTitleValue) self.assertEqual(an_activity.payload.body, self.testBodyValue) - self.assertEqual(an_activity.payload.media_urls[0].value, self.testMediaUrlValue1) - self.assertEqual(an_activity.payload.media_urls[0].meta_url, self.testMediaURLMetaURL1) - self.assertEqual(an_activity.payload.media_urls[1].meta_url, self.testMediaURLMetaURL2) - self.assertEqual(an_activity.payload.media_urls[1].value, self.testMediaUrlValue2) + self.assertEqual(an_activity.payload.media_urls[0], self.testMediaURL0) + self.assertEqual(an_activity.payload.media_urls[1], self.testMediaURL1) self.assertEqual(an_activity.payload.read_raw(), self.testRaw) @@ -244,8 +241,7 @@ class ActivityTestCase(unittest.TestCase): a_payload = payload.Payload(title=self.testTitleValue, body=self.testBodyValue, - media_urls=[URL(value=self.testMediaUrlValue1, meta_url=self.testMediaURLMetaURL1), - URL(value=self.testMediaUrlValue2, meta_url=self.testMediaURLMetaURL2)], + media_urls=[self.testMediaURL0, self.testMediaURL1], raw=self.testRaw) an_activity = activity.Activity(action=self.testActionValue, test/activity_test.py @@ -1 +1 @@ -<activity><at>2001-01-01T01:01:00.000Z</at><action>the_action</action><activityID>the_activityID</activityID><URL>the_URL</URL><source>the_source_1</source><source>the_source_2</source><place><point>1.0 -2.0</point><elev>3.0</elev><floor>4</floor><featuretypetag>the_featuretypetag_1</featuretypetag><featurename>the_featurename_1</featurename><relationshiptag>the_relationshiptag_1</relationshiptag></place><place><point>11.0 -12.0</point><elev>13.0</elev><floor>14</floor><featuretypetag>the_featuretypetag_2</featuretypetag><featurename>the_featurename_2</featurename><relationshiptag>the_relationshiptag_2</relationshiptag></place><actor metaURL="actor_metaURL_1" uid="actor_uid_1">the_actor_1</actor><actor metaURL="actor_metaURL_2" uid="actor_uid_2">the_actor_2</actor><destinationURL metaURL="destinationURL_metaURL_1">the_destinationURL_1</destinationURL><destinationURL metaURL="destinationURL_metaURL_2">the_destinationURL_2</destinationURL><tag metaURL="tag_metaURL_1">tag_metaURL_1</tag><tag metaURL="tag_metaURL_2">tag_metaURL_2</tag><to metaURL="to_metaURL_1">the_to_1</to><to metaURL="to_metaURL_2">the_to_2</to><regardingURL metaURL="regardingURL_metaURL_1">the_regardingURL_1</regardingURL><regardingURL metaURL="regardingURL_metaURL_2">the_regardingURL_2</regardingURL><payload><title>the_title</title><body>the_body</body><mediaURL metaURL="mediaURL_metaURL_1">the_mediaURL_1</mediaURL><mediaURL metaURL="mediaURL_metaURL_2">the_mediaURL_2</mediaURL><raw>H4sIAMG3eEkC/yvJSI0vSiwHAP9DokYHAAAA</raw></payload></activity> \ No newline at end of file +<activity><at>2001-01-01T01:01:00.000Z</at><action>the_action</action><activityID>the_activityID</activityID><URL>the_URL</URL><source>the_source_1</source><source>the_source_2</source><place><point>1.0 -2.0</point><elev>3.0</elev><floor>4</floor><featuretypetag>the_featuretypetag_1</featuretypetag><featurename>the_featurename_1</featurename><relationshiptag>the_relationshiptag_1</relationshiptag></place><place><point>11.0 -12.0</point><elev>13.0</elev><floor>14</floor><featuretypetag>the_featuretypetag_2</featuretypetag><featurename>the_featurename_2</featurename><relationshiptag>the_relationshiptag_2</relationshiptag></place><actor metaURL="actor_metaURL_1" uid="actor_uid_1">the_actor_1</actor><actor metaURL="actor_metaURL_2" uid="actor_uid_2">the_actor_2</actor><destinationURL metaURL="destinationURL_metaURL_1">the_destinationURL_1</destinationURL><destinationURL metaURL="destinationURL_metaURL_2">the_destinationURL_2</destinationURL><tag metaURL="tag_metaURL_1">tag_metaURL_1</tag><tag metaURL="tag_metaURL_2">tag_metaURL_2</tag><to metaURL="to_metaURL_1">the_to_1</to><to metaURL="to_metaURL_2">the_to_2</to><regardingURL metaURL="regardingURL_metaURL_1">the_regardingURL_1</regardingURL><regardingURL metaURL="regardingURL_metaURL_2">the_regardingURL_2</regardingURL><payload><title>the_title</title><body>the_body</body><mediaURL duration="2:30" height="70px" mimeType="audio/mpeg" type="audio" width="80px">http://www.example.com/somemedia.mp3</mediaURL><mediaURL>http://www.example.com/somevideo.qt</mediaURL><raw>H4sIAMG3eEkC/yvJSI0vSiwHAP9DokYHAAAA</raw></payload></activity> \ No newline at end of file test/activity_with_payload.xml @@ -57,12 +57,12 @@ class GnipTestCase(unittest.TestCase): def testPublishActivities(self): randVal = str(random.randint(1, 99999999)) a_place1 = place.Place(xml_objects.Point(1.0, -2.0), 3, 4, "city", "Boulder", "center") - a_place2 = place.Place(xml_objects.Point(11.0, -12.0), 13, 14, "city", "Boulder", "center") a_payload = payload.Payload(title="Title", body="Body", - media_urls=[xml_objects.URL(value="http://media1.com", meta_url="http://media1.com/meta"), xml_objects.URL(value="http://media2.com", meta_url="http://media2.com/meta")], + media_urls=[xml_objects.MediaURL(value="http://media1.com"), + xml_objects.MediaURL(value="http://media2.com")], raw="raw") an_activity = activity.Activity(action="update", test/gnip_test.py @@ -83,5 +83,39 @@ class XmlObjectsTest(unittest.TestCase): error2 = Error("Hello Cruel World!") self.assertEquals("Hello Cruel World!", error2.message) + def testMediaURLsAreEqual(self): + m1 = MediaURL("http://www.example.com/somemedia.mp3") + m2 = MediaURL("http://www.example.com/somemedia.mp3") + self.assertEqual(m1, m2) + + m1 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + m2 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + self.assertEqual(m1, m2) + + def testMediaURLsArentEqual(self): + m1 = MediaURL("http://www.example.com/somemedia.mp3") + m2 = MediaURL("http://www.example.com/someothermedia.mp3") + self.assertNotEqual(m1, m2) + + m1 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + m2 = MediaURL("http://www.example.com/somemedia.mp3", "71px", "80px", "2:30", "audio", "audio/mpeg") + self.assertNotEqual(m1, m2) + + m1 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + m2 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "81px", "2:30", "audio", "audio/mpeg") + self.assertNotEqual(m1, m2) + + m1 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + m2 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:31", "audio", "audio/mpeg") + self.assertNotEqual(m1, m2) + + m1 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + m2 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "video", "audio/mpeg") + self.assertNotEqual(m1, m2) + + m1 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg") + m2 = MediaURL("http://www.example.com/somemedia.mp3", "70px", "80px", "2:30", "audio", "audio/mpeg4") + self.assertNotEqual(m1, m2) + if __name__ == '__main__': unittest.main() test/xml_objects_test.py 12646f22e4526eac1edb7f39e6fa260d3984e3e7 Alex Jackson alex@gnipcentral.com http://github.com/gnip/gnip-python/commit/e907f5c3b9a18c7898c1f53fbea9f5e79303ad89 e907f5c3b9a18c7898c1f53fbea9f5e79303ad89 2009-01-26T14:56:37-08:00 2009-01-26T13:39:23-08:00 Add new attributes to mediaURL Ensure point is optional in place Add keywords to activity Signed-off-by: Ingrid Alongi <ingrid@gnipcentral.com> ca17030018191bee84b49145db77208a94f1780f Ingrid Alongi ingrid@gnipcentral.com