apipie-rails 0.0.7

data/lib/apipie/error_description.rb

@@ -0,0 +1,21 @@
+module Apipie
+
+  class ErrorDescription
+
+    attr_reader :code, :description
+
+    def initialize(args)
+      if args.first.is_a? Hash
+        args = args.first
+      elsif args.count == 2
+        args = {:code => args.first, :description => args.second}
+      else
+        raise ArgumentError "ApipieError: Bad use of error method."
+      end
+      @code = args[:code] || args['code']
+      @description = args[:desc] || args[:description] || args['desc'] || args['description']
+    end
+
+  end
+
+end

data/lib/apipie/extractor.rb

@@ -0,0 +1,143 @@
+require 'singleton'
+require 'fileutils'
+require 'set'
+require 'yaml'
+require 'apipie/extractor/recorder'
+require 'apipie/extractor/writer'
+require 'apipie/extractor/collector'
+
+class Apipie::Railtie
+  if ENV["APIPIE_RECORD"]
+    initializer 'apipie.extractor' do |app|
+      ActiveSupport.on_load :action_controller do
+        before_filter do |controller|
+          Apipie::Extractor.call_recorder.analyse_controller(controller)
+        end
+      end
+      app.middleware.use ::Apipie::Extractor::Recorder::Middleware
+      ActionController::TestCase::Behavior.instance_eval do
+        include Apipie::Extractor::Recorder::FunctionalTestRecording
+      end
+    end
+  end
+end
+
+module Apipie
+
+  module Extractor
+
+    class << self
+
+      def logger
+        Rails.logger
+      end
+
+      def call_recorder
+        Thread.current[:apipie_call_recorder] ||= Recorder.new
+      end
+
+      def call_finished
+        @collector ||= Collector.new
+        if record = call_recorder.record
+          @collector.handle_record(record)
+        end
+      ensure
+        Thread.current[:apipie_call_recorder] = nil
+      end
+
+      def write_docs
+        Writer.new(@collector).write_docs if @collector
+      end
+
+      def write_examples
+        Writer.new(@collector).write_examples if @collector
+      end
+
+      def apis_from_routes
+        return @apis_from_routes if @apis_from_routes
+
+        api_prefix = Apipie.configuration.api_base_url.sub(/\/$/,"")
+        all_routes = Rails.application.routes.routes.map do |r|
+          {
+            :verb => case r.verb
+                     when Regexp then r.verb.source[/\w+/]
+                     else r.verb.to_s
+                     end,
+            :path => case
+                     when r.path.respond_to?(:spec) then r.path.spec.to_s
+                     else r.path.to_s
+                     end,
+            :controller => r.requirements[:controller],
+            :action => r.requirements[:action]
+          }
+
+
+        end
+        api_routes = all_routes.find_all do |r|
+          r[:path].starts_with?(Apipie.configuration.api_base_url)
+        end
+
+        @apis_from_routes = Hash.new { |h, k| h[k] = [] }
+
+        api_routes.each do |route|
+          controller_path, action = route[:controller], route[:action]
+          next unless controller_path && action
+
+          controller = "#{controller_path}_controller".camelize
+
+          path = if /^#{Regexp.escape(api_prefix)}(.*)$/ =~ route[:path]
+                   $1.sub!(/\(\.:format\)$/,"")
+                 else
+                   nil
+                 end
+
+          if route[:verb].present?
+            @apis_from_routes[[controller, action]] << {:method => route[:verb], :path => path}
+          end
+        end
+        @apis_from_routes
+
+        apis_from_docs = Apipie.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}
+          end
+          h.update(method => apis)
+        end
+
+        @apis_from_routes.each do |(controller, action), new_apis|
+          method_key = "#{controller.constantize.controller_name}##{action}"
+          old_apis = apis_from_docs[method_key] || []
+          new_apis.each do |new_api|
+            new_api[:path].sub!(/\(\.:format\)$/,"")
+            if old_api = old_apis.find { |api| api[:path] == "#{api_prefix}#{new_api[:path]}" }
+              new_api[:desc] = old_api[:desc]
+            end
+          end
+        end
+        @apis_from_routes
+      end
+
+    end
+  end
+end
+
+if ENV["APIPIE_RECORD"]
+  Apipie.configuration.force_dsl = true
+  at_exit do
+    record_params, record_examples = false, false
+    case ENV["APIPIE_RECORD"]
+    when "params"   then record_params = true
+    when "examples" then record_examples = true
+    when "all"      then record_params = true, record_examples = true
+    end
+
+    if record_examples
+      puts "Writing examples to a file"
+      Apipie::Extractor.write_examples
+    end
+    if record_params
+      puts "Updating auto-generated documentation"
+      Apipie::Extractor.write_docs
+    end
+  end
+end

