ServiceTrello.save_data() - Code Metrics - foxmask/django-th - Measure and Improve Code Quality continuously with Scrutinizer

ServiceTrello.save_data() D
last analyzed 2017-10-09 22:02 UTC

↳ Parent: ServiceTrello

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	8
dl	0
loc	76
rs	4.8823
c	1
b	0
f	0

How to fix Long Method

# coding: utf-8
# Trello API
from trello import TrelloClient, ResourceUnavailable

# django classes
from django.conf import settings
from django.utils.translation import ugettext as _
from logging import getLogger
from django.core.cache import caches

# django_th classes
from django_th.apps import DjangoThConfig
from django_th.services.services import ServicesMgr
from django_th.models import update_result, UserService

"""
    handle process with Trello
    put the following in settings.py

    TH_TRELLO = {
        'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
        'consumer_secret': 'abcdefghijklmnopqrstuvwxyz',
    }

    TH_SERVICES = (
        ...
        'th_trello.my_trello.ServiceTrello',
        ...
    )

"""

logger = getLogger('django_th.trigger_happy')

cache = caches['django_th']


class ServiceTrello(ServicesMgr):
    """
        Serivce Trello
    """
    # Boards own Lists own Cards

    def __init__(self, token=None, **kwargs):
        super(ServiceTrello, self).__init__(token, **kwargs)
        # app name
        self.app_name = DjangoThConfig.verbose_name
        # expiration
        self.expiry = "30days"
        # scope define the rights access
        self.scope = 'read,write'
        self.oauth = 'oauth1'
        self.service = 'ServiceTrello'

        base = 'https://www.trello.com'
        self.AUTH_URL = '{}/1/OAuthAuthorizeToken'.format(base)
        self.REQ_TOKEN = '{}/1/OAuthGetRequestToken'.format(base)
        self.ACC_TOKEN = '{}/1/OAuthGetAccessToken'.format(base)
        self.consumer_key = settings.TH_TRELLO_KEY['consumer_key']
        self.consumer_secret = settings.TH_TRELLO_KEY['consumer_secret']
        if token:
            token_key, token_secret = token.split('#TH#')
            try:
                self.trello_instance = TrelloClient(self.consumer_key,
                                                    self.consumer_secret,
                                                    token_key,
                                                    token_secret)
            except ResourceUnavailable as e:
                us = UserService.objects.get(token=token)
                logger.error(e.msg, e.error_code)
                update_result(us.trigger_id, msg=e.msg, status=False)

    def read_data(self, **kwargs):
        """
            get the data from the service

            :param kwargs: contain keyword args : trigger_id at least
            :type kwargs: dict
        """
        trigger_id = kwargs.get('trigger_id')
        data = list()
        cache.set('th_trello_' + str(trigger_id), data)
        return data

    def save_data(self, trigger_id, **data):
        """
            let's save the data

            :param trigger_id: trigger ID from which to save data
            :param data: the data to check to be used and save
            :type trigger_id: int
            :type data:  dict
            :return: the status of the save statement
            :rtype: boolean
        """
        from th_trello.models import Trello

        data['output_format'] = 'md'
        title, content = super(ServiceTrello, self).save_data(trigger_id,
                                                              **data)

        if len(title):
            # get the data of this trigger
            t = Trello.objects.get(trigger_id=trigger_id)
            # footer of the card
            footer = self.set_card_footer(data, t)
            content += footer

            # 1 - we need to search the list and board where we will
            # store the card so ...

            # 1.a search the board_id by its name
            # by retrieving all the boards
            boards = self.trello_instance.list_boards()

            board_id = ''
            my_list = ''
            for board in boards:
                if t.board_name == board.name:
                    board_id = board.id
                    break

            if board_id:
                # 1.b search the list_id by its name
                my_board = self.trello_instance.get_board(board_id)
                lists = my_board.open_lists()
                # just get the open list ; not all the archive ones
                for list_in_board in lists:
                    # search the name of the list we set in the form
                    if t.list_name == list_in_board.name:
                        # return the (trello) list object
                        # to be able to add card at step 3
                        my_list = my_board.get_list(list_in_board.id)
                        break
                # we didnt find the list in that board
                # create it
                if my_list == '':
                    my_list = my_board.add_list(t.list_name)

            else:
                # 2 if board_id and/or list_id does not exist, create it/them
                my_board = self.trello_instance.add_board(t.board_name)
                # add the list that didnt exists and
                # return a (trello) list object
                my_list = my_board.add_list(t.list_name)

            # 3 create the card
            # create the Trello card
            my_list.add_card(title, content)

            sentence = str('trello {} created').format(data['link'])
            logger.debug(sentence)
            status = True
        else:
            sentence = "no token or link provided for trigger ID " \
                       "{}".format(trigger_id)
            update_result(trigger_id, msg=sentence, status=False)
            status = False

        return status

    @staticmethod
    def set_card_footer(data, trigger):
        """
            handle the footer of the note
        """
        footer = ''
        if data.get('link'):
            provided_by = _('Provided by')
            provided_from = _('from')
            footer_from = "<br/><br/>{} <em>{}</em> {} <a href='{}'>{}</a>"

            description = trigger.trigger.description
            footer = footer_from.format(
                provided_by, description, provided_from,
                data.get('link'), data.get('link'))

            import pypandoc
            footer = pypandoc.convert(footer, 'md', format='html')

        return footer

    def auth(self, request):
        """
            let's auth the user to the Service
            :param request: request object
            :return: callback url
            :rtype: string that contains the url to redirect after auth
        """
        request_token = super(ServiceTrello, self).auth(request)
        callback_url = self.callback_url(request)

        # URL to redirect user to, to authorize your app
        auth_url_str = '{auth_url}?oauth_token={token}'
        auth_url_str += '&scope={scope}&name={name}'
        auth_url_str += '&expiration={expiry}&oauth_callback={callback_url}'
        auth_url = auth_url_str.format(auth_url=self.AUTH_URL,
                                       token=request_token['oauth_token'],
                                       scope=self.scope,
                                       name=self.app_name,
                                       expiry=self.expiry,
                                       callback_url=callback_url)

        return auth_url

    def callback(self, request, **kwargs):
        """
            Called from the Service when the user accept to activate it
            :param request: request object
            :return: callback url
            :rtype: string , path to the template
        """
        return super(ServiceTrello, self).callback(request, **kwargs)


1			# coding: utf-8
2			# Trello API
3			from trello import TrelloClient, ResourceUnavailable
4
5			# django classes
6			from django.conf import settings
7			from django.utils.translation import ugettext as _
8			from logging import getLogger
9			from django.core.cache import caches
10
11			# django_th classes
12			from django_th.apps import DjangoThConfig
13			from django_th.services.services import ServicesMgr
14			from django_th.models import update_result, UserService
15
16			"""
17			handle process with Trello
18			put the following in settings.py
19
20			TH_TRELLO = {
21			'consumer_key': 'abcdefghijklmnopqrstuvwxyz',
22			'consumer_secret': 'abcdefghijklmnopqrstuvwxyz',
23			}
24
25			TH_SERVICES = (
26			...
27			'th_trello.my_trello.ServiceTrello',
28			...
29			)
30
31			"""
32
33			logger = getLogger('django_th.trigger_happy')
34
35			cache = caches['django_th']
36
37
38			class ServiceTrello(ServicesMgr):
39			"""
40			Serivce Trello
41			"""
42			# Boards own Lists own Cards
43
44			def __init__(self, token=None, **kwargs):
45			super(ServiceTrello, self).__init__(token, **kwargs)
46			# app name
47			self.app_name = DjangoThConfig.verbose_name
48			# expiration
49			self.expiry = "30days"
50			# scope define the rights access
51			self.scope = 'read,write'
52			self.oauth = 'oauth1'
53			self.service = 'ServiceTrello'
54
55			base = 'https://www.trello.com'
56			self.AUTH_URL = '{}/1/OAuthAuthorizeToken'.format(base)
57			self.REQ_TOKEN = '{}/1/OAuthGetRequestToken'.format(base)
58			self.ACC_TOKEN = '{}/1/OAuthGetAccessToken'.format(base)
59			self.consumer_key = settings.TH_TRELLO_KEY['consumer_key']
60			self.consumer_secret = settings.TH_TRELLO_KEY['consumer_secret']
61			if token:
62			token_key, token_secret = token.split('#TH#')
63			try:
64			self.trello_instance = TrelloClient(self.consumer_key,
65			self.consumer_secret,
66			token_key,
67			token_secret)
68			except ResourceUnavailable as e:
69			us = UserService.objects.get(token=token)
70			logger.error(e.msg, e.error_code)
71			update_result(us.trigger_id, msg=e.msg, status=False)
72
73			def read_data(self, **kwargs):
74			"""
75			get the data from the service
76
77			:param kwargs: contain keyword args : trigger_id at least
78			:type kwargs: dict
79			"""
80			trigger_id = kwargs.get('trigger_id')
81			data = list()
82			cache.set('th_trello_' + str(trigger_id), data)
83			return data
84
85			def save_data(self, trigger_id, **data):
86			"""
87			let's save the data
88
89			:param trigger_id: trigger ID from which to save data
90			:param data: the data to check to be used and save
91			:type trigger_id: int
92			:type data: dict
93			:return: the status of the save statement
94			:rtype: boolean
95			"""
96			from th_trello.models import Trello
97
98			data['output_format'] = 'md'
99			title, content = super(ServiceTrello, self).save_data(trigger_id,
100			**data)
101
102			if len(title):
103			# get the data of this trigger
104			t = Trello.objects.get(trigger_id=trigger_id)
105			# footer of the card
106			footer = self.set_card_footer(data, t)
107			content += footer
108
109			# 1 - we need to search the list and board where we will
110			# store the card so ...
111
112			# 1.a search the board_id by its name
113			# by retrieving all the boards
114			boards = self.trello_instance.list_boards()
115
116			board_id = ''
117			my_list = ''
118			for board in boards:
119			if t.board_name == board.name:
120			board_id = board.id
121			break
122
123			if board_id:
124			# 1.b search the list_id by its name
125			my_board = self.trello_instance.get_board(board_id)
126			lists = my_board.open_lists()
127			# just get the open list ; not all the archive ones
128			for list_in_board in lists:
129			# search the name of the list we set in the form
130			if t.list_name == list_in_board.name:
131			# return the (trello) list object
132			# to be able to add card at step 3
133			my_list = my_board.get_list(list_in_board.id)
134			break
135			# we didnt find the list in that board
136			# create it
137			if my_list == '':
138			my_list = my_board.add_list(t.list_name)
139
140			else:
141			# 2 if board_id and/or list_id does not exist, create it/them
142			my_board = self.trello_instance.add_board(t.board_name)
143			# add the list that didnt exists and
144			# return a (trello) list object
145			my_list = my_board.add_list(t.list_name)
146
147			# 3 create the card
148			# create the Trello card
149			my_list.add_card(title, content)
150
151			sentence = str('trello {} created').format(data['link'])
152			logger.debug(sentence)
153			status = True
154			else:
155			sentence = "no token or link provided for trigger ID " \
156			"{}".format(trigger_id)
157			update_result(trigger_id, msg=sentence, status=False)
158			status = False
159
160			return status
161
162			@staticmethod
163			def set_card_footer(data, trigger):
164			"""
165			handle the footer of the note
166			"""
167			footer = ''
168			if data.get('link'):
169			provided_by = _('Provided by')
170			provided_from = _('from')
171			footer_from = "<br/><br/>{} <em>{}</em> {} <a href='{}'>{}</a>"
172
173			description = trigger.trigger.description
174			footer = footer_from.format(
175			provided_by, description, provided_from,
176			data.get('link'), data.get('link'))
177
178			import pypandoc
179			footer = pypandoc.convert(footer, 'md', format='html')
180
181			return footer
182
183			def auth(self, request):
184			"""
185			let's auth the user to the Service
186			:param request: request object
187			:return: callback url
188			:rtype: string that contains the url to redirect after auth
189			"""
190			request_token = super(ServiceTrello, self).auth(request)
191			callback_url = self.callback_url(request)
192
193			# URL to redirect user to, to authorize your app
194			auth_url_str = '{auth_url}?oauth_token={token}'
195			auth_url_str += '&scope={scope}&name={name}'
196			auth_url_str += '&expiration={expiry}&oauth_callback={callback_url}'
197			auth_url = auth_url_str.format(auth_url=self.AUTH_URL,
198			token=request_token['oauth_token'],
199			scope=self.scope,
200			name=self.app_name,
201			expiry=self.expiry,
202			callback_url=callback_url)
203
204			return auth_url
205
206			def callback(self, request, **kwargs):
207			"""
208			Called from the Service when the user accept to activate it
209			:param request: request object
210			:return: callback url
211			:rtype: string , path to the template
212			"""
213			return super(ServiceTrello, self).callback(request, **kwargs)
214

foxmask / django-th

ServiceTrello.save_data() D last analyzed 2017-10-09 22:02 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

ServiceTrello.save_data() D
last analyzed 2017-10-09 22:02 UTC