diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..090eda8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,61 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*.pyc + +#IDEA +.idea/ + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo +*.pot + +# Django stuff: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Virtualenv +env/ diff --git a/README.md b/README.md index 2574a3b..5787d32 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,33 @@ # sms-counter-python -SMS Character Counter -============================= +---- -Character counter for SMS messages. +**sms-counter-python** is a lib that help to count characters of SMS messages. -##Usage +#### Get it now +``` +$ pip install git+https://github.com/dedayoa/sms-counter-python.git#egg=sms_counter +``` +#### Support +* Python 2 +* Python 3 + +#### Requirements +sms-counter-python has no external dependencies outside of the Python standard library + +#### Usage ```python from sms_counter import SMSCounter -smsmsg = SMSCounter(); -smsmsg.count('ǂ some-string-to-be-counted '); +>>> counter = SMSCounter.count('ǂ some-string-to-be-counted '); +>>> counter +>>> {'length': 29, 'messages': 1, 'remaining': 41, 'per_message': 70, 'encoding': 'UTF16'} ``` -returns -``` - -{ - 'length': 28, - 'per_message': 70, - 'remaining': 42, - 'messages': 1, - 'encoding': 'UTF16' -} -``` - - -###Mentions +#### Mentions * Original idea : [danxexe/sms-counter](https://github.com/danxexe/sms-counter) * Next Original : [wobblecode/sms-counter-php](https://github.com/wobblecode/sms-counter-php/) -## License - -sms-counter-python is released under the [MIT License](LICENSE.txt). - +#### License +MIT licensed. See the bundled [LICENSE](LICENSE) file for more details. diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..269613f --- /dev/null +++ b/setup.py @@ -0,0 +1,26 @@ +""" +See: +https://packaging.python.org/en/latest/distributing.html +""" +import os +from setuptools import setup + +# To use a consistent encoding +from codecs import open + +here = os.path.abspath(os.path.dirname(__file__)) + +# Get the long description from the README file +with open(os.path.join(here, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='sms-counter', + version='1.0.0', + description='SMS Character Counter', + long_description=long_description, + author='Dayo Ayeni', + # author_email='', + packages=['sms_counter'], + install_requires=[""], + include_package_data=True) diff --git a/sms-counter.py b/sms-counter.py deleted file mode 100644 index 5877951..0000000 --- a/sms-counter.py +++ /dev/null @@ -1,153 +0,0 @@ -# -*- coding: utf8 -*- -''' -Created on Jul 10, 2016 - -@author: Dayo -''' -from math import ceil - - -class SMSCounter(): - - GSM_7BIT = 'GSM_7BIT' - GSM_7BIT_EX = 'GSM_7BIT_EX' - UTF16 = 'UTF16' - GSM_7BIT_LEN = GSM_7BIT_EX_LEN = 160 - UTF16_LEN = 70 - GSM_7BIT_LEN_MULTIPART = GSM_7BIT_EX_LEN_MULTIPART = 153 - UTF16_LEN_MULTIPART = 67 - - - def get_gsm_7bit_map(self): - - return( - [10,13,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50, - 51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70, - 71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90, - 92,95,97,98,99,100,101,102,103,104,105,106,107,108,109,110, - 111,112,113,114,115,116,117,118,119,120,121,122, - 161,163,164,165,191,196,197,198,199,201,209,214, - 216,220,223,224,228,229,230,232,233,236,241,242, - 246,248,249,252,915,916,920,923,926,928,931,934, - 936,937] - ) - - def get_added_gsm_7bit_ex_map(self): - - return [91,92,93,94,123,124,125,126,8364] - - def get_gsm_7bit_ex_map(self): - - return(self.get_added_gsm_7bit_ex_map()+self.get_gsm_7bit_map()) - - - def text_to_unicode_pointcode_list(self, plaintext): - - textlist = [] - for stg in plaintext: - textlist.append(ord(stg)) - return textlist - - def unicode_pointcode_list_to_text(self, strlist): - - text = '' - for stc in strlist: - text.join(chr(stc)) - return text - - - def detect_encoding(self, plaintext): - - rf = self.text_to_unicode_pointcode_list(plaintext) - - utf16chars = set(rf).difference(set(self.get_gsm_7bit_map())) - - if len(utf16chars): - return self.UTF16 - - exchars = set(rf).intersection(set(self.get_added_gsm_7bit_ex_map())) - - if len(exchars): - return self.GSM_7BIT_EX - - return self.GSM_7BIT - - - - - def count(self, plaintext): - - textlist = self.text_to_unicode_pointcode_list(plaintext) - - exchars = [] - encoding = self.detect_encoding(plaintext) - length = len(textlist) - - if encoding == self.GSM_7BIT_EX: - lengthexchars = len(exchars) - length+=lengthexchars - - if encoding == self.GSM_7BIT: - permessage = self.GSM_7BIT_LEN - if length > self.GSM_7BIT_LEN: - permessage = self.GSM_7BIT_LEN_MULTIPART - - - elif encoding == self.GSM_7BIT_EX: - permessage = self.GSM_7BIT_EX_LEN - if length > self.GSM_7BIT_EX_LEN: - permessage = self.GSM_7BIT_EX_LEN_MULTIPART - - - else: - permessage = self.UTF16_LEN - if length > self.UTF16_LEN: - permessage = self.UTF16_LEN_MULTIPART - - - messages = ceil(length/permessage) - remaining = (permessage * messages) - length - - returnset = { - 'encoding' : encoding, - 'length' : length, - 'per_message' : permessage, - 'remaining' : remaining, - 'messages' : messages - } - - return returnset - - - def truncate(self, plaintext, limitsms): - - count = self.count(plaintext) - - if count.mesages <= limitsms: - return plaintext - - - if count.encoding == 'UTF16': - limit = self.UTF16_LEN - - if limitsms > 2: - limit = self.UTF16_LEN_MULTIPART - - if count.encoding != 'UTF16': - limit = self.GSM_7BIT_LEN - - if limitsms > 2: - limit = self.GSM_7BIT_LEN_MULTIPART - - - while True: - text = plaintext[0:limit*limitsms] - count = self.count(plaintext) - - limit = limit - 1 - - if count.messages < limitsms: - break - - return text - diff --git a/sms_counter/__init__.py b/sms_counter/__init__.py new file mode 100644 index 0000000..f06f198 --- /dev/null +++ b/sms_counter/__init__.py @@ -0,0 +1,5 @@ +#!/usr/bin/env python +from __future__ import absolute_import + +"""SMSCounter Module.""" +from .main import SMSCounter diff --git a/sms_counter/main.py b/sms_counter/main.py new file mode 100644 index 0000000..257aa85 --- /dev/null +++ b/sms_counter/main.py @@ -0,0 +1,129 @@ +# -*- coding: utf8 -*- +''' +Created on Jul 10, 2016 +@author: Dayo +''' +from math import ceil + + +class SMSCounter(object): + GSM_7BIT = 'GSM_7BIT' + GSM_7BIT_EX = 'GSM_7BIT_EX' + UTF16 = 'UTF16' + GSM_7BIT_LEN = GSM_7BIT_EX_LEN = 160 + UTF16_LEN = 70 + GSM_7BIT_LEN_MULTIPART = GSM_7BIT_EX_LEN_MULTIPART = 153 + UTF16_LEN_MULTIPART = 67 + + @classmethod + def _get_gsm_7bit_map(cls): + gsm_7bit_map = [ + 10, 13, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, + 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, + 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, + 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 92, 95, 97, 98, 99, 100, + 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, + 114, 115, 116, 117, 118, 119, 120, 121, 122, 161, 163, 164, 165, + 191, 196, 197, 198, 199, 201, 209, 214, 216, 220, 223, 224, 228, + 229, 230, 232, 233, 236, 241, 242, 246, 248, 249, 252, 915, 916, + 920, 923, 926, 928, 931, 934, 936, 937] + return gsm_7bit_map + + @classmethod + def _get_added_gsm_7bit_ex_map(cls): + added_gsm_7bit_ex_map = [91, 92, 93, 94, 123, 124, 125, 126, 8364] + return added_gsm_7bit_ex_map + + @classmethod + def _text_to_unicode_pointcode_list(cls, plaintext): + textlist = [] + for stg in plaintext: + textlist.append(ord(stg)) + return textlist + + @classmethod + def _detect_encoding(cls, plaintext): + rf = cls._text_to_unicode_pointcode_list(plaintext) + + utf16chars = set(rf).difference(set(cls._get_gsm_7bit_map())) + + if len(utf16chars): + return cls.UTF16 + + exchars = set(rf).intersection(set(cls._get_added_gsm_7bit_ex_map())) + + if len(exchars): + return cls.GSM_7BIT_EX + + return cls.GSM_7BIT + + @classmethod + def count(cls, plaintext): + textlist = cls._text_to_unicode_pointcode_list(plaintext) + + exchars = [] + encoding = cls._detect_encoding(plaintext) + length = len(textlist) + + if encoding == cls.GSM_7BIT_EX: + lengthexchars = len(exchars) + length += lengthexchars + + if encoding == cls.GSM_7BIT: + permessage = cls.GSM_7BIT_LEN + if length > cls.GSM_7BIT_LEN: + permessage = cls.GSM_7BIT_LEN_MULTIPART + elif encoding == cls.GSM_7BIT_EX: + permessage = cls.GSM_7BIT_EX_LEN + if length > cls.GSM_7BIT_EX_LEN: + permessage = cls.GSM_7BIT_EX_LEN_MULTIPART + else: + permessage = cls.UTF16_LEN + if length > cls.UTF16_LEN: + permessage = cls.UTF16_LEN_MULTIPART + + # Convert the dividend to fload so the division will be a float number + # and then convert the ceil result to int + # since python 2.7 return a float + messages = int(ceil(length / float(permessage))) + remaining = (permessage * messages) - length + + returnset = { + 'encoding': encoding, + 'length': length, + 'per_message': permessage, + 'remaining': remaining, + 'messages': messages + } + + return returnset + + @classmethod + def truncate(cls, plaintext, limitsms): + count = cls.count(plaintext) + + if count.mesages <= limitsms: + return plaintext + + if count.encoding == 'UTF16': + limit = cls.UTF16_LEN + + if limitsms > 2: + limit = cls.UTF16_LEN_MULTIPART + + if count.encoding != 'UTF16': + limit = cls.GSM_7BIT_LEN + + if limitsms > 2: + limit = cls.GSM_7BIT_LEN_MULTIPART + + while True: + text = plaintext[0:limit * limitsms] + count = cls.count(plaintext) + + limit = limit - 1 + + if count.messages < limitsms: + break + + return text