rest_baby 0.2 → 0.3

data/lib/rest_baby.rb

@@ -1,138 +1,193 @@
-=begin rdoc
-
-== Authors
-
-Dave McNulla
-
-=end
+# rest_baby.rb
+# @author Dave McNulla of ResMed
+# Originated: 2011
+# This library was written to simplify communications with rest services.
 
 require 'net/http'
 require 'net/https'
-require "rest_baby/version"
+require 'json'
+require 'nokogiri'
+require 'rest_baby/version'
 
-##
 # RestBaby is a small rest client. It encapsulates some of the details for creating and using the rest service.
+# @private
 module RestBaby
 	# Sends and receives data to a restful web service
 	class Client
+		# The WebService Response from the last call
+		attr_reader :wsresponse
+		# The user (for authentication)
+		attr_reader :user
+		# The password for the user (for authentication)
+		attr_reader  :password
 
-		##
 		# Creates a new rest client
 		#
-		# * +url+ = url of the rest service
+		# @param url [String] url of the rest service
 		# eg. http://myrestservice.com:80/time
-		# * +headers+ = default headers to use.
+		# @param headers [Hash] default headers to use.
 		# eg. '{ \"Content-Type\" => \"application/json\"}'
-		# can be multiple headers
-		def initialize(url, headers = {})
-			@uri = URI.parse(url)
+		# Can be multiple headers separated by commas inside the brackets.
+		def initialize(url, headers = {}, user = nil, password = nil)
+			@url = url
 			@headers = headers
-			@user = nil
-			@password = nil
+			@user = user
+			@password = password
+
+			if ENV["DEBUG_HTTP"].nil?
+				@verbose = true
+			else
+				@verbose = ENV["DEBUG_HTTP"].downcase=='true' ? true : false
+			end
 		end
 
-		##
-		# Modifies the headers by merging new headers with current headers. 
+		# Adds user/password to the rest client
 		#
-		# * +headers+ = new headers to merge with current headers
-		def set_headers(headers)
-			@headers = @headers.merge(headers)
+		# @param user [String] user that has authorization
+		# @param password [String] authorized user's password
+		def set_auth(user, password)
+			@user = user
+			@password = password
 		end
 
-		##
-		# Modifies the authentication for the rest client
+		# Modifies the headers by merging new headers with current headers. 
 		#
-		# * +user+ = authorized username
-		# * +password+ = password for the user
-		def set_auth(user, password)
-			new_url = "#{@uri.scheme}://#{user}:#{password}@#{@uri.host}:#{@uri.port}#{@uri.path}"
-			@uri = URI.parse(new_url)
+		# @param headers [Hash] new headers to merge with current headers
+		def set_headers(headers)
+			@headers = @headers.merge(headers)
 		end
 
-		##
 		# Basic web services Get command
 		#
-		# * +url+ = url to send the command to
-		# * +headers+ = header parameters including authorization and Content-Type
-		# The response from the rest server is returned
-		def get(headers = {})
-			return request(@uri, Net::HTTP::Get.new(@uri.request_uri), headers)
+		# @param  path [String] Path of service to send the command to
+		# @param headers [String] header parameters including authorization and Content-Type
+		# @return The response from the rest server is returned
+		def get(headers = {}, path = '')
+			uri = URI.parse("#{@url}#{path}")
+			return request(uri, Net::HTTP::Get.new(uri.request_uri), nil, headers)
 		end
-
-		## 
+ 
 		# Basic web services Post command
 		# 
-		# * +url+ = url to send the command to
-		# * +body+ = data to put in the body
-		# * +headers+ = header parameters including authorization and Content-Type
-		# The response from the rest server is returned
-		def post(body = nil, headers = {})
-			return request(@uri, Net::HTTP::Post.new(@uri.request_uri), body, headers)
+		# @param path [String] Path of service to send the command to
+		# @param body [Any type of string] Data to put in the body such as json or xml
+		# @param headers [Hash] header parameters including authorization and Content-Type
+		# @return The response from the rest server is returned
+		def post(body = nil, headers = {}, path = '')
+			uri = URI.parse("#{@url}#{path}")
+			return request(uri, Net::HTTP::Post.new(uri.request_uri), body, headers)
 		end
