wipo-gbd-transformation 1.1.36__py3-none-any.whl → 1.1.37__py3-none-any.whl

gbdtransformation/brands/rutm/filters.py

@@ -1,5 +1,9 @@
 # namespaces defined in XML and to be ignored in procecssing
-ignore_namespace = []
+ignore_namespace = [
+    'http://www.wipo.int/standards/XMLSchema/ST96/Common',
+    'http://www.wipo.int/standards/XMLSchema/ST96/Trademark',
+    'urn:ru:rupto:trademark'
+]
 
 
 # -------------------------------------------------------------
@@ -7,11 +11,10 @@ ignore_namespace = []
 # translate values from office interpretation to gbd equivalent
 # -------------------------------------------------------------
 def translate_kind(kind):
-    if not kind: return ['Individual']
 
-    if kind == 'Individual': return ['Individual']
-    if kind == 'Collective': return ['Collective']
-    if kind == 'Certificate': return ['Certificate']
+    if kind == 'Trademark': return ['Individual']
+    if kind == 'Collective trademark ': return ['Collective']
+    if kind == 'Certification mark ': return ['Certificate']
 
     raise Exception('kind "%s" is not mapped.' % kind)
 
@@ -31,15 +34,12 @@ def get_path(path, data):
 
 
 def get_trademark(data):
-    if data.TradeMarkDetails:
-        if isinstance(data.TradeMarkDetails.TradeMark, list):
-            trademark = data.TradeMarkDetails.TradeMark[0]
-            for transaction in data.TradeMarkDetails.TradeMark[1:]:
-                trademark.update(transaction)
-        else:
-            trademark = data.TradeMarkDetails.TradeMark
+    if data.TrademarkBag:
+        trademark = data.TrademarkBag.Trademark
         status = 'Registered'
-        if get_path('MarkRecordDetails.MarkRecord[-1].BasicRecord.BasicRecordKind', trademark) == 'Non Renewal':
+        if get_path('MarkRecordBag.MarkRecord[-1].BasicRecord.BasicRecordKind', trademark) == 'Non Renewal':
+            et_path('MarkRepresentation.MarkReproduction.MarkImageBag.MarkImage.ImageFileName', trademark)
+            print("expired for %s" % trademark.ApplicationNumber.ApplicationNumberText)
             status = 'Expired'
         return trademark, status
     if data.TradeMarkApplication:
@@ -51,10 +51,10 @@ def get_termination(value, gbd_status):
         return value
     return None
 
-def translate_feature(feature):
-    if not feature: return 'Undefined'
-
-    if feature == '3-D': return 'Three dimensional'
+def translate_feature(trademark):
+    feature = get_path('MarkRepresentation.MarkFeatureCategory',
+                        trademark)
+    if feature == 'Three dimensional': return 'Three dimensional'
     if feature == 'Hologram': return 'Hologram'
     if feature == 'Colour': return 'Colour'
     if feature == 'Sound': return 'Sound'
@@ -64,11 +64,14 @@ def translate_feature(feature):
     # the office wild card. bof
     if feature == 'Other': return 'Other'
 
-    # has_word = get_path('WordMarkSpecification.MarkSignificantVerbalElement', trademark)
-    # has_figure = get_path('MarkImageDetails.MarkImage.MarkImageFilename', trademark)
-
-    # if has_word and has_figure: return 'Combined'
-    # elif has_word: return 'Word'
-    # elif has_figure: return 'Figurative'
+    has_word = get_path('MarkRepresentation.MarkReproduction.WordMarkSpecification.MarkSignificantVerbalElementText',
+                        trademark)
+    has_figure = get_path('MarkRepresentation.MarkReproduction.MarkImageBag.MarkImage.ImageFileName', trademark)
+    if has_word and has_figure:
+        return 'Combined'
+    elif has_word:
+        return 'Word'
+    elif has_figure:
+        return 'Figurative'
 
     raise Exception('Feature "%s" unmapped' % feature)

gbdtransformation/brands/rutm/template.yml

@@ -1,39 +1,41 @@
 {% from 'navigation.tmpl' import match %}
-{% set TradeMark, status = Transaction.TradeMarkTransactionBody.TransactionContentDetails.TransactionData | get_trademark %}
+{% set TradeMark, status = TrademarkTransaction.TrademarkTransactionBody.TransactionContentBag.TransactionData | get_trademark %}
 
 type: TRADEMARK
-kind: {{ TradeMark.KindMark | translate_kind }}
-st13: {{ TradeMark.ApplicationNumber | st13('RU', appdate=TradeMark.ApplicationDate) }}
+kind: {{ TradeMark.MarkCategory  | translate_kind }}
+st13: {{ TradeMark.ApplicationNumber.ApplicationNumberText | st13('RU', appdate=TradeMark.ApplicationDate) }}
 gbdStatus: {{ status }}
 officeStatus: {{ status }}
-markFeature: {{ TradeMark.MarkFeature | translate_feature }}
+markFeature: {{ TradeMark | translate_feature }}
 registrationOfficeCode: {{ TradeMark.RegistrationOfficeCode }}
 designatedCountries:
   - {{ TradeMark.RegistrationOfficeCode }}
 applicationLanguageCode: 'ru'
-applicationNumber: {{ TradeMark.ApplicationNumber }}
+applicationNumber: {{ TradeMark.ApplicationNumber.ApplicationNumberText }}
 applicationDate: {{ TradeMark.ApplicationDate | convertdate('%Y-%m-%d') }}
 registrationNumber: {{ TradeMark.RegistrationNumber }}
 registrationDate: {{ TradeMark.RegistrationDate }}
+expiryDate: {{ TradeMark.ExpiryDate | convertdate('%Y-%m-%d')  }}
+
 markDisclaimerDetails:
-  {% call(desc) match('MarkDisclaimerDetails.MarkDisclaimer', TradeMark) %}
+  {% call(desc) match('MarkDisclaimerBag.MarkDisclaimerText', TradeMark) %}
   - text: {{ desc }}
     languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode, 'ru') }}
   {% endcall %}
 markDescriptionDetails:
-  {% call(desc) match('MarkDescriptionDetails.MarkDescription', TradeMark) %}
+  {% call(desc) match('MarkDescriptionBag.MarkDescriptionText', TradeMark) %}
   - text: {{ desc }}
     languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode, 'ru') }}
   {% endcall %}
 wordMarkSpecification:
   markVerbalElement:
-    {% call(desc) match('WordMarkSpecification.MarkSignificantVerbalElement', TradeMark) %}
+    {% call(desc) match('MarkRepresentation.MarkReproduction.WordMarkSpecification.MarkSignificantVerbalElementText', TradeMark) %}
     - text: {{ desc }}
-      languageCode: {{ desc | guess_language('ru') }}
+      languageCode: {{ desc | guess_language(TradeMark.ApplicationLanguageCode, 'ru') }}
     {% endcall %}
 markImageDetails:
-  {% call(img) match('MarkImageDetails.MarkImage', TradeMark) %}
-  - name: {{ img.MarkImageFilename }}
+  {% call(img) match('MarkRepresentation.MarkReproduction.MarkImageBag.MarkImage', TradeMark) %}
+  - name: {{ img.ImageFileName }}
     colourIndicator: {{ img.MarkImageColourClaimedText | get_true_or_false }}
     colourClaimed:
       {% call(desc) match('MarkImageColourClaimedText', img) %}
@@ -42,16 +44,15 @@ markImageDetails:
       {% endcall %}
   {% endcall %}
 
-{% call(nc_gs) match('GoodsServicesDetails.GoodsServices', TradeMark) %}
+{% call(nc_gs) match('GoodsServicesBag.GoodsServices.ClassDescriptionBag', TradeMark) %}
 goodsServicesClassification:
   kind: Nice
-  version: {{ ASK_THE_OFFICE }}
   class:
-    {% call(nice) match('ClassDescriptionDetails.ClassDescription', nc_gs) %}
+    {% call(nice) match('ClassDescription', nc_gs) %}
     - code: {{ nice.ClassNumber | int }}
       terms:
-      {% if nice.GoodsServicesDescription | has_value %}
-      {% call(desc) match('GoodsServicesDescription', nice) %}
+      {% if nice.GoodsServicesDescriptionText | has_value %}
+      {% call(desc) match('GoodsServicesDescriptionText', nice) %}
         ru:
         {% for gsline in desc | remove_trailing('.') | split_terms %}
           - {{ gsline | lower }}
@@ -61,39 +62,43 @@ goodsServicesClassification:
     {% endcall %}
 {% endcall %}
 
-{% call(unclassified) match('GoodsServicesDetails.GoodsServices.Comment', TradeMark) %}
-goodsServicesUnclassified:
-  ru:
-    - {{ unclassified }} #TODO sanitize
-{% endcall %}
-
 priorities:
-  {% call(priority) match('PriorityDetails.Priority', TradeMark) %}
+  {% call(priority) match('PriorityBag.Priority', TradeMark) %}
   - countryCode: {{ priority.PriorityCountryCode }}
-    number: {{ priority.PriorityNumber }}
-    date: {{ priority.PriorityDate }}
+    number: {{ priority.ApplicationNumberText }}
+    date: {{ priority.PriorityRegistrationDate }}
   {% endcall %}
+
 publications:
-  {% call(publication) match('PublicationDetails.Publication', TradeMark) %}
+  {% call(publication) match('RecordPublicationBag.RecordPublication', TradeMark) %}
   - identifier: {{ publication.PublicationIdentifier }}
     date: {{ publication.PublicationDate }}
-    section: {{ publication.PublicationSection }}
   {% endcall %}
 
 applicants:
-  {% call(Applicant) match('ApplicantDetails.Applicant', TradeMark) %}
-  - identifier: {{ Applicant.ApplicationNumber }}
+  {% call(Applicant) match('ApplicantBag.Applicant', TradeMark) %}
+  - identifier: {{ Applicant.AssignmentIdentifier }}
+    fullName:
+      - text: {{ Applicant.LegalEntityName  }}
+        languageCode: {{ Applicant.LegalEntityName | guess_language('ru') }}
     fullAddress:
-      {% call(adrline) match('FreeFormatAddressDetails.FreeFormatNameAddressLine', Applicant.ApplicantAddressBook) %}
-      - text: {{ adrline}}
+      {% call(adrline) match('Contact.PostalAddressBag.PostalAddress.PostalAddressText', Applicant) %}
+      - text: {{ adrline }}
         languageCode: {{ adrline | guess_language('ru') }}
+    countryCode: {{ Applicant.NationalityCode }}
+
       {% endcall %}
   {% endcall %}
 
 correspondence:
-  {% call(corespondance) match('CorrespondenceAddress.CorrespondenceAddressBook', TradeMark) %}
+  {% call(corespondance) match('CorrespondenceAddress.Contact', TradeMark) %}
+  fullName:
+    {% call(adrline) match('Name.EntityName', corespondance) %}
+    - text: {{ adrline }}
+      languageCode: {{ adrline | guess_language('ru') }}
+  {% endcall %}
   fullAddress:
-    {% call(adrline) match('FreeFormatAddressDetails.FreeFormatNameAddressLine', corespondance) %}
+    {% call(adrline) match('PostalAddressBag.PostalAddress.PostalAddressText', corespondance) %}
     - text: {{ adrline}}
       languageCode: {{ adrline | guess_language('ru') }}
     {% endcall %}

gbdtransformation/brands/sgtm/filters.py

