Merge lp:~openerp-dev/openobject-addons/trunk-paypal-transaction-fees-sgo into lp:openobject-addons

[Sanjay Gohel (Open ERP)]

Hello,

  Have done all improvement related paypal transaction fees given in specification.

 - Add a new paypal section under the 'eInvoicing & Payments' and all details related paypal in this section.
 - Add checkbox named ‘Charge Paypal fees to customers’ under paypal account.
 - Add fields below this check box which is visible after checked for domestic and international charges of paypal.
 - Display fees in paypal widget shown on invoice and sale order which comes after calculation based on domestic and international
 - And also added shipping and handling in paypal url.
- when country is not defined in company help for this field's will be changed

Thanks.

[lp:~openerp-dev/openobject-addons/trunk-paypal-transaction-fees-sgo]

8700. By Sanjay Gohel (Open ERP) on 2013-05-13

[IMP]improve string for international paypal charges help. and changed string where needed

8701. By Sanjay Gohel (Open ERP) on 2013-05-14

[IMP]Improve code

8702. By Sanjay Gohel (Open ERP) on 2013-05-15

[MERGE]sync with trunk'

8703. By Sanjay Gohel (Open ERP) on 2013-05-16

[IMP]improve string

8704. By Sanjay Gohel (Open ERP) on 2013-05-17

[IMP]onchange of company paypal fees country changed

8705. By Sanjay Gohel (Open ERP) on 2013-05-17

[IMP]improve string of percntage fee help

8706. By Sanjay Gohel (Open ERP) on 2013-06-05

[MERGE]sync with trunk

8707. By Sanjay Gohel (Open ERP) on 2013-06-10

[MERGE]sync with trunk

8708. By Sanjay Gohel (Open ERP) on 2013-06-20

[MERGE]sync with trunk

8709. By Sanjay Gohel (Open ERP) on 2013-06-24

[MERGE]sync with trunk

8710. By Sanjay Gohel (Open ERP) on 2013-06-25

[MERGE]sync with trunk

8711. By Sanjay Gohel (Open ERP) on 2013-07-01

[MERGE]sync with trunk

8712. By Sanjay Gohel (Open ERP) on 2013-07-22

[MERGE]sync with trunk

Unmerged revisions

8712. By Sanjay Gohel (Open ERP) on 2013-07-22

[MERGE]sync with trunk

8711. By Sanjay Gohel (Open ERP) on 2013-07-01

[MERGE]sync with trunk

8710. By Sanjay Gohel (Open ERP) on 2013-06-25

[MERGE]sync with trunk

8709. By Sanjay Gohel (Open ERP) on 2013-06-24

[MERGE]sync with trunk

8708. By Sanjay Gohel (Open ERP) on 2013-06-20

[MERGE]sync with trunk

8707. By Sanjay Gohel (Open ERP) on 2013-06-10

[MERGE]sync with trunk

8706. By Sanjay Gohel (Open ERP) on 2013-06-05

[MERGE]sync with trunk

8705. By Sanjay Gohel (Open ERP) on 2013-05-17

[IMP]improve string of percntage fee help

8704. By Sanjay Gohel (Open ERP) on 2013-05-17

[IMP]onchange of company paypal fees country changed

8703. By Sanjay Gohel (Open ERP) on 2013-05-16

[IMP]improve string

=== modified file 'account/edi/invoice.py'
--- account/edi/invoice.py	2012-12-17 14:43:06 +0000
+++ account/edi/invoice.py	2013-07-22 07:17:28 +0000
@@ -263,6 +263,7 @@
         res = dict.fromkeys(ids, False)
         for inv in self.browse(cr, uid, ids, context=context):
             if inv.type == 'out_invoice' and inv.company_id.paypal_account:
