grape_documenter 0.1.0 → 0.2.0

data/README.md

@@ -20,7 +20,7 @@ Or install it yourself as:
 
 Within the root of you Rails Application run the following rake task...
 
-   $ bundle exec grape_documenter 'MyApplication::API' '/path/to/where/you/want/your/docs'
+   $ bundle exec grape_docuementer 'MyApp::Api' '/path/to/docs' --format='html' --mounted-path='/api
 
 The first argument is the a string of the class of Grape::API. If you have multiple APIs within the same application you can run the task as many times as you like with different output paths.
 
@@ -28,8 +28,6 @@ The first argument is the a string of the class of Grape::API. If you have multi
 
 Currently 2 formats are supported: 'html'; 'textile'. The default is html. You can change the format as shown below...
 
-   $ bundle exec grape_doc 'MyApplication::API' '/path/to/where/you/want/your/docs' 'textile'
-
 ## Contributing
 
 1. Fork it

data/bin/grape_documenter

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'grape_documenter'
+require 'optparse'
 
 begin
   require File.expand_path(Dir.pwd + "/config/environment")
@@ -8,5 +9,19 @@ rescue LoadError => ex
   puts "#{ex}"
 end
 
-generator = GrapeDocumenter::Generator.new(ARGV[0], ARGV[1], :format => ARGV[2])
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: bundle exec grape_docuementer 'MyApp::Api' '/path/to/docs' --format='html' --mounted-path='/api'"
+
+  opts.on('--format [OPT]', "Output format. Defaults to html" ) do |f|
+    options[:format] = f
+  end
+
+  opts.on('--mounted-path [OPT]', "Path to where API is mounted. Defaults to /" ) do |path|
+    options[:mounted_path] = path
+  end
+end.parse!
+
+generator = GrapeDocumenter::Generator.new(ARGV[0], ARGV[1], options)
 generator.output

data/lib/grape_documenter/generator.rb

@@ -3,6 +3,8 @@ require 'active_support/inflector'
 
 module GrapeDocumenter
   class Generator
+    attr_reader :mounted_path
+
     def initialize(api_class, output_path, options = {})
       raise 'api_class must be specified' if api_class.nil?
       raise 'output_path must be specified' if output_path.nil?
@@ -10,6 +12,7 @@ module GrapeDocumenter
       @output_path = output_path
       @api_class = api_class.constantize
       @format = options[:format] || 'html'
+      @mounted_path = options[:mounted_path] || ''
     end
 
     def generate_namespace_docs
@@ -79,7 +82,7 @@ module GrapeDocumenter
     end
 
     def routes_for_version_and_namespace(version, namespace)
-      routes_for_version(version).select { |r| normalize_route_namespace(r) == namespace }.map{|r| RouteDoc.new(r)}
+      routes_for_version(version).select { |r| normalize_route_namespace(r) == namespace }.map{|r| RouteDoc.new(r, :mounted_path => @mounted_path)}
     end
 
     def titleize(string)

data/lib/grape_documenter/route_doc.rb

@@ -1,7 +1,8 @@
 module GrapeDocumenter
   class RouteDoc
-    def initialize(route)
+    def initialize(route, options = {})
       @route = route
+      @mounted_path = options[:mounted_path] || ''
     end
 
     def http_method
@@ -9,7 +10,7 @@ module GrapeDocumenter
     end
 
     def path
-      @route.route_path
+      @mounted_path + @route.route_path.gsub('(.:format)', '')
     end
 
     def description

data/lib/grape_documenter/version.rb

@@ -1,3 +1,3 @@
 module GrapeDocumenter
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/generator_spec.rb

@@ -21,11 +21,23 @@ describe GrapeDocumenter::Generator do
         let(:routes) { subject.generate_namespace_docs.first.routes }
 
         describe 'index' do
+          describe 'method' do
+            it 'returns get' do
+              routes.first.http_method.should == 'GET'
+            end
+          end
+
           describe 'description' do
             it 'returns Get all users' do
               routes.first.description.should == 'Get all users'
             end
           end
+
+          describe 'path' do
+            it 'returns /users' do
+              routes.first.path.should == '/:version/user'
+            end
+          end
         end
 
         describe 'show' do
@@ -50,4 +62,14 @@ describe GrapeDocumenter::Generator do
       end
     end
   end
+
+  describe 'options' do
+    describe 'prefix' do
+      subject { described_class.new 'MyApplication::API', '/tmp/grape_documenter', :mounted_path => '/mounted_path' }
+
+      it 'sets the prefix' do
+        subject.mounted_path.should == '/mounted_path'
+      end
+    end
+  end
 end

data/spec/route_doc_spec.rb

@@ -33,4 +33,12 @@ describe GrapeDocumenter::RouteDoc do
       subject.optional_params.should == {'foo' => {:type => 'string', :desc => 'fooness'}}
     end
   end
+
+  context 'with mounted_path' do
+    subject { described_class.new(mock_route, :mounted_path => '/foo')  }
+
+    it 'returns the path with mounted path' do
+      subject.path.should == '/foo/users'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape_documenter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-17 00:00:00.000000000 Z
+date: 2012-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: This adds a task to Rails Applications to generate documentation for Grape
@@ -173,3 +173,4 @@ test_files:
 - spec/route_doc_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_api.rb
+has_rdoc: