rquest 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 127855095b8f26517572c264644b4fcdafd9b927
-  data.tar.gz: 53e386a7b6697c74d5b1cf970cd1f3e1b6da3195
+  metadata.gz: af3484f4dfb24bdf2acac109deebd9b906884d6e
+  data.tar.gz: 63bc4354dd605483a1dd1191a91e2187841b77a4
 SHA512:
-  metadata.gz: 692f78864dcb4bbdfe0d32b6a0436e006a2fc83b904e224b1c73ad59555e6df3dd439988c24102711c75e90263e38df4ea1f46ae98dfe66f3dc15625cbad183d
-  data.tar.gz: 84104f4df5815766e12d21035f752a99c753586bc356162618696d8ade49cfbff59364a2dec7571e1342d45e0604806462427ef16bb6732c8f87f551d22a4b73
+  metadata.gz: 45f426956256bf01ef6b9a89db86bb073229a0dfaba7ad253ae07ef9defd61b1574eab16abdaaf0531390026839c4425cdc5f97c0684d1a4741d3794c6b94eff
+  data.tar.gz: a76a10109e2cdfeb0072011fa4e0062f8cb4886352b6b0ca609b0cb7de9f7382b0e318ff8dc03e17a0be71f57c96569f2be8ae4631ad125bc8060e9d4f568702

data/README.md

@@ -2,10 +2,12 @@
 
 A helper library to easily define restful web requests in ruby.
 
-Bassically I am tiered of constantly relooking up NET HTTP blog post to try and remember how to say override the default headers or attatch a file as a multipart post request. Also there are things about the ruby request generation process I felt I could improve such as, autodetecting the need for ssl from the URI and providing a clean DSL for request definition. As well as cleaner file attatchment.
+Bassically I am tiered of constantly relooking up NET HTTP blog post to try and remember how to say override the default headers or attatch a file as a multipart post request. Also there are things about the ruby request generation process I felt I could improve such as, autodetecting the need for ssl from the URI and providing a clean DSL for request definition, as well as cleaner file attatchment.
 
 RQuest makes it easy to build request and gives you full control over every aspect of the request. I modeled it after the chrome extension postman. Everything you can do with postman you can do with RQuest and it follows the same intuitive work flow.
 
+In addition Rquest is an object that can handle a full session request cycle. You can say log in have the authentication cookies set by the server and then proceed to parse your dashboard.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,8 +31,8 @@ Its basic setup involves setting the uri and action. Its send method will execut
 ```ruby
 rquest = RQuest.new({verb: :get, uri: "https://google.com"})
 response_body = rquest.send
-response_time = rquest.response_time
-full_request_object = rquest.response
+response_time = rquest.last_response_time
+response_object = rquest.last_response
 ```
 
 You can easily combine query params with the uri and the settings hash
@@ -53,7 +55,7 @@ https.use_ssl = true
 All controlled from the same settings hash with the payload key
 
 ```ruby
-rquest = RQuest.new({verb: :get, uri: "https://google.com", payload: {a_field: "stuff", another_field: "more stuff"} })
+rquest = RQuest.new({verb: :post, uri: "https://google.com", payload: {a_field: "stuff", another_field: "more stuff"} })
 rquest.send
 ```
 