data/lib/apipie/extractor/collector.rb

@@ -0,0 +1,113 @@
+module Apipie
+  module Extractor
+    class Collector
+      attr_reader :descriptions, :records
+
+      def initialize
+        @api_controllers_paths = Apipie.api_controllers_paths
+        @ignored = Apipie.configuration.ignored_by_recorder
+        @descriptions = Hash.new do |h, k|
+          h[k] = {:params => {}, :errors => Set.new}
+        end
+        @records = Hash.new { |h,k| h[k] = [] }
+      end
+
+      def controller_full_path(controller)
+        File.join(Rails.root, "app", "controllers", "#{controller.controller_path}_controller.rb")
+      end
+
+      def ignore_call?(record)
+        return true unless record[:controller]
+        return true if @ignored.include?(record[:controller].name)
+        return true if @ignored.include?("#{record[:controller].name}##{record[:action]}")
+        return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
+      end
+
+      def handle_record(record)
+        add_to_records(record)
+        if ignore_call?(record)
+          Extractor.logger.info("REST_API: skipping #{record_to_s(record)}")
+        else
+          refine_description(record)
+        end
+      end
+
+      def add_to_records(record)
+        key = "#{record[:controller].controller_name}##{record[:action]}"
+        @records[key] << record
+      end
+
+      def refine_description(record)
+        description = @descriptions["#{record[:controller].name}##{record[:action]}"]
+        description[:controller] ||= record[:controller]
+        description[:action] ||= record[:action]
+
+        refine_errors_description(description, record)
+        refine_params_description(description[:params], record[:params])
+      end
+
+      def refine_errors_description(description, record)
+        if record[:code].to_i >= 300 && !description[:errors].any? { |e| e[:code].to_i == record[:code].to_i }
+          description[:errors] << {:code => record[:code]}
+        end
+      end
+
+      def refine_params_description(params_desc, recorded_params)
+        recorded_params.each do |key, value|
+          params_desc[key] ||= {}
+          param_desc = params_desc[key]
+
+          if value.nil?
+            param_desc[:allow_nil] = true
+          else
+            # we specify what type it might be. At the end the first type
+            # that left is taken as the more general one
+            unless param_desc[:type]
+              param_desc[:type] = [:bool, :number]
+              param_desc[:type] << Hash if value.is_a? Hash
+              param_desc[:type] << :undef
+            end
+
+            if param_desc[:type].first == :bool && (! [true, false].include?(value))
+              param_desc[:type].shift
+            end
+
+            if param_desc[:type].first == :number && (key.to_s !~ /id$/ || !Apipie::Validator::NumberValidator.validate(value))
+              param_desc[:type].shift
+            end
+          end
+
+          if value.is_a? Hash
+            param_desc[:nested] ||= {}
+            refine_params_description(param_desc[:nested], value)
+          end
+        end
+      end
+
+      def finalize_descriptions
+        @descriptions.each do |method, desc|
+          add_routes_info(desc)
+        end
+        return @descriptions
+      end
+
+      def add_routes_info(desc)
+        api_prefix = Apipie.configuration.api_base_url.sub(/\/$/,"")
+        desc[:api] = Apipie::Extractor.apis_from_routes[[desc[:controller].name, desc[:action]]]
+        if desc[:api]
+          desc[:params].each do |name, param|
+            if desc[:api].all? { |a| a[:path].include?(":#{name}") }
+              param[:required] = true
+            end
+          end
+        end
+      end
+
+      def record_to_s(record)
+        "#{record[:controller]}##{record[:action]}"
+      end
+
+    end
+  end
+end
+

data/lib/apipie/extractor/recorder.rb