-
-		## 
+ 
 		# Basic web services Delete command
 		# 
-		# * +url+ = url to send the command to
-		# * +headers+ = header parameters including authorization and Content-Type
-		# The response from the rest server is returned
-		def delete(headers = {})
-			return request(@uri, Net::HTTP::Delete.new(@uri.request_uri), headers)
+		# @param path [String] Path of service to send the command to
+		# @param headers [Hash] header parameters including authorization and Content-Type
+		# @return The response from the rest server is returned
+		def delete(headers = {}, path = '')
+			uri = URI.parse("#{@url}#{path}")
+			return request(uri, Net::HTTP::Delete.new(uri.request_uri), headers)
 		end
-
-		## 
+ 
 		# Basic web services Put command
 		# 
-		# * +url+ = url to send the command to
-		# * +body+ = data to put in the body
-		# * +headers+ = header parameters including authorization and Content-Type
-		# The response from the rest server is returned
-		def put(body = nil, headers = {})
-			return request(@uri, Net::HTTP::Put.new(@uri.request_uri), body, headers)
+		# @param path [String] Path of service to send the command to
+		# @param body [String] data to put in the body
+		# @param headers [Hash] header parameters including authorization and Content-Type
+		# @return Response from the rest server is returned
+		def put(body = nil, headers = {}, path = '')
+			uri = URI.parse("#{@url}#{path}")
+			return request(uri, Net::HTTP::Put.new(uri.request_uri), body, headers)
 		end
 
-		## 
+		# Get the code from the last call
+		#
+		# @return the http code such as 200, 301, 403, 404, or 500
+		def get_code
+			@wsresponse.code
+		end
+ 
+		# Set verbose on or off
+		#
+		# @param on [Boolean] True=verbose, False=Not verbose
+		def set_verbose(on = true)
+			@verbose = on
+		end
+
+		private
+ 
 		# Sending the web services command
 		#
-		# * +url+ = url to send the command to
-		# * +req+ = command to send as Net::HTTP:<command> class
-		# * +body+ = data to put in the body
-		# * +headers+ = header parameters including authorization and Content-Type
-		# The response from the rest server is returned
-		def request(uri, request, body = nil, headers)
+		# @param uri [URI] Uri to send the command to
+		# @param request [HTTP Request] command to send as Net::HTTP:<command> class; get, post, put, delete.
+		# @param body [String] data to put in the body
+		# @param headers [Hash] header parameters including authorization and Content-Type
+		# @return The response from the rest server is returned
+		def request(uri, request, body = nil, headers = {})
 			@headers.merge(headers).each { |key, value| request[key] = value }
+			request.basic_auth(@user, @password) unless @user.nil?
 			request.body = body unless body.nil?
-			http = Net::HTTP.new(@uri.host, @uri.port)
-			http.use_ssl = true if @uri.scheme == 'https'
+			http = Net::HTTP.new(uri.host, uri.port)
+			http.use_ssl = true if uri.scheme == 'https'
+			print_request(request, http, uri)
 			begin
 				@wsresponse = http.request(request)
-				# puts print_last_response
+				print_response(@wsresponse)
 				return @wsresponse
 			rescue Timeout::Error => e 
 				raise e.message
 			end
 		end
 		
