Update documentation visibility of private methods

Now that we're allowing yard to document private methods, we need to be
explicit about what we do not wish to be public api by tagging it.

Author: derekprior

.yardopts

@@ -1,3 +1,4 @@
+--protected
 --private
 --hide-api private
 --exclude templates

lib/clearance/authentication.rb

@@ -105,7 +105,7 @@ def handle_unverified_request
 
     protected
 
-    # @private
+    # @api private
     def clearance_session
       request.env[:clearance]
     end

lib/clearance/authorization.rb

@@ -58,7 +58,7 @@ def deny_access(flash_message = nil)
 
     protected
 
-    # @private
+    # @api private
     def redirect_request(flash_message)
       store_location
 
@@ -73,46 +73,48 @@ def redirect_request(flash_message)
       end
     end
 
-    # @private
+    # @api private
     def clear_return_to
       session[:return_to] = nil
     end
 
-    # @private
+    # @api private
     def store_location
       if request.get?
         session[:return_to] = request.original_fullpath
       end
     end
 
-    # @private
+    # @api private
     def redirect_back_or(default)
       redirect_to(return_to || default)
       clear_return_to
     end
 
-    # @private
+    # @api private
     def return_to
       if return_to_url
         uri = URI.parse(return_to_url)
         "#{uri.path}?#{uri.query}".chomp('?')
       end
     end
 
-    # @private
+    # @api private
     def return_to_url
       session[:return_to]
     end
 
     # Used as the redirect location when {#deny_access} is called and there is a
     # currently signed in user.
+    #
     # @return [String]
     def url_after_denied_access_when_signed_in
       Clearance.configuration.redirect_url
     end
 
     # Used as the redirect location when {#deny_access} is called and there is
     # no currently signed in user.
+    #
     # @return [String]
     def url_after_denied_access_when_signed_out
       sign_in_url

lib/clearance/back_door.rb

@@ -29,6 +29,7 @@ def call(env)
 
     private
 
+    # @api private
     def sign_in_through_the_back_door(env)
       params = Rack::Utils.parse_query(env['QUERY_STRING'])
       user_id = params['as']

lib/clearance/configuration.rb

@@ -138,7 +138,8 @@ def routes_enabled?
     # This is called from the Clearance engine to reload the configured
     # user class during each request while in development mode, but only once
     # in production.
-    # @private
+    #
+    # @api private
     def reload_user_model
       if @user_model.present?
         @user_model = @user_model.to_s.constantize

lib/clearance/constraints/signed_in.rb

@@ -29,18 +29,22 @@ def matches?(request)
 
       private
 
+      # @api private
       def clearance_session
         @request.env[:clearance]
       end
 
+      # @api private
       def current_user
         clearance_session.current_user
       end
 
+      # @api private
       def current_user_fulfills_additional_requirements?
         @block.call current_user
       end
 
+      # @api private
       def signed_in?
         clearance_session.present? && clearance_session.signed_in?
       end

lib/clearance/constraints/signed_out.rb

@@ -18,10 +18,12 @@ def matches?(request)
 
       private
 
+      # @api private
       def clearance_session
         @request.env[:clearance]
       end
 
+      # @api private
       def missing_session?
         clearance_session.nil?
       end

lib/clearance/password_strategies/bcrypt.rb

@@ -25,10 +25,12 @@ def password=(new_password)
 
       private
 
+      # @api private
       def encrypt(password)
         ::BCrypt::Password.create(password, cost: cost)
       end
 
+      # @api private
       def cost
         if test_environment?
           ::BCrypt::Engine::MIN_COST
@@ -37,6 +39,7 @@ def cost
         end
       end
 
+      # @api private
       def test_environment?
         defined?(::Rails) && ::Rails.env.test?
       end

lib/clearance/password_strategies/bcrypt_migration_from_sha1.rb

@@ -9,6 +9,7 @@ module BCryptMigrationFromSHA1
         "strategy, add clearance-deprecated_password_strategies to your " \
         "Gemfile."
 
+      # @api private
       class BCryptUser
         include Clearance::PasswordStrategies::BCrypt
 
@@ -19,6 +20,7 @@ def initialize(user)
         delegate :encrypted_password, :encrypted_password=, to: :@user
       end
 
+      # @api private
       class SHA1User
         include Clearance::PasswordStrategies::SHA1
 
@@ -29,11 +31,15 @@ def initialize(user)
         delegate :salt, :salt=, :encrypted_password, :encrypted_password=, to: :@user
       end
 
+      # @deprecated Use {BCrypt} or `clearance-deprecated_password_strategies`
+      #   gem
       def authenticated?(password)
         warn "#{Kernel.caller.first}: #{DEPRECATION_MESSAGE}"
         authenticated_with_sha1?(password) || authenticated_with_bcrypt?(password)
       end
 
+      # @deprecated Use {BCrypt} or `clearance-deprecated_password_strategies`
+      #   gem
       def password=(new_password)
         warn "#{Kernel.caller.first}: #{DEPRECATION_MESSAGE}"
         @password = new_password
@@ -42,6 +48,7 @@ def password=(new_password)
 
       private
 
+      # @api private
       def authenticated_with_bcrypt?(password)
         begin
           BCryptUser.new(self).authenticated? password
@@ -50,6 +57,7 @@ def authenticated_with_bcrypt?(password)
         end
       end
 
+      # @api private
       def authenticated_with_sha1?(password)
         if sha1_password?
           if SHA1User.new(self).authenticated? password
@@ -60,6 +68,7 @@ def authenticated_with_sha1?(password)
         end
       end
 
+      # @api private
       def sha1_password?
         self.encrypted_password =~ /^[a-f0-9]{40}$/
       end

lib/clearance/password_strategies/blowfish.rb

@@ -11,11 +11,15 @@ module Blowfish
         "provide your own. To continue using this strategy add " \
         "clearance-deprecated_password_strategies to your Gemfile."
 
+      # @deprecated Use {BCrypt} or `clearance-deprecated_password_strategies`
+      #   gem
       def authenticated?(password)
         warn "#{Kernel.caller.first}: #{DEPRECATION_MESSAGE}"
         encrypted_password == encrypt(password)
       end
 
+      # @deprecated Use {BCrypt} or `clearance-deprecated_password_strategies`
+      #   gem
       def password=(new_password)
         warn "#{Kernel.caller.first}: #{DEPRECATION_MESSAGE}"
         @password = new_password
@@ -28,23 +32,27 @@ def password=(new_password)
 
       protected
 
+      # @api private
       def encrypt(string)
         generate_hash("--#{salt}--#{string}--")
       end
 
+      # @api private
       def generate_hash(string)
         cipher = OpenSSL::Cipher::Cipher.new('bf-cbc').encrypt
         cipher.key = Digest::SHA256.digest(salt)
         hash = cipher.update(string) << cipher.final
         Base64.encode64(hash).encode('utf-8')
       end
 
+      # @api private
       def initialize_salt_if_necessary
         if salt.blank?
           self.salt = generate_salt
         end
       end
 
+      # @api private
       def generate_salt
         Base64.encode64(SecureRandom.hex(20)).encode('utf-8')
       end