feed_us_grabber 0.1.15 → 1.0.0

data/README.rdoc

@@ -1,4 +1,3 @@
-=begin
 = feed_us_grabber
 
 == ENVIRONEMNT
@@ -67,7 +66,7 @@ To clear cache goto following url
 * Clear entire cache
 	http://rails_app/FeedUsGrabber?cachecommand=clearall
 
-:Note that if you receive a failure message that your IP is not authorized to clear the cache, add your IP to the ClientWhiteList in your controller (replace 127.0.0.0 with your IP, visit http://whatismyip.com/)
+:Note that if you receive a failure message that your IP is not authorized to clear the cache, add your IP to the ClientWhiteList in your controller
 def index
 	@grabber = feedUsGrabber(:FeedUsURL => 'http://render.feed.us/Feed.aspx?g=00767d50-bde8-e111-9875-4040419a7f04', :ClientWhiteList => '127.0.0.1')
 end
@@ -90,6 +89,6 @@ end
 
 == Copyright
 
-Copyright (c) 2012 Cliff G. See LICENSE.txt for
+Copyright (c) 2013 Feed.Us See LICENSE.txt for
 further details.
-=end
+

data/lib/app/controllers/feed_us_grabber_controller.rb

@@ -10,71 +10,73 @@ class FeedUsGrabberController < ActionController::Base
 			# ! IMPORTANT: TO DISABLE THIS CHECK SET BOTH ARRAYS TO nil 
 			@mClientWhiteList = [ "75.126.108.226", "75.126.107.10", "127.0.0.1", "50.56.95.92" ]		
 			@mClientHostNameWhileList = [ "app.feed.us", "request.feed.us", "feed.us", "classic.syndication.feed.us", "render.feed.us", "dev.feed.us", "stage.feed.us", "localhost"]  
-			@mClientIp
+			@mClientIp = ""			
 		end
 
-		args = {}
-
+		@mArgs = {}
+		
 		# URL that will be checked for connectivity before clearing the cache (phone home)
-		args[:FeedUsURL] = 'http://render.feed.us/grabberdefault.htm?phonehome=true'	 			
+		@mArgs[:FeedUsURL] = 'http://render.feed.us/grabberdefault.htm?phonehome=true'	 			
+		@mArgs[:DebugOutput] = ""
+		@mArgs[:Debug] = false
+		@mDebugLogger = FeedUsGrabber.new
 
 		unless params[:cachecommand].nil?
-			args[:CacheCommand] = params[:cachecommand]
+			@mArgs[:CacheCommand] = params[:cachecommand]
 		end
 		unless params[:group].nil?
-			args[:FeedUsCacheGroup] = params[:group]
+			@mArgs[:FeedUsCacheGroup] = params[:group]
 		end
-		args[:DebugOutput] = ""
-		args[:Debug] = false
+		
 		unless params[:debug].nil?
-			args[:Debug] = params[:debug] == "1"
+			@mArgs[:Debug] = params[:debug] == "1"
 		end	  
 
-		if args[:FeedUsCacheGroup]  && args[:CacheCommand].nil?
-			args[:CacheCommand] = 'clear'
+		if @mArgs[:FeedUsCacheGroup]  && @mArgs[:CacheCommand].nil?
+			@mArgs[:CacheCommand] = 'clear'
 		end
     
-		if args[:CacheCommand].nil?
-		  args[:CacheCommand] = 'clearall'
+		if @mArgs[:CacheCommand].nil?
+		  @mArgs[:CacheCommand] = 'clearall'
 		end
 		
-		if args[:CacheCommand] == 'clear' && args[:FeedUsCacheGroup]
+		if @mArgs[:CacheCommand] == 'clear' && @mArgs[:FeedUsCacheGroup]
 		  fetch = true
 		else
 		  fetch = false
 		end
-		if args[:CacheCommand] == 'clearall' || args[:CacheCommand] == CACHE_COMMAND_FORCE
+		if @mArgs[:CacheCommand] == 'clearall' || @mArgs[:CacheCommand] == CACHE_COMMAND_FORCE
 		  fetch = true
 		end
 		
 		# Client ip check
-		isPermittedToProceed = IsPermittedToProceed(args)
+		isPermitted = IsPermittedToProceed()
 		
 		renderText = ""
-		if isPermittedToProceed == false
-			renderText = "<img src=\"http://feed.us/images/feedus_logo_people.png\"><br />
-					<p style=\"font-family:arial;\"> IP " + @mClientIp + " is not authorized.  Modify the feed_us_grabber_controller @mClientWhiteList array if this IP should have access. "				
-		else	
+		if @mArgs[:Debug] == true && isPermitted
+			renderText << @mArgs[:DebugOutput]					
+		end
+
+		if isPermitted
 			if fetch == true 
-				feedUsGrabber(args)
-				renderText = "<img src=\"http://feed.us/images/feedus_logo_people.png\"><br />
+				grabber = feedUsGrabber(@mArgs)
+				renderText << grabber.getDebugOutput
+				renderText << "<img src=\"http://feed.us/images/feedus_logo_people.png\"><br />
 				<p style=\"font-family:arial;\">Congratulations!  You have successfully refreshed your content.</p>
 				<p style=\"font-family:arial;\"><a href=\"/\">Home</a></p> "
 			else
-				renderText = "<img src=\"http://feed.us/images/feedus_logo_people.png\"><br />
+				renderText << "<img src=\"http://feed.us/images/feedus_logo_people.png\"><br />
 				<p style=\"font-family:arial;\"> Please specify cachecommand=clear&group=GROUPNAME or cachecommand=clearall or cachecommand=force_clear_all in the URL</p> "
-			end
-		end
-		
-		if args[:Debug] == true
-			renderText << args[:DebugOutput]
-			renderText << @mClientWhiteList.to_s	
+			end					
+		else	
+			renderText << "<img src=\"http://feed.us/images/feedus_logo_people.png\"><br />
+					<p style=\"font-family:arial;\"> IP " + @mClientIp + " is not authorized.  Modify the feed_us_grabber_controller @mClientWhiteList array if this IP should have access. "				
 		end
-		
+					
 		render :text=> renderText
 	end
 	
-	def IsPermittedToProceed(args)			
+	def IsPermittedToProceed			
 		isPermitted = false
 		@mClientIp = request.remote_addr	
 		
@@ -82,7 +84,7 @@ class FeedUsGrabberController < ActionController::Base
 			@mClientIp = request.env["HTTP_X_FORWARDED_FOR"]
 		end
 				
-		isPermitted = IsClientIpInWhiteList(args)
+		isPermitted = IsClientIpInWhiteList()
 		
 		if isPermitted == false
 			if @mClientHostNameWhileList.nil? == false
@@ -90,7 +92,7 @@ class FeedUsGrabberController < ActionController::Base
 				begin
 					s = Socket.getaddrinfo(@mClientIp,nil)
 					host = s[0][2]
-					puts "Trace: host = #{host}"						
+					AddToDebugOutput("Host is #{host}")										
 					if @mClientHostNameWhileList.include?(host) == true
 						isPermitted = true
 					end
@@ -106,25 +108,17 @@ class FeedUsGrabberController < ActionController::Base
 			if @mClientIp == "" || @mClientIp.nil?
 				@mClientIp = request.env["X-Forwarded-For"]
 			end			
-			isPermitted = IsClientIpInWhiteList(args)
-			puts "Trace: Try to use fwd header = #{@mClientIp}"	
-			puts "Trace: using fwd header isPermitted = #{isPermitted}"	
-		end
-		
-		# Set the Debug flag - do not want to output Debug info if not permitted
-		if isPermitted == false
-			args[:Debug] = false
+			isPermitted = IsClientIpInWhiteList()
+			AddToDebugOutput("Trying to use X-Forwarded-For #{@mClientIp}")			
 		end
-		
-		puts "Trace: mClientIp = #{@mClientIp}"		
-		puts "Trace: returning is permitted true"
-		args[:DebugOutput] << "Debug: mClientIp = #{@mClientIp}"
+				
+		AddToDebugOutput("Results of is permitted check = #{isPermitted.to_s} for IP #{@mClientIp}")
 
-		return isPermitted
+		isPermitted
 	end
 	
-	def IsClientIpInWhiteList(args)
-		included = false		
+	def IsClientIpInWhiteList
+		included = false			
 		if @mClientWhiteList.nil? && @mClientHostNameWhileList.nil?
 			included = true
 		else	
@@ -134,10 +128,16 @@ class FeedUsGrabberController < ActionController::Base
 				@mClientWhiteList.push(configuredClientWhiteList)
 			end
 
+			AddToDebugOutput("Checking if IP #{@mClientIp} is in ClientWhiteList #{@mClientWhiteList.to_s}")	
+
 			if @mClientWhiteList.nil? == false && @mClientWhiteList.include?(@mClientIp) == true
 				included = true
 			end
 		end
 		return included
 	end
+
+	def AddToDebugOutput(info)
+		@mDebugLogger.addToDebugOutput(@mArgs[:DebugOutput], info)		
+	end
 end

data/lib/app/helpers/feed_us_grabber_helper.rb

@@ -37,5 +37,5 @@ module FeedUsGrabberHelper
 
   def feedUsGrabberRender(grabber)
     grabber.renderCacheFromFile.to_s.html_safe
-  end
+  end  
 end

data/lib/app/models/feed_us_grabber.rb

@@ -18,6 +18,7 @@ class FeedUsGrabber
 		@mstrCacheGroup = ""
 		@mstrStateFile = File.join(Rails.root.to_s,'tmp','FeedUsGrabberState')
 		@mstrClientWhiteList = ""
+		@mstrDebugOutput = ""
 	end
 
 	def setCacheGroup(param)
@@ -91,6 +92,14 @@ class FeedUsGrabber
 		@mstrClientWhiteList
 	end
 
+	def setDebugOutput(param)
+		@mstrDebugOutput = param
+	end
+
+	def getDebugOutput
+		@mstrDebugOutput
+	end
+
 	def getDynURL
 		@mstrDynURL
 	end
@@ -122,12 +131,12 @@ class FeedUsGrabber
 	end
 
 	def autoCacheToFile
-		puts "trace: start autoCacheToFile.  bIsPostBack = #{@bIsPostBack}"
+		appendDebugOutput("Start autoCacheToFile.  bIsPostBack = #{@bIsPostBack}")		
 		if @bIsPostBack
 			return
 		end
 
-		puts "trace: mstrCacheCommand = #{@mstrCacheCommand}"
+		appendDebugOutput("Cache command received = #{@mstrCacheCommand}")			
 		if @mstrCacheCommand.nil? || @mstrCacheCommand == ''
 			if (!self.cachedFileExists) or self.cacheFileIsExpired
 				self.createCacheFile
@@ -295,8 +304,8 @@ class FeedUsGrabber
 	end
 
 	def clearAllCachedFiles
-		# For testing heroku logging
-		puts "Trace: Clearing all caches at path = #{@mstrCacheFolder}"
+		# For testing heroku logging		
+		appendDebugOutput("Clearing all caches at path = #{@mstrCacheFolder}")			
 		logfile = File.open(File.join(Rails.root.to_s,'log','FeedUsGrabber.log'),'a');
 		grabber_logger = FeedUsGrabberLogger.new(logfile)
 		grabber_logger.info("Clearing all caches at path #{@mstrCacheFolder}")
@@ -308,7 +317,7 @@ class FeedUsGrabber
 		canConnect = canConnectToFeedUs()
 
 		if canConnect == true
-			puts "Trace: clear cache folder can connect"
+			appendDebugOutput("Clear cache folder can connect")						
 			FileUtils.rm_r Dir.glob("#{folder}/*")
 		else
 			logError("Unable to connect to Feed.Us. Cache will not be cleared. URL that was checked: #{@mstrDynURL}")
@@ -343,4 +352,14 @@ class FeedUsGrabber
 		logfile.close
 	end
 
+	def addToDebugOutput(debugOutput, info)	    
+	    debugOutput << info + "<br />"
+	    puts " Debug Trace -> " + info
+	end
+
+	private
+
+		def appendDebugOutput(info)		
+			self.addToDebugOutput(@mstrDebugOutput, info)
+		end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feed_us_grabber
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -124,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -873202771
+      hash: 39973683
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: