Supporting Python3

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Unbabel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,7 +4,7 @@ Python SDK for the Unbabel REST API
 Documentation:
 =============
 
-Please visit our documentation page at https://github.com/Unbabel
+Please visit our documentation page at https://github.com/Unbabel/unbabel_api
 
 
 
@@ -23,13 +23,19 @@ Getting started:
 
 ## Request a Translation
 
-`api.post_translations(text="This is a test translation",target_language="pt",source_language="en")`
+```
+api.post_translations(text="This is a test translation",target_language="pt",
+                       source_language="en",
+                       callback_url="http://my-awesome-service.com/unbabel_endpoint")
+```
+
+Check out the [API documentation](https://github.com/Unbabel/unbabel_api#translation) for additional options.
 
 ## Get a Translation
 
 Returns a translation by its uid.
 
-`t = api.get_translation(uid)` 
+`t = api.get_translation(uid)`
 
 
 
@@ -41,18 +47,18 @@ Returns all the translations for a given user.
 
 
 
-## Getting Available Language Pairs 
+## Getting Available Language Pairs
 
 `api.get_language_pairs()`
 
 > [pt_en,
   pt_fr,
-  ... 
+  ...
   it_en,
   it_fr,
   it_es]
-  
-  Each element of the list is a **LanguagePair** object that contains a source language and a target language. Each language is an instance of the **Language** class that contains a shortname ( iso639-1 language code ) and a name. 
+
+  Each element of the list is a **LanguagePair** object that contains a source language and a target language. Each language is an instance of the **Language** class that contains a shortname ( iso639-1 language code ) and a name.
 
 ## Getting Available Tones
 

localhost.env

@@ -0,0 +1,3 @@
+UNBABEL_TEST_USERNAME=gracaninja
+UNBABEL_TEST_API_KEY=5a6406e31f77ef779c4024b1579f0f6103944c5e
+UNBABEL_TEST_API_URL=http://0.0.0.0:8000/tapi/v2/

release_to_pypy.txt

@@ -0,0 +1,5 @@
+http://peterdowns.com/posts/first-time-with-pypi.html
+
+python setup.py register -r pypi
+
+python setup.py sdist upload -r pypi

requirements.py

@@ -1 +1,2 @@
 requests
+beautifulsoup4

runtests

@@ -0,0 +1,2 @@
+export $(cat .env)
+python -m unittest discover -s 'tests/' -p '*test*.py'

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description-file = README.md

setup.py

@@ -1,24 +1,21 @@
 from setuptools import setup
 
 setup(name='unbabel-py',
-      version='0.26',
+      version='0.50',
       description='Python Wrapper around Unbabel HTTP API',
       author='Joao Graca',
-      author_email='[email protected]',
-      packages=[
-          'unbabel',
-          ],
-      package_dir={
-        'unbabel': 'unbabel/',
-        },
+      author_email='[email protected]',
+      packages=['unbabel'],
+      package_dir={'unbabel': 'unbabel',},
       install_requires=[
-        'requests',
-          ],
-      url = 'https://github.com/Unbabel/unbabel-py',
-      download_url = 'https://github.com/Unbabel/unbabel-py/tarball/0.1',
-      classifiers = ['Development Status :: 4 - Beta',
-                     'Intended Audience :: Developers',
-                     'Programming Language :: Python ',
-                     'Topic :: Text Processing'
-                     ]
+          'requests',
+          'beautifulsoup4',
+      ],
+      url='https://github.com/Unbabel/unbabel-py',
+      download_url='https://github.com/Unbabel/unbabel-py/archive/0.50.tar.gz',
+      classifiers=['Development Status :: 4 - Beta',
+                   'Intended Audience :: Developers',
+                   'Programming Language :: Python ',
+                   'Topic :: Text Processing'
+                   ]
       )

tests/tests.py

@@ -11,18 +11,18 @@
 from unbabel.api import (UnbabelApi, Order, LangPair, Tone, Topic,
                          Translation, Account, Job, BadRequestException)
 
-
-UNBABEL_TEST_USERNAME = os.environ.get('UNBABEL_TEST_USERNAME')
-UNBABEL_TEST_API_KEY = os.environ.get('UNBABEL_TEST_API_KEY')
-
-
 class TestUnbabelAPI(unittest.TestCase):
+    UNBABEL_TEST_USERNAME = os.environ.get('UNBABEL_TEST_USERNAME')
+    UNBABEL_TEST_API_KEY = os.environ.get('UNBABEL_TEST_API_KEY')
+    UNBABEL_TEST_API_URL = os.environ.get('UNBABEL_TEST_API_URL')
+
     @property
     def api(self):
         if not hasattr(self, '_api'):
