if isinstance(value, dict):

return dict((k, _sanitize(v))

for k, v in six.iteritems(value))

if isinstance(value, six.string_types):

return value.replace('/', '%2F')

"""Represents a GitLab server connection.

def __init__(self, url, private_token=None, oauth_token=None, email=None,

password=None, ssl_verify=True, http_username=None,

http_password=None, timeout=None, api_version='4',

session=None, per_page=None):

self._api_version = str(api_version)

self._server_version = self._server_revision = None

self._base_url = url

self._url = '%s/api/v%s' % (url, api_version)

#: Timeout to use for requests to gitlab server

self.timeout = timeout

#: Headers that will be used in request to GitLab

self.headers = {}

#: The user email

self.email = email

#: The user password (associated with email)

self.password = password

#: Whether SSL certificates should be validated

self.ssl_verify = ssl_verify

self.private_token = private_token

self.http_username = http_username

self.http_password = http_password

self.oauth_token = oauth_token

self._set_auth_info()

#: Create a session object for requests

self.session = session or requests.Session()

self.per_page = per_page

objects = importlib.import_module('gitlab.v%s.objects' %

self._api_version)

self._objects = objects

self.broadcastmessages = objects.BroadcastMessageManager(self)

self.deploykeys = objects.DeployKeyManager(self)

self.geonodes = objects.GeoNodeManager(self)

self.gitlabciymls = objects.GitlabciymlManager(self)

self.gitignores = objects.GitignoreManager(self)

self.groups = objects.GroupManager(self)

self.hooks = objects.HookManager(self)

self.issues = objects.IssueManager(self)

self.ldapgroups = objects.LDAPGroupManager(self)

self.licenses = objects.LicenseManager(self)

self.namespaces = objects.NamespaceManager(self)

self.mergerequests = objects.MergeRequestManager(self)

self.notificationsettings = objects.NotificationSettingsManager(self)

self.projects = objects.ProjectManager(self)

self.runners = objects.RunnerManager(self)

self.settings = objects.ApplicationSettingsManager(self)

self.sidekiq = objects.SidekiqManager(self)

self.snippets = objects.SnippetManager(self)

self.users = objects.UserManager(self)

self.todos = objects.TodoManager(self)

self.dockerfiles = objects.DockerfileManager(self)

self.events = objects.EventManager(self)

self.features = objects.FeatureManager(self)

self.pagesdomains = objects.PagesDomainManager(self)

self.user_activities = objects.UserActivitiesManager(self)

def __enter__(self):

return self

def __exit__(self, *args):

self.session.close()

def __getstate__(self):

state = self.__dict__.copy()

state.pop('_objects')

return state

def __setstate__(self, state):

self.__dict__.update(state)

objects = importlib.import_module('gitlab.v%s.objects' %

self._api_version)

self._objects = objects

@property

def url(self):

"""The user-provided server URL."""

return self._base_url

@property

def api_url(self):

"""The computed API base URL."""

return self._url

@property

def api_version(self):

"""The API version used (4 only)."""

return self._api_version

@staticmethod

def from_config(gitlab_id=None, config_files=None):

"""Create a Gitlab connection from configuration files.

config = gitlab.config.GitlabConfigParser(gitlab_id=gitlab_id,

config_files=config_files)

return Gitlab(config.url, private_token=config.private_token,

oauth_token=config.oauth_token,

ssl_verify=config.ssl_verify, timeout=config.timeout,

http_username=config.http_username,

http_password=config.http_password,

api_version=config.api_version,

per_page=config.per_page)

def auth(self):

"""Performs an authentication.

if self.private_token or self.oauth_token:

self._token_auth()

else:

self._credentials_auth()

def _credentials_auth(self):

data = {'email': self.email, 'password': self.password}

r = self.http_post('/session', data)

manager = self._objects.CurrentUserManager(self)

self.user = self._objects.CurrentUser(manager, r)

self.private_token = self.user.private_token

self._set_auth_info()

def _token_auth(self):

self.user = self._objects.CurrentUserManager(self).get()

def version(self):

"""Returns the version and revision of the gitlab server.

if self._server_version is None:

try:

data = self.http_get('/version')

self._server_version = data['version']

self._server_revision = data['revision']

except Exception:

self._server_version = self._server_revision = 'unknown'

return self._server_version, self._server_revision

@on_http_error(GitlabVerifyError)

def lint(self, content, **kwargs):

"""Validate a gitlab CI configuration.

post_data = {'content': content}

data = self.http_post('/ci/lint', post_data=post_data, **kwargs)

return (data['status'] == 'valid', data['errors'])

@on_http_error(GitlabMarkdownError)

def markdown(self, text, gfm=False, project=None, **kwargs):

"""Render an arbitrary Markdown document.

post_data = {'text': text, 'gfm': gfm}

if project is not None:

post_data['project'] = project

data = self.http_post('/markdown', post_data=post_data, **kwargs)

return data['html']

@on_http_error(GitlabLicenseError)

def get_license(self, **kwargs):

"""Retrieve information about the current license.

return self.http_get('/license', **kwargs)

@on_http_error(GitlabLicenseError)

def set_license(self, license, **kwargs):

"""Add a new license.

data = {'license': license}

return self.http_post('/license', post_data=data, **kwargs)

def _construct_url(self, id_, obj, parameters, action=None):

if 'next_url' in parameters:

return parameters['next_url']

args = _sanitize(parameters)

url_attr = '_url'

if action is not None:

attr = '_%s_url' % action

if hasattr(obj, attr):

url_attr = attr

obj_url = getattr(obj, url_attr)

url = obj_url % args

if id_ is not None:

return '%s/%s' % (url, str(id_))

else:

return url

def _set_auth_info(self):

if self.private_token and self.oauth_token:

raise ValueError("Only one of private_token or oauth_token should "

"be defined")

if ((self.http_username and not self.http_password)

or (not self.http_username and self.http_password)):

raise ValueError("Both http_username and http_password should "

"be defined")

if self.oauth_token and self.http_username:

raise ValueError("Only one of oauth authentication or http "

"authentication should be defined")

self._http_auth = None

if self.private_token:

self.headers['PRIVATE-TOKEN'] = self.private_token

self.headers.pop('Authorization', None)

if self.oauth_token:

self.headers['Authorization'] = "Bearer %s" % self.oauth_token

self.headers.pop('PRIVATE-TOKEN', None)

if self.http_username:

self._http_auth = requests.auth.HTTPBasicAuth(self.http_username,

self.http_password)

def enable_debug(self):

import logging

try:

from http.client import HTTPConnection

except ImportError:

from httplib import HTTPConnection # noqa

HTTPConnection.debuglevel = 1

logging.basicConfig()

logging.getLogger().setLevel(logging.DEBUG)

requests_log = logging.getLogger("requests.packages.urllib3")

requests_log.setLevel(logging.DEBUG)

requests_log.propagate = True

def _create_headers(self, content_type=None):

request_headers = self.headers.copy()

if content_type is not None:

request_headers['Content-type'] = content_type

return request_headers

def _get_session_opts(self, content_type):

return {

'headers': self._create_headers(content_type),

'auth': self._http_auth,

'timeout': self.timeout,

'verify': self.ssl_verify

}

def _build_url(self, path):

"""Returns the full url from path.

if path.startswith('http://') or path.startswith('https://'):

return path

else:

return '%s%s' % (self._url, path)

def _check_redirects(self, result):

# Check the requests history to detect http to https redirections.

# If the initial verb is POST, the next request will use a GET request,

# leading to an unwanted behaviour.

# If the initial verb is PUT, the data will not be send with the next

# request.

# If we detect a redirection to https with a POST or a PUT request, we

# raise an exception with a useful error message.

if result.history and self._base_url.startswith('http:'):

for item in result.history:

if item.status_code not in (301, 302):

continue

# GET methods can be redirected without issue

if item.request.method == 'GET':

continue

# Did we end-up with an https:// URL?

location = item.headers.get('Location', None)

if location and location.startswith('https://'):

raise RedirectError(REDIRECT_MSG)

def http_request(self, verb, path, query_data={}, post_data=None,

streamed=False, files=None, **kwargs):

"""Make an HTTP request to the Gitlab server.

url = self._build_url(path)

params = {}

utils.copy_dict(params, query_data)

# Deal with kwargs: by default a user uses kwargs to send data to the

# gitlab server, but this generates problems (python keyword conflicts

# and python-gitlab/gitlab conflicts).

# So we provide a `query_parameters` key: if it's there we use its dict

# value as arguments for the gitlab server, and ignore the other

# arguments, except pagination ones (per_page and page)

if 'query_parameters' in kwargs:

utils.copy_dict(params, kwargs['query_parameters'])

for arg in ('per_page', 'page'):

if arg in kwargs:

params[arg] = kwargs[arg]

else:

utils.copy_dict(params, kwargs)

opts = self._get_session_opts(content_type='application/json')

verify = opts.pop('verify')

timeout = opts.pop('timeout')

# We need to deal with json vs. data when uploading files

if files:

data = post_data

json = None

del opts["headers"]["Content-type"]

else:

json = post_data

data = None

# Requests assumes that `.` should not be encoded as %2E and will make

# changes to urls using this encoding. Using a prepped request we can

# get the desired behavior.

# The Requests behavior is right but it seems that web servers don't

# always agree with this decision (this is the case with a default

# gitlab installation)

req = requests.Request(verb, url, json=json, data=data, params=params,

files=files, **opts)

prepped = self.session.prepare_request(req)

prepped.url = utils.sanitized_url(prepped.url)

