udata 9.1.2.dev30355__py2.py3-none-any.whl → 9.1.2.dev30454__py2.py3-none-any.whl

udata/core/organization/api_fields.py

@@ -1,142 +1,201 @@
 from flask import request
 
-from udata.api import api, fields, base_reference
+from udata.api import api, base_reference, fields
 from udata.core.badges.fields import badge_fields
 from udata.core.organization.permissions import OrganizationPrivatePermission
 
-from .constants import ORG_ROLES, DEFAULT_ROLE, MEMBERSHIP_STATUS, BIGGEST_LOGO_SIZE
-
-org_ref_fields = api.inherit('OrganizationReference', base_reference, {
-    'name': fields.String(description='The organization name', readonly=True),
-    'acronym': fields.String(description='The organization acronym'),
-    'uri': fields.UrlFor(
-        'api.organization', lambda o: {'org': o},
-        description='The organization API URI', readonly=True),
-    'slug': fields.String(
-        description='The organization string used as permalink',
-        required=True),
-    'page': fields.UrlFor(
-        'organizations.show', lambda o: {'org': o},
-        description='The organization web page URL', readonly=True, fallback_endpoint='api.organization'),
-    'logo': fields.ImageField(original=True,
-        description='The organization logo URL'),
-    'logo_thumbnail': fields.ImageField(attribute='logo', size=BIGGEST_LOGO_SIZE,
-        description='The organization logo thumbnail URL. This is the square '
-        '({0}x{0}) and cropped version.'.format(BIGGEST_LOGO_SIZE)),
-    'badges': fields.List(fields.Nested(badge_fields),
-        description='The organization badges',
-        readonly=True),
-})
+from .constants import BIGGEST_LOGO_SIZE, DEFAULT_ROLE, MEMBERSHIP_STATUS, ORG_ROLES
+
+org_ref_fields = api.inherit(
+    "OrganizationReference",
+    base_reference,
+    {
+        "name": fields.String(description="The organization name", readonly=True),
+        "acronym": fields.String(description="The organization acronym"),
+        "uri": fields.UrlFor(
+            "api.organization",
+            lambda o: {"org": o},
+            description="The organization API URI",
+            readonly=True,
+        ),
+        "slug": fields.String(
+            description="The organization string used as permalink", required=True
+        ),
+        "page": fields.UrlFor(
+            "organizations.show",
+            lambda o: {"org": o},
+            description="The organization web page URL",
+            readonly=True,
+            fallback_endpoint="api.organization",
+        ),
+        "logo": fields.ImageField(original=True, description="The organization logo URL"),
+        "logo_thumbnail": fields.ImageField(
+            attribute="logo",
+            size=BIGGEST_LOGO_SIZE,
+            description="The organization logo thumbnail URL. This is the square "
+            "({0}x{0}) and cropped version.".format(BIGGEST_LOGO_SIZE),
+        ),
+        "badges": fields.List(
+            fields.Nested(badge_fields), description="The organization badges", readonly=True
+        ),
+    },
+)
 
 from udata.core.user.api_fields import user_ref_fields  # noqa: required
 
+
 def check_can_access_email():
     # This endpoint is secure, only organization member has access.
-    if request.endpoint == 'api.request_membership':
+    if request.endpoint == "api.request_membership":
         return True
 
-    if request.endpoint != 'api.organization':
+    if request.endpoint != "api.organization":
         return False
 
-    org = request.view_args.get('org')
+    org = request.view_args.get("org")
     if org is None:
         return False
-    
+
     return OrganizationPrivatePermission(org).can()
 
