Release 0.5

Author: scottphilip

CHANGES.txt

@@ -12,3 +12,5 @@ Revision History
 |---------|-----------------------|-------------------------------------------------------------------------|
 | 0.4     | 13 July 2017          | Further http fixes                                                      |
 |---------|-----------------------|-------------------------------------------------------------------------|
+| 0.5     | 24 July 2017          | Encryption of Cookies file                                              |
+|---------|-----------------------|-------------------------------------------------------------------------|

GoogleToken/Configuration.py

@@ -1,87 +1,82 @@
 # Author:       Scott Philip (sp@scottphilip.com)
-# Version:      0.4 (13 July 2017)
+# Version:      0.5 (24 July 2017)
 # Source:       https://github.com/scottphilip/google-token/
 # Licence:      GNU GENERAL PUBLIC LICENSE (Version 3, 29 June 2007)
+
 import json
 from os.path import expanduser, join, isdir
 from os import makedirs
 from tempfile import gettempdir
 from datetime import datetime
 
 
-class GoogleTokenConfiguration:
-    """
-    Configuration
-    """
+class GoogleTokenConfiguration(object):
+    account_email = None
+    account_password = None
+    account_otp_secret = None
+    cookie_storage_path = None
+    oauth_client_id = None
+    oauth_redirect_uri = None
+    oauth_scope = None
+    logger = None
+    image_path = None
+    execute_script = None
+    phantomjs_path = "phantomjs"
+    phantomjs_config_useragent = "phantomjs.page.settings.userAgent"
+    phantomjs_log_path = None
+    cookies_ignore_discard = False
+    cookies_store_plain = False
+    url_accounts = "https://accounts.google.com"
+    url_my_account = "https://myaccount.google.com"
+    url_service_login = "https://accounts.google.com/ServiceLogin"
+    url_accounts_no_form = "https://accounts.google.com/x"
+    timeout_seconds = 30
+    oauth2_protocol = "https"
+    oauth2_domain = "accounts.google.com"
+    oauth2_path = "/o/oauth2/v2/auth"
+    user_agent = "Mozilla/5.0 (Windows NT 6.1; WOW64; rv:25.0) Gecko/20100101 Firefox/25.0"
+    default_headers = None
+    oauth2_data = None
 
-    def __init__(self,
-                 account_email=None,
-                 account_password=None,
-                 account_otp_secret=None,
-                 cookie_storage_path=None,
-                 oauth_client_id=None,
-                 oauth_redirect_uri=None,
-                 oauth_scope=None,
-                 logger=None,
-                 image_path=None,
-                 execute_script=None,
-                 phantomjs_path="phantomjs",
-                 phantomjs_config_useragent="phantomjs.page.settings.userAgent",
-                 phantomjs_log_path=None,
-                 cookies_ignore_discard=False,
-                 url_accounts="https://accounts.google.com",
-                 url_my_account="https://myaccount.google.com",
-                 url_service_login="https://accounts.google.com/ServiceLogin",
-                 url_accounts_no_form="https://accounts.google.com/x",
-                 timeout_seconds=30,
-                 oauth2_protocol="https",
-                 oauth2_domain="accounts.google.com",
-                 oauth2_path="/o/oauth2/v2/auth",
-                 user_agent="Mozilla/5.0 (Windows NT 6.1; WOW64; rv:25.0) Gecko/20100101 Firefox/25.0",
-                 default_headers=None,
-                 oauth2_data=None):
+    def __init__(self, **kwargs):
+        for key, value in kwargs.items():
+            if hasattr(self, key):
+                setattr(self, key, value)
+                continue
+            raise Exception("Unknown Argument: {0}".format(key))
 
-        self.account_email = account_email
+        argument_missing = []
+        if self.account_email is None:
+            argument_missing.append("account_email")
+        if self.oauth_client_id is None:
+            argument_missing.append("oauth_client_id")
+        if self.oauth_redirect_uri is None:
+            argument_missing.append("oauth_redirect_uri")
+        if self.oauth_scope is None:
+            argument_missing.append("oauth_scope")
+        if len(argument_missing) > 0:
+            raise Exception("REQUIRED_ARGUMENT", str(argument_missing))
 
         if not isdir(join(gettempdir(), "GoogleToken", self.account_email)):
             makedirs(join(gettempdir(), "GoogleToken", self.account_email))
-        if self.account_email is None:
-            raise Exception("account_email configuration must be set.")
-        self.account_password = account_password
-        self.account_otp_secret = account_otp_secret
-        self.cookie_storage_path = cookie_storage_path if cookie_storage_path is not None \
-            else join(expanduser("~"), "{0}.cookies".format(self.account_email))
-        self.oauth_client_id = oauth_client_id
-        self.oauth_redirect_uri = oauth_redirect_uri
-        self.oauth_scope = oauth_scope
-        self.logger = logger
-        self.image_path = image_path if image_path is not None else join(
-            gettempdir(),
-            "GoogleToken",
-            self.account_email,
-            datetime.now().strftime("%Y-%m-%d_%H-%M-%S"))
-        self.execute_script = execute_script
-        self.phantomjs_path = phantomjs_path
-        self.phantomjs_config_useragent = phantomjs_config_useragent
-        self.phantomjs_log_path = phantomjs_log_path if phantomjs_log_path is not None \
-            else join(gettempdir(),
-                      "GoogleToken",
-                      self.account_email, "phantomjs.log")
-        self.cookies_ignore_discard = cookies_ignore_discard
-        self.url_accounts = url_accounts
-        self.url_my_account = url_my_account
-        self.url_service_login = url_service_login
-        self.url_accounts_no_form = url_accounts_no_form
-        self.timeout_seconds = timeout_seconds
-        self.oauth2_protocol = oauth2_protocol
-        self.oauth2_domain = oauth2_domain
-        self.oauth2_path = oauth2_path
-        self.user_agent = user_agent
-        self.default_headers = {"User-Agent": user_agent} if default_headers is None else default_headers
+
+        self.cookie_storage_path = join(expanduser("~"), "{0}.cookies".format(self.account_email)) \
+            if self.cookie_storage_path is None else self.cookie_storage_path
+
+        self.image_path = join(gettempdir(), "GoogleToken", self.account_email, datetime.now()
+                               .strftime("%Y-%m-%d_%H-%M-%S")) if \
+            self.image_path is None else self.image_path
+
+        self.phantomjs_log_path = join(gettempdir(), "GoogleToken", self.account_email, "phantomjs.log") if \
+            self.phantomjs_log_path is None else self.phantomjs_log_path
+
+        self.default_headers = {"User-Agent": self.user_agent} if self.default_headers is \
+                                                                  None else self.default_headers
+
         self.oauth2_data = {"response_type": "token",
                             "client_id": "oauth_client_id",
                             "redirect_uri": "oauth_redirect_uri",
-                            "scope": "oauth_scope"} if oauth2_data is None else oauth2_data
+                            "scope": "oauth_scope"}
 
     def json(self):
         result = {}

GoogleToken/Generator.py

@@ -1,12 +1,12 @@
 # Author:       Scott Philip (sp@scottphilip.com)
-# Version:      0.4 (13 July 2017)
+# Version:      0.5 (24 July 2017)
 # Source:       https://github.com/scottphilip/google-token/
 # Licence:      GNU GENERAL PUBLIC LICENSE (Version 3, 29 June 2007)
 
+from GoogleToken.Configuration import GoogleTokenConfiguration
 from GoogleToken.Utils import *
-from http.cookiejar import MozillaCookieJar
 from os.path import isfile
-from json import dumps
+
 try:
     from urllib.parse import urlparse, parse_qs
     from urllib.request import build_opener, Request, HTTPCookieProcessor
@@ -15,19 +15,18 @@
     from urllib2 import HTTPCookieProcessor, build_opener, Request
 
 
-class GoogleTokenGenerator(GoogleTokenBase):
+class GoogleTokenGenerator(object):
     """
     Google Token Generator
     """
 
-    def __init__(self, config=None):
-        super(GoogleTokenGenerator, self).__init__(config)
-        debug(self.config, "SYSTEM_CONFIGURATION", config.json())
+    def __init__(self, **kwargs):
+        self.config = GoogleTokenConfiguration(**kwargs)
+        debug(self.config, "SYSTEM_CONFIGURATION", self.config.json())
 
     def generate(self):
-        cookie_storage_path = super(GoogleTokenGenerator, self).get_cookie_file_path()
-        if not isfile(cookie_storage_path):
-            debug(self.config, "COOKIE_FILE_NOT_FOUND", cookie_storage_path)
+        if not isfile(self.config.cookie_storage_path):
+            debug(self.config, "COOKIE_FILE_NOT_FOUND", self.config.cookie_storage_path)
             self.__phantom_login()
         return self.__cookies_login()
 
@@ -44,31 +43,40 @@ def __cookies_login(self):
             return http_handler.get_access_token()
 
 
-class GoogleTokenHttpHandler(GoogleTokenBase):
+class GoogleTokenHttpHandler(object):
     """
     Http Handler
     """
 
     def __init__(self, config):
-        super(GoogleTokenHttpHandler, self).__init__(config)
-        self.cookie_jar = MozillaCookieJar()
-        if not isfile(super(GoogleTokenHttpHandler, self).get_cookie_file_path()):
-            raise Exception("COOKIE_FILE_NOT_FOUND", super(GoogleTokenHttpHandler, self).get_cookie_file_path())
-        self.cookie_jar.load(super(GoogleTokenHttpHandler, self).get_cookie_file_path())
+        self.config = config
+        if not isfile(self.config.cookie_storage_path):
+            raise Exception("COOKIE_FILE_NOT_FOUND", self.config.cookie_storage_path)
+        self.cookie_jar = open_cookie_jar(self.config)
         self.opener = build_opener(GoogleTokenHttpNoRedirect,
-                          HTTPCookieProcessor(self.cookie_jar))
+                                   HTTPCookieProcessor(self.cookie_jar))
         debug(self.config, "COOKIES_LOADED")
 
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
-        self.cookie_jar.save(super(GoogleTokenHttpHandler, self).get_cookie_file_path(),
-                             ignore_discard=self.config.cookies_ignore_discard)
+        save_cookie_jar(self.config, self.cookie_jar)
         debug(self.config, "COOKIES_SAVED")
 
+    def get_oauth_url(self):
+        data = {}
+        data.update(self.config.oauth2_data)
+        for key in data:
+            if hasattr(self.config, data[key]):
+                data[key] = getattr(self.config, data[key])
+        return "{0}://{1}{2}?{3}" \
+            .format(self.config.oauth2_protocol,
+                    self.config.oauth2_domain,
+                    self.config.oauth2_path, urlencode(data))
+
     def get_access_token(self):
-        request = Request(super(GoogleTokenHttpHandler, self).get_oauth_url(),
+        request = Request(self.get_oauth_url(),
                           headers=self.config.default_headers)
         debug(self.config, "SENDING_REQUEST")
         response = self.opener.open(request)
@@ -99,7 +107,6 @@ def get_first_value(obj, attr_name):
             return item
         return obj[attr_name]
 
-
     @staticmethod
     def get_fragment(url):
         parsed = urlparse(url)

GoogleToken/Main.py

@@ -0,0 +1,32 @@
+from GoogleToken.Generator import GoogleTokenGenerator
+
+
+def get_google_token(account_email,
+                     oauth_client_id,
+                     oauth_redirect_uri,
+                     oauth_scope,
+                     account_password=None,
+                     account_otp_secret=None,
+                     **kwargs):
+    """
+    :param account_email: (REQUIRED)
+    :param oauth_client_id: (REQUIRED)
+    :param oauth_redirect_uri: (REQUIRED)
+    :param oauth_scope: (REQUIRED)
+    :param account_password: Necessary for first use.
+    :param account_otp_secret: Necessary for first use if enabled on account
+    :return: generated token
+    """
+
+    items = {"account_email": account_email,
+             "oauth_client_id": oauth_client_id,
+             "oauth_redirect_uri": oauth_redirect_uri,
+             "oauth_scope": oauth_scope,
+             "account_password": account_password,
+             "account_otp_secret": account_otp_secret}
+    for key, value in kwargs.items():
+        if key not in items:
+            items[key] = value
+
+    generator = GoogleTokenGenerator(**items)
+    return generator.generate()

GoogleToken/Phantom.py

@@ -1,5 +1,5 @@
 # Author:       Scott Philip (sp@scottphilip.com)
-# Version:      0.4 (13 July 2017)
+# Version:      0.5 (24 July 2017)
 # Source:       https://github.com/scottphilip/google-token/
 # Licence:      GNU GENERAL PUBLIC LICENSE (Version 3, 29 June 2007)
 
@@ -54,8 +54,7 @@ def save_cookies(self):
         for driver_cookie in driver_cookies:
             http_cookie = self.get_cookie(driver_cookie)
             cookie_jar.set_cookie(http_cookie)
-        cookie_jar.save(super(GoogleTokenPhantomLogin, self).get_cookie_file_path(),
-                        ignore_discard=self.config.cookies_ignore_discard)
+        save_cookie_jar(self.config, cookie_jar)
 
     @staticmethod
     def get_cookie(item):