Refactored report Header class to use TypedFields.

Bryan Worrell · Bryan Worrell · commit c3b3380ec441 · 2015-10-05T21:27:32.000-04:00
diff --git a/stix/report/header.py b/stix/report/header.py
@@ -1,10 +1,12 @@
 # Copyright (c) 2015, The MITRE Corporation. All rights reserved.
 # See LICENSE.txt for complete terms.
 
+from mixbox import fields
+
 import stix
 import stix.bindings.report as report_binding
-from stix.common import InformationSource, StructuredTextList, VocabString
-from stix.common.vocabs import ReportIntent
+from stix.common import InformationSource, StructuredTextList
+from stix.common.vocabs import VocabField, ReportIntent
 from stix.data_marking import Marking
 
 
@@ -28,11 +30,21 @@ class Header(stix.Entity):
 
     """
     _binding = report_binding
+    _binding_class = _binding.HeaderType
     _namespace = 'http://stix.mitre.org/Report-1'
 
+    title = fields.TypedField("Title")
+    descriptions = fields.TypedField("Description", type_=StructuredTextList)
+    short_descriptions = fields.TypedField("Short_Description", type_=StructuredTextList)
+    intents = VocabField("Intent", ReportIntent, multiple=True, key_name="intents")
+    handling = fields.TypedField("Handling", Marking)
+    information_source = fields.TypedField("Information_Source", InformationSource)
+
     def __init__(self, title=None, description=None, short_description=None,
                  handling=None, intents=None, information_source=None):
 
+        super(Header, self).__init__()
+
         self.intents = intents
         self.title = title
         self.description = description
@@ -61,36 +73,6 @@ def description(self):
     def description(self, value):
         self.descriptions = value
 
-    @property
-    def descriptions(self):
-        """A :class:`.StructuredTextList` object, containing descriptions about
-        the purpose or intent of this object.
-
-        This is typically used for the purpose of providing multiple
-        descriptions with different classificaton markings.
-
-        Iterating over this object will yield its contents sorted by their
-        ``ordinality`` value.
-
-        Default Value: Empty :class:`.StructuredTextList` object.
-
-        Note:
-            IF this is set to a value that is not an instance of
-            :class:`.StructuredText`, an effort will ne made to convert it.
-            If this is set to an iterable, any values contained that are not
-            an instance of :class:`.StructuredText` will be be converted.
-
-        Returns:
-            An instance of
-            :class:`.StructuredTextList`
-
-        """
-        return self._description
-
-    @descriptions.setter
-    def descriptions(self, value):
-        self._description = StructuredTextList(value)
-
     def add_description(self, description):
         """Adds a description to the ``descriptions`` collection.
 
@@ -120,35 +102,6 @@ def short_description(self):
     def short_description(self, value):
         self.short_descriptions = value
 
-    @property
-    def short_descriptions(self):
-        """A :class:`.StructuredTextList` object, containing short descriptions
-        about the purpose or intent of this object.
-
-        This is typically used for the purpose of providing multiple
-        short descriptions with different classificaton markings.
-
-        Iterating over this object will yield its contents sorted by their
-        ``ordinality`` value.
-
-        Default Value: Empty :class:`.StructuredTextList` object.
-
-        Note:
-            IF this is set to a value that is not an instance of
-            :class:`.StructuredText`, an effort will ne made to convert it.
-            If this is set to an iterable, any values contained that are not
-            an instance of :class:`.StructuredText` will be be converted.
-
-        Returns:
-            An instance of :class:`.StructuredTextList`
-
-        """
-        return self._short_description
-
-    @short_descriptions.setter
-    def short_descriptions(self, value):
-        self._short_description = StructuredTextList(value)
-
     def add_short_description(self, description):
         """Adds a description to the ``short_descriptions`` collection.
 
@@ -157,30 +110,6 @@ def add_short_description(self, description):
         """
         self.short_descriptions.add(description)
 
