PlumX: Update allowed ID types

Author: Michael-E-Rose

pybliometrics/scopus/plumx_metrics.py

@@ -83,38 +83,14 @@ def __init__(self,
 
         :param identifier: The identifier of a document.
         :param id_type: The type of used ID. Allowed values are:
-                        - 'airitiDocId'
-                        - 'arxivId'
-                        - 'cabiAbstractId'
-                        - 'citeulikeId'
-                        - 'digitalMeasuresArtifactId'
-                        - 'doi'
-                        - 'elsevierId'
-                        - 'elsevierPii'
-                        - 'facebookCountUrlId'
-                        - 'figshareArticleId'
-                        - 'isbn'
-                        - 'lccn'
-                        - 'medwaveId'
-                        - 'nctId'
-                        - 'oclc'
-                        - 'pittEprintDscholarId'
-                        - 'pmcid'
-                        - 'pmid'
-                        - 'redditId'
-                        - 'repecHandle'
-                        - 'repoUrl'
-                        - 'scieloId'
-                        - 'sdEid'
-                        - 'slideshareUrlId'
-                        - 'smithsonianPddrId'
-                        - 'soundcloudTrackId'
-                        - 'ssrnId'
-                        - 'urlId'
-                        - 'usPatentApplicationId'
-                        - 'usPatentPublicationId'
-                        - 'vimeoVideoId'
-                        - 'youtubeVideoId'
+                        'airitiDocId'; 'cabiAbstractId'; 'citeulikeId';
+                        'digitalMeasuresArtifactId'; 'doi'; 'elsevierId';
+                        'elsevierPii'; 'facebookCountUrlId';
+                        'figshareArticleId'; 'isbn'; 'lccn'; 'medwaveId';
+                        'nctId'; 'oclc'; 'pittEprintDscholarId'; 'pmcid';
+                        'pmid'; 'redditId'; 'repecHandle'; 'repoUrl';
+                        'scieloId'; 'sdEid'; 'slideshareUrlId';
+                        'smithsonianPddrId'; 'ssrnId'; 'urlId'
         :param refresh: Whether to refresh the cached file if it exists or not.
                         If `int` is passed, cached file will be refreshed if the
                         number of days since last modification exceeds that value.
@@ -133,16 +109,13 @@ def __init__(self,
         where `path` is specified in your configuration file.
         """
         # Checks
-        allowed = ('airitiDocId', 'arxivId', 'cabiAbstractId',
-                   'citeulikeId', 'digitalMeasuresArtifactId', 'doi',
-                   'elsevierId', 'elsevierPii', 'facebookCountUrlId',
-                   'figshareArticleId', 'isbn', 'lccn', 'medwaveId',
-                   'nctId', 'oclc', 'pittEprintDscholarId', 'pmcid',
-                   'pmid', 'redditId', 'repecHandle', 'repoUrl', 'scieloId',
-                   'sdEid', 'slideshareUrlId', 'smithsonianPddrId',
-                   'soundcloudTrackId', 'ssrnId', 'urlId',
-                   'usPatentApplicationId', 'usPatentPublicationId',
-                   'vimeoVideoId', 'youtubeVideoId')
+        allowed = ('airitiDocId', 'cabiAbstractId', 'citeulikeId',
+                   'digitalMeasuresArtifactId', 'doi', 'elsevierId',
+                   'elsevierPii', 'facebookCountUrlId', 'figshareArticleId',
+                   'isbn', 'lccn', 'medwaveId', 'nctId', 'oclc',
+                   'pittEprintDscholarId', 'pmcid', 'pmid', 'redditId',
+                   'repecHandle', 'repoUrl', 'scieloId', 'sdEid',
+                   'slideshareUrlId', 'smithsonianPddrId', 'ssrnId', 'urlId')
         check_parameter_value(id_type, allowed, "id_type")
         self._id_type = id_type
         self._identifier = identifier

pybliometrics/scopus/tests/test_PlumXMetrics.py

@@ -12,34 +12,24 @@
 m2 = PlumXMetrics('10.2307/2281868', 'doi', refresh=30)
 # A published paper. No PlumX Metrics.
 m3 = PlumXMetrics('2-s2.0-84950369844', 'elsevierId', refresh=30)
-# An arXiv paper. No Citation metrics.
-m4 = PlumXMetrics('1507.02672', 'arxivId', refresh=30)
 # A published book. No Social Media metrics.
-m5 = PlumXMetrics('9783540783893', 'isbn', refresh=30)
+m4 = PlumXMetrics('9783540783893', 'isbn', refresh=30)
 # A SSRN paper. No mention metrics.
-m6 = PlumXMetrics('3320470', 'ssrnId', refresh=30)
-# A YouTube video. No Capture and Citation metrics.
-m7 = PlumXMetrics('dQw4w9WgXcQ', 'youtubeVideoId', refresh=30)
+m5 = PlumXMetrics('3320470', 'ssrnId', refresh=30)
 
 
 def test_category_totals():
     m1_received = sorted([c.name  for c in m1.category_totals])
-    m1_expected = ['capture', 'citation', 'mention', 'socialMedia', 'usage']
+    m1_expected = ['capture', 'citation', 'mention', 'socialMedia']
     assert_equal(m1_received, m1_expected)
     m2_received = sorted([c.name  for c in m2.category_totals])
     m2_expected = ['capture', 'citation', 'mention']
     assert_equal(m2_received, m2_expected)
     assert_equal(m3.category_totals, None)
-    m4_received = sorted([c.name  for c in m4.category_totals])
-    m4_expected = ['citation', 'mention', 'socialMedia']
-    assert_equal(m4_received, m4_expected)
-    m6_received = sorted([c.name  for c in m6.category_totals])
-    m6_expected = ['capture', 'citation', 'socialMedia', 'usage']
-    assert_equal(m6_received, m6_expected)
-    m7_received = sorted([c.name  for c in m7.category_totals])
-    m7_expected = ['mention', 'socialMedia', 'usage']
-    assert_equal(m7_received, m7_expected)
-    for plumx in (m1, m2, m4, m5, m6, m7):
+    m5_received = sorted([c.name  for c in m5.category_totals])
+    m5_expected = ['capture', 'citation', 'socialMedia', 'usage']
+    assert_equal(m5_received, m5_expected)
+    for plumx in (m1, m2, m4, m5):
         m_fields = set(field for ntup in plumx.category_totals for
                        field in ntup._fields)
         assert_equal(m_fields, {'name', 'total'})
@@ -48,10 +38,9 @@ def test_category_totals():
 
 
 def test_capture():
-    for plumx in (m3, m4, m7):
-        assert_equal(plumx.capture, None)
+    assert_equal(m3.capture, None)
     expected = {'name', 'total'}
-    for plumx in (m1, m2, m5, m6):
+    for plumx in (m1, m2, m4, m5):
         assert_true(isinstance(plumx.capture, list))
         assert_true(len(plumx.capture) > 0)
         m_fields = set(field for ntup in plumx.capture for field in ntup._fields)
@@ -62,9 +51,8 @@ def test_capture():
 
 def test_citation():
     assert_equal(m3.citation, None)
-    assert_equal(m7.citation, None)
     expected = {'name', 'total'}
-    for plumx in (m1, m2, m4, m5, m6):
+    for plumx in (m1, m2, m4, m5):
         assert_true(isinstance(plumx.citation, list))
         assert_true(len(plumx.citation) > 0)
         m_fields = set(field for ntup in plumx.citation for field in ntup._fields)
@@ -75,9 +63,9 @@ def test_citation():
 
 def test_mention():
     assert_equal(m3.mention, None)
-    assert_equal(m6.mention, None)
+    assert_equal(m5.mention, None)
     expected = {'name', 'total'}
-    for plumx in (m1, m2, m4, m5, m7):
+    for plumx in (m1, m2, m4):
         print(plumx)
         assert_true(isinstance(plumx.mention, list))
         assert_true(len(plumx.mention) > 0)
@@ -90,9 +78,9 @@ def test_mention():
 def test_social_media():
     assert_equal(m2.social_media, None)
     assert_equal(m3.social_media, None)
-    assert_equal(m5.social_media, None)
+    assert_equal(m4.social_media, None)
     expected = {'name', 'total'}
-    for plumx in (m1, m4, m6, m7):
+    for plumx in (m1, m5):
         assert_true(isinstance(plumx.social_media, list))
         assert_true(len(plumx.social_media) > 0)
         m_fields = set(field for ntup in plumx.social_media for field in ntup._fields)
@@ -104,9 +92,8 @@ def test_social_media():
 def test_usage():
     assert_equal(m2.usage, None)
     assert_equal(m3.usage, None)
-    assert_equal(m4.usage, None)
     expected = {'name', 'total'}
-    for plumx in (m1, m5, m6, m7):
+    for plumx in (m4, m5):
         assert_true(isinstance(plumx.usage, list))
         assert_true(len(plumx.usage) > 0)
         m_fields = set(field for ntup in plumx.usage for field in ntup._fields)