apipie-rails 0.3.6 → 0.9.1

data/lib/apipie/tag_list_description.rb

@@ -0,0 +1,11 @@
+module Apipie
+
+  class TagListDescription
+
+    attr_reader :tags
+
+    def initialize(tags); @tags = tags; end
+
+  end
+
+end

data/lib/apipie/validator.rb

@@ -3,7 +3,7 @@ module Apipie
 
   module Validator
 
-    # to create new validator, inherit from Apipie::Validator::Base
+    # to create new validator, inherit from Apipie::Validator::BaseValidator
     # and implement class method build and instance method validate
     class BaseValidator
 
@@ -13,6 +13,16 @@ module Apipie
         @param_description = param_description
       end
 
+      def inspected_fields
+        [:param_description]
+      end
+
+      def inspect
+        string = "#<#{self.class.name}:#{self.object_id} "
+        fields = inspected_fields.map {|field| "#{field}: #{self.send(field)}"}
+        string << fields.join(", ") << ">"
+      end
+
       def self.inherited(subclass)
         @validators ||= []
         @validators.insert 0, subclass
@@ -47,6 +57,10 @@ module Apipie
         "TODO: validator description"
       end
 
+      def format_description_value(value)
+        "<code>#{CGI::escapeHTML(value.to_s)}</code>"
+      end
+
       def error
         ParamInvalid.new(param_name, @error_value, description)
       end
@@ -66,14 +80,27 @@ module Apipie
         'string'
       end
 
+      def ignore_allow_blank?
+        false
+      end
+
       def merge_with(other_validator)
-        raise NotImplementedError, "Dont know how to merge #{self.inspect} with #{other_validator.inspect}"
+        return self if self == other_validator
+        raise NotImplementedError, "Don't know how to merge #{self.inspect} with #{other_validator.inspect}"
       end
 
       def params_ordered
         nil
       end
 
+      def ==(other)
+        return false unless self.class == other.class
+        if param_description == other.param_description
+          true
+        else
+          false
+        end
+      end
     end
 
     # validate arguments type
@@ -96,7 +123,7 @@ module Apipie
       end
 
       def description
-        "Must be #{@type}"
+        "Must be a #{@type}"
       end
 
       def expected_type
@@ -106,6 +133,8 @@ module Apipie
           'array'
         elsif @type.ancestors.include? Numeric
           'numeric'
+        elsif @type.ancestors.include? File
+          'file'
         else
           'string'
         end
@@ -129,7 +158,7 @@ module Apipie
       end
 
       def description
-        "Must match regular expression <code>/#{@regexp.source}/</code>."
+        "Must match regular expression #{format_description_value("/#{@regexp.source}/")}."
       end
     end
 
@@ -148,8 +177,12 @@ module Apipie
         self.new(param_description, argument) if argument.is_a?(Array)
       end
 
+      def values
+        @array
+      end
+
       def description
-        string = @array.map { |value| "<code>#{value}</code>" }.join(', ')
+        string = @array.map { |value| format_description_value(value) }.join(', ')
         "Must be one of: #{string}."
       end
     end
@@ -202,7 +235,13 @@ module Apipie
 
       def has_valid_type?(value)
         if @items_type
-          value.kind_of?(@items_type)
+          item_validator = BaseValidator.find('', @items_type, nil, nil)
+
+          if item_validator
+            item_validator.valid?(value)
+          else
+            value.kind_of?(@items_type)
+          end
         else
           true
         end
@@ -243,7 +282,8 @@ module Apipie
       end
 
       def description
-        "Must be one of: #{@array.join(', ')}."
+        string = @array.map { |value| format_description_value(value) }.join(', ')
+        "Must be one of: #{string}."
       end
     end
 
@@ -297,6 +337,7 @@ module Apipie
         @params_ordered ||= _apipie_dsl_data[:params].map do |args|
           options = args.find { |arg| arg.is_a? Hash }
           options[:parent] = self.param_description
+          options[:param_group] = @param_group
           Apipie::ParamDescription.from_dsl_data(param_description.method_description, args)
         end
       end
@@ -375,6 +416,31 @@ module Apipie
       end
     end
 
+    class DecimalValidator < BaseValidator
+
+      def validate(value)
+        self.class.validate(value)
+      end
+
+      def self.build(param_description, argument, options, block)
+        if argument == :decimal
+          self.new(param_description)
+        end
+      end
+
+      def description
+        "Must be a decimal number."
+      end
+
+      def expected_type
+        'numeric'
+      end
+
+      def self.validate(value)
+        value.to_s =~ /\A^[-+]?[0-9]+([,.][0-9]+)?\Z$/
+      end
+    end
+
     class NumberValidator < BaseValidator
 
       def validate(value)
@@ -391,6 +457,10 @@ module Apipie
         "Must be a number."
       end
 
+      def expected_type
+        'numeric'
+      end
+
       def self.validate(value)
         value.to_s =~ /\A(0|[1-9]\d*)\Z$/
       end
