rufus-jig 0.1.23 → 1.0.0

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/CHANGELOG.txt

@@ -2,6 +2,14 @@
 = rufus-jig CHANGELOG.txt
 
 
+== rufus-jig - 1.0.0    released 2010/12/08
+
+- Couch #all, #query, #query_for_docs, #bulk_put and #bulk_delete
+- Rufus::Jig.parse_uri now identifies the #fragment
+- conditional GET on by default
+- switched from test/unit to rspec
+
+
 == rufus-jig - 0.1.23    released 2010/10/01
 
 - net-http-persistent 1.4 which contains the shutdown_in_all_threads patch

data/README.rdoc

@@ -74,8 +74,6 @@ posting...
 For the real thing : http://github.com/couchrest/couchrest
 There is also the excellent : http://github.com/langalex/couch_potato
 
-Warning : rufus-jig >= 0.1.18 is meant for CouchDB >= 0.11.
-
 The class Rufus::Jig::Couch provides a get/put/delete trio that is couch-oriented. Json encoding/decoding is automatically handled as well as
 
 put and delete return nil in case of success and true (conflict) or and exception else.
@@ -111,8 +109,32 @@ put and delete return nil in case of success and true (conflict) or and exceptio
 
   c.detach('coffee0', '1-x-newrevision-whatever', 'picture')
 
+there is also
+
+  c.all(:skip => 100, :limit => 100)
+  c.all(:keys => %w[ doc0 doc1 doc3 ])
+    # grabbing multiple docs in one go
+
+  c.query('_design/my_design_doc/_view/my_view')
+  c.query('my_design_doc:my_view')
+    # 'querying' a view
+
+  c.query_for_docs('my_design_doc:my_view')
+    # querying for documents
+
+bulk operations
+
+  docs = c.all(:keys => %w[ doc0 doc1 doc3 ])
+  c.bulk_delete(docs)
+    # deleting in one go
 
-=== on_change
+  docs = c.all(:keys => %w[ doc0 doc1 doc3 ])
+  docs.each { |doc| doc['status'] = 'copied' }
+  c.bulk_put(docs)
+    # updating in one go
+
+
+=== Couch on_change
 
 Continuous feed with a 20s heartbeat :
 
@@ -137,22 +159,29 @@ http://rufus.rubyforge.org/rufus-jig/
 
 == testing
 
-At first, make sure to start the tiny sinatra test server :
+  rake
+
+or
+
+  rspec spec/
+
+tests all (plain jig and CouchDB).
 
-  ruby test/server.rb
+  rspec spec/jig
 
-then do
+only tests the plain jig stuff.
 
-  ruby test/test.rb
+  rspec spec/couch
 
+only tests the CouchDB stuff.
 
-To test the CouchDB helpers, make you have a running Couch on http:/127.0.0.1:5984 then do
+By default net/http is used. To test with another HTTP lib :
 
-  ruby test/test.rb --couch
+  JIG_LIB=patron rspec spec/
 
-To test the em-http-request HTTP transport, make sure the sinatra server is running and then do:
+You can specify patron, em, netp or net. Netp corresponds to http://seattlerb.rubyforge.org/net-http-persistent/
 
-  ruby test/test.rb -- --em
+The specs require the json and sinatra gems. You can spot issues in the file server.log (created when running specs).
 
 
 == known issues
@@ -186,6 +215,7 @@ http://rufus.rubyforge.org
 
 * John Mettraux, http://jmettraux.wordpress.com/
 * Kenneth Kalmer, http://www.opensourcery.co.za/
+* Torsten Schoenebaum, http://github.com/tosch/
 
 
 == license

data/Rakefile

@@ -1,19 +1,11 @@
 
-
+$:.unshift('.')
 require 'lib/rufus/jig/version.rb'
 
 require 'rubygems'
 require 'rake'
 
 
-#
-# CLEAN
-
-require 'rake/clean'
-CLEAN.include('pkg', 'tmp', 'html', 'rdoc')
-task :default => [ :clean ]
-
-
 #
 # GEM
 
@@ -30,18 +22,18 @@ Jeweler::Tasks.new do |gem|
 
     An HTTP client, greedy with JSON content, GETting conditionally.
 
-    Uses Patron and Yajl-ruby whenever possible.
+    Uses Yajl-ruby whenever possible.
   }
   gem.email = 'jmettraux@gmail.com'
   gem.homepage = 'http://github.com/jmettraux/rufus-jig/'
   gem.authors = [ 'John Mettraux', 'Kenneth Kalmer' ]
   gem.rubyforge_project = 'rufus'
 
-  gem.test_file = 'test/test.rb'
-
   gem.add_dependency 'rufus-lru'
   gem.add_dependency 'rufus-json', '>= 0.2.5'
+
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec', '~> 2.2.0'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'jeweler'
   gem.add_development_dependency 'patron'
@@ -53,6 +45,39 @@ end
 Jeweler::GemcutterTasks.new
 
 
+#
+# CLEAN
+
+require 'rake/clean'
+CLEAN.include('pkg', 'tmp', 'html', 'rdoc', 'server.log')
+
+#
+# SPEC / TEST
+
+#task :spec => :check_dependencies do
+task :spec do
+  sh 'rspec spec/'
+end
+task :test => :spec
+
+task :default => :spec
+
+desc %{
+  runs the specs against net, netp, patron and em
+}
+task :specs do
+  puts; puts "-" * 80; puts
+  sh 'export JIG_LIB=net; rspec -f p spec/; exit 0'
+  puts; puts "-" * 80; puts
+  sh 'export JIG_LIB=netp; rspec -f p spec/; exit 0'
+  puts; puts "-" * 80; puts
+  sh 'export JIG_LIB=patron; rspec -f p spec/; exit 0'
+  puts; puts "-" * 80; puts
+  sh 'export JIG_LIB=em; rspec -f p spec/; exit 0'
+  puts; puts "-" * 80; puts
+end
+
+
 #
 # DOC
 

data/TODO.txt

@@ -19,14 +19,17 @@
     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)
+[o] why not a :force_json ?
+[o] netp : close() impl
+[o] views : couch#query(view, opts) ?
 
 [ ] HEAD
+[ ] OPTIONS
 [ ] redirections ? (Patron seem to understand them)
-[ ] why not a :force_json ?
 
 [ ] make HttpCore detect do_request
-
 [ ] timeout per request ?
+[ ] caching
 
-[ ] netp : close() impl
+[ ] digest auth (as for rufus-verbs) ?
 

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

@@ -25,20 +25,20 @@
 
 class Rufus::Jig::HttpResponse
 
-  def initialize( em_client )
+  def initialize(em_client)
 
     @original = [ em_client, em_client.response ]
 
     @status = em_client.response_header.status
-    @headers = response_headers( em_client.response_header )
+    @headers = response_headers(em_client.response_header)
     @body = em_client.response
   end
 
   protected
 
-  def response_headers( hash )
+  def response_headers(hash)
 
-    hash.inject({}) do |headers, ( key, value )|
+    hash.inject({}) do |headers, (key, value)|
       key = key.downcase.split('_').map { |c| c.capitalize }.join( '-' )
       headers[ key ] = value
       headers
@@ -50,9 +50,9 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
   require 'uri'
 
-  def initialize( *args )
+  def initialize(*args)
 
-    super( *args )
+    super(*args)
 
     @options[:user_agent] ||= "#{self.class} #{Rufus::Jig::VERSION} (em)"
   end
@@ -68,11 +68,11 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
   protected
 
-  def do_request( method, path, data, opts )
+  def do_request(method, path, data, opts)
 
     args = {}
 
-    args[:head] = request_headers( opts )
+    args[:head] = request_headers(opts)
     args[:body] = data if data
 
     if to = (opts[:timeout] || @options[:timeout])
@@ -83,26 +83,23 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     end
 
     if auth = @options[:basic_auth]
-      args[:head].merge!( 'authorization' => auth )
+      args[:head].merge!('authorization' => auth)
     end
 
-    em_response( em_request( path ).send( method, args ) )
+    em_response(em_request(path).send(method, args))
   end
 
-  def em_request( uri = '/' )
+  def em_request(uri='/')
 
-    uri = Rufus::Jig.parse_uri( uri )
-    uri = URI::HTTP.build(
-      :host => uri.host || @host,
-      :port => uri.port || @port,
-      :path => uri.path,
-      :query => uri.query
-    )
+    uri = Rufus::Jig.parse_uri(uri)
+    uri.scheme ||= (@port == 443 ? 'https' : 'http')
+    uri.host ||= @host
+    uri.port ||= @port
 
-    EventMachine::HttpRequest.new( uri.to_s )
+    EventMachine::HttpRequest.new(uri.to_s)
   end
 
-  def em_response( em_client )
+  def em_response(em_client)
 
     th = Thread.current
 
@@ -110,7 +107,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
     em_client.errback {
 
-      #th.raise( Rufus::Jig::TimeoutError.new )
+      #th.raise(Rufus::Jig::TimeoutError.new)
         # works with ruby < 1.9.x
       th.wakeup
     }
@@ -125,15 +122,15 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
     raise Rufus::Jig::TimeoutError if em_client.response_header.status == 0
 
-    Rufus::Jig::HttpResponse.new( em_client )
+    Rufus::Jig::HttpResponse.new(em_client)
   end
 
-  def request_headers( options )
+  def request_headers(options)
 
     headers = { 'user-agent' => @options[:user_agent] }
 
     %w[ Accept If-None-Match Content-Type ].each do |k|
-      headers[k] = options[k] if options.has_key?( k )
+      headers[k] = options[k] if options.has_key?(k)
     end
 
     headers

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

@@ -23,12 +23,11 @@
 #++
 
 require 'net/http'
-require 'rufus/jig/adapters/net_response'
 
 
 class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
-  def initialize (*args)
+  def initialize(*args)
 
     super(*args)
 
@@ -45,7 +44,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
   protected
 
-  def get_http (opts)
+  def get_http(opts)
 
     http = Net::HTTP.new(@host, @port)
 
@@ -62,7 +61,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     http
   end
 
-  def do_request (method, path, data, opts)
+  def do_request(method, path, data, opts)
 
     path = '/' if path == ''
 

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

@@ -23,12 +23,9 @@
 #++
 
 
-require 'rufus/jig/adapters/net_response'
-
-
 class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
-  def initialize (*args)
+  def initialize(*args)
 
     super(*args)
 
@@ -38,6 +35,14 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     name = [ 'jig', @host, @port.to_s ].join('|')
 
     @http = Net::HTTP::Persistent.new(name)
+
+    @http.open_timeout = 5
+      # connection timeout
+
+    @timeout = @options[:timeout]
+    @timeout = @timeout.to_i if @timeout
+
+    reset_timeout
   end
 
   def variant
@@ -54,7 +59,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
   protected
 
-  def do_request (method, path, data, opts)
+  def do_request(method, path, data, opts)
 
     path = '/' if path == ''
 
@@ -66,13 +71,27 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     if auth = @options[:basic_auth]
       req.basic_auth(*auth)
     end
+    if to = opts[:timeout]
+      @http.read_timeout = to
+    end
 
     req.body = data ? data : ''
 
     begin
       Rufus::Jig::HttpResponse.new(@http.request(uri, req))
-    rescue Timeout::Error => te
-      raise Rufus::Jig::TimeoutError
+    rescue Net::HTTP::Persistent::Error => nhpe
+      raise Rufus::Jig::TimeoutError if nhpe.message.match(/Timeout::Error/)
+    ensure
+      reset_timeout
+    end
+  end
+
+  def reset_timeout
+
+    if @timeout
+      @http.read_timeout = (@timeout < 1) ? nil : @timeout
+    else
+      @http.read_timeout = 5 # like Patron
     end
   end
 end

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

@@ -23,20 +23,31 @@
 #++
 
 
+#
+# Re-opening to adapt to Patron
+#
 class Rufus::Jig::HttpResponse
 
-  def initialize (patron_res)
+  NHR = /^Net::HTTP/
+
+  def initialize(res)
 
-    @original = patron_res
-    @status = patron_res.status
-    @headers = patron_res.headers
-    @body = patron_res.body
+    if NHR.match(res.class.name)
+      # for the couch#attach workaround :-( ...
+      net_http_init(res)
+      return
+    end
+
+    @original = res
+    @status = res.status
+    @headers = res.headers
+    @body = res.body
   end
 end
 
 class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
-  def initialize (*args)
+  def initialize(*args)
 
     super(*args)
 
@@ -54,11 +65,15 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
 
   protected
 
-  def get_patron (opts)
+  def get_patron(opts)
 
     to = (opts[:timeout] || @options[:timeout])
     to = to.to_i if to
-    to = nil if to && to < 1
+    to = if to
+      to < 1 ? nil : to
+    else
+      5
+    end
 
     patron = Patron::Session.new
     patron.base_url = "#{@host}:#{@port}"
@@ -80,7 +95,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     patron
   end
 
-  def do_request (method, path, data, opts)
+  def do_request(method, path, data, opts)
 
     opts['Expect'] = '' if (method == :put) && ( ! @options[:expect])
 
@@ -90,7 +105,7 @@ class Rufus::Jig::Http < Rufus::Jig::HttpCore
     end
 
     begin
-      get_patron(opts).send(method, *args)
+      Rufus::Jig::HttpResponse.new(get_patron(opts).send(method, *args))
     rescue Patron::TimeoutError => te
       raise Rufus::Jig::TimeoutError
     end