-member_user_with_email_fields = api.inherit('MemberUserWithEmail', user_ref_fields, {
-    'email': fields.Raw(
-        attribute=lambda o: o.email if check_can_access_email() else None,
-        description='The user email (only present on show organization endpoint if the current user has edit permission on the org)', readonly=True),
-})
-
-request_fields = api.model('MembershipRequest', {
-    'id': fields.String(readonly=True),
-    'user': fields.Nested(member_user_with_email_fields),
-    'created': fields.ISODateTime(
-        description='The request creation date', readonly=True),
-    'status': fields.String(
-        description='The current request status', required=True,
-        enum=list(MEMBERSHIP_STATUS)),
-    'comment': fields.String(
-        description='A request comment from the user', required=True),
-})
-
-member_fields = api.model('Member', {
-    'user': fields.Nested(member_user_with_email_fields),
-    'role': fields.String(
-        description='The member role in the organization', required=True,
-        enum=list(ORG_ROLES), default=DEFAULT_ROLE),
-    'since': fields.ISODateTime(
-        description='The date the user joined the organization', readonly=True),
-})
-
-org_fields = api.model('Organization', {
-    'id': fields.String(
-        description='The organization identifier', required=True),
-    'name': fields.String(description='The organization name', required=True),
-    'acronym': fields.String(description='The organization acronym'),
-    'url': fields.String(description='The organization website URL'),
-    'slug': fields.String(
-        description='The organization string used as permalink',
-        required=True),
-    'description': fields.Markdown(
-        description='The organization description in Markdown', required=True),
-    'business_number_id': fields.String(description='The organization\'s business identification number.'),
-    'created_at': fields.ISODateTime(
-        description='The organization creation date', readonly=True),
-    'last_modified': fields.ISODateTime(
-        description='The organization last modification date', readonly=True),
-    'deleted': fields.ISODateTime(
-        description='The organization deletion date if deleted',
-        readonly=True),
-    'metrics': fields.Raw(
-        attribute=lambda o: o.get_metrics(),
-        description='The organization metrics', readonly=True),
-    'uri': fields.UrlFor(
-        'api.organization', lambda o: {'org': o},
-        description='The organization API URI', readonly=True),
-    'page': fields.UrlFor(
-        'organizations.show', lambda o: {'org': o},
-        description='The organization page URL', readonly=True, fallback_endpoint='api.organization'),
-    'logo': fields.ImageField(original=True,
-        description='The organization logo URL'),
-    'logo_thumbnail': fields.ImageField(attribute='logo', size=BIGGEST_LOGO_SIZE,
-        description='The organization logo thumbnail URL. This is the square '
-        '({0}x{0}) and cropped version.'.format(BIGGEST_LOGO_SIZE)),
-    'members': fields.List(
-        fields.Nested(member_fields, description='The organization members')),
-    'badges': fields.List(fields.Nested(badge_fields),
-                          description='The organization badges',
-                          readonly=True),
-    'extras': fields.Raw(description='Extras attributes as key-value pairs'),
-})
-
-org_page_fields = api.model('OrganizationPage', fields.pager(org_fields))
-
-
-refuse_membership_fields = api.model('RefuseMembership', {
-    'comment': fields.String(
-        description='The refusal comment.'),
-})
-
-
-org_role_fields = api.model('OrganizationRole', {
-    'id': fields.String(description='The role identifier'),
-    'label': fields.String(description='The role label')
-})
-
-
-org_suggestion_fields = api.model('OrganizationSuggestion', {
-    'id': fields.String(
-        description='The organization identifier', readonly=True),
-    'name': fields.String(description='The organization name', readonly=True),
-    'acronym': fields.String(
-        description='The organization acronym', readonly=True),
-    'slug': fields.String(
-        description='The organization permalink string', readonly=True),
-    'image_url': fields.ImageField(size=BIGGEST_LOGO_SIZE, description='The organization logo URL', readonly=True),
-    'page': fields.UrlFor(
-        'organizations.show_redirect', lambda o: {'org': o['slug']},
-        description='The organization web page URL', readonly=True, fallback_endpoint='api.organization')
-})
+
+member_user_with_email_fields = api.inherit(
+    "MemberUserWithEmail",
+    user_ref_fields,
+    {
+        "email": fields.Raw(
+            attribute=lambda o: o.email if check_can_access_email() else None,
+            description="The user email (only present on show organization endpoint if the current user has edit permission on the org)",
+            readonly=True,
+        ),
+    },
+)
+
+request_fields = api.model(
+    "MembershipRequest",
+    {
+        "id": fields.String(readonly=True),
+        "user": fields.Nested(member_user_with_email_fields),
+        "created": fields.ISODateTime(description="The request creation date", readonly=True),
+        "status": fields.String(
+            description="The current request status", required=True, enum=list(MEMBERSHIP_STATUS)
+        ),
+        "comment": fields.String(description="A request comment from the user", required=True),
+    },
+)
+
+member_fields = api.model(
+    "Member",
+    {
+        "user": fields.Nested(member_user_with_email_fields),
+        "role": fields.String(
+            description="The member role in the organization",
+            required=True,
+            enum=list(ORG_ROLES),
+            default=DEFAULT_ROLE,
+        ),
+        "since": fields.ISODateTime(
+            description="The date the user joined the organization", readonly=True
+        ),
+    },
+)
+
+org_fields = api.model(
+    "Organization",
+    {
+        "id": fields.String(description="The organization identifier", required=True),
+        "name": fields.String(description="The organization name", required=True),
+        "acronym": fields.String(description="The organization acronym"),
+        "url": fields.String(description="The organization website URL"),
+        "slug": fields.String(
+            description="The organization string used as permalink", required=True
+        ),
+        "description": fields.Markdown(
+            description="The organization description in Markdown", required=True
+        ),
+        "business_number_id": fields.String(
+            description="The organization's business identification number."
+        ),
+        "created_at": fields.ISODateTime(
+            description="The organization creation date", readonly=True
+        ),
+        "last_modified": fields.ISODateTime(
+            description="The organization last modification date", readonly=True
+        ),
+        "deleted": fields.ISODateTime(
+            description="The organization deletion date if deleted", readonly=True
+        ),
+        "metrics": fields.Raw(
+            attribute=lambda o: o.get_metrics(),
+            description="The organization metrics",
+            readonly=True,
+        ),
+        "uri": fields.UrlFor(
+            "api.organization",
+            lambda o: {"org": o},
+            description="The organization API URI",
+            readonly=True,
+        ),
+        "page": fields.UrlFor(
+            "organizations.show",
+            lambda o: {"org": o},
+            description="The organization page URL",
+            readonly=True,
+            fallback_endpoint="api.organization",
+        ),
+        "logo": fields.ImageField(original=True, description="The organization logo URL"),
+        "logo_thumbnail": fields.ImageField(
+            attribute="logo",
+            size=BIGGEST_LOGO_SIZE,
+            description="The organization logo thumbnail URL. This is the square "
+            "({0}x{0}) and cropped version.".format(BIGGEST_LOGO_SIZE),
+        ),
+        "members": fields.List(
+            fields.Nested(member_fields, description="The organization members")
+        ),
+        "badges": fields.List(
+            fields.Nested(badge_fields), description="The organization badges", readonly=True
+        ),
+        "extras": fields.Raw(description="Extras attributes as key-value pairs"),
+    },
+)
+
+org_page_fields = api.model("OrganizationPage", fields.pager(org_fields))
+
+
+refuse_membership_fields = api.model(
+    "RefuseMembership",
+    {
+        "comment": fields.String(description="The refusal comment."),
+    },
+)
+
+
+org_role_fields = api.model(
+    "OrganizationRole",
+    {
+        "id": fields.String(description="The role identifier"),
+        "label": fields.String(description="The role label"),
+    },
+)
+
+
+org_suggestion_fields = api.model(
+    "OrganizationSuggestion",
+    {
+        "id": fields.String(description="The organization identifier", readonly=True),
+        "name": fields.String(description="The organization name", readonly=True),
+        "acronym": fields.String(description="The organization acronym", readonly=True),
+        "slug": fields.String(description="The organization permalink string", readonly=True),
+        "image_url": fields.ImageField(
+            size=BIGGEST_LOGO_SIZE, description="The organization logo URL", readonly=True
+        ),
+        "page": fields.UrlFor(
+            "organizations.show_redirect",
+            lambda o: {"org": o["slug"]},
+            description="The organization web page URL",
+            readonly=True,
+            fallback_endpoint="api.organization",
+        ),
+    },
+)

