rest_baby 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af729fe4758d51c75c7c37108de7f9376fa015ce
-  data.tar.gz: abb8b069b9fce12330b212d3741f1a08aa583146
+  metadata.gz: 1fb014e9218f045b6869e8220de3f320cfec06f4
+  data.tar.gz: 22e183843f1926e3bfbbd295168f2356717fe538
 SHA512:
-  metadata.gz: 704878c6592abd0ba51582933a72b5f1d67fbeba317e540aabb5faecc74e2cbd624752e53df83161ee0b597881fe5ab353c76596c16a142d4e8d343175e365c7
-  data.tar.gz: e267a8ae7a0eae0e28d1bf439eb93315fd7382ca3b1aea04d5f1190bb6ee951ba440a2bd58d071b8c95867038ae06c40b091a226533e939eb9e63156012561bc
+  metadata.gz: a31117c14615d8492718866d583f8b3680947ad5c5c906ed77dfb490d197cf40b0f8190f79ffc0cb94a5108ee087f432b48be571f9bc7027c2653232068b8544
+  data.tar.gz: 70b78cf5010e2ac75f66623e189c7f37f883e698475bfd7c9f35b473ab73afafde6f79a06ac61a88c0473675c5888c0791182dcad34bbbbf5a14219c5a1c3586

data/ChangeLog

@@ -12,10 +12,12 @@
 * Removed duplicate license file
 * Removed unnecessary attr_accessor entries from rest_baby.rb
 * Removed unused parameter from rest_baby client calls to rest services.
-=== Version 0.3 / 2013-02-13
+=== Version 0.3 / 2014-02-13
 * Updated to use markdown for comments
 * Revised authentication
 * Added output optional using HTTP_DEBUG=TRUE or FALSE
-=== Version 0.4 / 2014-06-11
-* Downgraded the version of rspec used due to compatibility issues
-* Fixed bug in lib/rest_baby.rb:177 that incorrectly referenced 'body' instead of 'response.body'
+=== Version 0.4 / 2014-06-12
+* Fixed unreported/untracked defect
+=== Version 0.5 / 2014-07-27
+* Enabled use of query parameters on GET calls
+* Revised tests to replace expect with should

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-gem 'cucumber', '>=1.3.5'
-gem 'fig_newton', '>=0.10'
-gem 'json', '>=1.8.1'
-gem 'nokogiri', '1.6.2.1'
-gem 'rspec', '>=2.8.0'
-gem 'webmock', '>=1.18.0'
+gem 'cucumber'
+gem 'fig_newton'
+gem 'json'
+gem 'nokogiri'
+gem 'rspec'
+gem 'webmock'

data/features/print_response.feature

@@ -1,6 +1,7 @@
 Feature: Create a basic rest client that can get, put, post, and delete
 
 @extended @get @print
+@print.S1
 Scenario: client rest Get
   Given I have a web service
   And I have "GET" service for "/test" as follows
@@ -8,11 +9,11 @@ Scenario: client rest Get
     {'Answer': 'What did you expect?'}
     """
   And I am a rest client
-# And I pause
   When I "GET" from the web service
   Then I receive the expected message
 
 @put @extended @print
+@print.S2
 Scenario: client rest Put
   Given I have a web service
   And I have "PUT" service for "/test" as follows
@@ -27,6 +28,7 @@ Scenario: client rest Put
   Then I receive the expected message
 
 @post @extended @print
+@print.S3
 Scenario: client rest Post
   Given I have a web service
   And I have "POST" service for "/test" as follows
@@ -41,6 +43,7 @@ Scenario: client rest Post
   Then I receive the expected message
 
 @delete @extended @print
+@print.S4
 Scenario: client rest Delete
   Given I have a web service
   And I have "DELETE" service for "/test" as follows

data/features/rest_client.feature

@@ -1,6 +1,7 @@
 Feature: Create a basic rest client that can get, put, post, and delete
 
 @core @get
+@rest.S1
 Scenario: client rest GET
   Given I have a web service
   And I have "GET" service for "/test"
@@ -9,6 +10,7 @@ Scenario: client rest GET
   Then I receive the expected message
 
 @core @put
+@rest.S2
 Scenario: client rest PUT
   Given I have a web service
   And I have "PUT" service for "/test"
@@ -20,6 +22,7 @@ Scenario: client rest PUT
   Then I receive the expected message
 
 @core @post
+@rest.S3
 Scenario: client rest POST
   Given I have a web service
   And I have "POST" service for "/test"
@@ -31,6 +34,7 @@ Scenario: client rest POST
   Then I receive the expected message
 
 @core @delete
+@rest.S4
 Scenario: client rest DELETE
   Given I have a web service
   And I have "DELETE" service for "/test"

data/features/step_definitions/rest_client_steps.rb

@@ -8,13 +8,30 @@ Given(/^I have a web service$/) do
 end
 
 Given(/^I have "(GET|PUT|POST|DELETE)" service for "(.*?)"$/) do |type, path|
-	@path = path
-	@mockservice.store_msg(type, path, DEFAULT_MESSAGE)
+	if type=="GET"
+		create_get(type, path)
+	else
+		@path = path
+		@mockservice.store_msg(type, path, DEFAULT_MESSAGE)
+	end
 end
 
 Given(/^I have "(GET|PUT|POST|DELETE)" service for "(.*?)" as follows$/) do |type, path, message|
-	@path = path
-	@mockservice.store_msg(type, path, message)
+	if type=="GET"
+		create_get(type, path, message)
+	else
+		@path = path
+		@mockservice.store_msg(type, path, message)
+	end
+end
+
+def create_get(type, path, message = DEFAULT_MESSAGE)
+	@path = path.split('?')[0]
+	if path.split('?').length==1
+		@mockservice.store_msg("GET", @path, message)
+	else
+		@mockservice.store_get_query(path)
+	end
 end
 
 Given(/^I am a rest client$/) do
@@ -39,6 +56,10 @@ When(/^I "(PUT|POST)" to the web service with the following$/) do |type, message
 	end
 end
 
+When(/^I "GET" from the web service with the parameters$/) do |table|
+	@response = @restbaby.get({}, nil, table.rows_hash)
+end
+
 When(/^I pause$/) do
   pause()
 end
@@ -48,7 +69,12 @@ Then(/^I receive the expected message$/) do
 	@response.body.should eq(DEFAULT_MESSAGE)
 end
 
-Then(/^I receive the following$/) do |message|
+# Then(/^I receive the following$/) do |message|
+# 	@response.code.should eq('200')
+# 	@response.body.should eq(message)
+# end
+
+Then(/^I receive a message with "(.*?)"$/) do |message|
 	@response.code.should eq('200')
 	@response.body.should eq(message)
 end

data/features/support/mock_rest_service.rb

@@ -4,7 +4,8 @@ include WebMock::API
 
 class MockRestService
 
-  STANDARD_HEADERS = {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}
+  # STANDARD_HEADERS = {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'User-Agent'=>'Ruby'}
+  STANDARD_HEADERS = {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}
   STANDARD = "http"
   SECURE = "https"
 
@@ -30,6 +31,15 @@ class MockRestService
       else
         raise "Unsupported type: #{type}"
     end
-  end    
+  end
 
+  def store_get_query(path, headers = {}, user = nil, password = nil)
+    new_headers = STANDARD_HEADERS.merge(headers)
+    params = Hash.new
+    message = path.split('?').last
+    auth_string = "#{user}:#{password}@" unless (user.nil? || password.nil?)
+    WebMock.stub_request(:get, "#{@protocol}://#{auth_string}#{@host}:#{@port}#{path}").
+      with(:headers => new_headers).
+      to_return({:body => "#{message}", :status => 200}, :headers => {})
+  end
 end

data/features/url_parameter.feature

@@ -0,0 +1,13 @@
+Feature: As a rest client I need to use URL parameters in order to send those parameters to a restful service.
+
+@parameter
+@parameter.S1
+Scenario: Send parameter to a service.
+  Given I have a web service
+  And I have "GET" service for "/test?first=1&second=2&third=3"
+  And I am a rest client
+  When I "GET" from the web service with the parameters
+  	| first  | 1 |
+  	| second | 2 |
+  	| third  | 3 |
+  Then I receive a message with "first=1&second=2&third=3"

data/lib/rest_baby/version.rb

@@ -1,3 +1,3 @@
 module RestBaby
-  VERSION = "0.4"
+  VERSION = "0.5"
 end

data/lib/rest_baby.rb

@@ -14,6 +14,9 @@ require 'rest_baby/version'
 module RestBaby
 	# Sends and receives data to a restful web service
 	class Client
+			PARAMETER_STARTER = "?"
+			PARAMETER_SEPARATOR = "&"
+
 		# The WebService Response from the last call
 		attr_reader :wsresponse
 		# The user (for authentication)
@@ -59,11 +62,13 @@ module RestBaby
 
 		# Basic web services Get command
 		#
-		# @param  path [String] Path of service to send the command to
-		# @param headers [String] header parameters including authorization and Content-Type
+		# @param headers [Hash] header parameters including authorization and Content-Type
+		# @param path [String] Path of service to send the command to
+		# @param parameters [Hash] query string that added as part of the URL
 		# @return The response from the rest server is returned
-		def get(headers = {}, path = '')
-			uri = URI.parse("#{@url}#{path}")
+		def get(headers = {}, path = '', parameters = {})
+			full_path = path_with_params(path, parameters)
+			uri = URI.parse("#{@url}#{full_path}")
 			return request(uri, Net::HTTP::Get.new(uri.request_uri), nil, headers)
 		end
  
@@ -114,7 +119,12 @@ module RestBaby
 		end
 
 		private
- 
+
+		def path_with_params(path, params)
+		   encoded_params = URI.encode_www_form(params)
+		   [path, encoded_params].join("?")
+		end
+
 		# Sending the web services command
 		#
 		# @param uri [URI] Uri to send the command to
@@ -140,9 +150,14 @@ module RestBaby
 		
 		# Print the Request 
 		def print_request(request, http, uri)
+			if uri.query==''
+				query = ''
+			else
+				query = "?#{uri.query}"
+			end
 			if @verbose
 				puts ">> REQUEST"
-	        	puts ">  URL: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}"
+	        	puts ">  URL: #{uri.scheme}://#{uri.host}:#{uri.port}#{uri.path}#{query}"
 	        	puts ">  Headers: "
 	        	request.each { |key, value| puts " >  #{key}: #{value}" }
 	        	# puts "> Basic_Auth #{request.basic_auth}"
@@ -174,7 +189,7 @@ module RestBaby
 		        elsif response.header['Content-Type']=='text/csv'
 		            puts response.body
 		        elsif response.header['Content-Type']=='application/xml'
-		            puts pretty_xml(response.body)
+		            puts pretty_xml(body)
 		        elsif response.body.nil?
 		            puts "[Empty]"
 		        else 

data/rest_baby.gemspec

@@ -18,12 +18,13 @@ 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 "rspec", "2.8.0"
-  spec.add_development_dependency "webmock", ">= 1.13.0"
+  spec.add_dependency 'nokogiri', '~> 0'
+  spec.add_dependency 'json', '~> 1.8', '>= 1.8.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'cucumber', '~> 1.3', '>= 1.3.5'
+  spec.add_development_dependency 'fig_newton', '~> 0.9'
+  spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
+  spec.add_development_dependency 'webmock', '~> 1.13', '>= 1.13.0'
+
 end

metadata

@@ -1,33 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: rest_baby
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Dave McNulla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
@@ -35,6 +38,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
@@ -56,20 +62,23 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
@@ -77,6 +86,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.5
@@ -84,34 +96,43 @@ dependencies:
   name: fig_newton
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.0
@@ -119,6 +140,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.13.0
@@ -186,6 +210,7 @@ files:
 - features/support/env.rb
 - features/support/mock_rest_service.rb
 - features/support/utility.rb
+- features/url_parameter.feature
 - lib/rest_baby.rb
 - lib/rest_baby/version.rb
 - rest_baby.gemspec
@@ -222,4 +247,5 @@ test_files:
 - features/support/env.rb
 - features/support/mock_rest_service.rb
 - features/support/utility.rb
+- features/url_parameter.feature
 has_rdoc: