Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: payer name & email from web form #47

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
2 changes: 1 addition & 1 deletion payments/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
# page_js = {"page" : "public/js/file.js"}

# include js in doctype views
# doctype_js = {"doctype" : "public/js/doctype.js"}
doctype_js = {"Web Form" : "public/js/web_form.js"}
# doctype_list_js = {"doctype" : "public/js/doctype_list.js"}
# doctype_tree_js = {"doctype" : "public/js/doctype_tree.js"}
# doctype_calendar_js = {"doctype" : "public/js/doctype_calendar.js"}
Expand Down
18 changes: 16 additions & 2 deletions payments/overrides/payment_webform.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ def get_payment_gateway_url(self, doc):
controller = get_payment_gateway_controller(self.payment_gateway)

title = f"Payment for {doc.doctype} {doc.name}"

# Set Amount
amount = self.amount
if self.amount_based_on_field:
amount = doc.get(self.amount_field)
Expand All @@ -35,15 +37,25 @@ def get_payment_gateway_url(self, doc):

if amount is None or Decimal(amount) <= 0:
return frappe.utils.get_url(self.success_url or self.route)

# Set Payer Name
payer_name = frappe.utils.get_fullname(frappe.session.user)
if self.payer_name_based_on_field:
payer_name = doc.get(self.payer_name_field)

# Set Payer Email
payer_email = frappe.session.user
if self.payer_email_based_on_field:
payer_email = doc.get(self.payer_email_field)

payment_details = {
"amount": amount,
"title": title,
"description": title,
"reference_doctype": doc.doctype,
"reference_docname": doc.name,
"payer_email": frappe.session.user,
"payer_name": frappe.utils.get_fullname(frappe.session.user),
"payer_email": payer_email,
"payer_name": payer_name,
"order_id": doc.name,
"currency": self.currency,
"redirect_to": frappe.utils.get_url(self.success_url or self.route),
Expand Down Expand Up @@ -101,6 +113,8 @@ def accept(web_form, data, docname=None, for_payment=False):
if for_payment:
web_form.validate_mandatory(doc)
doc.run_method("validate_payment")
# set payment gateway
doc.set("payment_gateway", web_form.payment_gateway)

if doc.name:
if web_form.has_web_form_permission(doc.doctype, doc.name, "write"):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ def validate_minimum_transaction_amount(self, currency, amount):
)

def get_payment_url(self, **kwargs):
return get_url(f"./stripe_checkout?{urlencode(kwargs)}")
return f"/stripe_checkout?{urlencode(kwargs)}"

def create_request(self, data):
import stripe
Expand Down Expand Up @@ -241,12 +241,13 @@ def finalize_request(self):
redirect_to = self.data.get("redirect_to") or None
redirect_message = self.data.get("redirect_message") or None
status = self.integration_request.status
custom_redirect_to_override = None

if self.flags.status_changed_to == "Completed":
if self.data.reference_doctype and self.data.reference_docname:
custom_redirect_to = None
try:
custom_redirect_to = frappe.get_doc(
custom_redirect_to, custom_redirect_to_override = frappe.get_doc(
self.data.reference_doctype, self.data.reference_docname
).run_method("on_payment_authorized", self.flags.status_changed_to)
except Exception:
Expand All @@ -272,6 +273,8 @@ def finalize_request(self):

if redirect_message:
redirect_url += "&" + urlencode({"redirect_message": redirect_message})
if custom_redirect_to_override:
redirect_url = redirect_to

return {"redirect_to": redirect_url, "status": status}

Expand Down
120 changes: 120 additions & 0 deletions payments/payments/custom/web_form.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
{
"custom_fields": [
{
"dt": "Web Form",
"fieldname": "payments_tab",
"fieldtype": "Tab Break",
"label": "Payments",
"insert_after": "custom_css",
"is_system_generated": 1
},
{
"default": "0",
"dt": "Web Form",
"fieldname": "accept_payment",
"fieldtype": "Check",
"label": "Accept Payments",
"insert_after": "payments_tab",
"is_system_generated": 1
},
{
"depends_on": "accept_payment",
"dt": "Web Form",
"fieldname": "payments_sb",
"fieldtype": "Section Break",
"insert_after": "accept_payment",
"is_system_generated": 1
},
{
"depends_on": "eval:!doc.amount_based_on_field",
"dt": "Web Form",
"fieldname": "amount",
"fieldtype": "Currency",
"label": "Amount",
"insert_after": "payments_sb",
"is_system_generated": 1
},
{
"dt": "Web Form",
"fieldname": "currency",
"fieldtype": "Link",
"label": "Currency",
"options": "Currency",
"insert_after": "amount",
"is_system_generated": 1
},
{
"dt": "Web Form",
"fieldname": "payment_gateway",
"fieldtype": "Link",
"label": "Payment Gateway",
"options": "Payment Gateway",
"insert_after": "currency",
"is_system_generated": 1
},
{
"dt": "Web Form",
"fieldname": "payments_cb",
"fieldtype": "Column Break",
"insert_after": "payment_gateway",
"is_system_generated": 1
},
{
"default": "0",
"dt": "Web Form",
"fieldname": "amount_based_on_field",
"fieldtype": "Check",
"label": "Amount Based On Field",
"insert_after": "payments_cb",
"is_system_generated": 1
},
{
"depends_on": "eval:doc.amount_based_on_field",
"dt": "Web Form",
"fieldname": "amount_field",
"fieldtype": "Select",
"label": "Amount Field",
"insert_after": "amount_based_on_field",
"is_system_generated": 1
},
{
"default": "0",
"dt": "Web Form",
"fieldname": "payer_name_based_on_field",
"fieldtype": "Check",
"label": "Payer Name Based On Field",
"insert_after": "amount_field",
"is_system_generated": 1
},
{
"depends_on": "eval:doc.payer_name_based_on_field",
"dt": "Web Form",
"fieldname": "payer_name_field",
"fieldtype": "Select",
"label": "Payer Name Field",
"insert_after": "payer_name_based_on_field",
"is_system_generated": 1
},
{
"default": "0",
"dt": "Web Form",
"fieldname": "payer_email_based_on_field",
"fieldtype": "Check",
"label": "Payer Email Based On Field",
"insert_after": "payer_name_field",
"is_system_generated": 1
},
{
"depends_on": "eval:doc.payer_email_based_on_field",
"dt": "Web Form",
"fieldname": "payer_email_field",
"fieldtype": "Select",
"label": "Payer Email Field",
"insert_after": "payer_email_based_on_field",
"is_system_generated": 1
}
],
"property_setters": [],
"sync_on_migrate": 1,
"doctype": "Web Form"
}
76 changes: 76 additions & 0 deletions payments/public/js/web_form.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
frappe.ui.form.on("Web Form", {
set_fields(frm) {
let doc = frm.doc;

let update_options = (options) => {
[frm.fields_dict.web_form_fields.grid, frm.fields_dict.list_columns.grid].forEach(
(obj) => {
obj.update_docfield_property("fieldname", "options", options);
}
);
};

if (!doc.doc_type) {
update_options([]);
frm.set_df_property("amount_field", "options", []);
frm.set_df_property("payer_name_field", "options", []);
frm.set_df_property("payer_email_field", "options", []);
return;
}

update_options([`Fetching fields from ${doc.doc_type}...`]);

get_fields_for_doctype(doc.doc_type).then((fields) => {
let as_select_option = (df) => ({
label: df.label,
value: df.fieldname,
});
update_options(fields.map(as_select_option));

// Amount Field Options
let currency_fields = fields
.filter((df) => ["Currency", "Float"].includes(df.fieldtype))
.map(as_select_option);
if (!currency_fields.length) {
currency_fields = [
{
label: `No currency fields in ${doc.doc_type}`,
value: "",
disabled: true,
},
];
}
frm.set_df_property("amount_field", "options", currency_fields);

// Payer Name Field Options
let payer_name_fields = fields
.filter((df) => ["Data", "Link"].includes(df.fieldtype))
.map(as_select_option);
if (!payer_name_fields.length) {
payer_name_fields = [
{
label: `No data or link fields in ${doc.doc_type}`,
value: "",
disabled: true,
},
];
}
frm.set_df_property("payer_name_field", "options", payer_name_fields);

// Payer Email Field Options
let payer_email_fields = fields
.filter((df) => ["Email"].includes(df.options))
.map(as_select_option);
if (!payer_email_fields.length) {
payer_email_fields = [
{
label: `No email fields in ${doc.doc_type}`,
value: "",
disabled: true,
},
];
}
frm.set_df_property("payer_email_field", "options", payer_email_fields);
});
}
});
Loading
Loading