Skip to content

Commit bdc3e3f

Browse files
guiajlopesguiajlopes
committed
Update examples to receive arguments instead of hardcoded constants
1 parent fb947c2 commit bdc3e3f

11 files changed

Lines changed: 91 additions & 235 deletions

‎examples/conversation_create_message.py‎

Lines changed: 10 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,20 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
3+
import argparse
64
import messagebird
75
from messagebird.conversation_message import MESSAGE_TYPE_TEXT
86

9-
# ACCESS_KEY = ''
10-
# CONVERSATION_ID = ''
11-
# CHANNEL_ID = ''
12-
# TEXT_MESSAGE = ''
13-
14-
try:
15-
ACCESS_KEY
16-
except NameError:
17-
print('You need to set an ACCESS_KEY constant in this file')
18-
sys.exit(1)
19-
20-
try:
21-
CONVERSATION_ID
22-
except NameError:
23-
print('You need to set a CONVERSATION_ID constant in this file')
24-
sys.exit(1)
25-
26-
try:
27-
CHANNEL_ID
28-
except NameError:
29-
print('You need to set a CHANNEL_ID constant in this file')
30-
sys.exit(1)
31-
32-
try:
33-
TEXT_MESSAGE
34-
except NameError:
35-
print('You need to set a TEXT_MESSAGE constant in this file')
36-
sys.exit(1)
7+
parser = argparse.ArgumentParser()
8+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
9+
parser.add_argument('--conversationId', help='conversation ID that you want to create a message for', type=str, required=True)
10+
parser.add_argument('--channelId', help='channel ID that you want to create a message for', type=str, required=True)
11+
parser.add_argument('--message', help='message that you want to send', type=str, required=True)
12+
args = vars(parser.parse_args())
3713

3814
try:
39-
client = messagebird.Client(ACCESS_KEY)
15+
client = messagebird.Client(args['accessKey'])
4016

41-
msg = client.conversation_create_message(CONVERSATION_ID, { 'channelId': CHANNEL_ID, 'type': MESSAGE_TYPE_TEXT, 'content': { 'text': TEXT_MESSAGE } })
17+
msg = client.conversation_create_message(args['conversationId'], { 'channelId': args['channelId'], 'type': MESSAGE_TYPE_TEXT, 'content': { 'text': args['message'] } })
4218

4319
# Print the object information.
4420
print('\nThe following information was returned as a Conversation List object:\n')

‎examples/conversation_create_webhook.py‎

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,24 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
3+
import argparse
64
import messagebird
75
from messagebird.conversation_webhook import \
86
CONVERSATION_WEBHOOK_EVENT_CONVERSATION_CREATED,\
97
CONVERSATION_WEBHOOK_EVENT_CONVERSATION_UPDATED
108

11-
# ACCESS_KEY = ''
12-
# CHANNEL_ID = ''
13-
14-
try:
15-
ACCESS_KEY
16-
except NameError:
17-
print('You need to set an ACCESS_KEY constant in this file')
18-
sys.exit(1)
19-
20-
try:
21-
CHANNEL_ID
22-
except NameError:
23-
print('You need to set an CHANNEL_ID constant in this file')
24-
sys.exit(1)
9+
parser = argparse.ArgumentParser()
10+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
11+
parser.add_argument('--channelId', help='channel that you want create the webhook', type=str, required=True)
12+
parser.add_argument('--url', help='url for the webhook', type=str)
13+
args = vars(parser.parse_args())
2514

2615
try:
27-
client = messagebird.Client(ACCESS_KEY)
16+
client = messagebird.Client(args['accessKey'])
2817

2918
webhook = client.conversation_create_webhook({
30-
'channelId': CHANNEL_ID,
19+
'channelId': args['channelId'],
3120
'events': [CONVERSATION_WEBHOOK_EVENT_CONVERSATION_CREATED, CONVERSATION_WEBHOOK_EVENT_CONVERSATION_UPDATED],
32-
'url': 'https://example.com'
21+
'url': args['url']
3322
})
3423

3524
# Print the object information.

‎examples/conversation_delete_webhook.py‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,17 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
3+
import argparse
64
import messagebird
75

8-
# ACCESS_KEY = ''
9-
# WEBHOOK_ID = ''
10-
11-
try:
12-
ACCESS_KEY
13-
except NameError:
14-
print('You need to set an ACCESS_KEY constant in this file')
15-
sys.exit(1)
16-
17-
try:
18-
WEBHOOK_ID
19-
except NameError:
20-
print('You need to set an WEBHOOK_ID constant in this file')
21-
sys.exit(1)
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
parser.add_argument('--webhookId', help='webhook that you want to delete', type=str, required=True)
9+
args = vars(parser.parse_args())
2210

2311
try:
24-
client = messagebird.Client(ACCESS_KEY)
12+
client = messagebird.Client(args['accessKey'])
2513

26-
client.conversation_delete_webhook(WEBHOOK_ID)
14+
client.conversation_delete_webhook(args['webhookId'])
2715

2816
# Print the object information.
2917
print('\nWebhook has been deleted:\n')

‎examples/conversation_list.py‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
62
import messagebird
3+
import argparse
4+
import sys
75

8-
# ACCESS_KEY = ''
9-
10-
try:
11-
ACCESS_KEY
12-
except NameError:
13-
print('You need to set an ACCESS_KEY constant in this file')
14-
sys.exit(1)
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
args = vars(parser.parse_args())
159

