Merge pull request open5e#755 from calumbell/751/add-services

Add Services to API

Author: augustjohnson

api_v2/admin.py

@@ -109,4 +109,6 @@ class LanguageAdmin(admin.ModelAdmin):
 admin.site.register(Rule)
 admin.site.register(RuleSet)
 
-admin.site.register(Image)
+admin.site.register(Image)
+
+admin.site.register(Service)

api_v2/migrations/0047_service.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.2.1 on 2025-06-04 09:56
+
+import django.core.validators
+import django.db.models.deletion
+from decimal import Decimal
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0046_characterclass_primary_abilities_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Service',
+            fields=[
+                ('desc', models.TextField(help_text='Description of the game content item. Markdown.')),
+                ('cost', models.DecimalField(decimal_places=2, default=None, help_text='Number representing the cost of the object.', max_digits=10, null=True, validators=[django.core.validators.MinValueValidator(Decimal('0'))])),
+                ('key', models.CharField(help_text='Unique key for the Item.', max_length=100, primary_key=True, serialize=False)),
+                ('detail', models.TextField(blank=True, help_text="Additional contextual infomation about the service. ie. For 'Squalid Living' the detail would be '1 day'", null=True)),
+                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='api_v2.document')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
+    ]

api_v2/migrations/0048_service_name.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.2.1 on 2025-06-04 10:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0047_service'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='service',
+            name='name',
+            field=models.CharField(default='default', help_text='Name of the item.', max_length=100),
+            preserve_default=False,
+        ),
+    ]

api_v2/models/__init__.py

@@ -4,7 +4,6 @@
 from .item import Item
 from .item import ItemSet
 from .item import ItemRarity
-
 from .abilities import Ability
 from .abilities import Skill
 
@@ -61,3 +60,5 @@
 from .rule import Rule, RuleSet
 
 from .image import Image
+
+from .service import Service

api_v2/models/abstracts.py

@@ -464,3 +464,23 @@ class HasSenses(models.Model):
     class Meta:
         abstract = True
 
+
+class HasPrice(models.Model):
+    """
+    The HasPrice abstract class is inherited by other models that have a price;
+    items, services, etc.
+
+    When inherited, it add the 'cost' field to the derived model
+    """
+    
+    cost = models.DecimalField(
+        null=True,  # Allow an unspecified cost.
+        default=None,
+        max_digits=10,
+        decimal_places=2,  # Only track down to 2 decimal places.
+        validators=[MinValueValidator(decimal.Decimal(0.0))],
+        help_text='Number representing the cost of the object.'
+    )
+
+    class Meta:
+        abstract = True

api_v2/models/item.py

@@ -5,7 +5,7 @@
 
 from .weapon import Weapon
 from .armor import Armor
-from .abstracts import HasName, HasDescription
+from .abstracts import HasName, HasDescription, HasPrice
 from .object import Object
 from .damagetype import DamageType
 from .document import FromDocument
@@ -24,21 +24,13 @@ class ItemCategory(HasName, FromDocument):
     """A class describing categories of items."""
 
 
-class Item(Object, HasDescription, FromDocument):
+class Item(Object, HasDescription, FromDocument, HasPrice):
     """
     This is the model for an Item, which is an object that can be used.
 
     This extends the object model, but adds cost, and is_magical.
     """
 
-    cost = models.DecimalField(
-        null=True,  # Allow an unspecified cost.
-        default=None,
-        max_digits=10,
-        decimal_places=2,  # Only track down to 2 decimal places.
-        validators=[MinValueValidator(decimal.Decimal(0.0))],
-        help_text='Number representing the cost of the object.')
-
     weapon = models.ForeignKey(
         Weapon,
         on_delete=models.CASCADE,

api_v2/models/service.py

@@ -0,0 +1,21 @@
+from django.db import models
+from .abstracts import HasName, HasDescription, HasPrice
+from .document import FromDocument
+
+
+class Service(HasName, HasDescription, FromDocument, HasPrice):
+  """
+  
+  This is the Model for a purchasable Service
+
+  This is a companion model to Item for those purchasable services that aren't
+  actually Items; life style expenses, hireling, etc.
+
+  """
+  # 'name', 'document', 'cost' fields inherited from abstract classes
+
+  detail = models.TextField(
+    null=True,
+    blank=True,
+    help_text="Additional contextual infomation about the service. ie. For 'Squalid Living' the detail would be '1 day'"
+  )

api_v2/serializers/__init__.py

@@ -50,4 +50,6 @@
 
 from .rule import RuleSerializer, RuleSetSerializer
 
-from .image import ImageSerializer
+from .image import ImageSerializer
+
+from .service import ServiceSerializer

api_v2/serializers/service.py

@@ -0,0 +1,12 @@
+from rest_framework import serializers
+from api_v2 import models
+from .abstracts import GameContentSerializer
+from .document import DocumentSummarySerializer
+
+class ServiceSerializer(GameContentSerializer):
+  key = serializers.ReadOnlyField()
+  document = DocumentSummarySerializer()
+
+  class Meta:
+    model = models.Service
+    fields = '__all__'

api_v2/urls.py

@@ -36,6 +36,7 @@
 router.register(r'rulesets', views.RuleSetViewSet)
 router.register(r'images', views.ImageViewSet)
 router.register(r'weaponproperties', views.WeaponPropertyViewSet)
+router.register(r'services', views.ServiceViewSet)
 urlpatterns = [
     path('v2/', include(router.urls)),
     path('v2/enums/', views.get_enums, name="enums")