api_key support for COUNTER 5.

fix #96

pycounter/sushi.py

@@ -6,7 +6,7 @@
 import logging
 import time
 import uuid
-
+import warnings
 
 from lxml import etree
 from lxml import objectify
@@ -145,6 +145,11 @@ def get_report(*args, **kwargs):
     else:
         gssr = get_sushi_stats_raw
         rtf = raw_to_full
+        if "api_key" in kwargs:
+            warnings.warn(
+                pycounter.exceptions.SushiWarning("api_key only supported in COUNTER 5")
+            )
+            kwargs.pop("api_key", None)
 
     no_delay = kwargs.pop("no_delay", False)
     delay_amount = 0 if no_delay else 60

pycounter/sushi5.py

@@ -156,6 +156,7 @@ def get_sushi_stats_raw(
     sushi_dump=False,
     verify=True,
     url=None,
+    api_key=None,
     **kwargs
 ):
     """Get SUSHI stats for a given site in dict (decoded from JSON) format.
@@ -182,6 +183,9 @@ def get_sushi_stats_raw(
 
     :param url: str: URL to endpoint for this provider
 
+    :param api_key: str: API key for SUSHI provider (not used by all vendors; see
+        vendor instructions to determine if this is needed)
+
     """
     _check_params(kwargs, release)
     if url is None and wsdl_url:  # pragma: no cover
@@ -199,6 +203,8 @@ def get_sushi_stats_raw(
         "end_date": end_date,
         "requestor_id": requestor_id,
     }
+    if api_key:
+        req_params["api_key"] = api_key
 
     response = requests.get(
         "{url}/reports/{report}".format(**url_params),

pycounter/sushiclient.py

@@ -30,8 +30,9 @@
 @click.option("--requestor_id", "-i", help="Requestor ID")
 @click.option("--requestor_email", help="Email address of requestor")
 @click.option("--requestor_name", help="Internationally recognized organization name")
-@click.option("--customer_reference", "-c", help="Customer reference")
 @click.option("--customer_name", help="Internationally recognized organization name")
+@click.option("--customer_reference", "-c", help="Customer reference")
+@click.option("--api_key", help="API key (COUNTER 5 only)")
 @click.option(
     "--format",
     "-f",
@@ -66,6 +67,7 @@ def main(
     requestor_name,
     customer_name,
     customer_reference,
+    api_key,
     format_,
     output_file,
     dump,
@@ -100,6 +102,7 @@ def main(
         sushi_dump=dump,
         no_delay=no_delay,
         verify=not no_ssl_verify,
+        api_key=api_key,
     )
     if "%s" in output_file:
         output_file = output_file % format_