@@ -51,7 +51,7 @@ def translate_status(status, prev_status=''):
     if status == 'Expunged': return 'Expired'
     if status == 'Removed': return 'Expired'
     if status == 'Removed (Restoration Possible)': return 'Expired'
-
+    if status == 'Expired (Renewal Possible)': return 'Expired'
     raise Exception('status/prev_status "%s/%s" is not mapped.' % (status, prev_status))
 
 def translate_feature(trademark):

gbdtransformation/brands/sttm/__init__.py

@@ -0,0 +1,16 @@
+render = 'JSON'
+source = 'national'
+
+# TN/M/100/901864 # madrid
+# TN/E/2002/001864 # etrangere
+# TN/T/2019/001877 # local
+# TN/S/2005/001886
+appnum_mask = [ 'TN/(T|E|S|M)/\\d{4}/(\\d*)',
+                'TN/(M)/100/(\\d*)',
+                '([A-D])/(M)/100/(\\d*)' ]
+
+# 100/901864
+# 2009/002484
+# 001818
+regnum_mask = [ '\\d*/(\\d*)',
+                '(\\d*)' ]

gbdtransformation/brands/sttm/filters.py

@@ -0,0 +1,70 @@
+import gbdtransformation.brands.ipas.filters as ipas
+import gbdtransformation.common.filters as commons
+
+ignore_namespace = [
+   'http://www.wipo.int/standards/XMLSchema/trademarks',
+   'http://www.wipo.int/standards/XMLSchema/wo-trademarks']
+
+def get_appdate(appdate, appnum):
+    return appnum.split('/')[-2].zfill(4)
+
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'Madrid Trademark': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+    if subcode == 'Madrid Protocol': return ['Individual']
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+def verbal_lang_map(markVerbalElements, applang=None):
+    # print( ipas.verbal_lang_map(markVerbalElements, applang=applang))
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    if not tmstatus in ['Expired', 'Registered']:
+        return None
+
+    # a way to deduce the registration number
+    appnum_parts = trademark.ApplicationNumber.split('/')
+    regnum = '%s/%s' % (appnum_parts[-2], appnum_parts[-1])
+    return regnum
+
+def get_expiry_date(trademark, tmstatus):
+    return ipas.get_expiry_date(trademark, tmstatus)
+
+def get_registration_date(trademark, tmstatus):
+    return ipas.get_registration_date(trademark, tmstatus)
+
+def is_international(header):
+    code = header.TransactionCode
+    return code == 'Marque Madrid'
+
+# TN/M/100/673426
+def get_ir_refnum(appnum):
+    return appnum.split('/')[-1]
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/sttm/schema

@@ -0,0 +1,83 @@
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventCode
+__________________/OfficeSpecificMarkEventDescription
+__________________/OfficeSpecificMarkEventDescription[@languageCode=en]
+__________________/OfficeSpecificMarkEventName
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+__________________/PublicationIdentifier
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+________________________/FreeFormatAddress
+__________________________/FreeFormatAddressLine
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode
+

gbdtransformation/brands/sttm/template.yml

@@ -0,0 +1 @@
+{% include "ipas/template.yml" %}

gbdtransformation/brands/ustm/filters.py

@@ -147,7 +147,6 @@ def get_applicants(owners, status):
 
     if not isinstance(owners, list):
         owners = [owners]
-
     # look for owners
     if status in ['Registered', 'Expired']:
         cdl = 20 # code low
@@ -160,8 +159,7 @@ def get_applicants(owners, status):
     applicants = []
     for owner in owners:
         code = owner.partyType
-
-        if cdl < int(code) <= cdh:
+        if cdl <= int(code) <= cdh:
             # get the address
             adrlines = []
             for i in range(1, 10):

gbdtransformation/brands/vntm/__init__.py

@@ -1,5 +1,6 @@
 render = 'JSON'
 source = 'national'
 
