initial commit

Author: mattbanister

.gitignore

@@ -0,0 +1,3 @@
+.idea
+.DS_Store
+*.pyc

INSTALL.md

@@ -0,0 +1,10 @@
+Installation
+============
+
+To install simply (preferably in a virtualenv):
+
+    $ pip install -r requirements.txt
+
+To run the example:
+
+    $ python example.py

README.md

@@ -0,0 +1,29 @@
+Diffbot Python API Client
+=========
+
+Currently supports calls to the article endpoint.
+
+
+Installation
+-----------
+To install simply (preferably in a virtualenv):
+
+    $ pip install -r requirements.txt
+
+To run the example:
+
+    $ python example.py
+
+Example use
+--------------
+An example of how to use the client in your code:
+
+```
+diffbot = DiffbotClient()
+url = "http://shichuan.github.io/javascript-patterns/"
+token = "3c66f28f72ea40c1b02e6a4cc195b07e"
+api = "article"
+version = 2
+
+response = diffbot.request(url, token, api, version=2)
+```

client.py

@@ -0,0 +1,25 @@
+import requests
+
+class DiffbotClient:
+    def __init__(self):
+        pass
+
+    def request(self, url, token, api, fields=[], version=2):
+        """
+        Returns a python object containing the requested resource from the diffbot api
+        """
+        params = {"url": url, "token": token}
+        response = requests.get(self.get_url(api, version), params=params)
+        obj = response.json()
+        if fields:
+            obj = dict( (x, obj[x]) for x in fields)
+        return obj
+
+    def get_url(self, api, version):
+        """
+        Returns the uri for an endpoint as a string
+        """
+        base_url = "http://api.diffbot.com/"
+        version = "v" + str(version)
+        url = base_url + version + "/" + api
+        return url

example.py

@@ -0,0 +1,14 @@
+from client import DiffbotClient
+import pprint
+
+diffbot = DiffbotClient()
+url = "http://shichuan.github.io/javascript-patterns/"
+token = "3c66f28f72ea40c1b02e6a4cc195b07e"
+api = "article"
+version = 2
+
+print "Calling article API endpoint on the url: http://shichuan.github.io/javascript-patterns/...\n"
+response = diffbot.request(url, token, api, version=2)
+print "\nPrinting response:\n"
+pp = pprint.PrettyPrinter(indent=4)
+print pp.pprint(response)

requirements.txt

@@ -0,0 +1,5 @@
+mock==1.0.1
+nose==1.3.0
+requests==2.1.0
+simplejson==3.3.1
+wsgiref==0.1.2

test.py

@@ -0,0 +1,31 @@
+import os
+import unittest
+from client import DiffbotClient
+from mock import patch
+import simplejson
+
+def fake_request(client, api):
+    resource_file = os.path.normpath('test_fixtures/%s.json' % api)
+    with open(resource_file, mode='rb') as file:
+        json = file.read()
+    return simplejson.loads(json)
+
+
+class TestDiffbotClient(unittest.TestCase):
+
+    def setUp(self):
+        self.patcher = patch('client.DiffbotClient.request', fake_request)
+        self.patcher.start()
+        self.client = DiffbotClient()
+
+    def tearDown(self):
+        self.patcher.stop()
+
+    def test_request_for_article(self):
+        api = "article"
+        response = self.client.request(api)
+        self.assertIn('text', response)
+        self.assertEqual(response['meta']['title'], 'JavaScript Patterns')
+
+if __name__ == '__main__':
+    unittest.main()