wipo-gbd-transformation 1.1.53__py3-none-any.whl → 1.1.55__py3-none-any.whl

gbdtransformation/brands/phtm/schema

@@ -1,50 +1,79 @@
-/RECORD
-__/AGENT
-____/ADDR_STREET
-____/AGENT_CODE
-____/CITY_NAME
-____/PERSON_NAME
-____/PROVINCE_NAME
-__/APPL_SUBTYP
-__/APPL_TYP
-__/APPNO
-__/EXPIRATION_DATE
-__/FILE_NBR
-__/FILE_SEQ
-__/FILE_SER
-__/FILE_TYP
-__/FILING_DATE
-__/LAW_CODE
-__/LOGO
-____/LOGO
-__/NICE_CLASS
-____/NICE_CLASS_CODE
-____/NICE_CLASS_DESCRIPTION
-__/OWNER
-____/ADDR_STREET
-____/CITY_NAME
-____/NATIONALITY_COUNTRY_CODE
-____/PERSON_NAME
-____/PROVINCE_NAME
-____/RESIDENCE_COUNTRY_CODE
-____/STATE_CODE
-____/STATE_NAME
-__/PRIORITIES
-____/COUNTRY_CODE
-____/PRIORITY_APPL_ID
-____/PRIORITY_DATE
-__/PUBLICATION_DATE
-__/REGISTRATION_DATE
-__/REGISTRATION_NBR
-__/SIGN_TYPE
-__/STATUS_CATEGORY
-__/STATUS_DATE
-__/STATUS_NAME
-__/TITLE
-__/VIENNA
-____/VIENNA_CLASS_CODE
-____/VIENNA_ELEM_CODE
-____/VIENNA_GROUP_CODE
-____/VIENNA_NAME
-____/VIENNA_TEXT
-__/sign_type
+/Transaction
+__/TradeMarkTransactionBody
+____/TransactionContentDetails
+______/TransactionCode
+______/TransactionData
+________/TradeMarkApplication
+__________/TradeMarkDetails
+____________/TradeMark
+______________/ApplicantDetails
+________________/Applicant
+__________________/ApplicantAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/ApplicationDate
+______________/ApplicationLanguageCode
+______________/ApplicationNumber
+______________/ExpiryDate
+______________/GoodsServicesDetails
+________________/GoodsServices
+__________________/ClassDescriptionDetails
+____________________/ClassDescription
+______________________/ClassNumber
+______________________/GoodsServicesDescription
+______________________/GoodsServicesDescription[@languageCode=en]
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventName
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageFileFormat
+__________________/MarkImageFilename
+______________/PriorityDetails
+________________/Priority
+__________________/PriorityCountryCode
+__________________/PriorityDate
+__________________/PriorityNumber
+______________/PublicationDetails
+________________/Publication
+__________________/PublicationDate
+__________________/PublicationIdentifier
+__________________/PublicationSection
+______________/RegistrationDate
+______________/RegistrationNumber
+______________/RegistrationOfficeCode
+______________/RepresentativeDetails
+________________/Representative
+__________________/RepresentativeAddressBook
+____________________/FormattedNameAddress
+______________________/Address
+________________________/AddressCountryCode
+______________________/Name
+________________________/FreeFormatName
+__________________________/FreeFormatNameDetails
+____________________________/FreeFormatNameLine
+____________________________/FreeFormatNameLine[@languageCode=en]
+______________/WordMarkSpecification
+________________/MarkVerbalElementText
+________________/MarkVerbalElementText[@languageCode=en]
+______/TransactionIdentifier
+______/TransactionSubCode

gbdtransformation/brands/phtm/schema.classic