udata/core/organization/apiv2.py

@@ -2,61 +2,61 @@ import mongoengine
 from flask import request
 
 from udata import search
-from udata.api import apiv2, API
-from udata.utils import multi_to_dict
+from udata.api import API, apiv2
 from udata.core.contact_point.api_fields import contact_point_fields
+from udata.utils import multi_to_dict
+
+from .api_fields import member_fields, org_fields, org_page_fields
+from .permissions import EditOrganizationPermission, OrganizationPrivatePermission
 from .search import OrganizationSearch
-from .api_fields import org_page_fields, org_fields, member_fields
-from .permissions import (
-    EditOrganizationPermission, OrganizationPrivatePermission
-)
 
-apiv2.inherit('OrganizationPage', org_page_fields)
-apiv2.inherit('Organization', org_fields)
-apiv2.inherit('Member', member_fields)
-apiv2.inherit('ContactPoint', contact_point_fields)
+apiv2.inherit("OrganizationPage", org_page_fields)
+apiv2.inherit("Organization", org_fields)
+apiv2.inherit("Member", member_fields)
+apiv2.inherit("ContactPoint", contact_point_fields)
 
 
-ns = apiv2.namespace('organizations', 'Organization related operations')
+ns = apiv2.namespace("organizations", "Organization related operations")
 search_parser = OrganizationSearch.as_request_parser()
 
-DEFAULT_SORTING = '-created_at'
+DEFAULT_SORTING = "-created_at"
 
 
-@ns.route('/search/', endpoint='organization_search')
+@ns.route("/search/", endpoint="organization_search")
 class OrganizationSearchAPI(API):
-    '''Organizations collection search endpoint'''
-    @apiv2.doc('search_organizations')
+    """Organizations collection search endpoint"""
+
+    @apiv2.doc("search_organizations")
     @apiv2.expect(search_parser)
     @apiv2.marshal_with(org_page_fields)
     def get(self):
-        '''Search all organizations'''
+        """Search all organizations"""
         search_parser.parse_args()
         return search.query(OrganizationSearch, **multi_to_dict(request.args))
 
 
-@ns.route('/<org:org>/extras/', endpoint='organization_extras')
-@apiv2.response(400, 'Wrong payload format, dict expected')
-@apiv2.response(400, 'Wrong payload format, list expected')
-@apiv2.response(404, 'Organization not found')
-@apiv2.response(410, 'Organization has been deleted')
+@ns.route("/<org:org>/extras/", endpoint="organization_extras")
+@apiv2.response(400, "Wrong payload format, dict expected")
+@apiv2.response(400, "Wrong payload format, list expected")
+@apiv2.response(404, "Organization not found")
+@apiv2.response(410, "Organization has been deleted")
 class OrganizationExtrasAPI(API):
-    @apiv2.doc('get_organization_extras')
+    @apiv2.doc("get_organization_extras")
     def get(self, org):
-        '''Get an organization extras given its identifier'''
+        """Get an organization extras given its identifier"""
         if org.deleted:
-            apiv2.abort(410, 'Organization has been deleted')
+            apiv2.abort(410, "Organization has been deleted")
         return org.extras
 
     @apiv2.secure
-    @apiv2.doc('update_organization_extras')
+    @apiv2.doc("update_organization_extras")
     def put(self, org):
-        '''Update a given organization extras'''
+        """Update a given organization extras"""
         data = request.json
         if not isinstance(data, dict):
-            apiv2.abort(400, 'Wrong payload format, dict expected')
+            apiv2.abort(400, "Wrong payload format, dict expected")
         if org.deleted:
-            apiv2.abort(410, 'Organization has been deleted')
+            apiv2.abort(410, "Organization has been deleted")
         EditOrganizationPermission(org).test()
         # first remove extras key associated to a None value in payload
         for key in [k for k in data if data[k] is None]:
@@ -72,14 +72,14 @@ class OrganizationExtrasAPI(API):
         return org.extras
 
     @apiv2.secure
-    @apiv2.doc('delete_organization_extras')
+    @apiv2.doc("delete_organization_extras")
     def delete(self, org):
-        '''Delete a given organization extras key on a given organization'''
+        """Delete a given organization extras key on a given organization"""
         data = request.json
         if not isinstance(data, list):
-            apiv2.abort(400, 'Wrong payload format, list expected')
+            apiv2.abort(400, "Wrong payload format, list expected")
         if org.deleted:
-            apiv2.abort(410, 'Organization has been deleted')
+            apiv2.abort(410, "Organization has been deleted")
         EditOrganizationPermission(org).test()
         for key in data:
             try:

udata/core/organization/commands.py

@@ -8,43 +8,41 @@ from udata.models import GeoZone, Organization
 log = logging.getLogger(__name__)
 
 
-@cli.group('organizations')
+@cli.group("organizations")
 def grp():
-    '''Organizations related operations'''
+    """Organizations related operations"""
     pass
 
 
 @grp.command()
-@click.argument('geoid', metavar='<geoid>')
-@click.argument('organization_id_or_slug', metavar='<organization>')
+@click.argument("geoid", metavar="<geoid>")
+@click.argument("organization_id_or_slug", metavar="<organization>")
 def attach_zone(geoid, organization_id_or_slug):
-    '''Attach a zone <geoid> restricted to level for a given <organization>.'''
-    organization = Organization.objects.get_by_id_or_slug(
-        organization_id_or_slug)
+    """Attach a zone <geoid> restricted to level for a given <organization>."""
+    organization = Organization.objects.get_by_id_or_slug(organization_id_or_slug)
     if not organization:
-        log.error('No organization found for %s', organization_id_or_slug)
+        log.error("No organization found for %s", organization_id_or_slug)
     geozone = GeoZone.objects.get(id=geoid)
     if not geozone:
-        log.error('No geozone found for %s', geoid)
-    log.info('Attaching {organization} with {geozone.name}'.format(
-             organization=organization, geozone=geozone))
+        log.error("No geozone found for %s", geoid)
+    log.info(
+        "Attaching {organization} with {geozone.name}".format(
+            organization=organization, geozone=geozone
+        )
+    )
     organization.zone = geozone.id
     organization.save()
-    log.info('Done')
+    log.info("Done")
 
 
 @grp.command()
-@click.argument('organization_id_or_slug', metavar='<organization>')
+@click.argument("organization_id_or_slug", metavar="<organization>")
 def detach_zone(organization_id_or_slug):
-    '''Detach the zone of a given <organization>.'''
-    organization = Organization.objects.get_by_id_or_slug(
-        organization_id_or_slug)
+    """Detach the zone of a given <organization>."""
+    organization = Organization.objects.get_by_id_or_slug(organization_id_or_slug)
     if not organization:
-        exit_with_error(
-            'No organization found for {0}'.format(organization_id_or_slug)
-        )
-    log.info('Detaching {organization} from {organization.zone}'.format(
-             organization=organization))
+        exit_with_error("No organization found for {0}".format(organization_id_or_slug))
+    log.info("Detaching {organization} from {organization.zone}".format(organization=organization))
     organization.zone = None
     organization.save()
-    log.info('Done')
+    log.info("Done")

udata/core/organization/constants.py

@@ -1,27 +1,27 @@
 from udata.i18n import lazy_gettext as _
 
 ORG_ROLES = {
-    'admin': _('Administrator'),
-    'editor': _('Editor'),
+    "admin": _("Administrator"),
+    "editor": _("Editor"),
 }
