Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

More templatetags #165

Merged
merged 8 commits into from
Oct 5, 2023
Merged

More templatetags #165

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
baf8801
divide
patimatnazhm May 20, 2021
0194ecd
Update user_sessions.py
akhmedgaziev May 21, 2021
20f959d
Add tests for new templatetags
blag Sep 18, 2023
79e3ca9
Update docstrings
blag Sep 18, 2023
d4ad4e0
Document new 'browser' and 'platform' template tags
blag Sep 18, 2023
fe1e1a5
Use importlib.metadata instead of the deprecated/remove pkg_resources…
blag Sep 19, 2023
9b69aff
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Sep 19, 2023
2130fe5
Improve usage formatting
blag Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,26 @@ the box:

Template tags
~~~~~~~~~~~~~
Two template tags are included
:meth:`~user_sessions.templatetags.user_sessions.device` and
:meth:`~user_sessions.templatetags.user_sessions.location`. These can be used
for respectively humanizing the user agent string and showing an approximate
location of the IP address::
Four template tags are included.

The first three are
:meth:`~user_sessions.templatetags.user_sessions.browser`, which can be used
to get just the browser from a session, and
:meth:`~user_sessions.templatetags.user_sessions.platform`, which can be used
to get just the hardware or operating system from a session, and
:meth:`~user_sessions.templatetags.user_sessions.device`, which can be used to
get both from a sesesion::
blag marked this conversation as resolved.
Show resolved Hide resolved

{% load user_sessions %}
{{ session.user_agent|device }} -> Safari on macOS
{{ session.user_agent|browser }} -> Safari
{{ session.user_agent|platform }} -> macOS

The last one is
:meth:`~user_sessions.templatetags.user_sessions.location`, which can be used
to show an approximate location of the last IP address for a session::

{% load user_sessions %}
{{ session.ip|location }} -> Zwolle, The Netherlands


Expand Down
274 changes: 273 additions & 1 deletion tests/tests.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@

from user_sessions.backends.db import SessionStore
from user_sessions.models import Session
from user_sessions.templatetags.user_sessions import device, location
from user_sessions.templatetags.user_sessions import (
browser, device, location, platform,
)
from user_sessions.utils.tests import Client

try:
Expand Down Expand Up @@ -322,6 +324,276 @@ def test_locations(self):
self.assertEqual('San Diego, United States', location('44.55.66.77'))


class PlatformTemplateFilterTest(TestCase):
def test_windows(self):
# Generic Windows
self.assertEqual("Windows XP", platform("NT 5.1 not a real browser/10.3"))
self.assertEqual("Windows Vista", platform("NT 6.0 not a real browser/10.3"))
self.assertEqual("Windows 7", platform("NT 6.1 not a real browser/10.3"))
self.assertEqual("Windows 8", platform("NT 6.2 not a real browser/10.3"))
self.assertEqual("Windows 8.1", platform("NT 6.3 not a real browser/10.3"))
self.assertEqual("Windows", platform("Windows not a real browser/10.3"))

# IE
self.assertEqual(
'Windows XP',
platform('Mozilla/4.0 (Windows; MSIE 6.0; Windows NT 5.1; SV1; '
'.NET CLR 2.0.50727)')
)
self.assertEqual(
'Windows Vista',
platform('Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; '
'Trident/4.0; SLCC1; .NET CLR 2.0.50727; .NET CLR 1.1.4322;'
' InfoPath.2; .NET CLR 3.5.21022; .NET CLR 3.5.30729; '
'MS-RTC LM 8; OfficeLiveConnector.1.4; OfficeLivePatch.1.3;'
' .NET CLR 3.0.30729)')
)
self.assertEqual(
'Windows 7',
platform('Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; '
'Trident/6.0)')
)
self.assertEqual(
'Windows 8',
platform('Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; '
'Win64; x64; Trident/6.0)')
)
self.assertEqual(
'Windows 8.1',
platform('Mozilla/5.0 (IE 11.0; Windows NT 6.3; Trident/7.0; '
'.NET4.0E; .NET4.0C; rv:11.0) like Gecko')
)

# Edge
self.assertEqual(
'Windows 10',
platform('Mozilla/5.0 (Windows NT 10.0) AppleWebKit/537.36 (KHTML, '
'like Gecko) Chrome/42.0.2311.135 Safari/537.36 Edge/12.10136')
)
self.assertEqual(
'Windows Mobile',
platform('Mozilla/5.0 (Windows Mobile 10; Android 8.0.0; Microsoft; Lumia '
'950XL) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.62 '
'Mobile Safari/537.36 Edge/40.15254.369')
)

# Edge Chromium
self.assertEqual(
'Windows 10',
platform('Mozilla/5.0 (Windows NT 10.0; Win64; x64) '
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.113 '
'Safari/537.36 Edg/81.0.416.62')
)

# Firefox
self.assertEqual(
'Windows 7',
platform('Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:22.0) '
'Gecko/20130328 Firefox/22.0')
)

# Chrome
self.assertEqual(
'Windows 8.1',
platform('Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 ('
'KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36')
)

def test_apple(self):
# Generic iPad
self.assertEqual("iPad", platform("iPad not a real browser/10.3"))

# Generic iPhone
self.assertEqual("iPhone", platform("iPhone not a real browser/10.3"))

self.assertEqual(
'iPad',
platform('Mozilla/5.0 (iPad; U; CPU OS 4_2_1 like Mac OS X; ja-jp) '
'AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 '
'Mobile/8C148 Safari/6533.18.5')
)

self.assertEqual(
'iPhone',
platform('Mozilla/5.0 (iPhone; CPU iPhone OS 7_0 like Mac OS X) '
'AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 '
'Mobile/11A465 Safari/9537.53')
)

self.assertEqual(
'macOS Mojave',
platform('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) '
'AppleWebKit/537.36 (KHTML, like Gecko) '
'Chrome/85.0.4178.0 Safari/537.36')
)
self.assertEqual(
'macOS Catalina',
platform('Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:77.0) '
'Gecko/20100101 Firefox/77.0')
)
self.assertEqual(
'macOS',
platform('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) '
'AppleWebKit/536.26.17 (KHTML, like Gecko) Version/6.0.2 '
'Safari/536.26.17')
)

# Edge Chromium
self.assertEqual(
'macOS Catalina',
platform('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) '
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 '
'Safari/537.36 Edg/85.0.564.51')
)

def test_android(self):
# androids identify themselves as Safari to get the good stuff
self.assertEqual(
'Android',
platform('Mozilla/5.0 (Linux; U; Android 1.5; de-de; HTC Magic '
'Build/CRB17) AppleWebKit/528.5+ (KHTML, like Gecko) '
'Version/3.1.2 Mobile Safari/525.20.1')
)

# Edge Chromium
self.assertEqual(
'Android',
platform('Mozilla/5.0 (Linux; Android 11; Pixel 3 XL) '
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.116 '
'Mobile Safari/537.36 EdgA/45.07.4.5059')
)

def test_linux_only(self):
self.assertEqual("Linux", platform("Linux not a real browser/10.3"))


class BrowserTemplateFilterTest(TestCase):
def test_ie(self):
self.assertEqual(
'Internet Explorer',
browser('Mozilla/4.0 (Windows; MSIE 6.0; Windows NT 5.1; SV1; '
'.NET CLR 2.0.50727)')
)
self.assertEqual(
'Internet Explorer',
browser('Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.0; '
'Trident/4.0; SLCC1; .NET CLR 2.0.50727; .NET CLR 1.1.4322;'
' InfoPath.2; .NET CLR 3.5.21022; .NET CLR 3.5.30729; '
'MS-RTC LM 8; OfficeLiveConnector.1.4; OfficeLivePatch.1.3;'
' .NET CLR 3.0.30729)')
)
self.assertEqual(
'Internet Explorer',
browser('Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.1; '
'Trident/6.0)')
)
self.assertEqual(
'Internet Explorer',
browser('Mozilla/5.0 (compatible; MSIE 10.0; Windows NT 6.2; '
'Win64; x64; Trident/6.0)')
)
self.assertEqual(
'Internet Explorer',
browser('Mozilla/5.0 (IE 11.0; Windows NT 6.3; Trident/7.0; '
'.NET4.0E; .NET4.0C; rv:11.0) like Gecko')
)

