apipie-rails 0.3.5 → 0.3.6

data/config/locales/es.yml

@@ -1,28 +1,28 @@
 es:
-    apipie:
-        resources: Recursos
-        resource: Recurso
-        description: Descripción
-        no_docs_found: No se encontró la documentación
-        no_docs_found_descr: No hemos encontrado ninguna documentación para tu API.
-        follow_instructions_html: Siga %{href} sobre cómo describir sus controladores.
-        follow_instructions_href: más instrucciones
-        oops: Huy!!
-        resource_not_found_html: Recurso %{res} no encontrado.
-        method_not_found_html: Método  %{method} no encontrado para el recurso %{resource}.
-        goto_homepage_html: Trate de ir a %{href}
-        goto_homepage_href: "%{app_name} página de documentación API  "
-        required: requerido
-        optional: opcional
-        nil_allowed: nil permitido
-        param_name: Nombre del parámetro
-        params: Parámetros
-        examples: Ejemplos
-        metadata: Metadatos
-        errors: Errores
-        supported_formats: Formatos soportados
-        enable_javascript_html: Por favor, active JavaScript para ver el %{comments_href}.
-        comments_powered_by_disqus: comentarios gracias a %{disqus}
-        api_documentation: Documentación de la API
-        headers: Cabeceras
-        header_name: Nombre de cabecera
+  apipie:
+    resources: Recursos
+    resource: Recurso
+    description: Descripción
+    no_docs_found: No se encontró la documentación
+    no_docs_found_descr: No hemos encontrado ninguna documentación para tu API.
+    follow_instructions_html: Siga %{href} sobre cómo describir sus controladores.
+    follow_instructions_href: más instrucciones
+    oops: Huy!!
+    resource_not_found_html: Recurso %{resource} no encontrado.
+    method_not_found_html: Método  %{method} no encontrado para el recurso %{resource}.
+    goto_homepage_html: Trate de ir a %{href}
+    goto_homepage_href: "%{app_name} página de documentación API  "
+    required: requerido
+    optional: opcional
+    nil_allowed: nil permitido
+    param_name: Nombre del parámetro
+    params: Parámetros
+    examples: Ejemplos
+    metadata: Metadatos
+    errors: Errores
+    supported_formats: Formatos soportados
+    enable_javascript_html: Por favor, active JavaScript para ver el %{comments_href}.
+    comments_powered_by_disqus: comentarios gracias a %{disqus}
+    api_documentation: Documentación de la API
+    headers: Cabeceras
+    header_name: Nombre de cabecera

data/config/locales/pl.yml

@@ -1,29 +1,28 @@
 pl:
-    apipie:
-        resources: Zasoby
-        resource: Zasób 
-        description: Opis
-        no_docs_found: Nie znalezionio dokumentacji
-        no_docs_found_descr: Nie znaleziono dokumentacji dla twojego API.
-        follow_instructions_html: Przejdź do %{href} aby opisać swoje kontrolery.
-        follow_instructions_href: dalsze instrukcje
-        oops: Ups!!
-        resource_not_found_html: Zasób %{res} nie został znaleziony.
-        method_not_found_html: Metoda %{method} dla zasobu %{resource} nie została znaleziona.
-        goto_homepage_html: Spróbuj przejść do %{href}
-        goto_homepage_href: "%{app_name} Strona główna dokumentacji API"
-        required: wymagany 
-        optional: opcjonalny
-        nil_allowed: nil dopuszczalny
-        param_name: Nazwa parametru
-        params: Parametry
-        examples: Przykłady
-        metadata: Metadane
-        errors: Błędy
-        supported_formats: Dostępne formaty
-        enable_javascript_html: Proszę włączyć obsługę javascript w celu zobaczenia %{comments_href}.
-        comments_powered_by_disqus: komentarze obsługiwane przez %{disqus}
-        api_documentation: Dokumentacja API
-        headers: Nagłówki
-        header_name: Nazwa nagłówka
-
+  apipie:
+    resources: Zasoby
+    resource: Zasób
+    description: Opis
+    no_docs_found: Nie znalezionio dokumentacji
+    no_docs_found_descr: Nie znaleziono dokumentacji dla twojego API.
+    follow_instructions_html: Przejdź do %{href} aby opisać swoje kontrolery.
+    follow_instructions_href: dalsze instrukcje
+    oops: Ups!!
+    resource_not_found_html: Zasób %{resource} nie został znaleziony.
+    method_not_found_html: Metoda %{method} dla zasobu %{resource} nie została znaleziona.
+    goto_homepage_html: Spróbuj przejść do %{href}
+    goto_homepage_href: "%{app_name} Strona główna dokumentacji API"
+    required: wymagany
+    optional: opcjonalny
+    nil_allowed: nil dopuszczalny
+    param_name: Nazwa parametru
+    params: Parametry
+    examples: Przykłady
+    metadata: Metadane
+    errors: Błędy
+    supported_formats: Dostępne formaty
+    enable_javascript_html: Proszę włączyć obsługę JavaScript w celu zobaczenia %{comments_href}.
+    comments_powered_by_disqus: komentarze obsługiwane przez %{disqus}
+    api_documentation: Dokumentacja API
+    headers: Nagłówki
+    header_name: Nazwa nagłówka

data/config/locales/pt-BR.yml

@@ -8,7 +8,7 @@
     follow_instructions_html: Siga %{href} para saber como descrever seus controllers.
     follow_instructions_href: mais instruções
     oops: Oops!!
-    resource_not_found_html: Recurso %{res} não encontrado.
+    resource_not_found_html: Recurso %{resource} não encontrado.
     method_not_found_html: Método %{method} não encontrado para o recurso %{resource}.
     goto_homepage_html: Tente ir para %{href}
     goto_homepage_href: "%{app_name} API - Página inicial da documentação"

data/config/locales/ru.yml

@@ -1,29 +1,28 @@
 ru:
-    apipie:
-        resources: Ресурсы
-        resource: Ресурс
-        description: Описание
-        no_docs_found: Документация не найдена
-        no_docs_found_descr: Мы не нашли никакой документации для вашего API.
-        follow_instructions_html: Перейдите по ссылке %{href}, чтобы узнать как описать ваш API.
-        follow_instructions_href: дополнительные инструкции
-        oops: Ой!!
-        resource_not_found_html: Ресурс %{res} не найден.
-        method_not_found_html: Метод %{method} для ресурса %{resource} не найден.
-        goto_homepage_html: Перейдите %{href}
-        goto_homepage_href: "%{app_name} домашняя страница API документации"
-        required: обязательно
-        optional: необязательно
-        nil_allowed: nil разрешен
-        param_name: Имя параметра
-        params: Параметры
-        examples: Примеры
-        metadata: Метаданные
-        errors: Ошибки
-        supported_formats: Поддерживаемые форматы
-        enable_javascript_html: Пожалуйста включите JavaScript, чтобы просматривать %{comments_href}.
-        comments_powered_by_disqus: комментарии представлены %{disqus}
-        api_documentation: API документация
-        headers: Заголовки
-        header_name: Название заголовка
-
+  apipie:
+    resources: Ресурсы
+    resource: Ресурс
+    description: Описание
+    no_docs_found: Документация не найдена
+    no_docs_found_descr: Мы не нашли никакой документации для вашего API.
+    follow_instructions_html: Перейдите по ссылке %{href}, чтобы узнать как описать ваш API.
+    follow_instructions_href: дополнительные инструкции
+    oops: Ой!!
+    resource_not_found_html: Ресурс %{resource} не найден.
+    method_not_found_html: Метод %{method} для ресурса %{resource} не найден.
+    goto_homepage_html: Перейдите %{href}
+    goto_homepage_href: "%{app_name} домашняя страница API документации"
+    required: обязательно
+    optional: необязательно
+    nil_allowed: nil разрешен
+    param_name: Имя параметра
+    params: Параметры
+    examples: Примеры
+    metadata: Метаданные
+    errors: Ошибки
+    supported_formats: Поддерживаемые форматы
+    enable_javascript_html: Пожалуйста включите JavaScript, чтобы просматривать %{comments_href}.
+    comments_powered_by_disqus: комментарии представлены %{disqus}
+    api_documentation: API документация
+    headers: Заголовки
+    header_name: Название заголовка

data/config/locales/tr.yml

@@ -0,0 +1,28 @@
+tr:
+  apipie:
+    resources: Kaynaklar
+    resource: Kaynak
+    description: Açıklama
+    no_docs_found: Hiçbir belge bulunamadı
+    no_docs_found_descr: API'niz için hiçbir belge bulunamadı.
+    follow_instructions_html: Controller açıklaması belgeleri için %{href} yolunu izleyin.
+    follow_instructions_href: daha fazla talimatlar
+    oops: Üzgünüz!!
+    resource_not_found_html: Kaynak %{resource} bulunamadı.
+    method_not_found_html: "%{resource} kaynağının %{method} yöntemi bulunamadı."
+    goto_homepage_html: "%{href} adresini deneyin"
+    goto_homepage_href: "%{app_name} API belgeleri ana sayfası"
+    required: gerekli
+    optional: isteğe bağlı
+    nil_allowed: nil olabilir
+    param_name: Parametre adı
+    params: Parametreler
+    examples: Örnekler
+    metadata: Üst veriler
+    errors: Hatalar
+    supported_formats: Desteklenen Biçimler
+    enable_javascript_html: "%{comments_href} adresini görebilmek için lütfen JavaScript'i etkinleştirin."
+    comments_powered_by_disqus: yorumlar %{disqus} tarafından desteklenmektedir
+    api_documentation: API belgeleri
+    headers: Üst bilgiler
+    header_name: Üst bilgi adı

data/config/locales/zh-CN.yml

@@ -8,8 +8,8 @@
     follow_instructions_html: 点击 %{href} 查看描述。
     follow_instructions_href: 高级指导
     oops: Oops!!
-    resource_not_found_html: 没有找到资源 %{res} 。
-    method_not_found_html: 没有找到资源 %{res} 的方法 %{method} 。
+    resource_not_found_html: 没有找到资源 %{resource} 。
+    method_not_found_html: 没有找到资源 %{resource} 的方法 %{method} 。
     goto_homepage_html: 试图访问 %{href}
     goto_homepage_href: "%{app_name} API 文档主页"
     required: 必填

data/config/locales/zh-TW.yml

@@ -8,8 +8,8 @@
     follow_instructions_html: 點擊 %{href} 查看描述。
     follow_instructions_href: 高級指導
     oops: Oops!!
-    resource_not_found_html: 沒有找到資源 %{res} 。
-    method_not_found_html: 沒有找到資源 %{res} 的方法 %{method} 。
+    resource_not_found_html: 沒有找到資源 %{resource} 。
+    method_not_found_html: 沒有找到資源 %{resource} 的方法 %{method} 。
     goto_homepage_html: 試圖訪問 %{href}
     goto_homepage_href: "%{app_name} API 文檔主頁"
     required: 必填

data/lib/apipie/configuration.rb

@@ -7,7 +7,7 @@ module Apipie
       :validate, :validate_value, :validate_presence, :validate_key, :authenticate, :doc_path,
       :show_all_examples, :process_params, :update_checksum, :checksum_path,
       :link_extension, :record, :languages, :translate, :locale, :default_locale,
-      :persist_show_in_doc
+      :persist_show_in_doc, :authorize
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default

data/lib/apipie/dsl_definition.rb

@@ -223,7 +223,7 @@ module Apipie
               if Apipie.configuration.validate_presence?
                 method_params.each do |_, param|
                   # check if required parameters are present
-                  raise ParamMissing.new(param.name) if param.required && !params.has_key?(param.name)
+                  raise ParamMissing.new(param) if param.required && !params.has_key?(param.name)
                 end
               end
 

data/lib/apipie/errors.rb

@@ -17,7 +17,15 @@ module Apipie
 
   class ParamMissing < DefinedParamError
     def to_s
-      "Missing parameter #{@param}"
+      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
 

data/lib/apipie/extractor/collector.rb

@@ -63,12 +63,12 @@ module Apipie
             # 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] = [:bool, :boolean, :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))
+            if [:boolean, :bool].include?(param_desc[:type].first) && (! [true, false, 1, 0].include?(value))
               param_desc[:type].shift
             end
 

data/lib/apipie/extractor/writer.rb

@@ -79,6 +79,12 @@ module Apipie
           next unless call.has_key?(k)
           ordered_call[k] = case call[k]
                        when ActiveSupport::HashWithIndifferentAccess
+                         # UploadedFiles break the to_json call, turn them into a string so they don't break
+                         call[k].each do |pkey, pval|
+                           if (pval.is_a?(Rack::Test::UploadedFile) || pval.is_a?(ActionDispatch::Http::UploadedFile))
+                             call[k][pkey] = "<FILE CONTENT '#{pval.original_filename}'>"
+                           end
+                         end
                          JSON.parse(call[k].to_json) # to_hash doesn't work recursively and I'm too lazy to write the recursion:)
                        else
                          call[k]

data/lib/apipie/helpers.rb

@@ -33,7 +33,7 @@ module Apipie
     end
 
     def include_javascripts
-      %w[ bundled/jquery-1.7.2.js
+      %w[ bundled/jquery.js
           bundled/bootstrap-collapse.js
           bundled/prettify.js
           apipie.js ].map do |file|
@@ -48,5 +48,26 @@ module Apipie
         "<link type='text/css' rel='stylesheet' href='#{Apipie.full_url("stylesheets/#{file}")}'/>"
       end.join("\n").html_safe
     end
+
+    def label_class_for_error(err)
+      case err[:code]
+        when 200
+          'label label-info'
+        when 201
+          'label label-success'
+        when 204
+          'label label-info2'
+        when 401
+          'label label-warning'
+        when 403
+          'label label-warning2'
+        when 422
+          'label label-important'
+        when 404
+          'label label-inverse'
+        else
+          'label'
+      end
+    end
   end
 end

data/lib/apipie/param_description.rb

@@ -8,7 +8,7 @@ module Apipie
   # validator - Validator::BaseValidator subclass
   class ParamDescription
 
-    attr_reader :method_description, :name, :desc, :allow_nil, :validator, :options, :metadata, :show, :as
+    attr_reader :method_description, :name, :desc, :allow_nil, :validator, :options, :metadata, :show, :as, :validations
     attr_accessor :parent, :required
 
     def self.from_dsl_data(method_description, args)
@@ -63,6 +63,8 @@ module Apipie
         @validator = Validator::BaseValidator.find(self, validator, @options, block)
         raise "Validator for #{validator} not found." unless @validator
       end
+
+      @validations = Array(options[:validations]).map {|v| concern_subst(Apipie.markup_to_html(v)) }
     end
 
     def from_concern?
@@ -112,7 +114,8 @@ module Apipie
                :validator => validator.to_s,
                :expected_type => validator.expected_type,
                :metadata => metadata,
-               :show => show }
+               :show => show,
+               :validations => validations }
       if sub_params = validator.params_ordered
         hash[:params] = sub_params.map { |p| p.to_json(lang)}
       end

data/lib/apipie/validator.rb

@@ -129,7 +129,7 @@ module Apipie
       end
 
       def description
-        "Must match regular expression /#{@regexp.source}/."
+        "Must match regular expression <code>/#{@regexp.source}/</code>."
       end
     end
 
@@ -149,7 +149,8 @@ module Apipie
       end
 
       def description
-        "Must be one of: #{@array.join(', ')}."
+        string = @array.map { |value| "<code>#{value}</code>" }.join(', ')
+        "Must be one of: #{string}."
       end
     end
 
@@ -305,7 +306,7 @@ module Apipie
         if @hash_params
           @hash_params.each do |k, p|
             if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(k) if p.required && !value.has_key?(k)
+              raise ParamMissing.new(p) if p.required && !value.has_key?(k)
             end
             if Apipie.configuration.validate_value?
               p.validate(value[k]) if value.has_key?(k)
@@ -398,11 +399,11 @@ module Apipie
     class BooleanValidator < BaseValidator
 
       def validate(value)
-        %w[true false].include?(value.to_s)
+        %w[true false 1 0].include?(value.to_s)
       end
 
       def self.build(param_description, argument, options, block)
-        if argument == :bool
+        if argument == :bool || argument == :boolean
           self.new(param_description)
         end
       end
@@ -412,7 +413,7 @@ module Apipie
       end
 
       def description
-        "Must be 'true' or 'false'"
+        "Must be 'true' or 'false' or '1' or '0'"
       end
     end
 

data/lib/apipie/version.rb

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

data/lib/tasks/apipie.rake

@@ -105,7 +105,8 @@ namespace :apipie do
                 else
                   File.expand_path("../../../app/views/apipie/apipies", __FILE__)
                 end
-    @apipie_renderer = ActionView::Base.new(base_path)
+    layouts_path = File.expand_path("../../../app/views/layouts", __FILE__)
+    @apipie_renderer = ActionView::Base.new([base_path, layouts_path])
     @apipie_renderer.singleton_class.send(:include, ApipieHelper)
     return @apipie_renderer
   end
@@ -118,7 +119,7 @@ namespace :apipie do
       end
       f.write av.render(
         :template => "#{template}",
-        :layout => (layout && "../../layouts/apipie/#{layout}"))
+        :layout => (layout && "apipie/#{layout}"))
     end
   end
 

data/spec/controllers/api/v1/architectures_controller_spec.rb

@@ -5,24 +5,23 @@ describe Api::V1::ArchitecturesController do
     subject { Apipie.get_resource_description(Api::V1::ArchitecturesController, "1.0") }
 
     it "should be version 1.0" do
-      subject._version.should eq('1.0')
+      expect(subject._version).to eq('1.0')
 
-      Apipie.resource_descriptions['1.0'].size.should == 2
-      Apipie.resource_descriptions['1.0'].keys.should
-        include('architectures', 'base')
+      expect(Apipie.resource_descriptions['1.0'].size).to eq(2)
+      expect(Apipie.resource_descriptions['1.0'].keys).to include('architectures', 'base')
     end
 
     context "there is another version" do
       let(:v2) { archv2 = Apipie.get_resource_description(Api::V2::ArchitecturesController, "2.0") }
 
       it "should have unique doc url" do
-        subject.doc_url.should_not eq(v2.doc_url)
+        expect(subject.doc_url).not_to eq(v2.doc_url)
       end
 
       it "should have unique methods" do
-        subject._methods.keys.should include(:index)
-        v2._methods.keys.should include(:index)
-        subject._methods[:index].should_not eq(v2._methods[:index])
+        expect(subject._methods.keys).to include(:index)
+        expect(v2._methods.keys).to include(:index)
+        expect(subject._methods[:index]).not_to eq(v2._methods[:index])
       end
 
     end