+                paypal_fees = self.pool.get('portal.payment.acquirer').compute_paypal_fees(cr, uid, inv, inv.currency_id, inv.residual, context=context)
                 params = {
                     "cmd": "_xclick",
                     "business": inv.company_id.paypal_account,
@@ -273,6 +274,7 @@
                     "button_subtype": "services",
                     "no_note": "1",
                     "bn": "OpenERP_Invoice_PayNow_" + inv.currency_id.name,
+                    "handling": paypal_fees
                 }
                 res[inv.id] = "https://www.paypal.com/cgi-bin/webscr?" + urlencode(params)
         return res

=== modified file 'account/project/wizard/account_analytic_chart_view.xml'
--- account/project/wizard/account_analytic_chart_view.xml	2012-11-29 22:26:45 +0000
+++ account/project/wizard/account_analytic_chart_view.xml	2013-07-22 07:17:28 +0000
@@ -13,8 +13,11 @@
                         <button string="Cancel" class="oe_link" special="cancel"/>
                     </header>
                     <group string="Select the Period for Analysis" col="4">
-                        <field name="from_date"/>
-                        <field name="to_date"/>
+                         <label for="from_date" class="oe_inline"/>
+                        <div>
+                            <field name="from_date" class="oe_inline"/>
+                            <field name="to_date" class="oe_inline"/>
+                        </div>
                         <label string="(Keep empty to open the current situation)" colspan="4"/>
                     </group>
                 </form>

=== modified file 'account/res_config_view.xml'
--- account/res_config_view.xml	2013-04-11 10:46:43 +0000
+++ account/res_config_view.xml	2013-07-22 07:17:28 +0000
@@ -226,21 +226,22 @@
                             </div>
                         </div>
                     </group>
+                    <group name="paypal">
+                        <label for="id" string="Paypal"/>
+                        <div>
+                            <label for="paypal_account"/>
+                            <field name="paypal_account" placeholder="e.g. [e-mail]" class="oe_inline"/>
+                        </div>
+                    </group>
                     <separator string="Bank &amp; Cash"/>
                     <group name="bank_cash">
                         <label for="id" string="Configuration"/>
                         <div>
-                            <div>
-                                <label for="company_footer"/>
-                                <button name="open_company_form" type="object"
-                                    string="Configure your company bank accounts" icon="gtk-go-forward"
-                                    class="oe_inline oe_link"/>
-                                <field name="company_footer"/>
-                            </div>
-                            <div>
-                                <label for="paypal_account"/>
-                                <field name="paypal_account" placeholder="e.g. [e-mail]" class="oe_inline"/>
-                            </div>
+                            <label for="company_footer"/>
+                            <button name="open_company_form" type="object"
+                                string="Configure your company bank accounts" icon="gtk-go-forward"
+                                class="oe_inline oe_link"/>
+                            <field name="company_footer"/>
                         </div>
                     </group>
                     <separator name="analytic_account" string="Analytic Accounting" invisible="1"/>

=== modified file 'portal/acquirer.py'
--- portal/acquirer.py	2012-11-30 09:45:01 +0000
+++ portal/acquirer.py	2013-07-22 07:17:28 +0000
@@ -47,7 +47,7 @@
         'visible': True,
     }
 
-    def render(self, cr, uid, id, object, reference, currency, amount, context=None, **kwargs):
+    def render(self, cr, uid, id, object, reference, currency, amount, fees=False, context=None, **kwargs):
         """ Renders the form template of the given acquirer as a mako template  """
         if not isinstance(id, (int,long)):
             id = id[0]
@@ -60,6 +60,7 @@
                                                            reference=reference,
                                                            currency=currency,
                                                            amount=amount,
+                                                           fees=fees,
                                                            kind=i18n_kind,
                                                            quote=quote,
                                                            # context kw would clash with mako internals
@@ -70,26 +71,40 @@
             _logger.exception("failed to render mako template value for payment.acquirer %s: %r", this.name, this.form_template)
             return
 
-    def _wrap_payment_block(self, cr, uid, html_block, amount, currency, context=None):
+    def _wrap_payment_block(self, cr, uid, html_block, amount, currency, fees=False, context=None):
         if not html_block:
             link = '#action=account.action_account_config'
