apipierails3 0.0.1

data/lib/apipie/error_description.rb

@@ -0,0 +1,44 @@
+module Apipie
+
+  class ErrorDescription
+    attr_reader :code, :description, :metadata
+
+    def self.from_dsl_data(args)
+      code_or_options, desc, options = args
+      Apipie::ErrorDescription.new(code_or_options,
+                                   desc,
+                                   options)
+    end
+
+    def initialize(code_or_options, desc=nil, options={})
+      if code_or_options.is_a? Hash
+        code_or_options.symbolize_keys!
+        @code = code_or_options[:code]
+        @metadata = code_or_options[:meta]
+        @description = code_or_options[:desc] || code_or_options[:description]
+      else
+        @code = 
+          if code_or_options.is_a? Symbol
+            Rack::Utils::SYMBOL_TO_STATUS_CODE[code_or_options]
+          else
+            code_or_options
+          end
+
+        raise UnknownCode, code_or_options unless @code
+
+        @metadata = options[:meta]
+        @description = desc
+      end
+    end
+
+    def to_json
+      {
+        :code => code,
+        :description => description,
+        :metadata => metadata
+      }
+    end
+
+  end
+
+end

data/lib/apipie/errors.rb

@@ -0,0 +1,86 @@
+module Apipie
+
+  class Error < StandardError
+  end
+
+  class ParamError < Error
+  end
+
+  class UnknownCode < Error
+  end
+
+  class ReturnsMultipleDefinitionError < Error
+    def to_s
+      "a 'returns' statement cannot indicate both array_of and type"
+    end
+  end
+
+  # abstract
+  class DefinedParamError < ParamError
+    attr_accessor :param
+
+    def initialize(param)
+      @param = param
+    end
+  end
+
+  class ParamMissing < DefinedParamError
+    def to_s
+      unless @param.options[:missing_message].nil?
+        if @param.options[:missing_message].kind_of?(Proc)
+          @param.options[:missing_message].call
+        else
+          @param.options[:missing_message].to_s
+        end
+      else
+        "Missing parameter #{@param.name}"
+      end
+    end
+  end
+
+  class UnknownParam < DefinedParamError
+    def to_s
+      "Unknown parameter #{@param}"
+    end
+  end
+
+  class ParamInvalid < DefinedParamError
+    attr_accessor :value, :error
+
+    def initialize(param, value, error)
+      super param
+      @value = value
+      @error = error
+    end
+
+    def to_s
+      "Invalid parameter '#{@param}' value #{@value.inspect}: #{@error}"
+    end
+  end
+
+  class ResponseDoesNotMatchSwaggerSchema < Error
+    def initialize(controller_name, method_name, response_code, error_messages, schema, returned_object)
+      @controller_name = controller_name
+      @method_name = method_name
+      @response_code = response_code
+      @error_messages = error_messages
+      @schema = schema
+      @returned_object = returned_object
+    end
+
+    def to_s
+      "Response does not match swagger schema (#{@controller_name}##{@method_name} #{@response_code}): #{@error_messages}\nSchema: #{JSON(@schema)}\nReturned object: #{@returned_object}"
+    end
+  end
+
+  class NoDocumentedMethod < Error
+    def initialize(controller_name, method_name)
+      @method_name = method_name
+      @controller_name = controller_name
+    end
+
+    def to_s
+      "There is no documented method #{@controller_name}##{@method_name}"
+    end
+  end
+end

data/lib/apipie/extractor.rb

@@ -0,0 +1,177 @@
+require 'singleton'
+require 'fileutils'
+require 'set'
+require 'yaml'
+require 'apipie/extractor/recorder'
+require 'apipie/extractor/writer'
+require 'apipie/extractor/collector'
+
+class Apipie::Railtie
+  initializer 'apipie.extractor' do |app|
+    ActiveSupport.on_load :action_controller do
+      before_filter do |controller|
+        if Apipie.configuration.record
+          Apipie::Extractor.call_recorder.analyse_controller(controller)
+        end
+      end
+    end
+    app.middleware.use ::Apipie::Extractor::Recorder::Middleware
+  end
+end
+
+module Apipie
+
+  module Extractor
+
+    class << self
+
+      def start(record)
+        Apipie.configuration.record = record
+        Apipie.configuration.force_dsl = true
+      end
+
+      def finish
+        record_params, record_examples = false, false
+        case Apipie.configuration.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"
+          write_examples
+        end
+        if record_params
+          puts "Updating auto-generated documentation"
+          write_docs
+        end
+      end
+
+      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
+      end
+
+      def clean_call_recorder
+        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.api_base_url.sub(/\/$/,"")
+        populate_api_routes
+        update_api_descriptions
+
+        @apis_from_routes
+      end
+
+      def controller_path(name)
+        Apipie.api_controllers_paths.detect { |p| p.include?("#{name}_controller.rb") }
+      end
+
+      private
+
+      def all_api_routes
+        all_routes = Apipie.configuration.api_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
+
+        return all_routes.find_all do |r|
+          r[:path].starts_with?(Apipie.api_base_url)
+        end
+      end
+
+      def populate_api_routes
+        @apis_from_routes = Hash.new { |h, k| h[k] = [] }
+
+        all_api_routes.each do |route|
+          controller_path, action = route[:controller], route[:action]
+          next unless controller_path && action
+
+          controller_path = controller_path.split('::').map(&:camelize).join('::')
+          controller = "#{controller_path}Controller"
+
+          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
+      end
+
+      def all_apis_from_docs
+        resource_descriptions = Apipie.resource_descriptions.values.map(&:values).flatten
+        method_descriptions = resource_descriptions.map(&:method_descriptions).flatten
+
+        return 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(desc.id => apis)
+        end
+      end
+
+      def update_api_descriptions
+        apis_from_docs = all_apis_from_docs
+        @apis_from_routes.each do |(controller, action), new_apis|
+          method_key = "#{Apipie.get_resource_name(controller.safe_constantize || next)}##{action}"
+          old_apis = apis_from_docs[method_key] || []
+          new_apis.each do |new_api|
+            new_api[:path].sub!(/\(\.:format\)$/,"") if new_api[:path]
+            old_api = old_apis.find do |api|
+              api[:path] == "#{@api_prefix}#{new_api[:path]}"
+            end
+            if old_api
+              new_api[:desc] = old_api[:desc]
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+if ENV["APIPIE_RECORD"]
+  Apipie::Extractor.start ENV["APIPIE_RECORD"]
+end
+
+at_exit do
+  Apipie::Extractor.finish
+end

data/lib/apipie/extractor/collector.rb

@@ -0,0 +1,117 @@
+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)
+        Apipie::Extractor.controller_path controller.controller_path
+      end
+
+      def ignore_call?(record)
+        return true unless record[:controller]
+        return true if @ignored.include?(record[:controller].name)
+        return true if @ignored.include?("#{Apipie.get_resource_name(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 = "#{Apipie.get_resource_name(record[:controller])}##{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, :boolean, :number]
+              param_desc[:type] << Hash if value.is_a? Hash
+              param_desc[:type] << :undef
+            end
+
+            if [:boolean, :bool].include?(param_desc[:type].first) && (! [true, false, 1, 0].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
+
+            if param_desc[:type].first == :decimal && (key.to_s !~ /id$/ || !Apipie::Validator::DecimalValidator.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.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,166 @@
+module Apipie
+  module Extractor
+    class Recorder
+      MULTIPART_BOUNDARY = 'APIPIE_RECORDER_EXAMPLE_BOUNDARY'
+
+      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"] || {})
+        rack_input = env["rack.input"]
+        if data = parse_data(rack_input.read)
+          @request_data = data
+        elsif form_hash = env["rack.request.form_hash"]
+          @request_data = reformat_multipart_data(form_hash)
+        end
+        rack_input.rewind
+      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 = if response[1]['Content-Disposition'].to_s.start_with?('attachment')
+                             '<STREAMED ATTACHMENT FILE>'
+                           else
+                             data
+                           end
+        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, :PATCH, :DELETE].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.strip.blank?
+        JSON.parse(data)
+      rescue StandardError
+        data
+      end
+
+      def reformat_multipart_data(form)
+        form.empty? and return ''
+        lines = ["Content-Type: multipart/form-data; boundary=#{MULTIPART_BOUNDARY}",'']
+        boundary = "--#{MULTIPART_BOUNDARY}"
+        form.each do |key, attrs|
+          if attrs.is_a?(String)
+            lines << boundary << content_disposition(key) << "Content-Length: #{attrs.size}" << '' << attrs
+          else
+            reformat_hash(boundary, attrs, lines)
+          end
+        end
+        lines << "#{boundary}--"
+        lines.join("\n")
+      end
+
+      def reformat_hash(boundary, attrs, lines)
+        if head = attrs[:head]
+          lines << boundary
+          lines.concat(head.split("\r\n"))
+          # To avoid large and/or binary file bodies, simply indicate the contents in the output.
+          lines << '' << %{... contents of "#{attrs[:name]}" ...}
+        else
+          # Look for subelements that contain a part.
+          attrs.each { |k,v| v.is_a?(Hash) and reformat_hash(boundary, v, lines) }
+        end
+      end
+
+      def content_disposition(name)
+        %{Content-Disposition: form-data; name="#{name}"}
+      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)
+          if Apipie.configuration.record
+            analyze(env) do
+              @app.call(env)
+            end
+          else
+            @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)
+          Apipie::Extractor.call_finished
+          response
+        ensure
+          Apipie::Extractor.clean_call_recorder
+        end
+      end
+
+      module FunctionalTestRecording
+        def process(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          ret = super(*args)
+          if Apipie.configuration.record
+            Apipie::Extractor.call_recorder.analyze_functional_test(self)
+            Apipie::Extractor.call_finished
+          end
+          ret
+        ensure
+          Apipie::Extractor.clean_call_recorder
+        end
+      end
+    end
+  end
+end