Shrink wait_util methods to one

Author: goofcode

README.md

@@ -27,7 +27,13 @@
 
 
 ## 2. Usage
-`$ git clone https://github.com/goofcode/lion`
+``` 
+$ git clone https://github.com/goofcode/lion
+$ cd lion
+$ pip3 install -r requirements.txt
+```
+
+
 ```python
 from lion import message
 from lion import info

exception.py

@@ -4,6 +4,12 @@
 
 
 class NoSuchDriverException(Exception):
-    def __init__(self, message):
+    def __init__(self, message='mode should be either "chrome" or "phantom"'):
         self.message = message
 
+
+class NoSuchLocateMethodException(Exception):
+    def __init__(self, message='by should be "id" or "xpath" or "class"'):
+        self.message = message
+
+

info.py

@@ -1,19 +1,22 @@
+"""
+author: Mookeun Ji, [email protected]
+"""
+
 import re
 import time
 
-import util
-
+from .util import *
 
 def get_friend_number(mode='phantom'):
     """
     :param mode: 'chrome' or 'phantom'(headless)
     :return: (int) number of friend of plus friend
     """
-    driver = util.get_driver(mode)
-    util.login_pf_center(driver)
-    util.to_pf_home(driver)
+    driver = get_driver(mode)
+    login_pf_center(driver)
+    to_pf_home(driver)
 
-    friend_element = util.wait_until_xpath_load(driver, util.get_locators()['friend_number_xpath'])
+    friend_element = wait_until_load(driver, 'xpath', get_locators()['friend_number_xpath'])
     # friend number is loaded dynamically
     time.sleep(2)
     friend_number = int(re.findall(r'\d+', friend_element.text)[0])
@@ -25,11 +28,11 @@ def get_left_free_message_number(mode='phantom'):
     :param mode: 'chrome' or 'phantom'(headless)
     :return: (int) number of left free message
     """
-    driver = util.get_driver(mode)
-    util.login_pf_center(driver)
-    util.to_pf_home(driver)
+    driver = get_driver(mode)
+    login_pf_center(driver)
+    to_pf_home(driver)
 
-    free_message_element = util.wait_until_xpath_load(driver, util.get_locators()['free_message_xpath'])
+    free_message_element = wait_until_load(driver, 'xpath', get_locators()['free_message_xpath'])
     # left_free_message_number is loaded dynamically
     time.sleep(2)
     free_message = int(free_message_element.text.replace(',', ''))

locator.json

@@ -16,6 +16,7 @@
   "link_input_id": "linkUpload",
   "no_share_radio_xpath": "//input[@id='fieldRadio0Forshareable']/../label[1]/span[1]",
   "next_btn_xpath": "//button[contains(text(),'다음')]",
+  "show_calendar_class": "lab_date",
   "submit_btn_xpath": "//button[contains(text(),'등록')]",
   "confirm_btn_xpath": "//button[contains(text(),'확인')]"
 }

message.py

@@ -1,7 +1,7 @@
 """
 author: Mookeun Ji, [email protected]
 
-# Functions defined here may raise some exceptions from driver in case of
+Functions defined here may raise some exceptions from driver in case of
 
     1. setting or locator fault
     2. loss of internet connection
@@ -13,17 +13,17 @@
    modifying this set of codes appropriately are recommended for further use
 """
 
-from util import *
+from .util import *
 
-def send_basic_text_message(content, link=None, share=True, mode='phantom'):
+def send_basic_text_message(content, time=None, link=None, share=True, mode='phantom'):
     """
     send basic text type message to all friends
 
     :param content: message content to be sent
-    :param link: link to be sent w/ message if none, only content will be send
-    :param share: whether enable 'share to friend'
-    :param mode: 'chrome' or 'phantom'(headless)
-
+    :param [opt] time: time message to be sent(formatted as yyyymmdd hh:mm, if none, time set to be now
+    :param [opt] link: link to be sent w/ message if none, only content will be send
+    :param [opt] share: whether enable 'share to friend'
+    :param [opt] mode: 'chrome' or 'phantom'(headless)
     """
 
     driver = get_driver(mode)
@@ -33,19 +33,29 @@ def send_basic_text_message(content, link=None, share=True, mode='phantom'):
     driver.get(url_join(settings['pf_home_url'], locators['basic_message_url']))
 
     # fill inputs for new message
-    wait_until_id_load(driver, locators['message_input_id']).send_keys(content)
+    wait_until_load(driver, 'id', locators['message_input_id']).send_keys(content)
 
     if link is not None:
-        wait_until_xpath_load(driver, locators['add_link_radio_xpath']).click()
-        wait_until_id_load(driver, locators['link_name_id']).send_keys("바로가기")
-        wait_until_id_load(driver, locators['link_input_id']).clear()
-        wait_until_id_load(driver, locators['link_input_id']).send_keys(link)
+        wait_until_load(driver, 'xpath', locators['add_link_radio_xpath']).click()
+        wait_until_load(driver, 'id', locators['link_name_id']).send_keys("바로가기")
+        wait_until_load(driver, 'id', locators['link_input_id']).clear()
+        wait_until_load(driver, 'id', locators['link_input_id']).send_keys(link)
 
     if share is False:
-        wait_until_xpath_load(driver, locators['no_share_radio_xpath']).click()
+        wait_until_load(driver, 'xpath', locators['no_share_radio_xpath']).click()
+
+    wait_until_load(driver, 'xpath', locators['next_btn_xpath']).click()
 
-    wait_until_xpath_load(driver, locators['next_btn_xpath']).click()
-    wait_until_xpath_load(driver, locators['submit_btn_xpath']).click()
-    wait_until_xpath_load(driver, locators['confirm_btn_xpath']).click()
+    '''
+     TODO : add time feature
+    
+    if time is not None:
+        d_time = datetime.datetime.strptime(time, '%Y%m%d %H:%M')
+        wait_until_load(driver, 'class', locators['show_calendar_class']).click()
+    '''
+
+    wait_until_load(driver, 'xpath', locators['submit_btn_xpath']).click()
+    wait_until_load(driver, 'xpath', locators['confirm_btn_xpath']).click()
 
     driver.close()
+

requirements.txt

@@ -0,0 +1 @@
+selenium==3.5.0

util.py

@@ -3,17 +3,19 @@
 """
 
 import json
+import os
 
 from selenium import webdriver
 from selenium.webdriver.common.by import By
 from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
 from selenium.webdriver.support import expected_conditions as ec
 from selenium.webdriver.support.wait import WebDriverWait
 
-from exception import NoSuchDriverException
+from .exception import *
 
-DEV = False
 
+DEV = False
+current_dir = os.path.dirname(os.path.abspath(__file__))
 
 def url_join(main_url, sub_url):
     """
@@ -30,14 +32,14 @@ def url_join(main_url, sub_url):
 
 def get_settings():
     if DEV:
-        with open('dev_setting.json', 'r') as settings_json:
+        with open(os.path.join(current_dir, 'dev_setting.json'), 'r') as settings_json:
             return json.load(settings_json)
     else:
-        with open('setting.json', 'r') as settings_json:
+        with open(os.path.join(current_dir, 'setting.json'), 'r') as settings_json:
             return json.load(settings_json)
 
 def get_locators():
-    with open('locator.json', 'r', encoding='utf-8') as locators_json:
+    with open(os.path.join(current_dir, 'locator.json'), 'r', encoding='utf-8') as locators_json:
         return json.load(locators_json)
 
 def get_settings_and_locators():
@@ -68,35 +70,33 @@ def get_driver(mode='phantom'):
         if DEV:
             driver.set_window_size(1920, 1080)
     else:
-        raise NoSuchDriverException('mode should be either "chrome" or "phantom"(headless)')
+        raise NoSuchDriverException()
 
     return driver
 
-def wait_until_xpath_load(driver, element_xpath, timeout=5):
+def wait_until_load(driver, by, locator, timeout=30):
     """
-    :param driver: selenium driver trying to load page
-    :param element_xpath: xpath of element waiting for
-    :param timeout: maximum time to wait. after this time elapsed, TimeoutException will be raised.
+    :param driver: selenium driver loading page
+    :param by: locating method 'id', 'xpath', 'class'
+    :param locator: proper locator according to param by
+    :param timeout: maximum time to wait. After this time elapsed, TimeoutException will be raised.
     :return: web element object waiting for
     """
-    return _get_element_after_loaded(driver, timeout, (By.XPATH, element_xpath))
+    if by is 'id':
+        return WebDriverWait(driver, timeout).until(ec.presence_of_element_located((By.ID, locator)))
+    elif by is 'xpath':
+        return WebDriverWait(driver, timeout).until(ec.presence_of_element_located((By.XPATH, locator)))
+    elif by is 'class':
+        return WebDriverWait(driver, timeout).until(ec.presence_of_element_located((By.CLASS_NAME, locator)))
+    else:
+        raise NoSuchLocateMethodException()
 
-def wait_until_id_load(driver, element_id, timeout=5):
-    """
-    :param driver: selenium driver trying to load page
-    :param element_id: id of element waiting for
-    :param timeout: maximum time to wait. after this time elapsed, TimeoutException will be raised.
-    :return: web element object waiting for
-    """
-    return _get_element_after_loaded(driver, timeout, (By.ID, element_id))
 
-def _get_element_after_loaded(driver, timeout, locator):
-    return WebDriverWait(driver, timeout).until(ec.presence_of_element_located(locator))
 
 def login_pf_center(driver):
     settings, locators = get_settings_and_locators()
     to_pf_center(driver)
-    wait_until_xpath_load(driver, locators['to_login_page_btn_xpath']).click()
+    wait_until_load(driver, 'xpath', locators['to_login_page_btn_xpath']).click()
     driver.find_element_by_id(locators['login_email_input_id']).send_keys(settings['admin_info']['email'])
     driver.find_element_by_id(locators['login_pw_input_id']).send_keys(settings['admin_info']['pw'])
     driver.find_element_by_id(locators['login_submit_btn_id']).click()