Bug 878430

Summary: Review Request: rubygem-apipie-rails - Rails REST API documentation tool
Product: [Fedora] Fedora Reporter: Bohuslav "Slavek" Kabrda <bkabrda>
Component: Package ReviewAssignee: Vít Ondruch <vondruch>
Status: CLOSED RAWHIDE QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: medium Docs Contact:
Priority: medium    
Version: rawhideCC: msuchy, notting, package-review, vondruch
Target Milestone: ---Flags: vondruch: fedora-review+
gwync: fedora-cvs+
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-11-21 14:43:58 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Bohuslav "Slavek" Kabrda 2012-11-20 12:13:58 UTC
Spec URL: http://bkabrda.fedorapeople.org/pkgs/apipie-rails/rubygem-apipie-rails.spec
SRPM URL: http://bkabrda.fedorapeople.org/pkgs/apipie-rails/rubygem-apipie-rails-0.0.13-1.fc18.src.rpm
Koji: http://koji.fedoraproject.org/koji/taskinfo?taskID=4708550
Description: Maintain your API documentation up to date!
Fedora Account System Username: bkabrda

Comment 1 Vít Ondruch 2012-11-20 12:16:49 UTC
I'll take this one for a review.

Comment 2 Vít Ondruch 2012-11-20 13:16:31 UTC
* Do not initiate the git repository
  - I guess that the "git init" could be avoided, if the Gemfile is removed
    for the test.

* Why are you dropping entire spec directory?
  - Since it is not required for runtime, we keep in in -doc subpackage typically

* File permissions
  - You are fixing few file permissions in %install section. Since this is very
    likely an upstream error, have you reported it upstream (I see no relevant
    notice anywhere)?

* Missing runtime dependencies
  - Seems that you are entirely missing runtime dependencies.

    irb(main):001:0> require 'apipie-rails'
    NameError: uninitialized constant ActionDispatch

* License
  - jquery-1.7.2.js is dual licensed under the MIT or GPL Version 2 licenses.

Comment 3 Bohuslav "Slavek" Kabrda 2012-11-20 15:11:39 UTC
(In reply to comment #2)
> * Do not initiate the git repository
>   - I guess that the "git init" could be avoided, if the Gemfile is removed
>     for the test.
> 

Fixed

> * Why are you dropping entire spec directory?
>   - Since it is not required for runtime, we keep in in -doc subpackage
> typically
> 

Done

> * File permissions
>   - You are fixing few file permissions in %install section. Since this is
> very
>     likely an upstream error, have you reported it upstream (I see no
> relevant
>     notice anywhere)?
> 

I discussed with upstream and changed the permissions stuff a little. See https://github.com/Pajk/apipie-rails/issues/70

> * Missing runtime dependencies
>   - Seems that you are entirely missing runtime dependencies.
> 
>     irb(main):001:0> require 'apipie-rails'
>     NameError: uninitialized constant ActionDispatch
> 

Actually, this gem is only meant to work with initialized rails app. I added Requires: rubygem(rails) and tested with the config mentioned in README.rdoc file (but I removed the "config.markup..." line, as it would require more deps, which are optional). So with a minimal rails app, the gem works, otherwise it doesn't really make sense.

> * License
>   - jquery-1.7.2.js is dual licensed under the MIT or GPL Version 2 licenses.

Indeed. Fixed.

Note, that rpmlint is still complaining about errors with two zero-length files, but I consider them to be false positives.



SPEC: http://bkabrda.fedorapeople.org/pkgs/apipie-rails/rubygem-apipie-rails.spec
SRPM: http://bkabrda.fedorapeople.org/pkgs/apipie-rails/rubygem-apipie-rails-0.0.13-2.fc18.src.rpm

Comment 4 Vít Ondruch 2012-11-21 11:27:40 UTC
Thank you. I hold of any other comments and APPROVE the package.

Comment 5 Bohuslav "Slavek" Kabrda 2012-11-21 13:54:20 UTC
Thanks for your review!

New Package SCM Request
=======================
Package Name: rubygem-apipie-rails
Short Description: Rails REST API documentation tool
Owners: bkabrda
Branches: f18 f17
InitialCC:

Comment 6 Gwyn Ciesla 2012-11-21 14:07:38 UTC
Git done (by process-git-requests).