Rename is_authorized to authorize.

+ fixed tests and slightly changed implementation

Author: Pajk

README.rst

@@ -581,10 +581,8 @@ authenticate
   Pass a proc in order to authenticate user. Pass nil for
   no authentication (by default).
 
-is_authorized
-  Pass a proc in order to authorize controllers and methods. Don't set
-  to use the default authorize all. The Proc is evaluated in the controller
-  context.
+authorize
+  Pass a proc in order to authorize controllers and methods. The Proc is evaluated in the controller context.
 
 show_all_examples
   Set this to true to set show_in_doc=1 in all recorded examples
@@ -634,7 +632,7 @@ Example:
           username == "test" && password == "supersecretpassword"
        end
      end
-     config.is_authorized = Proc.new do |controller, method, doc|
+     config.authorize = Proc.new do |controller, method, doc|
        !method   # show all controller doc, but no method docs.
      end
    end
@@ -1107,7 +1105,7 @@ When you want to avoid any unnecessary computation in production mode,
 you can generate a cache with ``rake apipie:cache`` and configure the
 app to use it in production with ``config.use_cache = Rails.env.production?``
 
-Default cache dir is ``File.join(Rails.root, "public", "apipie-cache")``, 
+Default cache dir is ``File.join(Rails.root, "public", "apipie-cache")``,
 you can change it to where you want, example: ``config.cache_dir = File.join(Rails.root, "doc", "apidoc")``.
 
 If, for some complex cases, you need to generate/re-generate just part of the cache

app/controllers/apipie/apipies_controller.rb

@@ -33,7 +33,7 @@ def index
         I18n.locale = @language
         @doc = Apipie.to_json(params[:version], params[:resource], params[:method], @language)
 
-        @doc = authorize(@doc)
+        @doc = authorized_doc
 
         format.json do
           if @doc
@@ -92,16 +92,24 @@ def get_language
       lang
     end
 
-    def authorize document
-      document[:docs][:resources].select! do |k, v|
-        instance_exec(k, nil, v, &Apipie.configuration.authorized?)
-      end
-      document[:docs][:resources].each do |k, v|
-        v[:methods].select! do |h|
-          instance_exec(k, h[:name], h, &Apipie.configuration.authorized?)
+    def authorized_doc
+
+      return @doc unless Apipie.configuration.authorize
+
+      new_doc = { :docs => @doc[:docs].clone }
+
+      new_doc[:docs][:resources] = @doc[:docs][:resources].select do |k, v|
+        if instance_exec(k, nil, v, &Apipie.configuration.authorize)
+          v[:methods] = v[:methods].select do |h|
+            instance_exec(k, h[:name], h, &Apipie.configuration.authorize)
+          end
+          true
+        else
+          false
         end
       end
-      document
+
+      new_doc
     end
 
     def get_format

lib/apipie/configuration.rb

@@ -7,12 +7,11 @@ class Configuration
       :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, :is_authorized
+      :persist_show_in_doc, :authorize
 
     alias_method :validate?, :validate
     alias_method :required_by_default?, :required_by_default
     alias_method :namespaced_resources?, :namespaced_resources
-    alias_method :authorized?, :is_authorized
 
     # matcher to be used in Dir.glob to find controllers to be reloaded e.g.
     #
@@ -166,7 +165,6 @@ def initialize
       @translate = lambda { |str, locale| str }
       @persist_show_in_doc = false
       @routes_formatter = RoutesFormatter.new
-      @is_authorized = ->(controller, method, document) { true }
     end
   end
 end

spec/controllers/apipies_controller_spec.rb

@@ -144,29 +144,44 @@
   describe "authorize document" do
     it "if an authroize method is set" do
       test = false
-      Apipie.configuration.is_authorized = Proc.new do |controller, method, doc|
+      Apipie.configuration.authorize = Proc.new do |controller, method, doc|
         test = true
         true
       end
       get :index
-      test.should == true
+      expect(test).to eq(true)
     end
     it "remove all resources" do
-      Apipie.configuration.is_authorized = Proc.new do |&args|
+      Apipie.configuration.authorize = Proc.new do |&args|
         false
       end
       get :index
-      assigns(:doc)[:resources].should == {}
+      expect(assigns(:doc)[:resources]).to eq({})
     end
     it "remove all methods" do
-      Apipie.configuration.is_authorized = Proc.new do |controller, method, doc|
+      Apipie.configuration.authorize = Proc.new do |controller, method, doc|
         !method
       end
       get :index
-      pp assigns(:doc)
-      assigns(:doc)[:resources]["concern_resources"][:methods].should == []
-      assigns(:doc)[:resources]["twitter_example"][:methods].should == []
-      assigns(:doc)[:resources]["users"][:methods].should == []
+      expect(assigns(:doc)[:resources]["concern_resources"][:methods]).to eq([])
+      expect(assigns(:doc)[:resources]["twitter_example"][:methods]).to eq([])
+      expect(assigns(:doc)[:resources]["users"][:methods]).to eq([])
+    end
+    it "remove specific method" do
+      Apipie.configuration.authorize = nil
+      get :index
+
+      users_methods = assigns(:doc)[:resources]["users"][:methods].size
+      twitter_example_methods = assigns(:doc)[:resources]["twitter_example"][:methods].size
+
+      Apipie.configuration.authorize = Proc.new do |controller, method, doc|
+        controller == "users" ? method != "index" : true
+      end
+
+      get :index
+
+      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
   end