evdispatch 0.3.0 → 0.3.1

data/History.txt

@@ -1,3 +1,6 @@
+== 0.3.1 2008-04-23
+  * Add support to set arbitrary HTTP headers
+
 == 0.3.0 2008-04-22 
   * Add type checking
   * Add support to stream responses directly to Ruby main thread over a pipe

data/ext/revdispatch/libdispatch-0.1/src/ev_dispatch.h

@@ -11,6 +11,9 @@
 #include <queue>
 #include <map>
 
+// declare ahead of time
+struct curl_slist;
+
 namespace EVD {
 
   // unique id to represent a request
@@ -42,6 +45,7 @@ namespace EVD {
 
     // by default this does nothing, each real request object can do as it pleases with this feature
     virtual void set_opt( const std::string &key, const std::string &value ){}
+    virtual void set_opt( const std::string &key, struct curl_slist *slist ){}
  
     virtual void set_key( request_t key ){ this->key = key; }
 

data/ext/revdispatch/libdispatch-0.1/src/ev_http.cc

@@ -287,6 +287,10 @@ HttpRequest::HttpRequest( Dispatch &dispatch, const std::string &url, int fd )
     m_client(dispatch.getHttpClient())
 {
   assert(m_client);
+  // prevent libcurl from sending signals or installing signal handles
+  curl_easy_setopt(m_handle,CURLOPT_NOSIGNAL,1);
+  // we won't be sending progress
+  curl_easy_setopt(m_handle,CURLOPT_NOPROGRESS,1);
   init_curl();
 }
 
@@ -346,6 +350,28 @@ void HttpRequest::set_key( request_t key )
   m_response->id = key;
 }
 
+void HttpRequest::set_opt( const std::string &key, struct curl_slist *slist )
+{
+  Request::set_opt(key,slist);
+  std::map<std::string,CURLoption> key_loopup;
+  key_loopup["headers"] = CURLOPT_HTTPHEADER;
+  std::map<std::string,CURLoption>::iterator loc = key_loopup.find(key);
+  if( loc != key_loopup.end() ) {
+    CURLoption val_type = loc->second;
+    if( key == "headers" ) {
+      // construct a slist of headers 
+      curl_easy_setopt( m_handle, val_type, slist );
+      if( slist ) {
+        // we need to keep a reference to the options slist so we can cleanup after the request completes
+        this->m_response->add_to_free_list( slist );
+      }
+    }
+  }
+  else {
+    printf("invalid option: %s", key.c_str() );
+  }
+}
+
 void HttpRequest::set_opt( const std::string &key, const std::string &value )
 {
   Request::set_opt(key,value);
@@ -367,7 +393,7 @@ void HttpRequest::set_opt( const std::string &key, const std::string &value )
   key_loopup["post"] = CURLOPT_POSTFIELDS;
 
   std::map<std::string,CURLoption>::iterator loc = key_loopup.find(key);
-  if( loc != key_loopup.end() ){
+  if( loc != key_loopup.end() ) {
     CURLoption val_type = loc->second;
     if( val_type >= CURLOPTTYPE_LONG && val_type < CURLOPTTYPE_OBJECTPOINT ) {
       long val = atoi(value.c_str());
@@ -391,6 +417,9 @@ void HttpRequest::set_opt( const std::string &key, const std::string &value )
       }
     }
   }
+  else {
+    printf("invalid option: %s", key.c_str() );
+  }
 }
 
 HttpResponse::HttpResponse( const std::string &url )
@@ -401,6 +430,14 @@ HttpResponse::HttpResponse(  const std::string &url, int fd )
   : Response(url), m_fd(fd)
 {
 }
+HttpResponse::~HttpResponse()
+{
+  for( std::set<struct curl_slist*>::iterator it = m_request_opts.begin();
+       it != m_request_opts.end(); ++it ) {
+    curl_slist_free_all( *it );
+  }
+  m_request_opts.clear();
+}
 void HttpResponse::write( void *ptr, size_t realsize, size_t size, size_t nmemb )
 {
 //  printf( "  write: %s, %d\n", this->name.c_str(), realsize );

data/ext/revdispatch/libdispatch-0.1/src/ev_http.h

@@ -4,6 +4,7 @@
 #include "config.h"
 #include "ev_dispatch.h"
 #include <curl/curl.h>
+#include <set>
 
 namespace EVD {
 
@@ -57,6 +58,7 @@ namespace EVD {
 
     virtual void set_key( request_t key );
     virtual void set_opt( const std::string &key, const std::string &value );
+    virtual void set_opt( const std::string &key, struct curl_slist *slist );
 
     static size_t write_cb(void *ptr, size_t size, size_t nmemb, void *data);
     static size_t header_write_cb(void *ptr, size_t size, size_t nmemb, void *data);
@@ -74,13 +76,19 @@ namespace EVD {
   struct HttpResponse : public Response {
     HttpResponse( const std::string &url );
     HttpResponse( const std::string &url, int fd );
+    virtual ~HttpResponse();
 
     void write( void *ptr, size_t realsize, size_t size, size_t nmemb );
     void write_header( void *ptr, size_t realsize, size_t size, size_t nmemb );
     void finish( HttpClient *client, CURLcode rc );
+
+    void add_to_free_list( struct curl_slist *opts ){ m_request_opts.insert(opts); }
  
     int m_fd;
     std::string m_header;
+  private:
+    // keep these around to free, everytime someone calls set_opt("header", slist) we store the pointer here
+    std::set<struct curl_slist*> m_request_opts;
   };
 
 }

data/ext/revdispatch/libdispatch-0.1/test/opt_test.cc

@@ -25,6 +25,12 @@ static void run_tests( Dispatch &dispatcher, int count )
   req->set_opt("useragent", "users are us");
   req->set_opt("cookie", "name1=content1; name2=content2;");
 
+  // set some arbitry headers
+  struct curl_slist *slist = NULL;
+  slist = curl_slist_append(slist, "x-my-header1: hi"); 
+  slist = curl_slist_append(slist, "x-my-header2: hello"); 
+  req->set_opt("headers", slist );
+
   request_t id = dispatcher.request( req );
 
   while( dispatcher.wait_for_response_by_id( id, Timer(1,5) ) ) {

data/ext/revdispatch/revdispatch.cc

@@ -1,5 +1,6 @@
 #include "util.h"
 #include "rhttp.h"
+#include <st.h>
 
 
 /*
@@ -93,8 +94,35 @@ VALUE Loop_request_http( VALUE self, VALUE url )
     req->set_opt(name, RSTRING_PTR(obj));\
   }\
 }
+
+static int
+build_header_list(VALUE key, VALUE value, struct curl_slist **slist )
+{
+  if (key == Qundef) return ST_CONTINUE;
+  VALUE str = rb_str_new(RSTRING_PTR(key),RSTRING_LEN(key));
+  str = rb_str_cat2(str,":");
+  *slist = curl_slist_append(*slist, RSTRING_PTR(rb_str_append(str,value)) ); 
+  return ST_CONTINUE;
+}
+
+static struct curl_slist *build_headers( VALUE hash )
+{
+  struct curl_slist *slist = NULL;
+  rb_hash_foreach( hash, (int (*)(...))build_header_list, (VALUE)&slist );
+  return slist;
+}
+
+static void set_headers( VALUE options, EVD::HttpRequest *req )
+{
+  VALUE hash = rb_hash_aref( options, ID2SYM(rb_intern("headers")) );
+  if( !NIL_P(hash) && TYPE(hash) == T_HASH ) {
+    struct curl_slist *headers = build_headers( hash );
+    req->set_opt( "headers", headers );
+  }
+}
+
 // set options
-#define SET_REQ_OPTS \
+#define SET_REQ_OPTS(options,req) \
   SET_LONG_VAL("port"); \
   SET_STR_VAL("autoreferer"); \
   SET_LONG_VAL("followlocation"); \
@@ -102,7 +130,9 @@ VALUE Loop_request_http( VALUE self, VALUE url )
   SET_STR_VAL("referer"); \
   SET_STR_VAL("useragent"); \
   SET_STR_VAL("cookie"); \
-  SET_STR_VAL("post");
+  SET_STR_VAL("post"); \
+  set_headers(options, req)
+
 
 /**
  * call-seq:
@@ -123,6 +153,7 @@ VALUE Loop_request_http( VALUE self, VALUE url )
  *            If you need to set multiple cookies, you need to set them all using a single option and thus you need to concatenate them all in one single string. Set multiple cookies in one string like this: "name1=content1; name2=content2;" etc.
  *            Note that this option sets the cookie header explictly in the outgoing request(s). If multiple requests are done due to authentication, followed redirections or similar, they will all get this cookie passed on.
  *            Using this option multiple times will only make the latest string override the previous ones.
+ *   :headers: (Hash) An arbitrary list of HTTP Headers. Set any HTTP header or override the defaults. see libcurl's documentation for more details.
  *
  *   :post: (String) Pass a string and sets CURLOPT_POST, CURLOPT_POSTFIELDSIZE, and CURLOPT_COPYPOSTFIELDS
  *
@@ -158,8 +189,8 @@ VALUE Loop_request( int argc, VALUE *argv, VALUE self )
 
     EVD::HttpRequest *req = new EVD::HttpRequest( *d, RSTRING_PTR(url), res->m_pipe[1] );
 
-    SET_REQ_OPTS 
-
+    SET_REQ_OPTS(options,req);
+    
     res->m_response = req->m_response;
 
     d->request(req);
@@ -167,7 +198,8 @@ VALUE Loop_request( int argc, VALUE *argv, VALUE self )
   }
   else {
     EVD::HttpRequest *req = new EVD::HttpRequest( *d, RSTRING_PTR(url) );
-    SET_REQ_OPTS 
+
+    SET_REQ_OPTS(options,req);
 
     return rb_int_new( d->request(req) );
   }

data/ext/revdispatch/stest.rb

@@ -30,7 +30,12 @@ class TestRequests < Test::Unit::TestCase
   end
 
   def test_options_request
-    id = loop.request("http://127.0.0.1:4044/redir/1", :followlocation => 1, :referer => 'pizza')
+    id = loop.request("http://127.0.0.1:4044/redir/1",
+                      :followlocation => 1,
+                      :referer => 'pizza',
+                      :headers => {
+                        'Simple' => 'Thoughts'
+                      })
     response = loop.response( id )
     assert_not_nil( response )
     assert_match(/ 302 Moved Temporarily/,response[:header])

data/lib/evdispatch/version.rb

@@ -2,7 +2,7 @@ module Evdispatch #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/website/index.html

@@ -18,7 +18,7 @@
     <h1>evdispatch</h1>
     <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/evdispatch"; return false'>
       <p>Get Version</p>
-      <a href="http://rubyforge.org/projects/evdispatch" class="numbers">0.3.0</a>
+      <a href="http://rubyforge.org/projects/evdispatch" class="numbers">0.3.1</a>
     </div>
     <h4 style="float:right;padding-right:10px;">&#x2192; &#8216;evdispatch&#8217;</h4>
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: evdispatch
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Todd A. Fisher
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-22 00:00:00 -04:00
+date: 2008-04-23 00:00:00 -04:00
 default_executable: 
 dependencies: []