apipie-rails 0.0.13 → 0.0.14

data/lib/apipie/markup.rb

@@ -19,12 +19,11 @@ module Apipie
     class Markdown
 
       def initialize
-        require 'redcarpet'
-        @redcarpet ||= ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML.new)
+        require 'maruku'
       end
 
       def to_html(text)
-        @redcarpet.render(text)
+        Maruku.new(text).to_html
       end
 
     end
@@ -42,4 +41,4 @@ module Apipie
     end
 
   end
-end
+end

data/lib/apipie/method_description.rb

@@ -5,39 +5,31 @@ module Apipie
 
     class Api
 
-      attr_accessor :short_description, :api_url, :http_method
+      attr_accessor :short_description, :path, :http_method
 
       def initialize(method, path, desc)
         @http_method = method.to_s
-        @api_url = create_api_url(path)
+        @path = path
         @short_description = desc
       end
 
-      private
-
-      def create_api_url(path)
-        path = "#{Apipie.configuration.api_base_url}#{path}"
-        path = path[0..-2] if path[-1..-1] == '/'
-        return path
-      end
-
     end
 
     attr_reader :full_description, :method, :resource, :apis, :examples, :see, :formats
 
     def initialize(method, resource, app)
-      @method = method
+      @method = method.to_s
       @resource = resource
 
-      @apis = app.get_api_args
-      @see = app.get_see
-      @formats = app.get_formats
+      @apis = app.last_dsl_data[:api_args]
+      @see = app.last_dsl_data[:see]
+      @formats = app.last_dsl_data[:formats]
 
-      desc = app.get_description || ''
+      desc = app.last_dsl_data[:description] || ''
       @full_description = Apipie.markup_to_html(desc)
-      @errors = app.get_errors
-      @params_ordered = app.get_params
-      @examples = app.get_examples
+      @errors = app.last_dsl_data[:errors]
+      @params_ordered = app.last_dsl_data[:params]
+      @examples = app.last_dsl_data[:examples]
 
       @examples += load_recorded_examples
 
@@ -45,7 +37,6 @@ module Apipie
       if parent != ActionController::Base
         @parent_resource = parent.controller_name
       end
-      @resource.add_method(id)
     end
 
     def id
@@ -53,7 +44,7 @@ module Apipie
     end
 
     def params
-      params_ordered.reduce({}) { |h,p| h[p.name] = p; h }
+      params_ordered.reduce(ActiveSupport::OrderedHash.new) { |h,p| h[p.name] = p; h }
     end
 
     def params_ordered
@@ -86,14 +77,28 @@ module Apipie
       return @merged_errors
     end
 
+    def version
+      resource._version
+    end
+
     def doc_url
-      Apipie.full_url("#{@resource._id}/#{@method}")
+      crumbs = []
+      crumbs << @resource._version if Apipie.configuration.version_in_url
+      crumbs << @resource._id
+      crumbs << @method
+      Apipie.full_url crumbs.join('/')
+    end
+
+    def create_api_url(api)
+      path = "#{Apipie.api_base_url(@resource._version)}#{api.path}"
+      path = path[0..-2] if path[-1..-1] == '/'
+      return path
     end
 
     def method_apis_to_json
       @apis.each.collect do |api|
         {
-          :api_url => api.api_url,
+          :api_url => create_api_url(api),
           :http_method => api.http_method.to_s,
           :short_description => api.short_description
         }
@@ -144,6 +149,7 @@ module Apipie
     def load_recorded_examples
       (Apipie.recorded_examples[id] || []).
         find_all { |ex| ex["show_in_doc"].to_i > 0 }.
+        find_all { |ex| ex["versions"].nil? || ex["versions"].include?(self.version) }.
         sort_by { |ex| ex["show_in_doc"] }.
         map { |ex| format_example(ex.symbolize_keys) }
     end

data/lib/apipie/resource_description.rb

@@ -12,72 +12,73 @@ module Apipie
   class ResourceDescription
 
     attr_reader :controller, :_short_description, :_full_description, :_methods, :_id,
