mongkok/arcgis-sdk

"""
arcgis-sdk
~~~~~~~~~~
Python SDK for Arcgis API
:copyright: (c) 2017 mongkok
:license: MIT, see LICENSE for more details
"""

import requests


__version__ = '0.0.12'

ARCGIS_API_URL = 'https://www.arcgis.com/sharing/rest/'


class ArcgisAPI(object):
    """
    Docs: https://resources.arcgis.com/en/help/arcgis-rest-api/
    """

    def __init__(self, access_token, timeout=None,
                 proxies=None, session=None):

        self.access_token = access_token
        self.timeout = timeout
        self.proxies = proxies
        self.session = session or requests.Session()

    def refresh_token(self, client_id, refresh_token):
        result = self.request('oauth2/token/', {
            'client_id': client_id,
            'refresh_token': refresh_token,
            'grant_type': 'refresh_token',
        })

        self.access_token = result.get('access_token')
        return result

    def self(self):
        return self.request('portals/self')

    def update_self(self, **data):
        return self.post('portals/self/update', data=data)

    def self_users(self, **params):
        return self.request('portals/self/users', params=params)

    def self_roles(self, **params):
        return self.request('portals/self/roles', params=params)

    def users(self, **params):
        return self.request('community/users', params=params)

    def user_detail(self, username):
        return self.request(
            'community/users/{username}'.format(username=username))

    def user_thumbnail(self, username, filename):
        return self.request(
            'community/users/{username}/info/{filename}'.format(
                username=username,
                filename=filename,
            ),
            stream=True)

    def groups(self, **params):
        return self.request('community/groups', params=params)

    def create_group(self, **data):
        return self.post('community/createGroup', data=data)

    def group_detail(self, group_id):
        return self.request(
            'community/groups/{group_id}'.format(group_id=group_id))

    def update_group(self, group_id, **data):
        return self.post(
            'community/groups/{group_id}/update'.format(group_id=group_id),
            data=data)

    def delete_group(self, group_id):
        return self.post(
            'community/groups/{group_id}/delete'.format(group_id=group_id))

    def add_to_group(self, group_id, users):
        return self.post(
            'community/groups/{group_id}/addUsers'.format(group_id=group_id),
            data={'users': users})

    def invite_to_group(self, group_id, **data):
        return self.post(
            'community/groups/{group_id}/invite'.format(group_id=group_id),
            data=data)

    def user_items(self, username, **params):
        return self.request(
            'content/users/{username}'.format(username=username),
            params=params)

    def group_items(self, group_id, **params):
        return self.request(
            'content/groups/{group_id}'.format(group_id=group_id),
            params=params)

    def item_detail(self, item_id):
        return self.request(
            'content/items/{item_id}'.format(item_id=item_id))

    def add_item(self, username, **data):
        return self.post(
            'content/users/{username}/addItem'.format(username=username),
            data=data)

    def update_item(self, username, item_id, data, **kwargs):
        return self.post(
            'content/users/{username}/items/{item_id}/update'.format(
                username=username,
                item_id=item_id,
            ),
            data=data,
            **kwargs)

    def share_item(self, item_id, groups):
        return self.post(
            'content/items/{item_id}/share'.format(item_id=item_id),
            data={'groups': groups})

    def post(self, *args, **kwargs):
        return self.request(method='POST', *args, **kwargs)

    def get_params(self, params=None):
        if params is None:
            params = {}

        if params.get('grant_type') != 'refresh_token':
            params.update({
                'token': self.access_token,
                'f': 'json',
            })

        return params

    def request(self, path, params=None, method=None, *args, **kwargs):
        response = self.session.request(
            method or 'GET',
            ARCGIS_API_URL + path,
            params=self.get_params(params),
            proxies=self.proxies,
            timeout=self.timeout,
            **kwargs)

        if not 200 <= response.status_code < 300:
            raise ArcgisAPIError(code=response.status_code)

        try:
            result = response.json()
        except ValueError:
            return response.content

        if result.get('error'):
            raise ArcgisAPIError(result)

        return result


class ArcgisAPIError(Exception):

    def __init__(self, result=None, code=None):
        self.result = result

        if isinstance(result, dict):
            self.code = result['error']['code']
            self.details = result['error'].get('details')
            message = result['error']['message']
        else:
            self.code = code
            message = 'Server error'

        super().__init__(message)