[GSOC 2015] Refunds for CiviCRM

[tahirramzan]

Respected Developers,

My name is Tahir Ramzan, student of BS(Computer Science) from Virtual University of Pakistan and I am interested to develop “Refunds” module for CiviCRM. The objective of this project is to provide functionality of refunding. Refunding occurs when wrong amount cheque is submitted, an event ticket is returned before an event, a membership or subscription is cancelled, or a donation exceeds the legal limit for a campaign contribution. It will enable CiviCRM users to request and release refunds. It is a potential problem and has enough possibilities to occur frequently.

Kindly share you precious feedback, thanks.

[Erik Hommel]

Cool Tahir! Sounds good!

[tahirramzan]

PERSONAL INFORMATION

(deleted by forum admins)

PROJECT INFORMATION

Which project idea sparks your interest and why?

I am interested to develop “Refunds” module for CiviCRM. The objective of this project is to provide functionality of refunding. Refunding occurs when wrong amount cheque is submitted, an event ticket is returned before an event, a membership or subscription is cancelled, or a donation exceeds the legal limit for a campaign contribution. It will enable CiviCRM users to request and release refunds. It is a potential problem and has enough possibilities to occur frequently.

Rectification of errors is a technique in financial accounting to solve this type of errors. It can be implemented digitally in CiviCRM to get functionality of “Refunds” to tackle above potential problem. It will be developed as: 

Allocate separate permissions (for roles authorized) to create refunds, approve refunds, submit refunds to payment processors, cut cheques for refunds
Proper bookkeeping entries for accounts payable for refunds owed but not sent, and for refunds disbursed
Intuitive user experience for site administrators, who are not bookkeepers
An intuitive user experience for self-serve refunds as appropriate by end users
Integrating cheque printing and audit controls from an existing CiviCRM grant programs extension


Why me to solve this problem and develop solution?

I am a fast leaner and quick accomplisher.
I have great skills to program in different programming language including C, C++, C#, PHP, Python and Java.
I have extensive abilities to read, understand and work with APIs, documentations and libraries.
I have knowledge of software project management to tackle critical projects and meet deadlines.
I studied financial accounting, financial statements and financial management deeply to handle bookkeeping and financial transactions.
And I will be fully available to project because there will not be any exam or study work trough out the schedule as my good luck to participate in GSoC 2014.


Potential Mentors: Joe Murray, Xavier Dutoit, Kreynen



Expected Deliverables:

05 May:   Software Requirements Specification
19 May:   UI Wireframes & Mockups
02 June:  Pre Alpha Version
16 June:  Alpha Version
25 July:   Beta Version
17 Aug:   Final Submission
 


Timeline:

Before April 21:

Familiarize myself completely with the CiviCRM
Read CiviCRM developer documentation
Review existing documentation
Keep in touch with CiviCRM community
April 22 – May 05:

Read and explore codebase
Keep in touch with my mentor regularly
Prepare Software Requirements Specification
Get feedback from community and update SRS accordingly
May 06 – May 19:

Read and explore codebase
Keep in touch with my mentor regularly
Prepare UI Wireframes & Mockups
Get feedback from community and update Wireframes and Mockups accordingly
May 20 – June 02:

Get instructions and guidance from mentor
Start coding and development of core functionality
Development will be Test-driven Development
Deliver Pre-Alpha version
June 03 – June 16:

Get instructions and guidance from mentor
Accommodate community feedback and Debugging of Pre-Alpha version
Further coding and development of remaining functionality according to SRS
Deliver Alpha version
June 17 – June 27:

Mid-term evaluation
June 28 – July 11:

Get instructions and guidance from mentor
Accommodate community feedback on Alpha version
Testing and Debugging
Complete required functionality according to SRS
July 12 – July 25:

Get instructions and guidance from mentor
Get feedback from CiviCRM community
Testing and Debugging   
Deliver Beta version
July 26 – August 08:

Get instructions and guidance from mentor
Get feedback from CiviCRM community
Testing and Debugging   
Code scrubbing
August 09 – August 16:

Get instructions and guidance from mentor
Get feedback from CiviCRM community
Verification and Validation of requirements
Documentation improvement
August 17 – August 21:

Final evaluation
Aug 22, 2014:

Submission of required code samples to Google


Which aspect project idea do you see as the most difficult?

Nothing is difficult to those who have the will.

Which aspect project idea do you see as the easiest?

Bookkeeping is the easiest aspect of the project for me as I have excellent knowledge of financial accounting and financial management.

