http-requestor 0.0.3 → 0.0.4

data/README.rdoc

@@ -2,28 +2,52 @@
 
 A Wrapper around Net/HTTP which allows you to perform HTTP Requests in a simple way.
 
-= Usage
-
-http = HttpRequestor.new("http://www.mydomain.com") # This will initialize the HttpRequestor class
-
-[Sending Calls to the initialized domain] response = http.get("/get_path")
-
-                                          response = http.post("/post_path")
-
-                                          response = http.put("/put_path")
-
-                                          response = http.delete("/delete_path")
-
-                                          The above methods also accept optional parameters, for
-                                          
-                                          * Parameters to be sent to the request
-                                          * Headers to be sent to the request
-
-[Alternatively you can also use the method]  HttpRequestor.request
-
-                                             which takes the paramters in order
-                                             * domain       #=> for example: "http://www.some_domain.com"
-                                             * request_type #=> GET|POST|PUT|DELETE
-                                             * path         #=> for example: "/some_path"
-                                             * parameters   #=> this is an optional parameter, if you want to send some parameters alongwith the request, you can pass a hash with
-                                             * headers      #=> this is also an optional parameter, you can pass a hash with stringified keys
+== Installation
+
+  gem install http-requestor
+
+== Usage
+
+
+=== Initialize a domain, and send request to multiple paths
+
+  http = HttpRequestor.new("http://www.mydomain.com")
+  # This will initialize the HttpRequestor class
+
+  get_request    = http.get(path, parameters, headers)
+  post_request   = http.post(path, parameters, headers)
+  put_request    = http.put(path, parameters, headers)
+  delete_request = http.delete(path, parameters, headers)
+  
+  # path         => for example: "/some_path"
+  # parameters   => this is an optional parameter, if you want to send some parameters alongwith the request, you can pass a hash with
+  # headers      => this is also an optional parameter, you can pass a hash with stringified keys
+
+=== Get a response right away  
+
+  HttpRequestor.request(domain, request_type, path, parameters, headers)
+  # domain       => for example: "http://www.some_domain.com"
+  # request_type => GET|POST|PUT|DELETE
+  # path         => for example: "/some_path"
+  # parameters   => this is an optional parameter, if you want to send some parameters alongwith the request, you can pass a hash with
+  # headers      => this is also an optional parameter, you can pass a hash with stringified keys
+  
+OR you can do it the other way
+  
+  HttpRequestor.request_with_url(url, request_type, data, headers)
+  # url          => for example: "http://www.some_domain.com/some_path_value"
+  # request_type => GET|POST|PUT|DELETE
+  # parameters   => this is an optional parameter, if you want to send some parameters alongwith the request, you can pass a hash with
+  # headers      => this is also an optional parameter, you can pass a hash with stringified keys
+  
+=== HTTP Basic Authentication
+
+  HttpRequestor.send_basic_auth_request(url, username, password)
+  # url      => for example: "http://www.some_domain.com/some_path_value" only GET URL's supported currently
+  # username => basic_auth_username
+  # password => basic_auth_password
+  
+== Issues and Suggestions
+
+Please report all the issues in the Github Issues Page, suggestions are also welcome.
+You can also mail me at rohit0981989[at]gmail[dot]com for the same.

data/lib/http-requestor.rb

@@ -3,8 +3,12 @@ require "net/https"
 require "uri"
 
 class HttpRequestor
-  def initialize(domain)
+
+  #============== Instance Methods ===================
+  
+  def initialize(domain, options={})
     raise InvalidURISchemeException, "Please send a valid URI scheme." if domain.match(/(http|https):\/\//).nil?
+
     @defaults = {:domain => domain}
     uri = URI.parse(@defaults[:domain])
     if uri.scheme == "http"
@@ -16,7 +20,8 @@ class HttpRequestor
     end
   end
 
-  def get(path,data="",headers=nil)
+  def get(path,data={},headers=nil)
+    data = data_to_query(data)
     if headers == nil
       response = @http.send_request('GET',path,data)
     else
@@ -25,7 +30,8 @@ class HttpRequestor
     response
   end
 
-  def post(path,data="",headers=nil)
+  def post(path,data={},headers=nil)
+    data = data_to_query(data)
     if headers == nil
       response = @http.send_request('POST',path,data)
     else
@@ -34,7 +40,8 @@ class HttpRequestor
     response
   end
 
-  def put(path,data="",headers=nil)
+  def put(path,data={},headers=nil)
+    data = data_to_query(data)
     if headers == nil
       response = @http.send_request('PUT',path,data)
     else
@@ -43,7 +50,8 @@ class HttpRequestor
     response
   end
   
-  def delete(path,data="",headers=nil)
+  def delete(path,data={},headers=nil)
+    data = data_to_query(data)
     if headers == nil
       response = @http.send_request('DELETE',path,data)
     else
@@ -51,12 +59,16 @@ class HttpRequestor
     end
     response
   end
+  
+  def data_to_query(data)
+    return (data.nil? || data.empty?) ? "" : data.to_query
+  end
 
-  def self.request(domain, request_type, request_path, data="", headers={})
+  #============== Class Methods ===================
+  def self.request(domain, request_type, request_path, data={}, headers={})
     request_type.upcase!
     raise InvalidRequestTypeException, "Please pass a valid request type." unless valid_request_types.include?(request_type)
     req = HttpRequestor.new(domain)
-    data = data.empty? ? "" : data.to_query
     if request_type == "GET"
       return req.get(request_path, data, headers)
     elsif request_type == "POST"
@@ -67,12 +79,27 @@ class HttpRequestor
       return req.delete(request_path, data, headers)
     end
   end
+  
+  def self.request_with_url(url, request_type, data={}, headers={})
+    uri = URI.parse(url)
+    return self.request("#{uri.scheme}://#{uri.host}:#{uri.port}", request_type, uri.request_uri, data, headers)
+  end
+  
+  def self.send_basic_auth_request(url, username, password)
+    uri = URI.parse(url)
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    request = Net::HTTP::Get.new(uri.request_uri)
+    request.basic_auth(username, password)
+    http.request(request)
+  end
 
   def self.valid_request_types
     ["GET", "POST", "UPDATE", "DELETE"]
   end
 end
 
+#================ ActiveSupport Like object#to_query methods =========================
 class Hash
   def to_query(namespace = nil)
     collect do |key, value|
@@ -99,6 +126,7 @@ class String
   end
 end
 
+#================= Exceptions ======================
 class InvalidRequestTypeException < Exception
 end
 

data/test/http_requestor_test.rb

@@ -11,7 +11,7 @@ class HttpRequestorTest < Test::Unit::TestCase
     assert_nothing_raised(InvalidURISchemeException) { HttpRequestor.new("http://www.google.com") }
     assert_nothing_raised(InvalidURISchemeException) { HttpRequestor.new("https://www.yahoo.com") }
   end
-  
+
   def test_should_raise_error_on_invalid_request_type
     assert_raise(InvalidRequestTypeException) { HttpRequestor.request("http://en.wikibooks.org", "OPTIONS", "/wiki/Ruby_Programming/Unit_testing#A_Simple_Introduction") }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http-requestor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000Z
+date: 2012-09-27 00:00:00.000000000Z
 dependencies: []
 description: A Wrapper around Net/HTTP which allows you to perform HTTP Requests.
 email: rohit0981989@gmail.com