watson-ruby 1.0.0

data/lib/watson/printer.rb

@@ -0,0 +1,293 @@
+module Watson
+		
+		# Color definitions for pretty printing
+		# Defined here because we need Global scope but makes sense to have them
+		# in the printer.rb file at least
+
+		BOLD  		= "\e[01m"
+		UNDERLINE 	= "\e[4m"
+		RESET 		= "\e[00m"
+
+		GRAY	= "\e[38;5;0m"
+		RED		= "\e[38;5;1m"
+		GREEN	= "\e[38;5;2m"
+		YELLOW	= "\e[38;5;3m"
+		BLUE 	= "\e[38;5;4m"
+		MAGENTA	= "\e[38;5;5m"
+		CYAN	= "\e[38;5;6m"
+		WHITE	= "\e[38;5;7m"
+
+
+	# Printer class that handles all formatting and printing of parsed dir/file structure
+	class Printer
+		# [review] - Not sure if the way static methods are defined is correct
+		#			 Ok to have same name as instance methods?
+		#			 Only difference is where the output gets printed to
+		# [review] - No real setup in initialize method, combine it and run method?
+
+		# Include for debug_print (for class methods)
+		include Watson
+
+		# Debug printing for this class
+		DEBUG = false 		
+
+		class << self
+	
+		# Include for debug_print (for static methods)
+		include Watson
+
+		###########################################################
+		# Custom color print for static call (only writes to STDOUT)   
+		def cprint (msg = "", color = "")
+
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+		
+			# This little check will allow us to take a Constant defined color
+			# As well as a [0-256] value if specified
+			if (color.is_a?(String))	
+				debug_print "Custom color specified for cprint\n"
+				STDOUT.write(color)
+			elsif (color.between?(0, 256))
+				debug_print "No or Default color specified for cprint\n"
+				STDOUT.write("\e[38;5;#{ color }m")
+			end
+		
+			STDOUT.write(msg)
+		end
+
+
+		###########################################################
+		# Standard header print for static call (uses static cprint) 
+		def print_header 
+		
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+
+			# Header
+			cprint BOLD + "------------------------------\n" + RESET
+			cprint BOLD + "watson" + RESET
+			cprint " - " + RESET
+			cprint BOLD + YELLOW + "inline issue manager\n" + RESET
+			cprint BOLD + "------------------------------\n\n" + RESET
+
+			return true
+		end
+
+
+		###########################################################
+		# Status printer for static call (uses static cprint) 
+		# Print status block in standard format
+		def print_status(msg, color) 
+			cprint RESET + BOLD
+			cprint WHITE + "[ "
+			cprint "#{ msg } ", color
+			cprint WHITE + "] " + RESET
+		end
+
+		end
+
+		###########################################################
+		# Printer initialization method to setup necessary parameters, states, and vars
+		def initialize(config)
+
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+			
+			@config = config
+			return true
+		end	
+
+		
+		###########################################################
+		# Take parsed structure and print out in specified formatting 
+		def run(structure)
+
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+		
+			# Check Config to see if we have access to less for printing
+			# If so, open our temp file as the output to write to
+			# Else, just print out to STDOUT
+			if @config.use_less
+				debug_print "Unix less avaliable, setting output to #{ @config.tmp_file }\n"
+				@output = File.open(@config.tmp_file, 'w')
+			elsif
+				debug_print "Unix less is unavaliable, setting output to STDOUT\n"
+				@output = STDOUT
+			end	
+			
+			# Print header for output
+			debug_print "Printing Header\n"
+			print_header
+
+			# Print out structure that was passed to this Printer
+			debug_print "Starting structure printing\n"
+			print_structure(structure)
+
+			# If we are using less, close the output file, display with less, then delete
+			if @config.use_less
+				@output.close
+				# [review] - Way of calling a native Ruby less?
+				system("less #{ @config.tmp_file }")
+				debug_print "File displayed with less, now deleting...\n"
+				File.delete(@config.tmp_file)
+			end
+
+			return true
+		end
+
+
+		###########################################################
+		# Custom color print for member call
+		# Allows not only for custom color printing but writing to file vs STDOUT
+		def cprint (msg = "", color = "")
+
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+
+			# This little check will allow us to take a Constant defined color
+			# As well as a [0-256] value if specified
+			if (color.is_a?(String))	
+				debug_print "Custom color specified for cprint\n"
+				@output.write(color)
+			elsif (color.between?(0, 256))
+				debug_print "No or Default color specified for cprint\n"
+				@output.write("\e[38;5;#{ color }m")
+			end
+
+			@output.write(msg)
+		end
+
+	
+		###########################################################
+		# Standard header print for class call (uses member cprint)
+		def print_header 
+			# Identify method entry
+
+			debug_print "#{ self } : #{ __method__ }\n"
+
+			# Header
+			cprint BOLD + "------------------------------\n" + RESET
+			cprint BOLD + "watson" + RESET
+			cprint " - " + RESET
+			cprint BOLD + YELLOW + "inline issue manager\n\n" + RESET
+			cprint "Run in: #{ Dir.pwd }\n"
+			cprint "Run @ #{ Time.now.asctime }\n"
+			cprint BOLD + "------------------------------\n\n" + RESET
+
+			return true
+		end
+
+
+		###########################################################
+		# Status printer for member call (uses member cprint)
+		# Print status block in standard format
+		def print_status(msg, color) 
+			cprint RESET + BOLD
+			cprint WHITE + "[ "
+			cprint "#{ msg } ", color
+			cprint WHITE + "] " + RESET
+		end
+
+
+		###########################################################
+		# Go through all files and directories and call necessary printing methods
+		# Print all individual entries, call print_structure on each subdir  
+		def print_structure(structure)
+
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+
+			# First go through all the files in the current structure
+			# The current "structure" should reflect a dir/subdir
+			structure[:files].each do | _file |
+				debug_print "Printing info for #{ _file }\n"
+				print_entry(_file)
+			end
+
+			# Next go through all the subdirs and pass them to print_structure
+			structure[:subdirs].each do | _subdir |
+				debug_print "Entering #{ _subdir } to print further\n"
+				print_structure(_subdir)
+			end
+		end
+
+
+		###########################################################
+		# Individual entry printer
+		# Uses issue hash to format printed output
+		def print_entry(entry)
+
+			# Identify method entry
+			debug_print "#{ self } : #{ __method__ }\n"
+
+			# If no issues for this file, print that and break
+			# The filename print is repetative, but reduces another check later
+			if entry[:has_issues] == false
+				debug_print "No issues for #{ entry }\n"
+				print_status "o", GREEN
+				cprint BOLD + UNDERLINE + GREEN + "#{ entry[:relative_path] }" + RESET + "\n"
+				return true
+			else
+				debug_print "Issues found for #{ entry }\n"
+				cprint "\n"
+				print_status "x", RED
+				cprint BOLD + UNDERLINE + RED + "#{entry[:relative_path]}" + RESET + "\n"
+			end	
+
+	
+			# [review] - Should the tag structure be self contained in the hash
+			#			 Or is it ok to reference @config to figure out the tags
+			@config.tag_list.each do | _tag |
+				debug_print "Checking for #{ _tag }\n"
+
+				# [review] - Better way to ignore tags through structure (hash) data
+				# Maybe have individual has_issues for each one?
+				if entry[_tag].size.zero?
+					debug_print "#{ _tag } has no issues, skipping\n"
+					cprint "\n"
+					next
+				end
+				
+				debug_print "#{ _tag } has issues in it, print!\n"
+				print_status "#{ _tag }", BLUE
+				cprint "\n"
+
+				# Go through each issue in tag
+				entry[_tag].each do | _issue |
+					cprint WHITE + "  line #{ _issue[:line_number] } - " + RESET
+					cprint BOLD + "#{ _issue[:title] }" + RESET
+
+
+					# Check to see if it has been resolved on GitHub/Bitbucket
+					debug_print "Checking if issue has been resolved\n"	
+					@config.github_issues[:closed].each do | _closed | 
+						if _closed["body"].include?(_issue[:md5])
+							debug_print "Found in #{ _closed[:comment] }, not posting\n"
+							cprint BOLD + " [" + RESET
+							cprint GREEN + BOLD + "Resolved on GitHub" + RESET
+							cprint BOLD + "]" + RESET
+						end
+						debug_print "Did not find in #{ _closed[:comment] }\n"
+					end	
+
+					debug_print "Checking if issue has been resolved\n"
+					@config.bitbucket_issues[:closed].each do  | _closed | 
+						if _closed["content"].include?(_issue[:md5])
+							debug_print "Found in #{ _closed["content"] }, not posting\n"
+							cprint BOLD + " [" + RESET
+							cprint GREEN + BOLD + "Resolved on Bitbucket" + RESET
+							cprint BOLD + "]\n" + RESET
+						end
+						debug_print "Did not find in #{ _closed["title"] }\n"
+					end
+					cprint "\n"
+
+				end
+				cprint "\n"
+			end
+		end
+	
+	end
+end 