+default_lang = 'vi'
 # 4201911818
-appnum_mask =  '4\\d{4}(\\d*)'
+appnum_mask =  '4-\\d{4}-(\\d*)'

gbdtransformation/brands/vntm/filters.py

@@ -5,7 +5,7 @@ ignore_namespace = [
    'http://www.wipo.int/standards/XMLSchema/wo-trademarks']
 
 def get_appdate(appdate, appnum):
-    return appnum[1:5]
+    return appnum[2:6]
 
 def translate_type(header):
     code = header.TransactionCode
@@ -20,13 +20,20 @@ def translate_type(header):
 
 def translate_kind(trademark, header):
     kind = trademark.KindMark
-
+    if not kind:
+        return 'Individual'
     return ipas.translate_kind(kind)
 
 def translate_status(trademark):
-    status = trademark.MarkCurrentStatusCode
+    value = trademark.MarkCurrentStatusCode
+    if value in ['Cấp bằng','Đang giải quyết', 'Từ chối']:
+        return ipas.translate_status('Pending')
+    elif value in ['Công bố']:
+        return ipas.translate_status('Active')
+    elif value in ['Hết hạn', 'Rút đơn']:
+        return ipas.translate_status("Expired")
 
-    return ipas.translate_status(status)
+    raise Exception('Status "%s" is not mapped.' % value)
 
 def translate_feature(trademark):
     feature = trademark.MarkFeature
@@ -35,14 +42,15 @@ def translate_feature(trademark):
 
 def translate_event(event):
     if event == 'Notificationd': return 'Notification'
-
+    if not event:
+        return None
     return ipas.translate_event(event)
 
 # ---------------------------------------
 
 # TODO: all set to vi but some are english really
 # TODO: {'vi': ['NITRASA, hình']} (remove the hih)
-def verbal_lang_map(markVerbalElements, applang=None):
+def verbal_lang_map(markVerbalElements, applang='vi'):
     # print( ipas.verbal_lang_map(markVerbalElements, applang=applang))
     return ipas.verbal_lang_map(markVerbalElements, applang=applang)
 

gbdtransformation/brands/xxtm/__init__.py

@@ -0,0 +1,2 @@
+# instruction to render the output to JSON format
+render = 'JSON'

gbdtransformation/brands/xxtm/filters.py

@@ -0,0 +1,60 @@
+# standard gbd definitions
+from gbdtransformation.brands import kinds as std_kinds
+from gbdtransformation.brands import status as std_status
+from gbdtransformation.brands import features as std_features
+from gbdtransformation.brands import events as std_events
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def translate_kind(kind):
+    """translation of the kind of trademark to a
+        multivalue gbd interpretation"""
+
+    # out-of-the-box match
+    if kind.capitalize() in std_kinds:
+        return [kind.capitalize()]
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+def translate_status(status):
+    """translation of mark status"""
+    # a required data from office. if not present and no way to guess,
+    # return Unknown
+    if not status: return 'Unknown'
+
+    # out-of-the-box match
+    if status.capitalize() in std_status:
+        return status.capitalize()
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('Status "%s" unmapped' % status)
+
+
+def translate_feature(feature):
+    """translation of mark feature"""
+
+    # needed information from office
+    # if office cannot provide information, then agree on a way to guess (uatm)
+    if not feature: return 'Undefined'
+
+    # out-of-the-box match
+    if feature.capitalize() in std_features:
+        return feature.capitalize()
+
+    # __insert here__ : translation logic
+
+    # raise Exception to recognize unmapped values
+    raise Exception('Feature "%s" unmapped' % feature)
+

gbdtransformation/brands/xxtm/schema

@@ -0,0 +1,4 @@
+# generate this file using
+$ gbd-transform-xpath /data/brands/collections/xxtm -o gbdtransformation/brands/xxtm/schema
+
+This process runs with a speed of 1000/sec