CiviCRM Community Forums (archive)

*

News:

Have a question about CiviCRM?
Get it answered quickly at the new
CiviCRM Stack Exchange Q+A site
This forum was archived on 25 November 2017. Learn more.
How to get involved.
What to do if you think you've found a bug.



  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion »
  • Google Summer of Code »
  • GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
Pages: 1 2 3 [4] 5 6 ... 8

Author Topic: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation  (Read 9573 times)

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 14, 2015, 02:21:39 pm
Great Annudit - have a go at creating an extension with an api in it next! The api doesn't need to do anything
Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 18, 2015, 10:25:15 am
Hi,

In past couple of days I faced a problem with my Ubuntu OS. Actually I was working whilst my laptop shutdown unexpectedly (I really don't know what happened there) on the top of that I was getting boot error ( kernel panic-not syncing: VFS: unable to mount root fs on unknown block(0,0) )

It is fixed now although I went through the setup process again (apache and buildkit) but I am glad it is running as expected, resuming from where I left.
Sorry I was unable to post my updates/reply regarding this on the forums.
I am now able to generate the skeletal module along with an API in it. I have created a test API but it in not appearing in the API explorer, also I am unable to change the custom extension path, the changes are not getting saved. What could be the possible reason for this ? well I am logging in as admin.

Thank you.
« Last Edit: June 18, 2015, 06:34:09 pm by Anudit Verma »
-for the love of code and always learning

Anudit Verma

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 22, 2015, 12:32:39 am
Hi,

Updates:

After the last Project check-in meeting on Hangout, Joe McLaughlin and Eileen decided to setup up  a CiviCRM drupal Sandbox development environment, we now have a Citizen Action of New York sponsored GSoC server.

Also now I can upload my locally created custom extensions to that server for testing as well I am able to generate skeletal modules through civix via SSH connected terminal window directly on the server.
Further for my previous issue with API explorer and extensions which were unresponsive as I was getting a white screen to which Eileen has figured out that I might be having some issues in apache. Now currently I am also monitoring my apache error log for error handling, I think this would be solved soon. Meanwhile I can incessantly work with extensions having API on the remote server.

Thank you.
-for the love of code and always learning

Anudit Verma

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 26, 2015, 01:44:25 pm
Updates:

After the last hangout meeting on  26th (Friday) following targets have been drawn for the coming weeks, initial OSDI implementation would be initiated now in a custom API. We will be using the HAL instance implemented by Action Network which can be accessed here: https://actionnetwork.org/api/browser/#https://actionnetwork.org/api/v1/

For viewing the data in the HAL by URL input, Eileen advised me to use hook for the custom module. This link can be followed to know more about hook in CiviCRM: http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu

Also after a bit more discussion on IRC with Eileen, Joe Murray, Josh Cohen from OSDI and Jason from Action Network we all have agreed to bypass the authentication for now (this week) which will be focused on next week.

Thank you.
-for the love of code and always learning

Anudit Verma

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 26, 2015, 05:54:20 pm
Anudit - you won't need that hook to implement the agreed path - ie the osdi file directly. Did you make any progress after the call yesterday?
Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 27, 2015, 01:16:18 pm
Ok- So I need to just put in the complete URL in HAL ie [drupal site URL]/sites/all/modules/civicrm/extern/rest.php?entity=people replacing rest.php by osdi.php
For adding the code into osdi.php, Do I need to follow OSDI based format fields instead of CiviCRM ?
I am trying it locally on my machine first and further I would try doing sftp on the remotely hosted working environment.
Thanks.
-for the love of code and always learning

Anudit Verma

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
June 27, 2015, 02:21:22 pm
yes - you want to return it in OSDI style format from there. I think if you look at IRC logs there were 3 goals in terms of what to return for Friday
Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 02, 2015, 01:32:09 am
Updates:

I was having some issues while working locally on my dev setup as I was unable to get any response on HAL-browser (viz is also implemented locally in web root), after the discussion with Eileen and Jason in an e-mail correspondence I learned that HAL browser may never work for localhost due to CORS browser restrictions. So we decided to upload the osdi.php on the gsoc-server sponsored for this project which will be based on OSDI format fields. Also now we have a running instance of HAL-browser on the gsoc-server for testing which can be accessed at http://camus.fuzion.co.nz/hal-browser/browser.html#/

I have configured sftp in FileZilla (ftp client) to connect and upload the customized file on the gsoc-server. Now I will be uploading and testing out the file on this server.
We will be skipping the authentication and would start that working on it after the Project check-in meeting coming this week.

Thank you.
-for the love of code and always learning

Anudit Verma

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 03, 2015, 03:33:53 pm
Updates:

After the last Project check-in Hangout meeting on 3rd July 7:30 am IST with the team we have decided to push the development process forward so that it would gain more momentum as valuable time was lost in the setup of development environment. Also I was unable to retrieve the data from CiviCRM through HAL-browser which didn't allow me to deliver my commitment of presenting the JSON code for retrieving the sample data from CiviCRM via hyper links.

Joe Murray decided to hold another meeting for the next day according to Eastern time for resolving these issues. On the same day at 6:40 pm IST, I conversed with him along with Edsel Roque who was invited to help me through the problem, Edsel is a member of JMA consulting from Mumbai, he is associated with CiviCRM for more than 4 years now. Joe Murray had other commitments for that hour so I worked with Edsel and he guided me through on retrieving the data through REST calls. I learned that in order to expose the data from CiviCRM we need some key based authentication so we decided to implement CiviCRM site and API keys in the REST URL. Thereafter I got to know about adding my own API key into the CiviCRM's database (I used mysql on the terminal in order to update the API key in the CiviCRM database). Further CiviCRM site key was retrieved which can be viewed in the file civicrm.settings.php located in the default directory under sites. After incorporating both the keys in the REST URL (as viewed in API Explorer) I was successfully able to view the exposed data when the complete URL was opened in a new browser tab window (local HAL-browser may not work due to CORS restrictions). I am very much thankful to Edsel for helping me resolved the issue I had.

Now I will be working on presenting the data in the OSDI format and would report about the same to Joe Murray in a meeting scheduled on Monday.

Thank you.
-for the love of code and always learning

Anudit Verma

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 07, 2015, 05:30:51 am
Updates:

Over the weekend I worked on presenting the CiviCRM's sample data (Contacts) into format based on OSDI specification. I have coded the Get.php (viz. custom API action file present under custom my extension dir) to transform some of the CiviCRM's fields as per the OSDI specification. Now I am able to retrieve the Contact data in OSDI format with some common fields that were transformed for People's resource. It is working fine on my local machine, also after discussing it with Joe Murray I have generated an API key against my user name on the gsoc-server so now it would work on the gsoc-server as well by passing the custom API name and action along with keys.

Now I am working on mapping more fields from OSDI specification also I am optimizing the code for reformatting the People's record.

Thank you.
-for the love of code and always learning

Anudit Verma

joemcl

  • I post occasionally
  • **
  • Posts: 72
  • Karma: 1
    • Citizen Action of New York
  • CiviCRM version: 4.4.13
  • CMS version: Drupal 7.34
  • MySQL version: 5.6
  • PHP version: Unsure
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 07, 2015, 08:33:45 am
Anudit, thanks so much for the updates. Looks like you're making some real progress. I'll check them out and loop back with you and Joe Murray soon.


Thanks again.

xavier

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4453
  • Karma: 161
    • Tech To The People
  • CiviCRM version: yes probably
  • CMS version: drupal
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 07, 2015, 10:15:20 pm
where is the code? github?
-Hackathon and data journalism about the European parliament 24-26 jan. Watch out the result

Eileen

  • Forum Godess / God
  • I’m (like) Lobo ;)
  • *****
  • Posts: 4195
  • Karma: 218
    • Fuzion
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 07, 2015, 10:19:28 pm
Yep Anudit - Xavier is right - time to start getting it onto github now
Make today the day you step up to support CiviCRM and all the amazing organisations that are using it to improve our world - http://civicrm.org/contribute