Which portion of the project idea will you start with?

I will start from Bookkeeping.

[xavier]

Hi Tahir,

Your project unfortunately wasn't selected for the GSoC. It was a good one, but we had too many good projects and we gave the 6 slots to others.

I encourage you to apply again next year, and as I mentioned on my feedback on google melange, try to come earlier in the discussion to help shape your project even better and engage with the community.

[tahirramzan]

respected sir(s),

i would like to submit that i will be developing this idea even without a stipend as i have already worked alot on this and i am determined to do so because of the fact that i am highly interested in CiviCRM; but the point made from your side that i did get quite late in submission was due to the fact that i was busy in taking exams of my course and once i got spared from it i, without wasting a single second, submitted my proposal.
only question arising here is that should i or should i not do it this way, what would you suggest ?
i would appreciate your kind and quick response, thanks in anticipation.

[tahirramzan]

This is my last year's proposal, kindly give me feedback on it, it will be pleasure for me to improve.
Regards

[JoeMurray]

Could you provide links to your several websites developed with Drupal, WordPress and Joomla?

Also, could you provide evidence of your "excellent knowledge of financial accounting and financial management"?

Have you ever worked to maintain or change software in large existing project before? Could you provide code samples from that? Could you provide PHP code samples?

Could you update your plan to incorporate work during the two week period you have set aside for a mid-term evaluation?

[tahirramzan]

Websites links:
http://www.must.edu.pk/
http://www.skytelecom.com.pk/
http://rosefm90.fm/

[tahirramzan]

What type of evidence you want? I have studied financial accounting and financial management in my university, are you asking for transcript sir?

[tahirramzan]

I have not worked to maintain or change software in large existing project before.

[JoeMurray]

http://www.must.edu.pk/
http://www.skytelecom.com.pk/
http://rosefm90.fm/

Thanks for the reference to these three WordPress sites. Could you indicate what role you played with their development, maintenance or administration?

Do you have any references for Drupal or Joomla sites?

It would be useful to see transcripts for your studies as part of your application, to my mind.

Looking at what we have committed to as a mentoring organization this year - http://wiki.civicrm.org/confluence/display/CRM/Application+draft+2015 - I think I would like you update your proposal to take account of all the relevant commitments there in terms of early code creation (within first two weeks), daily scrum updates on forum, regular meetings with mentor, etc.

[tahirramzan]

Respected Sir,
I have designed, developed deployed these different websites (plus plugins etc), I have also installed joomla and drupal CMS websites for local organizations but I have not access to these now as it was paid for those. All these websites are normal, not any mega or extra ordinary.

[tahirramzan]

Respected Sir,

Kindly look at this to check my transcripts, Online Verification of Transcripts:

Link: http://www.vu.edu.pk/verify/OnlineTranscriptVerification.aspx

Student ID: bc090403070
Verification Key: pzv366jpq

Student ID: bc140202189
Verification Key: 9jcdgbzpq

You can also check all courses curriculum and contents here: http://ocw.vu.edu.pk/

Regards

[tahirramzan]

Updated Proposal

GSOC INFORMATION
I had applied last year for CiviCRM, I had proposed same project last year but I was not accepted that time because I was late comer.
I am applying again for CiviCRM same project and I can devote approximately 45 hours per week to my GSoC project and there will not be any exams, education activities or some other work in this summer. I am very passionate to be part of CiviCRM and GSoC and I will give my full attention to my project to make it successful. It will be really great to start my career and boost my skills.
I think my proposed “Refunds and Partial Payments Module” is much wanted project across CiviCRM community and it highly suits my interests and learnings too.  I am expecting that this project will become part of CiviCRM core.

CIVICRM INFORMATION
Have you registered an account at CiviCRM.org?
Yes
Have you ever built a site with Drupal, WordPress, or Joomla?
Yes
Have you ever built a CiviCRM site or helped on a CiviCRM project? 
Yes, I have installed on my system for evolution purposes, I have installed CiviCRM with all of three CMS Joomla, Drupal and Wordpress.
Have you ever posted questions to the CiviCRM Forums, JIRA, or GitHub?
Yes, I am posting to get feedback and guidance for my proposed project.
Have you ever contributed code to CiviCRM?
Yes, I am trying but at this moment I have my terminal exam that’s why I am not fully involved yet.

