moira-python-client 4.2.0__tar.gz → 4.3.0__tar.gz

{moira-python-client-4.2.0 → moira_python_client-4.3.0}/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 4.3.0
+
+Add support for Team APIs
+
+# 4.2.1
+
+Add support for name field in contacts
+
 # 4.2.0
 
 Add support for multiple clusters in trigger creation

{moira-python-client-4.2.0/moira_python_client.egg-info → moira_python_client-4.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: moira-python-client
-Version: 4.2.0
+Version: 4.3.0
 Summary: Client for Moira - Alerting system based on Graphite data
 Home-page: https://github.com/moira-alert/python-moira-client
 Author: Alexander Lukyanchenko

moira_python_client-4.3.0/README.md

@@ -0,0 +1,285 @@
+[![Build Status](https://travis-ci.org/moira-alert/python-moira-client.svg?branch=master)](https://travis-ci.org/moira-alert/python-moira-client)
+
+# Moira Client
+
+If you're new here, better check out our main [README](https://github.com/moira-alert/moira/blob/master/README.md).
+
+Python client for Moira.
+
+# Installation
+
+```
+pip install moira-python-client
+```
+
+# Getting started
+
+Initialize Moira client:
+```
+from moira_client import Moira
+
+moira = Moira('http://localhost:8888/api/')
+```
+
+## Triggers
+
+### Create new trigger
+```
+from moira_client.models.trigger import STATE_ERROR
+
+trigger = moira.trigger.create(
+    id='service_trigger_name',
+    name='Trigger name',
+    tags=['service'],
+    targets=['prefix.service.*.postfix'],
+    warn_value=300,
+    error_value=600,
+    desc='my trigger',
+    ttl_state=STATE_ERROR
+)
+
+trigger.disable_day('Tue')
+trigger.save()
+print(trigger.id)
+```
+
+> **Note:** id parameter is not required but highly recommended for large production solutions <br>
+> (e.q. fetch_by_id will work faster than is_exist).
+> If parameter is not specified, random trigger guid will be generated.
+
+### Update triggers
+Turn off all triggers for Monday.
+```
+triggers = moira.trigger.fetch_all()
+for trigger in triggers:
+    trigger.disable_day('Mon')
+    trigger.update()
+```
+
+### Delete trigger
+```
+trigger = moira.trigger.fetch_by_id('bb1a8514-128b-406e-bec3-25e94153ab30')
+moira.trigger.delete(trigger.id)
+```
+
+### Check whether trigger exists or not (manually)
+```
+trigger = moira.trigger.create(
+    name='service',
+    targets=['service.rps'],
+    tags=['ops']
+)
+
+if not moira.trigger.is_exist(trigger):
+    trigger.save()
+```
+
+### Get non existent triggers
+```
+trigger1 = moira.trigger.create(
+    name='service',
+    targets=['service.rps'],
+    tags=['ops']
+)
+
+trigger2 = moira.trigger.create(
+    name='site',
+    targets=['site.rps'],
+    tags=['ops']
+)
+
+triggers = [trigger1, trigger2]
+
+non_existent_triggers = moira.trigger.get_non_existent(triggers)
+```
+
+## Subscription
+
+### Create subscription
+```
+subscription = moira.subscription.create(
+    contacts=['79ac9de2-a3b3-4f94-b3ea-74f6f4094fd2'],
+    tags=['tag']
+)
+subscription.save()
+```
+
+### Delete subscription
+Delete all subscriptions
+```
+subscriptions = moira.subscription.fetch_all()
+for subscription in subscriptions:
+    moira.subscription.delete(subscription.id)
+```
+
+## Contact
+
+### Get all contacts
+```
+contacts = moira.contact.fetch_all()
+for contact in contacts:
+    print(contact.id)
+```
+
+### Get contact id by type and value
+```
+contact_id = moira.contact.get_id(type='slack', value='#err')
+print(contact_id)
+```
+
+## Team
+
+### Get all teams
+```python
+teams = moira.team.get_all()
+```
+
+### Create a new team
+```python
+from moira_client.models.team import TeamModel
+
+team = TeamModel(
+    description="Team that holds all members of infrastructure division",
+    name="Infrastructure Team",
+)
+
+saved_team = moira.team.create(team)
+```
+
+### Delete a team
+```python
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+
+deleted_team = moira.team.delete(team_id)
+```
+
+### Get a team by ID
+```python
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+
+team = moira.team.get(team_id)
+```
+
+### Update existing team
+```python
+from moira_client.models.team import TeamModel
+
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+team = TeamModel(
+    description="Team that holds all members of infrastructure division",
+    name="Infrastructure Team",
+)
+
+updated_team = moira.team.update(team_id, team)
+```
+
+### Team Settings
+
+#### Get team settings
+```python
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+
+settings = moira.team.settings.get(team_id)
+```
+
+### Team User
+
+#### Get users of a team
+
+```python
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+
+users = moira.team.user.get(team_id)
+```
+
+#### Add users to a team
+
+```python
+from moira_client.models.team.user import TeamMembers
+
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+users_to_add = TeamMembers(usernames=["anonymous", ])
+
+users = moira.team.user.add(team_id, users_to_add)
+```
+
+#### Set users of a team
+
+```python
+from moira_client.models.team.user import TeamMembers
+
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+users_to_set = TeamMembers(usernames=["anonymous", ])
+
+users = moira.team.user.set(team_id, users_to_set)
+```
+
+#### Delete a user from a team
+
+```python
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+team_user_id = "anonymous"
+
+users = moira.team.user.delete(team_id, team_user_id)
+```
+
+### Team Subscription
+
+#### Create a new team subscription
+
+```python
+from moira_client.models.subscription import SubscriptionModel
+
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+subscription_to_create = SubscriptionModel(
+    any_tags=False,
+    contacts=[
+        "acd2db98-1659-4a2f-b227-52d71f6e3ba1"
+    ],
+    enabled=True,
+    ignore_recoverings=False,
+    ignore_warnings=False,
+    plotting={
+        "enabled": True,
+        "theme": "dark"
+    },
+    sched={
+        "days": [
+            {
+                "enabled": True,
+                "name": "Mon"
+            }
+        ],
+        "endOffset": 1439,
+        "startOffset": 0,
+        "tzOffset": -60
+    },
+    tags=[
+        "server",
+        "cpu"
+    ],
+    throttling=False,
+    user="",
+)
+
+subscription = moira.team.subscription.create(team_id, subscription_to_create)
+```
+
+### Team Contact
+
+#### Create a new team contact
+
+```python
+from moira_client.models.contact import Contact
+
+team_id = "d5d98eb3-ee18-4f75-9364-244f67e23b54"
+contact_to_create = Contact(
+    name="Mail Alerts",
+    team_id=team_id,
+    type="mail",
+    user="",
+    value="devops@example.com",
+)
+
+contact = moira.team.contact.create(team_id, contact_to_create)
+```

moira_python_client-4.3.0/VERSION.txt

@@ -0,0 +1 @@
+4.3.0

{moira-python-client-4.2.0 → moira_python_client-4.3.0}/moira_client/client.py

@@ -21,6 +21,14 @@ class InvalidJSONError(Exception):
         """
         self.content = content
 
+class MoiraApiError(Exception):
+    def __init__(self, body):
+        """
+
+        :param body: response body
+        """
+        self.body = body
+
 
 class Client:
     def __init__(self, api_url, auth_custom=None, auth_user=None, auth_pass=None, login=None):
@@ -64,7 +72,12 @@ class Client:
         :raises: InvalidJSONError
         """
         r = requests.get(self._path_join(path), headers=self.headers, auth=self.auth, **kwargs)
-        r.raise_for_status()
+        
+        try:
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as err:
+            raise MoiraApiError(r.content)
+
         try:
             return r.json()
         except ValueError:
@@ -81,7 +94,12 @@ class Client:
         :raises: InvalidJSONError
         """
         r = requests.delete(self._path_join(path), headers=self.headers, auth=self.auth, **kwargs)
-        r.raise_for_status()
+        
+        try:
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as err:
+            raise MoiraApiError(r.content)
+
         try:
             return r.json()
         except ValueError:
@@ -98,7 +116,12 @@ class Client:
         :raises: InvalidJSONError
         """
         r = requests.put(self._path_join(path), headers=self.headers, auth=self.auth, **kwargs)
-        r.raise_for_status()
+
+        try:
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as err:
+            raise MoiraApiError(r.content)
+
         try:
             return r.json()
         except ValueError:
@@ -115,7 +138,12 @@ class Client:
         :raises: InvalidJSONError
         """
         r = requests.post(self._path_join(path), headers=self.headers, auth=self.auth, **kwargs)
-        r.raise_for_status()
+        
+        try:
+            r.raise_for_status()
+        except requests.exceptions.HTTPError as err:
+            raise MoiraApiError(r.content)
+
         try:
             return r.json()
         except ValueError:

{moira-python-client-4.2.0 → moira_python_client-4.3.0}/moira_client/models/contact.py

@@ -21,33 +21,43 @@ class Contact(Base):
         self.type = type
         self.value = value
         self.user = kwargs.get('user', None)
+        self.name = kwargs.get('name', None)
         self._id = kwargs.get('id', None)
+        self.team_id = kwargs.get('team_id', None)
 
 
 class ContactManager:
     def __init__(self, client):
         self._client = client
 
-    def add(self, value, contact_type):
+    def add(self, value, contact_type, name=None):
         """
         Add new contact
 
         :param value: str contact value
         :param contact_type: str contact type (one of CONTACT_* constants)
+        :param name: str contact name
         :return: Contact
 
         :raises: ResponseStructureError
         """
-        data = {
-            'value': value,
-            'type': contact_type
-        }
 
         contacts = self.fetch_by_current_user()
         for contact in contacts:
             if contact.value == value and contact.type == contact_type:
+                if name and contact.name != name:
+                    contact.name = name
+                    self.update(contact)
+                    return contact
                 return contact
 
+        data = {
+            'value': value,
+            'type': contact_type
+        }
+        if name:
+            data['name'] = name
+
         result = self._client.put(self._full_path(), json=data)
         if 'id' not in result:
             raise ResponseStructureError('No id in response', result)
@@ -135,6 +145,8 @@ class ContactManager:
             'type': contact.type,
             'value': contact.value,
         }
+        if contact.name:
+            data['name'] = contact.name
 
         try:
             self._client.put(self._full_path(contact.id), json=data)

{moira-python-client-4.2.0 → moira_python_client-4.3.0}/moira_client/models/subscription.py

@@ -2,12 +2,10 @@ from ..client import InvalidJSONError
 from ..client import ResponseStructureError
 from .base import Base
 
-class Subscription(Base):
-    def __init__(self, client, tags, contacts=None, enabled=None, throttling=None, sched=None,
+class SubscriptionModel(Base):
+    def __init__(self, tags, contacts=None, enabled=None, throttling=None, sched=None,
                  ignore_warnings=False, ignore_recoverings=False, plotting=None, any_tags=False, **kwargs):
         """
-
-        :param client: api client
         :param tags: list of str tags
         :param contacts: list of contact id's
         :param enabled: bool is enabled
@@ -19,8 +17,6 @@ class Subscription(Base):
         :param any_tags: bool any tags
         :param kwargs: additional parameters
         """
-        self._client = client
-
         self._id = kwargs.get('id', None)
         self.tags = tags if not any_tags else []
         if not contacts:
@@ -38,32 +34,7 @@ class Subscription(Base):
         if not plotting:
             plotting = {'enabled': False, 'theme': 'light'}
         self.plotting = plotting
-
-    def _send_request(self, subscription_id=None):
-        data = {
-            'contacts': self.contacts,
-            'tags': self.tags,
-            'enabled': self.enabled,
-            'any_tags': self.any_tags,
-            'throttling': self.throttling,
-            'sched': self.sched,
-            'ignore_warnings': self.ignore_warnings,
-            'ignore_recoverings': self.ignore_recoverings,
-            'plotting': self.plotting
-        }
-
-        if subscription_id:
-            data['id'] = subscription_id
-
-        if subscription_id:
-            result = self._client.put('subscription/{id}'.format(id=subscription_id), json=data)
-        else:
-            result = self._client.put('subscription', json=data)
-        if 'id' not in result:
-            raise ResponseStructureError("id doesn't exist in response", result)
-
-        self._id = result['id']
-        return self._id
+        self.team_id = kwargs.get('team_id', None)
 
     def disable_day(self, day):
         """
@@ -124,26 +95,6 @@ class Subscription(Base):
             'theme': 'light'
             }
 
-    def save(self):
-        """
-        Save subscription
-
-        :return: subscription id
-        """
-        if self._id:
-            return self.update()
-        self._send_request()
-
-    def update(self):
-        """
-        Update subscription
-
-        :return: subscription id
-        """
-        if not self._id:
-            return self.save()
-        self._send_request(self._id)
-
     def set_start_hour(self, hour):
         """
         Set start hour
@@ -185,6 +136,85 @@ class Subscription(Base):
         self._end_minute = minute
 
 
+class Subscription(SubscriptionModel):
+    def __init__(self, client, tags, contacts=None, enabled=None, throttling=None, sched=None,
+                 ignore_warnings=False, ignore_recoverings=False, plotting=None, any_tags=False, **kwargs):
+        """
+        :param client: api client
+        :param tags: list of str tags
+        :param contacts: list of contact id's
+        :param enabled: bool is enabled
+        :param throttling: bool throttling
+        :param sched: dict schedule
+        :param ignore_warnings: bool ignore warnings
+        :param ignore_recoverings: bool ignore recoverings
+        :param plotting: dict plotting settings
+        :param any_tags: bool any tags
+        :param kwargs: additional parameters
+        """
+        self._client = client
+
+        super().__init__(
+            tags=tags,
+            contacts=contacts,
+            enabled=enabled,
+            throttling=throttling,
+            sched=sched,
+            ignore_warnings=ignore_warnings,
+            ignore_recoverings=ignore_recoverings,
+            plotting=plotting,
+            any_tags=any_tags,
+            **kwargs,
+        )
+
+    def _send_request(self, subscription_id=None):
+        data = {
+            'contacts': self.contacts,
+            'tags': self.tags,
+            'enabled': self.enabled,
+            'any_tags': self.any_tags,
+            'throttling': self.throttling,
+            'sched': self.sched,
+            'ignore_warnings': self.ignore_warnings,
+            'ignore_recoverings': self.ignore_recoverings,
+            'plotting': self.plotting,
+            'team_id': self.team_id,
+        }
+
+        if subscription_id:
+            data['id'] = subscription_id
+
+        if subscription_id:
+            result = self._client.put('subscription/{id}'.format(id=subscription_id), json=data)
+        else:
+            result = self._client.put('subscription', json=data)
+        if 'id' not in result:
+            raise ResponseStructureError("id doesn't exist in response", result)
+
+        self._id = result['id']
+        return self._id
+
+    def save(self):
+        """
+        Save subscription
+
+        :return: subscription id
+        """
+        if self._id:
+            return self.update()
+        self._send_request()
+
+    def update(self):
+        """
+        Update subscription
+
+        :return: subscription id
+        """
+        if not self._id:
+            return self.save()
+        self._send_request(self._id)
+
+
 class SubscriptionManager:
     def __init__(self, client):
         self._client = client

{moira-python-client-4.2.0 → moira_python_client-4.3.0}/moira_client/moira.py

@@ -9,6 +9,7 @@ from .models.trigger import TriggerManager
 from .models.health import HealthManager
 from .models.config import ConfigManager
 from .models.user import UserManager
+from .models.team import TeamManager
 
 
 class Moira:
@@ -34,6 +35,7 @@ class Moira:
         self._health = None
         self._config = None
         self._user = None
+        self._team = None
 
     @property
     def trigger(self):
@@ -145,3 +147,12 @@ class Moira:
         if not self._user:
             self._user = UserManager(self._client)
         return self._user
+
+    @property
+    def team(self) -> TeamManager:
+        """Get team manager
+        """
+        if not self._team:
+            self._team = TeamManager(self._client)
+
+        return self._team

{moira-python-client-4.2.0 → moira_python_client-4.3.0/moira_python_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: moira-python-client
-Version: 4.2.0
+Version: 4.3.0
 Summary: Client for Moira - Alerting system based on Graphite data
 Home-page: https://github.com/moira-alert/python-moira-client
 Author: Alexander Lukyanchenko

moira-python-client-4.2.0/README.md

@@ -1,128 +0,0 @@
-[![Build Status](https://travis-ci.org/moira-alert/python-moira-client.svg?branch=master)](https://travis-ci.org/moira-alert/python-moira-client)
-
-# Moira Client
-
-If you're new here, better check out our main [README](https://github.com/moira-alert/moira/blob/master/README.md).
-
-Python client for Moira.
-
-# Installation
-
-```
-pip install moira-python-client
-```
-
-# Getting started
-
-Initialize Moira client:
-```
-from moira_client import Moira
-
-moira = Moira('http://localhost:8888/api/')
-```
-
-## Triggers
-
-### Create new trigger
-```
-from moira_client.models.trigger import STATE_ERROR
-
-trigger = moira.trigger.create(
-    id='service_trigger_name',
-    name='Trigger name',
-    tags=['service'],
-    targets=['prefix.service.*.postfix'],
-    warn_value=300,
-    error_value=600,
-    desc='my trigger',
-    ttl_state=STATE_ERROR
-)
-
-trigger.disable_day('Tue')
-trigger.save()
-print(trigger.id)
-```
-
-> **Note:** id parameter is not required but highly recommended for large production solutions <br>
-> (e.q. fetch_by_id will work faster than is_exist).
-> If parameter is not specified, random trigger guid will be generated.
-
-### Update triggers
-Turn off all triggers for Monday.
-```
-triggers = moira.trigger.fetch_all()
-for trigger in triggers:
-    trigger.disable_day('Mon')
-    trigger.update()
-```
-
-### Delete trigger
-```
-trigger = moira.trigger.fetch_by_id('bb1a8514-128b-406e-bec3-25e94153ab30')
-moira.trigger.delete(trigger.id)
-```
-
-### Check whether trigger exists or not (manually)
-```
-trigger = moira.trigger.create(
-    name='service',
-    targets=['service.rps'],
-    tags=['ops']
-)
-
-if not moira.trigger.is_exist(trigger):
-    trigger.save()
-```
-
-### Get non existent triggers
-```
-trigger1 = moira.trigger.create(
-    name='service',
-    targets=['service.rps'],
-    tags=['ops']
-)
-
-trigger2 = moira.trigger.create(
-    name='site',
-    targets=['site.rps'],
-    tags=['ops']
-)
-
-triggers = [trigger1, trigger2]
-
-non_existent_triggers = moira.trigger.get_non_existent(triggers)
-```
-
-## Subscription
-
-### Create subscription
-```
-subscription = moira.subscription.create(
-    contacts=['79ac9de2-a3b3-4f94-b3ea-74f6f4094fd2'],
-    tags=['tag']
-)
-subscription.save()
-```
-
-### Delete subscription
-Delete all subscriptions
-```
-subscriptions = moira.subscription.fetch_all()
-for subscription in subscriptions:
-    moira.subscription.delete(subscription.id)
-```
-
-## Contact
-
-### Get all contacts
-```
-contacts = moira.contact.fetch_all()
-for contact in contacts:
-    print(contact.id)
-```
-
-### Get contact id by type and value
-```
-contact_id = moira.contact.get_id(type='slack', value='#err')
-print(contact_id)
-```

moira-python-client-4.2.0/VERSION.txt

@@ -1 +0,0 @@
-4.2.0