settings = self.session.merge_environment_settings(

prepped.url, {}, streamed, verify, None)

# obey the rate limit by default

obey_rate_limit = kwargs.get("obey_rate_limit", True)

# set max_retries to 10 by default, disable by setting it to -1

max_retries = kwargs.get("max_retries", 10)

cur_retries = 0

while True:

result = self.session.send(prepped, timeout=timeout, **settings)

self._check_redirects(result)

if 200 <= result.status_code < 300:

return result

if 429 == result.status_code and obey_rate_limit:

if max_retries == -1 or cur_retries < max_retries:

wait_time = 2 ** cur_retries * 0.1

if "Retry-After" in result.headers:

wait_time = int(result.headers["Retry-After"])

cur_retries += 1

time.sleep(wait_time)

continue

error_message = result.content

try:

error_json = result.json()

for k in ('message', 'error'):

if k in error_json:

error_message = error_json[k]

except (KeyError, ValueError, TypeError):

pass

if result.status_code == 401:

raise GitlabAuthenticationError(

response_code=result.status_code,

error_message=error_message,

response_body=result.content)

raise GitlabHttpError(response_code=result.status_code,

error_message=error_message,

response_body=result.content)

def http_get(self, path, query_data={}, streamed=False, **kwargs):

"""Make a GET request to the Gitlab server.

result = self.http_request('get', path, query_data=query_data,

streamed=streamed, **kwargs)

if (result.headers['Content-Type'] == 'application/json' and

not streamed):

try:

return result.json()

except Exception:

raise GitlabParsingError(

error_message="Failed to parse the server message")

else:

return result

def http_list(self, path, query_data={}, as_list=None, **kwargs):

"""Make a GET request to the Gitlab server for list-oriented queries.

# In case we want to change the default behavior at some point

as_list = True if as_list is None else as_list

get_all = kwargs.get('all', False)

url = self._build_url(path)

if get_all is True:

return list(GitlabList(self, url, query_data, **kwargs))

if 'page' in kwargs or as_list is True:

# pagination requested, we return a list

return list(GitlabList(self, url, query_data, get_next=False,

**kwargs))

# No pagination, generator requested

return GitlabList(self, url, query_data, **kwargs)

def http_post(self, path, query_data={}, post_data={}, files=None,

**kwargs):

"""Make a POST request to the Gitlab server.

result = self.http_request('post', path, query_data=query_data,

post_data=post_data, files=files, **kwargs)

try:

if result.headers.get('Content-Type', None) == 'application/json':

return result.json()

except Exception:

raise GitlabParsingError(

error_message="Failed to parse the server message")

return result

def http_put(self, path, query_data={}, post_data={}, files=None,

**kwargs):

"""Make a PUT request to the Gitlab server.

result = self.http_request('put', path, query_data=query_data,

post_data=post_data, files=files, **kwargs)

try:

return result.json()

except Exception:

raise GitlabParsingError(

error_message="Failed to parse the server message")

def http_delete(self, path, **kwargs):

"""Make a PUT request to the Gitlab server.

return self.http_request('delete', path, **kwargs)

@on_http_error(GitlabSearchError)

def search(self, scope, search, **kwargs):

"""Search GitLab resources matching the provided string.'

data = {'scope': scope, 'search': search}

"""Generator representing a list of remote objects.

def __init__(self, gl, url, query_data, get_next=True, **kwargs):

self._gl = gl

self._query(url, query_data, **kwargs)

self._get_next = get_next

def _query(self, url, query_data={}, **kwargs):

result = self._gl.http_request('get', url, query_data=query_data,

**kwargs)

try:

self._next_url = result.links['next']['url']

except KeyError:

self._next_url = None

self._current_page = result.headers.get('X-Page')

self._prev_page = result.headers.get('X-Prev-Page')

self._next_page = result.headers.get('X-Next-Page')

self._per_page = result.headers.get('X-Per-Page')

self._total_pages = result.headers.get('X-Total-Pages')

self._total = result.headers.get('X-Total')

try:

self._data = result.json()

except Exception:

raise GitlabParsingError(

error_message="Failed to parse the server message")

self._current = 0

@property

def current_page(self):

"""The current page number."""

return int(self._current_page)

@property

def prev_page(self):

"""The next page number.

return int(self._prev_page) if self._prev_page else None

@property

def next_page(self):

"""The next page number.

return int(self._next_page) if self._next_page else None

@property

def per_page(self):

"""The number of items per page."""

return int(self._per_page)

@property

def total_pages(self):

"""The total number of pages."""

return int(self._total_pages)

@property

def total(self):

"""The total number of items."""

return int(self._total)

def __iter__(self):

return self

def __len__(self):

return int(self._total)

def __next__(self):

return self.next()

def next(self):

try:

item = self._data[self._current]

self._current += 1

return item

except IndexError:

if self._next_url and self._get_next is True:

self._query(self._next_url)

return self.next()