frappeclient.py

"""
Simple Frappe-like Python wrapper for Frappe REST API. Source: https://github.com/frappe/frappe-client.

The MIT License (MIT)

Copyright (c) 2014 Web Notes Technologies Pvt. Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""
import requests
import json

from urllib.parse import quote
from base64 import b64encode
from io import StringIO


class AuthError(Exception):
	pass


class FrappeException(Exception):
	pass


class NotUploadableException(FrappeException):
	def __init__(self, doctype):
		self.message = "The doctype `{1}` is not uploadable, so you can't download the template".format(
			doctype
		)


class FrappeClient(object):
	def __init__(
		self,
		url=None,
		username=None,
		password=None,
		api_key=None,
		api_secret=None,
		verify=True,
	):
		self.headers = dict(Accept="application/json")
		self.session = requests.Session()
		self.can_download = []
		self.verify = verify
		self.url = url

		if username and password:
			self.login(username, password)

		if api_key and api_secret:
			self.authenticate(api_key, api_secret)

	def __enter__(self):
		return self

	def __exit__(self, *args, **kwargs):
		self.logout()

	def login(self, username, password):
		r = self.session.post(
			self.url,
			data={"cmd": "login", "usr": username, "pwd": password},
			verify=self.verify,
			headers=self.headers,
		)

		if r.json().get("message") == "Logged In":
			self.can_download = []
			return r.json()
		else:
			raise AuthError

	def authenticate(self, api_key, api_secret):
		token = b64encode(f"{api_key}:{api_secret}")
		auth_header = {"Authorization": f"Basic {token}"}
		self.session.headers.update(auth_header)

	def logout(self):
		self.session.get(
			self.url,
			params={
				"cmd": "logout",
			},
		)

	def get_list(
		self,
		doctype,
		fields='"*"',
		filters=None,
		limit_start=0,
		limit_page_length=0,
		order_by=None,
	):
		"""Returns list of records of a particular type"""
		if not isinstance(fields, str):
			fields = json.dumps(fields)
		params = {"fields": fields}
		if filters:
			params["filters"] = json.dumps(filters)
		if limit_page_length:
			params["limit_start"] = limit_start
			params["limit_page_length"] = limit_page_length
		if order_by:
			params["order_by"] = order_by
		res = self.session.get(
			f"{self.url}/api/resource/{doctype}",
			params=params,
			verify=self.verify,
			headers=self.headers,
		)

		return self.post_process(res)

	def insert(self, doc):
		"""Insert a document to the remote server

		:param doc: A dict or Document object to be inserted remotely"""
		res = self.session.post(
			f"{self.url}/api/resource/" + quote(doc.get("doctype")),
			data={"data": json.dumps(doc)},
		)

		return self.post_process(res)

	def insert_many(self, docs):
		"""Insert multiple documents to the remote server

		:param docs: List of dict or Document objects to be inserted in one request"""
		return self.post_request({"cmd": "frappe.client.insert_many", "docs": docs})

	def update(self, doc):
		"""Update a remote document

		:param doc: dict or Document object to be updated remotely. `name` is mandatory for this"""
		url = f"{self.url}/api/resource/{quote(doc.get('doctype'))}/{quote(doc.get('name'))}"
		res = self.session.put(url, data={"data": json.dumps(doc)})
		return self.post_process(res)

	def bulk_update(self, docs):
		"""Bulk update documents remotely

		:param docs: List of dict or Document objects to be updated remotely (by `name`)"""
		return self.post_request(
			{"cmd": "frappe.client.bulk_update", "docs": json.dumps(docs)}
		)

	def delete(self, doctype, name):
		"""Delete remote document by name

		:param doctype: `doctype` to be deleted
		:param name: `name` of document to be deleted"""
		return self.post_request(
			{"cmd": "frappe.client.delete", "doctype": doctype, "name": name}
		)

	def submit(self, doclist):
		"""Submit remote document

		:param doc: dict or Document object to be submitted remotely"""
		return self.post_request(
			{"cmd": "frappe.client.submit", "doclist": json.dumps(doclist)}
		)

	def get_value(self, doctype, fieldname=None, filters=None):
		return self.get_request(
			{
				"cmd": "frappe.client.get_value",
				"doctype": doctype,
				"fieldname": fieldname or "name",
				"filters": json.dumps(filters),
			}
		)

	def set_value(self, doctype, docname, fieldname, value):
		return self.post_request(
			{
				"cmd": "frappe.client.set_value",
				"doctype": doctype,
				"name": docname,
				"fieldname": fieldname,
				"value": value,
			}
		)

	def cancel(self, doctype, name):
		return self.post_request(
			{"cmd": "frappe.client.cancel", "doctype": doctype, "name": name}
		)

	def get_doc(self, doctype, name="", filters=None, fields=None):
		"""Returns a single remote document

		:param doctype: DocType of the document to be returned
		:param name: (optional) `name` of the document to be returned
		:param filters: (optional) Filter by this dict if name is not set
		:param fields: (optional) Fields to be returned, will return everythign if not set"""
		params = {}
		if filters:
			params["filters"] = json.dumps(filters)
		if fields:
			params["fields"] = json.dumps(fields)

		res = self.session.get(
			f"{self.url}/api/resource/{doctype}/{name}", params=params
		)

		return self.post_process(res)

	def rename_doc(self, doctype, old_name, new_name):
		"""Rename remote document

		:param doctype: DocType of the document to be renamed
		:param old_name: Current `name` of the document to be renamed
		:param new_name: New `name` to be set"""
		params = {
			"cmd": "frappe.client.rename_doc",
			"doctype": doctype,
			"old_name": old_name,
			"new_name": new_name,
		}
		return self.post_request(params)

	def get_pdf(self, doctype, name, print_format="Standard", letterhead=True):
		response = self.session.get(
			f"{self.url}/api/method/frappe.templates.pages.print.download_pdf",
			params={
				"doctype": doctype,
				"name": name,
				"format": print_format,
				"no_letterhead": int(not bool(letterhead)),
			},
			stream=True,
		)

		return self.post_process_file_stream(response)

	def get_html(self, doctype, name, print_format="Standard", letterhead=True):
		response = self.session.get(
			f"{self.url}/print",
			params={
				"doctype": doctype,
				"name": name,
				"format": print_format,
				"no_letterhead": int(not bool(letterhead)),
			},
			stream=True,
		)
		return self.post_process_file_stream(response)

	def __load_downloadable_templates(self):
		self.can_download = self.get_api(
			"frappe.core.page.data_import_tool.data_import_tool.get_doctypes"
		)

	def get_upload_template(self, doctype, with_data=False):
		if not self.can_download:
			self.__load_downloadable_templates()

		if doctype not in self.can_download:
			raise NotUploadableException(doctype)

		request = self.session.get(
			f"{self.url}/api/method/frappe.core.page.data_import_tool.exporter.get_template",
			params={
				"doctype": doctype,
				"parent_doctype": doctype,
				"with_data": "Yes" if with_data else "No",
				"all_doctypes": "Yes",
			},
		)
		return self.post_process_file_stream(request)

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

		res = self.session.get(f"{self.url}/api/method/{method}/", params=params)
		return self.post_process(res)

	def post_api(self, method, params=None):
		if params is None:
			params = {}
		res = self.session.post(f"{self.url}/api/method/{method}/", params=params)
		return self.post_process(res)

	def get_request(self, params):
		res = self.session.get(self.url, params=self.preprocess(params))
		res = self.post_process(res)
		return res

	def post_request(self, data):
		res = self.session.post(self.url, data=self.preprocess(data))
		res = self.post_process(res)
		return res

	def preprocess(self, params):
		"""convert dicts, lists to json"""
		for key, value in params.iteritems():
			if isinstance(value, (dict, list)):
				params[key] = json.dumps(value)

		return params

	def post_process(self, response):
		try:
			rjson = response.json()
		except ValueError:
			print(response.text)
			raise

		if rjson and ("exc" in rjson) and rjson["exc"]:
			raise FrappeException("\n".join(json.loads(rjson["exc"])))
		if "message" in rjson:
			return rjson["message"]
		elif "data" in rjson:
			return rjson["data"]
		else:
			return None

	def post_process_file_stream(self, response):
		if response.ok:
			output = StringIO()
			for block in response.iter_content(1024):
				output.write(block)
			return output

		else:
			try:
				rjson = response.json()
			except ValueError:
				print(response.text)
				raise

			if rjson and ("exc" in rjson) and rjson["exc"]:
				raise FrappeException(rjson["exc"])
			if "message" in rjson:
				return rjson["message"]
			elif "data" in rjson:
				return rjson["data"]
			else:
				return None