Added load_from_dict method to the GoogleAdsClient (googleads#152)

akaashhazarika · BenRKarl · commit 78c11565efb2 · 2019-07-17T08:56:42.000-04:00
diff --git a/google/ads/google_ads/client.py b/google/ads/google_ads/client.py
@@ -95,6 +95,25 @@ def load_from_string(cls, yaml_str):
         kwargs = cls._get_client_kwargs(config_data)
         return cls(**kwargs)
 
+    @classmethod  
+    def load_from_dict(cls, config_dict):
+        """Creates a GoogleAdsClient with data stored in the config_dict.
+
+        Args:
+            config_dict: a dict consisting of configuration data used to
+                initialize a GoogleAdsClient.
+
+        Returns:
+            A GoogleAdsClient initialized with the values specified in the
+                dict.
+
+        Raises:
+            ValueError: If the configuration lacks a required field.
+        """
+        config_data = config.load_from_dict(config_dict)
+        kwargs = cls._get_client_kwargs(config_data)
+        return cls(**kwargs)
+
     @classmethod
     def load_from_storage(cls, path=None):
         """Creates a GoogleAdsClient with data stored in the specified file.
diff --git a/google/ads/google_ads/config.py b/google/ads/google_ads/config.py
@@ -130,6 +130,28 @@ def load_from_yaml_file(path=None):
     return parse_yaml_document_to_dict(yaml_doc)
 
 
+@_config_validation_decorator
+@_config_parser_decorator
+def load_from_dict(config_dict):
+    """Check if the argument is dictionary or not. If successful it calls the parsing decorator,
+    followed by validation decorator. This validates the keys used in the config_dict, before
+    returning to its caller.
+
+    Args:
+        config_dict: a dict containing client configuration.
+
+    Returns:
+        The same input dictionary that is passed into the function.
+
+    Raises:
+        A value error if the argument (config_dict) is not a dict.
+    """
+    if isinstance(config_dict, dict):
+        return config_dict
+    else:
+        raise ValueError("The configuration object passed to function load_from_dict must be of type dict.")
+
+
 @_config_validation_decorator
 @_config_parser_decorator
 def parse_yaml_document_to_dict(yaml_doc):
diff --git a/tests/client_test.py b/tests/client_test.py
@@ -200,6 +200,32 @@ def test_get_client_kwargs_custom_endpoint(self):
                     'logging_config': None
                 })
 
+    def test_load_from_dict(self):
+        config = {
+            'developer_token': self.developer_token,
+            'client_id': self.client_id,
+            'client_secret': self.client_secret,
+            'refresh_token': self.refresh_token}
+        mock_credentials_instance = mock.Mock()
+
+        with mock.patch.object(
+            Client.GoogleAdsClient,
+            '__init__',
+            return_value=None
+        ) as mock_client_init, mock.patch.object(
+            Client.oauth2,
+            'get_installed_app_credentials',
+            return_value=mock_credentials_instance
+        ) as mock_credentials:
+          Client.GoogleAdsClient.load_from_dict(config)
+          
+          mock_client_init.assert_called_once_with(
+          credentials=mock_credentials_instance,
+          developer_token=self.developer_token,
+          endpoint=None,
+          login_customer_id=None,
+          logging_config=None)
+
     def test_load_from_storage(self):
         config = {
             'developer_token': self.developer_token,
diff --git a/tests/config_test.py b/tests/config_test.py
@@ -120,6 +120,18 @@ def test_parse_yaml_document_to_dict_missing_required_key(self):
             config.parse_yaml_document_to_dict,
             yaml_doc)
 
+    def test_load_from_dict(self):
+        config_data = {
+              'developer_token': self.developer_token,
+              'client_id': self.client_id,
+              'client_secret': self.client_secret,
+              'refresh_token': self.refresh_token}
+        self.assertEqual(config.load_from_dict(config_data), config_data)
+    
+    def test_load_from_dict_error(self):
+        config_data = 111
+        self.assertRaises(ValueError, config.load_from_dict, config_data)
+
     def test_load_from_env(self):
         environ = {
             'GOOGLE_ADS_DEVELOPER_TOKEN': self.developer_token,