@@ -70,6 +72,50 @@ rquest = RQuest.new({verb: :get, uri: "https://google.com", payload: {a_field: "
 rquest.send
 ```
 
+## Sessions
+
+Rquest is built to behave like a fresh incognito browser. Every time you apply send it will add the response to the transactions attribute and set the last_response and last_response_time.
+
+Simply call update to change what you need before the next send like so. New settings will be merged so they will either override old ones ore creat new ones. Any non specified setting will remain untouched from the last request.
+
+```ruby
+rquest = RQuest.new({verb: :get, uri: "https://google.com?q=testing", q_params: {token: "foo"}})
+rquest.send
+rquest.update({q_params: {q: "other search value"}}
+rquest.send
+first_query = rquest.transactions.first
+last_query = rquest.transactions.last
+```
+
+Transactions are stored as has with their request, response and response time available for future reference. Continuing from above we could.
+
+```ruby
+old_request = first_query[:request]
+old_response = first_query[:response]
+time_it_took = first_query[:response_time]
+```
+
+## Cookies
+
+You can set cookies for a request by adding them to the settings[:cookies] like
+
+```ruby
+rquest = RQuest.new({verb: :get, uri: "https://google.com", payload: {a_field: "stuff", another_field: "more stuff"}, cookies: {"MySpecialCookie" => "SomeSuperSecretValue"} })
+```
+
+Any response will add/merge any cookies in the "Set-Cookie" header of the response to your next request
+
+```ruby
+rquest = RQuest.new({verb: :post, uri: "https://somesite.com/sessions", payload: {username: "foobar", password: "SuperSecret"}})
+rquest.send
+```
+If this authenticates correctly then the server will send the right Set-Cookie so then you can do something like.
+
+```ruby
+rquest.update({uri: "https://somesite.com/mydashboard"}
+rquest.send
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rquest.rb

@@ -2,6 +2,7 @@ require "rquest/version"
 require 'net/http/post/multipart'
 require 'mimemagic'
 require 'benchmark'
+require "rquest/core_overrides"
 require "rquest/requestor"
 
 module Rquest
@@ -20,19 +21,3 @@ module Rquest
 		end
 	end
 end
-
-class Hash
-	def to_q_param_string
-		self.inject([]){|r,(k,v)| r.push( "#{k}=#{v}" )}.join("&")
-	end
-end
-
-class String
-	def to_q_param_hash
-		self.split("&").inject({}) do |hash, key_value|
-			key, value = key_value.split("=")
-			hash[key.to_sym] = value
-			hash
-		end
-	end
-end

data/lib/rquest/core_overrides.rb

@@ -0,0 +1,27 @@
+class Hash
+	def to_q_param_string
+		self.inject([]){|r,(k,v)| r.push( "#{k}=#{v}" )}.join("&")
+	end
+
+	def to_cookie_string
+		self.inject([]){|r,(k,v)| r.push( "#{k}=#{v}" )}.join("; ") + ";"
+	end
+end
+
+class String
+	def to_q_param_hash
+		self.split("&").inject({}) do |hash, key_value|
+			key, value = key_value.split("=")
+			hash[key.to_sym] = value
+			hash
+		end
+	end
+	def to_cookies_hash
+		tmp = self[0..-2]
+		tmp.split("; ").inject({}) do |hash, key_value|
+			key, value = key_value.split("=")
+			hash[key] = value
+			hash
+		end
+	end
+end

data/lib/rquest/requestor.rb

@@ -1,37 +1,71 @@
 module Rquest
 	class Requestor
-		attr_reader :response, :response_time
+		attr_reader :last_response, :last_response_time, :transactions
 		def initialize( settings={} )
-			@settings = settings
+			@transactions = []
+			update( settings )
+		end
+
+		def update( settings={} )
+			@settings ||= {}
+			@settings = @settings.merge( settings )
 			apply_default_settings
-			@verb = settings[:verb].to_sym
+			merge_settings
+			@verb = @settings[:verb].to_sym 
 			merge_string_and_hash_params
 			@uri = URI::parse( @settings[:uri] )
 			@headers = @settings[:headers]
 			initialize_http_client
-			set_headers
 			set_body
-		end
-
-		def send
-			@response_time = Benchmark.realtime do
-				@response = @http_client.request(@http_request_client)
-			end
-			@response.body
-		end
-
-		def uri_path
-			@uri.path.empty? ? "/" : @uri.path
+			set_headers
 		end
 
 		def apply_default_settings
 			@settings[:verb] ||= :get
 			@settings[:q_params] ||= {}
+			@settings[:cookies] ||= {}
 			@settings[:headers] ||= {}
+			@settings[:cookies] ||= {}
+			@settings[:headers]["User-Agent"] ||= "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2272.89 Safari/537.36"
 			@settings[:payload] ||= {}
+			@headers ||= {}
+			@cookies ||= {}
+			@q_params ||= {}
+			@files = {}
 			setup_files unless @settings[:files].nil?
 		end
 
+		def merge_settings
+			@headers = @headers.merge( @settings[:headers] )
+			@cookies = @cookies.merge( @settings[:cookies] )
+			@q_params = @q_params.merge( @settings[:q_params] )
+		end
+
+		def send
+			@last_response_time = Benchmark.realtime do
+				@last_response = @http_client.request(@http_request_client)
+			end
+			@transactions.push( { request: @http_request_client, response: @last_response, response_time: @last_response_time } )
+			unless @last_response["Set-Cookie"].nil?
+				new_cookies = @last_response["Set-Cookie"].to_cookies_hash
+				@cookies = @cookies.merge( new_cookies )
+			end
+			case @last_response
+				when Net::HTTPSuccess
+					@last_response.body
+				when Net::HTTPUnauthorized
+					{'error' => "#{@last_response.message}: username and password set and correct?"}
+				when Net::HTTPServerError
+					{'error' => "#{@last_response.message}: try again later?"}
+				else
+					{'error' => @last_response.message}
+			end
+		end
+
+		def uri_path
+			@uri.path.empty? ? "/" : @uri.path
+		end
+
 		def setup_files
 			old_files = @settings.delete(:files)
 			new_files = {}
@@ -40,14 +74,15 @@ module Rquest
 				mime_type = (extname == "") ? "text/plain" : MimeMagic.by_extension(extname).type
 				new_files[field_name] = UploadIO.new( file, mime_type, File.basename(file) )
 			end
-			@settings[:files] = new_files
+			@files = new_files
 		end
 
 		def merge_string_and_hash_params
 			url, string_params = @settings[:uri].split("?")
 			string_params ||= ""
 			hash_of_string_params = string_params.to_q_param_hash
-			final_params_hash = hash_of_string_params.merge( @settings[:q_params] )
+			final_params_hash = hash_of_string_params.merge( @q_params )
+			@q_params = final_params_hash
 			@settings[:uri] = [url, final_params_hash.to_q_param_string].join("?")
 		end
 
@@ -60,22 +95,27 @@ module Rquest
 		def initialize_http_client
 			@http_client = Net::HTTP.new( @uri.host, @uri.port )
 			@http_client.use_ssl = true if @uri.scheme == "https"
-			klass = Rquest::client_class_for_verb( @verb )
-			@http_request_client = klass.send(:new, uri_path)
 		end
 
 		def set_headers
+			set_cookies if @cookies.any?
 			@headers.each do |key, value|
 				@http_request_client[key.to_s] = value.to_s
 			end
 		end
 
+		def set_cookies
+			@http_request_client["Cookie"] = @cookies.to_cookie_string
+		end
+
 		def set_body
-			if @settings[:files].nil?
+			unless @files.any?
+				klass = Rquest::client_class_for_verb( @verb )
+				@http_request_client = klass.send(:new, uri_path)
 				@http_request_client.set_form_data( @settings[:payload] )
 			else
 				klass = Rquest::client_class_for_verb( @verb, true )
-				multi_part_params = @settings[:payload].merge( @settings[:files] )
+				multi_part_params = @settings[:payload].merge( @files )
 				@http_request_client = klass.send(:new, @uri.path, multi_part_params)
 			end
 		end

data/lib/rquest/version.rb

@@ -1,3 +1,3 @@
 module Rquest
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/rquest.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.summary       = %q{A helper library to easily define restful web requests in ruby. It wraps NET::HTTP in an intuitive work flow modeled off of the Postman Chrome extension.}
-  spec.description   = %q{RQuest makes it easy to build request and gives you full control over every aspect of the request. I modeled it after the chrome extension postman. Everything you can do with postman you can do with RQuest and it follows the same intuitive work flow.}
+  spec.description   = %q{RQuest makes it easy to build request and gives you full control over every aspect of the request. I modeled it after the chrome extension postman. Everything you can do with postman you can do with RQuest and it follows the same intuitive work flow. It also has support for session managment.}
   spec.homepage      = "https://github.com/thetyrelcorporation/rquest"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rquest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - The Tyrel Corporation
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -111,7 +111,7 @@ dependencies:
 description: RQuest makes it easy to build request and gives you full control over
   every aspect of the request. I modeled it after the chrome extension postman. Everything
   you can do with postman you can do with RQuest and it follows the same intuitive
-  work flow.
+  work flow. It also has support for session managment.
 email:
 - cloud.tycorp@gmail.com
 executables: []
@@ -130,8 +130,10 @@ files:
 - bin/console
 - bin/setup
 - lib/rquest.rb
+- lib/rquest/core_overrides.rb
 - lib/rquest/requestor.rb
 - lib/rquest/version.rb
+- rquest-0.1.0.gem
 - rquest.gemspec
 homepage: https://github.com/thetyrelcorporation/rquest
 licenses: