3359209404

Build # 3359209404

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/kobotoolbox/kpi/commit/<a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/<a class="double-link" href="https://git"><a class=hub.com/kobotoolbox/kpi/commit/b8274e339f07aeb3e2b5e45ad8d6c4f785f69140">b8274e339">&lt;a href=&quot;https://github.com/kobotoolbox/kpi/commit/</a><a class="double-link" href="https://github.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/kobotoolbox/kpi/commit/b8274e339f07aeb3e2b5e45ad8d6c4f785f69140">b8274e339</a><a href="https://github.com/kobotoolbox/kpi/commit/b8274e339f07aeb3e2b5e45ad8d6c4f785f69140">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/kobotoolbox/kpi/commit/b8274e339f07aeb3e2b5e45ad8d6c4f785f69140&quot;&gt;b8274e339&lt;/a&gt;&lt;a href=&quot;https://github.com/kobotoolbox/kpi/commit/b8274e339f07aeb3e2b5e45ad8d6c4f785f69140&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/kobotoolbox/kpi/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/kobotoolbox/kpi/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&am... (continued)

Pull Request Pull Request #4091: Endpoints for regional views

Run Details

2278 of 3748 branches covered (60.78%)

136 of 136 new or added lines in 5 files covered. (100.0%)

9764 of 12825 relevant lines covered (76.13%)

1.52 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

93.27

/kpi/utils/regional_views.py

# coding: utf-8
import json
from dataclasses import dataclass
from typing import List, Union, Optional

import constance
from rest_framework.request import Request


class DataDict:
    def to_dict(self):
        return self.__dict__


@dataclass
class RegionalView(DataDict):
    id: int
    label: str
    countries: Union[str, List[str]]
    permissions: List[str]


@dataclass
class RegionalAssignment(DataDict):
    view: int
    username: str


def get_regional_assignments() -> List[RegionalAssignment]:
    """
    Returns a list of RegionalAssignment objects as defined in constance.config
    """
    return [
        RegionalAssignment(**ra)
        for ra in json.loads(constance.config.REGIONAL_ASSIGNMENTS)
    ]


def get_regional_views() -> List[RegionalView]:
    """
    Returns a list of RegionalView objects as defined in constance.config
    """
    return [
        RegionalView(**rv) for rv in json.loads(constance.config.REGIONAL_VIEWS)
    ]


def get_asset_countries(asset: 'models.Asset') -> List[str]:
    """
    Returns a list of country values (codes) specfied in the Asset.settings

    If the 'country' key exists in Asset.settings, it may look like either:
        - Current structure: [{'value': 'ZAF', 'label': 'South Africa'}]
    or:
        - Legacy: {'value': 'ZAF', 'label': 'South Africa'}
    """
    countries = asset.settings.get('country')
    if countries is not None and isinstance(countries, list):
        return [c['value'] for c in countries]
    return [countries['value']] if countries else []


def get_regional_user_permissions_for_asset(
    asset: 'models.Asset', user: 'auth.User'
) -> List[str]:
    """
    Returns a flat list of permissions the user has available for a specified
    asset within a region
    """

    asset_countries = get_asset_countries(asset)

    # views that asset is in
    views_for_asset = [
        view
        for view in get_regional_views()
        if (set(asset_countries) & set(view.countries))
        or ('*' == view.countries)
    ]
    if not views_for_asset:
        return []

    # view ids that user is in
    view_ids_for_user = [
        v.view
        for v in get_regional_assignments()
        if v.username == user.username
    ]
    if not view_ids_for_user:
        return []

    # views that both the user and asset are in
    views_for_user_and_asset = [
        v for v in views_for_asset if v.id in view_ids_for_user
    ]
    if not views_for_user_and_asset:
        return []

    # unique, flattened list of permissions for asset
    # [['p1'], ['p1', 'p2']] -> ['p1', 'p2']
    return list(
        set(perm for v in views_for_user_and_asset for perm in v.permissions)
    )


def user_has_regional_asset_perm(
    asset: 'models.Asset', user: 'auth.User', perm: str
) -> bool:
    """
    Returns True if user has specified permission for asset within region if
    not explicitly granted through Asset.assign_perm()
    """
    return perm in get_regional_user_permissions_for_asset(asset, user)


def user_has_view_perms(user: 'auth.User', view: int) -> bool:
    """
    Returns True if user has any permissions permission to a specified view
    """
    return user.username in [
        v.username for v in get_regional_assignments() if v.view == view
    ]


def view_has_perm(view: int, perm: str) -> bool:
    """
    Returns True if a view has a specified permission associated with it
    """
    if view is not None:
        # flattened list of permissions
        perms_for_view = [
            perm
            for v in get_regional_views()
            for perm in v.permissions
            if v.id == view
        ]
        if perm in perms_for_view:
            return True
    return False


def get_region_for_view(view: int) -> List[str]:
    """
    Returns list of county codes for a specified view id
    """
    regions = [r.countries for r in get_regional_views() if r.id == view]
    return regions[0] if regions else []


def get_regional_views_for_user(user: 'auth.User') -> List[RegionalView]:
    """
    Returns a list of all available regional views for a user
    """
    views_for_user = [
        v.view
        for v in get_regional_assignments()
        if v.username == user.username
    ]
    return [v for v in get_regional_views() if v.id in views_for_user]


def get_view_as_int(view: Optional[str]) -> int:
    """
    Returns an int value for the view specified in the query params of the
    request
    """
    if view is not None:
        try:
            view = int(view)
        except ValueError:
            raise Exception('`view` must be an integer value')
    return view

