rufus-jig 0.1.4 → 0.1.5

data/.gitignore

@@ -0,0 +1 @@
+*.swp

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-jig CHANGELOG.txt
 
 
+== rufus-jig - 0.1.5    not yet released
+
+- returning true (not raising) in case of 409 conflict
+- using jeweler (thanks Kenneth)
+- made jig/patron really thread-safe
+
+
 == rufus-jig - 0.1.4    released 2009/12/15
 
 - made jig/patron thread-safe

data/Rakefile

@@ -0,0 +1,84 @@
+
+
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+require 'lib/rufus/jig.rb'
+
+require 'rubygems'
+require 'rake'
+
+
+#
+# CLEAN
+
+require 'rake/clean'
+CLEAN.include('pkg', 'tmp', 'html')
+task :default => [ :clean ]
+
+
+#
+# GEM
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+
+  gem.version = Rufus::Jig::VERSION
+  gem.name = 'rufus-jig'
+  gem.summary = 'An HTTP client, greedy with JSON content, GETting conditionally.'
+
+  gem.description = %{
+    Json Internet Get.
+
+    An HTTP client, greedy with JSON content, GETting conditionally.
+
+    Uses Patron and 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 'yajl-ruby'
+  #gem.add_dependency 'json'
+  gem.add_development_dependency 'yard', '>= 0'
+
+  # gemspec spec : http://www.rubygems.org/read/chapter/20
+end
+Jeweler::GemcutterTasks.new
+
+
+#
+# DOC
+
+begin
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |doc|
+    doc.options = [
+      '-o', 'html/rufus-jig', '--title',
+      "rufus-jig #{Rufus::Jig::VERSION}"
+    ]
+  end
+
+rescue LoadError
+
+  task :yard do
+    abort "YARD is not available : sudo gem install yard"
+  end
+end
+
+
+#
+# TO THE WEB
+
+task :upload_website => [ :clean, :yard ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/rufus'
+
+  sh "rsync -azv -e ssh html/rufus-jig #{account}:#{webdir}/"
+end
+

data/TODO.txt

@@ -7,17 +7,17 @@
 [o] POST/PUT cache if etag is given back (couch)
 [o] get('/x', :cache => false)
 [o] get('x') vs get('/x') ?
+[o] Net::HTTP (when no Patron)
+[x] couch : attachments
+[o] put_doc(h) where _id is set ?
+[o] :update_rev => true...
 
 [ ] long polling/continuous change (patron ?)
 [ ] HEAD
 
-[ ] Net::HTTP (when no Patron)
-
-[ ] couch : attachments
-
 [ ] redirections ? (Patron seem to understand them)
 
-[ ] put_doc(h) where _id is set ?
+[ ] don't abuse exceptions ! (especially with couch)
 
-[ ] :update_rev => true...
+[ ] patron : http can steal each other's patron session (inside the same thread)
 

data/lib/rufus/jig/couch.rb

@@ -51,24 +51,16 @@ module Rufus::Jig
 
       path = adjust(path)
 
-      begin
+      r = @http.put(path, payload, :content_type => :json, :cache => false)
 
-        r = @http.put(path, payload, :content_type => :json, :cache => false)
+      return true if r == true
+        # conflict
 
-        if opts[:update_rev] && doc_or_path.is_a?(Hash)
-          doc_or_path['_rev'] = r['rev']
-        end
-
-        nil
-
-      rescue Rufus::Jig::HttpError => he
-
-        if he.status == 409
-          true
-        else
-          raise he
-        end
+      if opts[:update_rev] && doc_or_path.is_a?(Hash)
+        doc_or_path['_rev'] = r['rev']
       end
+
+      nil
     end
 
     def get (doc_or_path)
@@ -89,34 +81,23 @@ module Rufus::Jig
 
       doc_or_path = { '_id' => doc_or_path, '_rev' => rev } if rev
 
-      begin
-
-        if doc_or_path.is_a?(String)
+      r = if doc_or_path.is_a?(String)
 
-          @http.delete(adjust(doc_or_path))
+        @http.delete(adjust(doc_or_path))
 
-        else
-
-          raise(
-            ArgumentError.new("cannot delete document without _rev")
-          ) unless doc_or_path['_rev']
-
-          path = adjust(doc_or_path['_id'])
-          path = Rufus::Jig::Path.add_params(path, :rev => doc_or_path['_rev'])
-
-          @http.delete(path)
-        end
+      else
 
-        nil
+        raise(
+          ArgumentError.new("cannot delete document without _rev")
+        ) unless doc_or_path['_rev']
 
-      rescue Rufus::Jig::HttpError => he
+        path = adjust(doc_or_path['_id'])
+        path = Rufus::Jig::Path.add_params(path, :rev => doc_or_path['_rev'])
 
-        if he.status == 409
-          true
-        else
-          raise he
-        end
+        @http.delete(path)
       end
+
+      r == true ? true : nil
     end
 
     protected

data/lib/rufus/jig/http.rb

@@ -162,6 +162,7 @@ module Rufus::Jig
 
         return Rufus::Jig.marshal_copy(cached.last) if r.status == 304
         return nil if method == :get && r.status == 404
+        return true if r.status == 409
 
         raise @error_class.new(r.status, r.body) \
           if r.status >= 400 && r.status < 600
@@ -297,7 +298,9 @@ if defined?(Patron) # gem install patron
     #
     def get_patron
 
-      patron = Thread.current["#{self.class}_patron"]
+      k = "#{self.class} #{self.object_id}"
+
+      patron = Thread.current[k]
 
       return patron if patron
 
@@ -306,9 +309,11 @@ if defined?(Patron) # gem install patron
 
       patron.headers['User-Agent'] =
         @options[:user_agent] ||
-        "#{self.class} #{Rufus::Jig::VERSION} #{Thread.current.object_id} (patron)"
+        [
+          self.class, Rufus::Jig::VERSION, Thread.current.object_id, '(patron)'
+        ].join(' ')
 
-      Thread.current["#{self.class}_patron"] = patron
+      Thread.current[k] = patron
     end
 
     def do_get (path, data, opts)

data/lib/rufus/jig.rb

@@ -29,7 +29,7 @@ module Jig
   require 'rufus/jig/http'
   require 'rufus/jig/json'
 
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 
   autoload :Couch, 'rufus/jig/couch'
   autoload :CouchError, 'rufus/jig/couch'

data/rufus-jig.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rufus-jig}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux", "Kenneth Kalmer"]
+  s.date = %q{2009-12-17}
+  s.description = %q{
+    Json Internet Get.
+
+    An HTTP client, greedy with JSON content, GETting conditionally.
+
+    Uses Patron and Yajl-ruby whenever possible.
+  }
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.txt",
+     "CREDITS.txt",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "lib/rufus-jig.rb",
+     "lib/rufus/jig.rb",
+     "lib/rufus/jig/couch.rb",
+     "lib/rufus/jig/http.rb",
+     "lib/rufus/jig/json.rb",
+     "lib/rufus/jig/path.rb",
+     "rufus-jig.gemspec",
+     "test/base.rb",
+     "test/couch_base.rb",
+     "test/ct_0_couch.rb",
+     "test/ct_1_couchdb.rb",
+     "test/server.rb",
+     "test/test.rb",
+     "test/ut_0_http_get.rb",
+     "test/ut_1_http_post.rb",
+     "test/ut_2_http_delete.rb",
+     "test/ut_3_http_put.rb",
+     "test/ut_4_http_prefix.rb",
+     "test/ut_5_http_misc.rb",
+     "test/ut_6_args.rb"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/rufus-jig/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rufus}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An HTTP client, greedy with JSON content, GETting conditionally.}
+  s.test_files = [
+    "test/test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/test/base.rb

@@ -0,0 +1,57 @@
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$: << lib unless $:.include?(lib)
+
+require 'rubygems'
+require 'yajl'
+
+# Our default
+transport_library = 'patron'
+
+if ARGV.include?( '--em' )
+  require 'openssl'
+  transport_library = 'em-http'
+elsif ARGV.include?( '--net' )
+  transport_library = 'net/http'
+end
+
+require transport_library
+
+require 'rufus/jig'
+
+require 'test/unit'
+
+if transport_library == 'em-http'
+  Thread.new { EM.run {} }
+  Thread.pass until EM.reactor_running?
+end
+
+#unless $test_server
+#
+#  pss = `ps aux | grep "test\/server.rb"`
+#  puts pss
+#
+#  $test_server = pss.index(' ruby ') || fork do
+#    #exec('ruby test/server.rb')
+#    exec('ruby test/server.rb > /dev/null 2>&1')
+#  end
+#  puts
+#  puts "...test server is at #{$test_server}"
+#  puts
+#  sleep 1
+#end
+
+begin
+  Rufus::Jig::Http.new('127.0.0.1', 4567).get('/document')
+rescue Exception => e
+  puts
+  p e
+  e.backtrace.each { |l| puts l }
+  puts
+  puts "test server not running, please run :"
+  puts
+  puts "  ruby test/server.rb"
+  puts
+  exit(1)
+end
+

data/test/couch_base.rb

@@ -0,0 +1,41 @@
+
+lib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$: << lib unless $:.include?(lib)
+
+require 'rubygems'
+require 'yajl'
+
+# Our default
+transport_library = 'patron'
+
+if ARGV.include?( '--em' )
+  require 'openssl'
+  transport_library = 'em-http'
+elsif ARGV.include?( '--net' )
+  transport_library = 'net/http'
+end
+
+p [ :lib, transport_library ]
+
+require transport_library
+
+require 'rufus/jig'
+
+require 'test/unit'
+
+if transport_library == 'em-http'
+  Thread.new { EM.run {} }
+  Thread.pass until EM.reactor_running?
+end
+
+
+begin
+  Rufus::Jig::Http.new('127.0.0.1', 5984).get('/_all_dbs')
+rescue Exception => e
+  p e
+  puts
+  puts "couch not running..."
+  puts
+  exit(1)
+end
+

data/test/ct_0_couch.rb

@@ -0,0 +1,56 @@
+
+#
+# testing rufus-jig
+#
+# Sun Nov  1 21:42:34 JST 2009
+#
+
+require File.join(File.dirname(__FILE__), 'couch_base')
+
+
+class CtCouchTest < Test::Unit::TestCase
+
+  def setup
+
+    begin
+      Rufus::Jig::Http.new('127.0.0.1', 5984).delete('/rufus_jig_test')
+    rescue Exception => e
+      #p e
+    end
+
+    @c = Rufus::Jig::Couch.new('127.0.0.1', 5984)
+  end
+
+  def test_welcome
+
+    assert_equal 'Welcome', @c.get('.')['couchdb']
+  end
+
+  def test_put_db
+
+    @c.put('rufus_jig_test')
+
+    assert_not_nil Rufus::Jig::Http.new('127.0.0.1', 5984).get('/rufus_jig_test')
+  end
+
+  def test_delete_db
+
+    Rufus::Jig::Http.new('127.0.0.1', 5984).put('/rufus_jig_test', '')
+
+    @c.delete('rufus_jig_test')
+
+    assert_nil Rufus::Jig::Http.new('127.0.0.1', 5984).get('/rufus_jig_test')
+  end
+
+#  def test_uuids
+#
+#    uuids = @c.get_uuids
+#
+#    assert_equal 1, uuids.size
+#
+#    uuids = @c.get_uuids(5)
+#
+#    assert_equal 5, uuids.size
+#  end
+end
+

data/test/ct_1_couchdb.rb

@@ -0,0 +1,127 @@
+
+#
+# testing rufus-jig
+#
+# Sun Dec 13 15:03:36 JST 2009
+#
+
+require File.join(File.dirname(__FILE__), 'couch_base')
+
+
+class CtCouchDbTest < Test::Unit::TestCase
+
+  def setup
+
+    begin
+      Rufus::Jig::Http.new('127.0.0.1', 5984).delete('/rufus_jig_test')
+    rescue Exception => e
+      #p e
+    end
+    Rufus::Jig::Http.new('127.0.0.1', 5984).put('/rufus_jig_test', '')
+
+    Rufus::Jig::Http.new('127.0.0.1', 5984).put(
+      '/rufus_jig_test/coffee1',
+      '{"_id":"coffee1","type":"ristretto"}')
+
+    @c = Rufus::Jig::Couch.new('127.0.0.1', 5984, 'rufus_jig_test')
+  end
+
+  def test_put_doc
+
+    r = @c.put('_id' => 'coffee0', 'type' => 'espresso')
+
+    assert_nil r
+
+    doc = Rufus::Jig::Http.new('127.0.0.1', 5984).get('/rufus_jig_test/coffee0')
+
+    assert_not_nil doc['_rev']
+  end
+
+  def test_put_doc_fail
+
+    r = @c.put('_id' => 'coffee1', 'type' => 'espresso')
+
+    assert_equal true, r
+  end
+
+  def test_put_update_rev
+
+    doc = { '_id' => 'soda0', 'type' => 'lemon' }
+
+    r = @c.put(doc, :update_rev => true)
+
+    assert_nil r
+    assert_not_nil doc['_rev']
+  end
+
+  def test_put_update_rev_2nd_time
+
+    @c.put({ '_id' => 'soda0b', 'type' => 'lemon' })
+    doc = @c.get('soda0b')
+    rev = doc['_rev']
+
+    r = @c.put(doc, :update_rev => true)
+
+    assert_nil r
+    assert_not_equal rev, doc['_rev']
+  end
+
+  def test_get_doc
+
+    doc = @c.get('coffee1')
+
+    assert_not_nil doc['_rev']
+  end
+
+  def test_get_missing_doc
+
+    doc = @c.get('tea0')
+
+    assert_nil doc
+  end
+
+  def test_delete_doc
+
+    doc = @c.get('coffee1')
+
+    r = @c.delete(doc)
+
+    assert_nil r
+
+    assert_nil(
+      Rufus::Jig::Http.new('127.0.0.1', 5984).get('/rufus_jig_test/coffee1'))
+  end
+
+  def test_delete_doc_2_args
+
+    doc = @c.get('coffee1')
+
+    @c.delete(doc['_id'], doc['_rev'])
+
+    assert_nil(
+      Rufus::Jig::Http.new('127.0.0.1', 5984).get('/rufus_jig_test/coffee1'))
+  end
+
+  def test_delete_doc_fail
+
+    doc = @c.get('coffee1')
+
+    rev = doc['_rev']
+
+    doc['_rev'] = rev + '99'
+
+    r = @c.delete(doc)
+
+    assert_equal true, r
+  end
+
+  def test_get_doc_304
+
+    doc = @c.get('coffee1')
+    assert_equal 200, @c.http.last_response.status
+
+    doc = @c.get('coffee1')
+    assert_equal 304, @c.http.last_response.status
+  end
+end
+