Feature/create board by workspace (ProdPerfect#60)

* Added "create board by workspace id"

* Update readme

* Added missing type hints

* Updated test

* More custom type hints

* Type hints for 'get_boards_query'

* Fixed tests

* Updated Readme and 'fetch_boards' method

Author: albcl

README.md

@@ -57,7 +57,14 @@ monday.items.create_item(board_id='12345678', group_id='today',  item_name='Do a
 
 
 #### Boards Resource (monday.boards)
-- `fetch_boards(**kwargs)` - Fetch boards associated with an account. Returns boards and their groups, tags, and columns. Accepts keyword arguments. See Monday API docs for a list of accepted keyword arguments.
+- `fetch_boards(**kwargs)` - Fetch boards associated with an account. Returns boards and their groups, tags, and columns. Accepts keyword arguments:
+    - `limit` - The number of boards returned (*int*. Default is 25).
+    - `page` - The page number returned, should you implement pagination(*int*. Starts at 1).
+    - `ids` - A list of the unique board identifier(s) (*List[int]*).
+    - `board_kind` - The board's kind (*BoardKind*. public / private / share).
+    - `state` - The state of the board (*BoardState*. all / active / archived / deleted. Default is active).
+    - `order_by` - The order in which to retrieve your boards (*BoardsOrderBy*. created_at / used_at).
+    
 
 - `fetch_boards_by_id([board_ids])` - Since Monday does not allow querying boards by name, you can use `fetch_boards` to get a list of boards, and then `fetch_boards_by_id` to get more detailed info about the groups and columns on that board. Accepts a comma separated list of board ids.
 

monday/query_joins.py

@@ -1,6 +1,7 @@
 import json
-from monday.resources.types import DuplicateTypes
-
+from enum import Enum
+from typing import List
+from monday.resources.types import BoardKind, BoardState, BoardsOrderBy, DuplicateTypes
 from monday.utils import monday_json_stringify
 
 
@@ -312,7 +313,18 @@ def get_board_items_query(board_id):
     return query
 
 
-def get_boards_query(**kwargs):
+def get_boards_query(limit: int = None, page: int = None, ids: List[int] = None, board_kind: BoardKind = None, state: BoardState = None, order_by: BoardsOrderBy = None):
+    parameters = locals().items()
+    query_params = []
+    for k, v in parameters:
+        if v is not None:
+            value = v
+            if isinstance(v, Enum):
+                value = v.value
+
+            query_params.append("%s: %s" % (k, value))
+
+
     query = '''query
     {
         boards (%s) {
@@ -333,7 +345,8 @@ def get_boards_query(**kwargs):
                 type
             }
         }
-    }''' % ', '.join(["%s: %s" % (arg, kwargs.get(arg)) for arg in kwargs])
+    }''' % ', '.join(query_params)
+
     return query
 
 
@@ -362,6 +375,26 @@ def get_boards_by_id_query(board_ids):
     }''' % board_ids
 
 
+def get_columns_by_board_query(board_ids):
+    return '''query
+        {
+            boards(ids: %s) {
+                id
+                name
+                groups {
+                    id
+                    title
+                }
+                columns {
+                    title
+                    id
+                    type
+                    settings_str
+                 }
+            }
+        }''' % board_ids
+
+
 def duplicate_board_query(
     board_id: int,
     duplicate_type: DuplicateTypes,
@@ -402,15 +435,15 @@ def duplicate_board_query(
     return query
 
 
-def create_board_by_workspace_query(board_name, board_kind, workspace_id = None):
+def create_board_by_workspace_query(board_name: str, board_kind: BoardKind, workspace_id = None) -> str:
     workspace_query = f'workspace_id: {workspace_id}' if workspace_id else ''
     query = '''
     mutation {
         create_board (board_name:"%s", board_kind: %s, %s) {
             id
         }
     }
-    ''' % (board_name, board_kind, workspace_query)
+    ''' % (board_name, board_kind.value, workspace_query)
     return query
 
 

monday/resources/boards.py

@@ -1,14 +1,22 @@
+from typing import List
 from monday.resources.base import BaseResource
-from monday.query_joins import duplicate_board_query, create_board_by_workspace_query, get_boards_query, get_boards_by_id_query, get_board_items_query, get_columns_by_board_query
-from monday.resources.types import DuplicateTypes
+from monday.query_joins import (
+    duplicate_board_query,
+    get_boards_query,
+    get_boards_by_id_query,
+    get_board_items_query,
+    get_columns_by_board_query,
+    create_board_by_workspace_query,
+)
+from monday.resources.types import BoardKind, BoardState, BoardsOrderBy, DuplicateTypes
 
 
 class BoardResource(BaseResource):
     def __init__(self, token):
         super().__init__(token)
 
-    def fetch_boards(self, **kwargs):
-        query = get_boards_query(**kwargs)
+    def fetch_boards(self, limit: int = None, page: int = None, ids: List[int] = None, board_kind: BoardKind = None, state: BoardState = None, order_by: BoardsOrderBy = None):
+        query = get_boards_query(limit, page, ids, board_kind, state, order_by)
         return self.client.execute(query)
 
     def fetch_boards_by_id(self, board_ids):
@@ -34,8 +42,7 @@ def duplicate_board(
     ):
         query = duplicate_board_query(board_id, duplicate_type, board_name, workspace_id, folder_id, keep_subscribers)
         return self.client.execute(query)
-        return self.client.execute(query)
 
-    def create_board(self, board_name, board_kind, workspace_id):
+    def create_board(self, board_name: str, board_kind: BoardKind, workspace_id: int = None):
         query = create_board_by_workspace_query(board_name, board_kind, workspace_id)
         return self.client.execute(query)

monday/resources/types.py

@@ -1,6 +1,30 @@
 from enum import Enum
 
 
+class BoardKind(Enum):
+    """Board kinds"""
+
+    PUBLIC = "public"
+    PRIVATE = "private"
+    SHARE = "share"
+
+
+class BoardState(Enum):
+    """Board available states"""
+
+    ALL = "all"
+    ACTIVE = "active"
+    ARCHIVED = "archived"
+    DELETED = "deleted"
+
+
+class BoardsOrderBy(Enum):
+    """Order to retrieve boards"""
+
+    CREATED_AT = "created_at"
+    USED_AT = "used_at"
+
+
 class DuplicateTypes(Enum):
     """Board duplication types"""
 

monday/tests/test_board_resource.py

@@ -7,8 +7,29 @@ def setUp(self):
         super(BoardTestCase, self).setUp()
 
     def test_get_boards_query(self):
-        query = get_boards_query(board_kind=self.board_kind)
-        self.assertIn(self.board_kind, query)
+        query_a = get_boards_query(limit=1, page=2, ids=[888,999], board_kind=self.board_kind, state=self.board_state, order_by=self.boards_order_by)
+        self.assertIn('1', query_a)
+        self.assertIn('2', query_a)
+        self.assertIn('[888, 999]', query_a)
+        self.assertNotIn(str(self.board_kind), query_a)
+        self.assertIn(str(self.board_kind.value), query_a)
+        self.assertNotIn(str(self.board_state), query_a)
+        self.assertIn(str(self.board_state.value), query_a)
+        self.assertNotIn(str(self.boards_order_by), query_a)
+        self.assertIn(str(self.boards_order_by.value), query_a)
+
+        query_b = get_boards_query(board_kind=self.board_kind)
+        self.assertNotIn(str(self.board_kind), query_b)
+        self.assertIn(str(self.board_kind.value), query_b)
+
+        query_c = get_boards_query(limit=1,state=self.board_state)
+        self.assertIn('1', query_c)
+        self.assertNotIn(str(self.board_state), query_c)
+        self.assertIn(str(self.board_state.value), query_c)
+        self.assertNotIn(str(self.board_kind), query_c)
+        self.assertNotIn(str(self.boards_order_by), query_c)
+
+
 
     def test_get_boards_by_id_query(self):
         query = get_boards_by_id_query(board_ids=self.board_id)
@@ -38,9 +59,11 @@ def test_duplicate_board_query(self):
     def test_create_board_by_workspace_query(self):
         query_a = create_board_by_workspace_query(board_name=self.board_name, board_kind=self.board_kind, workspace_id=self.workspace_id)
         self.assertIn(str(self.board_name), query_a)
-        self.assertIn(str(self.board_kind), query_a)
+        self.assertNotIn(str(self.board_kind), query_a)
+        self.assertIn(str(self.board_kind.value), query_a)
         self.assertIn(str(self.workspace_id), query_a)
         query_b = create_board_by_workspace_query(board_name=self.board_name, board_kind=self.board_kind)
         self.assertIn(str(self.board_name), query_b)
-        self.assertIn(str(self.board_kind), query_b)
+        self.assertNotIn(str(self.board_kind), query_b)
+        self.assertIn(str(self.board_kind.value), query_b)
         self.assertNotIn(str(self.workspace_id), query_b)

monday/tests/test_case_resource.py

@@ -1,6 +1,6 @@
 import unittest
 
-from monday.resources.types import DuplicateTypes
+from monday.resources.types import BoardKind, BoardState, BoardsOrderBy, DuplicateTypes
 
 
 class BaseTestCase(unittest.TestCase):
@@ -11,8 +11,10 @@ def setUp(self):
         self.item_id = 24
         self.board_name = "my_board"
         self.board_id = 12
-        self.board_kind = "public"
         self.duplicate_type = DuplicateTypes.WITH_PULSES
+        self.board_kind = BoardKind.PUBLIC
+        self.board_state = BoardState.ACTIVE
+        self.boards_order_by = BoardsOrderBy.USED_AT
         self.group_id = 7
         self.column_id = "file_column"
         self.user_ids = [1287123, 1230919]