-      :_path, :_version, :_name, :_params_ordered, :_errors_ordered, :_formats
+      :_path, :_name, :_params_ordered, :_errors_ordered, :_formats, :_parent
 
-    def initialize(controller, resource_name, &block)
-      @_methods = []
+    def initialize(controller, resource_name, dsl_data = nil, version = nil, &block)
+
+      @_methods = ActiveSupport::OrderedHash.new
       @_params_ordered = []
       @_errors_ordered = []
 
       @controller = controller
       @_id = resource_name
-      @_version = "1"
+      @_version = version || Apipie.configuration.default_version
       @_name = @_id.humanize
-      @_full_description = ""
-      @_short_description = ""
-      @_path = ""
-      @_formats = []
+      @_parent = Apipie.get_resource_description(controller.superclass, version)
 
-      block.arity < 1 ? instance_eval(&block) : block.call(self) if block_given?
+      update_from_dsl_data(dsl_data) if dsl_data
     end
 
-    def param(param_name, validator, desc_or_options = nil, options = {}, &block)
-      param_description = Apipie::ParamDescription.new(param_name, validator, desc_or_options, options, &block)
-      @_params_ordered << param_description
+    def update_from_dsl_data(dsl_data)
+      @_name = dsl_data[:resource_name] if dsl_data[:resource_name]
+      @_full_description = Apipie.markup_to_html(dsl_data[:description])
+      @_short_description = dsl_data[:short_description]
+      @_path = dsl_data[:path] || ""
+      @_formats = dsl_data[:formats]
+      @_errors_ordered = dsl_data[:errors]
+      @_params_ordered = dsl_data[:params]
+      if dsl_data[:app_info]
+        Apipie.configuration.app_info[_version] = dsl_data[:app_info]
+      end
+      if dsl_data[:api_base_url]
+        Apipie.configuration.api_base_url[_version] = dsl_data[:api_base_url]
+      end
     end
 
-    def error(*args)
-      error_description = Apipie::ErrorDescription.new(args)
-      @_errors_ordered << error_description
+    def _version
+      @_version || @_parent.try(:_version) || Apipie.configuration.default_version
     end
 
+    def add_method_description(method_description)
+      Apipie.debug "@resource_descriptions[#{self._version}][#{self._name}]._methods[#{method_description.method}] = #{method_description}"
+      @_methods[method_description.method.to_sym] = method_description
+    end
 
-    def path(path); @_path = path; end
-
-    def version(version); @_version = version; end
-
-    def formats(formats); @_formats = formats; end
-
-    def name(name); @_name = name; end
-
-    def short(short); @_short_description = short; end
-    alias :short_description :short
-
-    def desc(description)
-      description ||= ''
-      @_full_description = Apipie.markup_to_html(description)
+    def method_description(method_name)
+      @_methods[method_name.to_sym]
     end
-    alias :description :desc
-    alias :full_description :desc
 
-    # add description of resource method
-    def add_method(mapi_key)
-      @_methods << mapi_key
-      @_methods.uniq!
+    def remove_method_description(method_name)
+      if @_methods.has_key?(method_name)
+        @_methods.delete(method_name)
+      end
     end
 
     def doc_url
-      Apipie.full_url(@_id)
+      crumbs = []
+      crumbs << _version if Apipie.configuration.version_in_url
+      crumbs << @_id
+      Apipie.full_url crumbs.join('/')
     end
 
-    def api_url; "#{Apipie.configuration.api_base_url}#{@_path}"; end
+    def api_url; "#{Apipie.api_base_url(_version)}#{@_path}"; end
 
     def to_json(method_name = nil)
 
-      _methods = if method_name.blank?
-        @_methods.collect { |key| Apipie.method_descriptions[key].to_json }
+      methods = if method_name.blank?
+        @_methods.collect { |key, method_description| method_description.to_json}
       else
