uri.py 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. import json
  2. import logging
  3. import os
  4. import requests
  5. from core.NeuronModule import NeuronModule, InvalidParameterException
  6. logging.basicConfig()
  7. logger = logging.getLogger("kalliope")
  8. class Uri(NeuronModule):
  9. def __init__(self, **kwargs):
  10. super(Uri, self).__init__(**kwargs)
  11. # input variables
  12. self.url = kwargs.get('url', None)
  13. self.headers = kwargs.get('headers', None)
  14. self.data = kwargs.get('data', None)
  15. self.data_from_file = kwargs.get('data_from_file', None)
  16. self.method = kwargs.get('method', "GET")
  17. self.user = kwargs.get('user', None)
  18. self.password = kwargs.get('password', None)
  19. self.timeout = kwargs.get('timeout', None)
  20. # processing parameters
  21. self.parameters = None
  22. # output variable
  23. self.status_code = None
  24. self.content = None
  25. self.response_header = None
  26. # this is a switch case option
  27. switch_case = {
  28. "GET": self.do_get,
  29. "POST": self.do_post,
  30. "DELETE": self.do_delete,
  31. "PUT": self.do_put,
  32. "HEAD": self.do_head,
  33. "PATCH": self.do_patch,
  34. "OPTIONS": self.do_options
  35. }
  36. # check parameters
  37. if self._is_parameters_ok():
  38. # we get parameters that will be passed to the requests lib
  39. self.parameters = self.get_parameters()
  40. # we call the right method depending of the method selected
  41. switch_case[self.method]()
  42. message = {
  43. "status_code": self.status_code,
  44. "content": self.content,
  45. "response_header": self.response_header
  46. }
  47. self.say(message)
  48. def do_get(self):
  49. logger.debug(self.neuron_name + " do_get method called")
  50. r = requests.get(url=self.url, **self.parameters)
  51. self.post_processing_request(r)
  52. def do_post(self):
  53. logger.debug(self.neuron_name + " do_post method called")
  54. r = requests.post(url=self.url, **self.parameters)
  55. self.post_processing_request(r)
  56. def do_delete(self):
  57. logger.debug(self.neuron_name + " do_delete method called")
  58. r = requests.delete(url=self.url, **self.parameters)
  59. self.post_processing_request(r)
  60. def do_put(self):
  61. logger.debug(self.neuron_name + " do_put method called")
  62. r = requests.put(url=self.url, **self.parameters)
  63. self.post_processing_request(r)
  64. def do_head(self):
  65. logger.debug(self.neuron_name + " do_head method called")
  66. r = requests.head(url=self.url, **self.parameters)
  67. self.post_processing_request(r)
  68. def do_patch(self):
  69. logger.debug(self.neuron_name + " do_patch method called")
  70. r = requests.patch(url=self.url, **self.parameters)
  71. self.post_processing_request(r)
  72. def do_options(self):
  73. logger.debug(self.neuron_name + " do_options method called")
  74. r = requests.options(url=self.url, **self.parameters)
  75. self.post_processing_request(r)
  76. def get_parameters(self):
  77. """
  78. :return: Dict of parameters usable by the "requests" lib
  79. """
  80. returned_parameters = dict()
  81. if self.headers is not None:
  82. returned_parameters["headers"] = self.headers
  83. if self.timeout is not None:
  84. returned_parameters["timeout"] = self.timeout
  85. if self.data is not None:
  86. returned_parameters["data"] = self.data
  87. logger.debug(self.neuron_name + " parameters: %s" % returned_parameters)
  88. return returned_parameters
  89. def post_processing_request(self, r):
  90. self.status_code = r.status_code
  91. self.content = r.content
  92. # we try to load into a json object the content. So Kalliope can use it to talk
  93. self.content = json.loads(self.content)
  94. self.response_header = r.headers
  95. logger.debug(self.neuron_name + " status_code: %s" % self.status_code)
  96. logger.debug(self.neuron_name + " content: %s" % self.content)
  97. logger.debug(self.neuron_name + " response_header: %s" % self.response_header)
  98. def _is_parameters_ok(self):
  99. """
  100. Check that all provided parameters in the neurons are valid
  101. :return: True if all check passed
  102. """
  103. # URL is mandatory
  104. if self.url is None:
  105. raise InvalidParameterException("Uri needs an url")
  106. # headers can be null, but if provided it must be a list
  107. if self.headers is not None:
  108. if not isinstance(self.headers, dict):
  109. raise InvalidParameterException("headers must be a list of string")
  110. # timeout in second must be an integer
  111. if self.timeout is not None:
  112. if not isinstance(self.timeout, int):
  113. raise InvalidParameterException("timeout must be an integer")
  114. # data must be loadable with json
  115. if self.data is not None:
  116. try:
  117. self.data = json.loads(self.data)
  118. except ValueError, e:
  119. raise InvalidParameterException("error in \"data\" parameter: %s" % e)
  120. # data_from_file path must exist and data inside must be loadable by json
  121. if self.data_from_file is not None:
  122. # check that the file exist
  123. if not os.path.exists(self.data_from_file):
  124. raise InvalidParameterException("error in \"data_file\". File does not exist: %s" % self.data_from_file)
  125. # then try to load the json from the file
  126. try:
  127. self.data_from_file = json.loads(self.readfile(self.data_from_file))
  128. except ValueError, e:
  129. raise InvalidParameterException("error in \"data\" parameter: %s" % e)
  130. # the provided method must exist
  131. allowed_method = ["GET", "POST", "DELETE", "PUT", "HEAD", "PATCH", "OPTIONS"]
  132. if self.method not in allowed_method:
  133. raise InvalidParameterException("method %s not in: %s" % (self.method, allowed_method))
  134. return True
  135. @staticmethod
  136. def readfile(file_path):
  137. """
  138. return the content of the file <file_path>
  139. :param file_path: File path to read
  140. :return: Str content of the file
  141. """
  142. file_to_read = open(file_path, 'r')
  143. return file_to_read.read()