Fixed issue with secret token not being saved if DB does not exist.

Author: steveyken

lib/fat_free_crm/secret_token_generator.rb

@@ -16,17 +16,19 @@ class << self
       # If there is no secret token defined, we generate one and save it as a setting
       # If a token has been already been saved, we tell Rails to use it and move on.
       def setup!
-        if token.blank?
+        if !token_exists?
           Rails.logger.info("No secret key defined yet... generating and saving to Setting.secret_token")
-          generate_and_persist_token!
+          new_token!
         end
-        FatFreeCRM::Application.config.secret_token = token
-        raise(FAIL_MESSAGE) if FatFreeCRM::Application.config.secret_token.blank?# and !Rails.env.test?
+        # If db isn't setup yet, token will return nil, provide a randomly generated one for now.
+        FatFreeCRM::Application.config.secret_token = ( token || generate_token )
       end
 
       private
 
-      FAIL_MESSAGE = ::I18n.t('secret_token_generator.fail_message', default: "There was a problem generating the secret token. Please see lib/fat_free_crm/secret_token_generator.rb")
+      def token_exists?
+        Setting.secret_token.present?
+      end
 
       #
       # Read the current token from settings
@@ -36,12 +38,16 @@ def token
 
       #
       # Create a new secret token and save it as a setting.
-      def generate_and_persist_token!
+      def new_token!
         quietly do
-          Setting.secret_token = SecureRandom.hex(64)
+          Setting.secret_token = generate_token
         end
       end
 
+      def generate_token
+        SecureRandom.hex(64)
+      end
+
       #
       # Yields to a block that executes with the logging turned off
       # This stops the secret token from being appended to the log

spec/lib/secret_token_generator_spec.rb

@@ -13,41 +13,65 @@
 
   describe "setup!" do
 
-    it "should not generate a token if one already exists" do
-      FatFreeCRM::SecretTokenGenerator.stub(:token).and_return(nil)
-      expect(FatFreeCRM::SecretTokenGenerator).to receive(:generate_and_persist_token!)
-      FatFreeCRM::Application.config.stub(:secret_token).and_return(token)
+    it "should not generate a new token if one exists" do
+      FatFreeCRM::SecretTokenGenerator.stub(:token_exists?).and_return(true)
+      FatFreeCRM::SecretTokenGenerator.should_not_receive(:new_token!)
       FatFreeCRM::SecretTokenGenerator.setup!
     end
 
-    it "should generate a token if none exists already" do
-      FatFreeCRM::SecretTokenGenerator.stub(:token).and_return(token)
-      expect(FatFreeCRM::SecretTokenGenerator).not_to receive(:generate_and_persist_token!)
+    it "should generate a token if none exists" do
+      FatFreeCRM::SecretTokenGenerator.stub(:token_exists?).and_return(false)
+      FatFreeCRM::SecretTokenGenerator.should_receive(:new_token!)
       FatFreeCRM::SecretTokenGenerator.setup!
     end
 
-    it "should raise an error if the token is still blank (should never happen)" do
-      FatFreeCRM::SecretTokenGenerator.stub(:token).and_return(nil)
-      lambda { FatFreeCRM::SecretTokenGenerator.setup! }.should raise_error(RuntimeError)
+    it "should generate a random token if not persisted" do
+      FatFreeCRM::SecretTokenGenerator.stub(:token_exists?).and_return(false)
+      FatFreeCRM::SecretTokenGenerator.stub(:new_token)
+      FatFreeCRM::SecretTokenGenerator.should_receive(:generate_token).exactly(:twice)
+      FatFreeCRM::SecretTokenGenerator.setup!
+    end
+
+  end
+
+  describe "token_exists?" do
+
+    it "should be true" do
+      Setting.stub(:secret_token).and_return(token)
+      FatFreeCRM::SecretTokenGenerator.send(:token_exists?).should eql(true)
+    end
+
+    it "should be false" do
+      Setting.stub(:secret_token).and_return(nil)
+      FatFreeCRM::SecretTokenGenerator.send(:token_exists?).should eql(false)
     end
 
   end
 
   describe "token" do
 
     it "should delegate to Setting" do
-      expect(Setting).to receive(:secret_token).and_return(token)
-      expect(FatFreeCRM::SecretTokenGenerator.send(:token)).to eql(token)
+      Setting.should_receive(:secret_token).and_return(token)
+      FatFreeCRM::SecretTokenGenerator.send(:token).should eql(token)
+    end
+
+  end
+
+  describe "new_token!" do
+
+    it "should generate and set a new token" do
+      FatFreeCRM::SecretTokenGenerator.should_receive(:generate_token).and_return(token)
+      Setting.should_receive(:secret_token=).with(token)
+      FatFreeCRM::SecretTokenGenerator.send(:new_token!)
     end
 
   end
 
-  describe "generate_and_persist_token!" do
+  describe "generate_token!" do
 
     it "should generate a random token" do
-      expect(SecureRandom).to receive(:hex).with(64).and_return(token)
-      expect(Setting).to receive(:secret_token=).with(token)
-      FatFreeCRM::SecretTokenGenerator.send(:generate_and_persist_token!)
+      SecureRandom.should_receive(:hex).with(64).and_return(token)
+      FatFreeCRM::SecretTokenGenerator.send(:generate_token)
     end
 
   end