api_doc 0.0.7 → 0.0.9

data/Gemfile.lock

@@ -1,19 +1,19 @@
 PATH
   remote: .
   specs:
-    api_doc (0.0.7)
+    api_doc (0.0.9)
       jquery-rails
       rails (>= 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.7)
-      actionpack (= 3.2.7)
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
       mail (~> 2.4.4)
-    actionpack (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -21,18 +21,18 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.1.3)
-    activemodel (3.2.7)
-      activesupport (= 3.2.7)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activerecord (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.7)
-      activemodel (= 3.2.7)
-      activesupport (= 3.2.7)
-    activesupport (3.2.7)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
@@ -41,10 +41,10 @@ GEM
     hike (1.2.1)
     i18n (0.6.0)
     journey (1.0.4)
-    jquery-rails (2.0.2)
-      railties (>= 3.2.0, < 5.0)
+    jquery-rails (2.1.1)
+      railties (>= 3.1.0, < 5.0)
       thor (~> 0.14)
-    json (1.7.4)
+    json (1.7.5)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
@@ -59,17 +59,17 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.2.7)
-      actionmailer (= 3.2.7)
-      actionpack (= 3.2.7)
-      activerecord (= 3.2.7)
-      activeresource (= 3.2.7)
-      activesupport (= 3.2.7)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
       bundler (~> 1.0)
-      railties (= 3.2.7)
-    railties (3.2.7)
-      actionpack (= 3.2.7)
-      activesupport (= 3.2.7)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
@@ -81,7 +81,7 @@ GEM
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.15.4)
+    thor (0.16.0)
     tilt (1.3.3)
     treetop (1.4.10)
       polyglot

data/app/helpers/api_doc/application_helper.rb

@@ -25,7 +25,7 @@ module ApiDoc
           Rails.logger.info display_name
           display_name.gsub!(/\_\(/, " (")
           Rails.logger.info display_name
-          html << "<li><a href='#{api_doc_page_path(path: name)}'>#{display_name}</a></li>"
+          html << "<li><a href='#{api_doc_page_path(path: name)}'>#{display_name.gsub("_", " ")}</a></li>"
         end
       end
       raw html

data/app/views/api_doc/shared/_footer.html.erb

@@ -1,3 +1,3 @@
 <footer>
-  <p>&copy; <%= Time.now.year %></p>
+  <p>&copy; <%= Time.now.year %> - <%= t "api_doc.company_name" %></p>
 </footer>

data/app/views/layouts/api_doc/application.html.erb

@@ -24,7 +24,7 @@
             <span class="icon-bar"></span>
             <span class="icon-bar"></span>
           </a>
-          <%= link_to(ApiDoc::Config.doc_title, api_doc_home_path, class: "brand") %>
+          <%= link_to("#{t 'api_doc.company_name'} #{ApiDoc::Config.doc_title}", api_doc_home_path, class: "brand") %>
           <%= render partial: "api_doc/shared/nav_bar" %>
         </div>
       </div>

data/lib/api_doc/document.rb

@@ -78,7 +78,14 @@ module ApiDoc
       dir_path = File.join([ApiDoc::Config.view_path, File.dirname(@options[:path]).split("/")].flatten)
       # puts "dir_path: #{dir_path.inspect}"
       FileUtils.mkdir_p(dir_path)
-      File.open(File.join(dir_path, "#{@request.method}_#{File.basename(@options[:path])}_(#{@response.status}).html.erb"), 'w') do |f|
+      name = [@request.method, File.basename(@options[:path]), @options[:name].try(:gsub, " ", "_"), "(#{@response.status})"]
+      name.compact!
+      name = name.join("_")
+      # File.open(File.join(dir_path, "#{name.join("_").gsub(" ", "_")}.html.erb"), 'w') do |f|
+
+      # name = "#{@request.method}_#{File.basename(@options[:path])}_(#{@response.status})"
+      # puts "name: #{name.inspect}"
+      File.open(File.join(dir_path, "#{name}.html.erb"), 'w') do |f|
         f.write html
       end
     end

data/lib/api_doc/rspec.rb

@@ -2,6 +2,8 @@ if ENV["API_DOC"]
   RSpec.configure do |c|
     c.treat_symbols_as_metadata_keys_with_true_values = true
     c.after(:each, :api_doc) do |example|
+      # puts "example.example.metadata: #{example.example.metadata.inspect}"
+      # puts "example.example.metadata[:description_args]: #{example.example.metadata[:description_args].inspect}"
       api_doc = example.example.metadata[:api_doc]
       ApiDoc.document(example, {})
     end

data/lib/api_doc/templates/page.html.erb

@@ -23,7 +23,6 @@
 <%% end %>
 
 <h2><%= @request.method %> <%= @request.path_info %></h2>
-<h3>Status: <%= @response.status %></h3>
 <% if @request.method == 'GET' && !request_params.blank? %>
 <h3>Parameters</h3>
 <pre class="prettyprint">
@@ -44,6 +43,7 @@
 <!-- response: -->
 <div class="page-header">
   <h1><%%= tr('<%= @options[:slug] %>', :response, :header) %></h1>
+  <h3>Status: <%= @response.status %></h3>
 </div>
 
 <%% unless tr('<%= @options[:slug] %>', :request, :description).blank? %>

data/lib/api_doc/version.rb

@@ -1,3 +1,3 @@
 module ApiDoc
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

data/lib/generators/api_doc/templates/en.yml

@@ -1,5 +1,6 @@
 en:
   api_doc:
+    company_name: "Your Company Name"
     page:
       request: 
         header: "Sample Request"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_doc
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1961050336475124417
+      hash: -423127122305336932
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1961050336475124417
+      hash: -423127122305336932
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24