watson-ruby 1.0.3 → 1.0.4

data/lib/watson/remote.rb

@@ -1,120 +1,120 @@
 module Watson
-	# Remote class that handles all remote HTTP calls to Bitbucket and GitHub	
-	class Remote
+  # 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
+    # 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...
+    # 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)
+      # 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
+      # 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
+      # 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 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
+      # 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
+      # [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
+      # 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)
+      # 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"
+      # 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"
+      # [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
+      # [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

@@ -1,3 +1,3 @@
 module Watson 
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/spec/config_spec.rb

@@ -2,117 +2,117 @@ 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
+  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