convert example & homeassistant specific configs to a generic with all optional fields

cookbook/views/api.py

@@ -76,7 +76,7 @@ from cookbook.models import (Automation, BookmarkletImport, CookLog, CustomFilte
                              ShoppingListEntry, ShoppingListRecipe, Space, Step, Storage,
                              Supermarket, SupermarketCategory, SupermarketCategoryRelation, Sync,
                              SyncLog, Unit, UnitConversion, UserFile, UserPreference, UserSpace,
-                             ViewLog, HomeAssistantConfig)
+                             ViewLog, ConnectorConfig)
 from cookbook.provider.dropbox import Dropbox
 from cookbook.provider.local import Local
 from cookbook.provider.nextcloud import Nextcloud
@@ -102,7 +102,7 @@ from cookbook.serializer import (AccessTokenSerializer, AutomationSerializer,
                                  SupermarketCategorySerializer, SupermarketSerializer,
                                  SyncLogSerializer, SyncSerializer, UnitConversionSerializer,
                                  UnitSerializer, UserFileSerializer, UserPreferenceSerializer,
-                                 UserSerializer, UserSpaceSerializer, ViewLogSerializer, HomeAssistantConfigSerializer)
+                                 UserSerializer, UserSpaceSerializer, ViewLogSerializer, ConnectorConfigConfigSerializer)
 from cookbook.views.import_export import get_integration
 from recipes import settings
 from recipes.settings import FDC_API_KEY, DRF_THROTTLE_RECIPE_URL_IMPORT
@@ -464,10 +464,9 @@ class StorageViewSet(viewsets.ModelViewSet):
         return self.queryset.filter(space=self.request.space)
 
 
-class HomeAssistantConfigViewSet(viewsets.ModelViewSet):
-    # TODO handle delete protect error and adjust test
-    queryset = HomeAssistantConfig.objects
-    serializer_class = HomeAssistantConfigSerializer
+class ConnectorConfigConfigViewSet(viewsets.ModelViewSet):
+    queryset = ConnectorConfig.objects
+    serializer_class = ConnectorConfigConfigSerializer
     permission_classes = [CustomIsAdmin & CustomTokenHasReadWriteScope]
 
     def get_queryset(self):

cookbook/views/delete.py

@@ -9,7 +9,7 @@ from django.views.generic import DeleteView
 
 from cookbook.helper.permission_helper import GroupRequiredMixin, OwnerRequiredMixin, group_required
 from cookbook.models import (Comment, InviteLink, MealPlan, Recipe, RecipeBook, RecipeBookEntry,
-                             RecipeImport, Space, Storage, Sync, UserSpace, HomeAssistantConfig, ExampleConfig)
+                             RecipeImport, Space, Storage, Sync, UserSpace, ConnectorConfig)
 from cookbook.provider.dropbox import Dropbox
 from cookbook.provider.local import Local
 from cookbook.provider.nextcloud import Nextcloud
@@ -122,27 +122,15 @@ class StorageDelete(GroupRequiredMixin, DeleteView):
             return HttpResponseRedirect(reverse('list_storage'))
 
 
-class HomeAssistantConfigDelete(GroupRequiredMixin, DeleteView):
+class ConnectorConfigDelete(GroupRequiredMixin, DeleteView):
     groups_required = ['admin']
     template_name = "generic/delete_template.html"
-    model = HomeAssistantConfig
-    success_url = reverse_lazy('list_connectors')
+    model = ConnectorConfig
+    success_url = reverse_lazy('list_connector_config')
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        context['title'] = _("HomeAssistant Config Backend")
-        return context
-
-
-class ExampleConfigDelete(GroupRequiredMixin, DeleteView):
-    groups_required = ['admin']
-    template_name = "generic/delete_template.html"
-    model = ExampleConfig
-    success_url = reverse_lazy('list_connectors')
-
-    def get_context_data(self, **kwargs):
-        context = super().get_context_data(**kwargs)
-        context['title'] = _("Example Config Backend")
+        context['title'] = _("Connectors Config Backend")
         return context
 
 

