apipie-rails 0.0.22 → 0.0.23

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0

data/CHANGELOG

@@ -2,6 +2,14 @@
  Changelog
 ===========
 
+v0.0.23
+-------
+
+* fix exceptions on unknown validator
+* fix concerns substitution in parameters
+* possibility to authenticate the API doc
+* support for array in api_controllers_matcher
+
 v0.0.22
 -------
 

data/README.rst

@@ -492,7 +492,7 @@ reload_controllers
   Set to enable/disable reloading controllers (and the documentation with it), by default enabled in development.
 
 api_controllers_matcher
-  For reloading to work properly you need to specify where your API controllers are.
+  For reloading to work properly you need to specify where your API controllers are. Can be an array if multiple paths are needed
 
 markup
   You can choose markup language for descriptions of your application,
@@ -517,6 +517,9 @@ namespaced_resources
   Use controller paths instead of controller names as resource id.
   This prevents same named controllers overwriting each other.
 
+authenticate
+  Pass a proc in order to authenticate user. Pass nil for
+  no authentication (by default).
 
 Example:
 
@@ -535,6 +538,11 @@ Example:
        This is where you can inform user about your application and API
        in general.
      ", '1.0'
+     config.authenticate = Proc.new do
+        authenticate_or_request_with_http_basic do |username, password|
+          username == "test" && password == "supersecretpassword"
+       end 
+     end
    end
 
 

data/app/controllers/apipie/apipies_controller.rb

@@ -3,6 +3,13 @@ module Apipie
     layout Apipie.configuration.layout
 
     around_filter :set_script_name
+    before_filter :authenticate
+
+    def authenticate
+      if Apipie.configuration.authenticate
+        instance_eval(&Apipie.configuration.authenticate)
+      end
+    end
 
     def index
 

data/lib/apipie/application.rb

@@ -251,7 +251,7 @@ module Apipie
     end
 
     def api_controllers_paths
-      Dir[Apipie.configuration.api_controllers_matcher]
+      Dir.glob(Apipie.configuration.api_controllers_matcher)
     end
 
     def reload_documentation

data/lib/apipie/configuration.rb

@@ -4,7 +4,7 @@ module Apipie
     attr_accessor :app_name, :app_info, :copyright, :markup, :disqus_shortname,
       :api_base_url, :doc_base_url, :required_by_default, :layout,
       :default_version, :debug, :version_in_url, :namespaced_resources,
-      :validate, :validate_value, :validate_presence
+      :validate, :validate_value, :validate_presence, :authenticate
 
 
     alias_method :validate?, :validate

data/lib/apipie/param_description.rb

@@ -51,11 +51,9 @@ module Apipie
 
       action_awareness
 
-      @validator = nil
-      unless validator.nil?
-        @validator =
-          Validator::BaseValidator.find(self, validator, @options, block)
-        raise "Validator not found." unless validator
+      if validator
+        @validator = Validator::BaseValidator.find(self, validator, @options, block)
+        raise "Validator for #{validator} not found." unless @validator
       end
     end
 
@@ -180,16 +178,16 @@ module Apipie
     end
 
     def concern_subst(string)
-      return if string.nil?
+      return string if string.nil? or !method_description.from_concern?
+
       original = string
-      if method_description.from_concern?
-        string = ":#{original}" if original.is_a? Symbol
-        ret = method_description.resource.controller._apipie_perform_concern_subst(string)
-        ret = ret.to_sym if original.is_a? Symbol
-        ret
-      else
-        string
-      end
+      string = ":#{original}" if original.is_a? Symbol
+
+      replaced = method_description.resource.controller._apipie_perform_concern_subst(string)
+
+      return original if replaced == string
+      return replaced.to_sym if original.is_a? Symbol
+      return replaced
     end
 
   end

data/lib/apipie/static_dispatcher.rb

@@ -34,7 +34,7 @@ module Apipie
   end
 
   class StaticDispatcher
-    # Dispatches the statis files. Simillar to ActionDispatch::Static, but
+    # Dispatches the static files. Similar to ActionDispatch::Static, but
     # it supports different baseurl configurations
     def initialize(app, path, baseurl)
       @app = app

data/lib/apipie/validator.rb

@@ -98,6 +98,8 @@ module Apipie
       def expected_type
         if @type.ancestors.include? Hash
           'hash'
+        elsif @type.ancestors.include? Array
+          'array'
         elsif @type.ancestors.include? Numeric
           'numeric'
         else

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.0.22'
+  VERSION = '0.0.23'
 end

data/spec/controllers/apipies_controller_spec.rb

@@ -95,6 +95,17 @@ describe Apipie::ApipiesController do
     end
   end
 
+  describe "authenticate user" do
+    it "authenticate user if an authentication method is setted" do
+      test = false
+      Apipie.configuration.authenticate = Proc.new do
+        test = true
+      end
+      get :index
+      test.should == true
+    end
+  end
+
   describe "documentation cache" do
 
     let(:cache_dir) { File.join(Rails.root, "tmp", "apipie-cache") }

data/spec/dummy/app/controllers/concerns_controller.rb

@@ -2,7 +2,7 @@ class ConcernsController < ApplicationController
 
   resource_description { resource_id 'concern_resources' }
 
-  apipie_concern_subst(:concern => 'user', :custom_subst => 'custom')
+  apipie_concern_subst(:concern => 'user', :custom_subst => 'custom', 'string_subst' => 'string')
   include ::Concerns::SampleController
 
 end

data/spec/lib/application_spec.rb

@@ -2,6 +2,17 @@ require "spec_helper"
 
 describe Apipie::Application do
 
+  describe "api_controllers_paths" do
+    before { Apipie.configuration.api_controllers_matcher = [File.join(Rails.root, "app", "controllers", "**","*.rb"), File.join(Rails.root, "lib", "**","*.rb")] }
+
+    it "should support receiving array as parameter" do
+      expect { Apipie.api_controllers_paths}.
+        not_to raise_error
+    end
+
+
+  end
+
   describe "get_resource_name" do
     subject {Apipie.get_resource_name(Api::V2::Nested::ArchitecturesController)}
 

data/spec/lib/param_description_spec.rb

@@ -12,6 +12,63 @@ describe Apipie::ParamDescription do
     Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
   end
 
+  describe "validator selection" do
+
+    it "should allow nil validator" do
+      param = Apipie::ParamDescription.new(method_desc, :hidden_param, nil)
+      param.validator.should be_nil
+    end
+
+    it "should throw exception on unknown validator" do
+      proc { Apipie::ParamDescription.new(method_desc, :param, :unknown) }.should raise_error(RuntimeError, /Validator.*not found/)
+    end
+
+    it "should pick type validator" do
+      Apipie::Validator::BaseValidator.should receive(:find).and_return(:validator_instance)
+      param = Apipie::ParamDescription.new(method_desc, :param, String)
+      param.validator.should == :validator_instance
+    end
+
+  end
+
+  describe "concern substitution" do
+
+    let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }
+
+    let(:concern_resource_desc) do
+      Apipie::ResourceDescription.new(ConcernsController, "concerns")
+    end
+
+    let(:concern_method_desc) do
+      Apipie::MethodDescription.new(:show, concern_resource_desc, concern_dsl_data)
+    end
+
+    it "should replace string parameter name with colon prefix" do
+      param = Apipie::ParamDescription.new(concern_method_desc, ":string_subst", String)
+      param.name.should == "string"
+    end
+
+    it "should replace symbol parameter name" do
+      param = Apipie::ParamDescription.new(concern_method_desc, :concern, String)
+      param.name.should == :user
+    end
+
+    it "should keep original value for strings without colon prefixes" do
+      param = Apipie::ParamDescription.new(concern_method_desc, "string_subst", String)
+      param.name.should == "string_subst"
+    end
+
+    it "should keep the original value when a string can't be replaced" do
+      param = Apipie::ParamDescription.new(concern_method_desc, ":param", String)
+      param.name.should == ":param"
+    end
+
+    it "should keep the original value when a symbol can't be replaced" do
+      param = Apipie::ParamDescription.new(concern_method_desc, :param, String)
+      param.name.should == :param
+    end
+  end
+
 
   describe "required_by_default config option" do
     context "parameters required by default" do

data/spec/lib/validator_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+describe Apipie::Validator do
+
+  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }
+
+  let(:resource_desc) do
+    Apipie::ResourceDescription.new(UsersController, "users")
+  end
+
+  let(:method_desc) do
+    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+  end
+
+  let(:params_desc) do
+    Apipie::ParamDescription.new(method_desc, :param, nil)
+  end
+
+  describe 'TypeValidator' do
+
+    context "expected type" do
+
+      it "should return hash for type Hash" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Hash)
+        validator.expected_type.should == 'hash'
+      end
+
+      it "should return array for type Array" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Array)
+        validator.expected_type.should == 'array'
+      end
+
+      it "should return numeric for type Numeric" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Numeric)
+        validator.expected_type.should == 'numeric'
+      end
+
+      it "should return string by default" do
+        validator = Apipie::Validator::TypeValidator.new(params_desc, Symbol)
+        validator.expected_type.should == 'string'
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-12 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -249,6 +249,7 @@ files:
 - spec/lib/param_description_spec.rb
 - spec/lib/param_group_spec.rb
 - spec/lib/resource_description_spec.rb
+- spec/lib/validator_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/Pajk/apipie-rails
 licenses: []
@@ -330,4 +331,5 @@ test_files:
 - spec/lib/param_description_spec.rb
 - spec/lib/param_group_spec.rb
 - spec/lib/resource_description_spec.rb
+- spec/lib/validator_spec.rb
 - spec/spec_helper.rb