cli: Improve http/https dichotomy

Removed https protocol from protocol options, keeping only http or xrootd
Accepting https with --server option
closes #92

cernopendata_client/cli.py

@@ -115,7 +115,7 @@ def get_metadata(server, recid, doi, title, output_value):
 @click.option(
     "--protocol",
     default="http",
-    type=click.Choice(["http", "https", "xrootd"]),
+    type=click.Choice(["http", "xrootd"]),
     help="Protocol to be used in links.",
 )
 @click.option(
@@ -147,6 +147,8 @@ def get_file_locations(server, recid, doi, title, protocol, expand, verbose):
       $ cernopendata-client get-file-locations --recid 5500 --verbose
     """
     validate_server(server)
+    if server != SERVER_HTTP_URI:
+        protocol = server.split(":")[0]
     if recid is not None:
         validate_recid(recid)
     record_json = get_record_as_json(server, recid, doi, title)
@@ -165,7 +167,7 @@ def get_file_locations(server, recid, doi, title, protocol, expand, verbose):
 @click.option(
     "--protocol",
     default="http",
-    type=click.Choice(["http", "https", "xrootd"]),
+    type=click.Choice(["http", "xrootd"]),
     help="Protocol to be used in links.",
 )
 @click.option(
@@ -229,6 +231,8 @@ def download_files(
       $ cernopendata-client download-files --recid 5500 --filter-regexp py --filter-range 1-2
     """
     validate_server(server)
+    if server != SERVER_HTTP_URI:
+        protocol = server.split(":")[0]
     if recid is not None:
         validate_recid(recid)
     record_json = get_record_as_json(server, recid, doi, title)

cernopendata_client/downloader.py

@@ -87,7 +87,7 @@ def download_single_file(path=None, file_location=None, protocol=None):
         if not xrootd_available:
             display_message(
                 msg_type="error",
-                msg="xrootd is not installed on system. Please use the 'http' or 'https' protocol instead.",
+                msg="xrootd is not installed on system. Please use the 'http' protocol instead.",
             )
             sys.exit(1)
         file_src = file_location.split("root://eospublic.cern.ch/")[-1]

cernopendata_client/searcher.py

@@ -180,7 +180,7 @@ def get_files_list(
 
     :param server: CERN Open Data server to query
     :param record_json: Record content in JSON
-    :protocol: Protocol to be used in links(http | https | xrootd)
+    :protocol: Protocol to be used in links(http | xrootd)
     :expand: Flag for expanding file indexes
     :verbose: Flag for showing size and checksum of file
     :type server: str

docs/usage.rst

@@ -111,25 +111,7 @@ the **get-file-locations** command:
     http://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/mass4l_combine.png
 
 This command will output URIs for all the files associated with the record ID 5500, using the HTTP protocol.
-
-**HTTPS protocol**
-
-.. code-block:: console
-
-    $ cernopendata-client get-file-locations --recid 5500 --protocol https
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/BuildFile.xml
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/HiggsDemoAnalyzer.cc
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/List_indexfile.txt
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/M4Lnormdatall.cc
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/M4Lnormdatall_lvl3.cc
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/demoanalyzer_cfg_level3MC.py
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/demoanalyzer_cfg_level3data.py
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/demoanalyzer_cfg_level4MC.py
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/demoanalyzer_cfg_level4data.py
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/mass4l_combine.pdf
-    https://opendata.cern.ch/eos/opendata/cms/software/HiggsExample20112012/mass4l_combine.png
-
-This command will output URIs for all the files associated with the record ID 5500, using the HTTPS protocol.
+Note that you can specify `--server https://opendata.cern.ch` if you would like to use the HTTPS protocol instead.
 
 **XRootD protocol**
 
@@ -271,51 +253,7 @@ In order to download data files belonging to a record, please use the
     ==> Success!
 
 The command will download files into a `5500` directory.
-
-**HTTPS protocol**
-
-Note that you can use ``--protocol https`` command-line option if you
-would rather want to download files with https protocol:
-
-.. code-block:: console
-
-    $ cernopendata-client download-files --recid 5500 --protocol https
-    ==> Downloading file 1 of 11
-      -> File: ./5500/BuildFile.xml
-      -> Progress: 0/0 kiB (100%)
-    ==> Downloading file 2 of 11
-      -> File: ./5500/HiggsDemoAnalyzer.cc
-      -> Progress: 81/81 kiB (100%)
-    ==> Downloading file 3 of 11
-      -> File: ./5500/List_indexfile.txt
-      -> Progress: 1/1 kiB (100%)
-    ==> Downloading file 4 of 11
-      -> File: ./5500/M4Lnormdatall.cc
-      -> Progress: 14/14 kiB (100%)
-    ==> Downloading file 5 of 11
-      -> File: ./5500/M4Lnormdatall_lvl3.cc
-      -> Progress: 15/15 kiB (100%)
-    ==> Downloading file 6 of 11
-      -> File: ./5500/demoanalyzer_cfg_level3MC.py
-      -> Progress: 3/3 kiB (100%)
-    ==> Downloading file 7 of 11
-      -> File: ./5500/demoanalyzer_cfg_level3data.py
-      -> Progress: 3/3 kiB (100%)
-    ==> Downloading file 8 of 11
-      -> File: ./5500/demoanalyzer_cfg_level4MC.py
-      -> Progress: 3/3 kiB (100%)
-    ==> Downloading file 9 of 11
-      -> File: ./5500/demoanalyzer_cfg_level4data.py
-      -> Progress: 3/3 kiB (100%)
-    ==> Downloading file 10 of 11
-      -> File: ./5500/mass4l_combine.pdf
-      -> Progress: 17/17 kiB (100%)
-    ==> Downloading file 11 of 11
-      -> File: ./5500/mass4l_combine.png
-      -> Progress: 90/90 kiB (100%)
-    ==> Success!
-
-The command will download files into a `5500` directory.
+Note that you can specify `--server https://opendata.cern.ch` if you would like to use the HTTPS protocol instead.
 
 **XRootD protocol**
 

tests/test_cli_download_files.py

@@ -14,6 +14,7 @@
 
 from click.testing import CliRunner
 from cernopendata_client.cli import download_files
+from cernopendata_client.config import SERVER_HTTPS_URI
 
 
 def test_dry_run_from_recid():
@@ -94,7 +95,7 @@ def test_download_files_https_pycurl():
         os.remove(test_file)
     test_download_files = CliRunner()
     test_result = test_download_files.invoke(
-        download_files, ["--recid", 3005, "--protocol", "https"]
+        download_files, ["--recid", 3005, "--server", SERVER_HTTPS_URI]
     )
     assert test_result.exit_code == 0
     assert os.path.isfile(test_file) is True
@@ -112,7 +113,7 @@ def test_download_files_https_requests(mocker):
         os.remove(test_file)
     test_download_files = CliRunner()
     test_result = test_download_files.invoke(
-        download_files, ["--recid", 3005, "--protocol", "https"]
+        download_files, ["--recid", 3005, "--server", SERVER_HTTPS_URI]
     )
     assert test_result.exit_code == 0
     assert os.path.isfile(test_file) is True