Join rules and guest access

matrix_client/api.py

@@ -744,3 +744,16 @@ def get_room_members(self, room_id):
             room_id (str): The room to get the member events for.
         """
         return self._send("GET", "/rooms/{}/members".format(quote(room_id)))
+
+    def set_join_rule(self, room_id, join_rule):
+        """Set the rule for users wishing to join the room.
+
+        Args:
+            room_id(str): The room to set the rules for.
+            join_rule(str): The chosen rule. One of: ["public", "knock",
+                "invite", "private"]
+        """
+        content = {
+            "join_rule": join_rule
+        }
+        return self.send_state_event(room_id, "m.room.join_rules", content)

matrix_client/client.py

@@ -507,6 +507,8 @@ def _process_state_event(self, state_event, current_room):
                 current_room.topic = econtent.get("topic")
             elif etype == "m.room.aliases":
                 current_room.aliases = econtent.get("aliases")
+            elif etype == "m.room.join_rules":
+                current_room.invite_only = econtent["join_rule"] == "invite"
             elif etype == "m.room.member" and self._cache_level == CACHE.ALL:
                 # tracking room members can be large e.g. #matrix:matrix.org
                 if econtent["membership"] == "join":

matrix_client/room.py

@@ -33,6 +33,7 @@ def __init__(self, client, room_id):
         self.canonical_alias = None
         self.aliases = []
         self.topic = None
+        self.invite_only = None
         self._prev_batch = None
         self._members = []
 
@@ -624,6 +625,24 @@ def modify_required_power_levels(self, events=None, **kwargs):
         except MatrixRequestError:
             return False
 
+    def set_invite_only(self, invite_only):
+        """Set how the room can be joined.
+
+        Args:
+            invite_only(bool): If True, users will have to be invited to join
+                the room. If False, anyone who knows the room link can join.
+
+        Returns:
+            True if successful, False if not
+        """
+        join_rule = "invite" if invite_only else "public"
+        try:
+            self.client.api.set_join_rule(self.room_id, join_rule)
+            self.invite_only = invite_only
+            return True
+        except MatrixRequestError:
+            return False
+
     @property
     def prev_batch(self):
         return self._prev_batch

test/client_test.py

@@ -116,6 +116,13 @@ def test_state_event():
     client._process_state_event(ev, room)
     assert len(room._members) == 0
 
+    # test join_rules
+    room.invite_only = False
+    ev["type"] = "m.room.join_rules"
+    ev["content"] = {"join_rule": "invite"}
+    client._process_state_event(ev, room)
+    assert room.invite_only
+
 
 def test_get_user():
     client = MatrixClient("http://example.com")
@@ -406,3 +413,19 @@ def test_cache():
     assert m_none.rooms[room_id]._members == m_some.rooms[room_id]._members == []
     assert len(m_all.rooms[room_id]._members) == 1
     assert m_all.rooms[room_id]._members[0].user_id == "@alice:example.com"
+
+
+@responses.activate
+def test_room_join_rules():
+    client = MatrixClient(HOSTNAME)
+    room_id = "!UcYsUzyxTGDxLBEvLz:matrix.org"
+    room = client._mkroom(room_id)
+    assert room.invite_only is None
+    join_rules_state_path = HOSTNAME + MATRIX_V2_API_PATH + \
+        "/rooms/" + quote(room_id) + "/state/m.room.join_rules"
+
+    responses.add(responses.PUT, join_rules_state_path,
+                  json=response_examples.example_event_response)
+
+    assert room.set_invite_only(True)
+    assert room.invite_only