@@ -413,7 +483,12 @@ module Apipie
       end
 
       def description
-        "Must be 'true' or 'false' or '1' or '0'"
+        string = %w(true false 1 0).map { |value| format_description_value(value) }.join(', ')
+        "Must be one of: #{string}."
+      end
+
+      def ignore_allow_blank?
+        true
       end
     end
 
@@ -464,4 +539,3 @@ module Apipie
 
   end
 end
-

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.3.6'
+  VERSION = "0.9.1"
 end

data/lib/apipie-rails.rb

@@ -1,6 +1,9 @@
 require 'i18n'
+require 'json'
 require 'active_support/hash_with_indifferent_access'
 
+require 'apipie/core_ext/route'
+
 require "apipie/routing"
 require "apipie/markup"
 require "apipie/apipie_module"
@@ -9,14 +12,22 @@ require "apipie/configuration"
 require "apipie/method_description"
 require "apipie/resource_description"
 require "apipie/param_description"
+require "apipie/method_description/api"
+require "apipie/method_description/apis_service"
 require "apipie/errors"
 require "apipie/error_description"
+require "apipie/response_description"
+require "apipie/response_description_adapter"
 require "apipie/see_description"
+require "apipie/tag_list_description"
 require "apipie/validator"
 require "apipie/railtie"
 require 'apipie/extractor'
 require "apipie/version"
-
-if Rails.version.start_with?("3.0")
-  warn 'Warning: apipie-rails is not going to support Rails 3.0 anymore in future versions'
-end
+require "apipie/swagger_generator"
+require "apipie/generator/generator"
+require "apipie/generator/swagger/swagger"
+require "apipie/generator/swagger/warning"
+require "apipie/generator/swagger/warning_writer"
+require "apipie/generator/swagger/type"
+require "apipie/generator/swagger/type_extractor"

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

@@ -1,6 +1,6 @@
 module Apipie
   class InstallGenerator < ::Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     class_option(:route,
                  :aliases => "-r",

data/lib/generators/apipie/views_generator.rb

@@ -1,6 +1,6 @@
 module Apipie
   class ViewsGenerator < ::Rails::Generators::Base
-    source_root File.expand_path("../../../../app/views", __FILE__)
+    source_root File.expand_path('../../../app/views', __dir__)
     desc 'Copy Apipie views to your application'
 
     def copy_views

data/lib/tasks/apipie.rake

@@ -51,6 +51,71 @@ namespace :apipie do
     end
   end
 
+  desc "Generate static swagger json"
+  task :static_swagger_json, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
+    with_loaded_documentation do
+      out = ENV["OUT"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc')
+      generate_swagger_using_args(args, out)
+    end
+  end
+
+  # The following task compares the currently-generated swagger output to a reference copy generated
+  # by the previous execution of this task.
+  # if a difference is detected, the current output will be stored as a reference.
+  # reference files have the
+  # if more than 3 references are detected, the older ones will be purged
+  desc "Did swagger output change since the last execution of this task?"
+  task :did_swagger_change, [:version, :swagger_content_type_input, :filename_suffix] => :environment do |t, args|
+    with_loaded_documentation do
+      out = ENV["OUT_REF"] || File.join(::Rails.root, Apipie.configuration.doc_path, 'apidoc_ref')
+      paths = generate_swagger_using_args(args, out)
+      paths.each {|path|
+        existing_files_in_dir = Pathname(out).children(true)
+
+        make_reference = false
+
+        # reference filenames have the format <basename>.<counter>.swagger_ref
+        reference_files = existing_files_in_dir.select{|f|
+              f.extname == '.swagger_ref' &&
+              f.basename.sub_ext("").extname.delete('.').to_i > 0 &&
+              f.basename.sub_ext("").sub_ext("") == path.basename.sub_ext("")
+        }
+        if reference_files.empty?
+          print "Reference file does not exist for [#{path}]\n"
+          counter = 1
+          make_reference = true
+        else
+          reference_files.sort_by!(&:ctime)
+          last_ref = reference_files[-1]
+          print "Comparing [#{path}] to reference file: [#{last_ref.basename}]: "
+          if !FileUtils.compare_file(path, last_ref)
+            print("\n ---> Differences detected\n")
+            counter = last_ref.sub_ext("").extname.delete('.').to_i + 1
+            make_reference = true
+          else
+            print("identical\n")
+          end
+        end
+
+        if make_reference
+          new_path = path.sub_ext(".#{counter}.swagger_ref")
+          print " ---> Keeping current output as [#{new_path}]\n"
+          path.rename(new_path)
+          reference_files << new_path
+        else
+          path.delete
+        end
+
+        num_refs_to_keep = 3
+        if reference_files.length > num_refs_to_keep
+          (reference_files - reference_files[-num_refs_to_keep..-1]).each(&:delete)
+        end
+      }
+    end
+  end
+
+
+
   # By default the full cache is built.
   # It is possible to generate index resp. resources only with
   # rake apipie:cache cache_part=index (resources resp.)
@@ -100,13 +165,19 @@ namespace :apipie do
   # Attempt to use the Rails application views, otherwise default to built in views
   def renderer
     return @apipie_renderer if @apipie_renderer
-    base_path = if File.directory?("#{Rails.root}/app/views/apipie/apipies")
-                  "#{Rails.root}/app/views/apipie/apipies"
-                else
-                  File.expand_path("../../../app/views/apipie/apipies", __FILE__)
-                end
-    layouts_path = File.expand_path("../../../app/views/layouts", __FILE__)
-    @apipie_renderer = ActionView::Base.new([base_path, layouts_path])
+
+    base_paths = [File.expand_path('../../app/views/apipie/apipies', __dir__)]
+    base_paths.unshift("#{Rails.root}/app/views/apipie/apipies") if File.directory?("#{Rails.root}/app/views/apipie/apipies")
+
+    layouts_paths = [File.expand_path('../../app/views/layouts', __dir__)]
+    layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie")
+
+    if ActionView::Base.respond_to?(:with_empty_template_cache) && ActionView::Base.respond_to?(:with_view_paths)
+      @apipie_renderer = ActionView::Base.with_empty_template_cache.with_view_paths(base_paths + layouts_paths)
+    else
+      @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
+    end
+
     @apipie_renderer.singleton_class.send(:include, ApipieHelper)
     return @apipie_renderer
   end
@@ -123,29 +194,58 @@ namespace :apipie do
     end
   end
 
+  def generate_swagger_using_args(args, out)
+    args.with_defaults(:version => Apipie.configuration.default_version,
+                       :swagger_content_type_input => Apipie.configuration.swagger_content_type_input || :form_data,
+                       :filename_suffix => nil)
+    Apipie.configuration.swagger_content_type_input = args[:swagger_content_type_input].to_sym
+    count = 0
+
+    sfx = args[:filename_suffix] || "_#{args[:swagger_content_type_input]}"
+
+    paths = []
+
+    ([nil] + Apipie.configuration.languages).each do |lang|
+      doc = Apipie.to_swagger_json(args[:version], nil, nil, lang, count==0)
+      paths << generate_swagger_json_page(out, doc, sfx, lang)
+      count+=1
+    end
+
+    paths
+  end
+
   def generate_json_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(file_base) unless File.exists?(file_base)
+    FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     filename = "schema_apipie#{lang_ext(lang)}.json"
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
+  def generate_swagger_json_page(file_base, doc, sfx="", lang = nil)
+    FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
+
+    path = Pathname.new("#{file_base}/schema_swagger#{sfx}#{lang_ext(lang)}.json")
+    File.open(path, 'w') { |file| file.write(JSON.pretty_generate(doc)) }
+
+    path
+  end
+
   def generate_one_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
 
     render_page("#{file_base}-onepage#{lang_ext(lang)}.html", "static", {:doc => doc[:docs],
       :language => lang, :languages => Apipie.configuration.languages})
   end
 
   def generate_plain_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
 
     render_page("#{file_base}-plain#{lang_ext(lang)}.html", "plain", {:doc => doc[:docs],
       :language => lang, :languages => Apipie.configuration.languages}, nil)
   end
 
   def generate_index_page(file_base, doc, include_json = false, show_versions = false, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
     versions = show_versions && Apipie.available_versions
     render_page("#{file_base}#{lang_ext(lang)}.html", "index", {:doc => doc[:docs],
       :versions => versions, :language => lang, :languages => Apipie.configuration.languages})
@@ -156,7 +256,7 @@ namespace :apipie do
   def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
     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))
+      FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exist?(File.dirname(resource_file_base))
 
       doc = Apipie.to_json(version, resource_name, nil, lang)
       doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
@@ -170,7 +270,7 @@ namespace :apipie do
     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))
+        FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exist?(File.dirname(method_file_base))
 
         doc = Apipie.to_json(version, resource_name, method[:name], lang)
         doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
@@ -224,7 +324,7 @@ MESSAGE
       apis_from_routes.each do |(controller, action), apis|
         next if ignored.include?(controller)
         next if ignored.include?("#{controller}##{action}")
-        Apipie::Extractor::Writer.update_action_description(controller.constantize, action) do |u|
+        Apipie::Extractor::Writer.update_action_description((controller.safe_constantize || next), action) do |u|
           u.update_apis(apis)
         end
       end
@@ -234,7 +334,7 @@ MESSAGE
   desc "Convert your examples from the old yaml into the new json format"
   task :convert_examples => :environment do
     yaml_examples_file = File.join(Rails.root, Apipie.configuration.doc_path, "apipie_examples.yml")
-    if File.exists?(yaml_examples_file)
+    if File.exist?(yaml_examples_file)
       #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
       if defined? SafeYAML
         examples = YAML.load_file(yaml_examples_file, :safe=>false)