Source code for degreedClient.articles

import json

from .models.content import ArticleAttribute, Article
from .compatibility import scrub


class ArticleClient(object):
    """ Article Content API. """

    def __init__(self, client):
        self.client = client

    def all(self, per_page=None, next_id=None):
        """
        Gets all articles.

        :param per_page: Amount of articles per page
        :type  per_page: ``str``

        :param next_id: Supplied to retrieve the next batch of articles
        :type  query: ``str``

        :return: A list of articles
        :rtype: ``list`` of :class:`degreedClient.models.content.Article`
        """
        params = {}
        if per_page is not None:
            params['limit'] = per_page

        data = None
        if next_id is not None:
            data = json.dumps({'next': next_id})

        articles = self.client.get_paged('content/articles', params=params, data=data)
        results = []
        for page in articles:
            results.extend([ self._to_article(i) for i in page['data']])
        return results

    def get(self, id):
        """
        Fetch an article by ID.

        :param id: The article id
        :type  id: ``str``

        :return: An instance :class:`degreedClient.models.content.Article`
        :rtype: :class:`degreedClient.models.content.Article`
        """
        article = self.client.get("content/articles/{0}".format(id))
        article_data = article['data']
        return self._to_article(article_data)

    def create(self,
    	external_id,
    	title,
    	url,
    	num_words,   	   	
    	summary=None,
    	image_url=None):
        """
        Create an article.

        :param external_id: The article's external id, is required
        :type  external_id: ``str``

        :param title: The article's title, is required
        :type  title: ``str``

        :param url: The article's url, is required
        :type  url: ``str``

        :param num_words: The article's number of words, is required
        :type  num_words: ``int``

        :param summary: The article's summary,
        :type  summary: ``str``

        :param image_url: The article's image url 
        :type  image_url: ``str``       

        :return: An instance :class:`degreedClient.models.content.Article`
        :rtype: :class:`degreedClient.models.content.Article`
        """

        params = {
            "external-id": external_id,
            "title": title,
            "url": url,
            "num-words": num_words,
            }
        
        if summary:
            params['summary'] = summary
        if image_url:
            params['image-url'] = image_url

        article = self.client.post("content/articles", {"data":{"attributes": params}})
        an_article = article['data']
        return self._to_article(an_article)

    def update(self,
    	id,
    	external_id=None,
    	title=None,
    	url=None,
    	num_words=0,   	   	
    	summary=None,
    	image_url=None):
        """
        Can update contents any of the values as the Create A New Article

        :param id: id of the article, is required
        :type  id: ``str``

        :param external_id: The article's external id
        :type  external_id: ``str``

        :param title: The article's title
        :type  title: ``str``

        :param url: The article's url
        :type  url: ``str``

        :param num_words: The article's number of words
        :type  num_words: ``int``

        :param summary: The article's summary
        :type  summary: ``str``

        :param image_url: The article's image url 
        :type  image_url: ``str``       

        :return: An instance :class:`degreedClient.models.content.Article`
        :rtype: :class:`degreedClient.models.content.Article`
        """

        params = {}
        if external_id:
            params["external-id"] = external_id
        if title:
            params["title"] = title
        if url:
            params["url"] = url
        if num_words:
            params["num-words"] = num_words
        if summary:
            params['summary'] = summary
        if image_url:
            params['image-url'] = image_url

        article = self.client.patch("content/articles/{0}".format(id), {"data":{"attributes": params}})
        an_article = article['data']
        return self._to_article(an_article)

    def delete(self, id):
        """
        Delete an article by ID.

        :param id: The article ID
        :type  id: ``str``

        :return: None
        :rtype: None    
        """
        self.client.delete("content/articles/{0}".format(id))

    def _to_article(self, data):
        scrub(data)
        if "attributes" in data and data["attributes"] is not None:
        	data['attributes'] = { x.replace('-','_'): y
        	for x,y in data['attributes'].items()}
        	data['attributes'] = ArticleAttribute(**data['attributes'])
        return Article(**data)