-        [Apipie.method_descriptions[[@_id, method_name].join('#')].to_json]
+        [@_methods[method_name.to_sym].to_json]
       end
 
       {
@@ -86,10 +87,11 @@ module Apipie
         :name => @_name,
         :short_description => @_short_description,
         :full_description => @_full_description,
-        :version => @_version,
+        :version => _version,
         :formats => @_formats,
-        :methods => _methods
+        :methods => methods
       }
     end
+
   end
 end

data/lib/apipie/routing.rb

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

data/lib/apipie/static_dispatcher.rb

@@ -46,7 +46,6 @@ module Apipie
       case env['REQUEST_METHOD']
       when 'GET', 'HEAD'
         path = env['PATH_INFO'].sub("#{@baseurl}/","/apipie/").chomp('/')
-        path.sub!("#{ENV["RAILS_RELATIVE_URL_ROOT"]}",'')
 
         if match = @file_handler.match?(path)
           env["PATH_INFO"] = match

data/lib/apipie/version.rb

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

data/lib/generators/apipie/install/README

@@ -0,0 +1,6 @@
+Description:
+    Sets up Apipie-rails in your project.
+Examples:
+    `rails generate apipie:install`
+
+    `rails generate apipie:install --help`

data/lib/generators/apipie/install/install_generator.rb

@@ -0,0 +1,25 @@
+module Apipie
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    class_option(:route,
+                 :aliases => "-r",
+                 :type => :string,
+                 :desc => "What path should be the doc available on",
+                 :default => "/apipie")
+
+    class_option(:api_path,
+                 :alias => "-a",
+                 :type => :string,
+                 :desc => "What path are API requests on",
+                 :default => "/api")
+
+    def create_initializer
+      template 'initializer.rb.erb', 'config/initializers/apipie.rb'
+    end
+
+    def add_route
+      route("apipie")
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+Apipie.configure do |config|
+  config.app_name                = "<%= Rails.application.class.name[/^\w+/] %>"
+  config.api_base_url            = "<%= options.api_path %>"
+  config.doc_base_url            = "<%= options.route %>"
+  # were is your API defined?
+  config.api_controllers_matcher = "#{Rails.root}/app/controllers/*.rb"
+end

data/lib/tasks/apipie.rake

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 require 'fileutils'
-require 'apipie/client/generator'
 
 namespace :apipie do
 
@@ -17,22 +16,22 @@ namespace :apipie do
   #    | - resource2.html
   #
   # By default OUT="#{Rails.root}/doc/apidoc"
-  task :static => :environment do
+  task :static, [:version] => :environment do |t, args|
     with_loaded_documentation do
+      args.with_defaults(:version => Apipie.configuration.default_version)
       out = ENV["OUT"] || File.join(::Rails.root, 'doc', 'apidoc')
       subdir = File.basename(out)
-
       copy_jscss(out)
-
+      Apipie.configuration.version_in_url = false
       Apipie.url_prefix = "./#{subdir}"
-      doc = Apipie.to_json
+      doc = Apipie.to_json(args[:version])
       generate_one_page(out, doc)
       generate_plain_page(out, doc)
       generate_index_page(out, doc)
       Apipie.url_prefix = "../#{subdir}"
-      generate_resource_pages(out, doc)
+      generate_resource_pages(args[:version], out, doc)
       Apipie.url_prefix = "../../#{subdir}"
-      generate_method_pages(out, doc)
+      generate_method_pages(args[:version], out, doc)
     end
   end
 
@@ -44,12 +43,18 @@ namespace :apipie do
 
       file_base = File.join(cache_dir, Apipie.configuration.doc_base_url)
       Apipie.url_prefix = "./#{subdir}"
-      doc = Apipie.to_json
+      doc = Apipie.to_json(Apipie.configuration.default_version)
       generate_index_page(file_base, doc, true)
