apipie-rails 0.0.14 → 0.0.15

data/CHANGELOG

@@ -0,0 +1,11 @@
+===========
+ Changelog
+===========
+
+v0.0.15
+-------
+
+* Fix case when there is no documentation yet: with link to how to
+  start
+* Fix handling bad requests when cache is on
+* Fix params extractor in case there is already some documentation

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    apipie-rails (0.0.13)
+    apipie-rails (0.0.14)
+      rails (>= 3.0.10)
 
 GEM
   remote: http://rubygems.org/
@@ -51,7 +52,6 @@ GEM
     mime-types (1.19)
     minitest (3.2.0)
     multi_json (1.3.6)
-    oauth (0.4.6)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -78,8 +78,6 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)
@@ -101,10 +99,10 @@ GEM
     syntax (1.0.0)
     thor (0.15.4)
     tilt (1.3.3)
-    treetop (1.4.10)
+    treetop (1.4.12)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby
@@ -114,9 +112,6 @@ DEPENDENCIES
   apipie-rails!
   maruku
   minitest
-  oauth
-  rails (>= 3.0.10)
   rake
-  rest-client
   rspec-rails
   sqlite3

data/README.rst

@@ -9,12 +9,12 @@ API. Instead of traditional use of ``#comments``, Apipie let's you
 describe the code by code. This brings advantages like:
 
 * no need to learn yet another syntax, you already know Ruby, right?
-* possibility reuse the doc for other purposes (like validation)
+* possibility reuse the doc for other purposes (such as validation)
 * easier to extend and maintain (no string parsing involved)
 * possibility to use other sources for documentation purposes (such as
   routes etc.)
 
-The documenatation is available right in your app (by default under
+The documentation is available right in your app (by default under
 ``/apipie`` path. In development mode, you can see the changes as you
 go. It's markup language agnostic and even provides an API for reusing
 the documentation data in form of JSON.
@@ -48,7 +48,7 @@ use ``http://localhost:3000/apipie.json``.
 
 For more comprehensive getting started guide, see
 `this demo <https://github.com/iNecas/apipie-demo>`_, that includes
-features like generating documenation from tests, recording examples etc.
+features such as generating documenation from tests, recording examples etc.
 
 Screenshots
 -----------
@@ -85,16 +85,16 @@ Apipie-rails is released under the `MIT License <http://opensource.org/licenses/
 Resource Description
 --------------------
 
-You can describe a resource on controller level. The description is introcudes by calling
-``resource description do ... end``.
+You can describe a resource on controller level. The description is introduced by calling
+``resource_description do ... end``.
 
-Inheritance is supported, so you can specify common params for group of controlelrs in their parent
+Inheritance is supported, so you can specify common params for group of controllers in their parent
 class.
 
 The following keywords are available (all are optional):
 
 resource_id
-  How will be the resource referenced in Apipie (paths, ``see`` command etc.), by default `controller_name.downcase` is used.
+  How will the resource be referenced in Apipie (paths, ``see`` command etc.), by default `controller_name.downcase` is used.
 
 name
   Human readable name of resource. By default ``class.name.humanize`` is used.
@@ -103,10 +103,10 @@ short (also short_description)
   Short description of the resource (it's shown on both list of resources and resource details)
 
 desc (also description and full_description)
-  Full description of the resource (shown only on resource details)
+  Full description of the resource (shown only in resource details)
 
 param
-  Common params for all method defined in controller/child controllers.
+  Common params for all methods defined in controller/child controllers.
 
 api_base_url
   What url is the resource available under.
@@ -118,11 +118,11 @@ formats
   request / response formats.
 
 error
-  Describe each possible error that can happen what calling all
-  methods define in controller. HTTP response code and description can be provided.
+  Describe every possible error that can happen what calling all
+  methods defined in controller. HTTP response code and description can be provided.
 
 app_info
-  In case of versioning, this set's app info description on per_version basis.
+  In case of versioning, this sets app info description on per_version basis.
 
 Example:
 ~~~~~~~~
@@ -312,7 +312,9 @@ markup
   processor.
 
 layout
-  Name of a layout template to use instead of Apipie's layout. You can use Apipie.include_stylesheets and Apipie.include_javascripts helpers to include Apipie's stylesheets and javascripts.
+  Name of a layout template to use instead of Apipie's layout. You can use
+  Apipie.include_stylesheets and Apipie.include_javascripts helpers to include
+  Apipie's stylesheets and javascripts.
 
 ignored
   An array of controller names (strings) (might include actions as well)
@@ -333,7 +335,7 @@ Example:
      config.markup = Apipie::Markup::Markdown.new
      config.reload_controllers = true
      config.api_controllers_matcher = File.join(Rails.root, "app", "controllers", "**","*.rb")
-     config.app_info = <<-"
+     config.app_info = "
        This is where you can inform user about your application and API
        in general.
      ", '1.0'

data/app/controllers/apipie/apipies_controller.rb

@@ -13,7 +13,8 @@ module Apipie
       respond_to do |format|
 
         if Apipie.configuration.use_cache?
-          render_from_cache and return
+          render_from_cache
+          return
         end
 
         Apipie.reload_documentation if Apipie.configuration.reload_controllers?
@@ -24,6 +25,10 @@ module Apipie
         end
 
         format.html do
+          if @doc[:resources].blank?
+            render "getting_started" and return
+          end
+
           @versions = Apipie.available_versions
           @doc = @doc[:docs]
           @resource = @doc[:resources].first if params[:resource].present?

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

@@ -0,0 +1,4 @@
+<h1 class='page-header'>No documentation found</h1>
+<p>We have not found any documentation for your API.</p>
+<p>Follow <a href="https://github.com/Pajk/apipie-rails#getting-started" target="_blank">further instructions</a> on how to describe your controllers.</p>
+

data/lib/apipie/application.rb

@@ -281,8 +281,6 @@ module Apipie
       Apipie.configuration.validate? || ! Apipie.configuration.use_cache? || Apipie.configuration.force_dsl?
     end
 
-    private
-
     def get_resource_name(klass)
       if klass.class == String
         klass
@@ -296,6 +294,8 @@ module Apipie
       end
     end
 
+    private
+
     def get_resource_version(resource_description)
       if resource_description.respond_to? :_version
         resource_description._version

data/lib/apipie/extractor.rb

@@ -98,18 +98,19 @@ module Apipie
         end
         @apis_from_routes
 
-        method_descriptions = Apipie.resource_descriptions.map(&:method_descriptions).flatten
-        apis_from_docs = method_descriptions.reduce({}) do |h, (method, desc)|
-          apis = desc.apis.map do |api|
-            { :method => api.http_method,
-              :path => api.api_url,
-              :desc => api.short_description }
+        resource_descriptions = Apipie.resource_descriptions.values.map(&:values).flatten
+        method_descriptions = resource_descriptions.map(&:method_descriptions).flatten
+        apis_from_docs = method_descriptions.reduce({}) do |h, desc|
+          apis = desc.method_apis_to_json.map do |api|
+            { :method => api[:http_method],
+              :path => api[:api_url],
+              :desc => api[:short_description] }
           end
-          h.update(method => apis)
+          h.update(desc.id => apis)
         end
 
         @apis_from_routes.each do |(controller, action), new_apis|
-          method_key = "#{controller.constantize.controller_name}##{action}"
+          method_key = "#{Apipie.get_resource_name(controller.constantize)}##{action}"
           old_apis = apis_from_docs[method_key] || []
           new_apis.each do |new_api|
             new_api[:path].sub!(/\(\.:format\)$/,"")

data/lib/apipie/resource_description.rb

@@ -64,6 +64,10 @@ module Apipie
       end
     end
 
+    def method_descriptions
+      @_methods.values
+    end
+
     def doc_url
       crumbs = []
       crumbs << _version if Apipie.configuration.version_in_url

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-02-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &6778440 !ruby/object:Gem::Requirement
+  requirement: &18498540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *6778440
+  version_requirements: *18498540
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &6777800 !ruby/object:Gem::Requirement
+  requirement: &18498120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6777800
+  version_requirements: *18498120
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &6777100 !ruby/object:Gem::Requirement
+  requirement: &18497660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6777100
+  version_requirements: *18497660
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &6776620 !ruby/object:Gem::Requirement
+  requirement: &18528000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6776620
+  version_requirements: *18528000
 - !ruby/object:Gem::Dependency
   name: maruku
-  requirement: &6802620 !ruby/object:Gem::Requirement
+  requirement: &18527580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6802620
+  version_requirements: *18527580
 - !ruby/object:Gem::Dependency
   name: RedCloth
-  requirement: &6802040 !ruby/object:Gem::Requirement
+  requirement: &18527160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6802040
+  version_requirements: *18527160
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &6801560 !ruby/object:Gem::Requirement
+  requirement: &18526740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,7 +88,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6801560
+  version_requirements: *18526740
 description: Maintain your API documentation up to date!
 email:
 - pajkycz@gmail.com
@@ -102,6 +102,7 @@ files:
 - .rvmrc
 - .travis.yml
 - APACHE-LICENSE-2.0
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -123,6 +124,7 @@ files:
 - app/views/apipie/apipies/_params.html.erb
 - app/views/apipie/apipies/_params_plain.html.erb
 - app/views/apipie/apipies/apipie_404.html.erb
+- app/views/apipie/apipies/getting_started.html.erb
 - app/views/apipie/apipies/index.html.erb
 - app/views/apipie/apipies/method.html.erb
 - app/views/apipie/apipies/plain.html.erb