[D6] Site Search Analytics from Visitors Voice

Please add your sandbox URL and drupal repository URL

1. No README.txt file found
2. Found commented code in module file in function visitorsvoice_api_settings() and in function visitorsvoice_api_retrieve_results(). please remove that.
3. Function visitors_voice_api_keywords_to_url(), visitors_voice_api_search_terms_from_url(), visitors_voice_api_search_terms_to_url() and more which is never used.

Please check above

An Example module should be good.

The comment #5 is a SPAM!

Yes. That would be nicer!

Hi, Im the one who has initiated the development of this plugin. You can read more about our product at http://en.visitorsvoice.com and you can check out the API at http://api.visitorsvoice.com/.

We have many ideas of how to use our API for Drupal - for example to present internal search terms of a page/group of pages in order to help users navigate (quite common feature). Another idea is to present incoming/outgoing internal search terms in the edit mode for a page.

But we are not really sure how to do this in "the Drupal way" and would love to get some feedback on that from you guys or other Drupalists.

Therefore we would like to just as a start get this module published and in this way attract ideas and brains to our project/product. Whats your take on that?

More details on the ideas:

For the first idea this call would be used: http://api.visitorsvoice.com/Help/Api/GET-api-v1-SearchTermsFromUrl-Get_...

As url one can send in a full url or part of url and get all search terms made from pages matching that url. For example:
http://www.....com/category/specificpage.html => get outgoing search terms from that url
http://www.....com/category/ => get outgoing search terms from all subpages

For the second idea this call would be used: http://api.visitorsvoice.com/Help/Api/GET-api-v1-UrlContext-Get_start_da...

This gives valuable insights for editors when they work with their pages.

Perhaps we should change the name of this plugin to "Visitors Voice Site Search Analytics API" and the other modules we plan to do we could call "Visitors Voice Site Search from pages" and "Visitors Voice Site Search Analytics" etc

What's your take on that?

Best,
Pontus

Link to the project page and git clone command are missing in the issue summary, please add them.

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

Link to project page and git clone command added.

Thanks,
Pontus

Updated status as well to need review.

There are some errors reported by automated review tools, did you already check them? See http://pareview.sh/pareview/httpgitdrupalorgsandboxiamrasec2080155git

I'm a robot and this is an automated message from Project Applications Scraper.

Master Branch

It appears you are working in the "master" branch in git. You should really be working in a version specific branch. The most direct documentation on this is Moving from a master branch to a version branch. For additional resources please see the documentation about release naming conventions and creating a branch in git.

Aside from that, this would be RTBC from me.

----
Top Shelf Modules - Crafted, Curated, Contributed.

Added sandbox URL and Drupal repository URL to description

Thanks!

----
Top Shelf Modules - Crafted, Curated, Contributed.

I don't think the docblocks/doxygen written in the sandbox is completely in line with how Drupal expects documentation to be written.

For example :

**
 * Detect sudden changes users are searching for.
 *
 * @date_zero (integer) - required
 *   End date of the period where the search term trend should be detected 
 *   (yyyymmdd).
 *
 * @duration (integer) - required
 *   How many days back from date zero should be used for tracking the 
 *   search term trend (1-10).
 * 
 * @offset (integer) - required
 *   How many days previous to search term trend should be used for 
 *   comparison (1-30).
 * 
 * @min_user (integer) - required
 *   Minimum user count per day during trend period (>1).
 * 
 * @min_increase (integer) - required
 *   Min increase in user count during trend period compared to 
 *   previous period (>1).
 *
 * @ctr (string) - required
 *   Min (GT) /max (LT) click through rate ("GT-61" search terms 
 *   with max CTR of 60 during the trend period. "LT-59" means the opposite).
 * 
 * @return (object)
 *   The Drupal result object, or FALSE if the API key is not set.
 */

However, it should be like the following example :

/**
 * Sanitizes the 'value' or 'summary' data of a text value.
 *
 * Depending on whether the field instance uses text processing, data is run
 * through check_plain() or check_markup().
 *
 * @param $instance
 *   The instance definition.
 * @param $langcode
 *  The language associated to $item.
 * @param $item
 *   The field value to sanitize.
 * @param $column
 *   The column to sanitize (either 'value' or 'summary').
 *
 * @return
 *  The sanitized string.
 */

So the word after the @ needs to be a known word, not the argument.

Thank you, now this is fixed.

Added another project reviewed

I have added one more project reviewed.

I cant add tags to this page, but we claim the reviewbonus (PAReview: reviewbonus).

Did you forget to push your changes? http://drupalcode.org/sandbox/iamrasec/2080155.git

You can add tags to issues like this:

I have a major issue - the developer that helped us with this module doesnt respond any longer and I dont know how to push the changes to http://drupalcode.org/sandbox/iamrasec/2080155.git? If you check here I have made the changes

https://github.com/iamrasec/visitorsvoice_api

and I thought this was enough.

Any suggestions how I should proceed with this?

I would say to do the following:

1. Copy the sandbox code into your own sandbox.
2. Close this application.
3. Open a new application under your name, linking to your sandbox.

Unfortunately, we can only review drupal projects and sandboxes, not github. Sending to klausi as he would know better.

----
Top Shelf Modules - Crafted, Curated, Contributed.

Yep, exactly. Since we are vetting users here in this process you should open your own sandbox and your own project application issue.

Closing this one.

Review of the 6.x-1.x branch:

• Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.

This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

manual review:
Your doc blocks are stil formatted wrong, check the standards: https://drupal.org/node/1354#param
It might be nice to have an example module included that actuallly does something with the received data, like displaying it in a block or similar.

But otherwise looks good to me. Since this was RTBC already and further fixing the doc blocks is not a critical application blocker ...

Thanks for your contribution, iamrasec!

I updated your account so you can promote this to a full project and also create new projects as either a sandbox or a "full" project.

Here are some recommended readings to help with excellent maintainership:

• Dries' post on Responsible maintainers
• Best practices for creating and maintaining projects
• Maintaining a drupal.org project with Git
• Commit messages - providing history and credit
• Release naming conventions.
• Helping maintainers in the issue queues

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, also, for your patience with the review process. Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

Thanks to the dedicated reviewer(s) as well.

Forgot coder sniffer attachment.