Merge pull request #1 from bollenn/add_search_and_download

add searching for latest revs and download

Author: ptillemans

rt_factory/rt_factory.py

@@ -2,10 +2,16 @@
 import requests
 from requests.auth import HTTPBasicAuth
 import os
+try:
+    from urllib import urlencode
+except ImportError:
+    from urllib.parse import urlencode
+import logging
 
 # get the artifactory url from the environment
 ARTIFACTORY_URL = os.environ.get('ARTIFACTORY_URL',
                                  'http://localhost:8080/artifactory/api/')
+ARTIFACTORY_API_KEY = os.environ.get('ARTIFACTORY_API_KEY', '')
 
 
 class ApiError(Exception):
@@ -15,23 +21,27 @@ class ArtifactoryApi:
 
     def __init__(self, url = ARTIFACTORY_URL):
         self.url = url
+        self.api_key_header = None
 
-    def _get(self, path):
-        resp = requests.get(self.url + path)
+    def _get_from_url(self, full_url):
+        resp = requests.get(full_url, headers=self.api_key_header)
         if not resp.ok:
             # This means something went wrong.
-            raise ApiError('GET {} {}'.format(path, resp.status_code))
+            raise ApiError('GET {} {}'.format(full_url, resp.status_code))
         return resp.json()
 
+    def _get(self, path):
+        return self._get_from_url(self.url + path)
+
     def _post(self, path, payload):
-        resp = requests.post(self.url + path, json = payload)
+        resp = requests.post(self.url + path, json = payload, headers=self.api_key_header)
         if not resp.ok:
             # This means something went wrong.
             raise ApiError('POST {} {} {}'.format(path, resp.status_code, resp.content))
         return resp
 
-    def _put(self, path, payload):
-        resp = requests.put(self.url + path, json = payload)
+    def _put(self, path, payload=None):
+        resp = requests.put(self.url + path, json = payload, headers=self.api_key_header)
         if not resp.ok:
             # This means something went wrong.
             raise ApiError('PUT {} {} {}'.format(path, resp.status_code, resp.content))
@@ -153,3 +163,67 @@ def add_private_key(self, filename, phrase):
         path = 'gpg/key/private'
         self._put_file(path, filename, headers={'X-GPG-PASSPHRASE': phrase})
 
+    def get_link_to_last_modified(self, repository, path):
+        """ Searches for artifacts with the latest modification date.
+
+        Args:
+            repo (str): The repository name.
+            path (str): The full path to the file to be searched for.
+
+        Returns:
+            str: Download url to the artifact.
+        """
+        path = 'storage/{repo}/{path}/?lastModified'.format(repo=repository, path=path)
+        temp_link = self._get(path)['uri']
+        return self._get_from_url(temp_link)['downloadUri']
+
+    def get_link_to_last_version(self, repository, path):
+        """ Searches for artifacts with the latest value in the "version" property. Only artifacts
+        with a "version" property expressly defined in lower case will be taken into account. 
+
+        Args:
+            repository (str): The repository name.
+            path (str): The full path to the file to be searched for.
+
+        Returns:
+            str: Download url to the artifact.
+
+        Notes:
+            Requires an authenticated user (not anonymous).
+        """
+        path = 'versions/{repo}/{path}?listFiles=1'.format(repo=repository, path=path)
+        temp_link = self._get(path)
+        return temp_link['artifacts'][0]['downloadUri']
+
+    def download_file(self, url, path_to_file):
+        """ Download a file from the Artifactory server.
+
+        Args:
+            url (str): Url to the file to be downloaded.
+            path_to_file (str): Path + filename to be used for downloading the file.
+        """
+        dl_content = requests.get(url, stream=True)
+        with open(path_to_file, 'wb') as output_file:
+            for chunk in dl_content.iter_content(chunk_size=1024): 
+                if chunk:
+                    output_file.write(chunk)
+
+    def set_authentication_api_key(self, api_key=ARTIFACTORY_API_KEY):
+        """ Set the API Key for running commands needing authentication.
+
+        Args:
+            the_key (str): The users Artifactory API key.
+        """
+        self.api_key_header = {'X-JFrog-Art-Api':api_key}
+
+    def add_properties(self, repository, path, properties):
+        """ Set properties of an artifact
+
+        Args:
+            repository (str): The repository name.
+            path (str): The full path to the file to be searched for.
+            properties (list): Json list of properties to set on the artifact.
+        """
+        prop = urlencode(properties).replace('&', '|')
+        path = 'storage/{repo}/{path}?properties={prop}&recursive=1'.format(repo=repository, path=path, prop=prop)
+        self._put(path, properties)