cookbook/views/edit.py

@@ -9,10 +9,10 @@ from django.utils.translation import gettext as _
 from django.views.generic import UpdateView
 from django.views.generic.edit import FormMixin
 
-from cookbook.forms import CommentForm, ExternalRecipeForm, StorageForm, SyncForm, HomeAssistantConfigForm, ExampleConfigForm
+from cookbook.forms import CommentForm, ExternalRecipeForm, StorageForm, SyncForm, ConnectorConfigForm
 from cookbook.helper.permission_helper import (GroupRequiredMixin, OwnerRequiredMixin,
                                                above_space_limit, group_required)
-from cookbook.models import Comment, Recipe, RecipeImport, Storage, Sync, HomeAssistantConfig, ExampleConfig
+from cookbook.models import Comment, Recipe, RecipeImport, Storage, Sync, ConnectorConfig
 from cookbook.provider.dropbox import Dropbox
 from cookbook.provider.local import Local
 from cookbook.provider.nextcloud import Nextcloud
@@ -128,11 +128,11 @@ def edit_storage(request, pk):
     )
 
 
-class HomeAssistantConfigUpdate(GroupRequiredMixin, UpdateView):
+class ConnectorConfigUpdate(GroupRequiredMixin, UpdateView):
     groups_required = ['admin']
     template_name = "generic/edit_template.html"
-    model = HomeAssistantConfig
-    form_class = HomeAssistantConfigForm
+    model = ConnectorConfig
+    form_class = ConnectorConfigForm
 
     def get_form_kwargs(self):
         kwargs = super().get_form_kwargs()
@@ -143,33 +143,14 @@ class HomeAssistantConfigUpdate(GroupRequiredMixin, UpdateView):
         if form.cleaned_data['update_token'] != VALUE_NOT_CHANGED and form.cleaned_data['update_token'] != "":
             form.instance.token = form.cleaned_data['update_token']
         messages.add_message(self.request, messages.SUCCESS, _('Config saved!'))
-        return super(HomeAssistantConfigUpdate, self).form_valid(form)
+        return super(ConnectorConfigUpdate, self).form_valid(form)
 
     def get_success_url(self):
-        return reverse('edit_home_assistant_config', kwargs={'pk': self.object.pk})
+        return reverse('edit_connector_config', kwargs={'pk': self.object.pk})
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        context['title'] = _("HomeAssistantConfig")
-        return context
-
-
-class ExampleConfigUpdate(GroupRequiredMixin, UpdateView):
-    groups_required = ['admin']
-    template_name = "generic/edit_template.html"
-    model = ExampleConfig
-    form_class = ExampleConfigForm
-
-    def form_valid(self, form):
-        messages.add_message(self.request, messages.SUCCESS, _('Config saved!'))
-        return super().form_valid(form)
-
-    def get_success_url(self):
-        return reverse('edit_example_config', kwargs={'pk': self.object.pk})
-
-    def get_context_data(self, **kwargs):
-        context = super().get_context_data(**kwargs)
-        context['title'] = _("ExampleConfig")
+        context['title'] = _("ConnectorConfig")
         return context
 
 

cookbook/views/lists.py

@@ -6,8 +6,8 @@ from django.utils.translation import gettext as _
 from django_tables2 import RequestConfig
 
 from cookbook.helper.permission_helper import group_required
-from cookbook.models import InviteLink, RecipeImport, Storage, SyncLog, UserFile
-from cookbook.tables import ImportLogTable, InviteLinkTable, RecipeImportTable, StorageTable
+from cookbook.models import InviteLink, RecipeImport, Storage, SyncLog, UserFile, ConnectorConfig
+from cookbook.tables import ImportLogTable, InviteLinkTable, RecipeImportTable, StorageTable, ConnectorConfigTable
 
 
 @group_required('admin')