-      Apipie.url_prefix = "../#{subdir}"
-      generate_resource_pages(file_base, doc, true)
-      Apipie.url_prefix = "../../#{subdir}"
-      generate_method_pages(file_base, doc, true)
+      Apipie.available_versions.each do |version|
+        file_base_version = File.join(file_base, version)
+        Apipie.url_prefix = "../#{subdir}"
+        doc = Apipie.to_json(version)
+        generate_index_page(file_base_version, doc, true, true)
+        Apipie.url_prefix = "../../#{subdir}"
+        generate_resource_pages(version, file_base_version, doc, true)
+        Apipie.url_prefix = "../../../#{subdir}"
+        generate_method_pages(version, file_base_version, doc, true)
+      end
     end
   end
 
@@ -81,33 +86,33 @@ namespace :apipie do
     render_page("#{file_base}-plain.html", "plain", {:doc => doc[:docs]}, nil)
   end
 
-  def generate_index_page(file_base, doc, include_json = false)
+  def generate_index_page(file_base, doc, include_json = false, show_versions = false)
     FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
-
-    render_page("#{file_base}.html", "index", {:doc => doc[:docs]})
+    versions = show_versions && Apipie.available_versions
+    render_page("#{file_base}.html", "index", {:doc => doc[:docs], :versions => versions})
 
     File.open("#{file_base}.json", "w") { |f| f << doc.to_json } if include_json
   end
 
-  def generate_resource_pages(file_base, doc, include_json = false)
+  def generate_resource_pages(version, file_base, doc, include_json = false)
     doc[:docs][:resources].each do |resource_name, _|
       resource_file_base = File.join(file_base, resource_name.to_s)
       FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exists?(File.dirname(resource_file_base))
 
-      doc = Apipie.to_json(resource_name)
+      doc = Apipie.to_json(version, resource_name)
       render_page("#{resource_file_base}.html", "resource", {:doc => doc[:docs],
                                                           :resource => doc[:docs][:resources].first})
       File.open("#{resource_file_base}.json", "w") { |f| f << doc.to_json } if include_json
     end
   end
 
-  def generate_method_pages(file_base, doc, include_json = false)
+  def generate_method_pages(version, file_base, doc, include_json = false)
     doc[:docs][:resources].each do |resource_name, resource_params|
       resource_params[:methods].each do |method|
         method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s)
         FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exists?(File.dirname(method_file_base))
 
-        doc = Apipie.to_json(resource_name, method[:name])
+        doc = Apipie.to_json(version, resource_name, method[:name])
         render_page("#{method_file_base}.html", "method", {:doc => doc[:docs],
                                                            :resource => doc[:docs][:resources].first,
                                                            :method => doc[:docs][:resources].first[:methods].first})
@@ -129,28 +134,15 @@ namespace :apipie do
     FileUtils.cp_r "#{src}/.", dest
   end
 
-  namespace :client do
-    task :all, [:suffix] => [:environment] do |t, args|
-      args.with_defaults(:suffix => "_client")
-      Apipie.configuration.use_cache = false # we don't want to skip DSL evaluation
-      Apipie.api_controllers_paths.each { |file| require file }
-
-      Apipie::Client::Generator.start(Apipie.configuration.app_name, :all, args[:suffix])
-    end
-
-    desc "Generate only ruby bindings for API documented with apipie gem."
-    task :bindings, [:suffix] => [:environment] do |t, args|
-      args.with_defaults(:suffix => "_client")
-      Apipie.configuration.use_cache = false # we don't want to skip DSL evaluation
-      Apipie.api_controllers_paths.each { |file| require file }
-
-      Apipie::Client::Generator.start(Apipie.configuration.app_name, :bindings, args[:suffix])
-    end
+  desc "Generate CLI client for API documented with apipie gem. (deprecated)"
+  task :client do
+    puts <<MESSAGE
+The apipie gem itself doesn't provide client code generator. See
+https://github.com/Pajk/apipie-rails/wiki/CLI-client for more information on
+how to write your own generator.
+MESSAGE
   end
 
-  desc "Generate CLI client for API documented with apipie gem."
-  task :client, [:suffix] => 'client:all'
-
   def plaintext(text)
     text.gsub(/<.*?>/, '').gsub("\n",' ').strip
   end