Add possibility to configure endpoint and application name (#9)

* Add possibility to set the application name #6
Add possibility to configure the endpoint #7

* Allow fluent usage of with_endpoint and with_application
Fix some issues from review

* Fix tests

* remove with_* methods

* remove with_endpoint test

Author: LKaemmerling

hcloud/hcloud.py

@@ -15,7 +15,7 @@
 from hcloud.locations.client import LocationsClient
 from hcloud.datacenters.client import DatacentersClient
 
-from .version import VERSION
+from .version import VERSION, USER_AGENT_PREFIX
 
 
 class HcloudAPIException(Exception):
@@ -29,9 +29,11 @@ class HcloudClient(object):
     version = VERSION
     retry_wait_time = 0.5
 
-    def __init__(self, token):
+    def __init__(self, token, api_endpoint="https://api.hetzner.cloud/v1", application_name=None, application_version=None):
         self.token = token
-        self.api_endpoint = "https://api.hetzner.cloud/v1"
+        self._api_endpoint = api_endpoint
+        self._application_name = application_name
+        self._application_version = application_version
 
         self.datacenters = DatacentersClient(self)
         self.locations = LocationsClient(self)
@@ -45,7 +47,18 @@ def __init__(self, token):
         self.floating_ips = FloatingIPsClient(self)
 
     def _get_user_agent(self):
-        return "hcloud-python/" + self.version
+        if self._application_name is not None and self._application_version is None:
+            return "{application_name} {prefix}/{version}".format(application_name=self._application_name,
+                                                                  prefix=USER_AGENT_PREFIX,
+                                                                  version=self.version)
+        elif self._application_name is not None and self._application_version is not None:
+            return "{application_name}/{application_version} {prefix}/{version}".format(
+                application_name=self._application_name,
+                application_version=self._application_version,
+                prefix=USER_AGENT_PREFIX,
+                version=self.version)
+        else:
+            return "{prefix}/{version}".format(prefix=USER_AGENT_PREFIX, version=self.version)
 
     def _get_headers(self):
         headers = {
@@ -73,7 +86,7 @@ def _raise_exception_from_json_content(self, json_content):
     def request(self, method, url, tries=1, **kwargs):
         response = requests.request(
             method,
-            self.api_endpoint + url,
+            self._api_endpoint + url,
             headers=self._get_headers(),
             **kwargs
         )

hcloud/version.py

@@ -1 +1,2 @@
 VERSION = '0.1.0'
+USER_AGENT_PREFIX = 'hcloud-python'

tests/integration/conftest.py

@@ -6,6 +6,5 @@
 
 @pytest.fixture(autouse=True, scope='function')
 def hetzner_client():
-    hetzner_client = HcloudClient(token="test-token")
-    hetzner_client.api_endpoint = os.getenv("FAKE_API_ENDPOINT", default="http://localhost:8080")
+    hetzner_client = HcloudClient(token="test-token", api_endpoint=os.getenv("FAKE_API_ENDPOINT", default="http://localhost:4000"))
     return hetzner_client

tests/unit/test_hcloud.py

@@ -55,6 +55,16 @@ def test__get_user_agent(self, client):
         user_agent = client._get_user_agent()
         assert user_agent == "hcloud-python/0.0.0"
 
+    def test__get_user_agent_with_application_name(self, client):
+        client = HcloudClient(token="project_token", application_name="my-app")
+        user_agent = client._get_user_agent()
+        assert user_agent == "my-app hcloud-python/0.0.0"
+
+    def test__get_user_agent_with_application_name_and_version(self, client):
+        client = HcloudClient(token="project_token", application_name="my-app", application_version="1.0.0")
+        user_agent = client._get_user_agent()
+        assert user_agent == "my-app/1.0.0 hcloud-python/0.0.0"
+
     def test__get_headers(self, client):
         headers = client._get_headers()
         assert headers == {