Add Batch Django models

Author: Mikhail Pyrev

capitalist/capitalist.py

@@ -87,3 +87,11 @@ def get_document_fee(
         if wiretag:
             data['wiretag'] = wiretag
         return self.secure_request('get_document_fee', data)
+
+    def get_batch_info(self, batch_id, page_size=1, start_offset=0):
+        data = {
+            'batch_id': batch_id,
+            'page_size': page_size,
+            'start_offset': start_offset,
+        }
+        return self.secure_request('get_batch_info', data)

capitalist/contrib/django/django_capitalist/migrations/0002_auto_20190328_1508.py

@@ -0,0 +1,53 @@
+# Generated by Django 2.1.7 on 2019-03-28 15:08
+
+from django.db import migrations, models
+import django.db.models.deletion
+import django.utils.timezone
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('django_capitalist', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Batch',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('batch_id', models.CharField(max_length=50, unique=True, verbose_name='batch ID')),
+                ('created_at', models.DateTimeField(default=django.utils.timezone.now, verbose_name='created at')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='updated at')),
+                ('object_id', models.PositiveIntegerField(blank=True, null=True)),
+                ('content_type', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType')),
+            ],
+            options={
+                'verbose_name': 'batch',
+                'verbose_name_plural': 'batches',
+            },
+        ),
+        migrations.CreateModel(
+            name='BatchRecord',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('state', models.CharField(choices=[('NEW', 'New'), ('READY', 'Ready'), ('INPROCESS', 'In process'), ('DECLINED', 'Declined'), ('PROCESSED', 'Processed')], default='NEW', max_length=20, verbose_name='status')),
+                ('data', models.TextField(verbose_name='record data (CSV)')),
+                ('internal_id', models.CharField(max_length=255, verbose_name='internal ID')),
+                ('created_at', models.DateTimeField(default=django.utils.timezone.now, verbose_name='created at')),
+                ('updated_at', models.DateTimeField(auto_now=True, verbose_name='updated at')),
+                ('object_id', models.PositiveIntegerField(blank=True, null=True)),
+                ('batch', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='django_capitalist.Batch', verbose_name='batch')),
+                ('content_type', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType')),
+            ],
+            options={
+                'verbose_name': 'batch record',
+                'verbose_name_plural': 'batch records',
+            },
+        ),
+        migrations.AlterUniqueTogether(
+            name='batchrecord',
+            unique_together={('batch', 'internal_id')},
+        ),
+    ]

capitalist/contrib/django/django_capitalist/models.py

@@ -1,4 +1,7 @@
+from django.contrib.contenttypes.fields import GenericForeignKey
+from django.contrib.contenttypes.models import ContentType
 from django.db import models
+from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 
 
@@ -32,3 +35,56 @@ class Meta:
 
     def __str__(self):
         return '{} ({})'.format(self.name, self.number)
+
+
+class Batch(models.Model):
+    batch_id = models.CharField(_('batch ID'), max_length=50, unique=True)
+    created_at = models.DateTimeField(_('created at'), default=timezone.now)
+    updated_at = models.DateTimeField(_('updated at'), auto_now=True)
+
+    # Not required. Just for your convenience.
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE, blank=True, null=True)
+    object_id = models.PositiveIntegerField(blank=True, null=True)
+    related_object = GenericForeignKey('content_type', 'object_id')
+
+    class Meta:
+        verbose_name = _('batch')
+        verbose_name_plural = _('batches')
+
+    def __str__(self):
+        return 'Batch {}'.format(self.batch_id)
+
+
+class BatchRecord(models.Model):
+    NEW = 'NEW'
+    READY = 'READY'
+    INPROCESS = 'INPROCESS'
+    DECLINED = 'DECLINED'
+    PROCESSED = 'PROCESSED'
+
+    STATE_CHOICES = (
+        (NEW, _('New')),
+        (READY, _('Ready')),
+        (INPROCESS, _('In process')),
+        (DECLINED, _('Declined')),
+        (PROCESSED, _('Processed')),
+    )
+
+    batch = models.ForeignKey(Batch, models.CASCADE, verbose_name=_('batch'))
+    state = models.CharField(_('status'), max_length=20, choices=STATE_CHOICES, default=NEW)
+    data = models.TextField(_('record data (CSV)'))
+    internal_id = models.CharField(_('internal ID'), max_length=255)
+    created_at = models.DateTimeField(_('created at'), default=timezone.now)
+    updated_at = models.DateTimeField(_('updated at'), auto_now=True)
+
+    # Not required. Just for your convenience.
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE, blank=True, null=True)
+    object_id = models.PositiveIntegerField(blank=True, null=True)
+    related_object = GenericForeignKey('content_type', 'object_id')
+
+    class Meta:
+        verbose_name = _('batch record')
+        verbose_name_plural = _('batch records')
+        unique_together = [
+            ['batch', 'internal_id'],
+        ]

setup.py

@@ -43,7 +43,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='1.0.0',  # Required
+    version='1.1.0',  # Required
 
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field: