Merge pull request #7 from tbsf/original

FIX for forgetting to import utils, add tests, add graph_api/user_profile_api

Author: drice

pymessenger/bot.py

@@ -1,21 +1,16 @@
 import json
+
 import requests
 from requests_toolbelt import MultipartEncoder
 
-DEFAULT_API_VERSION = 2.6
+from pymessenger.graph_api import FacebookGraphApi
+import pymessenger.utils as utils
+
 
-class Bot(object):
-    def __init__(self, access_token, api_version=DEFAULT_API_VERSION, app_secret=None):
-        self.api_version = api_version
-        self.access_token = access_token
-        self.base_url = (
-            "https://graph.facebook.com"
-            "/v{0}/me/messages?access_token={1}"
-        ).format(self.api_version, access_token)
+class Bot(FacebookGraphApi):
 
-        if app_secret is not None:
-            appsecret_proof = generate_appsecret_proof(access_token, app_secret)
-            self.base_url += '&appsecret_proof={0}'.format(appsecret_proof)
+    def __init__(self, *args, **kwargs):
+        super(Bot, self).__init__(*args, **kwargs)
 
     def send_text_message(self, recipient_id, message):
         payload = {
@@ -72,10 +67,6 @@ def send_button_message(self, recipient_id, text, buttons):
         }
         return self._send_payload(payload)
 
-    def _send_payload(self, payload):
-        result = requests.post(self.base_url, json=payload).json()
-        return result
-
     def send_image(self, recipient_id, image_path):
         '''
             This sends an image to the specified recipient.
@@ -135,3 +126,15 @@ def send_image_url(self, recipient_id, image_url):
             )
         }
         return self._send_payload(payload)
+
+    def _send_payload(self, payload):
+        request_endpoint = '{0}/me/messages'.format(self.graph_url)
+        response = requests.post(
+            request_endpoint,
+            params=self.auth_args,
+            json=payload
+        )
+        result = response.json()
+        return result
+
+

pymessenger/graph_api.py

@@ -0,0 +1,30 @@
+import pymessenger.utils as utils
+
+DEFAULT_API_VERSION = 2.6
+
+class FacebookGraphApi(object):
+    def __init__(self, access_token, **kwargs):
+        '''
+            @required:
+                access_token
+            @optional:
+                api_version
+                app_secret
+        '''
+
+        self.api_version = kwargs.get('api_version') or DEFAULT_API_VERSION
+        self.app_secret = kwargs.get('app_secret')
+        self.graph_url = 'https://graph.facebook.com/v{0}'.format(self.api_version)
+        self.access_token = access_token
+
+    @property
+    def auth_args(self):
+        if not hasattr(self, '_auth_args'):
+            auth = {
+                'access_token': self.access_token
+            }
+            if self.app_secret is not None:
+                appsecret_proof = utils.generate_appsecret_proof(self.access_token, self.app_secret)
+                auth['appsecret_proof'] = appsecret_proof
+            self._auth_args = auth
+        return self._auth_args

pymessenger/user_profile.py

@@ -0,0 +1,18 @@
+import requests
+
+from pymessenger.graph_api import FacebookGraphApi
+    
+class UserProfileApi(FacebookGraphApi):
+    def get(self, user_id, fields=None):
+        params = {}
+        if fields is not None and isinstance(fields, (list, tuple)):
+            params['fields'] = ",".join(fields)
+
+        params.update(self.auth_args)
+
+        request_endpoint = '{0}/{1}'.format(self.graph_url, user_id)
+        response = requests.get(request_endpoint, params=params)
+        if response.status_code == 200:
+            user_profile = response.json()
+            return user_profile
+        return None

test/message_test.py

@@ -1,10 +1,13 @@
 import sys, os
 sys.path.append(os.path.realpath(os.path.dirname(__file__)+"/.."))
+
 from pymessenger.bot import Bot as PyBot
-from pymessenger import Element
+from pymessenger import Element, Button
 
 TOKEN = os.environ.get('TOKEN')
-bot = PyBot(TOKEN)
+APP_SECRET = os.environ.get('APP_SECRET')
+
+bot = PyBot(TOKEN, app_secret=APP_SECRET)
 recipient_id = os.environ.get('RECIPIENT_ID')
 
 def test_wrong_format_message():
@@ -17,3 +20,32 @@ def test_text_message():
     assert type(result) is dict
     assert result.get('message_id') is not None
     assert result.get('recipient_id') is not None
+
+def test_elements():
+    image_url = 'https://lh4.googleusercontent.com/-dZ2LhrpNpxs/AAAAAAAAAAI/AAAAAAAA1os/qrf-VeTVJrg/s0-c-k-no-ns/photo.jpg'
+    elements = []
+    element = Element(title="Arsenal", image_url=image_url, subtitle="Click to go to Arsenal website.", item_url="http://arsenal.com")
+    elements.append(element)
+    result = bot.send_generic_message(recipient_id, elements)
+    assert type(result) is dict
+    assert result.get('message_id') is not None
+    assert result.get('recipient_id') is not None
+
+def test_image_url():
+    image_url = 'https://lh4.googleusercontent.com/-dZ2LhrpNpxs/AAAAAAAAAAI/AAAAAAAA1os/qrf-VeTVJrg/s0-c-k-no-ns/photo.jpg'
+    result = bot.send_image_url(recipient_id, image_url)
+    assert type(result) is dict
+    assert result.get('message_id') is not None
+    assert result.get('recipient_id') is not None
+
+def test_button_message():
+    buttons = []
+    button = Button(title='Arsenal', type='web_url', url='http://arsenal.com')
+    buttons.append(button)
+    button = Button(title='Other', type='postback', payload='other')
+    buttons.append(button)
+    text='Select'
+    result = bot.send_button_message(recipient_id, text, buttons)
+    assert type(result) is dict
+    assert result.get('message_id') is not None
+    assert result.get('recipient_id') is not None

test/user_profile_test.py

@@ -0,0 +1,21 @@
+import json
+import sys, os
+sys.path.append(os.path.realpath(os.path.dirname(__file__)+"/.."))
+
+from pymessenger.user_profile import UserProfileApi
+
+TOKEN = os.environ.get('TOKEN')
+APP_SECRET = os.environ.get('APP_SECRET')
+TEST_USER_ID = os.environ.get('RECIPIENT_ID')
+
+upa = UserProfileApi(TOKEN, app_secret=APP_SECRET)
+
+def test_fields_blank():
+    user_profile = upa.get(TEST_USER_ID)
+    assert user_profile is not None
+
+def test_fields():
+    fields = ['first_name', 'last_name']
+    user_profile = upa.get(TEST_USER_ID, fields=fields)
+    assert user_profile is not None
+    assert len(user_profile.keys()) == len(fields)