-		def get_code
-			@wsresponse.code
-		end
-
-		## 
+		# Print the Request 
+		def print_request(request, http, uri)
+			if @verbose
+				puts ">> REQUEST"
+	        	puts ">  URL: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}"
+	        	puts ">  Headers: "
+	        	request.each { |key, value| puts " >  #{key}: #{value}" }
+	        	# puts "> Basic_Auth #{request.basic_auth}"
+		        puts ">  BODY = "
+		        if request.body.nil?
+		            puts "[Empty]"
+	            elsif request['Content-Type']=='application/json'
+		            jj JSON(request.body) 
+		        elsif request['Content-Type']=='text/csv'
+		            puts request.body
+		        elsif request['Content-Type']=='application/xml'
+		            puts pretty_xml(request.body)
+		        else
+		            puts request.body
+		        end
+		    end
+	    end
+ 
 		# Pretty print the web services last response
-		#
-		# The nice looking output is returned as a string
-		def print_last_response
-			output = "CODE = #{@wsresponse.code}\n"
-			output << "MESSAGE = #{@wsresponse.message}\n"
-			@wsresponse.each { |key, value| output << "#{key} = #{value}\n"}
-			begin
-				output << "BODY = "
-			  output << "#{@wsresponse.body}" 
-			rescue
-				output << "[Empty]"
-			end
-			return output
-		end
-		
+		def print_response(response)
+			if @verbose
+		        puts "<< RESPONSE"
+		        puts " < CODE = #{response.code}"
+		        puts " < MESSAGE = #{response.message}"
+		        response.each { |key, value| puts " < #{key} = #{value}\n"}
+		        puts " < BODY = "
+		        if response.header['Content-Type']=='application/json'
+		            jj JSON(response.body) 
+		        elsif response.header['Content-Type']=='text/csv'
+		            puts response.body
+		        elsif response.header['Content-Type']=='application/xml'
+		            puts pretty_xml(body)
+		        elsif response.body.nil?
+		            puts "[Empty]"
+		        else 
+		            puts "#{response.body}\n<"
+		        end
+		    end
+	    end
+
+	    def pretty_xml(xml)
+	    	doc = Nokogiri.XML(xml) do |config|
+  				config.default_xml.noblanks
+  			end
+  			return doc.to_xml(:indent => 2)
+  		end
 	end
 end

data/rest_baby.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "json", ">= 1.8.0"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "cucumber", ">= 1.3.5"
   spec.add_development_dependency "fig_newton", ">= 0.9"
-  spec.add_development_dependency "json", ">= 1.8.0"
-  spec.add_development_dependency "pinch_hitter", ">= 0.3"
   spec.add_development_dependency "rspec", ">= 2.14.1"
   spec.add_development_dependency "webmock", ">= 1.13.0"
 

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: rest_baby
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Dave McNulla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.8.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: cucumber
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.5
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: fig_newton
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
-  name: pinch_hitter
+  name: fig_newton
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,6 @@ files:
 - config/environments/mock.yml
 - cucumber.yml
 - doc/MockRestService.html
-- doc/PinchRestService.html
 - doc/RestBaby.html
 - doc/RestBaby/Client.html
 - doc/_index.html
@@ -175,6 +174,7 @@ files:
 - doc/requirements/tags/post.html
 - doc/requirements/tags/print.html
 - doc/requirements/tags/put.html
+- doc/requirements/tags/wip.html
 - doc/step_list.html
 - doc/stepdefinition_list.html
 - doc/tag_list.html
@@ -186,7 +186,6 @@ files:
 - features/step_definitions/rest_client_steps.rb
 - features/support/env.rb
 - features/support/mock_rest_service.rb
-- features/support/pinch_rest_service.rb
 - features/support/utility.rb
 - lib/rest_baby.rb
 - lib/rest_baby/version.rb
@@ -211,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: This is a small rest client developed for use in testing rest services.
@@ -223,6 +222,5 @@ test_files:
 - features/step_definitions/rest_client_steps.rb
 - features/support/env.rb
 - features/support/mock_rest_service.rb
-- features/support/pinch_rest_service.rb
 - features/support/utility.rb
 has_rdoc: