Refactored citation changes protobuf (#38)

.gitignore

@@ -99,3 +99,5 @@ ENV/
 
 # mypy
 .mypy_cache/
+
+python/

adsmsg/__init__.py

@@ -9,3 +9,4 @@
 from .orcid_claims import OrcidClaims
 from .status import Status
 from .citation_changes import CitationChanges, CitationChange
+from .citation_changes_content_type import CitationChangeContentType

adsmsg/citation_changes_content_type.py

@@ -0,0 +1,2 @@
+from .msg import Msg
+from .protobuf import citation_changes_content_type_pb2 as CitationChangeContentType

adsmsg/tests/test_citation_changes.py

@@ -2,7 +2,7 @@
 import os
 
 import unittest
-from adsmsg import CitationChanges, CitationChange, Status
+from adsmsg import CitationChanges, CitationChange, CitationChangeContentType, Status
 
 
 class TestCitationChanges(unittest.TestCase):
@@ -20,38 +20,34 @@ def test_is_valid(self):
         citation_change = citation_changes.changes.add()
         citation_change.citing = "1005PhRvC..71c4906H"
         citation_change.cited = "1976NuPhB.113..395J"
-        citation_change.doi = "10.1016/0550-3213(76)90133-4"
-        citation_change.pid = ""
-        citation_change.url = ""
-        citation_change.score = "1"
+        citation_change.content = "10.1016/0550-3213(76)90133-4"
+        citation_change.content_type = CitationChangeContentType.doi
+        citation_change.resolved = True
         citation_change.status = Status.new
         citation_change = citation_changes.changes.add()
         citation_change.citing = "2017SSEle.128..141M"
         citation_change.cited = "..................."
-        citation_change.doi = ""
-        citation_change.pid = ""
-        citation_change.url = "https://github.com/viennats/viennats-dev"
-        citation_change.score = "0"
+        citation_change.content = "https://github.com/viennats/viennats-dev"
+        citation_change.content_type = CitationChangeContentType.url
+        citation_change.resolved = True
         citation_change.status = Status.new
         citation_change = citation_changes.changes.add()
         citation_change.citing = "2017PASP..129b4005R"
         citation_change.cited = "2013ascl.soft03021B"
-        citation_change.doi = ""
-        citation_change.pid = "ascl:1303.021"
-        citation_change.url = ""
-        citation_change.score = "1"
+        citation_change.content = "ascl:1303.021"
+        citation_change.content_type = CitationChangeContentType.pid
+        citation_change.resolved = True
         citation_change.status = Status.new
         self.assertTrue(citation_changes.is_valid())
 
     def test_individual_is_valid(self):
-        citation_change = CitationChange(citing= "1005PhRvC..71c4906H", cited= "1976NuPhB.113..395J", doi='10.1016/0550-3213(76)90133-4', score='1', status='new')
+        citation_change = CitationChange(citing= "1005PhRvC..71c4906H", cited= "1976NuPhB.113..395J", content='10.1016/0550-3213(76)90133-4', content_type=CitationChangeContentType.doi, resolved=True, status='new')
         self.assertTrue(citation_change.is_valid())
         self.assertEqual(citation_change.citing, "1005PhRvC..71c4906H")
         self.assertEqual(citation_change.cited, "1976NuPhB.113..395J")
-        self.assertEqual(citation_change.doi, "10.1016/0550-3213(76)90133-4")
-        self.assertEqual(citation_change.pid, "")
-        self.assertEqual(citation_change.url, "")
-        self.assertEqual(citation_change.score, "1")
+        self.assertEqual(citation_change.content, "10.1016/0550-3213(76)90133-4")
+        self.assertEqual(citation_change.content_type, CitationChangeContentType.doi)
+        self.assertTrue(citation_change.resolved)
         self.assertEqual(citation_change.status, Status.new)
 
 

dev-requirements.txt

@@ -2,4 +2,6 @@ pytest==2.8.2
 coveralls==1.1.0
 mock==1.3.0
 coverage==4.0.1
-pytest-cov==2.2.0
+pytest-cov==2.2.0
+pudb==2017.1.4
+pytest-pudb==0.5

specs/citation_changes.proto

@@ -1,5 +1,6 @@
 syntax = "proto3";
 import "status.proto";
+import "citation_changes_content_type.proto";
 package adsmsg;
 
 message CitationChanges {
@@ -9,10 +10,9 @@ message CitationChanges {
 message CitationChange {
     string citing = 1;
     string cited = 2;
-    string doi = 3;
-    string pid = 4;
-    string url = 5;
-    string score = 6;
-    Status status = 7;
+    CitationChangeContentType content_type = 3;
+    string content = 4;
+    bool resolved = 5;
+    Status status = 6;
 }
 

specs/citation_changes_content_type.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+package adsmsg;
+
+enum CitationChangeContentType {
+  doi = 0;
+  pid = 1;
+  url = 2;
+}