data/lib/watson/remote.rb

@@ -0,0 +1,120 @@
+module Watson
+	# Remote class that handles all remote HTTP calls to Bitbucket and GitHub	
+	class Remote
+
+		# Debug printing for this class
+		DEBUG = false 		
+	
+		class << self
+		
+		# Include for debug_print
+		include Watson
+
+		# Required libs		
+		require 'net/https'
+		require 'uri'
+		require 'json'
+	
+	
+		# Default options hash for http_call
+		# Will get merged with input argument hash to maintain defaults	
+		HTTP_opts = {
+	  	  :url 		  => nil,			#--> URL of endpoint [String]
+	   	  :ssl		  => false,			#--> Use SSL in connection (HTTPS) (True/False]
+	 	  :method 	  => nil,			#--> GET or POST for respective HTTP method [String]
+	  	  :basic_auth => Array.new(0),	#--> Array of username and pw to use for basic authentication
+                                		#    If empty, assume no user authentication [Array]
+		  :auth 	  => nil,			#--> Authentication token [String]
+		  :data 	  => nil,			#--> Hash of data to be POST'd in HTTP request [Hash]
+		  :verbose    => false			#--> Turn on verbose debug for this call [True/False]
+		}
+			
+		###########################################################
+		# Generic HTTP call method
+		# Accepts input hash of options that dictate how the HTTP call is to be made 
+		def http_call( opts )
+		# [review] - Don't use DEBUG inside Remote class but pull from calling method's class?
+		# [review] - Not sure if this is the best/proper way to do things but it works...
+
+			# Identify method entry
+			debug_print "#{ self.class } : #{ __method__ }\n"
+			
+			# Merge default options with those passed in by user to form complete opt list
+			opts = HTTP_opts.merge(opts)
+
+
+			# Check URL in hash and get URI from it, then set up HTTP connection
+			if opts[:url] =~ /^#{URI::regexp}$/
+				_uri = URI(opts[:url]) 
+			else
+				debug_print "No URL specified in input opts, exiting HTTP call\n"
+				return false
+			end
+			
+			_http = Net::HTTP.new(_uri.host, _uri.port)
+			
+			# Print out verbose HTTP request if :verbose is set
+			# For hardcore debugging when shit really doesn't work
+			_http.set_debug_output $stderr if opts[:verbose] == true
+			
+			# If SSL is set in hash, set HTTP connection to use SSL 
+			_http.use_ssl = true if opts[:ssl] == true
+
+			# Create request based on HTTP method
+			# [review] - Not sure if to fail with no method or default to GET?
+			case opts[:method].upcase
+			when "GET"
+				_req = Net::HTTP::Get.new(_uri.request_uri)
+		
+			when "POST"
+				_req = Net::HTTP::Post.new(_uri.request_uri)
+			
+			else
+				debug_print "No method specified, cannot make HTTP request\n"
+				return false
+			end
+
+			# Check for basic authentication key in hash
+			if opts[:basic_auth].size == 2
+				_req.basic_auth(opts[:basic_auth][0], opts[:basic_auth][1])
+			end	
+
+			# Check for Authentication token key in hash to be used in header
+			# I think this is pretty universal, but specifically works for GitHub
+			if opts[:auth]
+				_req["Authorization"] = "token #{ opts[:auth] }"
+			end
+
+			# [review] - Add :data_format to use set_form_data vs json body?
+			# For now, use Hash or Array, this is to differentiate between 
+			# putting post data in body vs putting it in the form
+			
+			# If a POST method, :data is present, and is a Hash, fill request body with data
+			if opts[:method].upcase == "POST" && opts[:data] && opts[:data].is_a?(Hash)
+				_req.body = opts[:data].to_json
+			end
+
+			# If a POST method, :data is present, and is an Array, use set_form_data
+			if opts[:method].upcase == "POST" && opts[:data] && opts[:data].is_a?(Array)
+				_req.set_form_data(opts[:data][0])
+			end
+
+			# Make HTTP request
+			_resp = _http.request(_req)
+
+			# Debug prints for status and message
+			debug_print "HTTP Response Code: #{ _resp.code }\n"
+			debug_print "HTTP Response  Msg: #{ _resp.message }\n"
+
+			# [fix] - Not sure if 401 is the only code that gives nonparseable body? 
+			# Figure out what other response codes are bad news for JSON.parse
+			_json = _resp.code == "401" ? Hash.new :  JSON.parse(_resp.body)
+			debug_print "JSON: \n #{ _json }\n"
+
+			# [review] - Returning hash of json + response the right thing to do?
+			# return {:json => _json, :resp => _resp}
+			return _json, _resp 
+		end
+	end
+	end
+end

