apipie-rails 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -2,6 +2,14 @@
  Changelog
 ===========
 
+v0.1.1
+------
+
+* backward compatibility with Ruby 1.8 [#218](https://github.com/Apipie/apipie-rails/pull/218) [@mbacovsky][]
+* checksum calculation is lazy and respect use_cache config [#220](https://github.com/Apipie/apipie-rails/pull/220) [@mbacovsky][]
+* fix generating the cache in production environment [#223](https://github.com/Apipie/apipie-rails/pull/223) [@iNecas][]
+* fix loading regression with SafeYAML [#224](https://github.com/Apipie/apipie-rails/pull/224) [@iNecas][]
+
 v0.1.0
 ------
 
@@ -95,3 +103,4 @@ v0.0.15
 [@mtparet]: https://github.com/mtparet
 [@yonpols]: https://github.com/yonpols
 [@mkrajewski]: https://github.com/mkrajewski
+[@iNecas]: https://github.com/iNecas

data/README.rst

@@ -549,6 +549,10 @@ authenticate
 show_all_examples
   Set this to true to set show_in_doc=1 in all recorded examples
 
+link_extension
+  The extension to use for API pages ('.html' by default).  Link extensions
+  in static API docs cannot be changed from '.html'. 
+
 Example:
 
 .. code:: ruby
@@ -908,15 +912,13 @@ And in your apipie initializer allow checksum calculation
 
    Apipie.configuration.update_checksum = true
 
-and make sure your documentation is loaded.
-
-.. code::
-
-   Apipie.reload_documentation
 
 By default the header is added to responses for ``config.doc_base_url`` and ``/api``.
 It can be changed in configuration (see `Configuration Reference`_ for details).
 
+The checksum calculation is lazy, done with first request. If you run with ``use_cache = true``,
+do not forget to run the rake task ``apipie:cache``.
+
 
 ===================
  Tests Integration

data/apipie-rails.gemspec

@@ -17,10 +17,12 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "rails", ">= 3.0.10"
+  s.add_dependency 'json'
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"
   s.add_development_dependency "maruku"
   s.add_development_dependency "RedCloth"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rdoc"
 end

data/app/controllers/apipie/apipies_controller.rb

@@ -43,6 +43,7 @@ module Apipie
 
           @versions = Apipie.available_versions
           @doc = @doc[:docs]
+          @doc[:link_extension] = Apipie.configuration.link_extension
           if @doc[:resources].blank?
             render "getting_started" and return
           end

data/app/views/apipie/apipies/apipie_404.html.erb

@@ -10,5 +10,5 @@
 </h1>
 
 <% if @doc %>
-  Try going to <a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %> API documentation homepage</a>
+  Try going to <a href='<%= @doc[:doc_url] %><%= @doc[:link_extension] %>'><%= @doc[:name] %> API documentation homepage</a>
 <% end %>

data/app/views/apipie/apipies/index.html.erb

@@ -1,5 +1,5 @@
 <ul class='breadcrumb'>
-  <li class='active'><a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %> <%= @doc[:resources].values.first[:version] %></a></li>
+  <li class='active'><a href='<%= @doc[:doc_url] %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @doc[:resources].values.first[:version] %></a></li>
   <% if @versions && @versions.size > 1 %>
   <li class='pull-right'>
     <%= @versions.collect { |v| link_to v, Apipie.full_url(v) }.join(' / ').html_safe %>
@@ -13,7 +13,7 @@
 
 <% @doc[:resources].sort_by(&:first).each do |key, api| %>
   <h2>
-    <a href='<%= api[:doc_url] %>.html'>
+    <a href='<%= api[:doc_url] %><%= @doc[:link_extension] %>'>
       <%= api[:name] %>
     </a><br>
     <small><%= api[:short_description] %></small>
@@ -29,7 +29,7 @@
       <% api[:methods].each do |m| %>
         <% m[:apis].each do |a| %>
           <tr>
-            <td><a href='<%= m[:doc_url] %>.html'><%= a[:http_method] %> <%= a[:api_url] %></a></td>
+            <td><a href='<%= m[:doc_url] %><%= @doc[:link_extension] %>'><%= a[:http_method] %> <%= a[:api_url] %></a></td>
             <td width='60%'><%= a[:short_description] %></td>
           </tr>
         <% end %>

data/app/views/apipie/apipies/method.html.erb

@@ -1,10 +1,10 @@
 <ul class='breadcrumb'>
   <li>
-    <a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %> <%= @resource[:version] %></a>
+    <a href='<%= @doc[:doc_url] %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @resource[:version] %></a>
     <span class='divider'>/</span>
   </li>
   <li>
-    <a href='<%= @resource[:doc_url] %>.html'>
+    <a href='<%= @resource[:doc_url] %><%= @doc[:link_extension] %>'>
       <%= @resource[:name] %>
       <% if @resource[:version] %><% end %>
     </a>
@@ -24,7 +24,7 @@
 
 <div>
   <% unless @method[:see].empty? %>
-    Also see <%= @method[:see].map { |s| link_to(s[:description], "#{s[:link]}.html") }.to_sentence.html_safe %>.
+    Also see <%= @method[:see].map { |s| link_to(s[:description], "#{s[:link]}#{@doc[:link_extension]}") }.to_sentence.html_safe %>.
   <% end %>
 
   <%= render(:partial => "method_detail", :locals => {:method => @method, :h_level => 2}) %>

data/app/views/apipie/apipies/resource.html.erb

@@ -1,6 +1,6 @@
 <ul class='breadcrumb'>
   <li>
-    <a href='<%= @doc[:doc_url] %>.html'><%= @doc[:name] %> <%= @resource[:version] %></a>
+    <a href='<%= @doc[:doc_url] %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= @resource[:version] %></a>
     <span class='divider'>/</span>
   </li>
   <li class='active'>
@@ -36,7 +36,7 @@
   <% @resource[:methods].each do |m| %>
     <hr>
     <div class='pull-right small'>
-      <a href='<%= m[:doc_url] %>.html'> >>> </a>
+      <a href='<%= m[:doc_url] %><%= @doc[:link_extension] %>'> >>> </a>
     </div>
     <div>
       <% m[:apis].each do |api| %>
@@ -53,7 +53,7 @@
     </div>
 
     <% unless m[:see].empty? %>
-      Also see <%= m[:see].map { |s| link_to(s[:description], "#{s[:link]}.html") }.to_sentence.html_safe %>.
+      Also see <%= m[:see].map { |s| link_to(s[:description], "#{s[:link]}#{@doc[:link_extension]}") }.to_sentence.html_safe %>.
     <% end %>
 
     <div id='description-<%= m[:name] %>' class='collapse accordion-body'>

data/lib/apipie/application.rb

@@ -211,7 +211,7 @@ module Apipie
       if File.exists?(tape_file)
         #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
         if YAML.respond_to?(:safe_load_file) && defined?(SafeYAML)
-          @recorded_examples = SafeYAML.load_file(tape_file, :safe=>false)
+          @recorded_examples = YAML.load_file(tape_file, :safe=>false)
         else
           @recorded_examples = YAML.load_file(tape_file)
         end
@@ -259,19 +259,32 @@ module Apipie
     end
 
     def reload_documentation
-      rails_mark_classes_for_reload
-      init_env
-      reload_examples
+      if rails_mark_classes_for_reload
+        # if we are not able to mark classes for reload, we
+        # can't reinit the env, as we would loose the data that were
+        # already loaded
+        init_env
+        reload_examples
+      end
 
       api_controllers_paths.each do |f|
         load_controller_from_file f
       end
-      @checksum = compute_checksum if Apipie.configuration.update_checksum
+      @checksum = nil if Apipie.configuration.update_checksum
     end
 
     def compute_checksum
-      all_docs = Apipie.available_versions.inject({}) do |all, version|
-        all.update(version => Apipie.to_json(version))
+      if Apipie.configuration.use_cache?
+        file_base = File.join(Apipie.configuration.cache_dir, Apipie.configuration.doc_base_url)
+        all_docs = {}
+        Dir.glob(file_base + '/*.json').sort.each do |f|
+          all_docs[File.basename(f, '.json')] = JSON.parse(File.read(f))
+        end
+      else
+        reload_documentation if available_versions == []
+        all_docs = Apipie.available_versions.inject({}) do |all, version|
+          all.update(version => Apipie.to_json(version))
+        end
       end
       Digest::MD5.hexdigest(JSON.dump(all_docs))
     end
@@ -341,9 +354,15 @@ module Apipie
     # docs, therefore we just force to reload all the code. This
     # happens only when reload_controllers is set to true and only
     # when showing the documentation.
+    #
+    # If cache_classes is set to false, it does nothing,
+    # as this would break loading of the controllers.
     def rails_mark_classes_for_reload
-      ActiveSupport::DescendantsTracker.clear
-      ActiveSupport::Dependencies.clear
+      unless Rails.application.config.cache_classes
+        ActiveSupport::DescendantsTracker.clear
+        ActiveSupport::Dependencies.clear
+        return true
+      end
     end
 
   end

data/lib/apipie/configuration.rb

@@ -5,7 +5,8 @@ module Apipie
       :api_base_url, :doc_base_url, :required_by_default, :layout,
       :default_version, :debug, :version_in_url, :namespaced_resources,
       :validate, :validate_value, :validate_presence, :authenticate, :doc_path,
-      :show_all_examples, :process_params, :update_checksum, :checksum_path
+      :show_all_examples, :process_params, :update_checksum, :checksum_path,
+      :link_extension
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default
@@ -130,6 +131,7 @@ module Apipie
       @process_params = false
       @checksum_path = [@doc_base_url, '/api/']
       @update_checksum = false
+      @link_extension = ".html"
     end
   end
 end

data/lib/apipie/routing.rb

@@ -3,7 +3,7 @@ module Apipie
     module MapperExtensions
       def apipie
         namespace "apipie", :path => Apipie.configuration.doc_base_url do
-          get 'apipie_checksum', to: "apipies#apipie_checksum", :format => "json"
+          get 'apipie_checksum', :to => "apipies#apipie_checksum", :format => "json"
           constraints(:version => /[^\/]+/) do
             get("(:version)/(:resource)/(:method)" => "apipies#index", :as => :apipie)
           end

data/lib/apipie/validator.rb

@@ -365,7 +365,9 @@ module Apipie
       end
 
       def self.build(param_description, argument, options, block)
-        self.new(param_description, block, options[:param_group]) if block.is_a?(Proc) && block.arity == 0 && argument == Array
+        # in Ruby 1.8.x the arity on block without args is -1
+        # while in Ruby 1.9+ it is 0
+        self.new(param_description, block, options[:param_group]) if block.is_a?(Proc) && block.arity <= 0 && argument == Array
       end
 
       def description

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/tasks/apipie.rake

@@ -25,6 +25,7 @@ namespace :apipie do
       Apipie.configuration.version_in_url = false
       Apipie.url_prefix = "./#{subdir}"
       doc = Apipie.to_json(args[:version])
+      doc[:docs][:link_extension] = '.html'
       generate_one_page(out, doc)
       generate_plain_page(out, doc)
       generate_index_page(out, doc)

data/spec/controllers/users_controller_spec.rb

@@ -264,7 +264,8 @@ describe UsersController do
         end
         context "with bad input" do
           it "should raise an error" do
-            expect{ put :update,
+            expect{
+              put :update,
                 {
                   :id => 5,
                   :user => {
@@ -276,7 +277,7 @@ describe UsersController do
                       :comment => 'comment1'
                     },
                     {
-                      :comment => {bad_input: 5}
+                      :comment => {:bad_input => 5}
                     }
                   ]
                 }

data/spec/dummy/config/initializers/apipie.rb

@@ -64,6 +64,10 @@ Apipie.configure do |config|
   # specify disqus site shortname to show discusion on each page
   # to show it in custom layout, use `render 'disqus' if Apipie.configuration.use_disqus?`
   # config.disqus_shortname = 'paveltest'
+
+  # Hide '.html' extensions.  Note that '.html' extensions are forced
+  # when generating static documentation
+  # config.link_extension = ""
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,6 +28,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.10
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +140,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails REST API documentation tool
 email:
 - pajkycz@gmail.com