1610
try:
17-
client = messagebird.Client(ACCESS_KEY)
11+
client = messagebird.Client(args['accessKey'])
1812

1913
conversationList = client.conversation_list()
2014

@@ -35,4 +29,4 @@
3529
for error in e.errors:
3630
print(' code : %d' % error.code)
3731
print(' description : %s' % error.description)
38-
print(' parameter : %s\n' % error.parameter)
32+
print(' parameter : %s\n' % error.parameter)

‎examples/conversation_list_messages.py‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,17 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
3+
import argparse
64
import messagebird
75

8-
# ACCESS_KEY = ''
9-
# CONVERSATION_ID = ''
10-
11-
try:
12-
ACCESS_KEY
13-
except NameError:
14-
print('You need to set an ACCESS_KEY constant in this file')
15-
sys.exit(1)
16-
17-
try:
18-
CONVERSATION_ID
19-
except NameError:
20-
print('You need to set a CONVERSATION_ID constant in this file')
21-
sys.exit(1)
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
parser.add_argument('--conversationId', help='conversation that you want the list of messages', type=str, required=True)
9+
args = vars(parser.parse_args())
2210

2311
try:
24-
client = messagebird.Client(ACCESS_KEY)
12+
client = messagebird.Client(args['accessKey'])
2513

26-
msg = client.conversation_list_messages(CONVERSATION_ID)
14+
msg = client.conversation_list_messages(args['conversationId'])
2715

2816
itemIds = []
2917
for msgItem in msg.items:

‎examples/conversation_list_webhook.py‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,14 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
3+
import argparse
64
import messagebird
75

8-
# ACCESS_KEY = ''
9-
10-
try:
11-
ACCESS_KEY
12-
except NameError:
13-
print('You need to set an ACCESS_KEY constant in this file')
14-
sys.exit(1)
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
args = vars(parser.parse_args())
159

1610
try:
17-
client = messagebird.Client(ACCESS_KEY)
11+
client = messagebird.Client(args['accessKey'])
1812

1913
webhookList = client.conversation_list_webhooks()
2014

‎examples/conversation_read.py‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,17 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
62
import messagebird
3+
import argparse
4+
import sys
75

8-
# ACCESS_KEY = ''
9-
# CONVERSATION_ID = ''
10-
11-
try:
12-
ACCESS_KEY
13-
except NameError:
14-
print('You need to set an ACCESS_KEY constant in this file')
15-
sys.exit(1)
16-
17-
try:
18-
CONVERSATION_ID
19-
except NameError:
20-
print('You need to set an CONVERSATION_ID constant in this file')
21-
sys.exit(1)
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
parser.add_argument('--conversationId', help='conversation that you want the message list', type=str, required=True)
9+
args = vars(parser.parse_args())
2210

2311
try:
24-
client = messagebird.Client(ACCESS_KEY)
12+
client = messagebird.Client(args['accessKey'])
2513

26-
conversation = client.conversation_read(CONVERSATION_ID)
14+
conversation = client.conversation_read(args['conversationId'])
2715

2816
# Print the object information.
2917
print('\nThe following information was returned as a Conversation object:\n')

‎examples/conversation_read_message.py‎

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,17 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
3+
import argparse
64
import messagebird
75

8-
# ACCESS_KEY = ''
9-
# MESSAGE_ID = ''
10-
11-
try:
12-
ACCESS_KEY
13-
except NameError:
14-
print('You need to set an ACCESS_KEY constant in this file')
15-
sys.exit(1)
16-
17-
try:
18-
MESSAGE_ID
19-
except NameError:
20-
print('You need to set a MESSAGE_ID constant in this file')
21-
sys.exit(1)
22-
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
parser.add_argument('--messageId', help='message that you want to read', type=str, required=True)
9+
args = vars(parser.parse_args())
2310

2411
try:
25-
client = messagebird.Client(ACCESS_KEY)
12+
client = messagebird.Client(args['accessKey'])
2613

27-
msg = client.conversation_read_message(MESSAGE_ID)
14+
msg = client.conversation_read_message(args['messageId'])
2815

2916
# Print the object information.
3017
print('\nThe following information was returned as a Conversation List object:\n')

‎examples/conversation_read_webhook.py‎

Lines changed: 8 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,17 @@
11
#!/usr/bin/env python
2-
3-
import sys, os
4-
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))
5-
2+
import sys
63
import messagebird
4+
import argparse
75

8-
# ACCESS_KEY = ''
9-
# WEBHOOK_ID = ''
10-
11-
try:
12-
ACCESS_KEY
13-
except NameError:
14-
print('You need to set an ACCESS_KEY constant in this file')
15-
sys.exit(1)
16-
17-
try:
18-
WEBHOOK_ID
19-
except NameError:
20-
print('You need to set an WEBHOOK_ID constant in this file')
21-
sys.exit(1)
6+
parser = argparse.ArgumentParser()
7+
parser.add_argument('--accessKey', help='access key for MessageBird API', type=str, required=True)
8+
parser.add_argument('--webhookId', help='webhook that you want to read', type=str, required=True)
9+
args = vars(parser.parse_args())
2210

2311
try:
24-
client = messagebird.Client(ACCESS_KEY)
12+
client = messagebird.Client(args['accessKey'])
2513

26-
webhook = client.conversation_read_webhook(WEBHOOK_ID)
14+
webhook = client.conversation_read_webhook(args['webhookId'])
2715

2816
# Print the object information.
2917
print('\nThe following information was returned as a Webhook object:\n')

0 commit comments

Comments
 (0)