joemcl

  • I post occasionally
  • **
  • Posts: 72
  • Karma: 1
    • Citizen Action of New York
  • CiviCRM version: 4.4.13
  • CMS version: Drupal 7.34
  • MySQL version: 5.6
  • PHP version: Unsure
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 08, 2015, 09:38:35 am
Anudit's GitHub is here: https://github.com/anuditverma?tab=repositories

Anudit Verma

  • I post occasionally
  • **
  • Posts: 66
  • Karma: 3
  • Budding author of a concise tech blog.
  • CiviCRM version: 4.7
  • CMS version: Drupal 8 , WordPress 4.4.2
  • MySQL version: 5.6.17
  • PHP version: 5.5.9
Re: GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation
July 08, 2015, 12:25:53 pm
Hi  everyone,

I have pushed some changes to the repository on GitHub. You could follow this link to view the changes made to the custom extension:

https://github.com/anuditverma/OSDI-Implementation

Thank you.
-for the love of code and always learning

Anudit Verma
Pages: 1 2 3 [4] 5 6 ... 8
  • CiviCRM Community Forums (archive) »
  • Old sections (read-only, deprecated) »
  • Developer Discussion »
  • Google Summer of Code »
  • GSoC 2015 : New API : Open Supporter Data Interface (OSDI) Implementation

This forum was archived on 2017-11-26.