@@ -65,6 +65,22 @@ def storage(request):
     )
 
 
+@group_required('admin')
+def connector_config(request):
+    table = ConnectorConfigTable(ConnectorConfig.objects.filter(space=request.space).all())
+    RequestConfig(request, paginate={'per_page': 25}).configure(table)
+
+    return render(
+        request,
+        'generic/list_template.html',
+        {
+            'title': _("Connector Config Backend"),
+            'table': table,
+            'create_url': 'new_connector_config'
+        }
+    )
+
+
 @group_required('admin')
 def invite_link(request):
     table = InviteLinkTable(

cookbook/views/new.py

@@ -5,9 +5,9 @@ from django.urls import reverse, reverse_lazy
 from django.utils.translation import gettext as _
 from django.views.generic import CreateView
 
-from cookbook.forms import ImportRecipeForm, Storage, StorageForm, HomeAssistantConfigForm, ExampleConfigForm
+from cookbook.forms import ImportRecipeForm, Storage, StorageForm, ConnectorConfigForm
 from cookbook.helper.permission_helper import GroupRequiredMixin, above_space_limit, group_required
-from cookbook.models import Recipe, RecipeImport, ShareLink, Step, HomeAssistantConfig, ExampleConfig
+from cookbook.models import Recipe, RecipeImport, ShareLink, Step, ConnectorConfig
 from recipes import settings
 
 
@@ -70,21 +70,12 @@ class StorageCreate(GroupRequiredMixin, CreateView):
         return context
 
 
-class HomeAssistantConfigCreate(GroupRequiredMixin, CreateView):
+class ConnectorConfigCreate(GroupRequiredMixin, CreateView):
     groups_required = ['admin']
     template_name = "generic/new_template.html"
-    model = HomeAssistantConfig
-    form_class = HomeAssistantConfigForm
-    success_url = reverse_lazy('list_home_assistant_config')
-
-    def get_form_class(self):
-        form_class = super().get_form_class()
-
-        if self.request.method == 'GET':
-            update_token_field = form_class.base_fields['update_token']
-            update_token_field.required = True
-
-        return form_class
+    model = ConnectorConfig
+    form_class = ConnectorConfigForm
+    success_url = reverse_lazy('list_connector_config')
 
     def form_valid(self, form):
         if self.request.space.demo or settings.HOSTED:
@@ -96,35 +87,11 @@ class HomeAssistantConfigCreate(GroupRequiredMixin, CreateView):
         obj.created_by = self.request.user
         obj.space = self.request.space
         obj.save()
-        return HttpResponseRedirect(reverse('edit_home_assistant_config', kwargs={'pk': obj.pk}))
+        return HttpResponseRedirect(reverse('edit_connector_config', kwargs={'pk': obj.pk}))
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
-        context['title'] = _("HomeAssistant Config Backend")
-        return context
-
-
-class ExampleConfigCreate(GroupRequiredMixin, CreateView):
-    groups_required = ['admin']
-    template_name = "generic/new_template.html"
-    model = ExampleConfig
-    form_class = ExampleConfigForm
-    success_url = reverse_lazy('list_connectors')
-
-    def form_valid(self, form):
-        if self.request.space.demo or settings.HOSTED:
-            messages.add_message(self.request, messages.ERROR, _('This feature is not yet available in the hosted version of tandoor!'))
-            return redirect('index')
-
-        obj = form.save(commit=False)
-        obj.created_by = self.request.user
-        obj.space = self.request.space
-        obj.save()
-        return HttpResponseRedirect(reverse('edit_example_config', kwargs={'pk': obj.pk}))
-
-    def get_context_data(self, **kwargs):
-        context = super().get_context_data(**kwargs)
-        context['title'] = _("Example Config Backend")
+        context['title'] = _("Connector Config Backend")
         return context