@@ -0,0 +1,122 @@
+module Apipie
+  module Extractor
+    class Recorder
+      def initialize
+        @ignored_params = [:controller, :action]
+      end
+
+      def analyse_env(env)
+        @verb = env["REQUEST_METHOD"].to_sym
+        @path = env["PATH_INFO"].sub(/^\/*/,"/")
+        @query = env["QUERY_STRING"] unless env["QUERY_STRING"].blank?
+        @params = Rack::Utils.parse_nested_query(@query)
+        @params.merge!(env["action_dispatch.request.request_parameters"] || {})
+        if data = parse_data(env["rack.input"].read)
+          @request_data = data
+        end
+      end
+
+      def analyse_controller(controller)
+        @controller = controller.class
+        @action = controller.params[:action]
+      end
+
+      def analyse_response(response)
+        if response.last.respond_to?(:body) && data = parse_data(response.last.body)
+          @response_data = data
+        end
+        @code = response.first
+      end
+
+      def analyze_functional_test(test_context)
+        request, response = test_context.request, test_context.response
+        @verb = request.request_method.to_sym
+        @path = request.path
+        @params = request.request_parameters
+        if [:POST, :PUT].include?(@verb)
+          @request_data = @params
+        else
+          @query = request.query_string
+        end
+        @response_data = parse_data(response.body)
+        @code = response.code
+      end
+
+      def parse_data(data)
+        return nil if data.to_s =~ /^\s*$/
+        JSON.parse(data)
+      rescue Exception => e
+        data
+      end
+
+      def reformat_data(data)
+        parsed = parse_data(data)
+        case parsed
+        when nil
+          nil
+        when String
+          parsed
+        else
+          JSON.pretty_generate().gsub(/: \[\s*\]/,": []").gsub(/\{\s*\}/,"{}")
+        end
+      end
+
+      def record
+        if @controller
+          {:controller => @controller,
+           :action => @action,
+           :verb => @verb,
+           :path => @path,
+           :params => @params,
+           :query => @query,
+           :request_data => @request_data,
+           :response_data => @response_data,
+           :code => @code}
+        else
+          nil
+        end
+      end
+
+      protected
+
+      def api_description
+      end
+
+      class Middleware
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          analyze(env) do
+            @app.call(env)
+          end
+        end
+
+        def analyze(env, &block)
+          Apipie::Extractor.call_recorder.analyse_env(env)
+          response = block.call
+          Apipie::Extractor.call_recorder.analyse_response(response)
+          response
+        ensure
+          Apipie::Extractor.call_finished
+        end
+      end
+
+      module FunctionalTestRecording
+        def self.included(base)
+          base.alias_method_chain :process, :api_recording
+        end
+
+        def process_with_api_recording(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          process_without_api_recording(*args)
+          Apipie::Extractor.call_recorder.analyze_functional_test(self)
+        ensure
+          Apipie::Extractor.call_finished
+        end
+      end
+
+    end
+
+  end
+end

data/lib/apipie/extractor/writer.rb

@@ -0,0 +1,356 @@
+module Apipie
+  module Extractor
+    class Writer
+
+      def initialize(collector)
+        @collector = collector
+        @examples_file = File.join(Rails.root, "doc", "apipie_examples.yml")
+      end
+
+      def write_examples
+        merged_examples = merge_old_new_examples
+        FileUtils.mkdir_p(File.dirname(@examples_file))
+        File.open(@examples_file, "w") do |f|
+          f << YAML.dump(OrderedHash[*merged_examples.sort_by(&:first).flatten(1)])
+        end
+      end
+
+      def write_docs
+        descriptions = @collector.finalize_descriptions
+        descriptions.each do |_, desc|
+          if desc[:api].empty?
+            logger.warn("REST_API: Couldn't find any path for #{desc_to_s(desc)}")
+            next
+          end
+          self.class.update_action_description(desc[:controller], desc[:action]) do |u|
+            u.update_generated_description desc
+          end
+        end
+      end
+
+      def self.update_action_description(controller, action)
+        updater = ActionDescriptionUpdater.new(controller, action)
+        yield updater
+        updater.write!
+      rescue ActionDescriptionUpdater::ControllerNotFound
+        logger.warn("REST_API: Couldn't find controller file for #{controller}")
+      rescue ActionDescriptionUpdater::ActionNotFound
+        logger.warn("REST_API: Couldn't find action #{action} in #{controller}")
+      end
+
+      protected
+
+      def desc_to_s(description)
+        "#{description[:controller].name}##{description[:action]}"
+      end
+
+      def ordered_call(call)
+        call = call.stringify_keys
+        ordered_call = OrderedHash.new
+        %w[verb path query request_data response_data code show_in_doc recorded].each do |k|
+          next unless call.has_key?(k)
+          ordered_call[k] = case call[k]
+                       when ActiveSupport::HashWithIndifferentAccess
+                         JSON.parse(call[k].to_json) # to_hash doesn't work recursively and I'm too lazy to write the recursion:)
+                       else
+                         call[k]
+                       end
+        end
+        return ordered_call
+      end
+
+      def merge_old_new_examples
+        new_examples = self.load_new_examples
+        old_examples = self.load_old_examples
+        merged_examples = []
+        (new_examples.keys + old_examples.keys).uniq.each do |key|
+          if new_examples.has_key?(key)
+            records = new_examples[key]
+          else
+            records = old_examples[key]
+          end
+          merged_examples << [key, records.map { |r|  ordered_call(r) } ]
+        end
+        return merged_examples
+      end
+
+      def load_new_examples
+        @collector.records.reduce({}) do |h, (method, calls)|
+          show_in_doc = nil
+          recorded_examples = calls.map do |call|
+            if show_in_doc.nil?
+              show_in_doc = 1 if showable_in_doc?(call.with_indifferent_access)
+            else
+              show_in_doc = 0
+            end
+            example = call.merge(:show_in_doc => show_in_doc.to_i, :recorded => true)
+            example
+          end
+          h.update(method => recorded_examples)
+        end
+      end
+
+      def load_old_examples
+        if File.exists?(@examples_file)
+          return YAML.load(File.read(@examples_file))
+        end
+        return {}
+      end
+
+      def logger
+        self.class.logger
+      end
+
+      def self.logger
+        Extractor.logger
+      end
+
+      def showable_in_doc?(call)
+        # we don't want to mess documentation with too large examples
+        if hash_nodes_count(call["request_data"]) + hash_nodes_count(call["response_data"]) > 100
+          return false
+        else
+          return 1
+        end
+      end
+
+      def hash_nodes_count(node)
+        case node
+        when Hash
+          1 + (node.values.map { |v| hash_nodes_count(v) }.reduce(:+) || 0)
+        when Array
+          node.map { |v| hash_nodes_count(v) }.reduce(:+) || 1
+        else
+          1
+        end
+      end
+
+    end
+
+    class ActionDescriptionUpdater
+
+      class ControllerNotFound < Exception; end
+
+      class ActionNotFound < Exception; end
+
+      def initialize(controller, action)
+        @controller = controller
+        @action = action
+      end
+
+      def generated?
+        old_header.include?(Apipie.configuration.generated_doc_disclaimer)
+      end
+
+      def update_apis(apis)
+        new_header = ""
+        new_header << Apipie.configuration.generated_doc_disclaimer << "\n" if generated?
+        new_header << generate_apis_code(apis)
+        new_header << ensure_line_breaks(old_header.lines).reject do |line|
+          line.include?(Apipie.configuration.generated_doc_disclaimer) ||
+            line =~ /^api/
+        end.join
+        overwrite_header(new_header)
+      end
+
+      def update_generated_description(desc)
+        if generated? || old_header.empty?
+          new_header = generate_code(desc)
+          overwrite_header(new_header)
+        end
+      end
+
+      def update(new_header)
+        overwrite_header(new_header)
+      end
+
+      def old_header
+        return @old_header if defined? @old_header
+        @old_header = lines_above_method[/^\s*?#{Regexp.escape(Apipie.configuration.generated_doc_disclaimer)}.*/m]
+        @old_header ||= lines_above_method[/^\s*?\b(api|params|error|example)\b.*/m]
+        @old_header ||= ""
+        @old_header.sub!(/\A\s*\n/,"")
+        @old_header = align_indented(@old_header)
+      end
+
+      def write!
+        File.open(controller_path, "w") { |f| f << @controller_content }
+        @changed=false
+      end
+
+      protected
+
+      def logger
+        Extractor.logger
+      end
+
+      def action_line
+        return @action_line if defined? @action_line
+        @action_line = ensure_line_breaks(controller_content.lines).find_index { |line| line =~ /def \b#{@action}\b/ }
+        raise ActionNotFound unless @action_line
+        @action_line
+      end
+
+      def controller_path
+        @controller_path ||= File.join(Rails.root, "app", "controllers", "#{@controller.controller_path}_controller.rb")
+      end
+
+      def controller_content
+        raise ControllerNotFound.new unless File.exists? controller_path
+        @controller_content ||= File.read(controller_path)
+      end
+
+      def controller_content=(new_content)
+        return if @controller_name == new_content
+        remove_instance_variable("@action_line")
+        remove_instance_variable("@old_header")
+        @controller_content=new_content
+        @changed = true
+      end
+
+      def generate_code(desc)
+        code = "#{Apipie.configuration.generated_doc_disclaimer}\n"
+        code << generate_apis_code(desc[:api])
+        code << generate_params_code(desc[:params])
+        code << generate_errors_code(desc[:errors])
+        return code
+      end
+
+      def generate_apis_code(apis)
+        code = ""
+        apis.sort_by {|a| a[:path] }.each do |api|
+          desc = api[:desc]
+          name = @controller.controller_name.gsub("_", " ")
+          desc ||= case @action.to_s
+                   when "show", "create", "update", "destroy"
+                     name = name.singularize
+                     "#{@action.capitalize} #{name =~ /^[aeiou]/ ? "an" : "a"} #{name}"
+                   when "index"
+                     "List #{name}"
+                   end
+
+          code << "api :#{api[:method]}, \"#{api[:path]}\""
+          code << ", \"#{desc}\"" if desc
+          code << "\n"
+        end
+        return code
+      end
+
+      def generate_params_code(params, indent = "")
+        code = ""
+        params.sort_by {|n,_| n }.each do |(name, desc)|
+          desc[:type] = (desc[:type] && desc[:type].first) || Object
+          code << "#{indent}param"
+          if name =~ /\W/
+            code << " :\"#{name}\""
+          else
+            code << " :#{name}"
+          end
+          code << ", #{desc[:type].inspect}"
+          if desc[:allow_nil]
+            code << ", :allow_nil => true"
+          end
+          if desc[:required]
+            code << ", :required => true"
+          end
+          if desc[:nested]
+            code << " do\n"
+            code << generate_params_code(desc[:nested], indent + "  ")
+            code << "#{indent}end"
+          else
+          end
+          code << "\n"
+        end
+        code
+      end
+
+      def generate_errors_code(errors)
+        code = ""
+        errors.sort_by {|e| e[:code] }.each do |error|
+          code << "error :code => #{error[:code]}\n"
+        end
+        code
+      end
+
+      def align_indented(text)
+        shift_left = ensure_line_breaks(text.lines).map { |l| l[/^\s*/].size }.min
+        ensure_line_breaks(text.lines).map { |l| l[shift_left..-1] }.join
+      end
+
+      def overwrite_header(new_header)
+        overwrite_line_from = action_line
+        overwrite_line_to = action_line
+        unless old_header.empty?
+          overwrite_line_from -= ensure_line_breaks(old_header.lines).count
+        end
+        lines = ensure_line_breaks(controller_content.lines).to_a
+        indentation = lines[action_line][/^\s*/]
+        self.controller_content= (lines[0...overwrite_line_from] +
+                              [new_header.gsub(/^/,indentation)] +
+                              lines[overwrite_line_to..-1]).join
+      end
+
+      # returns all the lines before the method that might contain the restpi descriptions
+      # not bulletproof but working for conventional Ruby code
+      def lines_above_method
+        added_lines = []
+        lines_to_add = []
+        block_level = 0
+        ensure_line_breaks(controller_content.lines).first(action_line).reverse_each do |line|
+          if line =~ /\s*\bend\b\s*/
+            block_level += 1
+          end
+          if block_level > 0
+            lines_to_add << line
+          else
+            added_lines << line
+          end
+          if line =~ /\s*\b(module|class|def)\b /
+            break
+          end
+          if line =~ /do\s*(\|.*?\|)?\s*$/
+            block_level -= 1
+            if block_level == 0
+              added_lines.concat(lines_to_add)
+              lines_to_add = []
+            end
+          end
+        end
+        return added_lines.reverse.join
+      end
+
+      # this method would be totally useless unless some clever guy
+      # desided that it would be great idea to change a behavior of
+      # "".lines method to not include end of lines.
+      #
+      # For more details:
+      #   https://github.com/puppetlabs/puppet/blob/0dc44695/lib/puppet/util/monkey_patches.rb
+      def ensure_line_breaks(lines)
+        if lines.to_a.size > 1 && lines.first !~ /\n\Z/
+          lines.map { |l| l !~ /\n\Z/ ? (l << "\n") : l }.to_enum
+        else
+          lines
+        end
+      end
+    end
+
+    # Used to keep apipie_examples.yml params in order
+    class OrderedHash < ActiveSupport::OrderedHash
+
+      def to_yaml_type
+        "!tag:yaml.org,2002:map"
+      end
+
+      def to_yaml(opts = {})
+        YAML.quick_emit(self, opts) do |out|
+          out.map(taguri) do |map|
+            each do |k, v|
+              map.add(k, v)
+            end
+          end
+        end
+      end
+    end
+
+  end
+end