TECHNICAL INFORMATION
Have you ever utilized IRC?
Yes
Have you ever worked with Git?
Yes, but not professionally, I have taken these two courses for Git training:
How to Use Git and GitHub (https://www.udacity.com)
https://training.github.com

PROJECT INFORMATION
Which project idea sparks your interest and why?[/b]
I am interested to develop “Refunds and Partial Payments” module for CiviCRM. Link of projects idea page:
http://wiki.civicrm.org/confluence/display/CRM/Google+Summer+of+Code+-+2015
http://wiki.civicrm.org/confluence/display/CRMDOC/CiviAccounts+Roadmap
http://wiki.civicrm.org/confluence/display/CRM/Finance+and+Accounting
I am passionate to develop “Refunds and Partial Payments” module because I think it is much needed as well as I have already knowledge of financial account and financial management. I am expecting that my contribution will become part of CiviCRM core and nothing is more honorable for a computer science student to become part of any open source project contribution. 

Why me to solve this problem and develop solution?
•   I am a fast and quick leaner.
•   I am dedicated and sustainable.
•   I am flexible to be part of any team.
•   I have skills to program in different programming languages including PHP.
•   I have abilities to read, understand and work with APIs, documentations and libraries.
•   I have knowledge of software project management to tackle and meet deadlines.
•   I studied financial accounting, financial statements and financial management.
•   And I will be fully available to this project.

Potential Mentors: Joe Murray, Xavier Dutoit, Kreynen

Expected Deliverables:
05 May:   Software Requirements Specification and Design Document
19 May:   User Interfaces
02 June:   Refunds Module
16 June:   Partial Payments Module
25 July:   Final integration with CiviCRM components

Timeline:
Before April 27:
•   Familiarize myself completely with the CiviCRM
•   Read CiviCRM developer documentation
•   Keep in touch with CiviCRM community
•   Exploration, evaluation and experimentation with codebase
April 27 – May 05:
•   Keep in touch with my mentor regularly
•   Prepare Software Requirements Specification and Design Document
•   First Blog and forum post
•   Get feedback from community and update SRS and DD accordingly
May 06 – May 19:
•   Keep in touch with my mentor regularly
•   Prototyping of User Interfaces
•   Second Blog and forum post
•   Get feedback from community and update UIs
May 20 – June 02:
•   Get instructions and guidance from mentor
•   Coding of Refunds Module
•   Third Blog and forum post
•   Get feedback from community and its updation
June 03 – June 16:
•   Get instructions and guidance from mentor
•   Coding of Partial Payments Module
•   Fourth Blog and forum post
•   Get feedback from community and its updation
June 17 – June 27:
•   Mid-term evaluation submission
June 28 – July 11:
•   Get instructions and guidance from mentor
•   Testing and debugging
•   Fifth Blog and forum post
•   Get feedback from community and its updation
July 12 – July 25:
•   Get instructions and guidance from mentor
•   Integration with CiviCRM components (Refactoring of existing code if applicable)
•   Sixth Blog and forum post
•   Get feedback from community and its updation
July 26 – August 08:
•   Get instructions and guidance from mentor
•   Get feedback from CiviCRM community
•   Seventh Blog and forum post
•   Code scrubbing and improvement
August 09 – August 16:
•   Get instructions and guidance from mentor
•   Get feedback from CiviCRM community
•   Verification and Validation of requirements
•   Documentation preparation and improvement
August 17 – August 24:
•   Final evaluation
Aug 24, 2014:
•   Submission of required code samples to Google
•   Final Report and Blog Post

Which aspect project idea do you see as the most difficult?
Integration with CiviCRM components are seems comparatively difficult in this project; I think there should be some refactoring of existing code.

Which aspect project idea do you see as the easiest?
Financial accounting and financial management is easiest aspect for me as I have leant it in my university courses.

Which portion of the project idea will you start with?
I will start development from user interfaces then I will code Refunds Module, after that Partial Payments Module and finally I will integrate these with CiviCRM components.

Kindly give me your precious feedback on it, Regards

[JoeMurray]

Thanks for link to your transcripts. BTW, what is the reason for two - They appeared to be pretty much if not exactly the same?

I'm a bit concerned about the grades you have received and the quality of the institution. It seems some places in Pakistan haven't always accepted the degree given its perceived quality.

With respect to proposal I'm wondering if you could update it so that you don't take two weeks off for evaluation, and change it so that you are making you initial code commits and communicating with mentor as per commitments made in http://wiki.civicrm.org/confluence/plugins/servlet/mobile#content/view/216662033