def test_edge(self):
self.assertEqual(
'Edge',
browser('Mozilla/5.0 (Windows NT 10.0) AppleWebKit/537.36 (KHTML, '
'like Gecko) Chrome/42.0.2311.135 Safari/537.36 Edge/12.10136')
)
self.assertEqual(
'Edge',
browser('Mozilla/5.0 (Windows Mobile 10; Android 8.0.0; Microsoft; Lumia '
'950XL) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/78.0.3904.62 '
'Mobile Safari/537.36 Edge/40.15254.369')
)

def test_edge_chromium(self):
self.assertEqual(
'Edge',
browser('Mozilla/5.0 (Windows NT 10.0; Win64; x64) '
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.113 '
'Safari/537.36 Edg/81.0.416.62')
)
self.assertEqual(
'Edge',
browser('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) '
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 '
'Safari/537.36 Edg/85.0.564.51')
)
self.assertEqual(
'Edge',
browser('Mozilla/5.0 (Linux; Android 11; Pixel 3 XL) '
'AppleWebKit/537.36 (KHTML, like Gecko) Chrome/77.0.3865.116 '
'Mobile Safari/537.36 EdgA/45.07.4.5059')
)

def test_safari(self):
self.assertEqual(
'Safari',
browser('Mozilla/5.0 (iPad; U; CPU OS 4_2_1 like Mac OS X; ja-jp) '
'AppleWebKit/533.17.9 (KHTML, like Gecko) Version/5.0.2 '
'Mobile/8C148 Safari/6533.18.5')
)
self.assertEqual(
'Safari',
browser('Mozilla/5.0 (iPhone; CPU iPhone OS 7_0 like Mac OS X) '
'AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 '
'Mobile/11A465 Safari/9537.53')
)
self.assertEqual(
'Safari',
browser('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_8_2) '
'AppleWebKit/536.26.17 (KHTML, like Gecko) Version/6.0.2 '
'Safari/536.26.17')
)

self.assertEqual("Safari", browser("Not a legit OS Safari/5.2"))

def test_chrome(self):
self.assertEqual(
'Chrome',
browser('Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_6) '
'AppleWebKit/537.36 (KHTML, like Gecko) '
'Chrome/85.0.4178.0 Safari/537.36')
)

self.assertEqual(
'Chrome',
browser('Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 ('
'KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36')
)

self.assertEqual("Chrome", browser("Not a legit OS Chrome/54.0.32"))

def test_firefox(self):
self.assertEqual(
'Firefox',
browser('Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:77.0) '
'Gecko/20100101 Firefox/77.0')
)

self.assertEqual(
'Firefox',
browser('Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:22.0) '
'Gecko/20130328 Firefox/22.0')
)

self.assertEqual("Firefox", browser("Not a legit OS Firefox/51.0"))

def test_android(self):
# androids identify themselves as Safari to get the good stuff
self.assertEqual(
'Safari',
browser('Mozilla/5.0 (Linux; U; Android 1.5; de-de; HTC Magic '
'Build/CRB17) AppleWebKit/528.5+ (KHTML, like Gecko) '
'Version/3.1.2 Mobile Safari/525.20.1')
)


class DeviceTemplateFilterTest(TestCase):
def test_ie(self):
self.assertEqual(
Expand Down
17 changes: 11 additions & 6 deletions user_sessions/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
from pkg_resources import DistributionNotFound, get_distribution

try:
__version__ = get_distribution("django-user-sessions").version
except DistributionNotFound:
# package is not installed
__version__ = None
from importlib.metadata import version
except ImportError:
from pkg_resources import DistributionNotFound, get_distribution

try:
__version__ = get_distribution("django-user-sessions").version
except DistributionNotFound:
# package is not installed
__version__ = None
else:
__version__ = version("django-user-sessions")
Loading