1	# coding: utf-8
2	import json	2✔
3	from dataclasses import dataclass	2✔
4	from typing import List, Union, Optional	2✔
5
6	import constance	2✔
7	from rest_framework.request import Request	2✔
8
9
10	class DataDict:	2✔
11	def to_dict(self):	2✔
12	return self.__dict__	2✔
13
14
15	@dataclass	2✔
16	class RegionalView(DataDict):	2✔
17	id: int	2✔
18	label: str	2✔
19	countries: Union[str, List[str]]	2✔
20	permissions: List[str]	2✔
21
22
23	@dataclass	2✔
24	class RegionalAssignment(DataDict):	2✔
25	view: int	2✔
26	username: str	2✔
27
28
29	def get_regional_assignments() -> List[RegionalAssignment]:	2✔
30	"""
31	Returns a list of RegionalAssignment objects as defined in constance.config
32	"""
33	return [	2✔
34	RegionalAssignment(**ra)
35	for ra in json.loads(constance.config.REGIONAL_ASSIGNMENTS)
36	]
37
38
39	def get_regional_views() -> List[RegionalView]:	2✔
40	"""
41	Returns a list of RegionalView objects as defined in constance.config
42	"""
43	return [	2✔
44	RegionalView(**rv) for rv in json.loads(constance.config.REGIONAL_VIEWS)
45	]
46
47
48	def get_asset_countries(asset: 'models.Asset') -> List[str]:	2✔
49	"""
50	Returns a list of country values (codes) specfied in the Asset.settings
51
52	If the 'country' key exists in Asset.settings, it may look like either:
53	- Current structure: [{'value': 'ZAF', 'label': 'South Africa'}]
54	or:
55	- Legacy: {'value': 'ZAF', 'label': 'South Africa'}
56	"""
57	countries = asset.settings.get('country')	2✔
58	if countries is not None and isinstance(countries, list):	2✔
59	return [c['value'] for c in countries]	2✔
60	return [countries['value']] if countries else []	2✔
61
62
63	def get_regional_user_permissions_for_asset(	2✔
64	asset: 'models.Asset', user: 'auth.User'
65	) -> List[str]:
66	"""
67	Returns a flat list of permissions the user has available for a specified
68	asset within a region
69	"""
70
71	asset_countries = get_asset_countries(asset)	2✔
72
73	# views that asset is in
74	views_for_asset = [	2✔
75	view
76	for view in get_regional_views()
77	if (set(asset_countries) & set(view.countries))
78	or ('*' == view.countries)
79	]
80	if not views_for_asset:	2✔
81	return []	2✔
82
83	# view ids that user is in
84	view_ids_for_user = [	2✔
85	v.view
86	for v in get_regional_assignments()
87	if v.username == user.username
88	]
89	if not view_ids_for_user:	2!
90	return []	×
91
92	# views that both the user and asset are in
93	views_for_user_and_asset = [	2✔
94	v for v in views_for_asset if v.id in view_ids_for_user
95	]
96	if not views_for_user_and_asset:	2!
97	return []	×
98
99	# unique, flattened list of permissions for asset
100	# [['p1'], ['p1', 'p2']] -> ['p1', 'p2']
101	return list(	2✔
102	set(perm for v in views_for_user_and_asset for perm in v.permissions)
103	)
104
105
106	def user_has_regional_asset_perm(	2✔
107	asset: 'models.Asset', user: 'auth.User', perm: str
108	) -> bool:
109	"""
110	Returns True if user has specified permission for asset within region if
111	not explicitly granted through Asset.assign_perm()
112	"""
113	return perm in get_regional_user_permissions_for_asset(asset, user)	2✔
114
115
116	def user_has_view_perms(user: 'auth.User', view: int) -> bool:	2✔
117	"""
118	Returns True if user has any permissions permission to a specified view
119	"""
120	return user.username in [	2✔
121	v.username for v in get_regional_assignments() if v.view == view
122	]
123
124
125	def view_has_perm(view: int, perm: str) -> bool:	2✔
126	"""
127	Returns True if a view has a specified permission associated with it
128	"""
129	if view is not None:	2!
130	# flattened list of permissions
131	perms_for_view = [	2✔
132	perm
133	for v in get_regional_views()
134	for perm in v.permissions
135	if v.id == view
136	]
137	if perm in perms_for_view:	2!
138	return True	2✔
139	return False	×
140
141
142	def get_region_for_view(view: int) -> List[str]:	2✔
143	"""
144	Returns list of county codes for a specified view id
145	"""
146	regions = [r.countries for r in get_regional_views() if r.id == view]	2✔
147	return regions[0] if regions else []	2✔
148
149
150	def get_regional_views_for_user(user: 'auth.User') -> List[RegionalView]:	2✔
151	"""
152	Returns a list of all available regional views for a user
153	"""
154	views_for_user = [	2✔
155	v.view
156	for v in get_regional_assignments()
157	if v.username == user.username
158	]
159	return [v for v in get_regional_views() if v.id in views_for_user]	2✔
160
161
162	def get_view_as_int(view: Optional[str]) -> int:	2✔
163	"""
164	Returns an int value for the view specified in the query params of the
165	request
166	"""
167	if view is not None:	2✔
168	try:	2✔
169	view = int(view)	2✔
170	except ValueError:	2✔
171	raise Exception('`view` must be an integer value')	2✔
172	return view	2✔

kobotoolbox / kpi / 3359209404

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous