apipie-rails 0.3.6 → 0.5.17

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

@@ -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
@@ -67,13 +81,22 @@ module Apipie
       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 +119,7 @@ module Apipie
       end
 
       def description
-        "Must be #{@type}"
+        "Must be a #{@type}"
       end
 
       def expected_type
@@ -106,6 +129,8 @@ module Apipie
           'array'
         elsif @type.ancestors.include? Numeric
           'numeric'
+        elsif @type.ancestors.include? File
+          'file'
         else
           'string'
         end
@@ -129,7 +154,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 +173,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 +231,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 +278,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
 
@@ -375,6 +411,27 @@ 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 self.validate(value)
+        value.to_s =~ /\A^[-+]?[0-9]+([,.][0-9]+)?\Z$/
+      end
+    end
+
     class NumberValidator < BaseValidator
 
       def validate(value)
@@ -391,6 +448,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 +474,8 @@ 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
     end
 
@@ -464,4 +526,3 @@ module Apipie
 
   end
 end
-

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.3.6'
+  VERSION = '0.5.17'
 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.rb'
+
 require "apipie/routing"
 require "apipie/markup"
 require "apipie/apipie_module"
@@ -11,11 +14,15 @@ require "apipie/resource_description"
 require "apipie/param_description"
 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"
+require "apipie/swagger_generator"
 
 if Rails.version.start_with?("3.0")
   warn 'Warning: apipie-rails is not going to support Rails 3.0 anymore in future versions'

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! {|f| f.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{|f| f.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,14 @@ 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", __FILE__)]
+    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", __FILE__)]
+    layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie")
+
+    @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
     @apipie_renderer.singleton_class.send(:include, ApipieHelper)
     return @apipie_renderer
   end
@@ -123,6 +189,26 @@ 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)
 
@@ -130,6 +216,15 @@ namespace :apipie do
     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.exists?(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))
 
@@ -224,7 +319,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

data/spec/controllers/apipies_controller_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'fileutils'
+require "json-schema"
 
 describe Apipie::ApipiesController do
 
@@ -12,37 +13,37 @@ describe Apipie::ApipiesController do
     end
 
     it "succeeds on version details" do
-      get :index, :version => "2.0"
+      get :index, :params => { :version => "2.0" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong version" do
-      get :index, :version => "wrong_version"
+      get :index, :params => { :version => "wrong_version" }
 
       assert_response :not_found
     end
 
     it "succeeds on resource details" do
-      get :index, :version => "2.0", :resource => "architectures"
+      get :index, :params => { :version => "2.0", :resource => "architectures" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong resource" do
-      get :index, :version => "2.0", :resource => "wrong_resource"
+      get :index, :params => { :version => "2.0", :resource => "wrong_resource" }
 
       assert_response :not_found
     end
 
     it "succeeds on method details" do
-      get :index, :version => "2.0", :resource => "architectures", :method => "index"
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "index" }
 
       assert_response :success
     end
 
     it "returns not_found on wrong method" do
-      get :index, :version => "2.0", :resource => "architectures", :method => "wrong_method"
+      get :index, :params => { :version => "2.0", :resource => "architectures", :method => "wrong_method" }
 
       assert_response :not_found
     end
@@ -130,6 +131,38 @@ describe Apipie::ApipiesController do
     end
   end
 
+  describe "GET index as swagger" do
+
+    let(:swagger_schema) do
+      File.read(File.join(File.dirname(__FILE__),"../lib/swagger/openapi_2_0_schema.json"))
+    end
+
+    it "outputs swagger when format is json and type is swagger" do
+      get :index, :params => { :format => "json", :type => "swagger"}
+
+      assert_response :success
+      expect(response.body).to match(/"swagger":"2.0"/)
+      # puts response.body
+
+      expect(JSON::Validator.validate(swagger_schema, response.body)).to be_truthy
+    end
+
+    it "does not output swagger when format is not json even if type is swagger" do
+      get :index, :params => { :type => "swagger"}
+
+      assert_response :success
+      expect(response.body).not_to match(/"swagger":"2.0"/)
+    end
+
+    it "does not output swagger when format is json even but type is not swagger" do
+      get :index, :params => { :format => "json"}
+
+      assert_response :success
+      expect(response.body).not_to match(/"swagger":"2.0"/)
+    end
+  end
+
+
   describe "authenticate user" do
     it "authenticate user if an authentication method is setted" do
       test = false
@@ -183,6 +216,11 @@ describe Apipie::ApipiesController do
       expect(assigns(:doc)[:resources]["users"][:methods].size).to eq(users_methods - 1)
       expect(assigns(:doc)[:resources]["twitter_example"][:methods].size).to eq(twitter_example_methods)
     end
+    it "does not allow access to swagger when authorization is set" do
+      get :index, :params => { :format => "json", :type => "swagger"}
+
+      assert_response :forbidden
+    end
   end
 
   describe "documentation cache" do
@@ -215,19 +253,21 @@ describe Apipie::ApipiesController do
     it "uses the file in cache dir instead of generating the content on runtime" do
       get :index
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v1'
+      get :index, :params => { :version => 'v1' }
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v2'
+      get :index, :params => { :version => 'v2' }
       expect(response.body).to eq("apidoc.html cache v2")
-      get :index, :version => 'v1', :format => "html"
+      get :index, :params => { :version => 'v1', :format => "html" }
       expect(response.body).to eq("apidoc.html cache v1")
-      get :index, :version => 'v1', :format => "json"
+      get :index, :params => { :version => 'v1', :format => "json" }
       expect(response.body).to eq("apidoc.json cache")
-      get :index, :version => 'v1', :format => "html", :resource => "resource"
+      get :index, :params => { :version => 'v1', :format => "html", :resource => "resource" }
       expect(response.body).to eq("resource.html cache")
-      get :index, :version => 'v1', :format => "html", :resource => "resource", :method => "method"
+      get :index, :params => { :version => 'v1', :format => "html", :resource => "resource", :method => "method" }
       expect(response.body).to eq("method.html cache")
     end
 
   end
+
+
 end

data/spec/controllers/concerns_controller_spec.rb

@@ -8,12 +8,12 @@ describe ConcernsController do
   end
 
   it "should reply to valid request" do
-    get :show, :id => '5', :session => "secret_hash"
+    get :show, :params => { :id => '5' }, :session => { :user_id => "secret_hash" }
     assert_response :success
   end
 
   it "should pass if required parameter is missing" do
-    expect { get :show, :id => '5' }.not_to raise_error
+    expect { get :show, :params => { :id => '5' } }.not_to raise_error
   end
 
   it "peserved the order of methods being defined in file" do

data/spec/controllers/extended_controller_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe ExtendedController do
+
+  it 'should include params from both original controller and extending concern' do
+    expect(Apipie["extended#create"].params.keys).to eq [:oauth, :user, :admin]
+    user_param = Apipie["extended#create"].params[:user]
+    expect(user_param.validator.params_ordered.map(&:name)).to eq [:name, :password, :from_concern]
+  end
+
+  it 'should include updated metadata' do
+    expect(Apipie['extended#create'].metadata).to eq metadata: 'data'
+  end
+end

data/spec/controllers/memes_controller_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe TestEngine::MemesController do
+
+  describe "#index" do
+    it "should have the full mounted path of engine" do
+      Apipie.routes_for_action(TestEngine::MemesController, :index, {}).first[:path].should eq("/test/memes")
+    end
+  end
+end