Skip to content
This repository has been archived by the owner on May 24, 2023. It is now read-only.

Commit

Permalink
update examples
Browse files Browse the repository at this point in the history
  • Loading branch information
@j-hc
j-hc committed Dec 23, 2021
1 parent c41c978 commit d13f4d0
Show file tree
Hide file tree
Showing 3 changed files with 104 additions and 78 deletions.
48 changes: 34 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ from Reddit_ChatBot_Python import RedditAuthentication

reddit_authentication = RedditAuthentication.PasswordAuth(reddit_username="",
reddit_password="",
twofa="")
twofa=None)
```

or you can go with your self-obtained api key. (not the one you get from your registered app)
Expand Down Expand Up @@ -105,6 +105,16 @@ The event of a user typing.
```
The event of a user reading a message.

```python
@chatbot.event.on_broadcast
```
The event of receiving a broadcast like upon user join

```python
@chatbot.event.on_reaction
```
The event of a user sending a reaction

---

All events receives a parsed frame as an argument. They are handled like this.:
Expand All @@ -118,7 +128,7 @@ def greet(resp):
return True
```

- Returning ```True``` from events means that handling of the other events won't be carried out.
- **Returning ```True``` from events means that handling of the other events won't be carried out!**

- ```resp.channel_url``` is the url of the channel we want to send the message to (resp.channel_url in this case
which is the channel in which the "Hi!" message was sent.)
Expand Down Expand Up @@ -394,12 +404,13 @@ Complete Example
-------

```python
from Reddit_ChatBot_Python import ChatBot, RedditAuthentication, CustomType
from Reddit_ChatBot_Python import ChatBot, RedditAuthentication
from Reddit_ChatBot_Python import CustomType, Snoo, Reaction
import random # for a basic dice rolling game

# create authentication with username and pass
reddit_authentication = RedditAuthentication.PasswordAuth(reddit_username="", reddit_password="",
twofa="") # 2FA supported although not necessary obv..
twofa=None) # 2FA supported, default'd to None