-    @property
-    def handling(self):
-        """The :class:`.Marking` section of this Header. This section contains
-        data marking information.
-
-        """
-        return self._handling
-
-    @handling.setter
-    def handling(self, value):
-        self._set_var(Marking, try_cast=False, handling=value)
-
-    @property
-    def intents(self):
-        """A collection of :class:`.VocabString` controlled vocabulary
-        objects.
-
-        """
-        return self._intents
-
-    @intents.setter
-    def intents(self, value):
-        self._intents = _ReportIntents(value)
-
     def add_intent(self, intent):
         """Adds :class:`.VocabString` object to the :attr:`intents`
         collection.
@@ -190,82 +119,3 @@ def add_intent(self, intent):
 
         """
         self.intents.append(intent)
-
-    @property
-    def information_source(self):
-        """The :class:`.InformationSource` section of the Header.
-
-        """
-        return self._information_source
-
-    @information_source.setter
-    def information_source(self, value):
-        self._set_var(InformationSource, try_cast=False, information_source=value)
-
-    @classmethod
-    def from_obj(cls, obj, return_obj=None):
-        if not obj:
-            return None
-
-        if not return_obj:
-            return_obj = cls()
-
-        return_obj.title = obj.Title
-        return_obj.descriptions = StructuredTextList.from_obj(obj.Description)
-        return_obj.short_descriptions = StructuredTextList.from_obj(obj.Short_Description)
-        return_obj.handling = Marking.from_obj(obj.Handling)
-        return_obj.information_source = InformationSource.from_obj(obj.Information_Source)
-        return_obj.intents = _ReportIntents.from_obj(obj.Intent)
-
-        return return_obj
-
-    def to_obj(self, return_obj=None, ns_info=None):
-        super(Header, self).to_obj(return_obj=return_obj, ns_info=ns_info)
-
-        if not return_obj:
-            return_obj = self._binding.HeaderType()
-
-        if self.title:
-            return_obj.Title = self.title
-        if self.intents:
-            return_obj.Intent = self.intents.to_obj(ns_info=ns_info)
-        if self.descriptions:
-            return_obj.Description = self.descriptions.to_obj(ns_info=ns_info)
-        if self.short_descriptions:
-            return_obj.Short_Description = self.short_descriptions.to_obj(ns_info=ns_info)
-        if self.handling:
-            return_obj.Handling = self.handling.to_obj(ns_info=ns_info)
-        if self.information_source:
-            return_obj.Information_Source = self.information_source.to_obj(ns_info=ns_info)
-
-        return return_obj
-
-    @classmethod
-    def from_dict(cls, dict_repr, return_obj=None):
-        if not dict_repr:
-            return None
-
-        if not return_obj:
-            return_obj = cls()
-
-        get = dict_repr.get
-
-        return_obj.title = get('title')
-        return_obj.intents = _ReportIntents.from_list(get('intents'))
-        return_obj.descriptions = StructuredTextList.from_dict(get('description'))
-        return_obj.short_descriptions = StructuredTextList.from_dict(get('short_description'))
-        return_obj.handling = Marking.from_dict(get('handling'))
-        return_obj.information_source = InformationSource.from_dict(get('information_source'))
-
-        return return_obj
-
-    def to_dict(self):
-        return super(Header, self).to_dict()
-
-
-# NOT AN ACTUAL STIX TYPE!
-class _ReportIntents(stix.TypedList):
-    _contained_type = VocabString
-
-    def _fix_value(self, value):
-        return ReportIntent(value)
diff --git a/stix/test/report_test.py b/stix/test/report_test.py
@@ -18,6 +18,7 @@ class HeaderTests(EntityTestCase, unittest.TestCase):
         'short_description': 'A really, really short description',
         'handling': data_marking_test.MarkingTests._full_dict,
         'information_source': information_source_test.InformationSourceTests._full_dict,
+        'intents': ["foo", "bar"]
     }
 
     def test_duplicate_package_intent(self):

Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ class HeaderTests(EntityTestCase, unittest.TestCase):`
`18`	`18`	`'short_description': 'A really, really short description',`
`19`	`19`	`'handling': data_marking_test.MarkingTests._full_dict,`
`20`	`20`	`'information_source': information_source_test.InformationSourceTests._full_dict,`
	`21`	`+ 'intents': ["foo", "bar"]`
`21`	`22`	`}`
`22`	`23`
`23`	`24`	`def test_duplicate_package_intent(self):`