apipie-rails 0.3.1 → 0.3.2

data/CHANGELOG.md

@@ -2,6 +2,18 @@
  Changelog
 ===========
 
+v0.3.2
+------
+
+* PATCH support for examples recording
+  [#332](https://github.com/Apipie/apipie-rails/pull/332) [@akenger][]
+* Recursively search for API controllers by default for new projects
+  [#333](https://github.com/Apipie/apipie-rails/pull/333) [@baweaver][]
+* Handling recursive route definitions with `api!` keyword
+  [#338](https://github.com/Apipie/apipie-rails/pull/338) [@stormsilver][]
+* Support for eager-loaded controllers
+  [#329](https://github.com/Apipie/apipie-rails/pull/329) [@mtparet][]
+
 v0.3.1
 ------
 
@@ -259,3 +271,6 @@ v0.0.15
 [@bradrf]: https://github.com/bradrf
 [@dprice-fiksu]: https://github.com/dprice-fiksu
 [@burnettk]: https://github.com/burnettk
+[@akenger]: https://github.com/akenger
+[@baweaver]: https://github.com/baweaver
+[@stormsilver]: https://github.com/stormsilver

data/README.rst

@@ -616,10 +616,10 @@ Example:
      config.reload_controllers = Rails.env.development?
      config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
      config.api_routes = Rails.application.routes
-     config.app_info = "
+     config.app_info["1.0"] = "
        This is where you can inform user about your application and API
        in general.
-     ", '1.0'
+     "
      config.authenticate = Proc.new do
         authenticate_or_request_with_http_basic do |username, password|
           username == "test" && password == "supersecretpassword"
@@ -649,7 +649,7 @@ option, like this:
 
 .. code:: ruby
 
-   class MyFormatter < Apipie::RailsFormatter
+   class MyFormatter < Apipie::RoutesFormatter
      def format_path(route)
        super.gsub(/\(.*?\)/, '').gsub('//','') # hide all implicit parameters
      end
@@ -1241,6 +1241,12 @@ And then configure RSpec in this way:
 This way, when running in recording mode, only the tests that have been marked with the
 ``:show_in_doc`` metadata will be run, and hence only those will be used as examples.
 
+Caveats
+-------
+
+Make sure to enable ``config.render_views`` in your ``config/rails_helper.rb`` or
+``config/spec_helper.rb`` if you're using jbuilder, or you will get back empty results
+
 ====================
  Bindings Generator
 ====================

data/app/controllers/apipie/apipies_controller.rb

@@ -26,7 +26,8 @@ module Apipie
 
         @language = get_language
 
-        Apipie.reload_documentation if Apipie.configuration.reload_controllers?
+        Apipie.load_documentation if Apipie.configuration.reload_controllers? || (Rails.version.to_i >= 4.0 && !Rails.application.config.eager_load)
+
         I18n.locale = @language
         @doc = Apipie.to_json(params[:version], params[:resource], params[:method], @language)
 

data/lib/apipie/application.rb

@@ -53,11 +53,12 @@ module Apipie
 
     # the app might be nested when using contraints, namespaces etc.
     # this method does in depth search for the route controller
-    def route_app_controller(app, route)
+    def route_app_controller(app, route, visited_apps = [])
+      visited_apps << app
       if app.respond_to?(:controller)
         return app.controller(route.defaults)
-      elsif app.respond_to?(:app)
-        return route_app_controller(app.app, route)
+      elsif app.respond_to?(:app) && !visited_apps.include?(app.app)
+        return route_app_controller(app.app, route, visited_apps)
       end
     rescue ActionController::RoutingError
       # some errors in the routes will not stop us here: just ignoring
@@ -305,6 +306,13 @@ module Apipie
       locale = old_locale
     end
 
+    def load_documentation
+      if !@documentation_loaded || Apipie.configuration.reload_controllers?
+        Apipie.reload_documentation
+        @documentation_loaded = true
+      end
+    end
+
     def compute_checksum
       if Apipie.configuration.use_cache?
         file_base = File.join(Apipie.configuration.cache_dir, Apipie.configuration.doc_base_url)
@@ -313,7 +321,7 @@ module Apipie
           all_docs[File.basename(f, '.json')] = JSON.parse(File.read(f))
         end
       else
-        reload_documentation if available_versions == []
+        load_documentation if available_versions == []
         all_docs = Apipie.available_versions.inject({}) do |all, version|
           all.update(version => Apipie.to_json(version))
         end

data/lib/apipie/extractor/recorder.rb

@@ -38,7 +38,7 @@ module Apipie
         @verb = request.request_method.to_sym
         @path = request.path
         @params = request.request_parameters
-        if [:POST, :PUT].include?(@verb)
+        if [:POST, :PUT, :PATCH].include?(@verb)
           @request_data = @params
         else
           @query = request.query_string

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/generators/apipie/install/templates/initializer.rb.erb

@@ -3,5 +3,5 @@ Apipie.configure do |config|
   config.api_base_url            = "<%= options.api_path %>"
   config.doc_base_url            = "<%= options.route %>"
   # where is your API defined?
-  config.api_controllers_matcher = "#{Rails.root}/app/controllers/*.rb"
+  config.api_controllers_matcher = "#{Rails.root}/app/controllers/**/*.rb"
 end

data/spec/dummy/config/routes.rb

@@ -26,4 +26,5 @@ Dummy::Application.routes.draw do
     apipie
   end
   root :to => 'apipie/apipies#index'
+  match '(/)*path' => redirect('http://www.example.com'), :via => :all
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails