rufus-jig 0.1.21 → 0.1.22

data/CHANGELOG.txt

@@ -2,7 +2,15 @@
 = rufus-jig CHANGELOG.txt
 
 
-== rufus-jig - 0.1.21    release 2010/09/21
+== rufus-jig - 0.1.22    released 2010/09/30
+
+- close methods are back
+- basic authentication added
+- net-http-persistent integration
+- Rufus::Jig.parse_uri(s), uri now has scheme
+
+
+== rufus-jig - 0.1.21    released 2010/09/21
 
 - fixed port.to_i minor issue
 - caching is only for GET !

data/README.rdoc

@@ -11,6 +11,11 @@ This library also contains some CouchDB helpers.
 To select a HTTP transport layer for rufus-jig, just make sure you have loaded
 the library before loading rufus-jig.
 
+For net-http-persistent:
+
+  require 'net/http/persistent'
+  require 'rufus/jig'
+
 For Patron:
 
   require 'patron'
@@ -33,7 +38,7 @@ Let's say we have an hypothetical document server.
 
 getting...
 
-  require 'patron'
+  require 'net/http/persistent'
   require 'yajl'
   require 'rufus/jig'
 
@@ -49,8 +54,6 @@ getting...
   p [ r.status, r.body ]
     #
     # => [ 200, "letter:\n\nfour birds" ]
-    #
-    # else returns a Response object (currently the one of Patron)
 
   j = @h.get('/document', :content_type => 'application/json')
   j = @h.get('/document', :content_type => :json)
@@ -77,7 +80,7 @@ The class Rufus::Jig::Couch provides a get/put/delete trio that is couch-oriente
 
 put and delete return nil in case of success and true (conflict) or and exception else.
 
-  require 'patron'
+  require 'net/http/persistent'
   require 'yajl'
   require 'rufus/jig'
 
@@ -108,9 +111,6 @@ put and delete return nil in case of success and true (conflict) or and exceptio
 
   c.detach('coffee0', '1-x-newrevision-whatever', 'picture')
 
-...
-
-Warning : Patron, as of 0.4.5 is timing out when PUTting images.
 
 === on_change
 
@@ -155,6 +155,11 @@ To test the em-http-request HTTP transport, make sure the sinatra server is runn
   ruby test/test.rb -- --em
 
 
+== known issues
+
+- the EM based client cannot deal with non-ASCII paths
+
+
 == mailing list
 
 On the rufus-ruby list :

data/TODO.txt

@@ -15,16 +15,18 @@
 [x] don't abuse exceptions ! (especially with couch)
 [o] couch.attach
 [o] couch.detach ?
+[o] net http persistent
+    http://seattlerb.rubyforge.org/net-http-persistent/Net/HTTP/Persistent.html
+[o] HttpResponse : DRY net and netp
+[x] patron : http can steal each other's patron session (inside the same thread)
 
 [ ] HEAD
 [ ] redirections ? (Patron seem to understand them)
-[ ] patron : http can steal each other's patron session (inside the same thread)
 [ ] why not a :force_json ?
 
 [ ] make HttpCore detect do_request
 
 [ ] timeout per request ?
 
-[ ] net http persistent
-    http://seattlerb.rubyforge.org/net-http-persistent/Net/HTTP/Persistent.html
+[ ] netp : close() impl
 

data/lib/rufus/jig/adapters/em.rb

@@ -48,9 +48,11 @@ end
 
 class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
-  def initialize ( host, port, opts={} )
+  require 'uri'
 
-    super( host, port, opts )
+  def initialize( *args )
+
+    super( *args )
 
     @options[:user_agent] ||= "#{self.class} #{Rufus::Jig::VERSION} (em)"
   end
@@ -59,9 +61,14 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     :em
   end
 
+  def close
+
+    # nothing to do
+  end
+
   protected
 
-  def do_request ( method, path, data, opts )
+  def do_request( method, path, data, opts )
 
     args = {}
 
@@ -75,14 +82,19 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
       args[:timeout] = 5.0 # like Patron
     end
 
+    if auth = @options[:basic_auth]
+      args[:head].merge!( 'authorization' => auth )
+    end
+
     em_response( em_request( path ).send( method, args ) )
   end
 
   def em_request( uri = '/' )
