apipie-rails 0.0.23 → 0.0.24

data/CHANGELOG

@@ -2,6 +2,15 @@
  Changelog
 ===========
 
+v0.0.24
+-------
+
+* fix DOS vulnerability for running in production without use_cache
+* ability to load descriptions from external files
+* improved examples extractor
+* fixed deprecation warnings in Rails 4
+* using StandardError instead of Exception for errors
+
 v0.0.23
 -------
 

data/README.rst

@@ -781,11 +781,20 @@ For inspiration this is how Textile markup usage looks like:
    end
 
 
+================
+Modifying Views
+================
+
+To modify the views of your documentation, run ``rails g apipie:views``.
+This will copy the Apipie views to ``app/views/apipie/apipies`` and
+``app/views/layouts/apipie``.
+
+
 ==============
  Static files
 ==============
 
-To generate static version of documentation (perhaps to put it on
+To generate a static version of documentation (perhaps to put it on
 project site or something) run ``rake apipie:static`` task. It will
 create set of html files (multi-pages, single-page, plain) in your doc
 directory. By default the documentation for default API version is

data/app/controllers/apipie/apipies_controller.rb

@@ -28,10 +28,19 @@ module Apipie
         @doc = Apipie.to_json(params[:version], params[:resource], params[:method])
 
         format.json do
-          render :json => @doc
+          if @doc
+            render :json => @doc
+          else
+            head :not_found
+          end
         end
 
         format.html do
+          unless @doc
+            render 'apipie_404', :status => 404
+            return
+          end
+
           @versions = Apipie.available_versions
           @doc = @doc[:docs]
           if @doc[:resources].blank?

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

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

data/lib/apipie/application.rb

@@ -225,6 +225,8 @@ module Apipie
 
     def to_json(version, resource_name, method_name)
 
+      return unless resource_descriptions.has_key?(version)
+
       _resources = if resource_name.blank?
         # take just resources which have some methods because
         # we dont want to show eg ApplicationController as resource

data/lib/apipie/configuration.rb

@@ -4,7 +4,7 @@ module Apipie
     attr_accessor :app_name, :app_info, :copyright, :markup, :disqus_shortname,
       :api_base_url, :doc_base_url, :required_by_default, :layout,
       :default_version, :debug, :version_in_url, :namespaced_resources,
-      :validate, :validate_value, :validate_presence, :authenticate
+      :validate, :validate_value, :validate_presence, :authenticate, :doc_path
 
 
     alias_method :validate?, :validate
@@ -123,6 +123,7 @@ module Apipie
       @debug = false
       @version_in_url = true
       @namespaced_resources = false
+      @doc_path = "doc"
     end
   end
 end

data/lib/apipie/dsl_definition.rb

@@ -144,6 +144,18 @@ module Apipie
       alias :description :desc
       alias :full_description :desc
 
+      # describe next method with document in given path
+      # in convension, these doc located under "#{Rails.root}/doc"
+      # Example:
+      # document "hello_world.md"
+      # def hello_world
+      #   puts "hello world"
+      # end
+      def document path
+        content = File.open(File.join(Rails.root,  Apipie.configuration.doc_path, path)).read
+        desc content
+      end
+
       # Describe available request/response formats
       #
       #   formats ['json', 'jsonp', 'xml']
@@ -152,6 +164,7 @@ module Apipie
         _apipie_dsl_data[:formats] = formats
       end
 
+
       # Describe possible errors
       #
       # Example:

data/lib/apipie/extractor.rb

@@ -41,7 +41,9 @@ module Apipie
         if record = call_recorder.record
           @collector.handle_record(record)
         end
-      ensure
+      end
+
+      def clean_call_recorder
         Thread.current[:apipie_call_recorder] = nil
       end
 

data/lib/apipie/extractor/recorder.rb

@@ -46,7 +46,7 @@ module Apipie
       def parse_data(data)
         return nil if data.to_s =~ /^\s*$/
         JSON.parse(data)
-      rescue Exception => e
+      rescue StandardError => e
         data
       end
 
@@ -98,9 +98,10 @@ module Apipie
           Apipie::Extractor.call_recorder.analyse_env(env)
           response = block.call
           Apipie::Extractor.call_recorder.analyse_response(response)
+          Apipie::Extractor.call_finished
           response
         ensure
-          Apipie::Extractor.call_finished
+          Apipie::Extractor.clean_call_recorder
         end
       end
 
@@ -112,9 +113,10 @@ module Apipie
         def process_with_api_recording(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
           ret = process_without_api_recording(*args)
           Apipie::Extractor.call_recorder.analyze_functional_test(self)
+          Apipie::Extractor.call_finished
           ret
         ensure
-          Apipie::Extractor.call_finished
+          Apipie::Extractor.clean_call_recorder
         end
       end
 

data/lib/apipie/extractor/writer.rb

@@ -140,9 +140,9 @@ module Apipie
 
     class ActionDescriptionUpdater
 
-      class ControllerNotFound < Exception; end
+      class ControllerNotFound < StandardError; end
 
-      class ActionNotFound < Exception; end
+      class ActionNotFound < StandardError; end
 
       def initialize(controller, action)
         @controller = controller

data/lib/apipie/param_description.rb

@@ -61,7 +61,7 @@ module Apipie
       return true if @allow_nil && value.nil?
       unless @validator.valid?(value)
         error = @validator.error
-        error = ParamError.new(error) unless error.is_a? Exception
+        error = ParamError.new(error) unless error.is_a? StandardError
         raise error
       end
     end

data/lib/apipie/static_dispatcher.rb

@@ -27,10 +27,19 @@ module Apipie
 
     def ext
       @ext ||= begin
-        ext = ::ActionController::Base.page_cache_extension
+        ext = cache_extension
         "{,#{ext},/index#{ext}}"
       end
     end
+
+    def cache_extension
+      if ::ActionController::Base.respond_to?(:default_static_extension)
+        ::ActionController::Base.default_static_extension
+      else
+        ::ActionController::Base.page_cache_extension
+      end
+
+    end
   end
 
   class StaticDispatcher

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.23'
+  VERSION = '0.0.24'
 end

data/lib/generators/apipie/views_generator.rb

@@ -0,0 +1,11 @@
+module Apipie
+  class ViewsGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../../../../app/views", __FILE__)
+    desc 'Copy Apipie views to your application'
+
+    def copy_views
+      directory 'apipie', 'app/views/apipie'
+      directory 'layouts/apipie', 'app/views/layouts/apipie'
+    end
+  end
+end

data/lib/tasks/apipie.rake

@@ -58,8 +58,13 @@ namespace :apipie do
     end
   end
 
+  # Attempt to use the Rails application views, otherwise default to built in views
   def renderer
-    ActionView::Base.new(File.expand_path("../../../app/views/apipie/apipies", __FILE__))
+    if File.directory?("#{Rails.root}/app/views/apipie/apipies")
+      ActionView::Base.new("#{Rails.root}/app/views/apipie/apipies")
+    else
+      ActionView::Base.new(File.expand_path("../../../app/views/apipie/apipies", __FILE__))
+    end
   end
 
   def render_page(file_name, template, variables, layout = 'apipie')

data/spec/controllers/users_controller_spec.rb

@@ -393,6 +393,12 @@ GET /users/15
 404
 EOS2
     end
+
+    describe "document" do
+      it "should be able to load document from markup file" do
+        Apipie.get_method_description(UsersController, :desc_from_file).full_description.should include("description from document")
+      end
+    end
   end
 
   describe "param description" do

data/spec/dummy/app/controllers/users_controller.rb

@@ -248,4 +248,11 @@ class UsersController < ApplicationController
   def see_another
     render :text => 'This is very similar to create action'
   end
+
+
+  api :GET, '/users/desc_from_file', 'desc from file'
+  document 'users/desc_from_file.md'
+  def desc_from_file
+    render :text => 'document from file action'
+  end
 end

data/spec/dummy/doc/users/desc_from_file.md

@@ -0,0 +1 @@
+description from document

data/spec/lib/param_description_spec.rb

@@ -24,7 +24,7 @@ describe Apipie::ParamDescription do
     end
 
     it "should pick type validator" do
-      Apipie::Validator::BaseValidator.should receive(:find).and_return(:validator_instance)
+      Apipie::Validator::BaseValidator.should_receive(:find).and_return(:validator_instance)
       param = Apipie::ParamDescription.new(method_desc, :param, String)
       param.validator.should == :validator_instance
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -190,6 +190,7 @@ files:
 - lib/generators/apipie/install/README
 - lib/generators/apipie/install/install_generator.rb
 - lib/generators/apipie/install/templates/initializer.rb.erb
+- lib/generators/apipie/views_generator.rb
 - lib/tasks/apipie.rake
 - rel-eng/packages/.readme
 - rel-eng/packages/rubygem-apipie-rails
@@ -232,6 +233,7 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/.gitkeep
 - spec/dummy/doc/apipie_examples.yml
+- spec/dummy/doc/users/desc_from_file.md
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -271,7 +273,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Rails REST API documentation tool
@@ -314,6 +316,7 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/.gitkeep
 - spec/dummy/doc/apipie_examples.yml
+- spec/dummy/doc/users/desc_from_file.md
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -333,3 +336,4 @@ test_files:
 - spec/lib/resource_description_spec.rb
 - spec/lib/validator_spec.rb
 - spec/spec_helper.rb
+has_rdoc: