Repository: datosgobar/pydatajson

Issue:
Push organization to ckan
El objetivo es implementar un método que tome la data de una organización y cree via API la organización en un andino pasado por parámetro

Discussion:

Patch:
diff --git a/docs/MANUAL.md b/docs/MANUAL.md
index a84878b..9c97bb2 100644
--- a/docs/MANUAL.md
+++ b/docs/MANUAL.md
@@ -461,6 +461,20 @@ parámetros:
   Retorna el árbol de organizaciones creadas. Cada nodo tiene un campo `success` que indica si fue creado exitosamente o
   no. En caso de que `success` sea False, los hijos de esa organización no son creados.
 
+- **pydatajson.federation.push_organization_to_ckan()**: Tomando en un diccionario la data de una organización; la crea
+en el portal de destino. Toma los siguientes parámetros:
+  - **portal_url**: La URL del portal CKAN de destino.
+  - **apikey**: La apikey de un usuario con los permisos que le permitan crear las organizaciones.
+  - **organization**: Diccionario con la información a crear, el único campo obligatorio es `name`. Para más
+  información sobre los campos posibles, ver la [documentación de CKAN](https://docs.ckan.org/en/latest/api/#ckan.logic.action.create.organization_create)
+  - **parent** (opcional, default: None): Si se define, la organización pasada en `organization` se crea bajo la
+  organización con `name` pasado en `parent`. Si no se pasa un parámetro, las organizaciones son creadas como primer
+  nivel.
+  
+  Retorna el diccionario de la organización creada. El resultado tiene un campo `success` que indica si fue creado
+  exitosamente o no.
+
+
 ## Anexo I: Estructura de respuestas
 
 ### validate_catalog()
diff --git a/pydatajson/backup.py b/pydatajson/backup.py
index e0faf7d..2ee5544 100644
--- a/pydatajson/backup.py
+++ b/pydatajson/backup.py
@@ -79,7 +79,7 @@ def make_catalogs_backup(catalogs, local_catalogs_dir="",
 
 def make_catalog_backup(catalog, catalog_id=None, local_catalogs_dir="",
                         include_metadata=True, include_data=True,
-                        include_datasets=None,
+                        include_datasets=[],
                         include_distribution_formats=['CSV', 'XLS'],
                         include_metadata_xlsx=True, use_short_path=False):
     """Realiza una copia local de los datos y metadatos de un catálogo.
diff --git a/pydatajson/federation.py b/pydatajson/federation.py
index eb5564b..6ba9a28 100644
--- a/pydatajson/federation.py
+++ b/pydatajson/federation.py
@@ -347,23 +347,44 @@ def push_organization_tree_to_ckan(portal_url, apikey, org_tree, parent=None):
                     exitosa o no.
 
     """
-    portal = RemoteCKAN(portal_url, apikey=apikey)
     created = []
     for node in org_tree:
-        if parent:
-            node['groups'] = [{'name': parent}]
-        try:
-            pushed_org = portal.call_action('organization_create',
-                                            data_dict=node)
-            pushed_org['success'] = True
-        except Exception as e:
-            logger.exception('Ocurrió un error creando la organización {}: {}'
-                             .format(node['title'], str(e)))
-            pushed_org = {'name': node, 'success': False}
-
+        pushed_org = push_organization_to_ckan(portal_url,
+                                               apikey,
+                                               node,
+                                               parent=parent)
         if pushed_org['success']:
             pushed_org['children'] = push_organization_tree_to_ckan(
                 portal_url, apikey, node['children'], parent=node['name'])
 
         created.append(pushed_org)
     return created
+
+
+def push_organization_to_ckan(portal_url, apikey, organization, parent=None):
+    """Toma una organización y la crea en el portal de destino.
+        Args:
+            portal_url (str): La URL del portal CKAN de destino.
+            apikey (str): La apikey de un usuario con los permisos que le
+                permitan crear la organización.
+            organization(dict): Datos de la organización a crear.
+            parent(str): Campo name de la organización padre.
+        Returns:
+            (dict): Devuelve el diccionario de la organizacion enviada,
+                junto con el status detallando si la creación fue
+                exitosa o no.
+
+    """
+    portal = RemoteCKAN(portal_url, apikey=apikey)
+    if parent:
+        organization['groups'] = [{'name': parent}]
+    try:
+        pushed_org = portal.call_action('organization_create',
+                                        data_dict=organization)
+        pushed_org['success'] = True
+    except Exception as e:
+        logger.exception('Ocurrió un error creando la organización {}: {}'
+                         .format(organization['title'], str(e)))
+        pushed_org = {'name': organization, 'success': False}
+
+    return pushed_org


Test patch:
diff --git a/tests/test_federation.py b/tests/test_federation.py
index daf9df4..375dee3 100644
--- a/tests/test_federation.py
+++ b/tests/test_federation.py
@@ -495,6 +495,7 @@ class OrganizationsTestCase(FederationSuite):
         if parent is None:
             self.assertTrue('groups' not in node)
         else:
+            self.assertEqual(1, len(node['groups']))
             self.assertDictEqual(node['groups'][0],
                                  {'name': parent})
 
@@ -511,6 +512,33 @@ class OrganizationsTestCase(FederationSuite):
         mock_portal.return_value.call_action.assert_called_with(
             'organization_show', data_dict={'id': 'test_id'})
 
+    def test_push_organization_sets_correct_attributes_on_success(
+            self, mock_portal):
+        mock_portal.return_value.call_action = (lambda _, data_dict: data_dict)
+        pushed_org = push_organization_to_ckan(self.portal_url,
+                                               self.apikey,
+                                               self.org_tree[0])
+        self.assertTrue(pushed_org['success'])
+
+    def test_push_organization_assigns_parent_correctly(self, mock_portal):
+        mock_portal.return_value.call_action = (lambda _, data_dict: data_dict)
+        pushed_org = push_organization_to_ckan(self.portal_url,
+                                               self.apikey,
+                                               self.org_tree[0],
+                                               parent='parent')
+        self.assertEqual(1, len(pushed_org['groups']))
+        self.assertDictEqual(pushed_org['groups'][0], {'name': 'parent'})
+
+    def test_push_organization_sets_correct_attributes_on_failures(
+            self, mock_portal):
+        def broken_call(_, __):
+            raise Exception('broken api call')
+        mock_portal.return_value.call_action = broken_call
+        pushed_org = push_organization_to_ckan(self.portal_url,
+                                               self.apikey,
+                                               self.org_tree[0])
+        self.assertFalse(pushed_org['success'])
+
     def test_push_organizations_sends_correct_hierarchy(self, mock_portal):
         mock_portal.return_value.call_action = (lambda _, data_dict: data_dict)
         pushed_tree = push_organization_tree_to_ckan(self.portal_url,