restapi 0.0.4 → 0.0.5

data/lib/restapi/dsl_definition.rb

@@ -16,6 +16,7 @@ module Restapi
     #   Long description...
     # EOS
     def resource_description(options = {}, &block) #:doc:
+      return unless Restapi.active_dsl?
       Restapi.remove_resource_description(self)
       Restapi.define_resource_description(self, &block) if block_given?
     end
@@ -26,6 +27,7 @@ module Restapi
     #   api :GET, "/resource_route", "short description",
     #
     def api(method, path, desc = nil) #:doc:
+      return unless Restapi.active_dsl?
       Restapi.add_method_description_args(method, path, desc)
     end
 
@@ -38,6 +40,7 @@ module Restapi
     #   end
     #
     def desc(description) #:doc:
+      return unless Restapi.active_dsl?
       if Restapi.last_description
         raise "Double method description."
       end
@@ -45,9 +48,21 @@ module Restapi
     end
     alias :description :desc
 
+    # Reference other similar method
+    #
+    #   api :PUT, '/articles/:id'
+    #   see "articles#create"
+    #   def update; end
+    def see(method_key)
+      return unless Restapi.active_dsl?
+      raise "'See' method called twice." if Restapi.last_see
+      Restapi.last_see = method_key
+    end
+
     # Show some example of what does the described
     # method return.
     def example(example) #:doc:
+      return unless Restapi.active_dsl?
       Restapi.add_example(example)
     end
 
@@ -55,12 +70,14 @@ module Restapi
     #
     # Example:
     #   error :desc => "speaker is sleeping", :code => 500
+    #   error 500, "speaker is sleeping"
     #   def hello_world
     #     return 500 if self.speaker.sleeping?
     #     puts "hello world"
     #   end
     #
-    def error(args) #:doc:
+    def error(*args) #:doc:
+      return unless Restapi.active_dsl?
       Restapi.last_errors << Restapi::ErrorDescription.new(args)
     end
 
@@ -73,14 +90,15 @@ module Restapi
     #   end
     #
     def param(param_name, *args, &block) #:doc:
+      return unless Restapi.active_dsl?
       Restapi.last_params << Restapi::ParamDescription.new(param_name, *args, &block)
     end
 
     # create method api and redefine newly added method
     def method_added(method_name) #:doc:
-
       super
 
+      return unless Restapi.active_dsl?
       return unless Restapi.restapi_provided?
 
       # remove method description if exists and create new one

data/lib/restapi/error_description.rb

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

data/lib/restapi/extractor.rb

@@ -0,0 +1,143 @@
+require 'singleton'
+require 'fileutils'
+require 'set'
+require 'yaml'
+require 'restapi/extractor/recorder'
+require 'restapi/extractor/writer'
+require 'restapi/extractor/collector'
+
+class Restapi::Railtie
+  if ENV["RESTAPI_RECORD"]
+    initializer 'restapi.extractor' do |app|
+      ActiveSupport.on_load :action_controller do
+        before_filter do |controller|
+          Restapi::Extractor.call_recorder.analyse_controller(controller)
+        end
+      end
+      app.middleware.use ::Restapi::Extractor::Recorder::Middleware
+      ActionController::TestCase::Behavior.instance_eval do
+        include Restapi::Extractor::Recorder::FunctionalTestRecording
+      end
+    end
+  end
+end
+
+module Restapi
+
+  module Extractor
+
+    class << self
+
+      def logger
+        Rails.logger
+      end
+
+      def call_recorder
+        Thread.current[:restapi_call_recorder] ||= Recorder.new
+      end
+
+      def call_finished
+        @collector ||= Collector.new
+        if record = call_recorder.record
+          @collector.handle_record(record)
+        end
+      ensure
+        Thread.current[:restapi_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 = Restapi.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?(Restapi.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 = Restapi.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["RESTAPI_RECORD"]
+  Restapi.configuration.force_dsl = true
+  at_exit do
+    record_params, record_examples = false, false
+    case ENV["RESTAPI_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"
+      Restapi::Extractor.write_examples
+    end
+    if record_params
+      puts "Updating auto-generated documentation"
+      Restapi::Extractor.write_docs
+    end
+  end
+end

data/lib/restapi/extractor/collector.rb

@@ -0,0 +1,113 @@
+module Restapi
+  module Extractor
+    class Collector
+      attr_reader :descriptions, :records
+
+      def initialize
+        @api_controllers_paths = Restapi.api_controllers_paths
+        @ignored = Restapi.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$/ || !Restapi::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 = Restapi.configuration.api_base_url.sub(/\/$/,"")
+        desc[:api] = Restapi::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/restapi/extractor/recorder.rb

@@ -0,0 +1,122 @@
+module Restapi
+  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)
+          Restapi::Extractor.call_recorder.analyse_env(env)
+          response = block.call
+          Restapi::Extractor.call_recorder.analyse_response(response)
+          response
+        ensure
+          Restapi::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)
+          Restapi::Extractor.call_recorder.analyze_functional_test(self)
+        ensure
+          Restapi::Extractor.call_finished
+        end
+      end
+
+    end
+
+  end
+end