-            self._api = UnbabelApi(username=UNBABEL_TEST_USERNAME,
-                                   api_key=UNBABEL_TEST_API_KEY)
-
+            self._api = UnbabelApi(username = self.UNBABEL_TEST_USERNAME,
+                                   api_key = self.UNBABEL_TEST_API_KEY,
+                                   sandbox = True)
+            self._api.api_url = self.UNBABEL_TEST_API_URL
         return self._api
 
     def test_api_get_language_pairs(self):
@@ -68,11 +68,11 @@ def test_api_post_translation(self):
         self.assertIsNotNone(translation.uid, 'Did not get a uid')
         self.assertGreater(translation.price, 0, 'Price is not greater than 0')
         self.assertEqual(translation.source_language, 'en',
-                         'Source language is not en')
+                         'Source language is not en but %s'%translation.source_language)
         self.assertEqual(translation.target_language, 'pt',
-                         'Target language is not pt')
+                         'Target language is not pt but %s'%translation.target_language)
         self.assertEqual(translation.text, data['text'])
-        self.assertEqual(translation.status, 'new', 'status is not new')
+        self.assertEqual(translation.status, 'New', 'Wrong status: [{}]'.format(translation.status))
         self.assertIsNone(translation.topics, 'Topics is not None')
         self.assertIsInstance(translation.translators, list,
                               'Translators is not a list')
@@ -90,45 +90,40 @@ def test_api_post_translation(self):
                          'target language not equal')
         self.assertEqual(translation.price, trans.price, 'price not equal')
         self.assertEqual(translation.text, trans.text, 'text not equal')
-        self.assertEqual(translation.status, trans.status, 'status not equal')
+
 
     def test_api_get_account(self):
         account = self.api.get_account()
         self.assertIsInstance(account, Account,
                               'Should be an Account instance')
         self.assertIsInstance(account.username, unicode,
                               'Username is not unicode')