# instantiate the chatbot
chatbot = ChatBot(print_chat=True, store_session=True, log_websocket_frames=False, # some parameters u might wanna know
Expand All @@ -416,19 +427,20 @@ chatbot.enable_rate_limiter(max_calls=23, # how many messages will be sent by t
def dice_roller(resp): # resp is a SimpleNamespace that carries all the data of the received frame
messg_s = resp.message.split()
if messg_s[0] == "!roll" and len(messg_s) == 3: # if received message says !roll
chatbot.send_reaction(Reaction.REACT4, resp.msg_id, resp.channel_url) # send a reaction

limit_bottom = int(messg_s[1])
limit_top = int(messg_s[2])

rolled_number = random.randint(limit_bottom, limit_top)
response_text = f"@{resp.user.name} {rolled_number}. Better luck next time!"
# a simple game
response_text = f"@{resp.user.name} rolled {rolled_number}. Better luck next time!"

# send typing indicator cuz why not? maybe they think you are a real person
chatbot.send_typing_indicator(resp.channel_url)
chatbot.send_message(response_text,
resp.channel_url) # send the message, always add resp.channel_url as the second argument
chatbot.stop_typing_indicator(resp.channel_url)
chatbot.send_snoomoji('partyparrot', resp.channel_url) # and send a snoomoji cuz why not??
chatbot.send_snoomoji(Snoo.PARTYPARROT, resp.channel_url) # and send a snoomoji cuz why not??
return True # return true if you want to be done with checking the other hooks, otherwise return None or False
# keep in mind that first added hooks get executed first

Expand All @@ -442,11 +454,9 @@ def keeper_of_decency(resp):
if resp.message == "*some very bad slur word*":
chatbot.kick_user(channel_url=resp.channel_url, user_id=resp.user.guest_id, duration=600) # duration is in secs
chatbot.send_message(f'i banned {resp.user.name} for 10 mins', resp.channel_url)
return True
elif resp.message == "*another bad word*":
chatbot.delete_mesg(channel_url=resp.channel_url, msg_id=resp.msg_id)
chatbot.send_message(f"i deleted {resp.user.name}'s message", resp.channel_url)
return True


# or you can add a basic response hook directly like so:
Expand All @@ -469,8 +479,6 @@ def on_invit(resp):
invit_type = "group chat"
elif resp.channel_type == CustomType.direct:
invit_type = "DM"
else:
invit_type = None
print(f"got invited to {invit_type} by {resp.data.inviter.nickname}")
chatbot.accept_chat_invite(resp.channel_url)
chatbot.send_message("Hello! I accepted your invite", resp.channel_url)
Expand All @@ -484,26 +492,38 @@ def report_channels(_):
print("up and running in these channels!: ")
for channel in channels:
print(channel.name)

# reading last 50 messages from a channel


# reading last 130 messages from a channel
@chatbot.event.on_ready
def report_channels(_):
channels = chatbot.get_channels()
my_channel = None
for channel in channels:
if channel.name == "My Channel":
last_fifty_message = chatbot.get_older_messages(channel_url=channel.channel_url, prev_limit=50)
my_channel = channel

last_hundred_messages = chatbot.get_older_messages(channel_url=my_channel.channel_url,
prev_limit=100)
remaining_thirty = chatbot.get_older_messages(channel_url=my_channel.channel_url,
message_ts=last_hundred_messages[-1].created_at,
prev_limit=30)


# starting a direct chat
@chatbot.event.on_ready
def dm(_):
dm_channel = chatbot.create_direct_channel("someuseridk")
chatbot.send_message("Hey what's up?", dm_channel.channel_url)


# starting a group chat
@chatbot.event.on_ready
def dm(_):
dm_channel = chatbot.create_channel(nicknames=["user1", "user2"], group_name="my group")
chatbot.send_message("Hey guys what's up?", dm_channel.channel_url)
chatbot.invite_user_to_channel(dm_channel.channel_url, nicknames=["someotheruser"])


# wanna check invitations on start? i got you
@chatbot.event.on_ready
Expand Down
105 changes: 53 additions & 52 deletions Reddit_ChatBot_Python/_api/models.py
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
from typing import Dict, Optional, List
from enum import Enum


# AUTO GENERATED


Expand All @@ -14,40 +15,6 @@ class MemberState(str, Enum):
invited = 'invited'


class _Channel:
def __init__(self, in_data: dict):
self.name: str = in_data.get('name')
self.member_count: int = in_data.get('member_count')
self.custom_type: CustomType = CustomType[in_data.get('custom_type')]
self.channel_url: str = in_data.get('channel_url')
self.created_at: int = in_data.get('created_at')
self.max_length_message: int = in_data.get('max_length_message')
self.data: str = in_data.get('data')


class User:
def __init__(self, in_data: dict):
self.is_blocking_me: Optional[bool] = in_data.get('is_blocking_me')
self.user_id: Optional[str] = in_data.get('user_id')
self.is_muted: Optional[bool] = in_data.get('is_muted')
self.friend_name: Optional[str] = in_data.get('friend_name')
self.joined_ts: Optional[int] = in_data.get('joined_ts')
self.is_active: Optional[bool] = in_data.get('is_active')
self.read_ts: Optional[int] = in_data.get('read_ts')
self.is_blocked_by_me: Optional[bool] = in_data.get('is_blocked_by_me')
self.state: Optional[str] = in_data.get('state')
self.role: Optional[str] = in_data.get('role')
self.is_online: Optional[bool] = in_data.get('is_online')
self.require_auth_for_profile_image: Optional[bool] = in_data.get('require_auth_for_profile_image')
self.nickname: Optional[str] = in_data.get('nickname')


class Members:
def __init__(self, in_data: dict):
self.members: List[User] = list(map(lambda n: User(n), in_data.get('members')))
self.next: str = in_data.get('next')


class BannedUser:
def __init__(self, in_data: dict):
self.description: str = in_data.get('description')
Expand All @@ -58,27 +25,10 @@ def __init__(self, in_data: dict):

class BannedUsers:
def __init__(self, in_data: dict):
self.banned_list: List[BannedUser] = list(map(lambda n: BannedUser(n), in_data.get('banned_list')))
self.banned_list: List[BannedUser] = [BannedUser(n) for n in in_data.get('banned_list')]
self.next: str = in_data.get('next')


class Message:
def __init__(self, in_data: dict):
self.mentioned_users: List[User] = list(map(lambda n: User(n), in_data.get('mentioned_users')))
self.updated_at: Optional[User] = in_data.get('updated_at')
self.is_op_msg: Optional[User] = in_data.get('is_op_msg')
self.is_removed: Optional[User] = in_data.get('is_removed')
self.user: Optional[User] = in_data.get('user')
self.message: str = in_data.get('message')
self.data: str = in_data.get('data')
self.type: Optional[User] = in_data.get('type')
self.created_at: Optional[User] = in_data.get('created_at')
self.req_id: Optional[User] = in_data.get('req_id')
self.mention_type: Optional[User] = in_data.get('mention_type')
self.channel_url: str = in_data.get('channel_url')
self.message_id: Optional[User] = in_data.get('message_id')


class Channel:
def __init__(self, in_data: dict):
self.invited_at: Optional[int] = in_data.get('invited_at')
Expand Down Expand Up @@ -109,3 +59,54 @@ def __init__(self, in_data: dict):
self.max_length_message: Optional[int] = in_data.get('max_length_message')
self.inviter: Optional[User] = in_data.get('inviter')
self.count_preference: Optional[str] = in_data.get('count_preference')


class Members:
def __init__(self, in_data: dict):
self.members: List[User] = [User(n) for n in in_data.get('members')]
self.next: str = in_data.get('next')


class Message:
def __init__(self, in_data: dict):
self.mentioned_users: List[User] = [User(n) for n in in_data.get('mentioned_users')]
self.updated_at: Optional[int] = in_data.get('updated_at')
self.is_op_msg: Optional[bool] = in_data.get('is_op_msg')
self.is_removed: Optional[bool] = in_data.get('is_removed')
self.user: Optional[User] = in_data.get('user')
self.message: str = in_data.get('message')
self.data: str = in_data.get('data')
self.type: Optional[str] = in_data.get('type')
self.created_at: Optional[int] = in_data.get('created_at')
self.req_id: Optional[str] = in_data.get('req_id')
self.mention_type: Optional[str] = in_data.get('mention_type')
self.channel_url: str = in_data.get('channel_url')
self.message_id: Optional[int] = in_data.get('message_id')


class User:
def __init__(self, in_data: dict):
self.is_blocking_me: Optional[bool] = in_data.get('is_blocking_me')
self.user_id: Optional[str] = in_data.get('user_id')
self.is_muted: Optional[bool] = in_data.get('is_muted')
self.friend_name: Optional[str] = in_data.get('friend_name')
self.joined_ts: Optional[int] = in_data.get('joined_ts')
self.is_active: Optional[bool] = in_data.get('is_active')
self.read_ts: Optional[int] = in_data.get('read_ts')
self.is_blocked_by_me: Optional[bool] = in_data.get('is_blocked_by_me')
self.state: Optional[str] = in_data.get('state')
self.role: Optional[str] = in_data.get('role')
self.is_online: Optional[bool] = in_data.get('is_online')
self.require_auth_for_profile_image: Optional[bool] = in_data.get('require_auth_for_profile_image')
self.nickname: Optional[str] = in_data.get('nickname')


class _Channel:
def __init__(self, in_data: dict):
self.name: str = in_data.get('name')
self.member_count: int = in_data.get('member_count')
self.custom_type: CustomType = CustomType[in_data.get('custom_type')]
self.channel_url: str = in_data.get('channel_url')
self.created_at: int = in_data.get('created_at')
self.max_length_message: int = in_data.get('max_length_message')
self.data: str = in_data.get('data')
29 changes: 17 additions & 12 deletions examples/casual_chatbot.py
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
from Reddit_ChatBot_Python import ChatBot, RedditAuthentication, CustomType
from Reddit_ChatBot_Python import ChatBot, RedditAuthentication
from Reddit_ChatBot_Python import CustomType, Snoo, Reaction
import random # for a basic dice rolling game

# create authentication with username and pass
reddit_authentication = RedditAuthentication.PasswordAuth(reddit_username="", reddit_password="",
twofa="") # 2FA supported although not necessary obv..
twofa=None) # 2FA supported, default'd to None

# instantiate the chatbot
chatbot = ChatBot(print_chat=True, store_session=True, log_websocket_frames=False, # some parameters u might wanna know
Expand All @@ -20,19 +21,20 @@
def dice_roller(resp): # resp is a SimpleNamespace that carries all the data of the received frame
messg_s = resp.message.split()
if messg_s[0] == "!roll" and len(messg_s) == 3: # if received message says !roll
chatbot.send_reaction(Reaction.REACT4, resp.msg_id, resp.channel_url) # send a reaction

limit_bottom = int(messg_s[1])
limit_top = int(messg_s[2])

rolled_number = random.randint(limit_bottom, limit_top)
response_text = f"@{resp.user.name} {rolled_number}. Better luck next time!"
# a simple game
response_text = f"@{resp.user.name} rolled {rolled_number}. Better luck next time!"

# send typing indicator cuz why not? maybe they think you are a real person
chatbot.send_typing_indicator(resp.channel_url)
chatbot.send_message(response_text,
resp.channel_url) # send the message, always add resp.channel_url as the second argument
chatbot.stop_typing_indicator(resp.channel_url)
chatbot.send_snoomoji('partyparrot', resp.channel_url) # and send a snoomoji cuz why not??
chatbot.send_snoomoji(Snoo.PARTYPARROT, resp.channel_url) # and send a snoomoji cuz why not??
return True # return true if you want to be done with checking the other hooks, otherwise return None or False
# keep in mind that first added hooks get executed first

Expand All @@ -46,11 +48,9 @@ def keeper_of_decency(resp):
if resp.message == "*some very bad slur word*":
chatbot.kick_user(channel_url=resp.channel_url, user_id=resp.user.guest_id, duration=600) # duration is in secs
chatbot.send_message(f'i banned {resp.user.name} for 10 mins', resp.channel_url)
return True
elif resp.message == "*another bad word*":
chatbot.delete_mesg(channel_url=resp.channel_url, msg_id=resp.msg_id)
chatbot.send_message(f"i deleted {resp.user.name}'s message", resp.channel_url)
return True


# or you can add a basic response hook directly like so:
Expand All @@ -73,8 +73,6 @@ def on_invit(resp):
invit_type = "group chat"
elif resp.channel_type == CustomType.direct:
invit_type = "DM"
else:
invit_type = None
print(f"got invited to {invit_type} by {resp.data.inviter.nickname}")
chatbot.accept_chat_invite(resp.channel_url)
chatbot.send_message("Hello! I accepted your invite", resp.channel_url)
Expand All @@ -90,13 +88,20 @@ def report_channels(_):
print(channel.name)


# reading last 50 messages from a channel
# reading last 130 messages from a channel
@chatbot.event.on_ready
def report_channels(_):
channels = chatbot.get_channels()
my_channel = None
for channel in channels:
if channel.name == "My Channel":
last_fifty_message = chatbot.get_older_messages(channel_url=channel.channel_url, prev_limit=50)
my_channel = channel

last_hundred_messages = chatbot.get_older_messages(channel_url=my_channel.channel_url,
prev_limit=100)
remaining_thirty = chatbot.get_older_messages(channel_url=my_channel.channel_url,
message_ts=last_hundred_messages[-1].created_at,
prev_limit=30)


# starting a direct chat
Expand All @@ -111,6 +116,7 @@ def dm(_):
def dm(_):
dm_channel = chatbot.create_channel(nicknames=["user1", "user2"], group_name="my group")
chatbot.send_message("Hey guys what's up?", dm_channel.channel_url)
chatbot.invite_user_to_channel(dm_channel.channel_url, nicknames=["someotheruser"])


# wanna check invitations on start? i got you
Expand All @@ -125,4 +131,3 @@ def check_invites(_):

# and finally, run forever...
chatbot.run_4ever(auto_reconnect=True)
# set auto_reconnect to True so as to re-connect in case remote server shuts down the connection after some period of time

0 comments on commit d13f4d0

Please sign in to comment.