@@ -0,0 +1,50 @@
+/RECORD
+__/AGENT
+____/ADDR_STREET
+____/AGENT_CODE
+____/CITY_NAME
+____/PERSON_NAME
+____/PROVINCE_NAME
+__/APPL_SUBTYP
+__/APPL_TYP
+__/APPNO
+__/EXPIRATION_DATE
+__/FILE_NBR
+__/FILE_SEQ
+__/FILE_SER
+__/FILE_TYP
+__/FILING_DATE
+__/LAW_CODE
+__/LOGO
+____/LOGO
+__/NICE_CLASS
+____/NICE_CLASS_CODE
+____/NICE_CLASS_DESCRIPTION
+__/OWNER
+____/ADDR_STREET
+____/CITY_NAME
+____/NATIONALITY_COUNTRY_CODE
+____/PERSON_NAME
+____/PROVINCE_NAME
+____/RESIDENCE_COUNTRY_CODE
+____/STATE_CODE
+____/STATE_NAME
+__/PRIORITIES
+____/COUNTRY_CODE
+____/PRIORITY_APPL_ID
+____/PRIORITY_DATE
+__/PUBLICATION_DATE
+__/REGISTRATION_DATE
+__/REGISTRATION_NBR
+__/SIGN_TYPE
+__/STATUS_CATEGORY
+__/STATUS_DATE
+__/STATUS_NAME
+__/TITLE
+__/VIENNA
+____/VIENNA_CLASS_CODE
+____/VIENNA_ELEM_CODE
+____/VIENNA_GROUP_CODE
+____/VIENNA_NAME
+____/VIENNA_TEXT
+__/sign_type

gbdtransformation/brands/phtm/template.classic.yml

