rufus-jig 0.1.13 → 0.1.14

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-jig CHANGELOG.txt
 
 
+== rufus-jig - 0.1.14    released 2010/02/25
+
+- temporary fallback to net/http for Couch#attach and patron
+- implemented Rufus::Jig::Couch#attach and #detach
+  warning : Patron as of 0.4.5 is not OK with PUTting attachments
+
+
 == rufus-jig - 0.1.13    released 2010/02/12
 
 - implemented Rufus::Jig::Couch#post

data/README.rdoc

@@ -94,8 +94,22 @@ put and delete return nil in case of success and true (conflict) or and exceptio
 
   c.delete(doc1['_id'], doc1['_rev'])
 
+  # ...
+
+  c.attach(
+    doc0, 'picture', File.read('espresso.jpg'), :content_type => 'image/jpeg')
+      # or
+  c.attach(
+    doc0['_id'], doc0['_rev'], 'picture', File.read('espresso.jpg'), :content_type => 'image/jpeg')
+
+  picture = c.get('coffe0/picture')
+
+  c.detach('coffee0', '1-x-newrevision-whatever', 'picture')
+
 ...
 
+Warning : Patron, as of 0.4.5 is timing out when PUTting images.
+
 
 == rdoc
 

data/Rakefile

@@ -41,8 +41,10 @@ Jeweler::Tasks.new do |gem|
 
   gem.add_dependency 'rufus-lru'
   gem.add_dependency 'rufus-json'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'yard'
   gem.add_development_dependency 'jeweler'
+  gem.add_development_dependency 'patron'
 
   # gemspec spec : http://www.rubygems.org/read/chapter/20
 end

data/TODO.txt

@@ -23,3 +23,6 @@
 
 [ ] why not a :force_json ?
 
+[ ] couch.attach
+[ ] couch.detach ?
+

data/lib/rufus/jig/couch.rb

@@ -25,6 +25,10 @@
 
 module Rufus::Jig
 
+  #
+  # A class wrapping an instance of Rufus::Jig::Http and providing
+  # CouchDB-oriented http verbs.
+  #
   class Couch
 
     attr_reader :http
@@ -134,6 +138,86 @@ module Rufus::Jig
       @http.post(path, doc, opts)
     end
 
+    # Attaches a file to a couch document.
+    #
+    #   couch.attach(
+    #     doc['_id'], doc['_rev'], 'my_picture', data,
+    #     :content_type => 'image/jpeg')
+    #
+    # or
+    #
+    #   couch.attach(
+    #     doc, 'my_picture', data,
+    #     :content_type => 'image/jpeg')
+    #
+    def attach (doc_id, doc_rev, attachment_name, data, opts=nil)
+
+      if opts.nil?
+        opts = data
+        data = attachment_name
+        attachment_name = doc_rev
+        doc_rev = doc_id['_rev']
+        doc_id = doc_id['_id']
+      end
+
+      attachment_name = attachment_name.gsub(/\//, '%2F')
+
+      ct = opts[:content_type]
+
+      raise(ArgumentError.new(
+        ":content_type option must be specified"
+      )) unless ct
+
+      opts[:cache] = false
+
+      path = adjust("#{doc_id}/#{attachment_name}?rev=#{doc_rev}")
+
+      if @http.variant == :patron
+        #
+        # patron, as of 0.4.5 has difficulties when PUTting attachements
+        # this is a fallback to net/http
+        #
+        require 'net/http'
+        http = Net::HTTP.new(@http.host, @http.port)
+        req = Net::HTTP::Put.new(path)
+        req['User-Agent'] =
+          "rufus-jig #{Rufus::Jig::VERSION} (patron 0.4.5 fallback to net/http)"
+        req['Content-Type'] =
+          opts[:content_type]
+        req.body = data
+        res = http.start { |h| h.request(req) }
+        status = res.code.to_i
+        raise Rufus::Jig::HttpError.new(status, res.body) \
+          unless [ 200, 201 ].include?(status)
+        return nil
+      end
+
+      @http.put(path, data, opts)
+    end
+
+    # Detaches a file from a couch document.
+    #
+    #   couch.detach(doc['_id'], doc['_rev'], 'my_picture')
+    #
+    # or
+    #
+    #   couch.detach(doc, 'my_picture')
+    #
+    def detach (doc_id, doc_rev, attachment_name=nil)
+
+      if attachment_name.nil?
+        attachment_name = doc_rev
+        doc_rev = doc_id['_rev']
+        doc_id = doc_id['_id']
+      end
+
+      attachment_name = attachment_name.gsub(/\//, '%2F')
+
+      path = adjust("#{doc_id}/#{attachment_name}?rev=#{doc_rev}")
+
+      @http.delete(path)
+    end
+
     protected
 
     def adjust (path)

data/lib/rufus/jig/http.rb

@@ -246,12 +246,23 @@ module Rufus::Jig
 
     def repack_data (data, opts)
 
-      return data if data.nil? || data.is_a?(String)
+      return nil unless data
 
-      return Rufus::Json.encode(data) \
-        if (opts['Content-Type'] || '').match(/^application\/json/)
 
-      data.to_s
+      data = if data.is_a?(String)
+        data
+      elsif (opts['Content-Type'] || '').match(/^application\/json/)
+        Rufus::Json.encode(data)
+      else
+        data.to_s
+      end
+
+      #opts['Content-Length'] =
+      #  (data.respond_to?(:bytesize) ? data.bytesize : data.size).to_s
+        #
+        # Patron doesn't play well with custom lengths : "56, 56" issue
+
+      data
     end
 
     def do_cache (method, path, response, body, opts)
@@ -306,6 +317,10 @@ if defined?(Patron) # gem install patron
       Thread.current[key] = nil
     end
 
+    def variant
+      :patron
+    end
+
     protected
 
     def key
@@ -394,6 +409,10 @@ elsif defined?( EventMachine::HttpRequest )
       @em_ua = opts[:user_agent] || "#{self.class} #{Rufus::Jig::VERSION} (em)"
     end
 
+    def variant
+      :em
+    end
+
     protected
 
     def do_get( path, data, opts )
@@ -496,6 +515,10 @@ else
       @mutex = Mutex.new
     end
 
+    def variant
+      :net
+    end
+
     protected
 
     def do_get (path, data, opts)

data/lib/rufus/jig/version.rb

@@ -1,7 +1,7 @@
 
 module Rufus
 module Jig
-  VERSION = '0.1.13'
+  VERSION = '0.1.14'
 end
 end
 

data/rufus-jig.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rufus-jig}
-  s.version = "0.1.13"
+  s.version = "0.1.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer"]
-  s.date = %q{2010-02-12}
+  s.date = %q{2010-02-25}
   s.description = %q{
     Json Interwebs Get.
 
@@ -44,8 +44,10 @@ Gem::Specification.new do |s|
      "test/ct_1_couchdb.rb",
      "test/ct_2_couchdb_options.rb",
      "test/ct_3_couchdb_views.rb",
+     "test/ct_4_attachments.rb",
      "test/server.rb",
      "test/test.rb",
+     "test/tweet.png",
      "test/ut_0_http_get.rb",
      "test/ut_1_http_post.rb",
      "test/ut_2_http_delete.rb",
@@ -71,19 +73,25 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rufus-lru>, [">= 0"])
       s.add_runtime_dependency(%q<rufus-json>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<patron>, [">= 0"])
     else
       s.add_dependency(%q<rufus-lru>, [">= 0"])
       s.add_dependency(%q<rufus-json>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<patron>, [">= 0"])
     end
   else
     s.add_dependency(%q<rufus-lru>, [">= 0"])
     s.add_dependency(%q<rufus-json>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<patron>, [">= 0"])
   end
 end
 

data/test/ct_4_attachments.rb

@@ -0,0 +1,126 @@
+
+#
+# testing rufus-jig
+#
+# Wed Feb 24 17:29:39 JST 2010
+#
+
+require File.join(File.dirname(__FILE__), 'couch_base')
+
+
+class CtAttachmentsTest < Test::Unit::TestCase
+
+  def setup
+
+    h = Rufus::Jig::Http.new('127.0.0.1', 5984)
+    begin
+      h.delete('/rufus_jig_test')
+    rescue Exception => e
+      #p e
+    end
+
+    h.put('/rufus_jig_test', '')
+    h.close
+
+    @c = Rufus::Jig::Couch.new('127.0.0.1', 5984, 'rufus_jig_test')
+
+    @c.put('_id' => 'thedoc', 'function' => 'recipient for attachements')
+    @d = @c.get('thedoc')
+  end
+
+  def teardown
+
+    @c.close
+  end
+
+  def test_missing_content_type
+
+    assert_raise ArgumentError do
+
+      @c.attach(
+        'thedoc/message', 'this is a message', :content_type => 'text/plain')
+    end
+  end
+
+  def test_attach
+
+    r = @c.attach(
+      'thedoc', @d['_rev'], 'message', 'this is a message',
+      :content_type => 'text/plain')
+
+    #assert_not_equal @d['_rev'], r['_rev']
+
+    assert_equal 'this is a message', @c.get('thedoc/message')
+
+    assert_not_equal @d['_rev'], @c.get('thedoc')['_rev']
+
+    r = @c.http.get('/rufus_jig_test/thedoc/message', :raw => true)
+
+    assert_equal 200, r.status
+    assert_equal 'text/plain', r.headers['Content-Type']
+  end
+
+  def test_attach_with_doc
+
+    @c.attach(
+      @d, 'message', 'this is a message', :content_type => 'text/plain')
+
+    assert_equal 'this is a message', @c.get('thedoc/message')
+  end
+
+  def test_wrong_rev_on_attach
+
+    assert_raise Rufus::Jig::HttpError do
+      @c.attach(
+        'thedoc', '1-745aeb1d8eccafa88e635b813507608c',
+        'message', 'this is a message',
+        :content_type => 'text/plain')
+    end
+  end
+
+  def test_attach_image
+
+    image = File.read(File.join(File.dirname(__FILE__), 'tweet.png'))
+
+    @c.attach(
+      'thedoc', @d['_rev'], 'image', image, :content_type => 'image/png')
+
+    r = @c.http.get('/rufus_jig_test/thedoc/image', :raw => true)
+
+    assert_equal 200, r.status
+    assert_equal 'image/png', r.headers['Content-Type']
+
+    #File.open('out.png', 'wb') { |f| f.write(r.body) }
+  end
+
+  def test_detach
+
+    attach_image
+
+    d = @c.get('thedoc')
+
+    r = @c.detach('thedoc', d['_rev'], 'image')
+
+    assert_not_equal d['_rev'], r['_rev']
+
+    assert_nil @c.get('thedoc/image')
+  end
+
+  def test_detach_fail
+
+    attach_image
+
+    assert_equal true, @c.detach(@d, 'image')
+  end
+
+  protected
+
+  def attach_image
+
+    image = File.read(File.join(File.dirname(__FILE__), 'tweet.png'))
+
+    @c.attach(
+      'thedoc', @d['_rev'], 'image', image, :content_type => 'image/png')
+  end
+end
+

data/test/server.rb

@@ -94,6 +94,8 @@ end
 
 post '/documents' do
 
+  #p env
+
   did = (Time.now.to_f * 1000).to_i.to_s
   doc = env['rack.input'].read
 
@@ -113,6 +115,8 @@ end
 
 put '/documents/:id' do
 
+  #p env
+
   doc = env['rack.input'].read
 
   DOCS[params[:id]] = [ request.content_type, doc ]

data/test/ut_1_http_post.rb

@@ -53,5 +53,25 @@ class UtHttpPostTest < Test::Unit::TestCase
 
     assert_equal 1, @h.cache.size
   end
+
+  def test_post_long_stuff
+
+    data = 'x' * 1000
+
+    b = @h.post('/documents', data, :content_type => 'text/plain')
+
+    r = @h.last_response
+
+    assert_equal 201, r.status
+  end
+
+  def test_post_image
+
+    data = File.read(File.join(File.dirname(__FILE__), 'tweet.png'))
+
+    b = @h.post('/documents', data, :content_type => 'image/png')
+
+    assert_equal 201, @h.last_response.status
+  end
 end
 

data/test/ut_3_http_put.rb

@@ -84,5 +84,22 @@ class UtHttpPutTest < Test::Unit::TestCase
 
     assert_equal true, r
   end
+
+  def test_put_long_stuff
+
+    data = 'x' * 5000
+
+    b = @h.put('/documents/abcd', data, :content_type => 'image/png')
+
+    assert_equal 201, @h.last_response.status
+  end
+
+  #def test_put_image
+  #  data = File.read(File.join(File.dirname(__FILE__), 'tweet.png'))
+  #  b = @h.put('/documents/img0', data, :content_type => 'image/png')
+  #  assert_equal 201, @h.last_response.status
+  #end
+    #
+    # currently disabled since Patron 0.4.5 times out on that one
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-jig
 version: !ruby/object:Gem::Version 
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors: 
 - John Mettraux
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-12 00:00:00 +09:00
+date: 2010-02-25 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -33,6 +33,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: yard
   type: :development
@@ -53,6 +63,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: patron
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: "\n    Json Interwebs Get.\n\n    An HTTP client, greedy with JSON content, GETting conditionally.\n\n    Uses Patron and Yajl-ruby whenever possible.\n  "
 email: jmettraux@gmail.com
 executables: []
@@ -84,8 +104,10 @@ files:
 - test/ct_1_couchdb.rb
 - test/ct_2_couchdb_options.rb
 - test/ct_3_couchdb_views.rb
+- test/ct_4_attachments.rb
 - test/server.rb
 - test/test.rb
+- test/tweet.png
 - test/ut_0_http_get.rb
 - test/ut_1_http_post.rb
 - test/ut_2_http_delete.rb