+
     uri = Rufus::Jig.parse_uri( uri )
     uri = URI::HTTP.build(
-      :host => ( uri.host || @host ),
-      :port => ( uri.port || @port ),
+      :host => uri.host || @host,
+      :port => uri.port || @port,
       :path => uri.path,
       :query => uri.query
     )
@@ -91,6 +103,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
   end
 
   def em_response( em_client )
+
     th = Thread.current
 
     timedout = false
@@ -116,6 +129,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
   end
 
   def request_headers( options )
+
     headers = { 'user-agent' => @options[:user_agent] }
 
     %w[ Accept If-None-Match Content-Type ].each do |k|

data/lib/rufus/jig/adapters/net.rb

@@ -22,39 +22,27 @@
 # Made in Japan.
 #++
 
-require 'thread'
 require 'net/http'
+require 'rufus/jig/adapters/net_response'
 
 
-class Rufus::Jig::HttpResponse
-
-  def initialize (nh_res)
-
-    @original = nh_res
-    @status = nh_res.code.to_i
-    @body = nh_res.body
-    @headers = {}
-    nh_res.each { |k, v|
-      @headers[k.split('-').collect { |s| s.capitalize }.join('-')] = v
-    }
-  end
-end
-
 class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
-  def initialize (host, port, opts={})
+  def initialize (*args)
 
-    super(host, port, opts)
+    super(*args)
 
     @options[:user_agent] ||= "#{self.class} #{Rufus::Jig::VERSION} (net/http)"
-
-    #@mutex = Mutex.new
   end
 
   def variant
     :net
   end
 
+  def close
+    # nothing to do
+  end
+
   protected
 
   def get_http (opts)
@@ -76,8 +64,6 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
   def do_request (method, path, data, opts)
 
-    #@mutex.synchronize do
-
     path = '/' if path == ''
 
     req = eval("Net::HTTP::#{method.to_s.capitalize}").new(path)
@@ -85,14 +71,20 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     req['User-Agent'] = @options[:user_agent]
     opts.each { |k, v| req[k] = v if k.is_a?(String) }
 
+    if auth = @options[:basic_auth]
+      req.basic_auth(*auth)
+    end
+
     req.body = data ? data : ''
 
     begin
-      Rufus::Jig::HttpResponse.new(get_http(opts).start { |h| h.request(req) })
+      http = get_http(opts)
+      Rufus::Jig::HttpResponse.new(http.start { |h| h.request(req) })
     rescue Timeout::Error => te
       raise Rufus::Jig::TimeoutError
+    ensure
+      http.finish rescue nil
     end
-    #end
   end
 end
 

data/lib/rufus/jig/adapters/net_persistent.rb

@@ -0,0 +1,101 @@
+#--
+# Copyright (c) 2009-2010, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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 OR COPYRIGHT HOLDERS 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.
+#
+# Made in Japan.
+#++
+
+
+require 'rufus/jig/adapters/net_response'
+
+
+#
+# Re-opening Net::HTTP::Persistent to add a shutdown_in_all_threads method.
+#
+class Net::HTTP::Persistent
+
+  # Shuts down this instance's connection in all the threads.
+  #
+  # (to avoid too many open files issues).
+  #
+  def shutdown_in_all_threads
+
+    Thread.list.each do |t|
+
+      if cons = t[@connection_key]
+        cons.each { |_, connection| connection.finish rescue IOError }
+      end
+
+      t[@connection_key] = nil
+      t[@request_key] = nil
+    end
+  end
+end
+
+
+class Rufus::Jig::Http < Rufus::Jig::HttpCore
+
+  def initialize (*args)
+
+    super(*args)
+
+    @options[:user_agent] ||=
+      "#{self.class} #{Rufus::Jig::VERSION} (net/http/persistent)"
+
+    @http = Net::HTTP::Persistent.new
+  end
+
+  def variant
+    :net_persistent
+  end
+
+  # Closes the connection
+  #
+  def close
+
+    #@http.shutdown
+    @http.shutdown_in_all_threads
+  end
+
+  protected
+
+  def do_request (method, path, data, opts)
+
+    path = '/' if path == ''
+
+    req = eval("Net::HTTP::#{method.to_s.capitalize}").new(path)
+
+    req['User-Agent'] = @options[:user_agent]
+    opts.each { |k, v| req[k] = v if k.is_a?(String) }
+
+    if auth = @options[:basic_auth]
+      req.basic_auth(*auth)
+    end
+
+    req.body = data ? data : ''
+
+    begin
+      Rufus::Jig::HttpResponse.new(@http.request(uri, req))
+    rescue Timeout::Error => te
+      raise Rufus::Jig::TimeoutError
+    end
+  end
+end
+

data/lib/rufus/jig/adapters/net_response.rb

@@ -0,0 +1,42 @@
+#--
+# Copyright (c) 2009-2010, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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 OR COPYRIGHT HOLDERS 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.
+#
+# Made in Japan.
+#++
+
+
+#
+# a Rufus::Jig wrapper for the server response.
+#
+class Rufus::Jig::HttpResponse
+
+  def initialize (nh_res)
+
+    @original = nh_res
+    @status = nh_res.code.to_i
+    @body = nh_res.body
+    @headers = {}
+    nh_res.each { |k, v|
+      @headers[k.split('-').collect { |s| s.capitalize }.join('-')] = v
+    }
+  end
+end
+

data/lib/rufus/jig/adapters/patron.rb

@@ -36,23 +36,22 @@ end
 
 class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
-  def initialize (host, port, opts={})
+  def initialize (*args)
 
-    super(host, port, opts)
-  end
-
-  def close
+    super(*args)
 
-    # it's not really closing, it's rather making sure the patron
-    # session can get collected as garbage
-
-    #Thread.current[key] = nil
+    @options[:user_agent] ||= "#{self.class} #{Rufus::Jig::VERSION} (patron)"
   end
 
   def variant
     :patron
   end
 
+  def close
+
+    # nothing to do
+  end
+
   protected
 
   def get_patron (opts)
@@ -72,6 +71,12 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
       @options[:user_agent] ||
       [ self.class, Rufus::Jig::VERSION, '(patron)' ].join(' ')
 
+    if auth = @options[:basic_auth]
+      patron.auth_type = :basic
+      patron.username = auth[0]
+      patron.password = auth[1]
+    end
+
     patron
   end
 

data/lib/rufus/jig/couch.rb

@@ -22,6 +22,7 @@
 # Made in Japan.
 #++
 
+require 'base64'
 require 'socket'
   # for #on_change
 
@@ -39,9 +40,9 @@ module Rufus::Jig
 
     def initialize (*args)
 
-      @http, @path, payload, @opts = Rufus::Jig::Http.extract_http(false, *args)
+      @http = Rufus::Jig::Http.new(*args)
 
-      @path ||= '/'
+      @path = @http._path || '/'
     end
 
     def name
@@ -248,15 +249,43 @@ module Rufus::Jig
       query = {
         'feed' => 'continuous',
         'heartbeat' => opts[:heartbeat] || 20_000 }
+        #'since' => 0 } # that's already the default
       query['include_docs'] = true if block.arity > 2
       query = query.map { |k, v| "#{k}=#{v}" }.join('&')
 
       socket = TCPSocket.open(@http.host, @http.port)
 
+      auth = @http.options[:basic_auth]
+
+      if auth
+        auth = Base64.encode64(auth.join(':')).strip
+        auth = "Authorization: Basic #{auth}\r\n"
+      else
+        auth = ''
+      end
+
       socket.print("GET /#{path}/_changes?#{query} HTTP/1.1\r\n")
       socket.print("User-Agent: rufus-jig #{Rufus::Jig::VERSION}\r\n")
+      #socket.print("Accept: application/json;charset=UTF-8\r\n")
+      socket.print(auth)
       socket.print("\r\n")
 
+      # consider reply
+
+      answer = socket.gets.strip
+      status = answer.match(/^HTTP\/.+ (\d{3}) /)[1].to_i
+
+      raise Rufus::Jig::HttpError.new(status, answer) if status != 200
+
+      # discard headers
+
+      loop do
+        data = socket.gets
+        break if data.nil? || data == "\r\n"
+      end
+
+      # the on_change loop
+
       loop do
         data = socket.gets
         break if data.nil?