-            payment_header = _('You can finish the configuration in the <a href="%s">Bank&Cash settings</a>') % link
+            payment_header = _('You can finish the configuration in the <a href="%s">eInvoicing &amp; Payments</a>') % link
             amount = _('No online payment acquirers configured')
+            fees_str = _('')
+            fees_amount = ''
             group_ids = self.pool.get('res.users').browse(cr, uid, uid, context=context).groups_id
             if any(group.is_portal for group in group_ids):
                 return ''
         else:
             payment_header = _('Pay safely online')
+            fees_str = _('Fees: ')
             amount_str = float_repr(amount, self.pool.get('decimal.precision').precision_get(cr, uid, 'Account'))
             currency_str = currency.symbol or currency.name
             amount = u"%s %s" % ((currency_str, amount_str) if currency.position == 'before' else (amount_str, currency_str))
-        result =  """<div class="payment_acquirers">
-                         <div class="payment_header">
-                             <div class="payment_amount">%s</div>
-                             %s
-                         </div>
-                         %%s
-                     </div>""" % (amount, payment_header)
+            fees_amount = u"%s %s" % ((currency_str, fees) if currency.position == 'before' else (fees, currency_str))
+        if fees:
+            result =  """<div class="payment_acquirers">
+                             <div class="payment_header">
+                                 <div class="payment_amount">%s</div>
+                                 <div>%s %s</div>
+                                 %s
+                             </div>
+                             %%s
+                         </div>""" % (amount, fees_str, fees_amount, payment_header)
+        else:
+            result =  """<div class="payment_acquirers">
+                             <div class="payment_header">
+                                 <div class="payment_amount">%s</div>
+                                 %s
+                             </div>
+                             %%s
+                         </div>""" % (amount, payment_header)
         return result % html_block
 
     def render_payment_block(self, cr, uid, object, reference, currency, amount, context=None, **kwargs):
@@ -100,9 +115,28 @@
         if not acquirer_ids:
             return
         html_forms = []
+        paypal_fees = self.compute_paypal_fees(cr, uid, object, currency, amount, context=context)
         for this in self.browse(cr, uid, acquirer_ids):
-            content = this.render(object, reference, currency, amount, context=context, **kwargs)
+            content = this.render(object, reference, currency, amount, fees=paypal_fees, context=context, **kwargs)
             if content:
                 html_forms.append(content)
         html_block = '\n'.join(filter(None,html_forms))
-        return self._wrap_payment_block(cr, uid, html_block, amount, currency, context=context)  
+        return self._wrap_payment_block(cr, uid, html_block, amount, currency, fees=paypal_fees, context=context)  
+
+    def compute_paypal_fees(self, cr, uid, object, currency, amount, context=None):
+        group_id = self.pool.get('ir.model.data').get_object_reference(cr, uid, 'portal_sale', 'group_paypal_fees_on_customer')[1]
+        group_check_total = self.pool.get('res.groups').browse(cr, uid, group_id, context=context)
+        charge = 0.00
+        if group_check_total and uid in [x.id for x in group_check_total.users]:
+            if object.partner_id.country_id.id == object.company_id.country_id.id or not object.partner_id.country_id.id or not object.company_id.country_id.id:
+                per_fee = object.company_id.domestic_fee * 0.01
+                fix_fee = object.company_id.domestic_fixed_fee
+                charge = (per_fee * amount + fix_fee) / (1 - per_fee)
+            else:
+                per_fee = object.company_id.international_fee * 0.01
+                fix_fee = object.company_id.international_fixed_fee
+                charge = (per_fee * amount + fix_fee) / (1 - per_fee)
+            total_charges = float_repr(charge, self.pool.get('decimal.precision').precision_get(cr, uid, 'Account'))
+            return total_charges
+        else:
+            return charge
\ No newline at end of file

