rest_baby 0.1 → 0.2

data/lib/rest_baby.rb

@@ -4,20 +4,26 @@
 
 Dave McNulla
 
-== Revision Log
-
-2013.07.30	initial files for a simple rest client
-
 =end
 
 require 'net/http'
 require 'net/https'
 require "rest_baby/version"
 
+##
+# RestBaby is a small rest client. It encapsulates some of the details for creating and using the rest service.
 module RestBaby
+	# Sends and receives data to a restful web service
 	class Client
-		attr_accessor :contentType, :uri, :wsresponse, :headers
 
+		##
+		# Creates a new rest client
+		#
+		# * +url+ = url of the rest service
+		# eg. http://myrestservice.com:80/time
+		# * +headers+ = default headers to use.
+		# eg. '{ \"Content-Type\" => \"application/json\"}'
+		# can be multiple headers
 		def initialize(url, headers = {})
 			@uri = URI.parse(url)
 			@headers = headers
@@ -25,54 +31,73 @@ module RestBaby
 			@password = nil
 		end
 
+		##
+		# Modifies the headers by merging new headers with current headers. 
+		#
+		# * +headers+ = new headers to merge with current headers
 		def set_headers(headers)
 			@headers = @headers.merge(headers)
 		end
 
+		##
+		# Modifies the authentication for the rest client
+		#
+		# * +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}"
+			new_url = "#{@uri.scheme}://#{user}:#{password}@#{@uri.host}:#{@uri.port}#{@uri.path}"
 			@uri = URI.parse(new_url)
 		end
 
-		#Basic web services Get command
-		# * url = url to send the command to
-		# * headers = header parameters including authorization and Content-Type
+		##
+		# 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(path, headers = {})
-			return request(uri, Net::HTTP::Get.new(@uri.request_uri), headers)
+		def get(headers = {})
+			return request(@uri, Net::HTTP::Get.new(@uri.request_uri), 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
+		## 
+		# 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(path, body = nil, headers = {})
-			return request(uri, Net::HTTP::Post.new(@uri.request_uri), body, headers)
+		def post(body = nil, headers = {})
+			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
+		## 
+		# 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(path, headers = {})
-			return request(uri, Net::HTTP::Delete.new(@uri.request_uri), headers)
+		def delete(headers = {})
+			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
+		## 
+		# 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(path, body = nil, headers = {})
-			return request(uri, Net::HTTP::Put.new(@uri.request_uri), body, headers)
+		def put(body = nil, headers = {})
+			return request(@uri, Net::HTTP::Put.new(@uri.request_uri), body, headers)
 		end
 
-		#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
+		## 
+		# 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)
 			@headers.merge(headers).each { |key, value| request[key] = value }
@@ -92,8 +117,10 @@ module RestBaby
 			@wsresponse.code
 		end
 
-		# Pretty print the web services response
-		# * response = web service response to print
+		## 
+		# 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_baby
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Dave McNulla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,14 +129,57 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ChangeLog
 - Gemfile
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
 - config/environments/mock.yml
 - cucumber.yml
-- features/header_options.feature
+- doc/MockRestService.html
+- doc/PinchRestService.html
+- doc/RestBaby.html
+- doc/RestBaby/Client.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/cucumber.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/feature_list.html
+- doc/featuredirectories_list.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/cucumber.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/requirements.html
+- doc/requirements/features.html
+- doc/requirements/features/header_options.html
+- doc/requirements/features/headers.html
+- doc/requirements/features/headers/header_options.html
+- doc/requirements/features/print_response.html
+- doc/requirements/features/rest_client.html
+- doc/requirements/step_transformers.html
+- doc/requirements/tags.html
+- doc/requirements/tags/authentication.html
+- doc/requirements/tags/core.html
+- doc/requirements/tags/delete.html
+- doc/requirements/tags/extended.html
+- doc/requirements/tags/get.html
+- doc/requirements/tags/headers.html
+- doc/requirements/tags/post.html
+- doc/requirements/tags/print.html
+- doc/requirements/tags/put.html
+- doc/step_list.html
+- doc/stepdefinition_list.html
+- doc/tag_list.html
+- doc/top-level-namespace.html
+- features/headers/header_options.feature
 - features/print_response.feature
 - features/rest_client.feature
 - features/step_definitions/header_steps.rb
@@ -173,7 +216,7 @@ signing_key:
 specification_version: 4
 summary: This is a small rest client developed for use in testing rest services.
 test_files:
-- features/header_options.feature
+- features/headers/header_options.feature
 - features/print_response.feature
 - features/rest_client.feature
 - features/step_definitions/header_steps.rb
@@ -182,3 +225,4 @@ test_files:
 - features/support/mock_rest_service.rb
 - features/support/pinch_rest_service.rb
 - features/support/utility.rb
+has_rdoc: 

data/LICENSE

@@ -1,24 +0,0 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
-OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
-
-For more information, please refer to <http://unlicense.org/>