Skip to content

Commit b8a1be1

Browse files
committed
Fix everything; Bump ver. 0.2.0
1 parent 870e07a commit b8a1be1

File tree

7 files changed

+230
-212
lines changed

7 files changed

+230
-212
lines changed

README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,50 +6,46 @@ TypeForm API wrapper written in python.
66
pip install typeform-python
77
```
88

9-
## Requirements
10-
- requests
11-
12-
139
## Usage
14-
### Simple access with API KEY
1510
```
1611
from typeform.client import Client
1712
18-
client = Client('API_KEY')
13+
client = Client('CLIENT_KEY', 'CLIENT_SECRET')
14+
```
15+
16+
Get authorization url
1917
```
20-
### Authorized Access
18+
url = client.authorization_url('REDIRECT_URI', ['forms:write', 'forms:read'])
2119
```
22-
from typeform.client import Client
23-
client = Client('TOKEN')
2420

25-
To get the TOKEN follow the documentation
26-
27-
https://developer.typeform.com/get-started/scopes/
21+
Exchange the code for a token
22+
```
23+
token = client.exchange_code('REDIRECT_URI', 'CODE')
2824
```
2925

30-
Get form ID
26+
Set the token
3127
```
32-
client.get_form_uid('URL_FORM')
28+
client.set_access_token('TOKEN')
3329
```
3430

35-
Get form information
31+
Get form ID
3632
```
37-
client.get_form_information('UID, URL')
33+
client.get_form_uid('FORM_URL')
3834
```
3935

40-
Get form stats
36+
Get form information
4137
```
42-
client.get_form_stats('UID, URL')
38+
client.get_form_information('FORM_UID')
4339
```
4440

4541
Get form questions
4642
```
47-
client.get_form_questions('UID, URL')
43+
client.get_form_questions('FORM_UID')
4844
```
4945

5046
Get form metadata
5147
```
52-
client.get_form_metadata('UID, URL')
48+
client.get_form_metadata('FORM_UID', 'SINCE', 'UNTIL')
5349
```
5450

5551
Get all forms
@@ -59,18 +55,22 @@ client.get_forms()
5955

6056
Create Webhook
6157
```
62-
client.create_webhook(url_webhook, tag_webhook, uid)
58+
client.create_webhook('WEBHOOK_URL', 'WEBHOOK_TAG', 'FORM_UID')
6359
```
64-
Delete Webhook
60+
61+
View Webhook
6562
```
66-
client.create_webhook(tag_webhook, uid)
63+
client.view_webhook('WEBHOOK_TAG', 'FORM_UID')
6764
```
6865

69-
View Webhook
66+
Delete Webhook
7067
```
71-
client.create_webhook(tag_webhook, uid)
68+
client.delete_webhook('WEBHOOK_TAG', 'FORM_UID')
7269
```
7370

71+
## Requirements
72+
- requests
73+
7474
## TODO
7575
- create_form
7676
- Update_form

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ def read(fname):
77

88

99
setup(name='typeform-python',
10-
version='0.1.1',
10+
version='0.2.0',
1111
description='API wrapper for Typeform written in Python',
1212
long_description=read('README.md'),
1313
url='https://github.com/GearPlug/typeform-python',

tests/test_client.py

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,31 @@
11
import os
2-
from unittest import TestCase
3-
from typeform.client import Client, ClientAuth
42
from datetime import datetime, timedelta
3+
from unittest import TestCase
4+
5+
from typeform.client import Client
56

67

78
class TypeformTestCases(TestCase):
89
def setUp(self):
9-
self.access_token = os.environ.get('token')
10-
self.api_key = os.environ.get('apikey')
11-
self.form_id = os.environ.get('form_id')
12-
self.url_webhook = os.environ.get('url_webhook')
13-
self.client=Client(access_token=self.access_token)
10+
self.client_id = os.environ.get('CLIENT_ID')
11+
self.client_secret = os.environ.get('CLIENT_SECRET')
12+
self.access_token = os.environ.get('ACCESS_TOKEN')
13+
self.form_id = os.environ.get('FORM_ID')
14+
self.webhook_url = os.environ.get('WEBHOOK_URL')
15+
self.client = Client(self.client_id, self.client_secret)
16+
self.client.set_access_token(self.access_token)
1417

1518
def test_create_webhook(self):
16-
result_create = self.client.create_webhook(url_webhook=self.url_webhook,uid=self.form_id, tag_webhook=1)
17-
result_view = self.client.view_webhook(tag_webhook=1, uid=self.form_id)
18-
self.client.delete_webhook(tag_webhook=1, uid=self.form_id)
19-
self.assertEqual(result_create['id'],result_view['id'])
19+
result_create = self.client.create_webhook(webhook_url=self.webhook_url, form_uid=self.form_id, webhook_tag=1)
20+
result_view = self.client.view_webhook(form_uid=self.form_id, webhook_tag=1)
21+
self.client.delete_webhook(form_uid=self.form_id, webhook_tag=1)
22+
self.assertEqual(result_create['id'], result_view['id'])
2023

2124
def test_delete_webhook(self):
22-
result_create = self.client.create_webhook(url_webhook=self.url_webhook,uid=self.form_id, tag_webhook=1)
23-
self.client.delete_webhook(tag_webhook=1, uid=self.form_id)
24-
try:
25-
result_view = self.client.view_webhook(tag_webhook=1, uid=self.form_id)
26-
result = False
27-
except:
28-
result = True
29-
self.assertTrue(result)
25+
result_create = self.client.create_webhook(webhook_url=self.webhook_url, form_uid=self.form_id, webhook_tag=1)
26+
self.client.delete_webhook(webhook_tag=1, form_uid=self.form_id)
27+
result_view = self.client.view_webhook(form_uid=self.form_id, webhook_tag=1)
28+
self.assertFalse(result_view)
3029

3130
def test_get_forms(self):
3231
result = self.client.get_forms()
@@ -37,25 +36,19 @@ def test_get_forms(self):
3736
self.assertEqual(_form, self.form_id)
3837

3938
def test_get_form_information(self):
40-
result = self.client.get_form_information(uid=self.form_id)
39+
result = self.client.get_form_information(form_uid=self.form_id)
4140
self.assertIsInstance(result, dict)
4241
self.assertEqual(result['id'], self.form_id)
4342

4443
def test_get_form_questions(self):
45-
result = self.client.get_form_questions(uid=self.form_id)
44+
result = self.client.get_form_questions(form_uid=self.form_id)
4645
self.assertIsInstance(result, list)
4746
self.assertIn('title', result[0])
4847

4948
def test_get_form_metadata(self):
5049
since = (datetime.utcnow() - timedelta(days=1)).isoformat()
5150
until = datetime.utcnow().isoformat()
52-
result = self.client.get_form_metadata(uid=self.form_id, since=since, until=until)
51+
result = self.client.get_form_metadata(form_uid=self.form_id, since=since, until=until)
5352
self.assertIsInstance(result, list)
54-
self.assertIsInstance(result[0],dict)
53+
self.assertIsInstance(result[0], dict)
5554
self.assertIn('answers', result[0])
56-
57-
58-
59-
60-
61-

0 commit comments

Comments
 (0)