=== modified file 'portal/acquirer_view.xml'
--- portal/acquirer_view.xml	2012-12-21 16:48:08 +0000
+++ portal/acquirer_view.xml	2013-07-22 07:17:28 +0000
@@ -19,6 +19,7 @@
                                 <ul>
                                     <li>reference: the reference number of the document to pay</li>
                                     <li>kind: the kind of document on which the payment form is rendered (translated to user language, e.g. "Invoice")</li>
+                                    <li>handling: the total international/domestic fees to pay, as a float</li>
                                     <li>currency: the currency record in which the document is issued (e.g. currency.name could be EUR)</li>
                                     <li>amount: the total amount to pay, as a float</li>
                                     <li>object: the document on which the payment form is rendered (usually an invoice or sales order record)</li>

=== modified file 'portal/portal_data.xml'
--- portal/portal_data.xml	2012-12-21 16:48:08 +0000
+++ portal/portal_data.xml	2013-07-22 07:17:28 +0000
@@ -96,6 +96,7 @@
   <input type="hidden" name="item_name" value="${object.company_id.name} ${kind.title()} ${reference}"/>
   <input type="hidden" name="amount" value="${amount}"/>
   <input type="hidden" name="currency_code" value="${currency.name}"/>
+  <input type="hidden" name="handling" value="${fees}"/>
   <input type="image" name="submit" src="https://www.paypal.com/en_US/i/btn/btn_paynowCC_LG.gif"/>
 </form>
 % endif

=== modified file 'portal_sale/portal_sale.py'
--- portal_sale/portal_sale.py	2013-05-06 09:49:55 +0000
+++ portal_sale/portal_sale.py	2013-07-22 07:17:28 +0000
@@ -129,3 +129,18 @@
                 if p.id not in order.message_follower_ids:
                     so_obj.message_subscribe(cr, uid, [mail.res_id], [p.id], context=context)
         return super(mail_mail, self)._postprocess_sent_message(cr, uid, mail=mail, context=context)
+
+class res_company(osv.osv):
+    _inherit = "res.company"
+    _columns = {
+                'domestic_fee': fields.float('Percentage fee', help="Percentage fee charged by Paypal on each transaction. The percentage fee is applied before the fixed fee on the total amount of the invoice."),
+                'domestic_fixed_fee': fields.float('Fixed fee', help="Fixed fee charged by Paypal on each transaction."),
+                'international_fee': fields.float('Percentage fee', help="Percentage fee charged by Paypal on each transaction. The percentage fee is applied before the fixed fee on the total amount of the invoice."),
+                'international_fixed_fee': fields.float('Fixed fee', help="Fixed fee charged by Paypal on each transaction."),
+    }
+    _defaults = {
+        'domestic_fee': 2.90,
+        'domestic_fixed_fee': 0.30,
+        'international_fee': 3.90,
+        'international_fixed_fee': 0.30
+    }

=== modified file 'portal_sale/res_config.py'
--- portal_sale/res_config.py	2012-11-13 16:44:35 +0000
+++ portal_sale/res_config.py	2013-07-22 07:17:28 +0000
@@ -21,6 +21,10 @@
 
 from openerp.osv import fields, osv 
 
+from lxml import etree
+from openerp import tools
+from openerp.tools.translate import _
+
 class sale_portal_config_settings(osv.TransientModel):
     _inherit = 'account.config.settings'
 
@@ -29,4 +33,57 @@
             implied_group='portal_sale.group_payment_options',
             help="Show online payment options on Sale Orders and Customer Invoices to employees. "
                  "If not checked, these options are only visible to portal users."),
