refactor examples (#8)

* refactor examples

Author: shuisman

README.MD

@@ -1,4 +1,4 @@
-##Usabilla API - Python Client
+#Usabilla API - Python Client
 
 [![Build Status](https://travis-ci.org/usabilla/api-python.svg?branch=master)](https://travis-ci.org/usabilla/api-python)
 [![PyPI version](https://badge.fury.io/py/usabilla-api.svg)](https://badge.fury.io/py/usabilla-api)
@@ -26,42 +26,24 @@ It makes use of the API to request the following products and resources:
 
 For more information on resources, authorization and available API calls, please visit out [documentation](https://usabilla.com/api).
 
-# Installation:
+## Installation:
 
 Requires Python 2.7
 
 ```bash
 pip install usabilla-api
 ```
 
-# Buttons example:
-```python
->>> import usabilla as ub
->>> api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
->>> api.set_query_parameters({'limit' : 1})
->>> buttons = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES,api.RESOURCE_BUTTON)
->>> print buttons
-```
+## Examples:
+The example folder contains an  example of the client, which gives an idea how the client can be used and what is possible.
+
 
-### Iterators
+## Iterators
 
 When working with the <code>limit</code> parameters (default value is **100**) you can request resources using the <code>item_iterator()</code> function.
 The API returns data in pages. This function returns a [Generator](https://wiki.python.org/moin/Generators) which
 traverses these pages for you and yields each result in the current page before retrieving the next page.
 
-## Feedback example
-
-```python
->>> import usabilla as ub
->>> import json
->>> api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
->>> api.set_query_parameters({'limit' : 1})
->>> feedbackItems = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES,api.RESOURCE_FEEDBACK,'*',iterate=True)
->>> print json.dumps([item for item in feedbackItems], indent=4)
-```
-
-Where <code>id</code> is the button id from which the feedback originates.
-
 ##Support
 
 The Usabilla Python Client API is maintained by Usabilla Development Team. Everyone is encouraged to file bug reports, feature requests, and pull requests through GitHub. This input is critical and will be carefully considered, but we can’t promise a specific resolution or time frame for any request. For more information please email our Support Team at support@usabilla.com

example/examples_apps.py

@@ -0,0 +1,29 @@
+"""Example Usabilla for Apps"""
+
+import usabilla as ub
+
+from datetime import datetime, timedelta
+
+if __name__ == '__main__':
+    # Create an API client with access key and secret key
+    api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
+
+    # Set the limit of buttons to retrieve to 1
+    if False:
+    	api.set_query_parameters({'limit': 1})
+
+    # Set a limit for last 7 days
+    if False:
+        epoch = datetime(1970, 1, 1)
+        since = timedelta(days=7)
+        since_unix = (datetime.utcnow() - since - epoch).total_seconds() * 1000
+        api.set_query_parameters({'since': since_unix})
+
+    # Get all apps forms for this account
+    forms = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_APPS, api.RESOURCE_APP)
+    first_form = forms['items'][0]
+    print first_form['name']
+
+    # Get the feedback of the first app form
+    feedback = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_APPS, api.RESOURCE_FEEDBACK, first_form['id'], iterate=True)
+    print len([item for item in feedback])

example/examples_email.py

@@ -0,0 +1,16 @@
+"""Example Usabilla for Email"""
+
+import usabilla as ub
+
+if __name__ == '__main__':
+    # Create an API client with access key and secret key
+    api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
+
+    # Get all email widgets for this account
+    widgets = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_EMAIL, api.RESOURCE_BUTTON)
+    first_widget = widgets['items'][0]
+    print first_widget['name']
+
+    # Get the feedback of the first email widget
+    feedback = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_EMAIL, api.RESOURCE_FEEDBACK, first_widget['id'], iterate=True)
+    print len([item for item in feedback])

example/examples_websites.py

@@ -0,0 +1,34 @@
+"""Examples Usabilla for Websites"""
+
+import usabilla as ub
+
+if __name__ == '__main__':
+    # Create an API client with access key and secret key
+    api = ub.APIClient('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY')
+
+    # Get all buttons for this account
+    buttons = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES,api.RESOURCE_BUTTON)
+    first_button = buttons['items'][0]
+    print first_button['name']
+
+    # Get the feedback items for the first button of the list
+    feedback_items = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES, api.RESOURCE_FEEDBACK, first_button['id'], iterate=True)
+    print len([item for item in feedback_items])
+
+    # ---------------------------------------
+    # Get all campaigns for this account
+    campaigns = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES, api.RESOURCE_CAMPAIGN)
+    first_campaign = campaigns['items'][0]
+    print first_campaign['name']
+
+    # Get the responses of the first campaign
+    responses = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES, api.RESOURCE_CAMPAIGN_RESULT, first_campaign['id'], iterate=True)
+    print len([item for item in responses])
+
+    # Get the stats of the first campaign
+    stats = api.get_resource(api.SCOPE_LIVE, api.PRODUCT_WEBSITES, api.RESOURCE_CAMPAIGN_STATS, first_campaign['id'])
+    print stats
+
+
+    # ---------------------------------------
+    # in-page is not yet available