From d7fdacee7ae71383498c2d5ca32417259d542c37 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 25 Jan 2021 12:52:48 +0000 Subject: [PATCH 01/31] serializser working for tags but not single tags --- products/serializers.py | 10 +++++----- products/tests.py | 13 +++++++------ utils/tag_serializers.py | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 50 insertions(+), 11 deletions(-) diff --git a/products/serializers.py b/products/serializers.py index d39b689..a1e0832 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -3,14 +3,14 @@ from rest_framework import serializers from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer from products.models import Product -from utils.tag_serializers import SingleTagSerializerField +from utils.tag_serializers import SingleTagSerializerField, CustomTagSerializer -class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): +class ProductSerializer(CustomTagSerializer, serializers.ModelSerializer): - tags = TagListSerializerField( ) - category = SingleTagSerializerField() # main tag category - attributes = TagListSerializerField() + tags = TagListSerializerField(required=False) + category = SingleTagSerializerField(required=False) # main tag category + attributes = TagListSerializerField(required=False) class Meta: model = Product diff --git a/products/tests.py b/products/tests.py index c8f964e..3f77e89 100644 --- a/products/tests.py +++ b/products/tests.py @@ -116,9 +116,9 @@ class ProductViewSetTest(APITestCase): 'update_date': datetime.datetime.now().isoformat()+'Z', 'discount': '0.05', 'stock': 22, - # tags = models.ManyToMany(Tag, null=True, blank=True ) - # category = models.ForeignKey(Tag, null=true) # main tag category - # attributes = models.ManyToMany(Tag, null=True, blank=True ) + 'tags': ['tag1, tag2'], + # 'category': 'MayorTagCategory', + # 'attributes': ['color/red', 'size/xxl'], 'identifiers': '34rf34f43c43', } @@ -128,6 +128,7 @@ class ProductViewSetTest(APITestCase): # Query endpoint response = self.client.post(self.endpoint, data=data, format='json') + import ipdb; ipdb.set_trace() # Assert endpoint returns created status self.assertEqual(response.status_code, status.HTTP_201_CREATED) @@ -160,9 +161,9 @@ class ProductViewSetTest(APITestCase): 'update_date': datetime.datetime.now().isoformat()+'Z', 'discount': '0.05', 'stock': 22, - # tags = models.ManyToMany(Tag, null=True, blank=True ) - # category = models.ForeignKey(Tag, null=true) # main tag category - # attributes = models.ManyToMany(Tag, null=True, blank=True ) + 'tags': ['tag1x, tag2x'], + 'category': 'MayorTagCategory2', + 'attributes': ['color/blue', 'size/m'], 'identifiers': '34rf34f43c43', } diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index b5893a6..49dca92 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -1,5 +1,6 @@ from rest_framework import serializers +from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer class SingleTag(str): @@ -37,3 +38,40 @@ class SingleTagSerializerField(serializers.Field): value = value.name value = SingleTag(value) return value + + +class CustomTagSerializer(serializers.Serializer): + + def create(self, validated_data): + to_be_tagged, validated_data = self._pop_tags(validated_data) + + tag_object = super(CustomTagSerializer, self).create(validated_data) + + return self._save_tags(tag_object, to_be_tagged) + + def update(self, instance, validated_data): + to_be_tagged, validated_data = self._pop_tags(validated_data) + + tag_object = super(CustomTagSerializer, self).update( + instance, validated_data) + + return self._save_tags(tag_object, to_be_tagged) + + def _save_tags(self, tag_object, tags): + for key in tags.keys(): + tag_values = tags.get(key) + getattr(tag_object, key).set(*tag_values) + + return tag_object + + def _pop_tags(self, validated_data): + to_be_tagged = {} + import ipdb; ipdb.set_trace() + for key in self.fields.keys(): + field = self.fields[key] + if isinstance(field, TagListSerializerField): + if key in validated_data: + to_be_tagged[key] = validated_data.pop(key) + + return (to_be_tagged, validated_data) + From 8059cd3667dfc39a705e50c174602bfbb2bf47a8 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 25 Jan 2021 13:51:38 +0000 Subject: [PATCH 02/31] more tests for tagging serializer --- products/serializers.py | 2 +- products/tests.py | 2 +- requirements.txt | 3 +- utils/tag_serializers.py | 72 ++++++++++++++++++++++++++++++++++++---- 4 files changed, 69 insertions(+), 10 deletions(-) diff --git a/products/serializers.py b/products/serializers.py index a1e0832..42e3d8a 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -6,7 +6,7 @@ from products.models import Product from utils.tag_serializers import SingleTagSerializerField, CustomTagSerializer -class ProductSerializer(CustomTagSerializer, serializers.ModelSerializer): +class ProductSerializer(CustomTagSerializer): tags = TagListSerializerField(required=False) category = SingleTagSerializerField(required=False) # main tag category diff --git a/products/tests.py b/products/tests.py index 3f77e89..da69855 100644 --- a/products/tests.py +++ b/products/tests.py @@ -118,7 +118,7 @@ class ProductViewSetTest(APITestCase): 'stock': 22, 'tags': ['tag1, tag2'], # 'category': 'MayorTagCategory', - # 'attributes': ['color/red', 'size/xxl'], + 'attributes': ['color/red', 'size/xxl'], 'identifiers': '34rf34f43c43', } diff --git a/requirements.txt b/requirements.txt index c2f2832..0e62195 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,4 +6,5 @@ django-dotenv==1.4.2 django-filter==2.4.0 -e git://github.com/darklow/django-suit/@v2#egg=django-suit django-cors-headers==3.5.0 -django-taggit-serializer==0.1.7 \ No newline at end of file +django-taggit-serializer==0.1.7 +django-tagulous==1.1.0 \ No newline at end of file diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index 49dca92..6a9a72d 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -1,4 +1,11 @@ +import traceback + from rest_framework import serializers +from rest_framework.fields import CharField, ListField +from rest_framework.serializers import raise_errors_on_nested_writes +from rest_framework.utils import model_meta + +from tagulous.models.descriptors import FakeTagRelatedManager from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer @@ -40,14 +47,67 @@ class SingleTagSerializerField(serializers.Field): return value -class CustomTagSerializer(serializers.Serializer): +class CustomTagSerializer(serializers.ModelSerializer): + """ + Differentiate between tags and single-tags + """ + + def __init__(self, instance=None, data='', **kwargs): + self.serializer_field_mapping[SingleTagSerializerField] = CharField + self.serializer_field_mapping[TagListSerializerField] = ListField + super(CustomTagSerializer, self).__init__(instance, data, **kwargs) def create(self, validated_data): to_be_tagged, validated_data = self._pop_tags(validated_data) - tag_object = super(CustomTagSerializer, self).create(validated_data) + # tag_object = super(CustomTagSerializer, self).create(validated_data) + raise_errors_on_nested_writes('create', self, validated_data) - return self._save_tags(tag_object, to_be_tagged) + ModelClass = self.Meta.model + + # Remove many-to-many relationships from validated_data. + # They are not valid arguments to the default `.create()` method, + # as they require that the instance has already been saved. + info = model_meta.get_field_info(ModelClass) + many_to_many = {} + for field_name, relation_info in info.relations.items(): + if relation_info.to_many and (field_name in validated_data): + many_to_many[field_name] = validated_data.pop(field_name) + + try: + instance = ModelClass._default_manager.create(**validated_data) + except TypeError: + tb = traceback.format_exc() + msg = ( + 'Got a `TypeError` when calling `%s.%s.create()`. ' + 'This may be because you have a writable field on the ' + 'serializer class that is not a valid argument to ' + '`%s.%s.create()`. You may need to make the field ' + 'read-only, or override the %s.create() method to handle ' + 'this correctly.\nOriginal exception was:\n %s' % + ( + ModelClass.__name__, + ModelClass._default_manager.name, + ModelClass.__name__, + ModelClass._default_manager.name, + self.__class__.__name__, + tb + ) + ) + raise TypeError(msg) + + # Save many-to-many relationships after the instance is created. + if many_to_many: + for field_name, value in many_to_many.items(): + field = getattr(instance, field_name) + import ipdb; ipdb.set_trace() + if type(field) == "": + for item in value: + field.set(item) + else: + field.set(value) + + return self._save_tags(instance, to_be_tagged) def update(self, instance, validated_data): to_be_tagged, validated_data = self._pop_tags(validated_data) @@ -66,12 +126,10 @@ class CustomTagSerializer(serializers.Serializer): def _pop_tags(self, validated_data): to_be_tagged = {} - import ipdb; ipdb.set_trace() - for key in self.fields.keys(): - field = self.fields[key] + for key in self.serializer_field_mapping.keys(): + field = self.serializer_field_mapping[key] if isinstance(field, TagListSerializerField): if key in validated_data: to_be_tagged[key] = validated_data.pop(key) return (to_be_tagged, validated_data) - From 00b2cf9f225f0f1e06b333b7629021d34a824499 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 25 Jan 2021 14:07:11 +0000 Subject: [PATCH 03/31] more improvements for tag serializer --- products/tests.py | 3 +-- utils/tag_serializers.py | 35 +++++++++++++++++++++++++++++------ 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/products/tests.py b/products/tests.py index da69855..64f2474 100644 --- a/products/tests.py +++ b/products/tests.py @@ -128,7 +128,6 @@ class ProductViewSetTest(APITestCase): # Query endpoint response = self.client.post(self.endpoint, data=data, format='json') - import ipdb; ipdb.set_trace() # Assert endpoint returns created status self.assertEqual(response.status_code, status.HTTP_201_CREATED) @@ -162,7 +161,7 @@ class ProductViewSetTest(APITestCase): 'discount': '0.05', 'stock': 22, 'tags': ['tag1x, tag2x'], - 'category': 'MayorTagCategory2', + # 'category': 'MayorTagCategory2', 'attributes': ['color/blue', 'size/m'], 'identifiers': '34rf34f43c43', } diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index 6a9a72d..cbf54b9 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -5,7 +5,7 @@ from rest_framework.fields import CharField, ListField from rest_framework.serializers import raise_errors_on_nested_writes from rest_framework.utils import model_meta -from tagulous.models.descriptors import FakeTagRelatedManager +from tagulous.models.managers import TagRelatedManagerMixin from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer @@ -100,8 +100,7 @@ class CustomTagSerializer(serializers.ModelSerializer): if many_to_many: for field_name, value in many_to_many.items(): field = getattr(instance, field_name) - import ipdb; ipdb.set_trace() - if type(field) == "": + if field_name in ('tags', 'category', 'attributes'): for item in value: field.set(item) else: @@ -112,10 +111,34 @@ class CustomTagSerializer(serializers.ModelSerializer): def update(self, instance, validated_data): to_be_tagged, validated_data = self._pop_tags(validated_data) - tag_object = super(CustomTagSerializer, self).update( - instance, validated_data) + raise_errors_on_nested_writes('update', self, validated_data) + info = model_meta.get_field_info(instance) - return self._save_tags(tag_object, to_be_tagged) + # Simply set each attribute on the instance, and then save it. + # Note that unlike `.create()` we don't need to treat many-to-many + # relationships as being a special case. During updates we already + # have an instance pk for the relationships to be associated with. + m2m_fields = [] + for attr, value in validated_data.items(): + if attr in info.relations and info.relations[attr].to_many: + m2m_fields.append((attr, value)) + else: + setattr(instance, attr, value) + + instance.save() + + # Note that many-to-many fields are set after updating instance. + # Setting m2m fields triggers signals which could potentially change + # updated instance and we do not want it to collide with .update() + for attr, value in m2m_fields: + field = getattr(instance, attr) + if attr in ('tags', 'category', 'attributes'): + for item in value: + field.set(item) + else: + field.set(value) + + return self._save_tags(instance, to_be_tagged) def _save_tags(self, tag_object, tags): for key in tags.keys(): From 0e5aee73c3980c2576f8d1c90ecef7fb1dd92a78 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 10:58:57 +0000 Subject: [PATCH 04/31] more work on serializing tags --- companies/serializers.py | 1 + products/serializers.py | 2 +- products/tests.py | 11 ++++++----- utils/tag_serializers.py | 12 ++++-------- 4 files changed, 12 insertions(+), 14 deletions(-) diff --git a/companies/serializers.py b/companies/serializers.py index f3254d0..dd115ae 100644 --- a/companies/serializers.py +++ b/companies/serializers.py @@ -3,6 +3,7 @@ from companies.models import Company class CompanySerializer(serializers.ModelSerializer): + class Meta: model = Company exclude = ['created', 'updated', 'creator'] diff --git a/products/serializers.py b/products/serializers.py index 42e3d8a..d0521ea 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -6,7 +6,7 @@ from products.models import Product from utils.tag_serializers import SingleTagSerializerField, CustomTagSerializer -class ProductSerializer(CustomTagSerializer): +class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): tags = TagListSerializerField(required=False) category = SingleTagSerializerField(required=False) # main tag category diff --git a/products/tests.py b/products/tests.py index 64f2474..0c291d0 100644 --- a/products/tests.py +++ b/products/tests.py @@ -8,6 +8,7 @@ from django.utils import timezone from rest_framework.test import APITestCase from rest_framework import status +from companies.factories import CompanyFactory from products.factories import ProductFactory from products.models import Product @@ -101,12 +102,12 @@ class ProductViewSetTest(APITestCase): """Regular logged-in user can create new instance """ # Define request data + company = CompanyFactory() data = { - 'company': None, + 'company': company.id, 'sku': 'qwerewq', 'name': 'qwerewq', 'description': 'qwerewq', - 'image': None, 'url': 'http://qwerewq.com', 'price': '12.21', 'shipping_cost': '21.12', @@ -128,7 +129,6 @@ class ProductViewSetTest(APITestCase): # Query endpoint response = self.client.post(self.endpoint, data=data, format='json') - # Assert endpoint returns created status self.assertEqual(response.status_code, status.HTTP_201_CREATED) @@ -145,8 +145,9 @@ class ProductViewSetTest(APITestCase): instance.save() # Define request data + company = CompanyFactory() data = { - 'company': None, + 'company': company.id, 'sku': 'qwerewq', 'name': 'qwerewq', 'description': 'qwerewq', @@ -173,7 +174,7 @@ class ProductViewSetTest(APITestCase): # Query endpoint url = self.endpoint + f'{instance.pk}/' response = self.client.put(url, data, format='json') - + import ipdb; ipdb.set_trace() # Assert endpoint returns OK code self.assertEqual(response.status_code, status.HTTP_200_OK) diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index cbf54b9..836fcf2 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -47,16 +47,11 @@ class SingleTagSerializerField(serializers.Field): return value -class CustomTagSerializer(serializers.ModelSerializer): +class CustomTagSerializer(serializers.Serializer): """ Differentiate between tags and single-tags """ - def __init__(self, instance=None, data='', **kwargs): - self.serializer_field_mapping[SingleTagSerializerField] = CharField - self.serializer_field_mapping[TagListSerializerField] = ListField - super(CustomTagSerializer, self).__init__(instance, data, **kwargs) - def create(self, validated_data): to_be_tagged, validated_data = self._pop_tags(validated_data) @@ -149,8 +144,9 @@ class CustomTagSerializer(serializers.ModelSerializer): def _pop_tags(self, validated_data): to_be_tagged = {} - for key in self.serializer_field_mapping.keys(): - field = self.serializer_field_mapping[key] + + for key in self.fields.keys(): + field = self.fields[key] if isinstance(field, TagListSerializerField): if key in validated_data: to_be_tagged[key] = validated_data.pop(key) From 4437037710688dd029e24b62c5b45a61cbf52d44 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 11:20:48 +0000 Subject: [PATCH 05/31] everythin working except for creation product insance with category --- products/factories.py | 2 +- products/serializers.py | 5 +- products/tests.py | 6 +- utils/tag_serializers.py | 178 ++++++++++++++++++++------------------- 4 files changed, 99 insertions(+), 92 deletions(-) diff --git a/products/factories.py b/products/factories.py index efe243f..5fc7e17 100644 --- a/products/factories.py +++ b/products/factories.py @@ -17,7 +17,7 @@ class ProductFactory(DjangoModelFactory): name = FuzzyText(prefix='NAME_', length=10) description = FuzzyText(prefix='DECRIPTION', length=100) image = None - url = FuzzyText(prefix='http://WEB_LINK_', suffix='.test', length=10) + url = FuzzyText(prefix='http://WEB-LINK-', suffix='.test', length=10) price = FuzzyDecimal(low=1.00) shipping_cost = FuzzyDecimal(low=1.00) shipping_terms = FuzzyText(prefix='SHIPPING_TERMS', length=100) diff --git a/products/serializers.py b/products/serializers.py index d0521ea..70f85ab 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer from products.models import Product -from utils.tag_serializers import SingleTagSerializerField, CustomTagSerializer +from utils.tag_serializers import TagListSerializerField, TaggitSerializer, SingleTagSerializerField class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): @@ -14,4 +14,5 @@ class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): class Meta: model = Product - exclude = ['created', 'updated', 'creator'] + # exclude = ['created', 'updated', 'creator'] + fields = '__all__' diff --git a/products/tests.py b/products/tests.py index 0c291d0..b7c8759 100644 --- a/products/tests.py +++ b/products/tests.py @@ -118,7 +118,7 @@ class ProductViewSetTest(APITestCase): 'discount': '0.05', 'stock': 22, 'tags': ['tag1, tag2'], - # 'category': 'MayorTagCategory', + # 'category': '', 'attributes': ['color/red', 'size/xxl'], 'identifiers': '34rf34f43c43', } @@ -129,6 +129,7 @@ class ProductViewSetTest(APITestCase): # Query endpoint response = self.client.post(self.endpoint, data=data, format='json') + import ipdb; ipdb.set_trace() # Assert endpoint returns created status self.assertEqual(response.status_code, status.HTTP_201_CREATED) @@ -162,7 +163,7 @@ class ProductViewSetTest(APITestCase): 'discount': '0.05', 'stock': 22, 'tags': ['tag1x, tag2x'], - # 'category': 'MayorTagCategory2', + 'category': 'MayorTagCategory2', 'attributes': ['color/blue', 'size/m'], 'identifiers': '34rf34f43c43', } @@ -174,7 +175,6 @@ class ProductViewSetTest(APITestCase): # Query endpoint url = self.endpoint + f'{instance.pk}/' response = self.client.put(url, data, format='json') - import ipdb; ipdb.set_trace() # Assert endpoint returns OK code self.assertEqual(response.status_code, status.HTTP_200_OK) diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index 836fcf2..9f74c72 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -1,13 +1,34 @@ -import traceback +# -*- coding: utf-8 -*- +import json +# Third party +import six +from django.utils.translation import ugettext_lazy as _ from rest_framework import serializers -from rest_framework.fields import CharField, ListField -from rest_framework.serializers import raise_errors_on_nested_writes -from rest_framework.utils import model_meta -from tagulous.models.managers import TagRelatedManagerMixin -from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer +class TagList(list): + def __init__(self, *args, **kwargs): + pretty_print = kwargs.pop("pretty_print", True) + list.__init__(self, *args, **kwargs) + self.pretty_print = pretty_print + + def __add__(self, rhs): + return TagList(list.__add__(self, rhs)) + + def __getitem__(self, item): + result = list.__getitem__(self, item) + try: + return TagList(result) + except TypeError: + return result + + def __str__(self): + if self.pretty_print: + return json.dumps( + self, sort_keys=True, indent=4, separators=(',', ': ')) + else: + return json.dumps(self) class SingleTag(str): @@ -16,13 +37,15 @@ class SingleTag(str): pass def __str__(self): - return self + return json.dumps(self) class SingleTagSerializerField(serializers.Field): child = serializers.CharField() default_error_messages = { - 'not_a_str': 'Expected a string but got type "{input_type}".', + 'invalid_json': _('Invalid json str. A tag list submitted in string' + ' form must be valid json.'), + 'not_a_str': _('Expected a string but got type "{input_type}".') } order_by = None @@ -30,7 +53,7 @@ class SingleTagSerializerField(serializers.Field): super(SingleTagSerializerField, self).__init__(**kwargs) def to_internal_value(self, value): - if isinstance(value, str): + if isinstance(value, six.string_types): if not value: value = "" @@ -47,93 +70,76 @@ class SingleTagSerializerField(serializers.Field): return value -class CustomTagSerializer(serializers.Serializer): - """ - Differentiate between tags and single-tags - """ +class TagListSerializerField(serializers.Field): + child = serializers.CharField() + default_error_messages = { + 'not_a_list': _( + 'Expected a list of items but got type "{input_type}".'), + 'invalid_json': _('Invalid json list. A tag list submitted in string' + ' form must be valid json.'), + 'not_a_str': _('All list items must be of string type.') + } + order_by = None + def __init__(self, **kwargs): + pretty_print = kwargs.pop("pretty_print", True) + + style = kwargs.pop("style", {}) + kwargs["style"] = {'base_template': 'textarea.html'} + kwargs["style"].update(style) + + super(TagListSerializerField, self).__init__(**kwargs) + + self.pretty_print = pretty_print + + def to_internal_value(self, value): + if isinstance(value, six.string_types): + if not value: + value = "[]" + try: + value = json.loads(value) + except ValueError: + self.fail('invalid_json') + + if not isinstance(value, list): + self.fail('not_a_list', input_type=type(value).__name__) + + for s in value: + if not isinstance(s, six.string_types): + self.fail('not_a_str') + + self.child.run_validation(s) + + return value + + def to_representation(self, value): + if not isinstance(value, TagList): + if not isinstance(value, list): + if self.order_by: + tags = value.all().order_by(*self.order_by) + else: + tags = value.all() + value = [tag.name for tag in tags] + value = TagList(value, pretty_print=self.pretty_print) + + return value + + +class TaggitSerializer(serializers.Serializer): def create(self, validated_data): to_be_tagged, validated_data = self._pop_tags(validated_data) - # tag_object = super(CustomTagSerializer, self).create(validated_data) - raise_errors_on_nested_writes('create', self, validated_data) + tag_object = super(TaggitSerializer, self).create(validated_data) - ModelClass = self.Meta.model - - # Remove many-to-many relationships from validated_data. - # They are not valid arguments to the default `.create()` method, - # as they require that the instance has already been saved. - info = model_meta.get_field_info(ModelClass) - many_to_many = {} - for field_name, relation_info in info.relations.items(): - if relation_info.to_many and (field_name in validated_data): - many_to_many[field_name] = validated_data.pop(field_name) - - try: - instance = ModelClass._default_manager.create(**validated_data) - except TypeError: - tb = traceback.format_exc() - msg = ( - 'Got a `TypeError` when calling `%s.%s.create()`. ' - 'This may be because you have a writable field on the ' - 'serializer class that is not a valid argument to ' - '`%s.%s.create()`. You may need to make the field ' - 'read-only, or override the %s.create() method to handle ' - 'this correctly.\nOriginal exception was:\n %s' % - ( - ModelClass.__name__, - ModelClass._default_manager.name, - ModelClass.__name__, - ModelClass._default_manager.name, - self.__class__.__name__, - tb - ) - ) - raise TypeError(msg) - - # Save many-to-many relationships after the instance is created. - if many_to_many: - for field_name, value in many_to_many.items(): - field = getattr(instance, field_name) - if field_name in ('tags', 'category', 'attributes'): - for item in value: - field.set(item) - else: - field.set(value) - - return self._save_tags(instance, to_be_tagged) + return self._save_tags(tag_object, to_be_tagged) def update(self, instance, validated_data): to_be_tagged, validated_data = self._pop_tags(validated_data) - raise_errors_on_nested_writes('update', self, validated_data) - info = model_meta.get_field_info(instance) + tag_object = super(TaggitSerializer, self).update( + instance, validated_data) - # Simply set each attribute on the instance, and then save it. - # Note that unlike `.create()` we don't need to treat many-to-many - # relationships as being a special case. During updates we already - # have an instance pk for the relationships to be associated with. - m2m_fields = [] - for attr, value in validated_data.items(): - if attr in info.relations and info.relations[attr].to_many: - m2m_fields.append((attr, value)) - else: - setattr(instance, attr, value) - - instance.save() - - # Note that many-to-many fields are set after updating instance. - # Setting m2m fields triggers signals which could potentially change - # updated instance and we do not want it to collide with .update() - for attr, value in m2m_fields: - field = getattr(instance, attr) - if attr in ('tags', 'category', 'attributes'): - for item in value: - field.set(item) - else: - field.set(value) - - return self._save_tags(instance, to_be_tagged) + return self._save_tags(tag_object, to_be_tagged) def _save_tags(self, tag_object, tags): for key in tags.keys(): From 2a05beec072d2b9b6d5f2d734c6175855e4d7632 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 12:00:44 +0000 Subject: [PATCH 06/31] serialized tags working --- back_latienda/settings/base.py | 1 + products/factories.py | 7 +++---- products/models.py | 6 +++--- products/serializers.py | 4 +--- products/tests.py | 28 +++++++++++++++++++++++++--- 5 files changed, 33 insertions(+), 13 deletions(-) diff --git a/back_latienda/settings/base.py b/back_latienda/settings/base.py index ff94f1e..a407d89 100644 --- a/back_latienda/settings/base.py +++ b/back_latienda/settings/base.py @@ -45,6 +45,7 @@ INSTALLED_APPS = [ 'django_filters', 'corsheaders', 'taggit_serializer', + 'tagulous', # local apps 'core', diff --git a/products/factories.py b/products/factories.py index 5fc7e17..77ebf13 100644 --- a/products/factories.py +++ b/products/factories.py @@ -16,7 +16,6 @@ class ProductFactory(DjangoModelFactory): sku = FuzzyText(prefix='SKU_', length=10) name = FuzzyText(prefix='NAME_', length=10) description = FuzzyText(prefix='DECRIPTION', length=100) - image = None url = FuzzyText(prefix='http://WEB-LINK-', suffix='.test', length=10) price = FuzzyDecimal(low=1.00) shipping_cost = FuzzyDecimal(low=1.00) @@ -26,9 +25,9 @@ class ProductFactory(DjangoModelFactory): update_date = FuzzyDateTime(start_dt=timezone.now()) discount = FuzzyDecimal(low=0.00, high=100.00) stock = FuzzyInteger(low=0) - # tags = models.ManyToMany(Tag, null=True, blank=True ) - # category = models.ForeignKey(Tag, null=true) # main tag category - # attributes = models.ManyToMany(Tag, null=True, blank=True ) + tags = ['test-tag'] + category = 'top-category' # main tag category + attributes = ['programming/python', 'testing'] identifiers = FuzzyText(prefix='IDENTIFIERS_', length=100) class Meta: diff --git a/products/models.py b/products/models.py index 8afd717..3dc9742 100644 --- a/products/models.py +++ b/products/models.py @@ -32,9 +32,9 @@ class Product(models.Model): update_date = models.DateTimeField('Fecha de actualización de producto', null=True, blank=True) discount = models.DecimalField('Descuento', max_digits=5, decimal_places=2, null=True, blank=True) stock = models.PositiveIntegerField('Stock', null=True) - tags = TagField( ) - category = SingleTagField() # main tag category - attributes = TagField() + tags = TagField(force_lowercase=True,max_count=5, tree=True) + category = SingleTagField(null=True) # main tag category + attributes = TagField(force_lowercase=True,max_count=5, tree=True) identifiers = models.TextField('Identificador único de producto', null=True, blank=True) # internal diff --git a/products/serializers.py b/products/serializers.py index 70f85ab..e7d2fcf 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -1,6 +1,5 @@ from rest_framework import serializers -from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer from products.models import Product from utils.tag_serializers import TagListSerializerField, TaggitSerializer, SingleTagSerializerField @@ -14,5 +13,4 @@ class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): class Meta: model = Product - # exclude = ['created', 'updated', 'creator'] - fields = '__all__' + exclude = ['created', 'updated', 'creator'] diff --git a/products/tests.py b/products/tests.py index b7c8759..fcb973a 100644 --- a/products/tests.py +++ b/products/tests.py @@ -118,7 +118,7 @@ class ProductViewSetTest(APITestCase): 'discount': '0.05', 'stock': 22, 'tags': ['tag1, tag2'], - # 'category': '', + 'category': 'Mr', 'attributes': ['color/red', 'size/xxl'], 'identifiers': '34rf34f43c43', } @@ -129,7 +129,6 @@ class ProductViewSetTest(APITestCase): # Query endpoint response = self.client.post(self.endpoint, data=data, format='json') - import ipdb; ipdb.set_trace() # Assert endpoint returns created status self.assertEqual(response.status_code, status.HTTP_201_CREATED) @@ -188,13 +187,36 @@ class ProductViewSetTest(APITestCase): # Create instances instance = self.factory() + # Define request data + company = CompanyFactory() + data = { + 'company': company.id, + 'sku': 'qwerewq', + 'name': 'qwerewq', + 'description': 'qwerewq', + 'url': 'http://qwerewq.com', + 'price': '12.21', + 'shipping_cost': '21.12', + 'shipping_terms': 'qwerewq', + 'source': 'SYNCHRONIZED', + 'sourcing_date': datetime.datetime.now().isoformat()+'Z', + 'update_date': datetime.datetime.now().isoformat()+'Z', + 'discount': '0.05', + 'stock': 22, + 'tags': ['tag1, tag2'], + 'category': 'Mr', + 'attributes': ['color/red', 'size/xxl'], + 'identifiers': '34rf34f43c43', + } + # Authenticate user token = get_tokens_for_user(self.user) self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") # Query endpoint url = self.endpoint + f'{instance.pk}/' - response = self.client.put(url, data={}, format='json') + response = self.client.put(url, data=data, format='json') + # Assert endpoint returns OK code self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) From a9658c1009345c66a759c70298c234b2fd619ce9 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 12:06:20 +0000 Subject: [PATCH 07/31] applied tags field to company model --- companies/factories.py | 2 +- companies/models.py | 4 +++- companies/serializers.py | 11 +++++++---- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/companies/factories.py b/companies/factories.py index 4fd8e80..2c61558 100644 --- a/companies/factories.py +++ b/companies/factories.py @@ -27,7 +27,7 @@ class CompanyFactory(DjangoModelFactory): shop_rss_feed = FuzzyText(prefix='http://SHOP_RSS_FEED_', suffix='.test', length=10) sale_terms = FuzzyText(prefix='SALES_TERMS', length=250) shipping_cost = FuzzyDecimal(low=1.00) - # tags = models.ManyToMany(Tag, null=True) + tags = ['cool', 'hip', 'tech/blockchain'] sync = FuzzyChoice(choices=(True, False)) class Meta: diff --git a/companies/models.py b/companies/models.py index efb67c0..157718e 100644 --- a/companies/models.py +++ b/companies/models.py @@ -1,6 +1,8 @@ # from django.db import models from django.contrib.gis.db import models +from tagulous.models import TagField + # Create your models here. class Company(models.Model): @@ -34,7 +36,7 @@ class Company(models.Model): shop_rss_feed = models.URLField('RSS tienda online', null=True, blank=True) sale_terms = models.TextField('Condiciones de venta', null=True, blank=True) shipping_cost = models.DecimalField('Gastos de envío', max_digits=10, decimal_places=2, null=True, blank=True) - # tags = models.ManyToMany(Tag, null=True) + tags = TagField(force_lowercase=True,max_count=5, tree=True) sync = models.BooleanField('Sincronizar tienda', default=False, null=True, blank=True) # internal diff --git a/companies/serializers.py b/companies/serializers.py index dd115ae..9ff7fa8 100644 --- a/companies/serializers.py +++ b/companies/serializers.py @@ -1,9 +1,12 @@ from rest_framework import serializers from companies.models import Company +from utils.tag_serializers import TagListSerializerField, TaggitSerializer -class CompanySerializer(serializers.ModelSerializer): +class CompanySerializer(TaggitSerializer, serializers.ModelSerializer): - class Meta: - model = Company - exclude = ['created', 'updated', 'creator'] + tags = TagListSerializerField(required=False) + + class Meta: + model = Company + exclude = ['created', 'updated', 'creator'] From 7175dab55e9a19e9942025c6f5fcc108c71f0b24 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 12:16:46 +0000 Subject: [PATCH 08/31] cleanup --- companies/serializers.py | 5 +- products/serializers.py | 6 ++- utils/tag_serializers.py | 113 --------------------------------------- 3 files changed, 7 insertions(+), 117 deletions(-) diff --git a/companies/serializers.py b/companies/serializers.py index 9ff7fa8..b0ca1ce 100644 --- a/companies/serializers.py +++ b/companies/serializers.py @@ -1,7 +1,8 @@ from rest_framework import serializers -from companies.models import Company -from utils.tag_serializers import TagListSerializerField, TaggitSerializer +from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer + +from companies.models import Company class CompanySerializer(TaggitSerializer, serializers.ModelSerializer): diff --git a/products/serializers.py b/products/serializers.py index e7d2fcf..ddbc05b 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -1,8 +1,10 @@ from rest_framework import serializers -from products.models import Product +from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer -from utils.tag_serializers import TagListSerializerField, TaggitSerializer, SingleTagSerializerField +from utils.tag_serializers import SingleTagSerializerField + +from products.models import Product class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index 9f74c72..70b0277 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -7,30 +7,6 @@ from django.utils.translation import ugettext_lazy as _ from rest_framework import serializers -class TagList(list): - def __init__(self, *args, **kwargs): - pretty_print = kwargs.pop("pretty_print", True) - list.__init__(self, *args, **kwargs) - self.pretty_print = pretty_print - - def __add__(self, rhs): - return TagList(list.__add__(self, rhs)) - - def __getitem__(self, item): - result = list.__getitem__(self, item) - try: - return TagList(result) - except TypeError: - return result - - def __str__(self): - if self.pretty_print: - return json.dumps( - self, sort_keys=True, indent=4, separators=(',', ': ')) - else: - return json.dumps(self) - - class SingleTag(str): def __init__(self, *args, **kwargs): @@ -69,92 +45,3 @@ class SingleTagSerializerField(serializers.Field): value = SingleTag(value) return value - -class TagListSerializerField(serializers.Field): - child = serializers.CharField() - default_error_messages = { - 'not_a_list': _( - 'Expected a list of items but got type "{input_type}".'), - 'invalid_json': _('Invalid json list. A tag list submitted in string' - ' form must be valid json.'), - 'not_a_str': _('All list items must be of string type.') - } - order_by = None - - def __init__(self, **kwargs): - pretty_print = kwargs.pop("pretty_print", True) - - style = kwargs.pop("style", {}) - kwargs["style"] = {'base_template': 'textarea.html'} - kwargs["style"].update(style) - - super(TagListSerializerField, self).__init__(**kwargs) - - self.pretty_print = pretty_print - - def to_internal_value(self, value): - if isinstance(value, six.string_types): - if not value: - value = "[]" - try: - value = json.loads(value) - except ValueError: - self.fail('invalid_json') - - if not isinstance(value, list): - self.fail('not_a_list', input_type=type(value).__name__) - - for s in value: - if not isinstance(s, six.string_types): - self.fail('not_a_str') - - self.child.run_validation(s) - - return value - - def to_representation(self, value): - if not isinstance(value, TagList): - if not isinstance(value, list): - if self.order_by: - tags = value.all().order_by(*self.order_by) - else: - tags = value.all() - value = [tag.name for tag in tags] - value = TagList(value, pretty_print=self.pretty_print) - - return value - - -class TaggitSerializer(serializers.Serializer): - def create(self, validated_data): - to_be_tagged, validated_data = self._pop_tags(validated_data) - - tag_object = super(TaggitSerializer, self).create(validated_data) - - return self._save_tags(tag_object, to_be_tagged) - - def update(self, instance, validated_data): - to_be_tagged, validated_data = self._pop_tags(validated_data) - - tag_object = super(TaggitSerializer, self).update( - instance, validated_data) - - return self._save_tags(tag_object, to_be_tagged) - - def _save_tags(self, tag_object, tags): - for key in tags.keys(): - tag_values = tags.get(key) - getattr(tag_object, key).set(*tag_values) - - return tag_object - - def _pop_tags(self, validated_data): - to_be_tagged = {} - - for key in self.fields.keys(): - field = self.fields[key] - if isinstance(field, TagListSerializerField): - if key in validated_data: - to_be_tagged[key] = validated_data.pop(key) - - return (to_be_tagged, validated_data) From 9c880197006b7087343b9b7d6f01ae4a908cc3df Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 12:32:19 +0000 Subject: [PATCH 09/31] enabled django-suit for admin --- back_latienda/settings/base.py | 3 +++ companies/models.py | 9 ++++++++- core/admin.py | 3 +++ products/models.py | 6 ++++++ 4 files changed, 20 insertions(+), 1 deletion(-) diff --git a/back_latienda/settings/base.py b/back_latienda/settings/base.py index a407d89..3eaa173 100644 --- a/back_latienda/settings/base.py +++ b/back_latienda/settings/base.py @@ -33,12 +33,15 @@ SECRET_KEY = 'td*#7t-(1e9^(g0cod*hs**dp(%zvg@=$cug_-dtzcj#i2mrz@' # Application definition INSTALLED_APPS = [ + 'suit', + 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', + 'django.contrib.gis', # 3rd party 'rest_framework', diff --git a/companies/models.py b/companies/models.py index 157718e..4ad357c 100644 --- a/companies/models.py +++ b/companies/models.py @@ -42,4 +42,11 @@ class Company(models.Model): # internal created = models.DateTimeField('date of creation', auto_now_add=True) updated = models.DateTimeField('date last update', auto_now=True) - creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='company') \ No newline at end of file + creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='company') + + def __str__(self): + return self.company_name + + class Meta: + verbose_name = "Compañía" + verbose_name_plural = "Compañías" diff --git a/core/admin.py b/core/admin.py index 8c38f3f..c9690d2 100644 --- a/core/admin.py +++ b/core/admin.py @@ -1,3 +1,6 @@ from django.contrib import admin +from . import models + # Register your models here. +admin.register(models.CustomUser) diff --git a/products/models.py b/products/models.py index 3dc9742..7ef0b98 100644 --- a/products/models.py +++ b/products/models.py @@ -43,3 +43,9 @@ class Product(models.Model): creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='product') # history = models.FoiregnKey('history.History', on_delete=models.DO_NOTHING, null=True) + def __str__(self): + return f"{self.name} / {self.sku}" + + class Meta: + verbose_name = "Producto" + verbose_name_plural = "Productos" From b385767232db15c87d26b031382449898c590b79 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 12:50:29 +0000 Subject: [PATCH 10/31] readme update --- README.md | 17 +++++++++++++++++ stats/models.py | 3 +++ 2 files changed, 20 insertions(+) diff --git a/README.md b/README.md index 0f2dfde..3ef1321 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ This README aims to document functionality of backend as well as required steps - [First Steps](#first-steps) - [Location Data](#location-data) +- [Endpoints](#endpoints) ## First Steps @@ -34,3 +35,19 @@ python manage.py migrate ## Location data To load initial location data use: `python manage.py addgeo` + + +## Endpoints + +- `/api/v1/users/`: User information +- `/api/v1/companies/`: Company information +- `/api/v1/products/`: Product information +- `/api/v1/history/`: Historical records about product importation +- `/api/v1/stats/`: logs about user interaction with products links + +Location ednpoints: + +- `/api/v1/countries/` +- `/api/v1/regions/` +- `/api/v1/provinces/` +- `/api/v1/cities/` diff --git a/stats/models.py b/stats/models.py index bc7d827..67f1d36 100644 --- a/stats/models.py +++ b/stats/models.py @@ -6,6 +6,9 @@ User = get_user_model() # Create your models here. class StatsLog(models.Model): + """ + Keep track of interactions between user and product links + """ model = models.ForeignKey(ContentType, on_delete=models.DO_NOTHING, null=True) user = models.ForeignKey(User, on_delete=models.DO_NOTHING, null=True) From 9b78fba1427d0faf384cee681db2a4753c6f012d Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 13:36:15 +0000 Subject: [PATCH 11/31] moved data files to datasets/, created addtestdata command --- core/management/commands/addgeo.py | 4 +- core/management/commands/addtestdata.py | 55 +++++++++++++++++++++ gadm36_ESP.json => datasets/gadm36_ESP.json | 0 locations.json => datasets/locations.json | 0 requirements.txt | 3 +- 5 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 core/management/commands/addtestdata.py rename gadm36_ESP.json => datasets/gadm36_ESP.json (100%) rename locations.json => datasets/locations.json (100%) diff --git a/core/management/commands/addgeo.py b/core/management/commands/addgeo.py index 6d47e05..4f9f92b 100644 --- a/core/management/commands/addgeo.py +++ b/core/management/commands/addgeo.py @@ -26,12 +26,12 @@ class Command(BaseCommand): # create country for spain country = Country.objects.create(name='España') - locations_file = 'locations.json' + locations_file = 'datasets/locations.json' locations = json.loads(open(locations_file).read()) # REGIONS - geo_file='gadm36_ESP.json' # geo boundary data for regions + geo_file='datasets/gadm36_ESP.json' # geo boundary data for regions geo_data = json.loads(open(geo_file).read()) logging.info("Starting Region creation") diff --git a/core/management/commands/addtestdata.py b/core/management/commands/addtestdata.py new file mode 100644 index 0000000..55f035f --- /dev/null +++ b/core/management/commands/addtestdata.py @@ -0,0 +1,55 @@ +import logging +import json + +from django.core.management.base import BaseCommand +from django.contrib.gis.geos import GEOSGeometry, MultiPolygon + +from faker import Faker + +from companies.factories import CompanyFactory +from products.factories import ProductFactory + + +logging.basicConfig( + filename='logs/addtestdata.log', + filemode='w', + format='%(levelname)s:%(message)s', + level=logging.INFO, + ) + +class Command(BaseCommand): + + def handle(self, *args, **kwargs): + print("Creating fake data to populate database") + + + # start faker + fake = Faker() + Faker.seed(0) + + # companies created + new_companies = [] + logging.info("Creating fake companies") + print("Creating fake companies") + for i in range(10): + name = f"{fake.company()} {fake.company_suffix()}" + company = CompanyFactory(company_name=name) + new_companies.append(company) + logging.debug(f"New Company {company.company_name} created") + print(".", end = '') + print('') + + logging.info("Creating fake products") + print("Creating fake products") + # create and assign products to companies + for company in new_companies: + logging.info(f"Products for {company.company_name}") + for i in range(100): + name = fake.last_name_nonbinary() + description = fake.paragraph(nb_sentences=5) + product = ProductFactory(name=name, description=description) + logging.debug(f"New Product {product.name} created") + print(".", end = '') + print('') + + print("Dataset creation finished") \ No newline at end of file diff --git a/gadm36_ESP.json b/datasets/gadm36_ESP.json similarity index 100% rename from gadm36_ESP.json rename to datasets/gadm36_ESP.json diff --git a/locations.json b/datasets/locations.json similarity index 100% rename from locations.json rename to datasets/locations.json diff --git a/requirements.txt b/requirements.txt index 0e62195..4142296 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,4 +7,5 @@ django-filter==2.4.0 -e git://github.com/darklow/django-suit/@v2#egg=django-suit django-cors-headers==3.5.0 django-taggit-serializer==0.1.7 -django-tagulous==1.1.0 \ No newline at end of file +django-tagulous==1.1.0 +faker==5.7.0 \ No newline at end of file From d94eb9882cb320dca6ae260825f132e389361b70 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 26 Jan 2021 14:05:39 +0000 Subject: [PATCH 12/31] changes to addtestdata --- core/management/commands/addtestdata.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/core/management/commands/addtestdata.py b/core/management/commands/addtestdata.py index 55f035f..25d93b8 100644 --- a/core/management/commands/addtestdata.py +++ b/core/management/commands/addtestdata.py @@ -1,6 +1,8 @@ import logging import json +import requests + from django.core.management.base import BaseCommand from django.contrib.gis.geos import GEOSGeometry, MultiPolygon @@ -19,6 +21,8 @@ logging.basicConfig( class Command(BaseCommand): + logo_url = "https://picsum.photos/200/300" + def handle(self, *args, **kwargs): print("Creating fake data to populate database") @@ -47,7 +51,18 @@ class Command(BaseCommand): for i in range(100): name = fake.last_name_nonbinary() description = fake.paragraph(nb_sentences=5) - product = ProductFactory(name=name, description=description) + # TODO: apply tags from tag list + + """ + # TODO: add dynamic image to product + response = requests.get(self.logo_url) + if response.status_code == 200: + response.raw.decode_content = True + image = response.raw + else: + image= None + """ + product = ProductFactory(name=name, description=description,) logging.debug(f"New Product {product.name} created") print(".", end = '') print('') From b8cd663fee1e22e27cfbf465a35cdd7ab3682999 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 1 Feb 2021 12:56:28 +0000 Subject: [PATCH 13/31] fix for user registration --- companies/models.py | 4 +++- core/models.py | 10 ++++++---- core/serializers.py | 19 +++++++++++++++---- core/tests.py | 35 ++++++++++++++++++++++++++++++----- core/views.py | 27 ++++++++++++++++++++++++++- 5 files changed, 80 insertions(+), 15 deletions(-) diff --git a/companies/models.py b/companies/models.py index 4ad357c..15944e0 100644 --- a/companies/models.py +++ b/companies/models.py @@ -38,11 +38,13 @@ class Company(models.Model): shipping_cost = models.DecimalField('Gastos de envío', max_digits=10, decimal_places=2, null=True, blank=True) tags = TagField(force_lowercase=True,max_count=5, tree=True) sync = models.BooleanField('Sincronizar tienda', default=False, null=True, blank=True) + is_validated = models.BooleanField('Validado', default=False, null=True, blank=True) + is_active = models.BooleanField('Activado', default=False, null=True, blank=True) # Accesible on site # internal created = models.DateTimeField('date of creation', auto_now_add=True) updated = models.DateTimeField('date last update', auto_now=True) - creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='company') + creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='company_creator') def __str__(self): return self.company_name diff --git a/core/models.py b/core/models.py index e5f9b61..111900b 100644 --- a/core/models.py +++ b/core/models.py @@ -2,9 +2,11 @@ from django.db import models from django.contrib.auth.base_user import AbstractBaseUser, BaseUserManager from django.contrib.auth.models import PermissionsMixin +from companies.models import Company + # Create your models here. -class UserManager(BaseUserManager): +class CustomUserManager(BaseUserManager): use_in_migrations = True def _create_user(self, email, password, **extra_fields): @@ -16,7 +18,7 @@ class UserManager(BaseUserManager): email = self.normalize_email(email) user = self.model(email=email, **extra_fields) user.set_password(password) - user.save(using=self._db) + user.save() return user def create_user(self, email, password=None, **extra_fields): @@ -42,7 +44,7 @@ class CustomUser(AbstractBaseUser, PermissionsMixin): notify = models.BooleanField('Notificar', default=False, null=True) provider = models.CharField('Proveedor', max_length=1000, blank=True, null=True) # red social de registro email_verified = models.BooleanField('Email verificado', default=False, null=True) - company = None # models.ForeignKey(Empresa, null=True, on_delete=models.DO_NOTHING) + company = models.ForeignKey(Company, null=True, on_delete=models.DO_NOTHING, related_name='custom_user') is_active = models.BooleanField('Activo', default=True) is_staff = models.BooleanField('Empleado',default=False ) @@ -51,7 +53,7 @@ class CustomUser(AbstractBaseUser, PermissionsMixin): created = models.DateTimeField(auto_now_add=True, null=True, blank=True) last_visit = models.DateTimeField(auto_now=True) - objects = UserManager() + objects = CustomUserManager() USERNAME_FIELD = 'email' REQUIRED_FIELDS = [] diff --git a/core/serializers.py b/core/serializers.py index 83b7f60..b1443f7 100644 --- a/core/serializers.py +++ b/core/serializers.py @@ -1,17 +1,28 @@ +from django.contrib.auth import get_user_model + from rest_framework import serializers from . import models +User = get_user_model() -class CustomUserSerializer(serializers.ModelSerializer): + +class CustomUserReadSerializer(serializers.ModelSerializer): class Meta: - model = models.CustomUser - fields = ('email', 'full_name', 'role', 'is_active') + model = User + fields = ('email', 'full_name', 'role', 'is_active',) + + +class CustomUserWriteSerializer(serializers.ModelSerializer): + + class Meta: + model = User + fields = ('email', 'full_name', 'role', 'is_active', 'password') class CreatorSerializer(serializers.ModelSerializer): class Meta: - model = models.CustomUser + model = User fields = ('email',) diff --git a/core/tests.py b/core/tests.py index 6765222..822e900 100644 --- a/core/tests.py +++ b/core/tests.py @@ -1,6 +1,8 @@ import random import string import json +import hashlib +import base64 from django.test import TestCase @@ -13,6 +15,7 @@ from . import models from . import factories # Create your tests here. + class CustomUserViewSetTest(APITestCase): """CustomUser viewset tests """ @@ -35,13 +38,11 @@ class CustomUserViewSetTest(APITestCase): # anon user def test_anon_user_can_create_inactive_instance(self): """Not logged-in user can create new instance of User but it's inactive - TODO: should create inactive user """ data = { 'email': 'test@email.com', 'full_name': 'TEST NAME', - 'password1': 'VENTILADORES1234499.89', - 'password2': 'VENTILADORES1234499.89', + 'password': 'VENTILADORES1234499.89', } # Query endpoint @@ -49,8 +50,14 @@ class CustomUserViewSetTest(APITestCase): # Assert creation is successful self.assertEqual(response.status_code, status.HTTP_201_CREATED) + # check for new user instance created + self.assertEquals(1, self.model.objects.filter(email=data['email']).count()) + # assert password has been set + new_user = self.model.objects.get(email=data['email']) + self.assertNotEqual('', new_user.password) # assert instance is inactive info = json.loads(response.content) + self.assertFalse(info['is_active']) def test_anon_user_cannot_modify_existing_instance(self): @@ -151,6 +158,25 @@ class CustomUserViewSetTest(APITestCase): # Assert access is forbidden self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) + def test_user_update_password(self): + '''Test the modification of PASSWORD field value for an instance of User ''' + # modify values of alert instance + new_password = "updated_super secret password" + self.user.set_password(new_password) + self.user.save() + # get updated intance using PK + updated_user = self.model.objects.get(pk=self.user.pk) + # assert fields exist, and data matches + stored_value = updated_user.__dict__['password'] + hash_type, iteration, salt, stored_password_hash = stored_value.split('$') + new_password_hash = hashlib.pbkdf2_hmac( + hash_name='sha256', + password=new_password.encode(), + salt=salt.encode(), + iterations=int(iteration), + ) + self.assertEqual(stored_password_hash, base64.b64encode(new_password_hash).decode()) + # admin user def test_admin_user_can_create_instance(self): """Admin user can create new instance @@ -163,8 +189,7 @@ class CustomUserViewSetTest(APITestCase): data = { 'email': 'test@email.com', 'full_name': 'TEST NAME', - 'password1': 'VENTILADORES1234499.89', - 'password2': 'VENTILADORES1234499.89', + 'password': 'VENTILADORES1234499.89', } # Authenticate user diff --git a/core/views.py b/core/views.py index 3588a04..e8265e3 100644 --- a/core/views.py +++ b/core/views.py @@ -15,7 +15,32 @@ from back_latienda.permissions import CustomUserPermissions class CustomUserViewSet(viewsets.ModelViewSet): model = models.CustomUser - serializer_class = serializers.CustomUserSerializer + serializer_class = serializers.CustomUserReadSerializer + write_serializer_class =serializers.CustomUserWriteSerializer model_name = 'custom_user' queryset = models.CustomUser.objects.all() permission_classes = [CustomUserPermissions,] + + def create(self, request): + """ + Create Instance + """ + try: + serializer = self.write_serializer_class( + data=request.data, + ) + if serializer.is_valid(): + # save model instance data + password = serializer.validated_data.pop('password') + instance = self.model(**serializer.validated_data) + instance.set_password(password) + instance.save() + + return Response(self.serializer_class( + instance, many=False, context={'request': request}).data, + status=status.HTTP_201_CREATED) + else: + return Response( + serializer.errors, status=status.HTTP_406_NOT_ACCEPTABLE) + except Exception as e: + return Response(str(e), status=status.HTTP_500_INTERNAL_SERVER_ERROR) From ee33b327fa65b85ea5379f052d83cc1ee9f04aea Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 1 Feb 2021 13:32:34 +0000 Subject: [PATCH 14/31] user modification enabled --- back_latienda/permissions.py | 15 +++++++++++++-- core/models.py | 4 ++-- core/serializers.py | 4 ++-- core/tests.py | 23 ++++++++++++++++++++++- core/views.py | 7 ++++++- 5 files changed, 45 insertions(+), 8 deletions(-) diff --git a/back_latienda/permissions.py b/back_latienda/permissions.py index 095d56e..8368e6d 100644 --- a/back_latienda/permissions.py +++ b/back_latienda/permissions.py @@ -41,13 +41,24 @@ class CustomUserPermissions(permissions.BasePermission): """ Custom permissions for managing custom user instances """ + + def has_object_permission(self, request, view, obj): + # check for object permissions + if obj.email == request.user.email: + return True + elif request.user.is_staff is True: + return True + else: + return False + def has_permission(self, request, view): # allow anon users to create new CustomUser (inactive) if request.method == 'POST' and request.user.is_anonymous is True: return True - + elif request.method == 'PUT' and request.user.is_authenticated is True: + return True # only admins can change or delete - if request.user.is_staff is True: + elif request.user.is_staff is True: return True # for everything else diff --git a/core/models.py b/core/models.py index 111900b..d36482c 100644 --- a/core/models.py +++ b/core/models.py @@ -46,8 +46,8 @@ class CustomUser(AbstractBaseUser, PermissionsMixin): email_verified = models.BooleanField('Email verificado', default=False, null=True) company = models.ForeignKey(Company, null=True, on_delete=models.DO_NOTHING, related_name='custom_user') - is_active = models.BooleanField('Activo', default=True) - is_staff = models.BooleanField('Empleado',default=False ) + is_active = models.BooleanField('Activo', default=False) + is_staff = models.BooleanField('Empleado',default=False) modified = models.DateTimeField(auto_now=True, null=True, blank=True) created = models.DateTimeField(auto_now_add=True, null=True, blank=True) diff --git a/core/serializers.py b/core/serializers.py index b1443f7..8ba39c4 100644 --- a/core/serializers.py +++ b/core/serializers.py @@ -11,14 +11,14 @@ class CustomUserReadSerializer(serializers.ModelSerializer): class Meta: model = User - fields = ('email', 'full_name', 'role', 'is_active',) + fields = ('email', 'full_name', 'role', 'is_active', 'provider') class CustomUserWriteSerializer(serializers.ModelSerializer): class Meta: model = User - fields = ('email', 'full_name', 'role', 'is_active', 'password') + fields = ('email', 'full_name', 'role', 'password', 'provider') class CreatorSerializer(serializers.ModelSerializer): diff --git a/core/tests.py b/core/tests.py index 822e900..13f8cb2 100644 --- a/core/tests.py +++ b/core/tests.py @@ -43,6 +43,7 @@ class CustomUserViewSetTest(APITestCase): 'email': 'test@email.com', 'full_name': 'TEST NAME', 'password': 'VENTILADORES1234499.89', + 'provider': 'TWITTER', } # Query endpoint @@ -57,7 +58,6 @@ class CustomUserViewSetTest(APITestCase): self.assertNotEqual('', new_user.password) # assert instance is inactive info = json.loads(response.content) - self.assertFalse(info['is_active']) def test_anon_user_cannot_modify_existing_instance(self): @@ -110,6 +110,27 @@ class CustomUserViewSetTest(APITestCase): # Assert access is forbidden self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + def test_regular_user_can_modify_own_instance(self): + """Regular user can modify own instance + """ + # Create instance + data = { + "email": "new_email@mail.com", + "full_name": "New Full Name", + "password": "SUPERSECRETNEWPASSWORD", + } + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # Query endpoint + url = self.endpoint + f'{self.user.pk}/' + response = self.client.put(url, data=data, format='json') + + # Assert forbidden code + self.assertEqual(response.status_code, status.HTTP_200_OK) + def test_regular_user_cannot_modify_existing_instance(self): """Regular user cannot modify existing instance """ diff --git a/core/views.py b/core/views.py index e8265e3..0d4119e 100644 --- a/core/views.py +++ b/core/views.py @@ -1,4 +1,4 @@ -from django.shortcuts import render +from django.shortcuts import render, get_object_or_404 from django.http import HttpResponse from rest_framework import status @@ -44,3 +44,8 @@ class CustomUserViewSet(viewsets.ModelViewSet): serializer.errors, status=status.HTTP_406_NOT_ACCEPTABLE) except Exception as e: return Response(str(e), status=status.HTTP_500_INTERNAL_SERVER_ERROR) + + def get_object(self): + obj = get_object_or_404(self.get_queryset(), pk=self.kwargs["pk"]) + self.check_object_permissions(self.request, obj) + return obj \ No newline at end of file From ca89ac73f23abfac8dddf34b426f77a58e916d1e Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 1 Feb 2021 13:36:42 +0000 Subject: [PATCH 15/31] update to readme --- README.md | 47 ++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 42 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3ef1321..d3976f0 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,48 @@ To load initial location data use: `python manage.py addgeo` ## Endpoints -- `/api/v1/users/`: User information -- `/api/v1/companies/`: Company information -- `/api/v1/products/`: Product information -- `/api/v1/history/`: Historical records about product importation -- `/api/v1/stats/`: logs about user interaction with products links + +### Users + +Endpoint url: `/api/v1/users/` + +Authenticated users cannot create new users +User are inactive by default + +To create user: +```json +{ + "email": "test_user23@mail.com", + "full_name": "Mr Test User", + "password": "wqertewqr32qrewqr", + "provider": "TWITTER" +} +``` + + +### Companies + +Endpoint url: `/api/v1/companies/` + +### Products + +Endpoint url: `/api/v1/products/` + + +### History + +Endpoint url: `/api/v1/history/`: + +Historical records about product importation + + +### Stats +Endpoint url: `/api/v1/stats/` + +logs about user interaction with products links + + +### Geo location Location ednpoints: From ec584b7aab792de45306c7b56a18471b984f8446 Mon Sep 17 00:00:00 2001 From: Sam Date: Mon, 1 Feb 2021 14:13:58 +0000 Subject: [PATCH 16/31] fixed password update not working --- README.md | 17 +++++++++++++++++ back_latienda/urls.py | 1 - core/tests.py | 21 +++++++++++++++------ core/views.py | 37 +++++++++++++++++++++++++++++++++++-- 4 files changed, 67 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index d3976f0..cbcbdf0 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,23 @@ To load initial location data use: `python manage.py addgeo` ## Endpoints +### Authentication + +Implemented using `djangorestframework-simplejwt` + + +New token pair endpoint: `/api/v1/token/` + +Response: +```json +{ + "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTYxMjI3MTcwNSwianRpIjoiZDU4YTgzYzFkYzFkNDI5MTljMGQ0NzcxNzljNzUxYTQiLCJ1c2VyX2lkIjo4fQ.yln80W5lONSyHwwqF4qBBHteqLuRfdLLWuaQANr_vxc", + "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjEyMTg4OTA1LCJqdGkiOiIzNGIxMzM3NmU4MWI0OWY5YjU3ZmUxM2M5NThmZWZkYiIsInVzZXJfaWQiOjh9.aRDCUvKj7LCvixjPLC9ghy0h7rfRwR6Lo3A7HX4kSHE" +} +``` +Refresh expired token endpoint: `/api/v1/token/refresh/` + + ### Users Endpoint url: `/api/v1/users/` diff --git a/back_latienda/urls.py b/back_latienda/urls.py index 5767a16..dcba025 100644 --- a/back_latienda/urls.py +++ b/back_latienda/urls.py @@ -27,6 +27,5 @@ urlpatterns = [ path('admin/', admin.site.urls), path('api/v1/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'), path('api/v1/token/refresh/', TokenRefreshView.as_view(), name='token_refresh'), - path('api/v1/token/verify/', TokenVerifyView.as_view(), name='token_verify'), path('api/v1/', include(router.urls)), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/core/tests.py b/core/tests.py index 13f8cb2..89cf9eb 100644 --- a/core/tests.py +++ b/core/tests.py @@ -26,12 +26,8 @@ class CustomUserViewSetTest(APITestCase): self.endpoint = '/api/v1/users/' self.factory = factories.CustomUserFactory self.model = models.CustomUser - # create admin user - self.admin_email = f"admin_user@mail.com" - self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = self.factory(email=self.admin_email, password=self.password, is_active=True) # create regular user - self.reg_email = f"regular_user@mail.com" + self.reg_email = f"user@mail.com" self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) self.user = self.factory(email=self.reg_email, password=self.password, is_active=True) @@ -129,7 +125,20 @@ class CustomUserViewSetTest(APITestCase): response = self.client.put(url, data=data, format='json') # Assert forbidden code - self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.status_code, status.HTTP_201_CREATED) + + # assert new password hash properly updated + # assert fields exist, and data matches + updated_user = self.model.objects.get(pk=self.user.id) + stored_value = updated_user.__dict__['password'] + hash_type, iteration, salt, stored_password_hash = stored_value.split('$') + new_password_hash = hashlib.pbkdf2_hmac( + hash_name='sha256', + password=data['password'].encode(), + salt=salt.encode(), + iterations=int(iteration), + ) + self.assertEqual(stored_password_hash, base64.b64encode(new_password_hash).decode()) def test_regular_user_cannot_modify_existing_instance(self): """Regular user cannot modify existing instance diff --git a/core/views.py b/core/views.py index 0d4119e..4db0ab7 100644 --- a/core/views.py +++ b/core/views.py @@ -1,5 +1,6 @@ from django.shortcuts import render, get_object_or_404 from django.http import HttpResponse +from django.contrib.auth import get_user_model from rest_framework import status from rest_framework import viewsets @@ -12,13 +13,17 @@ from . import serializers from back_latienda.permissions import CustomUserPermissions # Create your views here. + +User = get_user_model() + + class CustomUserViewSet(viewsets.ModelViewSet): - model = models.CustomUser + model = User serializer_class = serializers.CustomUserReadSerializer write_serializer_class =serializers.CustomUserWriteSerializer model_name = 'custom_user' - queryset = models.CustomUser.objects.all() + queryset = User.objects.all() permission_classes = [CustomUserPermissions,] def create(self, request): @@ -45,6 +50,34 @@ class CustomUserViewSet(viewsets.ModelViewSet): except Exception as e: return Response(str(e), status=status.HTTP_500_INTERNAL_SERVER_ERROR) + def update(self, request, pk): + """ + Update CustomUser Instance + """ + try: + serializer = self.write_serializer_class( + data=request.data, + ) + if serializer.is_valid(): + # save model instance data + password = serializer.validated_data.pop('password') + instance = get_object_or_404(User, pk=pk) + + for key, value in serializer.validated_data.items(): + instance.__dict__[key] = value + + instance.set_password(password) + instance.save() + + return Response(self.serializer_class( + instance, many=False, context={'request': request}).data, + status=status.HTTP_201_CREATED) + else: + return Response( + serializer.errors, status=status.HTTP_406_NOT_ACCEPTABLE) + except Exception as e: + return Response(str(e), status=status.HTTP_500_INTERNAL_SERVER_ERROR) + def get_object(self): obj = get_object_or_404(self.get_queryset(), pk=self.kwargs["pk"]) self.check_object_permissions(self.request, obj) From c8d433c3f905c497eef5576030eddc371c006f9a Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 2 Feb 2021 11:46:43 +0000 Subject: [PATCH 17/31] fixed regression introduced --- README.md | 71 ---------- back_latienda/permissions.py | 29 ++-- back_latienda/settings/base.py | 3 - back_latienda/urls.py | 4 + companies/models.py | 11 +- companies/serializers.py | 5 +- companies/tests.py | 2 +- core/admin.py | 3 - core/management/commands/addgeo.py | 4 +- core/models.py | 9 +- core/serializers.py | 68 +++++++++- core/tests.py | 210 ++++++++++++++++++++--------- core/views.py | 54 +++----- geo/tests.py | 8 +- products/models.py | 6 - products/serializers.py | 6 +- products/tests.py | 2 +- requirements.txt | 3 +- stats/models.py | 3 - utils/tag_serializers.py | 113 ++++++++++++++++ 20 files changed, 377 insertions(+), 237 deletions(-) diff --git a/README.md b/README.md index cbcbdf0..0f2dfde 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,6 @@ This README aims to document functionality of backend as well as required steps - [First Steps](#first-steps) - [Location Data](#location-data) -- [Endpoints](#endpoints) ## First Steps @@ -35,73 +34,3 @@ python manage.py migrate ## Location data To load initial location data use: `python manage.py addgeo` - - -## Endpoints - - -### Authentication - -Implemented using `djangorestframework-simplejwt` - - -New token pair endpoint: `/api/v1/token/` - -Response: -```json -{ - "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTYxMjI3MTcwNSwianRpIjoiZDU4YTgzYzFkYzFkNDI5MTljMGQ0NzcxNzljNzUxYTQiLCJ1c2VyX2lkIjo4fQ.yln80W5lONSyHwwqF4qBBHteqLuRfdLLWuaQANr_vxc", - "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjEyMTg4OTA1LCJqdGkiOiIzNGIxMzM3NmU4MWI0OWY5YjU3ZmUxM2M5NThmZWZkYiIsInVzZXJfaWQiOjh9.aRDCUvKj7LCvixjPLC9ghy0h7rfRwR6Lo3A7HX4kSHE" -} -``` -Refresh expired token endpoint: `/api/v1/token/refresh/` - - -### Users - -Endpoint url: `/api/v1/users/` - -Authenticated users cannot create new users -User are inactive by default - -To create user: -```json -{ - "email": "test_user23@mail.com", - "full_name": "Mr Test User", - "password": "wqertewqr32qrewqr", - "provider": "TWITTER" -} -``` - - -### Companies - -Endpoint url: `/api/v1/companies/` - -### Products - -Endpoint url: `/api/v1/products/` - - -### History - -Endpoint url: `/api/v1/history/`: - -Historical records about product importation - - -### Stats -Endpoint url: `/api/v1/stats/` - -logs about user interaction with products links - - -### Geo location - -Location ednpoints: - -- `/api/v1/countries/` -- `/api/v1/regions/` -- `/api/v1/provinces/` -- `/api/v1/cities/` diff --git a/back_latienda/permissions.py b/back_latienda/permissions.py index 8368e6d..60f46e8 100644 --- a/back_latienda/permissions.py +++ b/back_latienda/permissions.py @@ -41,25 +41,26 @@ class CustomUserPermissions(permissions.BasePermission): """ Custom permissions for managing custom user instances """ + def has_permission(self, request, view): + # allow anon users to create new CustomUser (inactive) + if request.method == 'POST' and request.user.is_anonymous is True: + return True + + # only admins can change or delete + if request.user.is_staff is True: + return True + + # for everything else + return False + + +class YourOwnUserPermissions(permissions.BasePermission): def has_object_permission(self, request, view, obj): - # check for object permissions + # user can interact with own instance of CustomUser if obj.email == request.user.email: return True elif request.user.is_staff is True: return True else: return False - - def has_permission(self, request, view): - # allow anon users to create new CustomUser (inactive) - if request.method == 'POST' and request.user.is_anonymous is True: - return True - elif request.method == 'PUT' and request.user.is_authenticated is True: - return True - # only admins can change or delete - elif request.user.is_staff is True: - return True - - # for everything else - return False diff --git a/back_latienda/settings/base.py b/back_latienda/settings/base.py index 3eaa173..a407d89 100644 --- a/back_latienda/settings/base.py +++ b/back_latienda/settings/base.py @@ -33,15 +33,12 @@ SECRET_KEY = 'td*#7t-(1e9^(g0cod*hs**dp(%zvg@=$cug_-dtzcj#i2mrz@' # Application definition INSTALLED_APPS = [ - 'suit', - 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', - 'django.contrib.gis', # 3rd party 'rest_framework', diff --git a/back_latienda/urls.py b/back_latienda/urls.py index dcba025..eb7fd06 100644 --- a/back_latienda/urls.py +++ b/back_latienda/urls.py @@ -20,6 +20,7 @@ from django.conf import settings from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView, TokenVerifyView +from core import views as core_views from .routers import router @@ -27,5 +28,8 @@ urlpatterns = [ path('admin/', admin.site.urls), path('api/v1/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'), path('api/v1/token/refresh/', TokenRefreshView.as_view(), name='token_refresh'), + path('api/v1/token/verify/', TokenVerifyView.as_view(), name='token_verify'), + path('api/v1/user/change_password//', core_views.ChangeUserPasswordView.as_view(), name="change-password"), + path('api/v1/user/update//', core_views.UpdateUserView.as_view(), name="update-user"), path('api/v1/', include(router.urls)), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/companies/models.py b/companies/models.py index 15944e0..a830e03 100644 --- a/companies/models.py +++ b/companies/models.py @@ -38,17 +38,8 @@ class Company(models.Model): shipping_cost = models.DecimalField('Gastos de envío', max_digits=10, decimal_places=2, null=True, blank=True) tags = TagField(force_lowercase=True,max_count=5, tree=True) sync = models.BooleanField('Sincronizar tienda', default=False, null=True, blank=True) - is_validated = models.BooleanField('Validado', default=False, null=True, blank=True) - is_active = models.BooleanField('Activado', default=False, null=True, blank=True) # Accesible on site # internal created = models.DateTimeField('date of creation', auto_now_add=True) updated = models.DateTimeField('date last update', auto_now=True) - creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='company_creator') - - def __str__(self): - return self.company_name - - class Meta: - verbose_name = "Compañía" - verbose_name_plural = "Compañías" + creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='creator') \ No newline at end of file diff --git a/companies/serializers.py b/companies/serializers.py index b0ca1ce..9ff7fa8 100644 --- a/companies/serializers.py +++ b/companies/serializers.py @@ -1,9 +1,8 @@ from rest_framework import serializers - -from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer - from companies.models import Company +from utils.tag_serializers import TagListSerializerField, TaggitSerializer + class CompanySerializer(TaggitSerializer, serializers.ModelSerializer): tags = TagListSerializerField(required=False) diff --git a/companies/tests.py b/companies/tests.py index 9a4a264..41750b0 100644 --- a/companies/tests.py +++ b/companies/tests.py @@ -27,7 +27,7 @@ class CompanyViewSetTest(APITestCase): self.model = Company # create user self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = CustomUserFactory(password=self.password) + self.user = CustomUserFactory(email="test@mail.com", password=self.password, is_active=True) # user not authenticated def test_not_logged_user_cannot_create_instance(self): diff --git a/core/admin.py b/core/admin.py index c9690d2..8c38f3f 100644 --- a/core/admin.py +++ b/core/admin.py @@ -1,6 +1,3 @@ from django.contrib import admin -from . import models - # Register your models here. -admin.register(models.CustomUser) diff --git a/core/management/commands/addgeo.py b/core/management/commands/addgeo.py index 4f9f92b..6d47e05 100644 --- a/core/management/commands/addgeo.py +++ b/core/management/commands/addgeo.py @@ -26,12 +26,12 @@ class Command(BaseCommand): # create country for spain country = Country.objects.create(name='España') - locations_file = 'datasets/locations.json' + locations_file = 'locations.json' locations = json.loads(open(locations_file).read()) # REGIONS - geo_file='datasets/gadm36_ESP.json' # geo boundary data for regions + geo_file='gadm36_ESP.json' # geo boundary data for regions geo_data = json.loads(open(geo_file).read()) logging.info("Starting Region creation") diff --git a/core/models.py b/core/models.py index d36482c..2a36e28 100644 --- a/core/models.py +++ b/core/models.py @@ -4,9 +4,8 @@ from django.contrib.auth.models import PermissionsMixin from companies.models import Company - # Create your models here. -class CustomUserManager(BaseUserManager): +class UserManager(BaseUserManager): use_in_migrations = True def _create_user(self, email, password, **extra_fields): @@ -18,7 +17,7 @@ class CustomUserManager(BaseUserManager): email = self.normalize_email(email) user = self.model(email=email, **extra_fields) user.set_password(password) - user.save() + user.save(using=self._db) return user def create_user(self, email, password=None, **extra_fields): @@ -47,13 +46,13 @@ class CustomUser(AbstractBaseUser, PermissionsMixin): company = models.ForeignKey(Company, null=True, on_delete=models.DO_NOTHING, related_name='custom_user') is_active = models.BooleanField('Activo', default=False) - is_staff = models.BooleanField('Empleado',default=False) + is_staff = models.BooleanField('Empleado',default=False ) modified = models.DateTimeField(auto_now=True, null=True, blank=True) created = models.DateTimeField(auto_now_add=True, null=True, blank=True) last_visit = models.DateTimeField(auto_now=True) - objects = CustomUserManager() + objects = UserManager() USERNAME_FIELD = 'email' REQUIRED_FIELDS = [] diff --git a/core/serializers.py b/core/serializers.py index 8ba39c4..256f549 100644 --- a/core/serializers.py +++ b/core/serializers.py @@ -1,28 +1,82 @@ -from django.contrib.auth import get_user_model - from rest_framework import serializers from . import models -User = get_user_model() + +class CustomUserSerializer(serializers.ModelSerializer): + + class Meta: + model = models.CustomUser + fields = ('email', 'full_name', 'role', 'is_active') class CustomUserReadSerializer(serializers.ModelSerializer): class Meta: - model = User + model = models.CustomUser fields = ('email', 'full_name', 'role', 'is_active', 'provider') class CustomUserWriteSerializer(serializers.ModelSerializer): class Meta: - model = User + model = models.CustomUser fields = ('email', 'full_name', 'role', 'password', 'provider') - class CreatorSerializer(serializers.ModelSerializer): class Meta: - model = User + model = models.CustomUser fields = ('email',) + + +class ChangePasswordSerializer(serializers.ModelSerializer): + password = serializers.CharField(write_only=True, required=True) + password2 = serializers.CharField(write_only=True, required=True) + old_password = serializers.CharField(write_only=True, required=True) + + class Meta: + model = models.CustomUser + fields = ('old_password', 'password', 'password2') + + def validate(self, attrs): + if attrs['password'] != attrs['password2']: + raise serializers.ValidationError({"password": "Password fields didn't match."}) + + return attrs + + def validate_old_password(self, value): + user = self.context['request'].user + if not user.check_password(value): + raise serializers.ValidationError({"old_password": "Old password is not correct"}) + return value + + def update(self, instance, validated_data): + + instance.set_password(validated_data['password']) + instance.save() + + return instance + + +class UpdateUserSerializer(serializers.ModelSerializer): + email = serializers.EmailField(required=True) + + class Meta: + model = models.CustomUser + fields = ('full_name', 'email') + + def validate_email(self, value): + user = self.context['request'].user + if models.CustomUser.objects.exclude(pk=user.pk).filter(email=value).exists(): + raise serializers.ValidationError({"email": "This email is already in use."}) + return value + + def update(self, instance, validated_data): + for key, value in validated_data.items(): + instance.__dict__[key] = value + + instance.save() + + return instance + diff --git a/core/tests.py b/core/tests.py index 89cf9eb..2938131 100644 --- a/core/tests.py +++ b/core/tests.py @@ -15,7 +15,6 @@ from . import models from . import factories # Create your tests here. - class CustomUserViewSetTest(APITestCase): """CustomUser viewset tests """ @@ -26,20 +25,24 @@ class CustomUserViewSetTest(APITestCase): self.endpoint = '/api/v1/users/' self.factory = factories.CustomUserFactory self.model = models.CustomUser + # create admin user + self.admin_email = f"admin_user@mail.com" + self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) + self.user = self.factory(email=self.admin_email, password=self.password, is_active=True) # create regular user - self.reg_email = f"user@mail.com" + self.reg_email = f"regular_user@mail.com" self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) self.user = self.factory(email=self.reg_email, password=self.password, is_active=True) # anon user def test_anon_user_can_create_inactive_instance(self): """Not logged-in user can create new instance of User but it's inactive + TODO: should create inactive user """ data = { 'email': 'test@email.com', 'full_name': 'TEST NAME', 'password': 'VENTILADORES1234499.89', - 'provider': 'TWITTER', } # Query endpoint @@ -47,11 +50,6 @@ class CustomUserViewSetTest(APITestCase): # Assert creation is successful self.assertEqual(response.status_code, status.HTTP_201_CREATED) - # check for new user instance created - self.assertEquals(1, self.model.objects.filter(email=data['email']).count()) - # assert password has been set - new_user = self.model.objects.get(email=data['email']) - self.assertNotEqual('', new_user.password) # assert instance is inactive info = json.loads(response.content) self.assertFalse(info['is_active']) @@ -106,40 +104,6 @@ class CustomUserViewSetTest(APITestCase): # Assert access is forbidden self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) - def test_regular_user_can_modify_own_instance(self): - """Regular user can modify own instance - """ - # Create instance - data = { - "email": "new_email@mail.com", - "full_name": "New Full Name", - "password": "SUPERSECRETNEWPASSWORD", - } - - # Authenticate - token = get_tokens_for_user(self.user) - self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") - - # Query endpoint - url = self.endpoint + f'{self.user.pk}/' - response = self.client.put(url, data=data, format='json') - - # Assert forbidden code - self.assertEqual(response.status_code, status.HTTP_201_CREATED) - - # assert new password hash properly updated - # assert fields exist, and data matches - updated_user = self.model.objects.get(pk=self.user.id) - stored_value = updated_user.__dict__['password'] - hash_type, iteration, salt, stored_password_hash = stored_value.split('$') - new_password_hash = hashlib.pbkdf2_hmac( - hash_name='sha256', - password=data['password'].encode(), - salt=salt.encode(), - iterations=int(iteration), - ) - self.assertEqual(stored_password_hash, base64.b64encode(new_password_hash).decode()) - def test_regular_user_cannot_modify_existing_instance(self): """Regular user cannot modify existing instance """ @@ -188,25 +152,6 @@ class CustomUserViewSetTest(APITestCase): # Assert access is forbidden self.assertEqual(response.status_code, status.HTTP_401_UNAUTHORIZED) - def test_user_update_password(self): - '''Test the modification of PASSWORD field value for an instance of User ''' - # modify values of alert instance - new_password = "updated_super secret password" - self.user.set_password(new_password) - self.user.save() - # get updated intance using PK - updated_user = self.model.objects.get(pk=self.user.pk) - # assert fields exist, and data matches - stored_value = updated_user.__dict__['password'] - hash_type, iteration, salt, stored_password_hash = stored_value.split('$') - new_password_hash = hashlib.pbkdf2_hmac( - hash_name='sha256', - password=new_password.encode(), - salt=salt.encode(), - iterations=int(iteration), - ) - self.assertEqual(stored_password_hash, base64.b64encode(new_password_hash).decode()) - # admin user def test_admin_user_can_create_instance(self): """Admin user can create new instance @@ -288,3 +233,146 @@ class CustomUserViewSetTest(APITestCase): self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT) # Assert instance doesn't exists anymore on db self.assertFalse(self.model.objects.filter(id=instance.pk).exists()) + + +class ChangeUserPasswordViewTest(APITestCase): + + def setUp(self): + """Tests setup + """ + self.endpoint = '/api/v1/user/update/' + self.factory = factories.CustomUserFactory + self.model = models.CustomUser + # create regular user + self.reg_email = f"user@mail.com" + self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) + self.user = self.factory(email=self.reg_email, is_active=True) + self.user.set_password(self.password) + self.user.save() + + def test_fail_different_passwords(self): + # Create instance + data = { + "old_password": self.password, + "password": "!!!", + "password2": "SUPERSECRETNEWPASSWORD", + } + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # Query endpoint + url = f'/api/v1/user/change_password/{self.user.pk}/' + response = self.client.put(url, data=data, format='json') + + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) + + def test_fail_wrong_old_password(self): + # Create instance + data = { + "old_password": 'WRONG!!!!', + "password": 'SUPERSECRETNEWPASSWORD', + "password2": "SUPERSECRETNEWPASSWORD", + } + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # Query endpoint + url = f'/api/v1/user/change_password/{self.user.pk}/' + response = self.client.put(url, data=data, format='json') + + self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) + + + def test_auth_user_can_modify_own_password(self): + """authenticated user can modify own password + """ + data = { + "old_password": self.password, + "password": "SUPERSECRETNEWPASSWORD", + "password2": "SUPERSECRETNEWPASSWORD", + } + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # Query endpoint + url = f'/api/v1/user/change_password/{self.user.pk}/' + response = self.client.put(url, data=data, format='json') + # Assert forbidden code + self.assertEqual(response.status_code, status.HTTP_200_OK) + + # assert new password hash properly updated + # assert fields exist, and data matches + updated_user = self.model.objects.get(pk=self.user.id) + stored_value = updated_user.__dict__['password'] + hash_type, iteration, salt, stored_password_hash = stored_value.split('$') + new_password_hash = hashlib.pbkdf2_hmac( + hash_name='sha256', + password=data['password'].encode(), + salt=salt.encode(), + iterations=int(iteration), + ) + self.assertEqual(stored_password_hash, base64.b64encode(new_password_hash).decode()) + + +class UpdateUserViewTest(APITestCase): + + def setUp(self): + """Tests setup + """ + self.endpoint = '/api/v1/user/change_password/' + self.factory = factories.CustomUserFactory + self.model = models.CustomUser + # create regular user + self.reg_email = f"user@mail.com" + self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) + self.user = self.factory(email=self.reg_email, is_active=True) + self.user.set_password(self.password) + self.user.save() + + def test_auth_user_can_modify_own_instance(self): + """Regular user can modify own instance + """ + # Create instance + data = { + "email": "new_email@mail.com", + "full_name": "New Full Name", + 'provider': 'PROVIDER', + } + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # Query endpoint + url = f'/api/v1/user/update/{self.user.pk}/' + response = self.client.put(url, data=data, format='json') + # Assert forbidden code + self.assertEqual(response.status_code, status.HTTP_200_OK) + + def test_auth_user_cannot_modify_random_instance(self): + """Regular user can modify own instance + """ + # Create instance + instance = self.factory() + data = { + "email": "new_email@mail.com", + "full_name": "New Full Name", + 'provider': 'PROVIDER', + } + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # Query endpoint + url = f'/api/v1/user/update/{instance.pk}/' + response = self.client.put(url, data=data, format='json') + # Assert forbidden code + self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + diff --git a/core/views.py b/core/views.py index 4db0ab7..fba82d5 100644 --- a/core/views.py +++ b/core/views.py @@ -1,29 +1,26 @@ -from django.shortcuts import render, get_object_or_404 +from django.shortcuts import render from django.http import HttpResponse -from django.contrib.auth import get_user_model from rest_framework import status from rest_framework import viewsets from rest_framework.response import Response from rest_framework.permissions import IsAdminUser +from rest_framework.generics import UpdateAPIView from . import models from . import serializers -from back_latienda.permissions import CustomUserPermissions +from back_latienda.permissions import CustomUserPermissions, YourOwnUserPermissions # Create your views here. - -User = get_user_model() - - class CustomUserViewSet(viewsets.ModelViewSet): - model = User + model = models.CustomUser + # serializer_class = serializers.CustomUserSerializer serializer_class = serializers.CustomUserReadSerializer write_serializer_class =serializers.CustomUserWriteSerializer model_name = 'custom_user' - queryset = User.objects.all() + queryset = models.CustomUser.objects.all() permission_classes = [CustomUserPermissions,] def create(self, request): @@ -50,35 +47,18 @@ class CustomUserViewSet(viewsets.ModelViewSet): except Exception as e: return Response(str(e), status=status.HTTP_500_INTERNAL_SERVER_ERROR) - def update(self, request, pk): - """ - Update CustomUser Instance - """ - try: - serializer = self.write_serializer_class( - data=request.data, - ) - if serializer.is_valid(): - # save model instance data - password = serializer.validated_data.pop('password') - instance = get_object_or_404(User, pk=pk) - for key, value in serializer.validated_data.items(): - instance.__dict__[key] = value +class ChangeUserPasswordView(UpdateAPIView): - instance.set_password(password) - instance.save() + model = models.CustomUser + queryset = model.objects.all() + permission_classes = (YourOwnUserPermissions,) + serializer_class = serializers.ChangePasswordSerializer - return Response(self.serializer_class( - instance, many=False, context={'request': request}).data, - status=status.HTTP_201_CREATED) - else: - return Response( - serializer.errors, status=status.HTTP_406_NOT_ACCEPTABLE) - except Exception as e: - return Response(str(e), status=status.HTTP_500_INTERNAL_SERVER_ERROR) - def get_object(self): - obj = get_object_or_404(self.get_queryset(), pk=self.kwargs["pk"]) - self.check_object_permissions(self.request, obj) - return obj \ No newline at end of file +class UpdateUserView(UpdateAPIView): + + model = models.CustomUser + queryset = model.objects.all() + permission_classes = (YourOwnUserPermissions,) + serializer_class = serializers.UpdateUserSerializer diff --git a/geo/tests.py b/geo/tests.py index b267a05..e15ab7a 100644 --- a/geo/tests.py +++ b/geo/tests.py @@ -135,7 +135,7 @@ class CountryViewSetTest(APITestCase): self.model = models.Country # create user self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = CustomUserFactory(password=self.password) + self.user = CustomUserFactory(email="test@mail.com", password=self.password, is_active=True) def test_anon_user_cannot_create_country(self): """Not logged-in user cannot create new country @@ -263,7 +263,7 @@ class RegionViewSetTest(APITestCase): self.model = models.Region # create user self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = CustomUserFactory(password=self.password) + self.user = CustomUserFactory(email="test@mail.com", password=self.password, is_active=True) def test_not_logged_user_cannot_create_instance(self): """Not logged-in user cannot create new region @@ -397,7 +397,7 @@ class ProvinceViewSetTest(APITestCase): self.model = models.Province # create user self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = CustomUserFactory(password=self.password) + self.user = CustomUserFactory(email="test@mail.com", password=self.password, is_active=True) def test_not_logged_user_cannot_create_instance(self): """Not logged-in user cannot create new instance @@ -531,7 +531,7 @@ class CityViewSetTest(APITestCase): self.model = models.City # create user self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = CustomUserFactory(password=self.password) + self.user = CustomUserFactory(email="test@mail.com", password=self.password, is_active=True) def test_not_logged_user_cannot_create_city(self): """Not logged-in user cannot create new city diff --git a/products/models.py b/products/models.py index 7ef0b98..3dc9742 100644 --- a/products/models.py +++ b/products/models.py @@ -43,9 +43,3 @@ class Product(models.Model): creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='product') # history = models.FoiregnKey('history.History', on_delete=models.DO_NOTHING, null=True) - def __str__(self): - return f"{self.name} / {self.sku}" - - class Meta: - verbose_name = "Producto" - verbose_name_plural = "Productos" diff --git a/products/serializers.py b/products/serializers.py index ddbc05b..e7d2fcf 100644 --- a/products/serializers.py +++ b/products/serializers.py @@ -1,11 +1,9 @@ from rest_framework import serializers -from taggit_serializer.serializers import TagListSerializerField, TaggitSerializer - -from utils.tag_serializers import SingleTagSerializerField - from products.models import Product +from utils.tag_serializers import TagListSerializerField, TaggitSerializer, SingleTagSerializerField + class ProductSerializer(TaggitSerializer, serializers.ModelSerializer): diff --git a/products/tests.py b/products/tests.py index fcb973a..577de8f 100644 --- a/products/tests.py +++ b/products/tests.py @@ -29,7 +29,7 @@ class ProductViewSetTest(APITestCase): self.model = Product # create user self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) - self.user = CustomUserFactory(password=self.password) + self.user = CustomUserFactory(email="test@mail.com", password=self.password, is_active=True) # anon user def test_anon_user_cannot_create_instance(self): diff --git a/requirements.txt b/requirements.txt index 4142296..0e62195 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,5 +7,4 @@ django-filter==2.4.0 -e git://github.com/darklow/django-suit/@v2#egg=django-suit django-cors-headers==3.5.0 django-taggit-serializer==0.1.7 -django-tagulous==1.1.0 -faker==5.7.0 \ No newline at end of file +django-tagulous==1.1.0 \ No newline at end of file diff --git a/stats/models.py b/stats/models.py index 67f1d36..bc7d827 100644 --- a/stats/models.py +++ b/stats/models.py @@ -6,9 +6,6 @@ User = get_user_model() # Create your models here. class StatsLog(models.Model): - """ - Keep track of interactions between user and product links - """ model = models.ForeignKey(ContentType, on_delete=models.DO_NOTHING, null=True) user = models.ForeignKey(User, on_delete=models.DO_NOTHING, null=True) diff --git a/utils/tag_serializers.py b/utils/tag_serializers.py index 70b0277..9f74c72 100644 --- a/utils/tag_serializers.py +++ b/utils/tag_serializers.py @@ -7,6 +7,30 @@ from django.utils.translation import ugettext_lazy as _ from rest_framework import serializers +class TagList(list): + def __init__(self, *args, **kwargs): + pretty_print = kwargs.pop("pretty_print", True) + list.__init__(self, *args, **kwargs) + self.pretty_print = pretty_print + + def __add__(self, rhs): + return TagList(list.__add__(self, rhs)) + + def __getitem__(self, item): + result = list.__getitem__(self, item) + try: + return TagList(result) + except TypeError: + return result + + def __str__(self): + if self.pretty_print: + return json.dumps( + self, sort_keys=True, indent=4, separators=(',', ': ')) + else: + return json.dumps(self) + + class SingleTag(str): def __init__(self, *args, **kwargs): @@ -45,3 +69,92 @@ class SingleTagSerializerField(serializers.Field): value = SingleTag(value) return value + +class TagListSerializerField(serializers.Field): + child = serializers.CharField() + default_error_messages = { + 'not_a_list': _( + 'Expected a list of items but got type "{input_type}".'), + 'invalid_json': _('Invalid json list. A tag list submitted in string' + ' form must be valid json.'), + 'not_a_str': _('All list items must be of string type.') + } + order_by = None + + def __init__(self, **kwargs): + pretty_print = kwargs.pop("pretty_print", True) + + style = kwargs.pop("style", {}) + kwargs["style"] = {'base_template': 'textarea.html'} + kwargs["style"].update(style) + + super(TagListSerializerField, self).__init__(**kwargs) + + self.pretty_print = pretty_print + + def to_internal_value(self, value): + if isinstance(value, six.string_types): + if not value: + value = "[]" + try: + value = json.loads(value) + except ValueError: + self.fail('invalid_json') + + if not isinstance(value, list): + self.fail('not_a_list', input_type=type(value).__name__) + + for s in value: + if not isinstance(s, six.string_types): + self.fail('not_a_str') + + self.child.run_validation(s) + + return value + + def to_representation(self, value): + if not isinstance(value, TagList): + if not isinstance(value, list): + if self.order_by: + tags = value.all().order_by(*self.order_by) + else: + tags = value.all() + value = [tag.name for tag in tags] + value = TagList(value, pretty_print=self.pretty_print) + + return value + + +class TaggitSerializer(serializers.Serializer): + def create(self, validated_data): + to_be_tagged, validated_data = self._pop_tags(validated_data) + + tag_object = super(TaggitSerializer, self).create(validated_data) + + return self._save_tags(tag_object, to_be_tagged) + + def update(self, instance, validated_data): + to_be_tagged, validated_data = self._pop_tags(validated_data) + + tag_object = super(TaggitSerializer, self).update( + instance, validated_data) + + return self._save_tags(tag_object, to_be_tagged) + + def _save_tags(self, tag_object, tags): + for key in tags.keys(): + tag_values = tags.get(key) + getattr(tag_object, key).set(*tag_values) + + return tag_object + + def _pop_tags(self, validated_data): + to_be_tagged = {} + + for key in self.fields.keys(): + field = self.fields[key] + if isinstance(field, TagListSerializerField): + if key in validated_data: + to_be_tagged[key] = validated_data.pop(key) + + return (to_be_tagged, validated_data) From 3e54061733d38b77342390bf91226b2427af0266 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 2 Feb 2021 11:51:00 +0000 Subject: [PATCH 18/31] update to requirements, fix dataset file location in management command --- core/management/commands/addgeo.py | 4 ++-- requirements.txt | 6 ++++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/core/management/commands/addgeo.py b/core/management/commands/addgeo.py index 6d47e05..4f9f92b 100644 --- a/core/management/commands/addgeo.py +++ b/core/management/commands/addgeo.py @@ -26,12 +26,12 @@ class Command(BaseCommand): # create country for spain country = Country.objects.create(name='España') - locations_file = 'locations.json' + locations_file = 'datasets/locations.json' locations = json.loads(open(locations_file).read()) # REGIONS - geo_file='gadm36_ESP.json' # geo boundary data for regions + geo_file='datasets/gadm36_ESP.json' # geo boundary data for regions geo_data = json.loads(open(geo_file).read()) logging.info("Starting Region creation") diff --git a/requirements.txt b/requirements.txt index 0e62195..360f7be 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,10 +1,12 @@ Django==2.2.17 +psycopg2-binary==2.8.6 djangorestframework==3.12.2 -djangorestframework-simplejwt==4.4.0 +djangorestframework-simplejwt==4.6.0 factory-boy==3.1.0 django-dotenv==1.4.2 django-filter==2.4.0 -e git://github.com/darklow/django-suit/@v2#egg=django-suit django-cors-headers==3.5.0 django-taggit-serializer==0.1.7 -django-tagulous==1.1.0 \ No newline at end of file +django-tagulous==1.1.0 +Pillow==8.1.0 \ No newline at end of file From 02b6e9545e4fdeeec56a20bd9f93f8f2eeafc119 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 2 Feb 2021 12:01:05 +0000 Subject: [PATCH 19/31] updated to readme about user management --- README.md | 108 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 108 insertions(+) diff --git a/README.md b/README.md index 0f2dfde..49fee26 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ This README aims to document functionality of backend as well as required steps - [First Steps](#first-steps) - [Location Data](#location-data) +- [Endpoints](#endpoints) ## First Steps @@ -34,3 +35,110 @@ python manage.py migrate ## Location data To load initial location data use: `python manage.py addgeo` + + +## Endpoints + + +### User Management + +Creation: +- endpoint: /api/v1/users/ +- method: GET +- payload: +```json +{ + "email": "test@email.com", + "full_name": "TEST NAME", + "password": "VENTILADOR2ES1234499.89", +} +``` + +Change password: +- endpoint: api/v1/user/change_password/{user.pk}/ +- method: POST +- payload: +```json +{ + "old_password": "my_old_password", + "password": "SUPERSECRETNEWPASSWORD", + "password2": "SUPERSECRETNEWPASSWORD" +} +``` + +Update user profile: +- endpoint: api/v1/user/update// +- method: PUT +- payload: +```json +{ + "email": "new_user@email.com", + "full_name": "Mr. TEST NAME", +} +``` + +### Authentication + +Implemented using `djangorestframework-simplejwt` + + +New token pair endpoint: `/api/v1/token/` + +Response: +```json +{ + "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTYxMjI3MTcwNSwianRpIjoiZDU4YTgzYzFkYzFkNDI5MTljMGQ0NzcxNzljNzUxYTQiLCJ1c2VyX2lkIjo4fQ.yln80W5lONSyHwwqF4qBBHteqLuRfdLLWuaQANr_vxc", + "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjEyMTg4OTA1LCJqdGkiOiIzNGIxMzM3NmU4MWI0OWY5YjU3ZmUxM2M5NThmZWZkYiIsInVzZXJfaWQiOjh9.aRDCUvKj7LCvixjPLC9ghy0h7rfRwR6Lo3A7HX4kSHE" +} +``` +Refresh expired token endpoint: `/api/v1/token/refresh/` + + +### Users + +Endpoint url: `/api/v1/users/` + +Authenticated users cannot create new users +User are inactive by default + +To create user: +```json +{ + "email": "test_user23@mail.com", + "full_name": "Mr Test User", + "password": "wqertewqr32qrewqr", + "provider": "TWITTER" +} +``` + + +### Companies + +Endpoint url: `/api/v1/companies/` + +### Products + +Endpoint url: `/api/v1/products/` + + +### History + +Endpoint url: `/api/v1/history/`: + +Historical records about product importation + + +### Stats +Endpoint url: `/api/v1/stats/` + +logs about user interaction with products links + + +### Geo location + +Location ednpoints: + +- `/api/v1/countries/` +- `/api/v1/regions/` +- `/api/v1/provinces/` +- `/api/v1/cities/` From b5887c5c51771126ecd65b0fd72c2c4a57ac97d1 Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 2 Feb 2021 12:21:42 +0000 Subject: [PATCH 20/31] reenabled django suit --- back_latienda/settings/base.py | 3 +++ companies/factories.py | 6 +++--- companies/models.py | 11 ++++++++++- core/admin.py | 3 +++ products/models.py | 6 ++++++ 5 files changed, 25 insertions(+), 4 deletions(-) diff --git a/back_latienda/settings/base.py b/back_latienda/settings/base.py index a407d89..3eaa173 100644 --- a/back_latienda/settings/base.py +++ b/back_latienda/settings/base.py @@ -33,12 +33,15 @@ SECRET_KEY = 'td*#7t-(1e9^(g0cod*hs**dp(%zvg@=$cug_-dtzcj#i2mrz@' # Application definition INSTALLED_APPS = [ + 'suit', + 'django.contrib.admin', 'django.contrib.auth', 'django.contrib.contenttypes', 'django.contrib.sessions', 'django.contrib.messages', 'django.contrib.staticfiles', + 'django.contrib.gis', # 3rd party 'rest_framework', diff --git a/companies/factories.py b/companies/factories.py index 2c61558..01880cc 100644 --- a/companies/factories.py +++ b/companies/factories.py @@ -11,9 +11,9 @@ class CompanyFactory(DjangoModelFactory): cif = FuzzyText(prefix='CIF_', length=10) company_name = FuzzyText(prefix='COMPANY_NAME_', length=10) short_name = FuzzyText(prefix='SHORT_NAME_', length=10) - web_link = FuzzyText(prefix='http://WEB_LINK_', suffix='.test', length=10) + web_link = FuzzyText(prefix='http://WEB-LINK-', suffix='.test', length=10) shop = FuzzyChoice(choices=(True, False)) - shop_link = FuzzyText(prefix='http://SHOP_LINK_', suffix='.test', length=10) + shop_link = FuzzyText(prefix='http://SHOP-LINK-', suffix='.test', length=10) platform = FuzzyChoice(choices=[x[1] for x in Company.PLATFORMS]) email = FuzzyText(prefix='EMAIL_', suffix='@test.com', length=10) logo = None @@ -24,7 +24,7 @@ class CompanyFactory(DjangoModelFactory): mobile = '+34666555333' other_phone = '+34666555222' description = FuzzyText(prefix='DESCRIPTION_', length=250) - shop_rss_feed = FuzzyText(prefix='http://SHOP_RSS_FEED_', suffix='.test', length=10) + shop_rss_feed = FuzzyText(prefix='http://SHOP-RSS-FEED-', suffix='.test', length=10) sale_terms = FuzzyText(prefix='SALES_TERMS', length=250) shipping_cost = FuzzyDecimal(low=1.00) tags = ['cool', 'hip', 'tech/blockchain'] diff --git a/companies/models.py b/companies/models.py index a830e03..3fb2ab7 100644 --- a/companies/models.py +++ b/companies/models.py @@ -38,8 +38,17 @@ class Company(models.Model): shipping_cost = models.DecimalField('Gastos de envío', max_digits=10, decimal_places=2, null=True, blank=True) tags = TagField(force_lowercase=True,max_count=5, tree=True) sync = models.BooleanField('Sincronizar tienda', default=False, null=True, blank=True) + is_validated = models.BooleanField('Validado', default=False, null=True, blank=True) + is_active = models.BooleanField('Activado', default=False, null=True, blank=True) # internal created = models.DateTimeField('date of creation', auto_now_add=True) updated = models.DateTimeField('date last update', auto_now=True) - creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='creator') \ No newline at end of file + creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='creator') + + def __str__(self): + return self.company_name + + class Meta: + verbose_name = "Compañía" + verbose_name_plural = "Compañías" diff --git a/core/admin.py b/core/admin.py index 8c38f3f..e6daebe 100644 --- a/core/admin.py +++ b/core/admin.py @@ -1,3 +1,6 @@ from django.contrib import admin +from . import models # Register your models here. + +admin.site.register(models.CustomUser) diff --git a/products/models.py b/products/models.py index 3dc9742..7ef0b98 100644 --- a/products/models.py +++ b/products/models.py @@ -43,3 +43,9 @@ class Product(models.Model): creator = models.ForeignKey('core.CustomUser', on_delete=models.DO_NOTHING, null=True, related_name='product') # history = models.FoiregnKey('history.History', on_delete=models.DO_NOTHING, null=True) + def __str__(self): + return f"{self.name} / {self.sku}" + + class Meta: + verbose_name = "Producto" + verbose_name_plural = "Productos" From b906ef0be9b606e5ac8e0a0dc1361970b506d1cc Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 2 Feb 2021 12:51:51 +0000 Subject: [PATCH 21/31] added default roles to user: shop_user, coop_manager --- core/factories.py | 3 ++- core/models.py | 10 +++++++++- core/views.py | 45 +++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+), 2 deletions(-) diff --git a/core/factories.py b/core/factories.py index b5506e2..6422f08 100644 --- a/core/factories.py +++ b/core/factories.py @@ -5,12 +5,13 @@ from factory import LazyAttribute, SubFactory from factory.fuzzy import FuzzyText, FuzzyChoice, FuzzyDateTime, FuzzyDate, FuzzyDecimal from factory.django import DjangoModelFactory +ROLES = ('SHOP_USER', 'COOP_MANAGER') class CustomUserFactory(DjangoModelFactory): email = FuzzyText(length=6, suffix="@mail.com") full_name = FuzzyText(length=15, prefix="TestName_") - role = FuzzyText(length=15, prefix="TestPosition_") + role = FuzzyChoice(ROLES) notify = FuzzyChoice(choices=(True, False)) provider = FuzzyText(length=15, prefix="TestProvider_") email_verified = True diff --git a/core/models.py b/core/models.py index 2a36e28..6120a7c 100644 --- a/core/models.py +++ b/core/models.py @@ -37,9 +37,17 @@ class UserManager(BaseUserManager): class CustomUser(AbstractBaseUser, PermissionsMixin): + SHOP_USER = 'SHOP_USER' + COOP_MANAGER = 'COOP_MANAGER' + + ROLES = ( + (SHOP_USER, 'Shop User'), + (COOP_MANAGER, 'Coop Manager'), + ) + email = models.EmailField('Dirección de email', unique=True) full_name = models.CharField('Nombre completo', max_length=100, blank=True) - role = models.CharField('Rol', max_length=100, blank=True, null=True) + role = models.CharField('Rol', choices=ROLES, default=SHOP_USER, max_length=100, blank=True, null=True) notify = models.BooleanField('Notificar', default=False, null=True) provider = models.CharField('Proveedor', max_length=1000, blank=True, null=True) # red social de registro email_verified = models.BooleanField('Email verificado', default=False, null=True) diff --git a/core/views.py b/core/views.py index fba82d5..c99487b 100644 --- a/core/views.py +++ b/core/views.py @@ -1,18 +1,35 @@ +import csv +import logging + from django.shortcuts import render from django.http import HttpResponse +from django.contrib.auth import get_user_model from rest_framework import status from rest_framework import viewsets from rest_framework.response import Response from rest_framework.permissions import IsAdminUser from rest_framework.generics import UpdateAPIView +from rest_framework.decorators import api_view, permission_classes from . import models from . import serializers from back_latienda.permissions import CustomUserPermissions, YourOwnUserPermissions + + +User = get_user_model() + # Create your views here. +logging.basicConfig( + filename='logs/csv-load.log', + filemode='w', + format='%(levelname)s:%(message)s', + level=logging.INFO, + ) + + class CustomUserViewSet(viewsets.ModelViewSet): model = models.CustomUser @@ -62,3 +79,31 @@ class UpdateUserView(UpdateAPIView): queryset = model.objects.all() permission_classes = (YourOwnUserPermissions,) serializer_class = serializers.UpdateUserSerializer + + +@api_view(['POST',]) +@permission_classes([IsAdminUser,]) +def load_coop_managers(request): + """Read CSV file being received + Parse it to create users and related companies + """ + csv_file = request.FILES["csv_file"] + if csv_file.name.endswith('.csv') is not True: + logging.error(f"File {csv_file.name} is not a CSV file") + return Response({"errors":{"details": "File is not CSV type"}}) + + logging.info(f"Reading contents of {csv_file.name}") + csv_reader = csv.DictReader(csv_file, delimiter=',') + for row in csv_reader: + email = row['email'] + cif = row['cif'] + company_name = row['nombre-coop'] + short_name = row['nombre-corto'] + url = row['url'] + shop = row['es-tienda'] + + coop = None + coop_user = User.objects.create_user(email=email, company=coop, role='COOP_MANAGER') + + + return Response From a80d4565db0b25f4e8cba54b3653c45d38c03b4d Mon Sep 17 00:00:00 2001 From: Sam Date: Tue, 2 Feb 2021 14:22:38 +0000 Subject: [PATCH 22/31] more work on load_coop_managers endpoint, unfinished --- back_latienda/urls.py | 1 + core/tests.py | 84 +++++++++++++++++++++++++++++++++++++++++++ core/views.py | 53 ++++++++++++++++++--------- requirements.txt | 4 ++- 4 files changed, 125 insertions(+), 17 deletions(-) diff --git a/back_latienda/urls.py b/back_latienda/urls.py index eb7fd06..89f3d4a 100644 --- a/back_latienda/urls.py +++ b/back_latienda/urls.py @@ -31,5 +31,6 @@ urlpatterns = [ path('api/v1/token/verify/', TokenVerifyView.as_view(), name='token_verify'), path('api/v1/user/change_password//', core_views.ChangeUserPasswordView.as_view(), name="change-password"), path('api/v1/user/update//', core_views.UpdateUserView.as_view(), name="update-user"), + path('api/v1/load_coops/', core_views.load_coop_managers, name='csv-loader'), path('api/v1/', include(router.urls)), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/core/tests.py b/core/tests.py index 2938131..d8a322c 100644 --- a/core/tests.py +++ b/core/tests.py @@ -3,14 +3,19 @@ import string import json import hashlib import base64 +import csv from django.test import TestCase from rest_framework.test import APITestCase from rest_framework import status +import requests + from core.utils import get_tokens_for_user +from companies.models import Company + from . import models from . import factories # Create your tests here. @@ -376,3 +381,82 @@ class UpdateUserViewTest(APITestCase): # Assert forbidden code self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) + +class LoadCoopManagerTestCase(TestCase): + + def setUp(self): + """Tests setup + """ + self.endpoint = 'http://127.0.0.1:8000/api/v1/load_coops/' + self.user_factory = factories.CustomUserFactory + self.user_model = models.CustomUser + self.company_model = Company + # create admin user + self.admin_email = f"admin_user@mail.com" + self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) + self.admin_user = self.user_factory(email=self.admin_email, password=self.password, is_staff=True, is_active=True) + # create regular user + self.reg_email = f"user@mail.com" + self.user = self.user_factory(email=self.reg_email, is_active=True) + self.user.set_password(self.password) + self.user.save() + + def test_admin_can_load_csv(self): + company_count = self.company_model.objects.count() + user_count = self.user_model.objects.count() + + # read csv file + csv_file = '../coop.csv' + files = {'csv_file': open(csv_file,'rt')} + + # Authenticate + token = get_tokens_for_user(self.admin_user) + headers = {'Authorization': f"Bearer {token['access']}"} + + # send in request + response = requests.post(self.endpoint, files=files, headers=headers) + + # check response + + # check for object creation + self.assertNotEqual(company_count, self.company_model.objects.count()) + self.assertNotEqual(user_count, self.user_model.objects.count()) + + def test_auth_user_cannot_load_csv(self): + company_count = self.company_model.objects.count() + user_count = self.user_model.objects.count() + + # read csv file + csv_file = '../coop.csv' + files = {'csv_file': open(csv_file,'r')} + + # Authenticate + token = get_tokens_for_user(self.user) + headers = {'Authorization': f"Bearer {token['access']}"} + + # send in request + response = requests.post(self.endpoint, files=files, headers=headers) + + # check response + + # check for object creation + self.assertEqual(company_count, self.company_model.objects.count()) + self.assertEqual(user_count, self.user_model.objects.count()) + + def test_anon_user_cannot_load_csv(self): + company_count = self.company_model.objects.count() + user_count = self.user_model.objects.count() + + # read csv file + csv_file = '../coop.csv' + files = {'csv_file': open(csv_file,'r')} + + # Query endpoint + response = self.client.post(self.endpoint, files=files) + + # check response + + # check for object creation + self.assertEqual(company_count, self.company_model.objects.count()) + self.assertEqual(user_count, self.user_model.objects.count()) + diff --git a/core/views.py b/core/views.py index c99487b..7f0aaa1 100644 --- a/core/views.py +++ b/core/views.py @@ -1,5 +1,7 @@ import csv import logging +import json +import io from django.shortcuts import render from django.http import HttpResponse @@ -12,6 +14,8 @@ from rest_framework.permissions import IsAdminUser from rest_framework.generics import UpdateAPIView from rest_framework.decorators import api_view, permission_classes +from companies.models import Company + from . import models from . import serializers @@ -87,23 +91,40 @@ def load_coop_managers(request): """Read CSV file being received Parse it to create users and related companies """ - csv_file = request.FILES["csv_file"] - if csv_file.name.endswith('.csv') is not True: - logging.error(f"File {csv_file.name} is not a CSV file") - return Response({"errors":{"details": "File is not CSV type"}}) + try: - logging.info(f"Reading contents of {csv_file.name}") - csv_reader = csv.DictReader(csv_file, delimiter=',') - for row in csv_reader: - email = row['email'] - cif = row['cif'] - company_name = row['nombre-coop'] - short_name = row['nombre-corto'] - url = row['url'] - shop = row['es-tienda'] + csv_file = request.FILES['csv_file'] + if csv_file.name.endswith('.csv') is not True: + logging.error(f"File {csv_file.name} is not a CSV file") + return Response({"errors":{"details": "File is not CSV type"}}) - coop = None - coop_user = User.objects.create_user(email=email, company=coop, role='COOP_MANAGER') + logging.info(f"Reading contents of {csv_file.name}") + contents = csv_file.file + import ipdb; ipdb.set_trace() + csv_reader = csv.reader(contents, delimiter=',') + coop_counter = 0 + user_counter = 0 + for row in csv_reader: + import ipdb; ipdb.set_trace() + try: + coop_data = { + 'cif': row['cif'], + 'company_name': row['nombre-coop'], + 'short_name': row['nombre-corto'], + 'shop': row['es-tienda'], + 'url': row['url'], + } + coop = Company.object.create(**coop_data) + logging.info(f"Created Coop: {coop_data}") + coop_counter += 1 - return Response + coop_user = User.objects.create_user(email=row['email'], company=coop, role='COOP_MANAGER') + logging.info(f"Created User: {coop_user}") + user_counter += 1 + except Exception as e: + logging.error(f"Could not parse {row}") + + return Response() + except Exception as e: + return Response({"errors": {"details": str(type(e))}}) diff --git a/requirements.txt b/requirements.txt index 360f7be..ab1a7f7 100644 --- a/requirements.txt +++ b/requirements.txt @@ -9,4 +9,6 @@ django-filter==2.4.0 django-cors-headers==3.5.0 django-taggit-serializer==0.1.7 django-tagulous==1.1.0 -Pillow==8.1.0 \ No newline at end of file +Pillow==8.1.0 +# for testing +requests==2.25.1 \ No newline at end of file From cc0bb2ebbf568138e2c88f1e23aa06b30f4e4d14 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 09:59:01 +0000 Subject: [PATCH 23/31] csv loading working --- core/tests.py | 39 +++++++++++++++++++-------------------- core/views.py | 21 +++++++++------------ datasets/test_coop.csv | 9 +++++++++ requirements.txt | 2 -- 4 files changed, 37 insertions(+), 34 deletions(-) create mode 100644 datasets/test_coop.csv diff --git a/core/tests.py b/core/tests.py index d8a322c..9eb4f83 100644 --- a/core/tests.py +++ b/core/tests.py @@ -10,8 +10,6 @@ from django.test import TestCase from rest_framework.test import APITestCase from rest_framework import status -import requests - from core.utils import get_tokens_for_user from companies.models import Company @@ -382,12 +380,13 @@ class UpdateUserViewTest(APITestCase): self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) -class LoadCoopManagerTestCase(TestCase): +class LoadCoopManagerTestCase(APITestCase): def setUp(self): """Tests setup """ - self.endpoint = 'http://127.0.0.1:8000/api/v1/load_coops/' + self.url = 'http://127.0.0.1:8000/api/v1/load_coops/' + self.endpoint = '/api/v1/load_coops/' self.user_factory = factories.CustomUserFactory self.user_model = models.CustomUser self.company_model = Company @@ -400,24 +399,26 @@ class LoadCoopManagerTestCase(TestCase): self.user = self.user_factory(email=self.reg_email, is_active=True) self.user.set_password(self.password) self.user.save() + # test CSV file path + self.csv_path = 'datasets/test_coop.csv' def test_admin_can_load_csv(self): company_count = self.company_model.objects.count() user_count = self.user_model.objects.count() # read csv file - csv_file = '../coop.csv' - files = {'csv_file': open(csv_file,'rt')} + csv_file = 'datasets/test_coop.csv' + files = {'csv_file': open(self.csv_path,'rt')} # Authenticate token = get_tokens_for_user(self.admin_user) - headers = {'Authorization': f"Bearer {token['access']}"} + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") # send in request - response = requests.post(self.endpoint, files=files, headers=headers) - - # check response + response = self.client.post(self.url, files) + # check re sponse + self.assertEqual(response.status_code, 200) # check for object creation self.assertNotEqual(company_count, self.company_model.objects.count()) self.assertNotEqual(user_count, self.user_model.objects.count()) @@ -427,18 +428,17 @@ class LoadCoopManagerTestCase(TestCase): user_count = self.user_model.objects.count() # read csv file - csv_file = '../coop.csv' - files = {'csv_file': open(csv_file,'r')} + files = {'csv_file': open(self.csv_path,'r')} # Authenticate token = get_tokens_for_user(self.user) - headers = {'Authorization': f"Bearer {token['access']}"} + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") # send in request - response = requests.post(self.endpoint, files=files, headers=headers) + response = self.client.post(self.url, files) # check response - + self.assertEqual(response.status_code, 403) # check for object creation self.assertEqual(company_count, self.company_model.objects.count()) self.assertEqual(user_count, self.user_model.objects.count()) @@ -448,14 +448,13 @@ class LoadCoopManagerTestCase(TestCase): user_count = self.user_model.objects.count() # read csv file - csv_file = '../coop.csv' - files = {'csv_file': open(csv_file,'r')} + files = {'csv_file': open(self.csv_path,'r')} - # Query endpoint - response = self.client.post(self.endpoint, files=files) + # send in request + response = self.client.post(self.url, files) # check response - + self.assertEqual(response.status_code, 401) # check for object creation self.assertEqual(company_count, self.company_model.objects.count()) self.assertEqual(user_count, self.user_model.objects.count()) diff --git a/core/views.py b/core/views.py index 7f0aaa1..c0443ea 100644 --- a/core/views.py +++ b/core/views.py @@ -92,35 +92,32 @@ def load_coop_managers(request): Parse it to create users and related companies """ try: - csv_file = request.FILES['csv_file'] if csv_file.name.endswith('.csv') is not True: logging.error(f"File {csv_file.name} is not a CSV file") return Response({"errors":{"details": "File is not CSV type"}}) logging.info(f"Reading contents of {csv_file.name}") - contents = csv_file.file - import ipdb; ipdb.set_trace() - csv_reader = csv.reader(contents, delimiter=',') + decoded_file = csv_file.read().decode('utf-8').splitlines() + csv_reader = csv.DictReader(decoded_file, delimiter=',') coop_counter = 0 user_counter = 0 for row in csv_reader: - import ipdb; ipdb.set_trace() try: coop_data = { - 'cif': row['cif'], - 'company_name': row['nombre-coop'], - 'short_name': row['nombre-corto'], - 'shop': row['es-tienda'], - 'url': row['url'], + 'cif': row['cif'].strip(), + 'company_name': row['nombre-coop'].strip(), + 'short_name': row['nombre-corto'].strip(), + 'shop': bool(row['es-tienda'].strip()), + 'shop_link': row['url'].strip(), } - - coop = Company.object.create(**coop_data) + coop = Company.objects.create(**coop_data) logging.info(f"Created Coop: {coop_data}") coop_counter += 1 coop_user = User.objects.create_user(email=row['email'], company=coop, role='COOP_MANAGER') logging.info(f"Created User: {coop_user}") + # TODO: send confirmation email user_counter += 1 except Exception as e: logging.error(f"Could not parse {row}") diff --git a/datasets/test_coop.csv b/datasets/test_coop.csv new file mode 100644 index 0000000..9d97ecd --- /dev/null +++ b/datasets/test_coop.csv @@ -0,0 +1,9 @@ +email,cif,nombre-coop,nombre-corto,url,es-tienda +qwer@mail.com, 1223432214L, FEWQ4FEWQ COOP, fc, tienda1.com, True +dsfds@mail.com, 65876514L, FEW2QFEWQ COOP, fc, tienda2.com, True +ghjhg@mail.com, 122343214L, FEWQF2EWQ COOP, fc, tienda3.com, True +xcv@mail.com, 12343214L, FEWQ2FEWQ COOP, fc, tienda4.com, True +cvc@mail.com, 1879783214L, 2FEWQFEWQ COOP, fc, tienda5.com, True +bvbc@mail.com, 5653214L, FEW2QFEWQ COOP, fc, tienda6.com, True +kjk@mail.com, 54326543H, FE2WQF2EWQ COOP, fc, tienda7.com, True +yuyu@mail.com, 12343214L, F2EWQFEWQ COOP, fc, tienda8.com, True \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index ab1a7f7..b13037e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -10,5 +10,3 @@ django-cors-headers==3.5.0 django-taggit-serializer==0.1.7 django-tagulous==1.1.0 Pillow==8.1.0 -# for testing -requests==2.25.1 \ No newline at end of file From 569ba6515b8d5b94b15ccf7b2ed39a057895fa4d Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 10:28:58 +0000 Subject: [PATCH 24/31] readme update --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 49fee26..3a17b7f 100644 --- a/README.md +++ b/README.md @@ -77,6 +77,15 @@ Update user profile: } ``` +### COOP and Managin User Data Load + +For massive load of data from COOPs and the managing user. + +CSV headers: `email,cif,nombre-coop,nombre-corto,url,es-tienda` + +Only admin users have access to endoint + + ### Authentication Implemented using `djangorestframework-simplejwt` From e6ada44704d468b73edd3d84f4c75ebc9add4f4d Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 11:32:58 +0000 Subject: [PATCH 25/31] implemented required fields for csv data load --- core/tests.py | 5 +++-- core/views.py | 4 ++++ datasets/test_coop.csv | 12 ++++++------ 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/core/tests.py b/core/tests.py index 9eb4f83..557da7e 100644 --- a/core/tests.py +++ b/core/tests.py @@ -403,6 +403,7 @@ class LoadCoopManagerTestCase(APITestCase): self.csv_path = 'datasets/test_coop.csv' def test_admin_can_load_csv(self): + # delete all instances company_count = self.company_model.objects.count() user_count = self.user_model.objects.count() @@ -420,8 +421,8 @@ class LoadCoopManagerTestCase(APITestCase): # check re sponse self.assertEqual(response.status_code, 200) # check for object creation - self.assertNotEqual(company_count, self.company_model.objects.count()) - self.assertNotEqual(user_count, self.user_model.objects.count()) + self.assertEquals(company_count + 5, self.company_model.objects.count()) + self.assertEquals(user_count + 5, self.user_model.objects.count()) def test_auth_user_cannot_load_csv(self): company_count = self.company_model.objects.count() diff --git a/core/views.py b/core/views.py index c0443ea..2e7f5cb 100644 --- a/core/views.py +++ b/core/views.py @@ -103,6 +103,9 @@ def load_coop_managers(request): coop_counter = 0 user_counter = 0 for row in csv_reader: + if '' in (row['cif'], row['nombre-coop'], row['email']): + logging.error(f"Required data missing: {row}") + continue try: coop_data = { 'cif': row['cif'].strip(), @@ -111,6 +114,7 @@ def load_coop_managers(request): 'shop': bool(row['es-tienda'].strip()), 'shop_link': row['url'].strip(), } + # import ipdb; ipdb.set_trace() coop = Company.objects.create(**coop_data) logging.info(f"Created Coop: {coop_data}") coop_counter += 1 diff --git a/datasets/test_coop.csv b/datasets/test_coop.csv index 9d97ecd..6080b1e 100644 --- a/datasets/test_coop.csv +++ b/datasets/test_coop.csv @@ -1,9 +1,9 @@ email,cif,nombre-coop,nombre-corto,url,es-tienda -qwer@mail.com, 1223432214L, FEWQ4FEWQ COOP, fc, tienda1.com, True -dsfds@mail.com, 65876514L, FEW2QFEWQ COOP, fc, tienda2.com, True -ghjhg@mail.com, 122343214L, FEWQF2EWQ COOP, fc, tienda3.com, True -xcv@mail.com, 12343214L, FEWQ2FEWQ COOP, fc, tienda4.com, True -cvc@mail.com, 1879783214L, 2FEWQFEWQ COOP, fc, tienda5.com, True -bvbc@mail.com, 5653214L, FEW2QFEWQ COOP, fc, tienda6.com, True +, 1223432214L, FEWQ4FEWQ COOP, fc, tienda1.com, True +dsfds@mail.com,, FEW2QFEWQ COOP, fc, tienda2.com, True +ghjhg@mail.com, 122343214L,, fc, tienda3.com, True +xcv@mail.com, 12343214L, FEWQ2FEWQ COOP,, tienda4.com, True +cvc@mail.com, 1879783214L, 2FEWQFEWQ COOP, fc,, True +bvbc@mail.com, 5653214L, FEW2QFEWQ COOP, fc, tienda6.com, kjk@mail.com, 54326543H, FE2WQF2EWQ COOP, fc, tienda7.com, True yuyu@mail.com, 12343214L, F2EWQFEWQ COOP, fc, tienda8.com, True \ No newline at end of file From f3698014e6c446efde701f5a8b5191a6d0842b0a Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 11:46:46 +0000 Subject: [PATCH 26/31] change to user serializer --- core/models.py | 2 +- core/serializers.py | 2 +- core/tests.py | 8 +++++--- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/core/models.py b/core/models.py index 6120a7c..53b36d4 100644 --- a/core/models.py +++ b/core/models.py @@ -53,7 +53,7 @@ class CustomUser(AbstractBaseUser, PermissionsMixin): email_verified = models.BooleanField('Email verificado', default=False, null=True) company = models.ForeignKey(Company, null=True, on_delete=models.DO_NOTHING, related_name='custom_user') - is_active = models.BooleanField('Activo', default=False) + is_active = models.BooleanField('Activo', default=True) is_staff = models.BooleanField('Empleado',default=False ) modified = models.DateTimeField(auto_now=True, null=True, blank=True) diff --git a/core/serializers.py b/core/serializers.py index 256f549..c60a2ab 100644 --- a/core/serializers.py +++ b/core/serializers.py @@ -14,7 +14,7 @@ class CustomUserReadSerializer(serializers.ModelSerializer): class Meta: model = models.CustomUser - fields = ('email', 'full_name', 'role', 'is_active', 'provider') + fields = ('id', 'email', 'full_name', 'role', 'is_active', 'provider', 'notify') class CustomUserWriteSerializer(serializers.ModelSerializer): diff --git a/core/tests.py b/core/tests.py index 557da7e..204ac9e 100644 --- a/core/tests.py +++ b/core/tests.py @@ -38,7 +38,7 @@ class CustomUserViewSetTest(APITestCase): self.user = self.factory(email=self.reg_email, password=self.password, is_active=True) # anon user - def test_anon_user_can_create_inactive_instance(self): + def test_anon_user_can_create_active_instance(self): """Not logged-in user can create new instance of User but it's inactive TODO: should create inactive user """ @@ -55,7 +55,7 @@ class CustomUserViewSetTest(APITestCase): self.assertEqual(response.status_code, status.HTTP_201_CREATED) # assert instance is inactive info = json.loads(response.content) - self.assertFalse(info['is_active']) + self.assertTrue(info['is_active']) def test_anon_user_cannot_modify_existing_instance(self): """Not logged-in user cannot modify existing instance @@ -196,7 +196,8 @@ class CustomUserViewSetTest(APITestCase): # Define request data data = { 'email': 'test_alt@email.com', - 'full_name': 'TEST NAME ALT' + 'full_name': 'TEST NAME ALT', + 'notify': True, } # Authenticate user @@ -346,6 +347,7 @@ class UpdateUserViewTest(APITestCase): "email": "new_email@mail.com", "full_name": "New Full Name", 'provider': 'PROVIDER', + 'notify': True, } # Authenticate From 05fa09a8f342394bc9a73e85a2eec5c42f0198de Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 12:24:18 +0000 Subject: [PATCH 27/31] massive product load implementation, not tested --- back_latienda/urls.py | 4 +- core/views.py | 1 + datasets/test_products.csv | 1 + products/views.py | 80 +++++++++++++++++++++++++++++++++++++- 4 files changed, 84 insertions(+), 2 deletions(-) create mode 100644 datasets/test_products.csv diff --git a/back_latienda/urls.py b/back_latienda/urls.py index 89f3d4a..5541f26 100644 --- a/back_latienda/urls.py +++ b/back_latienda/urls.py @@ -21,6 +21,7 @@ from django.conf import settings from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView, TokenVerifyView from core import views as core_views +from products import views as product_views from .routers import router @@ -31,6 +32,7 @@ urlpatterns = [ path('api/v1/token/verify/', TokenVerifyView.as_view(), name='token_verify'), path('api/v1/user/change_password//', core_views.ChangeUserPasswordView.as_view(), name="change-password"), path('api/v1/user/update//', core_views.UpdateUserView.as_view(), name="update-user"), - path('api/v1/load_coops/', core_views.load_coop_managers, name='csv-loader'), + path('api/v1/load_coops/', core_views.load_coop_managers, name='coop-loader'), + path('api/v1/load_products/', product_views.load_coop_products, name='product-loader'), path('api/v1/', include(router.urls)), ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT) diff --git a/core/views.py b/core/views.py index 2e7f5cb..6c99566 100644 --- a/core/views.py +++ b/core/views.py @@ -129,3 +129,4 @@ def load_coop_managers(request): return Response() except Exception as e: return Response({"errors": {"details": str(type(e))}}) + diff --git a/datasets/test_products.csv b/datasets/test_products.csv new file mode 100644 index 0000000..d3ee8b5 --- /dev/null +++ b/datasets/test_products.csv @@ -0,0 +1 @@ +id,nombre-producto,descripcion,imagen,url,precio,gastos-envio,cond-envio,descuento,stock,tags,categoria,identificadores \ No newline at end of file diff --git a/products/views.py b/products/views.py index ba342cb..2982557 100644 --- a/products/views.py +++ b/products/views.py @@ -1,8 +1,15 @@ +import logging +import csv + from django.shortcuts import render +from django.conf import settings # Create your views here. from rest_framework import viewsets -from rest_framework.permissions import IsAuthenticatedOrReadOnly +from rest_framework.permissions import IsAuthenticatedOrReadOnly, IsAdminUser +from rest_framework.decorators import api_view, permission_classes + +import requests from products.models import Product from products.serializers import ProductSerializer @@ -10,7 +17,78 @@ from products.serializers import ProductSerializer from back_latienda.permissions import IsCreator +logging.basicConfig( + filename='logs/product-load.log', + filemode='w', + format='%(levelname)s:%(message)s', + level=logging.INFO, + ) + + class ProductViewSet(viewsets.ModelViewSet): queryset = Product.objects.all() serializer_class = ProductSerializer permission_classes = [IsAuthenticatedOrReadOnly, IsCreator] + + +@api_view(['POST',]) +@permission_classes([IsAdminUser,]) +def load_coop_products(request): + """Read CSV file being received + Parse it to create products for related Company + """ + try: + csv_file = request.FILES['csv_file'] + if csv_file.name.endswith('.csv') is not True: + logging.error(f"File {csv_file.name} is not a CSV file") + return Response({"errors":{"details": "File is not CSV type"}}) + + logging.info(f"Reading contents of {csv_file.name}") + decoded_file = csv_file.read().decode('utf-8').splitlines() + csv_reader = csv.DictReader(decoded_file, delimiter=',') + counter = 0 + for row in csv_reader: + if '' in (row['nombre-producto'], row['descripcion'], row['precio']): + logging.error(f"Required data missing: {row}") + continue + try: + # download image references in csv + image_url = row['image'].strip() + response = requests.get(image_url, stream=True) + if response.status_code == 200: + path = f"{setting.BASE_DIR}media/{row['nombre-producto'].strip()}.{image.url.split('/')[-1]}" + logging.info(f"Saving product image to: {path}") + new_image = open(path, 'wb') + for chunk in response: + new_image.write(chunk) + new_image.close() + else: + logging.warninig(f"Image URL did not work: {image_url}") + new_image = None + # assemble instance data + product_data = { + 'id': None if row['id'].strip()=='' else row['id'].strip(), + 'name': row['nombre-coop'].strip(), + 'short_name': row['nombre-producto'].strip(), + 'description': row['descripcion'].strip(), + 'image': new_image, + 'url': row['url'].strip(), + 'precio': row['precio'].strip(), + 'shipping_cost': row['gastos-envio'].strip(), + 'shipping_terms': row['cond-envio'].strip(), + 'discount': row['descuento'].strip(), + 'stock': row['stock'].strip(), + 'tags': row['tags'].strip(), + 'category': row['categoria'].strip(), + 'identifiers': row['identificadores'].strip(), + } + Product.objects.create(**product_data) + logging.info(f"Created Product: {product_data}") + counter += 1 + except Exception as e: + logging.error(f"Could not parse {row}") + return Response() + except Exception as e: + return Response({"errors": {"details": str(type(e))}}) + + From b7ab7eb5d399eab106c93e82147df4b88854d282 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 12:33:32 +0000 Subject: [PATCH 28/31] added test for product load --- core/tests.py | 3 +- products/tests.py | 75 +++++++++++++++++++++++++++++++++++++++++++++++ products/views.py | 1 + 3 files changed, 77 insertions(+), 2 deletions(-) diff --git a/core/tests.py b/core/tests.py index 204ac9e..5d98fe9 100644 --- a/core/tests.py +++ b/core/tests.py @@ -405,12 +405,11 @@ class LoadCoopManagerTestCase(APITestCase): self.csv_path = 'datasets/test_coop.csv' def test_admin_can_load_csv(self): - # delete all instances + # count existing instances company_count = self.company_model.objects.count() user_count = self.user_model.objects.count() # read csv file - csv_file = 'datasets/test_coop.csv' files = {'csv_file': open(self.csv_path,'rt')} # Authenticate diff --git a/products/tests.py b/products/tests.py index 577de8f..85940ae 100644 --- a/products/tests.py +++ b/products/tests.py @@ -259,3 +259,78 @@ class ProductViewSetTest(APITestCase): self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT) # Assert instance doesn't exists anymore on db self.assertFalse(self.model.objects.filter(id=instance.pk).exists()) + + +class LoadCoopProductsTestCase(APITestCase): + + def setUp(self): + """Tests setup + """ + self.endpoint = '/api/v1/load_products/' + self.model = Product + self.factory = ProductFactory + # create admin user + self.admin_email = f"admin_user@mail.com" + self.password = ''.join(random.choices(string.ascii_uppercase, k = 10)) + self.admin_user = CustomUserFactory(email=self.admin_email, password=self.password, is_staff=True, is_active=True) + # create regular user + self.reg_email = f"user@mail.com" + self.user = CustomUserFactory(email=self.reg_email, is_active=True) + self.user.set_password(self.password) + self.user.save() + # test CSV file path + self.csv_path = 'datasets/test_products.csv' + + def test_admin_can_load_csv(self): + # delete existing instances + self.model.objects.all().delete() + + # read csv file + files = {'csv_file': open(self.csv_path,'rt')} + + # Authenticate + token = get_tokens_for_user(self.admin_user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # send in request + response = self.client.post(self.endpoint, files) + + # check re sponse + self.assertEqual(response.status_code, 200) + # check for object creation + self.assertEquals(5, self.model.objects.count()) + + def test_auth_user_cannot_load_csv(self): + # delete existing instances + self.model.objects.all().delete() + + # read csv file + files = {'csv_file': open(self.csv_path,'r')} + + # Authenticate + token = get_tokens_for_user(self.user) + self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") + + # send in request + response = self.client.post(self.endpoint, files) + + # check response + self.assertEqual(response.status_code, 403) + # check for object creation + self.assertEqual(0, self.model.objects.count()) + + def test_anon_user_cannot_load_csv(self): + # delete existing instances + self.model.objects.all().delete() + + # read csv file + files = {'csv_file': open(self.csv_path,'r')} + + # send in request + response = self.client.post(self.endpoint, files) + + # check response + self.assertEqual(response.status_code, 401) + # check for object creation + self.assertEqual(0, self.model.objects.count()) + diff --git a/products/views.py b/products/views.py index 2982557..39789e7 100644 --- a/products/views.py +++ b/products/views.py @@ -6,6 +6,7 @@ from django.conf import settings # Create your views here. from rest_framework import viewsets +from rest_framework.response import Response from rest_framework.permissions import IsAuthenticatedOrReadOnly, IsAdminUser from rest_framework.decorators import api_view, permission_classes From b4eaa0f287c252b60c22371fbe7778144e73db5e Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 13:00:08 +0000 Subject: [PATCH 29/31] massive load of products working --- datasets/test_products.csv | 11 ++++++++++- products/views.py | 35 +++++++++++++++++++++-------------- 2 files changed, 31 insertions(+), 15 deletions(-) diff --git a/datasets/test_products.csv b/datasets/test_products.csv index d3ee8b5..68499ce 100644 --- a/datasets/test_products.csv +++ b/datasets/test_products.csv @@ -1 +1,10 @@ -id,nombre-producto,descripcion,imagen,url,precio,gastos-envio,cond-envio,descuento,stock,tags,categoria,identificadores \ No newline at end of file +id,nombre-producto,descripcion,imagen,url,precio,gastos-envio,cond-envio,descuento,stock,tags,categoria,identificadores +,,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl", limpio, "alto, forma/redondo" +,mi-nombre,mi-descripcion,,coop.com,10.00,5.01,"condiciones de envio, una cosa, y la otra",4.05,1000,"color/rojo, talla/xxl" \ No newline at end of file diff --git a/products/views.py b/products/views.py index 39789e7..d4af09b 100644 --- a/products/views.py +++ b/products/views.py @@ -14,6 +14,7 @@ import requests from products.models import Product from products.serializers import ProductSerializer +from companies.models import Company from back_latienda.permissions import IsCreator @@ -48,33 +49,38 @@ def load_coop_products(request): decoded_file = csv_file.read().decode('utf-8').splitlines() csv_reader = csv.DictReader(decoded_file, delimiter=',') counter = 0 + for row in csv_reader: - if '' in (row['nombre-producto'], row['descripcion'], row['precio']): + if '' in (row['nombre-producto'], row['descripcion'], row['precio'], row['categoria']): logging.error(f"Required data missing: {row}") continue try: # download image references in csv - image_url = row['image'].strip() - response = requests.get(image_url, stream=True) - if response.status_code == 200: - path = f"{setting.BASE_DIR}media/{row['nombre-producto'].strip()}.{image.url.split('/')[-1]}" - logging.info(f"Saving product image to: {path}") - new_image = open(path, 'wb') - for chunk in response: - new_image.write(chunk) - new_image.close() + if row['imagen'].strip() != '': + image_url = row['imagen'].strip() + response = requests.get(image_url, stream=True) + if response.status_code == 200: + path = f"{setting.BASE_DIR}media/{row['nombre-producto'].strip()}.{image.url.split('/')[-1]}" + logging.info(f"Saving product image to: {path}") + new_image = open(path, 'wb') + for chunk in response: + new_image.write(chunk) + new_image.close() + else: + logging.warning(f"Image URL did not work: {image_url}") + new_image = None else: - logging.warninig(f"Image URL did not work: {image_url}") new_image = None # assemble instance data + product_data = { 'id': None if row['id'].strip()=='' else row['id'].strip(), - 'name': row['nombre-coop'].strip(), - 'short_name': row['nombre-producto'].strip(), + 'company': Company.objects.filter(creator=request.user).first(), + 'name': row['nombre-producto'].strip(), 'description': row['descripcion'].strip(), 'image': new_image, 'url': row['url'].strip(), - 'precio': row['precio'].strip(), + 'price': row['precio'].strip(), 'shipping_cost': row['gastos-envio'].strip(), 'shipping_terms': row['cond-envio'].strip(), 'discount': row['descuento'].strip(), @@ -83,6 +89,7 @@ def load_coop_products(request): 'category': row['categoria'].strip(), 'identifiers': row['identificadores'].strip(), } + Product.objects.create(**product_data) logging.info(f"Created Product: {product_data}") counter += 1 From ae7fac60dc0188e52ffc24aa559e12290b715af6 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 13:11:39 +0000 Subject: [PATCH 30/31] added user role SITE_ADMIN --- core/models.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/core/models.py b/core/models.py index 53b36d4..6f4da0b 100644 --- a/core/models.py +++ b/core/models.py @@ -39,10 +39,12 @@ class CustomUser(AbstractBaseUser, PermissionsMixin): SHOP_USER = 'SHOP_USER' COOP_MANAGER = 'COOP_MANAGER' + SITE_ADMIN = 'SITE_ADMIN' ROLES = ( (SHOP_USER, 'Shop User'), (COOP_MANAGER, 'Coop Manager'), + (SITE_ADMIN, 'Site Admin'), ) email = models.EmailField('Dirección de email', unique=True) From ae043b24fc957a81f41c6d93313cace0fada46e9 Mon Sep 17 00:00:00 2001 From: Sam Date: Wed, 3 Feb 2021 13:23:40 +0000 Subject: [PATCH 31/31] updated to readme --- README.md | 31 +++++++++++++++++++++++-------- core/tests.py | 7 +++---- 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 3a17b7f..14d16a5 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This README aims to document functionality of backend as well as required steps - [First Steps](#first-steps) - [Location Data](#location-data) - [Endpoints](#endpoints) +- [Data Load](#data-load) ## First Steps @@ -77,14 +78,6 @@ Update user profile: } ``` -### COOP and Managin User Data Load - -For massive load of data from COOPs and the managing user. - -CSV headers: `email,cif,nombre-coop,nombre-corto,url,es-tienda` - -Only admin users have access to endoint - ### Authentication @@ -151,3 +144,25 @@ Location ednpoints: - `/api/v1/regions/` - `/api/v1/provinces/` - `/api/v1/cities/` + + +## Load Data + + +### COOP and Managing User Data Load + +For massive load of data from COOPs and the managing user. + +CSV headers: `email,cif,nombre-coop,nombre-corto,url,es-tienda` + +Only admin users have access to endoint + +### Product Data Load + +Endpoint: `/api/v1/load_products/` + +For massive load of product data. + +CSV headers: `id,nombre-producto,descripcion,imagen,url,precio,gastos-envio,cond-envio,descuento,stock,tags,categoria,identificadores` + +Only admin users have access to endoint diff --git a/core/tests.py b/core/tests.py index 5d98fe9..9ce297c 100644 --- a/core/tests.py +++ b/core/tests.py @@ -387,7 +387,6 @@ class LoadCoopManagerTestCase(APITestCase): def setUp(self): """Tests setup """ - self.url = 'http://127.0.0.1:8000/api/v1/load_coops/' self.endpoint = '/api/v1/load_coops/' self.user_factory = factories.CustomUserFactory self.user_model = models.CustomUser @@ -417,7 +416,7 @@ class LoadCoopManagerTestCase(APITestCase): self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") # send in request - response = self.client.post(self.url, files) + response = self.client.post(self.endpoint, files) # check re sponse self.assertEqual(response.status_code, 200) @@ -437,7 +436,7 @@ class LoadCoopManagerTestCase(APITestCase): self.client.credentials(HTTP_AUTHORIZATION=f"Bearer {token['access']}") # send in request - response = self.client.post(self.url, files) + response = self.client.post(self.endpoint, files) # check response self.assertEqual(response.status_code, 403) @@ -453,7 +452,7 @@ class LoadCoopManagerTestCase(APITestCase): files = {'csv_file': open(self.csv_path,'r')} # send in request - response = self.client.post(self.url, files) + response = self.client.post(self.endpoint, files) # check response self.assertEqual(response.status_code, 401)