@@ -0,0 +1,102 @@
+{% from 'navigation.tmpl' import match %}
+{% set status = RECORD | translate_status %}
+
+type: TRADEMARK
+kind:
+  - Individual
+
+st13: {{ RECORD.APPNO | st13('PH') }}
+
+markFeature: {{ RECORD.SIGN_TYPE | translate_feature}}
+registrationOfficeCode: PH
+designatedCountries:
+  - PH
+
+applicationNumber: {{ RECORD.APPNO }}
+applicationDate: {{ RECORD.FILING_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+registrationNumber: {{ RECORD.REGISTRATION_NBR }}
+registrationDate: {{ RECORD.REGISTRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+
+reference:
+{% if RECORD.APPL_TYP == 'M' %}
+  office: WO
+  registration:
+    - number: {{ RECORD.FILE_NBR }}
+{% endif %}
+
+applicationLanguageCode: en
+expiryDate: {{ RECORD.EXPIRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+{% if status == 'Ended' %}
+terminationDate: {{ RECORD.EXPIRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
+{% endif %}
+
+officeStatus: {{ RECORD.STATUS_NAME }}
+gbdStatus: {{ status }}
+statusDate: {{ RECORD.STATUS_DATE | convertdate2('%m/%d/%Y;%b\t%d\t%Y')}}
+
+{% if RECORD.TITLE %}
+wordMarkSpecification:
+  markVerbalElement:
+  - languageCode: en
+    text: {{ RECORD.TITLE}}
+{% endif %}
+
+{% if RECORD.SIGN_TYPE == 'B' or RECORD.SIGN_TYPE == 'L' %}
+markImageDetails:
+  - name: {{ RECORD.LOGO.LOGO }}
+    {% if RECORD.VIENNA %}
+    classification:
+      kind: Vienna
+      code:
+      {% call(vienna) match('VIENNA', RECORD) %}
+      - {{ vienna.VIENNA_TEXT | pad_vienna }}
+      {% endcall %}
+    {% endif %}
+{% endif %}
+
+{% if RECORD.NICE_CLASS %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% call(nice) match('NICE_CLASS', RECORD) %}
+    - code: {{ nice.NICE_CLASS_CODE | int }}
+      terms:
+        en:
+          {% for gsline in nice.NICE_CLASS_DESCRIPTION | split_terms %}
+          - {{ gsline | remove_trailing('.') | lower }}
+          {% endfor %}
+  {% endcall %}
+{% endif %}
+
+priorities:
+  {% call(priority) match('PRIORITIES', RECORD) %}
+    - countryCode: {{ priority.COUNTRY_CODE }}
+      number: {{ priority.PRIORITY_APPL_ID | remove_trailing('-') }}
+      date: {{ priority.PRIORITY_DATE  | convertdate('%Y-%m-%dT%H:%M:%S')}}
+  {% endcall %}
+
+applicants:
+  {% call(applicant) match('OWNER', RECORD) %}
+      - fullName:
+          - text: {{ applicant.PERSON_NAME }}
+            languageCode: en
+        countryCode: {{ applicant.RESIDENCE_COUNTRY_CODE | remove_trailing('-', '.') }}
+        fullAddress:
+          - text: {{ applicant | get_address }}
+            languageCode: en
+  {% endcall %}
+
+representatives:
+  {% call(rep) match('AGENT', RECORD) %}
+  {% if rep.PERSON_NAME %}
+  - identifier: {{ rep.AGENT_CODE }}
+    fullName:
+    - text: {{ rep.PERSON_NAME }}
+      languageCode: en
+    countryCode: PH
+    fullAddress:
+    - text: {{ rep | get_address }}
+      languageCode: en
+  {% endif %}
+  {% endcall %}

gbdtransformation/brands/phtm/template.yml

@@ -1,102 +1 @@
-{% from 'navigation.tmpl' import match %}
-{% set status = RECORD | translate_status %}
-
-type: TRADEMARK
-kind:
-  - Individual
-
-st13: {{ RECORD.APPNO | st13('PH') }}
-
-markFeature: {{ RECORD.SIGN_TYPE | translate_feature}}
-registrationOfficeCode: PH
-designatedCountries:
-  - PH
-
-applicationNumber: {{ RECORD.APPNO }}
-applicationDate: {{ RECORD.FILING_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
-registrationNumber: {{ RECORD.REGISTRATION_NBR }}
-registrationDate: {{ RECORD.REGISTRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
-
-reference:
-{% if RECORD.APPL_TYP == 'M' %}
-  office: WO
-  registration:
-    - number: {{ RECORD.FILE_NBR }}
-{% endif %}
-
-applicationLanguageCode: en
-expiryDate: {{ RECORD.EXPIRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
-{% if status == 'Ended' %}
-terminationDate: {{ RECORD.EXPIRATION_DATE | convertdate('%Y-%m-%dT%H:%M:%S')}}
-{% endif %}
-
-officeStatus: {{ RECORD.STATUS_NAME }}
-gbdStatus: {{ status }}
-statusDate: {{ RECORD.STATUS_DATE | convertdate2('%m/%d/%Y;%b\t%d\t%Y')}}
-
-{% if RECORD.TITLE %}
-wordMarkSpecification:
-  markVerbalElement:
-  - languageCode: en
-    text: {{ RECORD.TITLE}}
-{% endif %}
-
-{% if RECORD.SIGN_TYPE == 'B' or RECORD.SIGN_TYPE == 'L' %}
-markImageDetails:
-  - name: {{ RECORD.LOGO.LOGO }}
-    {% if RECORD.VIENNA %}
-    classification:
-      kind: Vienna
-      code:
-      {% call(vienna) match('VIENNA', RECORD) %}
-      - {{ vienna.VIENNA_TEXT | pad_vienna }}
-      {% endcall %}
-    {% endif %}
-{% endif %}
-
-{% if RECORD.NICE_CLASS %}
-goodsServicesClassification:
-  kind: Nice
-  version: {{ ASK_THE_OFFICE }}
-  class:
-  {% call(nice) match('NICE_CLASS', RECORD) %}
-    - code: {{ nice.NICE_CLASS_CODE | int }}
-      terms:
-        en:
-          {% for gsline in nice.NICE_CLASS_DESCRIPTION | split_terms %}
-          - {{ gsline | remove_trailing('.') | lower }}
-          {% endfor %}
-  {% endcall %}
-{% endif %}
-
-priorities:
-  {% call(priority) match('PRIORITIES', RECORD) %}
-    - countryCode: {{ priority.COUNTRY_CODE }}
-      number: {{ priority.PRIORITY_APPL_ID | remove_trailing('-') }}
-      date: {{ priority.PRIORITY_DATE  | convertdate('%Y-%m-%dT%H:%M:%S')}}
-  {% endcall %}
-
-applicants:
-  {% call(applicant) match('OWNER', RECORD) %}
-      - fullName:
-          - text: {{ applicant.PERSON_NAME }}
-            languageCode: en
-        countryCode: {{ applicant.RESIDENCE_COUNTRY_CODE | remove_trailing('-', '.') }}
-        fullAddress:
-          - text: {{ applicant | get_address }}
-            languageCode: en
-  {% endcall %}
-
-representatives:
-  {% call(rep) match('AGENT', RECORD) %}
-  {% if rep.PERSON_NAME %}
-  - identifier: {{ rep.AGENT_CODE }}
-    fullName:
-    - text: {{ rep.PERSON_NAME }}
-      languageCode: en
-    countryCode: PH
-    fullAddress:
-    - text: {{ rep | get_address }}
-      languageCode: en
-  {% endif %}
-  {% endcall %}
+{% include "ipas/template.yml" %}

gbdtransformation/brands/vctm/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+#  VC/T/2015/109
+appnum_mask = 'VC/T/\d{4}/(.*)'

gbdtransformation/brands/vctm/filters.py

@@ -0,0 +1,75 @@
+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]
+
+    #return ipas.get_appdate(appdate, appnum)
+
+def translate_type(header):
+    code = header.TransactionCode
+    if code == 'Trademark': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+    if subcode == 'Trademarks': return ['Individual']
+    # it is None for all
+    # kind = trademark.KindMark
+
+    raise Exception('Kind "%s" not mapped.' % subcode)
+
+def translate_status(trademark):
+    status = trademark.MarkCurrentStatusCode
+    """
+    if status == 'Converted': return 'Registered'
+    """
+    return ipas.translate_status(status)
+
+def translate_feature(trademark):
+    feature = trademark.MarkFeature
+    if not feature: return 'Undefined'
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    if not event: return 'Unknown'
+
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+# # language code is not accurate for markVerbalElement
+# def guess_language(text, lang, default):
+#     if commons.is_latin(text):
+#         return 'en'
+#     else:
+#         return commons.guess_language(text, lang, default)
+
+def verbal_lang_map(markVerbalElements, applang=None):
+    return ipas.verbal_lang_map(markVerbalElements, applang=applang)
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    return None
+
+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):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/vctm/schema

@@ -0,0 +1,87 @@
+/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]
+______________/KindMark
+______________/MarkCurrentStatusCode
+______________/MarkCurrentStatusDate
+______________/MarkDisclaimerDetails
+________________/MarkDisclaimer
+________________/MarkDisclaimer[@languageCode=en]
+______________/MarkEventDetails
+________________/MarkEvent
+__________________/MarkEventCode
+__________________/MarkEventDate
+__________________/OfficeSpecificMarkEventCode
+__________________/OfficeSpecificMarkEventDescription
+__________________/OfficeSpecificMarkEventDescription[@languageCode=en]
+______________/MarkFeature
+______________/MarkImageDetails
+________________/MarkImage
+__________________/MarkImageCategory
+____________________/CategoryCodeDetails
+______________________/CategoryCode
+____________________/CategoryKind
+____________________/CategoryVersion
+__________________/MarkImageColourClaimedText
+__________________/MarkImageColourClaimedText[@languageCode=en]
+__________________/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/vctm/template.yml

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

gbdtransformation/brands/xxxx/template.yml

@@ -36,7 +36,7 @@ filingPlace:
 # some collections indicate that the application
 # originates from international filing and provide IR number
 # (question to ask in GBD participation questionnaire)
-referece:
+reference:
   application:
     - number:
       date:

gbdtransformation/designs/woid/filters.py

@@ -3,6 +3,7 @@ from gbdtransformation.designs import kinds as std_kinds
 from gbdtransformation.designs import status as std_status
 from gbdtransformation.designs.filters import st13
 from datetime import datetime, date
+import json 
 
 # namespaces defined in XML and to be ignored in procecssing
 ignore_namespace = [ "http://www.wipo.int/standards/XMLSchema/ST96/Design", 
@@ -145,7 +146,7 @@ def format_address(address_lines):
     if not isinstance(address_lines, list):
         address_lines = [address_lines]
     for address_line in address_lines:
-        if "__value" in address_line:
+        if address_line is not None and "__value" in address_line:
             address += address_line.__value + ' \n'
     if len(address) > 0:
         return address.strip()
@@ -153,6 +154,8 @@ def format_address(address_lines):
         return None
 
 def format_complete_address(PostalStructuredAddress):
+    if PostalStructuredAddress == None:
+        return None
     adr_lines = format_address(PostalStructuredAddress.AddressLineText)
     address = []
     if adr_lines:
@@ -344,4 +347,26 @@ def isApplicableToCountry(countryCode, hagueHistoryEvent):
                         return True
     return False
 
+"""
+Functions dedicated to Hague transaction history  
+"""
+
+transaction_header_elements = [ "HagueBulletinNumber", "PublicationDate" ]
+
+def get_event_type(history):
+    for child in history:
+        if child.startswith("_"):
+            continue
+        if child not in transaction_header_elements:
+            return child
+    return None
+
+def serialize(history):
+    #print(history)
+    jsonString = history.toJSON()
+    # keeping single quote in the JSON (even escaped) will fail when going back to yaml (yaml parsing error)
+    # so we need to use an alternative unicode for single quote. 
+    jsonString = jsonString.replace("\'", "\u201A")
+    return json.loads(jsonString)
+