-        self.assertEqual(account.username, UNBABEL_TEST_USERNAME,
+        self.assertEqual(account.username, self.UNBABEL_TEST_USERNAME,
                          'Wrong username')
         self.assertIsInstance(account.balance, float, 'Balance is not float')
         self.assertIsInstance(account.email, unicode, 'Email is not unicode')
 
     def test_api_get_translations(self):
+        data = {
+            'text': "This is a test translation",
+            'source_language': 'en',
+            'target_language': 'pt',
+        }
+        self.api.post_translations(**data)
         translations = self.api.get_translations()
-        self.assertIsInstance(translations, list, 'Translations is not list')
-        if not len(translations):
-            data = {
-                'text': "This is a test translation",
-                'source_language': 'en',
-                'target_language': 'pt',
-            }
-            self.api.post_translations(**data)
-            translations = self.api.get_translations()
-            self.assertIsInstance(translations, list,
-                                  'Translations is not list')
-        self.assertTrue(
-            reduce(lambda x, y: x and y,
-                   [isinstance(t, Translation) for t in translations]),
+        self.assertIsInstance(translations, list,
+            'Translations is not a list!')
+        self.assertTrue(len(translations) > 0,
+            'Translations list is empty!')
+        self.assertTrue(all(isinstance(t, Translation) for t in translations),
             'Items are not all instance of Translation')
 
     def test_order_post(self):
         order = self.api.post_order()
         self.assertIsInstance(order, Order, 'Result is not an Order')
         self.assertIsNotNone(order.id, 'ID is None')
-        self.assertEqual(order.status, 'new', 'Order status is not new')
         self.assertEqual(order.price, 0, 'Price is not 0')
 
-
     def test_job_add_job_to_order(self):
         order = self.api.post_order()
 
@@ -142,7 +137,6 @@ def test_job_add_job_to_order(self):
         job = self.api.post_job(**data)
         self.assertIsInstance(job, Job)
         self.assertEqual(job.order_id, order.id, 'Order ID is not equal')
-        self.assertEqual(job.status, 'built', 'Job status is not built')
         self.assertEqual(job.text, data['text'], 'Job text is not correct')
         self.assertEqual(job.source_language, data['source_language'],
                          'Job source_language is not correct')
@@ -185,9 +179,37 @@ def test_job_add_job_to_order_all_params(self):
         job = self.api.post_job(**data)
         self.assertIsInstance(job, Job)
         self.assertEqual(job.order_id, order.id, 'Order ID is not equal')
-        self.assertEqual(job.status, 'built', 'Job status is not built')
         self.assertEqual(job.text, data['text'], 'Job text is not correct')
         self.assertEqual(job.source_language, data['source_language'],
                          'Job source_language is not correct')
         self.assertEqual(job.target_language, data['target_language'],
                          'Job target_language is not correct')
+
+    def test_job_no_balance(self):
+        self.UNBABEL_TEST_USERNAME="gracaninja-1"
+        self.UNBABEL_TEST_API_KEY="d004dd5659e177d11ef9c22798b767a264f74b17"
+        if hasattr(self, '_api'): delattr(self, '_api')
+
+        data = {
+            'text': "This is a test translation",
+            'source_language': 'en',
+            'target_language': 'pt',
+            'ttype': 'paid'
+        }
+
+        self.assertEqual(self.api.username,"gracaninja-1","API Username not correct %s"%self.api.username)
+        self.assertEqual(self.api.api_key,"d004dd5659e177d11ef9c22798b767a264f74b17","API key not correct %s"%self.api.api_key)
+
+        translation = self.api.post_translations(**data)
+        self.assertEqual(translation.status, "insufficient_balance", 'Job status not insufficient_balance but %s'%translation.status)
+
+        self.UNBABEL_TEST_USERNAME = os.environ.get('UNBABEL_TEST_USERNAME')
+        self.UNBABEL_TEST_API_KEY = os.environ.get('UNBABEL_TEST_API_KEY')
+        if hasattr(self, '_api'): delattr(self, '_api')
+
+    def test_pay_order(self):
+        order = self.api.post_order()
+        self.assertTrue(self.api.pay_order(order.id))
+
+if __name__ == "__main__":
+     unittest.main()

unbabel/__init__.py

@@ -1,3 +1,4 @@
+import unbabel.api
 
 LOG_CONFIG = {
     'version': 1,

unbabel/abc.py

@@ -0,0 +1,102 @@
+"""Abstract base classes. Mainly Pythonic container objects from JSON."""
+
+class NamedObject(object):
+    """Abstract object that has a name and its name is the __repr__ and __str__."""
+    def __init__(self, name):
+        self.name
+    def __repr__(self):
+        return self.name
+    def __str__(self):
+        return self.name
+
+
+class Language(NamedObject):
+    def __init__(self, shortname, name):
+        super(Language, self).__init__(name=name)
+        self.shortname = shortname
+
+
+class Tone(NamedObject):
+    def __init__(self, description, name):
+        super(Language, self).__init__(name=name)
+        self.description = description
+
+
+class Topic(NamedObject):
+    def __init__(self, name):
+        super(Language, self).__init__(name=name)
+
+
+class LangPair(NamedObject):
+    def __init__(self, source_language, target_language):
+        name = "{}_{}".format(source_language, target_language)
+        super(Language, self).__init__(name=name)
+        self.source_language = source_language
+        self.target_language = target_language
+
+
+class Translator(object):
+    def __init__(self, first_name="", last_name="",
+                 picture_url="", profile_url=""):
+        self.first_name = first_name
+        self.last_name = last_name
+        self.picture_url = picture_url
+        self.profile_url = profile_url
+
+    @classmethod
+    def from_json(cls, json_object):
+        return Translator(json_object["first_name"],  json_object["last_name"],
+                          json_object["picture_url"], json_object["profile_url"])
+
+
+class UnicodeReprObject:
+    """Abstract object that suports unicode representation objects."""
+    def __init__(self):
+        pass
+    def __repr__(self):
+        return self._repr
+    def __str__(self):
+        return self._repr
+    def __unicode__(self):
+        return self._repr
+
+
+class Account(UnicodeReprObject):
+    def __init__(self, username, email, balance):
+        self.username = username
+        self.email = email
+        self.balance = balance
+        # For __unicode__
+        self._repr = u'email: {email}, balance: {balance}'.format(
+                        email=self.email, balance=self.balance)
+
+
+class Job(UnicodeReprObject):
+    def __init__(self, id, uid, order_id, status, source_language,
+                 target_language,
+                 text, price, tone, text_format):
+        self.id = id
+        self.uid = uid
+        self.order_id = order_id
+        self.status = status
+        self.text = text
+        self.price = price
+        self.source_language = source_language
+        self.target_language = target_language
+        self.tone = tone
+        self.text_format = text_format
+        # For __unicode__
+        self._repr = u'order_id: {}, id: {}, status: {}'.format(self.order_id, self.id, self.status)
+
+
+class Order(UnicodeReprObject):
+    def __init__(self, id, status, price):
+        self.id = id
+        self.status = status
+        self.price = price
+        # For __unicode__
+        self._repr = u'{id} - {status} - {price}'.format(id=self.id, status=self.status, price=self.price)
+
+
+__all__ = ['Language', 'Tone', 'Topic', 'LangPair',
+           'Translator', 'Account', 'Job', 'Order']