-    }
\ No newline at end of file
+        'group_paypal_fees_on_customer': fields.boolean('Charge Paypal fees to customers',
+            implied_group='portal_sale.group_paypal_fees_on_customer',
+            help="Check this box if you want to charge the transaction fees to your customers when they pay with Paypal. "
+                 "An additional line will appear on the Paypal payment form with the amount of the fee."),
+        'domestic_fee': fields.related('company_id', 'domestic_fee', type='float', string='Percentage fee',
+            help="Percentage fee charged by Paypal on each transaction. The percentage fee is applied before the fixed fee on the total amount of the invoice."),
+        'domestic_fixed_fee': fields.related('company_id', 'domestic_fixed_fee', type='float', string='Fixed fee',
+            help="Fixed fee charged by Paypal on each transaction"),
+        'international_fee': fields.related('company_id', 'international_fee', type='float', string='Percentage fee',
+            help="Percentage fee charged by Paypal on each transaction. The percentage fee is applied before the fixed fee on the total amount of the invoice."),
+        'international_fixed_fee': fields.related('company_id', 'international_fixed_fee', type='float', string='Fixed fee',
+            help="Fixed fee charged by Paypal on each transaction"),
+        'is_country': fields.boolean('If country in company',readonly=True),
+        'country_name_dmstc': fields.char("Country name for domestic help",size=128,readonly=True),
+        'country_name_intrntl': fields.char("Country name for international help",size=128,readonly=True),
+    }
+    
+    def onchange_company_id(self, cr, uid, ids, company_id, context=None):
+        vals = super(sale_portal_config_settings, self).onchange_company_id(cr, uid, ids, company_id, context=None)
+        company = self.pool.get('res.company').browse(cr, uid, company_id, context=context)
+        if company.country_id:
+            vals['value'].update({
+                    'is_country':True,
+                    'country_name_dmstc':company.country_id.name,
+                    'country_name_intrntl':company.country_id.name,
+                    })
+        else:
+            vals['value'].update({
+                    'is_country':False,
+                    })
+        vals['value'].update({
+                'domestic_fee': company.domestic_fee,
+                'domestic_fixed_fee': company.domestic_fixed_fee,
+                'international_fee': company.international_fee,
+                'international_fixed_fee': company.international_fixed_fee,
+                   })
+        return vals
+    
+    def open_current_company(self, cr, uid, ids, context=None):
+        """ open Company's view """
+        mod_obj = self.pool.get('ir.model.data')
+        config = self.browse(cr, uid, ids[0], context=context)
+        dummy, form_view = mod_obj.get_object_reference(cr, uid, 'base', 'view_company_form')
+        return {
+            'name': _('Company'),
+            'view_type': 'form',
+            'view_mode': 'form',
+            'res_model': 'res.company',
+            'res_id': int(config.company_id.id),
+            'view_id': False,
+            'views': [(form_view or False, 'form'),
+                    (False, 'calendar'), (False, 'graph')],
+            'type': 'ir.actions.act_window',
+        }

=== modified file 'portal_sale/res_config_view.xml'
--- portal_sale/res_config_view.xml	2012-11-13 16:44:35 +0000
+++ portal_sale/res_config_view.xml	2013-07-22 07:17:28 +0000
@@ -7,13 +7,48 @@
                 <field name="model">account.config.settings</field>
                 <field name="inherit_id" ref="account.view_account_config_settings"/>
                 <field name="arch" type="xml">
-                    <xpath expr="//group[@name='bank_cash']/div" version="7.0" position="inside">
+                    <xpath expr="//group[@name='paypal']/div" version="7.0" position="inside">
                         <div>
                             <field name="group_payment_options" class="oe_inline"/>
                             <label for="group_payment_options"/>
                             <button name='%(portal.action_acquirer_list)d' type="action"
                                     string="Configure payment acquiring methods" class="oe_link"/>
                         </div>
+                        <div>
+                            <field name="group_paypal_fees_on_customer" class="oe_inline"/>
+                            <label for="group_paypal_fees_on_customer"/>
+                        </div>
+                        <field name="is_country" invisible="1"/>
+                        <div attrs="{'invisible': [('group_paypal_fees_on_customer','=',False)]}">
+                            <p name="help_domestic">Fees for domestic transactions (per transaction).</p>
+                            <p attrs="{'invisible': [('is_country','=',False)]}">These fees will be applied to any Paypal payment 
+                                where the customer’s country on the invoice is <field name="country_name_dmstc"/></p>
+
+                            <p attrs="{'invisible': [('is_country','=',True)]}">These fees will be applied to any Paypal payment 
+                                where the customer’s country on the invoice is the same as the country in your <button name="open_current_company" type="object" class="oe_link" string="company's address"/></p>
+                            <div>
+                                <label for="domestic_fee"/>
+                                <field name="domestic_fee" class="oe_inline" attrs="{'required': [('group_paypal_fees_on_customer','=',True)]}"/><b>%%</b>
+                            </div>
+                            <div>
+                                <label for="domestic_fixed_fee"/>
+                                <field name="domestic_fixed_fee" class="oe_inline" widget='monetary' options="{'currency_field': 'currency_id'}" attrs="{'required': [('group_paypal_fees_on_customer','=',True)]}"/>
+                            </div>
+                            <p name="help_international">Fees for international transactions (per transaction).</p>
+                            <p attrs="{'invisible': [('is_country','=',False)]}">These fees will be applied to any Paypal payment where 
+                                the customer’s country on the invoice is different from <field name="country_name_intrntl"/></p>
+
+                            <p attrs="{'invisible': [('is_country','=',True)]}">These fees will be applied to any Paypal payment where the customer’s country 
+                                on the invoice is different from the country in your <button name="open_current_company" type="object" class="oe_link" string="company's address"/></p>
+                            <div>
+                                <label for="international_fee"/>
+                                <field name="international_fee" class="oe_inline" attrs="{'required': [('group_paypal_fees_on_customer','=',True)]}"/><b>%%</b>
+                            </div>
+                            <div>
+                                <label for="international_fixed_fee"/>
+                                <field name="international_fixed_fee" class="oe_inline" widget='monetary' options="{'currency_field': 'currency_id'}" attrs="{'required': [('group_paypal_fees_on_customer','=',True)]}"/>
+                            </div>
+                        </div>
                     </xpath>
                 </field>
         </record>

=== modified file 'portal_sale/security/portal_security.xml'
--- portal_sale/security/portal_security.xml	2012-11-29 22:26:45 +0000
+++ portal_sale/security/portal_security.xml	2013-07-22 07:17:28 +0000
@@ -9,6 +9,10 @@
 on Sale Orders and Customer Invoices. These options are meant for customers who are accessing
 their documents through the portal.</field>
         </record>
+        <record id="group_paypal_fees_on_customer" model="res.groups">
+            <field name="name">Advance Paypal Payment Options</field>
+            <field name="category_id" ref="base.module_category_hidden"/>
+        </record>
         <!-- Make the payment_options group implied for all portal users -->
         <record id="portal.group_portal" model="res.groups">
             <field name="implied_ids" eval="[(4,ref('group_payment_options'))]"/>

=== modified file 'sale/edi/sale_order.py'
--- sale/edi/sale_order.py	2012-12-17 14:43:06 +0000
+++ sale/edi/sale_order.py	2013-07-22 07:17:28 +0000
@@ -186,6 +186,7 @@
         for order in self.browse(cr, uid, ids, context=context):
             if order.order_policy in ('prepaid', 'manual') and \
                     order.company_id.paypal_account and order.state != 'draft':
+                paypal_fees = self.pool.get('portal.payment.acquirer').compute_paypal_fees(cr, uid, order, order.pricelist_id.currency_id, order.amount_total, context=context)
                 params = {
                     "cmd": "_xclick",
                     "business": order.company_id.paypal_account,
@@ -196,6 +197,7 @@
                     "button_subtype": "services",
                     "no_note": "1",
                     "bn": "OpenERP_Order_PayNow_" + order.pricelist_id.currency_id.name,
+                    "handling": paypal_fees
                 }
                 res[order.id] = "https://www.paypal.com/cgi-bin/webscr?" + urlencode(params)
         return res