Merge pull request #1 from bcongdon/all-emoji

Support for Emojipedia.all(), Test Fixes

Author: bcongdon

.codeclimate.yml

@@ -12,6 +12,8 @@ engines:
     enabled: true
   radon:
     enabled: true
+    exclude_paths:
+      - "test_emojipedia.py"
 ratings:
   paths:
   - "**.inc"

.travis.yml

@@ -6,7 +6,9 @@ python:
   - "3.6"
 install: 
   - "pip install -r requirements.txt"
-  - "pip install pep8"
+  - "pip install -r test_requirements.txt"
 script:
   - pep8 emojipedia/ test_emojipedia.py
-  - nosetests
+  - nosetests --with-coverage --cover-package=emojipedia
+after_sucess:
+  - CODECLIMATE_REPO_TOKEN=$COVERAGE_TOKEN codeclimate-test-reporter

README.md

@@ -2,6 +2,7 @@
 [![Build Status](https://travis-ci.org/bcongdon/python-emojipedia.svg?branch=master)](https://travis-ci.org/bcongdon/python-emojipedia)
 [![Code Climate](https://codeclimate.com/github/bcongdon/python-emojipedia/badges/gpa.svg)](https://codeclimate.com/github/bcongdon/python-emojipedia)
 [![PyPI version](https://badge.fury.io/py/Emojipedia.svg)](https://badge.fury.io/py/Emojipedia)
+[![Test Coverage](https://codeclimate.com/github/bcongdon/python-emojipedia/badges/coverage.svg)](https://codeclimate.com/github/bcongdon/python-emojipedia/coverage)
 >Emoji data from Emojipedia :sunglasses:
 
 ## Installation:
@@ -22,22 +23,45 @@ from emojipedia import Emojipedia
 taco = Emojipedia.search('taco')
 
 # Emojipedia description
-print taco.description # "A taco; a Mexican food item displayed with a variety of fillings. ..."
+print(taco.description)  # "A taco; a Mexican food item displayed with a variety of fillings. ..."
 
 # Emojipedia codepoints
-print taco.codepoints # "U+1F32E"
+print(taco.codepoints)  # "U+1F32E"
 
 # Emojipedia listed platforms 
 # Contains title, Emojipedia platform url, and platform specific emoji img url
 platforms = taco.platforms 
-print platforms[0] # {'title': 'Apple', 'platform_url': '...', 'platform_img': '...'}
+print(platforms[0])  # {'title': 'Apple', 'platform_url': '...', 'platform_img': '...'}
 
 joy = Emojipedia.search('face-with-tears-of-joy')
 # Emoji shortcodes
-joy.shortcodes # ":joy:"
+joy.shortcodes  # ":joy:"
 
 # Search for emoji by emoji
 smirk = Emojipedia.search('😏')
 # Custom Emoji string preview
-print str(smirk) # <Emoji - 'Smirking Face' - character: 😏, description: A sly smile, often u...>
+print(str(smirk))  # <Emoji - 'Smirking Face' - character: 😏, description: A sly smile, often u...>
+
+# Get a category of emoji
+people = Emojipedia.category('people')
+people[0].title  # <Emoji - 'Grinning Face' - character: 😀, description: A face with a big op...>
+print(len(people))  # 306
+
+# Get all the emoji
+emojis = Emojipedia.all()
+print(len(emojis))  # 2621
+for emoji in emojis:
+    print(emoji.title)
 ```
+
+## Contributing
+
+Contributions to `python-emojipedia` are welcomed! 😁
+
+1. Fork the repo.
+2. Create a new feature branch.
+3. Add your feature / make your changes.
+4. Install [pep8](https://pypi.python.org/pypi/pep8) and run `pep8 *.py` in the root project directory to lint your changes. Fix any linting errors.
+5. Create a PR.
+6. ???
+7. 🎉 Profit. 🎉

emojipedia/__init__.py

@@ -1 +1 @@
-from .emojipedia import Emojipedia
+from .emojipedia import Emojipedia, Emoji

emojipedia/emoji.py

@@ -1,5 +1,7 @@
 from bs4 import BeautifulSoup
 import requests
+import re
+import six
 
 
 class Emoji:
@@ -18,9 +20,32 @@ def __init__(self, soup=None, url=None):
         self._shortcodes = None
         self._title = None
 
+    def _get_emoji_article_url(self):
+        response = requests.get('http://emojipedia.org' + self._url)
+        if response.status_code != 200:
+            raise RuntimeError('Could not get emojipedia page for '
+                               "'{}'".format(self._url))
+
+        soup = BeautifulSoup(response.text, 'html.parser')
+        desc = soup.find('td', text=re.compile('Description'))
+
+        if not desc:
+            raise ValueError('Could not parse emoji description')
+
+        article_url = desc.parent.find_next('a')
+        if not article_url:
+            raise ValueError('Could not find emoji article')
+
+        return article_url['href']
+
     @property
     def soup(self):
         if not self._soup:
+            # Check to see if we've given a general emoji page
+            if 'emoji/' in self._url:
+                # Resolve to emoji article
+                self._url = self._get_emoji_article_url()
+
             response = requests.get('http://emojipedia.org' + self._url)
             if response.status_code != 200:
                 raise RuntimeError('Could not get emojipedia page for \'{0}\''
@@ -98,12 +123,15 @@ def character(self):
             self._character = self.soup.find('h1').text.split()[0]
         return self._character
 
-    def __str__(self):
+    def __unicode__(self):
         string = u"<Emoji - '{0}' - character: {2}, description: {1}>"
         string = string.format(self.title,
-                               self.description[:20] + "...",
+                               self.description[:20] + u"...",
                                self.character)
         return string
 
+    def __str__(self):
+        return six.text_type(self.__unicode__()).encode('utf-8')
+
     def __repr__(self):
         return self.__str__()

emojipedia/emojipedia.py

@@ -36,6 +36,24 @@ def category(query):
             emojis.append(e)
         return emojis
 
+    @staticmethod
+    def all():
+        soup = Emojipedia._get_page('emoji')
+        emoji_list = soup.find('table', {'class': 'emoji-list'})
+        if not emoji_list:
+            raise ValueError('Could not extract emoji list')
+        emojis = []
+        for emoji_entry in emoji_list.find_all('tr'):
+            emoji_link = emoji_entry.find('a')
+            emoji_text = emoji_link.text.split(' ')
+            emoji_row, codepoints = emoji_entry.find_all('td')
+
+            e = Emoji(url=emoji_link['href'])
+            e._codepoints = codepoints.text.split(', ')
+            e._character, e._title = emoji_text[0], ' '.join(emoji_text[1:])
+            emojis.append(e)
+        return emojis
+
     @staticmethod
     def _valid_emoji_page(soup):
         """

test_emojipedia.py

@@ -1,7 +1,9 @@
 # -*- coding: utf-8 -*-
 
-from emojipedia import Emojipedia
+from emojipedia import Emojipedia, Emoji
 import nose.tools
+from nose.tools import timed
+from nose import run
 
 
 @nose.tools.raises(RuntimeError)
@@ -79,13 +81,41 @@ def test_emoji_repr():
     pizza = Emojipedia.search('slice-of-pizza')
     correct = (u"<Emoji - 'Pizza' - character: 🍕, "
                u"description: A slice  of pizza, w...>")
-    print(type(correct))
-    print(type(pizza.__str__()))
-    assert pizza.__str__() == correct
+    assert pizza.__unicode__() == correct
+    assert pizza.__repr__() == pizza.__str__()
 
 
 def test_emoji_category():
     people = Emojipedia.category('people')
     for e in people:
         assert e.title
         assert e.character
+
+
+@timed(5)
+def test_all_emoji():
+    all_emoji = Emojipedia.all()
+    assert len(all_emoji) >= 2621
+    for e in all_emoji:
+        # Test private properties so we don't scrape Emojipedia
+        # if this fails
+        assert e._title
+        assert e._character
+        assert e._codepoints
+
+
+def test_lazy_parsing_article():
+    article_emoji = Emoji(url='/heavy-plus-sign')
+    assert article_emoji.title
+    assert article_emoji.character
+    assert article_emoji.description
+    assert article_emoji.codepoints
+
+    generic_emoji = Emoji(url=u'/emoji/🌮')
+    assert generic_emoji.title
+    assert generic_emoji.character
+    assert generic_emoji.description
+    assert generic_emoji.codepoints
+
+if __name__ == '__main__':
+    run()

test_requirements.txt

@@ -0,0 +1,3 @@
+codeclimate-test-reporter==0.1.0
+coverage==4.0.2
+pep8==1.7.0