wipo-gbd-transformation 1.1.105__py3-none-any.whl

gbdtransformation/brands/eetm/filters.py

@@ -0,0 +1,115 @@
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = []
+
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def get_appyear(appdate, appnum):
+    if appnum[:1] == 'M': # M200000084
+        return appnum[1:5]
+    else:
+        return appdate[-4:]
+
+def get_termination(value, gbd_status):
+    if gbd_status == 'Ended':
+        return value
+    return None
+
+def translate_office_status(status):
+    if status == 'Seniority': return 'Deleted - basis of Seniority'
+    if status == 'EC_Seniority': return 'Deleted - basis of Seniority'
+    if status == 'EC Seniority': return 'Deleted - basis of Seniority'
+    if status == 'Decision appealed': return 'Appeal pending'
+    if status == 'AppealExamination procedure': return 'Appeal pending'
+
+    # correct the typo. bof!
+    if status == 'Replaced by an Internatinal Registration': return 'Replaced by an International Registration'
+
+    return status
+
+def translate_status(status):
+    if not status: return 'Unknown'
+
+    if status == 'Registered': return 'Registered'
+    if status == 'Cancelled': return 'Delete'
+
+    if status in [ 'Seniority',
+                   'Registration surrendered',
+                   'Expired',
+                   'EC_Seniority',
+                   'EC Seniority',
+                   'Deleted from Register',
+                   'Replaced by an International Registration',
+                   'Replaced by an Internatinal Registration' ]:
+        return 'Expired'
+
+
+    if status in [ 'Proceeding terminated by the request of applicant',
+                   'Proceeding terminated',
+                   'Refused',
+                   'Application not filed' ]:
+        return 'Ended'
+
+    if status in [ 'Pending',
+                   'Published',
+                   'Decision appealed',
+                   'AppealExamination procedure',
+                   'Examination procedure',
+                   'Opposition pending' ]:
+        return 'Pending'
+
+    if 'pending' in status:
+        return 'Pending'
+
+    raise Exception('Status "%s" unmapped' % status)
+
+def split_vienna(code):
+    return "%s.%s.%s" % (code[0:2], code[2:4], code[4:])
+
+def get_full_address(addr):
+    address = []
+
+    if addr.RepAddress: address.append(addr.RepAddress)
+    if addr.AddressLine: address.append(addr.AddressLine)
+    if addr.AddressCity: address.append(addr.AddressCity)
+    if addr.AddressPostcode: address.append(addr.AddressPostcode)
+
+    return ', '.join(address)
+
+
+def get_full_name_type(addr):
+    name = []
+    type = 'Natural person'
+    if addr.FullName:
+        name.append(addr.FullName)
+    elif addr.FirstName:
+        name.append("%s %s" % (addr.FirstName, addr.LastName))
+
+    if addr.OrganizationName:
+        name.append(addr.OrganizationName)
+        type = 'Legal entity'
+
+    if len(name):
+        return (type, ', '.join(name))
+    else:
+        raise Exception("Cannot find name")
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+
+    if feature == 'Word': return 'Word'
+    if feature == 'Combined': return 'Combined'
+    if feature == 'Figurative': return 'Figurative'
+    if feature == '3-D': return 'Three dimensional'
+    if feature == 'Multimedia': return 'Multimedia'
+    if feature == 'Motion': return 'Motion'
+    if feature == 'Pattern-marks': return 'Pattern'
+    if feature == 'Position': return 'Position'
+    if feature == 'Sound': return 'Sound'
+    if feature == 'Colour': return 'Colour'
+
+    raise Exception('Feature "%s" unmapped' % feature)
+

gbdtransformation/brands/eetm/schema

@@ -0,0 +1,48 @@
+TradeMark
+__/ApplicantDetails
+____/ApplicantDetail
+______/Applicant
+________/AddressCity
+________/AddressCountry
+________/AddressLine
+________/AddressPostcode
+________/AddressState
+________/FirstName
+________/FullName
+________/LastName
+__/ApplicationDate
+__/ApplicationNumber
+__/CategoryCodeDetails
+____/CategoryCodeDetail
+______/CategoryCode
+________/CategoryCode
+__/EE_Colors
+__/ExpiryDate
+__/GoodsServicesDetails
+____/GoodsServicesDetail
+______/GoodsServices
+________/ClassNumber
+________/GoodsServicesDescription
+__/MarkImage
+__/MarkType
+__/MarkVerbalElementText
+__/PriorityDetails
+____/PriorityDetail
+______/Priority
+________/EE_PriorityCountry
+________/EE_PriorityNum
+________/PriorityDate
+__/PublicationDate
+__/RegistrationDate
+__/RegistrationNumber
+__/RepresentativeDetails
+____/RepresentativeDetail
+______/Representative
+________/AddressCity
+________/AddressCountry
+________/AddressPostcode
+________/FirstName
+________/LastName
+________/OrganizationName
+________/RepAddress
+__/Status

gbdtransformation/brands/eetm/template.yml

@@ -0,0 +1,98 @@
+{% from 'navigation.tmpl' import match %}
+
+{% set status = TradeMark.Status | translate_status  %}
+{% set appyear = TradeMark.ApplicationDate | get_appyear(TradeMark.ApplicationNumber) %}
+
+gbdStatus: {{ status }}
+st13: {{TradeMark.ApplicationNumber | st13('EE', appdate=appyear) }}
+registrationOfficeCode: EE
+type: TRADEMARK
+
+{% if not status == 'Delete' %}
+kind:
+  - Individual
+markFeature: {{TradeMark.MarkType | translate_feature}}
+designatedCountries:
+  - EE
+applicationNumber: {{TradeMark.ApplicationNumber}}
+applicationDate: {{TradeMark.ApplicationDate|convertdate('%d.%m.%Y')}}
+registrationNumber: {{TradeMark.RegistrationNumber}}
+registrationDate: {{TradeMark.RegistrationDate|convertdate('%d.%m.%Y')}}
+applicationLanguageCode: et
+expiryDate: {{TradeMark.ExpiryDate|convertdate('%d.%m.%Y')}}
+officeStatus: {{TradeMark.Status | translate_office_status}}
+publicationDate: {{ TradeMark.PublicationDate | convertdate('%d.%m.%Y') }}
+wordMarkSpecification:
+  markVerbalElement:
+    {% call(desc) match('MarkVerbalElementText', TradeMark) %}
+    - text: {{ desc }}
+      languageCode: {{ desc | guess_language('et', 'en') }}
+    {% endcall %}
+markImageDetails:
+  - name: {{ TradeMark.MarkImage }}
+    {% if TradeMark.EE_Colors %}
+    colourIndicator: true
+    colourClaimed:
+      - languageCode: et
+        text: {{ TradeMark.EE_Colors }}
+    {% endif %}
+    {% if TradeMark.CategoryCodeDetails %}
+    classification:
+      kind: Vienna
+      code:
+      {% call(code) match('CategoryCodeDetails.CategoryCodeDetail', TradeMark) %}
+        - {{ code.CategoryCode.CategoryCode | split_vienna }}
+      {% endcall %}
+    {% endif %}
+
+{% call(nc_gs) match('GoodsServicesDetails', TradeMark) %}
+goodsServicesClassification:
+  kind: Nice
+  version: {{ ASK_THE_OFFICE }}
+  class:
+  {% call(nice) match('GoodsServicesDetail', nc_gs) %}
+    - code: {{ nice.GoodsServices.ClassNumber | int }}
+      terms:
+      {% if nice.GoodsServices.GoodsServicesDescription | has_value %}
+        et:
+        {% for gsline in nice.GoodsServices.GoodsServicesDescription | remove_trailing('.') | split_terms %}
+          - {{ gsline | lower }}
+        {% endfor %}
+      {% endif %}
+    {% endcall %}
+{% endcall %}
+
+priorities:
+  {% call(priority) match('PriorityDetails.PriorityDetail', TradeMark) %}
+    - countryCode: {{ priority.Priority.EE_PriorityCountry }}
+      number: {{ priority.Priority.EE_PriorityNum }}
+      date: {{ priority.Priority.PriorityDate  | convertdate('%d.%m.%Y')}}
+  {% endcall %}
+
+applicants:
+  {% call(entity) match('ApplicantDetails.ApplicantDetail', TradeMark) %}
+  {% set (type, name) = entity.Applicant | get_full_name_type %}
+  - kind: {{ type }}
+    fullName:
+      - text: {{ name }}
+        languageCode: en
+    fullAddress:
+      - text: {{ entity.Applicant | get_full_address }}
+        languageCode: {{ entity.Applicant | get_full_address | guess_language('en') }}
+    countryCode: {{ entity.Applicant.AddressCountry }}
+  {% endcall %}
+
+representatives:
+  {% call(entity) match('RepresentativeDetails.RepresentativeDetail', TradeMark) %}
+  {% set (type, name) = entity.Representative | get_full_name_type %}
+  - kind: {{ type }}
+    fullName:
+      - text: {{ name }}
+        languageCode: en
+    fullAddress:
+      - text: {{ entity.Representative | get_full_address }}
+        languageCode: {{ entity.Representative | get_full_address | guess_language('en') }}
+    countryCode: {{ entity.Representative.AddressCountry }}
+  {% endcall %}
+
+{% endif %}

gbdtransformation/brands/egtm/__init__.py

@@ -0,0 +1,5 @@
+render = 'JSON'
+source = 'national'
+
+# EG/211858
+appnum_mask = 'EG/(\\d*)'

gbdtransformation/brands/egtm/filters.py

@@ -0,0 +1,73 @@
+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 ipas.get_appdate(appdate, appnum)
+
+def translate_type(header):
+    code = header.TransactionCode
+
+    if code == 'علامة تجارية وطنية': return 'TRADEMARK'
+
+    raise Exception('Type "%s" is not mapped.' % code)
+
+def translate_kind(trademark, header):
+    subcode = header.TransactionSubCode
+
+    if subcode == 'طلب علامات وطني': return ['Individual']
+    if subcode == 'طلب وطني مودع بالادارة': 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
+
+    if not feature: return 'Undefined'
+    if feature == 'M': return 'Combined'
+    if feature == 'F': return 'Figurative'
+
+    return ipas.translate_feature(feature)
+
+def translate_event(event):
+    if not event: return 'Unknown'
+    return ipas.translate_event(event)
+
+# ---------------------------------------
+
+# TODO:
+# {'ar': ['----'], 'en': ['CALGON']}
+#   remove empty arabic brand names
+# {'ar': ['YOGL BEAR'], 'en': ['YOGL BEAR']}
+#   remove arabic == english
+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(content):
+    return False
+
+def get_ir_refnum(appnum):
+    return
+
+def get_goods_services(goods_services):
+    return ipas.get_goods_services(goods_services)

gbdtransformation/brands/egtm/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/egtm/template.yml

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

gbdtransformation/brands/emtm/__init__.py

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

gbdtransformation/brands/emtm/filters.py

@@ -0,0 +1,96 @@
+# 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
+
+# namespaces defined in XML and to be ignored in procecssing
+ignore_namespace = [
+    'http://www.euipo.europa.eu/EUTM/EUTM_Download'
+]
+
+
+def get_termination(value, gbd_status):
+    if gbd_status == 'Ended':
+        return value
+    return None
+
+# -------------------------------------------------------------
+# data translation helpers:
+# translate values from office interpretation to gbd equivalent
+# -------------------------------------------------------------
+
+def format_address(address):
+    return '%s, %s %s' % (address.AddressStreet,
+                          address.AddressPostcode,
+                          address.AddressCity)
+
+def format_name(name):
+    fname = name.FirstName
+    lname = name.LastName
+
+    full_name = [name.FirstName, name.LastName]
+    full_name = [f for f in full_name if f]
+
+    return ' '.join(full_name)
+
+
+def translate_kind(kind):
+    if not kind: return ['Individual']
+
+    if kind.capitalize() in std_kinds:
+        return [kind.capitalize()]
+
+    if kind == 'EU Certificate':
+        return ['Certificate']
+
+    raise Exception('kind "%s" is not mapped.' % kind)
+
+
+
+def translate_feature(feature):
+    if not feature: return 'Undefined'
+
+    if feature == "3D shape": return 'Three dimensional'
+
+    if feature.capitalize() in std_features:
+        return feature.capitalize()
+
+    return 'Unknown'
+    #raise Exception('Feature "%s" unmapped' % feature)
+
+
+def get_registration_nb(trademark, tmstatus):
+    if trademark.RegistrationNumber:
+        return trademark.RegistrationNumber
+
+    # default registration number to application number
+    # in case none is provided
+    if tmstatus in ['Registered', 'Expired']:
+        return trademark.ApplicationNumber
+
+def translate_status(trademark):
+    if trademark._operationCode == 'Delete':
+        return 'Delete'
+
+    status = trademark.MarkCurrentStatusCode
+
+    if status in ['Application filed',
+                  'Application published',
+                  'Application under examination',
+                  'Application opposed',
+                  'Registration pending',
+                  'Appeal pending',
+                  'Registration cancellation pending']:
+        return 'Pending'
+
+    if status in ['Application refused',
+                  'Application withdrawn',
+                  'Registration cancelled',
+                  'Registration surrendered']:
+        return 'Ended'
+
+    if status == 'Registered': return 'Registered'
+    if status == 'Registration expired': return 'Expired'
+
+    return 'Unknown'
+    #raise Exception('Status "%s" not mapped.' % status)