Traffic Endpoints Support (#977)

Added support for the traffic endpoints found at https://developer.github.com/v3/repos/traffic/. We added four functions to the Repository class (one for each of the endpoints) with corresponding unit tests. Fixes #926
2026-09-01 19:31:10 +00:00 · 2018-12-05 09:54:31 +08:00
parent aca50a7581
commit a433a2fe3d
14 changed files with 646 additions and 5 deletions
@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2018 Justin Kufro <jkufro@andrew.cmu.edu>                          #
+# Copyright 2018 Ivan Minno <iminno@andrew.cmu.edu>                            #
+# Copyright 2018 Zilei Gu <zileig@andrew.cmu.edu>                              #
+# Copyright 2018 Yves Zumbach <yzumbach@andrew.cmu.edu>                        #
+# Copyright 2018 Leying Chen <leyingc@andrew.cmu.edu>                          #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+
+import github.GithubObject
+
+
+class View(github.GithubObject.NonCompletableGithubObject):
+    """
+    This class represents a popular Path for a GitHub repository.
+    The reference can be found here https://developer.github.com/v3/repos/traffic/
+    """
+
+    def __repr__(self):
+        return self.get__repr__({
+            "timestamp": self._timestamp.value,
+            "count": self._count.value,
+            "uniques": self._uniques.value
+        })
+
+    @property
+    def timestamp(self):
+        """
+        :type: datetime.datetime
+        """
+        return self._timestamp.value
+
+    @property
+    def count(self):
+        """
+        :type: integer
+        """
+        return self._count.value
+
+    @property
+    def uniques(self):
+        """
+        :type: integer
+        """
+        return self._uniques.value
+
+    def _initAttributes(self):
+        self._timestamp = github.GithubObject.NotSet
+        self._count = github.GithubObject.NotSet
+        self._uniques = github.GithubObject.NotSet
+
+    def _useAttributes(self, attributes):
+        if "timestamp" in attributes:  # pragma no branch
+            self._timestamp = self._makeDatetimeAttribute(attributes["timestamp"])
+        if "count" in attributes:  # pragma no branch
+            self._count = self._makeIntAttribute(attributes["count"])
+        if "uniques" in attributes:  # pragma no branch
+            self._uniques = self._makeIntAttribute(attributes["uniques"])