python-service-builder 1.3.0__tar.gz → 2.1.0__tar.gz

{python_service_builder-1.3.0/python_service_builder.egg-info → python_service_builder-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-service-builder
-Version: 1.3.0
+Version: 2.1.0
 Summary: Helper library for easier creation of Google services.
 Author-email: David Harcombe <david.harcombe@gmail.com>
 License-Expression: Apache-2.0
@@ -49,10 +49,12 @@ ready for use.
 
 `service_builder.build_service()` needs two mandatory pieces of information:
 
-| Parameter | Description |
-| :-: | - |
-| key | The credentials to use to authenticate the user to the service it has to create |
-| service | The Google API endpoint it is trying to connect to. |
+| Parameter | Type | Description |
+| :-: | - | - |
+| key | str | The credentials to use to authenticate the user to the service it has to create. |
+| service | Service | The Google API endpoint it is trying to connect to. |
+| api_key | _See below_ | _Optional_ An API key for those services which require an API key in addition to credentials. |
+| extra_scopes | List[str] | _Optional_ Extra OAuth scopes needed. |
 
 ### `key`
 
@@ -60,7 +62,7 @@ These can be supplied in one of 4 ways.
 
 1. A valid `google.oauth2.Credentials` object, created and passed to the
    service builder.
-1. An `str` which is the name of a local file containing the `json`
+1. A `str` which is the name of a local file containing the `json`
    representation of an OAuth credentials object.
 1. A `Mapping` object which is a `json` keyfile `dict`
 2. An `OAuthKey` object from this package, which is a `dataclass` object
@@ -69,11 +71,36 @@ These can be supplied in one of 4 ways.
 ### `service`
 
 This is an Enum in the `service_framework.service` module, which defines
-the Google service you're planning to connect to. All of these services are
-dynamically built, but their names match the Google-defined name.
+the Google service you're planning to connect to. All the standard Google
+services are included (as of the date listed in the `Services.py` file).
 
-### Example
+If a
+new service has been added but this library has yet to be updated, you can
+request it by using either `Service('<UNLISTED SERVICE>')` or
+`Service.from_value('<UNLISTED SERVICE>')`. This will cause the library to
+attempt to fetch the service's definition from Google and will create an
+entry in the enum for this new service.
 
+### Examples
+
+#### 1. Using `Credentials`
+```
+from service_framework.services import Service
+from service_framework import service_builder
+from google.oauth2 import credentials as oauth
+
+credentials = oauth.Credentials(
+   access_token="<YOUR ACCESS TOKEN>",
+   refresh_token="<YOUR REFRESH TOKEN>",
+   token_uri="https://oauth2.googleapis.com/token",
+   client_id="<YOUR CLIENT ID>",
+   client_secret="<YOUR CLIENT SECRET>"
+)
+
+service = service_builder.build_service(service=Service.CHAT, key=credentials)
+```
+
+#### 2. Using an `OAuthKey`
 ```
 from service_framework.services import Service
 from service_framework import service_builder
@@ -93,12 +120,3 @@ Here, we are creating the key as an `OAuthKey` object as we have clearly got the
 tokens and client_[id|secret] from elsewhere. Creating the service is then as
 simple as invoking the `service_builder.build_service` method which will return
 you a service you can use.
-
-### Other parameters
-
-`service_builder.build_service()` can also take 2 other optional parameters.
-
-| Parameter | Description |
-| :-: | - |
-| api_key | Some APIs require an API key as well as the OAuth credentials |
-| extra_scopes | Any extra OAUth scopes required for the operation |

{python_service_builder-1.3.0 → python_service_builder-2.1.0}/README.md

@@ -18,10 +18,12 @@ ready for use.
 
 `service_builder.build_service()` needs two mandatory pieces of information:
 
-| Parameter | Description |
-| :-: | - |
-| key | The credentials to use to authenticate the user to the service it has to create |
-| service | The Google API endpoint it is trying to connect to. |
+| Parameter | Type | Description |
+| :-: | - | - |
+| key | str | The credentials to use to authenticate the user to the service it has to create. |
+| service | Service | The Google API endpoint it is trying to connect to. |
+| api_key | _See below_ | _Optional_ An API key for those services which require an API key in addition to credentials. |
+| extra_scopes | List[str] | _Optional_ Extra OAuth scopes needed. |
 
 ### `key`
 
@@ -29,7 +31,7 @@ These can be supplied in one of 4 ways.
 
 1. A valid `google.oauth2.Credentials` object, created and passed to the
    service builder.
-1. An `str` which is the name of a local file containing the `json`
+1. A `str` which is the name of a local file containing the `json`
    representation of an OAuth credentials object.
 1. A `Mapping` object which is a `json` keyfile `dict`
 2. An `OAuthKey` object from this package, which is a `dataclass` object
@@ -38,11 +40,36 @@ These can be supplied in one of 4 ways.
 ### `service`
 
 This is an Enum in the `service_framework.service` module, which defines
-the Google service you're planning to connect to. All of these services are
-dynamically built, but their names match the Google-defined name.
+the Google service you're planning to connect to. All the standard Google
+services are included (as of the date listed in the `Services.py` file).
 
-### Example
+If a
+new service has been added but this library has yet to be updated, you can
+request it by using either `Service('<UNLISTED SERVICE>')` or
+`Service.from_value('<UNLISTED SERVICE>')`. This will cause the library to
+attempt to fetch the service's definition from Google and will create an
+entry in the enum for this new service.
 
+### Examples
+
+#### 1. Using `Credentials`
+```
+from service_framework.services import Service
+from service_framework import service_builder
+from google.oauth2 import credentials as oauth
+
+credentials = oauth.Credentials(
+   access_token="<YOUR ACCESS TOKEN>",
+   refresh_token="<YOUR REFRESH TOKEN>",
+   token_uri="https://oauth2.googleapis.com/token",
+   client_id="<YOUR CLIENT ID>",
+   client_secret="<YOUR CLIENT SECRET>"
+)
+
+service = service_builder.build_service(service=Service.CHAT, key=credentials)
+```
+
+#### 2. Using an `OAuthKey`
 ```
 from service_framework.services import Service
 from service_framework import service_builder
@@ -62,12 +89,3 @@ Here, we are creating the key as an `OAuthKey` object as we have clearly got the
 tokens and client_[id|secret] from elsewhere. Creating the service is then as
 simple as invoking the `service_builder.build_service` method which will return
 you a service you can use.
-
-### Other parameters
-
-`service_builder.build_service()` can also take 2 other optional parameters.
-
-| Parameter | Description |
-| :-: | - |
-| api_key | Some APIs require an API key as well as the OAuth credentials |
-| extra_scopes | Any extra OAUth scopes required for the operation |

{python_service_builder-1.3.0 → python_service_builder-2.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = "python-service-builder"
-version = "1.3.0"
+version = "2.1.0"
 authors = [{ name = "David Harcombe", email = "david.harcombe@gmail.com" }]
 description = "Helper library for easier creation of Google services."
 readme = "README.md"

{python_service_builder-1.3.0 → python_service_builder-2.1.0/python_service_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-service-builder
-Version: 1.3.0
+Version: 2.1.0
 Summary: Helper library for easier creation of Google services.
 Author-email: David Harcombe <david.harcombe@gmail.com>
 License-Expression: Apache-2.0
@@ -49,10 +49,12 @@ ready for use.
 
 `service_builder.build_service()` needs two mandatory pieces of information:
 
-| Parameter | Description |
-| :-: | - |
-| key | The credentials to use to authenticate the user to the service it has to create |
-| service | The Google API endpoint it is trying to connect to. |
+| Parameter | Type | Description |
+| :-: | - | - |
+| key | str | The credentials to use to authenticate the user to the service it has to create. |
+| service | Service | The Google API endpoint it is trying to connect to. |
+| api_key | _See below_ | _Optional_ An API key for those services which require an API key in addition to credentials. |
+| extra_scopes | List[str] | _Optional_ Extra OAuth scopes needed. |
 
 ### `key`
 
@@ -60,7 +62,7 @@ These can be supplied in one of 4 ways.
 
 1. A valid `google.oauth2.Credentials` object, created and passed to the
    service builder.
-1. An `str` which is the name of a local file containing the `json`
+1. A `str` which is the name of a local file containing the `json`
    representation of an OAuth credentials object.
 1. A `Mapping` object which is a `json` keyfile `dict`
 2. An `OAuthKey` object from this package, which is a `dataclass` object
@@ -69,11 +71,36 @@ These can be supplied in one of 4 ways.
 ### `service`
 
 This is an Enum in the `service_framework.service` module, which defines
-the Google service you're planning to connect to. All of these services are
-dynamically built, but their names match the Google-defined name.
+the Google service you're planning to connect to. All the standard Google
+services are included (as of the date listed in the `Services.py` file).
 
-### Example
+If a
+new service has been added but this library has yet to be updated, you can
+request it by using either `Service('<UNLISTED SERVICE>')` or
+`Service.from_value('<UNLISTED SERVICE>')`. This will cause the library to
+attempt to fetch the service's definition from Google and will create an
+entry in the enum for this new service.
 
+### Examples
+
+#### 1. Using `Credentials`
+```
+from service_framework.services import Service
+from service_framework import service_builder
+from google.oauth2 import credentials as oauth
+
+credentials = oauth.Credentials(
+   access_token="<YOUR ACCESS TOKEN>",
+   refresh_token="<YOUR REFRESH TOKEN>",
+   token_uri="https://oauth2.googleapis.com/token",
+   client_id="<YOUR CLIENT ID>",
+   client_secret="<YOUR CLIENT SECRET>"
+)
+
+service = service_builder.build_service(service=Service.CHAT, key=credentials)
+```
+
+#### 2. Using an `OAuthKey`
 ```
 from service_framework.services import Service
 from service_framework import service_builder
@@ -93,12 +120,3 @@ Here, we are creating the key as an `OAuthKey` object as we have clearly got the
 tokens and client_[id|secret] from elsewhere. Creating the service is then as
 simple as invoking the `service_builder.build_service` method which will return
 you a service you can use.
-
-### Other parameters
-
-`service_builder.build_service()` can also take 2 other optional parameters.
-
-| Parameter | Description |
-| :-: | - |
-| api_key | Some APIs require an API key as well as the OAuth credentials |
-| extra_scopes | Any extra OAUth scopes required for the operation |

{python_service_builder-1.3.0 → python_service_builder-2.1.0}/python_service_builder.egg-info/SOURCES.txt

@@ -8,7 +8,8 @@ python_service_builder.egg-info/requires.txt
 python_service_builder.egg-info/top_level.txt
 service_framework/__init__.py
 service_framework/__init_test.py
-service_framework/list_services.py
 service_framework/service_builder.py
+service_framework/service_finder.py
 service_framework/services.py
-service_framework/services_test.py
+service_framework/services_test.py
+service_framework/update_services.py

{python_service_builder-1.3.0 → python_service_builder-2.1.0}/service_framework/__init__.py

@@ -12,27 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import dataclasses
-from typing import Any, Callable, Mapping
+from typing import Any, Mapping
 
 import dataclasses_json
 
 
-def lazy_property(f: Callable):
-  """Decorator that makes a property lazy-evaluated.
-
-  Args:
-    f: the function to convert to a lazy property.
-  """
-  attr_name = '_lazy_' + f.__name__
-
-  @property
-  def _lazy_property(self) -> Any:
-    if not hasattr(self, attr_name):
-      setattr(self, attr_name, f(self))
-    return getattr(self, attr_name)
-  return _lazy_property
-
-
 def metadata(base: Mapping[str, Any], **custom) -> Mapping[str, Any]:
   """Merges properties into the metadata and returns the merged result.
 
@@ -113,3 +97,12 @@ def camel_field(default: Any = None,
   """
   return field(default=default, default_factory=default_factory,
                letter_case=dataclasses_json.LetterCase.CAMEL, **kwargs)
+
+
+@dataclasses_json.dataclass_json
+@dataclasses.dataclass
+class ServiceDefinition(object):
+  """Defines a Google Service for the builder."""
+  service_name: str = camel_field()
+  version: str = camel_field()
+  discovery_service_url: str = camel_field()

{python_service_builder-1.3.0 → python_service_builder-2.1.0}/service_framework/service_builder.py

@@ -36,7 +36,7 @@ class OAuthKey(object):
 
   NOTE: This is by no means the entire key; just the fields neccessary for OAuth.
   """
-  access_token: Optional[str] = snake_field(field_name='token')
+  access_token: Optional[str] = snake_field(field_name='ken')
   refresh_token: Optional[str] = snake_field()
   token_uri: Optional[str] = snake_field()
   client_id: Optional[str] = snake_field()

python_service_builder-1.3.0/service_framework/list_services.py → python_service_builder-2.1.0/service_framework/service_finder.py

@@ -16,42 +16,46 @@ import json
 import urllib.parse
 import urllib.request
 from collections import namedtuple
-from contextlib import closing, suppress
-from pprint import pprint
+from contextlib import closing
 from typing import Mapping
 from urllib.request import urlopen
 
-import aenum as enum
-from absl import app
+from service_framework import ServiceDefinition
 
-from service_framework.services import ServiceDefinition
 
-""" _summary_
-"""
+class ServiceFinder(object):
+  """ServiceFinder
+  """
+  def __call__(cls, value, *args, **kwargs) -> ServiceDefinition:
+    """What to do when the `ServiceFinder` is invoked
 
+    Usage:
+        ```
+        finder = ServiceFinder()
+        finder('CHAT')
+        ```
 
-class ServiceFinder(enum.EnumMeta):
-  def __call__(cls, value, *args, **kwargs):
-    api = ServiceLister().find(name=value.lower())
-    if api:
-      (service_name, version) = api[0]
-      definition = ServiceDefinition(
-          service_name=service_name,
-          version=version,
-          discovery_service_url=(
-              f'https://{service_name}.googleapis.com/$discovery/rest'
-              f'?version={version}'))
-      return definition
+    Args:
+        value (str): the name of the service to find
 
-    else:
-      raise Exception(f'No service found for {value}')
+    Raises:
+        Exception: No valid Google service of this name exists
+
+    Returns:
+        ServiceDefinition: the service definition
+    """
+    if api := ServiceFinder.find(name=value.lower()):
+      return api[value.upper()]
 
+    else:
+      raise Exception(f'No Google service found with the name {value.upper()}')
 
-class ServiceLister(object):
-  def find_all(self) -> Mapping[str, str]:
-    return self.find(None)
+  @classmethod
+  def find_all(cls) -> Mapping[str, ServiceDefinition]:
+    return cls.find(None)
 
-  def find(self, name: str) -> Mapping[str, str]:
+  @classmethod
+  def find(cls, name: str) -> Mapping[str, ServiceDefinition]:
     Components = namedtuple(
         typename='Components',
         field_names=['scheme', 'netloc', 'url', 'path', 'query', 'fragment']
@@ -59,8 +63,7 @@ class ServiceLister(object):
 
     apis = {}
 
-    parameters = {#'fields': 'items.name,items.version',
-                  'preferred': 'true'}
+    parameters = {'preferred': 'true'}
     if name:
       parameters |= {'name': name}
 
@@ -80,19 +83,7 @@ class ServiceLister(object):
       api_list = json.loads(_api_list.read())
       if items := api_list.get('items', None):
         for api in items:
-          apis[api['name'].upper()] = (api['name'], api['version'], api['discoveryRestUrl'])
+          apis[api['name'].upper()] = ServiceDefinition(
+              api['name'], api['version'], api['discoveryRestUrl'])
 
     return apis
-
-
-def main(unused) -> None:
-  del unused
-
-  # apis = ServiceLister().find(name='CHAT'.lower())
-  apis = ServiceLister().find_all()
-  pprint(apis, indent=2)
-
-
-if __name__ == '__main__':
-  with suppress(SystemExit):
-    app.run(main)