data/lib/watson/version.rb

@@ -0,0 +1,3 @@
+module Watson 
+  VERSION = "1.0.0"
+end

data/spec/config_spec.rb

@@ -0,0 +1,119 @@
+module Watson
+require_relative 'helper_spec'
+
+describe Config do
+	before(:each) do
+		@config = Config.new
+		@file = @config.instance_variable_get(:@rc_file)
+		silence_output
+	end
+
+	after(:each) do
+		File.delete(@file) if File.exists?(@file)
+		enable_output
+	end
+
+
+	describe '#create_conf' do
+		it 'create config file, return true' do
+			@config.create_conf.should be_true 	
+			File.exists?(@file).should be_true
+		end
+	end
+
+	describe '#check_conf' do
+		context 'config does not exist' do
+			it 'create config file, return true' do
+				@config.check_conf.should be_true
+				File.exists?(@file).should be_true
+			end
+		end
+
+		context 'config does exist' do
+			it 'should return true' do
+				@config.check_conf.should be_true
+				File.exists?(@file).should be_true
+			end
+		end
+	end 
+
+	describe '#read_conf' do
+		context 'config does not exist' do
+			it 'no config, return false' do
+				@config.read_conf.should be_false
+			end
+		end
+
+		context 'config does exist' do
+			before { @config.create_conf }
+
+			it 'return true, values match default config' do
+				@config.create_conf.should be_true
+				@config.read_conf.should be_true
+				@config.dir_list.should include('.')
+				@config.tag_list.should include('fix', 'review', 'todo')
+				@config.ignore_list.should include('.git', '*.swp')
+				
+			end
+		end
+	end
+
+	describe '#update_conf' do
+		before do 
+			@config.check_conf
+			@config.parse_depth = 1000 
+			@config.update_conf('parse_depth') 
+		end	
+
+		it 'updated config.parse_depth should be 1000' do
+			@new_config = Config.new
+			@new_config.check_conf.should be_true
+			@new_config.read_conf.should be_true
+			@new_config.parse_depth.to_i.should eql 1000
+		end		
+	end
+
+	# [review] - Should this be #initialize or #new?
+	describe '#initialize' do
+		it 'should initialize all member vars' do
+			@config.cl_entry_set.should be_false
+			@config.cl_tag_set.should be_false
+			@config.cl_ignore_set.should be_false
+
+			@config.use_less.should be_false
+			
+			@config.ignore_list.should == []
+			@config.dir_list.should == []
+			@config.file_list.should == []
+			@config.tag_list.should == []
+
+			@config.remote_valid.should be_false
+
+			@config.github_valid.should be_false
+			@config.github_api.should == ''
+			@config.github_repo.should == ''
+			@config.github_issues.should == {:open => Hash.new(),
+											 :closed => Hash.new() }
+
+			@config.bitbucket_valid.should be_false
+			@config.bitbucket_api.should == ''
+			@config.bitbucket_repo.should == ''
+			@config.bitbucket_issues.should == {:open => Hash.new(),
+											 :closed => Hash.new() }
+
+		end	
+	end
+
+	describe '#run' do
+		it 'should populate all member vars' do
+			@config.run
+			@config.ignore_list.should include('.git', '*.swp')
+			@config.tag_list.should include('fix', 'review', 'todo')
+			@config.dir_list.should include('.')
+		end	
+
+	end
+
+end
+
+end