LEXIO-37872: get_dataset_version (#5)

Author: ns-shudson

crma_api_client/__init__.py

@@ -2,4 +2,4 @@
 
 from .client import CRMAAPIClient
 
-__version__ = "0.5.0"
+__version__ = "0.6.0"

crma_api_client/client.py

@@ -8,7 +8,10 @@
 import httpx
 from pydantic import BaseModel
 
-from crma_api_client.resources.dataset import DatasetVersionsResponse
+from crma_api_client.resources.dataset import (
+    DatasetVersionResponse,
+    DatasetVersionsResponse,
+)
 from crma_api_client.resources.query import QueryLanguage, QueryResponse
 from .encoder import json_dumps_common
 
@@ -169,6 +172,24 @@ async def list_dataset_versions(self, identifier: str) -> DatasetVersionsRespons
         response = await self.request(f"/wave/datasets/{identifier}/versions", "GET")
         return DatasetVersionsResponse.parse_obj(response.json())
 
+    async def get_dataset_version(
+        self, dataset_id: str, version_id: str
+    ) -> DatasetVersionResponse:
+        """Get a single version for a dataset
+
+        Args:
+            dataset_id: Dataset name or ID
+            version_id: Version ID
+
+        Returns:
+            the version of the dataset
+
+        """
+        response = await self.request(
+            f"/wave/datasets/{dataset_id}/versions/{version_id}", "GET"
+        )
+        return DatasetVersionResponse.parse_obj(response.json())
+
     async def query(
         self,
         query: str,

crma_api_client/resources/dataset.py

@@ -1,22 +1,144 @@
 """Contains definitions for the dataset resource"""
 
 from datetime import datetime
-from typing import List
+from enum import Enum
+from typing import List, Optional, TypeVar
 
-from pydantic import BaseModel
+from pydantic import BaseModel, validator
 
 from .user import User
 from .util import to_camel
 
+T = TypeVar("T")
 
-class Dataset(BaseModel):
+
+class CRMAModel(BaseModel):
+    """Base class for all models from the CRMA API
+
+    Has logic for converting camel case to snake case
+    """
+
+    class Config:
+        """Model configuration"""
+
+        alias_generator = to_camel
+
+
+class Dataset(CRMAModel):
     """Dataset model"""
 
     id: str
     url: str
 
 
-class DatasetVersion(BaseModel):
+class DateType(Enum):
+    """The type of date field"""
+
+    date = "Date"
+    date_only = "DateOnly"
+    date_time = "DateTime"
+
+
+class XmdDateFields(CRMAModel):
+    """Date fields in the extended metadata format
+
+    See https://developer.salesforce.com/docs/atlas.en-us.230.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm#XmdDateFieldRepresentation
+    """
+
+    day: str
+    epoch_day: str
+    epoch_second: str
+    fiscal_month: Optional[str]
+    fiscal_quarter: Optional[str]
+    fiscal_week: Optional[str]
+    fiscal_year: Optional[str]
+    full_field: str
+    hour: str
+    minute: str
+    month: str
+    quarter: str
+    second: str
+    week: str
+    year: str
+
+    @validator("fiscal_month", "fiscal_quarter", "fiscal_week", "fiscal_year")
+    def not_none(cls, v: T) -> T:
+        """Validates that the given value is not None
+
+        This is needed since the Optional type doesn't distinguish between a field
+        being None and being missing.
+
+        Args:
+            v: the value to check
+
+        Raises:
+            ValueError: if the value is None
+
+        Returns:
+            the value if it's not None
+
+        """
+        if v is None:
+            raise ValueError("Fiscal fields may not be None")
+        return v
+
+
+class XmdDate(CRMAModel):
+    """Date in the extended metadata format
+
+    See https://developer.salesforce.com/docs/atlas.en-us.230.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm#XmdDateRepresentation
+    """
+
+    alias: str
+    fields: XmdDateFields
+    first_day_of_week: int
+    fiscal_month_offset: int
+    fully_qualified_name: str
+    is_year_end_fiscal_year: bool
+    label: str
+    type: DateType
+
+
+class XmdDimension(CRMAModel):
+    """Dimension in the Xmd format
+
+    See https://developer.salesforce.com/docs/atlas.en-us.230.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm#XmdDimensionRepresentation
+    """
+
+    field: str
+    label: str
+
+
+class XmdMeasure(CRMAModel):
+    """Measure in the Xmd format
+
+    See https://developer.salesforce.com/docs/atlas.en-us.230.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm#XmdMeasureRepresentation
+    """
+
+    field: str
+    label: str
+
+
+class DatasetXmd(CRMAModel):
+    """Extended metadata for a dataset
+
+    See https://developer.salesforce.com/docs/atlas.en-us.230.0.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_resources_xmd_main.htm
+    """
+
+    created_by: User
+    created_date: datetime
+    dates: List[XmdDate]
+    derived_dimensions: List[XmdDimension]
+    derived_measures: List[XmdMeasure]
+    dimensions: List[XmdDimension]
+    last_modified_by: User
+    last_modified_date: datetime
+    measures: List[XmdMeasure]
+    type: str
+    url: str
+
+
+class DatasetVersion(CRMAModel):
     """Dataset version model
 
     See https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version.htm
@@ -32,13 +154,17 @@ class DatasetVersion(BaseModel):
     type: str
     url: str
 
-    class Config:
-        """Model configuration"""
 
-        alias_generator = to_camel
+class DatasetVersionResponse(DatasetVersion):
+    """Dataset version model
+
+    See https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version.htm
+    """
+
+    xmd_main: DatasetXmd
 
 
-class DatasetVersionsResponse(BaseModel):
+class DatasetVersionsResponse(CRMAModel):
     """Response model for a list of dataset versions
 
     See https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_version_collection.htm

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "crma-api-client"
-version = "0.5.0"
+version = "0.6.0"
 description = "CRM Analytics REST API Client"
 authors = ["Jonathan Drake <[email protected]>"]
 license = "BSD-3-Clause"

tests/functional/test_dataset.py

@@ -0,0 +1,14 @@
+"""Contains functional tests for the dataset resource"""
+
+import pytest
+
+from crma_api_client.client import CRMAAPIClient
+
+
+@pytest.mark.asyncio
+async def test_get_dataset_version(client: CRMAAPIClient):
+    """Should get the metadata for a particular dataset"""
+    dataset_id = "Sample_Superstore_xls_Orders"
+    versions_response = await client.list_dataset_versions(dataset_id)
+    version = versions_response.versions[0]
+    await client.get_dataset_version(dataset_id, version.id)