-DEFAULT_ROLE = 'editor'
+DEFAULT_ROLE = "editor"
 
 
 MEMBERSHIP_STATUS = {
-    'pending': _('Pending'),
-    'accepted': _('Accepted'),
-    'refused': _('Refused'),
+    "pending": _("Pending"),
+    "accepted": _("Accepted"),
+    "refused": _("Refused"),
 }
 
 LOGO_MAX_SIZE = 500
 LOGO_SIZES = [100, 60, 25]
 BIGGEST_LOGO_SIZE = LOGO_SIZES[0]
 
-PUBLIC_SERVICE = 'public-service'
-CERTIFIED = 'certified'
-ASSOCIATION = 'Association'
-COMPANY = 'Company'
-LOCAL_AUTHORITY = 'Local authority'
+PUBLIC_SERVICE = "public-service"
+CERTIFIED = "certified"
+ASSOCIATION = "Association"
+COMPANY = "Company"
+LOCAL_AUTHORITY = "Local authority"
 
 TITLE_SIZE_LIMIT = 350
 DESCRIPTION_SIZE_LIMIT = 100000

udata/core/organization/csv.py

@@ -9,17 +9,17 @@ class OrganizationCsvAdapter(csv.Adapter):
     downloads_counts = None
 
     fields = (
-        'id',
-        'name',
-        'slug',
-        ('url', 'external_url'),
-        'description',
-        ('logo', lambda o: o.logo(external=True)),
-        ('badges', lambda o: ','.join([badge.kind for badge in o.badges])),
-        'created_at',
-        'last_modified',
-        'business_number_id',
-        ('members_count', lambda o: len(o.members)),
+        "id",
+        "name",
+        "slug",
+        ("url", "external_url"),
+        "description",
+        ("logo", lambda o: o.logo(external=True)),
+        ("badges", lambda o: ",".join([badge.kind for badge in o.badges])),
+        "created_at",
+        "last_modified",
+        "business_number_id",
+        ("members_count", lambda o: len(o.members)),
     )
 
     def dynamic_fields(self):
@@ -27,12 +27,12 @@ class OrganizationCsvAdapter(csv.Adapter):
 
     def get_dynamic_field_downloads(self):
         downloads_counts = self.get_downloads_counts()
-        return [('downloads', lambda o: downloads_counts.get(str(o.id), 0))]
+        return [("downloads", lambda o: downloads_counts.get(str(o.id), 0))]
 
     def get_downloads_counts(self):
-        '''
+        """
         Prefetch all the resources' downloads for all selected organization into memory
-        '''
+        """
         if self.downloads_counts is not None:
             return self.downloads_counts
 
@@ -44,6 +44,8 @@ class OrganizationCsvAdapter(csv.Adapter):
             if self.downloads_counts.get(org_id) is None:
                 self.downloads_counts[org_id] = 0
 
-            self.downloads_counts[org_id] += sum(resource.metrics.get('views', 0) for resource in dataset.resources)
+            self.downloads_counts[org_id] += sum(
+                resource.metrics.get("views", 0) for resource in dataset.resources
+            )
 
         return self.downloads_counts

udata/core/organization/factories.py

@@ -2,22 +2,19 @@ import factory
 
 from udata.factories import ModelFactory
 
-from .models import Organization, Team, Member
+from .models import Member, Organization, Team
 
 
 class OrganizationFactory(ModelFactory):
     class Meta:
         model = Organization
 
-    name = factory.Faker('sentence')
-    description = factory.Faker('text')
-    members = factory.LazyAttribute(lambda o: [
-        Member(user=user, role='admin')
-        for user in o.admins
-    ] + [
-        Member(user=user, role='editor')
-        for user in o.editors
-    ])
+    name = factory.Faker("sentence")
+    description = factory.Faker("text")
+    members = factory.LazyAttribute(
+        lambda o: [Member(user=user, role="admin") for user in o.admins]
+        + [Member(user=user, role="editor") for user in o.editors]
+    )
 
     class Params:
         admins = []
@@ -28,4 +25,4 @@ class TeamFactory(ModelFactory):
     class Meta:
         model = Team
 
-    name = factory.Faker('sentence')
+    name = factory.Faker("sentence")