apipie-rails-jq 1.4.3.pre.beta.pre.jq.1

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 ParamMultipleMissing < ParamError
+    attr_accessor :params
+
+    def initialize(params)
+      @params = params
+    end
+
+    def to_s
+      params.map do |param|
+        ParamMissing.new(param).to_s
+      end.join("\n")
+    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)
+      super("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)
+      super("There is no documented method #{controller_name}##{method_name}")
+    end
+  end
+end

data/lib/apipie/extractor/collector.rb

@@ -0,0 +1,116 @@
+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_id(record[:controller].name)}##{record[:action]}")
+        return true unless @api_controllers_paths.include?(controller_full_path(record[:controller]))
+      end
+
+      def handle_record(record)
+        if ignore_call?(record)
+          Extractor.logger.info("REST_API: skipping #{record_to_s(record)}")
+        else
+          add_to_records(record)
+          refine_description(record)
+        end
+      end
+
+      def add_to_records(record)
+        key = "#{Apipie.get_resource_id(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_value do |desc|
+          add_routes_info(desc)
+        end
+        return @descriptions
+      end
+
+      def add_routes_info(desc)
+        api_prefix = Apipie.api_base_url.sub(%r{/$},"")
+        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,193 @@
+module Apipie
+  module Extractor
+    class Recorder
+      MULTIPART_BOUNDARY = 'APIPIE_RECORDER_EXAMPLE_BOUNDARY'.freeze
+
+      def initialize
+        @ignored_params = [:controller, :action]
+      end
+
+      def analyse_env(env)
+        @verb = env["REQUEST_METHOD"].to_sym
+        @path = env["PATH_INFO"].sub(%r{^/*},"/")
+        @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 = Apipie.configuration.api_action_matcher.call(controller)
+      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 = request.content_type == "multipart/form-data" ? reformat_multipart_data(@params) : @params
+        else
+          @query = request.query_string
+        end
+        if response.media_type != 'application/pdf'
+          @response_data = parse_data(response.body)
+        end
+        @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) # rubocop:disable Style/CaseLikeIf
+            lines << boundary << content_disposition(key) << "Content-Length: #{attrs.size}" << '' << attrs
+          elsif attrs.is_a?(Rack::Test::UploadedFile) || attrs.is_a?(ActionDispatch::Http::UploadedFile)
+            reformat_uploaded_file(boundary, attrs, key, lines)
+          elsif attrs.is_a?(Array)
+            reformat_array(boundary, attrs, key, lines)
+          elsif attrs.is_a?(TrueClass) || attrs.is_a?(FalseClass)
+            reformat_boolean(boundary, attrs, key, lines)
+          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_value { |v| v.is_a?(Hash) and reformat_hash(boundary, v, lines) }
+        end
+      end
+
+      def reformat_boolean(boundary, attrs, key, lines)
+        lines << boundary << content_disposition(key)
+        lines << '' << attrs.to_s
+      end
+
+      def reformat_array(boundary, attrs, key, lines)
+        attrs.each do |item|
+          lines << boundary << content_disposition("#{key}[]")
+          lines << '' << item
+        end
+      end
+
+      def reformat_uploaded_file(boundary, file, key, lines)
+        lines << boundary << %{#{content_disposition(key)}; filename="#{file.original_filename}"}
+        lines << "Content-Length: #{file.size}" << "Content-Type: #{file.content_type}" << "Content-Transfer-Encoding: binary"
+        lines << '' << %{... contents of "#{key}" ...}
+      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(*) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          ret = super
+          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
+        ruby2_keywords :process if respond_to?(:ruby2_keywords, true)
+      end
+    end
+  end
+end