[D7] Swagger

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

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.

Closing due to lack of activity. If you are still working on this application, you should fix all known problems and then set the status to "Needs review". (See also the project application workflow).

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

Hi,

manual Review :

.info file
1) We must not enter 'version' into info file , Drupal does that automatically for you during release. Please read here https://www.drupal.org/node/542202#version

.install file

Suggestions :
1) if your path "/admin/structure/services/list/" is an configuration path then you can define it inside your .info file with configure parameter.
2) You should try writing drupal_set_message() inside hook_enable() rather than in hook_install().

.module file
1) I guess this should be translatable string 'name' => 'Swagger UI' inside hook_libraries_info() ?

Hi, the module looks good. But I have a two small wishes

swagger.module

• 147 - Looks like here redundant empty string :)
• 177 – You might use module_load_include('inc', 'services','services.runtime') instead module_load_include('runtime.inc', 'services');

I love the idea of this module, I explored doing this for our most recent headless project, but abandoned it due to time pressure.
If theres anything I can do to help , let me know.
Just tried installing it, Can you specify the swagger ui version you used - 2.1.1 didnt seem to work

Automated Review

[Best practice issues identified by pareview.sh / drupalcs / coder. Please don't copy/paste all of the results unless they are short. If there are a lot, then post a link to the automated review and mention that problems should be addressed.]

Note that perfect adherence to Drupal Coding Standard is NOT a reason to block an application, except for total disregard of them. However, modules should follow them as closely as possible.

swagger.js: line 6, col 10, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 12, col 13, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 13, col 28, Error - "SwaggerUi" is not defined. (no-undef)
swagger.js: line 17, col 27, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 17, col 50, Error - Missing space before opening brace. (space-before-blocks)
swagger.js: line 18, col 36, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 18, col 44, Error - "hljs" is not defined. (no-undef)
swagger.js: line 18, col 66, Error - Missing semicolon. (semi)
swagger.js: line 20, col 26, Error - Missing space before function parentheses. (space-before-function-paren)

Not a blocker but nice to have it all linted and clean to meet coding standards.

It helps reviews to have a link to PAreview (below) in the issue header btw.

http://pareview.sh/pareview/httpgitdrupalorgsandboxmmillford2402571git

Fixed the git clone URL in the issue summary for non-maintainer users.

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

Automated Review

Review of the 7.x-1.x branch (commit 77ca3eb):

• ESLint has found some issues with your code (please check the JavaScript coding standards).

swagger.js: line 6, col 10, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 12, col 13, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 13, col 28, Error - "SwaggerUi" is not defined. (no-undef)
swagger.js: line 17, col 27, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 17, col 50, Error - Missing space before opening brace. (space-before-blocks)
swagger.js: line 18, col 36, Error - Missing space before function parentheses. (space-before-function-paren)
swagger.js: line 18, col 44, Error - "hljs" is not defined. (no-undef)
swagger.js: line 18, col 66, Error - Missing semicolon. (semi)
swagger.js: line 20, col 26, Error - Missing space before function parentheses. (space-before-function-paren)

9 problems

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.

Source: http://pareview.sh/ - PAReview.sh online service

Note that perfect adherence to Drupal Coding Standard is NOT a reason to block an application, except for total disregard of them. However, modules should follow them as closely as possible.

Manual Review

No duplication

Yes: Does not cause module duplication and/or fragmentation. However, this possibly duplicates an older Drupal module found on GitHub (not on Drupal.org): https://github.com/tpanagos/Drupal_SwaggerUI/ so you might consider reviewing that code to see if there is any useful functionality there that your module does not cover and include it.

Master Branch

Yes: Follows the guidelines for master branch.

Licensing

Yes: Follows the licensing requirements.

3rd party assets/code

Yes: Follows the guidelines for 3rd party assets/code.

README.txt/README.md

Yes: Follows the guidelines for in-project documentation and/or the README Template.

Code long/complex enough for review

Yes: Follows the guidelines for project length and complexity.

Secure code

Yes: Meets the security requirements.

Coding style & Drupal API usage

1. In your page callback you're calling drupal_add_js() twice. Two observations: 1) these can be chained together into a single function call passing an array 2) the callback appears to return what looks like a render array. Would it still work if you used '#attached' => 'js' => array() here?
2. Instead of pointing people towards the README.txt file when enabling the module, consider implementing hook_help and providing a link to the help page.
3. Consider using dashes in the swagger_page.tpl.php file names instead of underscores. I couldnt find a documentation page about this so can't mark this as a blocker, but the vast majority of modules and all of core templates use dashes, so this is highly recommended.

The starred items (*) are fairly big issues and warrant going back to Needs Work. Items marked with a plus sign (+) are important and should be addressed before a stable project release. The rest of the comments in the code walkthrough are recommendations.

Overall the code is very well written, I think clean up the remaining issues with the JS linter, consider my recommendations above and you're good to go.

This review uses the Project Application Review Template.

@jwilson3: thanks for your review! Looks like you didn't find any blocking issues, anything else or can this be RTBC instead?

Automated Review

Review result of 7.x-1.x branch: http://pareview.sh/pareview/httpgitdrupalorgsandboxmmillford2402571git
There are some little things to fix.

Manual Review

Individual user account

Yes, it follows.

No duplication

Yes, it's not duplicated

Master Branch

Yes, default branch 7.x-1.x is set

Licensing

Yes, it follows

3rd party assets/code

Yes, there is not third party code associated.

README.txt/README.md

Yes, README file exists and with properly standards.

Code long/complex enough for review

Yes, code is enough complex.

Secure code

Yes, it follows.

Coding style & Drupal API usage

In swagger.module, line 294, you can use drupal_strlen instead of strlen.

I used the module and main features worked for me. I could access to swagger io json of my resources and test a endpoint using swagger ui library inside the drupal.

Thanks for your contribution, Mark!

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.