rufus-jig 0.1.2 → 0.1.3

data/CHANGELOG.txt

@@ -1,11 +1,21 @@
 
 = rufus-jig CHANGELOG.txt
 
+
+== rufus-jig - 0.1.3    released 2009/12/15
+
+- delete(doc) without _rev now raises ArgumentError
+- Patron session go stale. Now refreshing them at each request.
+- CouchDatabase#put_doc : 1 or 2 params
+
+
 == rufus-jig - 0.1.2    released 2009/12/07
 
 - fixed issue with '/' and net/http. Thanks Torsten.
 
+
 == rufus-jig - 0.1.1    released
 
+
 == rufus-jig - 0.1.0    released 2009/11/09
 

data/README.rdoc

@@ -71,73 +71,30 @@ posting...
 For the real thing : http://github.com/couchrest/couchrest
 There is also the excellent : http://github.com/langalex/couch_potato
 
-  require 'patron'
-  require 'yajl'
-  require 'rufus/jig'
-
-  c = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-    # connecting to the local couch
-
-  db = @c.put_db('rufus_jig_test')
-    # let's create a database named 'rufus_jig_test'
+The class Rufus::Jig::Couch provides a get/put/delete trio that is couch-oriented. Json encoding/decoding is automatically handled as well as
 
-  d = @db.put_doc('ct2', { 'item' => 'suit', 'brand' => 'suit company' })
-  p [ d._id, d._rev, d['item'] ]
-    #
-    # => [ "ct2", "1-755f205df9f3c3a05849df3554ea24f7", "suit" ]
-
-  # meanwhile, somebody else modifies the doc ...
-
-  d['size'] = 'XL'
-
-  d.put
-    #
-    # ouch, this gives us :
-    # => conflict: Document update conflict. (Rufus::Jig::CouchError)
-
-  d.get
-  p [ d._id, d._rev, d['size'] ]
-    #
-    # re-getting the document
-    #
-    # => [ "ct2", "2-3a09eafe8739b54ab46105b96c1c69a2", "XL" ]
-
-  d.delete
-    # 
-    # getting rid of the document
-
-Some class methods (getting right to the stuff).
+put and delete return nil in case of success and true (conflict) or and exception else.
 
   require 'patron'
   require 'yajl'
   require 'rufus/jig'
 
-  db = Rufus::Jig::Couch.get_db('http://127.0.0.1:5984/test_db')
-    # returns a Rufus::Jig::CouchDatabase instance
-    # or nil if the db doesn't exist
-
-  db = Rufus::Jig::Couch.put_db('http://127.0.0.1:5984/test_db')
-    # creates a new database, or raise an exception if the db already exists
-
-  doc = Rufus::Jig::Couch.get_doc('http://127.0.0.1:5984/test_db/doc0')
-    # returns a Rufus::Jig::CouchDocument instance
-    # or nil the document doesn't exist
-
-  # ...
-
-Perhaps the right way to interact from rufus-jig to CouchDB is something like :
+  c = Rufus::Jig::Couch.new('127.0.0.1', 5984, 'my_couch_db')
 
-  db = Rufus::Jig::Couch.get_db('http://127.0.0.1:5984/test_db')
+  c.put('_id' => 'coffee0', 'category' => 'espresso')
+  c.put('_id' => 'coffee1', 'category' => 'instantaneous')
 
-  doc = db.get_doc('doc0')
+  doc0 = c.get('coffee0')
+  doc1 = c.get('coffee1')
 
-  doc['car'] = { 'brand' => 'BMW', 'model' => 'MarkIII' }
+  c.delete(doc0)
 
-  doc.put
+  doc1['category'] => 'instant'
+  c.put(doc1)
 
-  # ...
+  c.delete(doc1['_id'], doc1['_rev'])
 
-Get a CouchDatabase instance then play from it.
+...
 
 
 == rdoc

data/TODO.txt

@@ -19,3 +19,5 @@
 
 [ ] put_doc(h) where _id is set ?
 
+[ ] :update_rev => true...
+

data/lib/rufus/jig/couch.rb

@@ -25,125 +25,98 @@
 
 module Rufus::Jig
 
-  #
-  # An error class for the couch stuff.
-  #
-  # Has a #status and an #original methods.
-  #
-  class CouchError < HttpError
-
-    # the original error hash
-    #
-    attr_reader :original
+  class Couch
 
-    def initialize (status, message)
+    attr_reader :http
 
-      @original = (Rufus::Jig::Json.decode(message) rescue nil) || message
+    def initialize (*args)
 
-      if @original.is_a?(String)
-        super(status, @original)
-      else
-        super(status, "#{@original['error']}: #{@original['reason']}")
-      end
+      @http, @path, payload, @opts = Rufus::Jig::Http.extract_http(false, *args)
+
+      @path ||= '/'
     end
-  end
 
-  #
-  # The parent class of Rufus::Jig::Couch CouchDatabase and CouchDocument.
-  #
-  class CouchResource
+    def put (doc_or_path, opts={})
 
-    # the jig client
-    #
-    attr_reader :http
+      path, payload = if doc_or_path.is_a?(String)
+        [ doc_or_path, '' ]
+      else
+        [ doc_or_path['_id'], doc_or_path ]
+      end
 
-    # the path for this couch resource
-    #
-    attr_reader :path
+      #if opts[:update_rev] && payload.is_a?(Hash) && payload['_rev']
+      #  pre = get(path)
+      #  payload['_rev'] = prev['_rev']
+      #end
 
-    # nil for a Couch instance, the Couch instance for a CouchDatabase or
-    # the CouchDatabase for a CouchDocument.
-    #
-    attr_reader :parent
+      path = adjust(path)
+
+      begin
 
-    def initialize (parent_or_http, path)
+        r = @http.put(path, payload, :content_type => :json, :cache => false)
 
-      @path = path
+        if opts[:update_rev] && doc_or_path.is_a?(Hash)
+          doc_or_path['_rev'] = r['rev']
+        end
 
-      path = path.split('/').select { |e| e != '' }
+        nil
 
-      @parent, @http = if parent_or_http.is_a?(Rufus::Jig::Http)
+      rescue Rufus::Jig::HttpError => he
 
-        parent = if path.length == 0
-          nil
-        elsif path.length == 1
-          Couch.new(parent_or_http)
+        if he.status == 409
+          true
         else
-          CouchDatabase.new(parent_or_http, path.first)
+          raise he
         end
-        [ parent, parent_or_http ]
+      end
+    end
 
-      else
+    def get (doc_or_path)
+
+      path = doc_or_path.is_a?(Hash) ? doc_or_path['_id'] : doc_or_path
+      path = adjust(path)
 
-        [ parent_or_http, parent_or_http.http ]
+      opts = {}
+
+      if et = etag(path)
+        opts[:etag] = et
       end
 
-      @http.options[:error_class] = CouchError
+      @http.get(path, opts)
     end
 
-    # Returns the Rufus::Jig::Couch instance holding this couch resource.
-    #
-    def couch
+    def delete (doc_or_path, rev=nil)
 
-      @parent == nil ? self : @parent.couch
-    end
+      doc_or_path = { '_id' => doc_or_path, '_rev' => rev } if rev
 
-    # Returns the Rufus::Jig::CouchDatabase instance holding this couch
-    # resource (or nil if this resource is a Rufus::Jig::Couch instance).
-    #
-    def db
+      begin
 
-      return nil if @parent.nil?
-      return self if self.is_a?(CouchDatabase)
-      @parent # self is a document
-    end
+        if doc_or_path.is_a?(String)
 
-    # GET, relatively to this resource.
-    #
-    def get (path, opts={})
-      @http.get(adjust(path), opts)
-    end
+          @http.delete(adjust(doc_or_path))
 
-    # POST, relatively to this resource.
-    #
-    def post (path, data, opts={})
-      @http.post(adjust(path), data, opts)
-    end
+        else
 
-    # DELETE, relatively to this resource.
-    #
-    def delete (path, opts={})
-      @http.delete(adjust(path), opts)
-    end
+          raise(
+            ArgumentError.new("cannot delete document without _rev")
+          ) unless doc_or_path['_rev']
 
-    # PUT, relatively to this resource.
-    #
-    def put (path, data, opts={})
-      @http.put(adjust(path), data, opts)
-    end
+          path = adjust(doc_or_path['_id'])
+          path = Rufus::Jig::Path.add_params(path, :rev => doc_or_path['_rev'])
 
-    # Returns an array of 1 or more UUIDs generated by CouchDB.
-    #
-    def get_uuids (count=1)
+          @http.delete(path)
+        end
 
-      @http.get("/_uuids?count=#{count}")['uuids']
-    end
+        nil
 
-    # Returns the list of all database [names] in this couch.
-    #
-    def get_databases
+      rescue Rufus::Jig::HttpError => he
 
-      @http.get('/_all_dbs')
+        if he.status == 409
+          true
+        else
+          raise he
+        end
+      end
     end
 
     protected
@@ -166,368 +139,5 @@ module Rufus::Jig
       r ? r.first : nil
     end
   end
-
-  #
-  # Wrapping info about a Couch server.
-  #
-  #
-  # Also provides a set of class methods for interacting directly with couch
-  # resources.
-  #
-  # * get_couch
-  # * get_db
-  # * put_db
-  # * delete_db
-  # * get_doc
-  # * put_doc
-  # * delete_doc
-  #
-  # The first one is very important
-  #
-  class Couch < CouchResource
-
-    # Never call this method directly.
-    #
-    # Do
-    #
-    #  couch = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-    #
-    # instead.
-    #
-    def initialize (parent_or_http)
-
-      super(parent_or_http, '/')
-    end
-
-    # Returns a CouchDatabase instance or nil if the database doesn't
-    # exist in this couch.
-    #
-    #  couch = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-    #  db = couch.get_db('hr_documents')
-    #
-    def get_db (name)
-
-      return nil if get(name).nil?
-
-      CouchDatabase.new(couch, name)
-    end
-
-    # Creates a database and returns the new CouchDatabase instance.
-    #
-    # Will raise a Rufus::Jig::CouchError if the db already exists.
-    #
-    #  couch = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-    #  db = couch.put_db('financial_results')
-    #
-    def put_db (name)
-
-      d = CouchDatabase.new(couch, name)
-      d.put('.', '')
-
-      d
-    end
-
-    # Deletes a database, given its name.
-    #
-    # Will raise a Rufus::Jig::CouchError if the db doesn't exist.
-    #
-    #  couch = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-    #  db = couch.delete_db('financial_results')
-    #
-    def delete_db (name)
-
-      raise(CouchError.new(404, "no db named '#{name}'")) if get(name).nil?
-
-      delete(name)
-    end
-
-    #--
-    # handy class methods
-    #++
-
-    # Returns a Rufus::Jig::Couch instance.
-    #
-    #   couch = Rufus::Jig::Couch.get_couch('http://127.0.0.1:5984')
-    #     # or
-    #   couch = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-    #
-    # Will raise a Rufus::Jig::CouchError in case of trouble.
-    #
-    def self.get_couch (*args)
-
-      ht, pt, pl, op = extract_http(false, *args)
-
-      Couch.new(ht)
-    end
-
-    # Returns a CouchDatabase instance or nil if the db doesn't exist.
-    #
-    #   db = Rufus::Jig::Couch.get_db('127.0.0.1', 5984, 'my_database')
-    #     # or
-    #   db = Rufus::Jig::Couch.get_db('http://127.0.0.1:5984/my_database')
-    #
-    def self.get_db (*args)
-
-      ht, pt, pl, op = extract_http(false, *args)
-
-      return nil unless ht.get(pt)
-
-      CouchDatabase.new(ht, Rufus::Jig::Path.to_name(pt))
-    end
-
-    # Creates a database and returns a CouchDatabase instance.
-    #
-    #   db = Rufus::Jig::Couch.put_db('127.0.0.1', 5984, 'my_database')
-    #     # or
-    #   db = Rufus::Jig::Couch.put_db('http://127.0.0.1:5984/my_database')
-    #
-    # Will raise a Rufus::Jig::CouchError if the db already exists.
-    #
-    def self.put_db (*args)
-
-      ht, pt, pl, op = extract_http(false, *args)
-
-      ht.put(pt, '')
-
-      CouchDatabase.new(ht, Rufus::Jig::Path.to_name(pt))
-    end
-
-    # Deletes a database.
-    #
-    #   Rufus::Jig::Couch.delete_db('127.0.0.1', 5984, 'my_database')
-    #     # or
-    #   Rufus::Jig::Couch.delete_db('http://127.0.0.1:5984/my_database')
-    #
-    # Will raise a Rufus::Jig::CouchError if the db doesn't exist.
-    #
-    def self.delete_db (*args)
-
-      ht, pt, pl, op = extract_http(false, *args)
-
-      ht.delete(pt)
-    end
-
-    # Fetches a document. Returns nil if not found or a CouchDocument instance.
-    #
-    #   Rufus::Jig::Couch.get_doc('127.0.0.1', 5984, 'my_database/doc0')
-    #     # or
-    #   Rufus::Jig::Couch.get_doc('http://127.0.0.1:5984/my_database/doc0')
-    #
-    def self.get_doc (*args)
-
-      ht, pt, pl, op = extract_http(false, *args)
-
-      doc = ht.get(pt)
-
-      doc ? CouchDocument.new(ht, pt, doc) : nil
-    end
-
-    # Puts (creates) a document
-    #
-    #   Rufus::Jig::Couch.put_doc(
-    #     '127.0.0.1', 5984, 'my_database/doc0', { 'a' => 'b' })
-    #       # or
-    #   Rufus::Jig::Couch.put_doc(
-    #     'http://127.0.0.1:5984/my_database/doc0', { 'x' => 'y' })
-    #
-    # To update a doc, get it first, then change its content and put it
-    # via its put method.
-    #
-    def self.put_doc (*args)
-
-      ht, pt, pl, op = extract_http(true, *args)
-
-      info = ht.put(pt, pl, :content_type => :json, :cache => false)
-
-      CouchDocument.new(ht, pt, Rufus::Jig.marshal_copy(pl), info)
-    end
-
-    # Deletes a document.
-    #
-    #   Rufus::Jig::Couch.delete_doc('127.0.0.1', 5984, 'my_database/doc0')
-    #     # or
-    #   Rufus::Jig::Couch.delete_doc('http://127.0.0.1:5984/my_database/doc0')
-    #
-    # Will raise a Rufus::Jig::CouchError if the doc doesn't exist.
-    #
-    def self.delete_doc (*args)
-
-      ht, pt, pl, op = extract_http(false, *args)
-
-      ht.delete(pt)
-    end
-
-    # This method is used from get_couch, get_db, put_db and co...
-    #
-    # Never used directly.
-    #
-    def self.extract_http (payload_expected, *args)
-
-      a = Rufus::Jig::Http.extract_http(payload_expected, *args)
-
-      a.first.error_class = Rufus::Jig::CouchError
-
-      a
-    end
-  end
-
-  #
-  # Wrapping info about a Couch database.
-  #
-  # You usually grab an instance of it like that :
-  #
-  #   db = Rufus::Jig::Couch.get_db('127.0.0.1', 5984, 'my_database')
-  #     # or
-  #   db = Rufus::Jig::Couch.get_db('http://127.0.0.1:5984/my_database')
-  #
-  #     # or
-  #   couch = Rufus::Jig::Couch.get_couch('127.0.0.1', 5984)
-  #   db = Rufus::Jig::Couch.get_db('my_database')
-  #
-  class CouchDatabase < CouchResource
-
-    attr_reader :name
-
-    # Usually called via Couch#get_database(name)
-    #
-    def initialize (parent_or_http, name)
-
-      @name = name
-
-      super(parent_or_http, Rufus::Jig::Path.to_path(@name))
-    end
-
-    # Given an id and an JSONable hash, puts the doc to the database
-    # and returns a CouchDocument instance wrapping it.
-    #
-    #   db.put_doc('doc0', { 'item' => 'car', 'brand' => 'bmw' })
-    #
-    def put_doc (doc_id, doc)
-
-      info = put(doc_id, doc, :content_type => :json, :cache => false)
-
-      CouchDocument.new(
-        self,
-        Rufus::Jig::Path.join(@name, doc_id),
-        Rufus::Jig.marshal_copy(doc), info)
-    end
-
-    # Gets a document, given its id.
-    # (conditional GET).
-    #
-    #   db.get_doc('doc0')
-    #
-    def get_doc (doc_id)
-
-      path = Rufus::Jig::Path.join(@path, doc_id)
-      opts = {}
-
-      if et = etag(path)
-        opts[:etag] = et
-      end
-
-      doc = get(path, opts)
-
-      doc ?
-        CouchDocument.new(self, Rufus::Jig::Path.join(@name, doc_id), doc) :
-        nil
-    end
-
-    # Deletes a document, you have to provide the current revision.
-    #
-    #   db.delete_doc('doc0')
-    #
-    def delete_doc (doc_id, rev)
-
-      raise(ArgumentError.new("no doc '#{name}'")) if get(doc_id).nil?
-
-      delete(Rufus::Jig::Path.add_params(doc_id, :rev => rev))
-    end
-  end
-
-  #
-  # Wrapping a couch document.
-  #
-  # Responds to [] and []=
-  #
-  class CouchDocument < CouchResource
-
-    attr_reader :payload
-
-    # Don't call this method directly, use one of the get_doc or put_doc
-    # methods.
-    #
-    def initialize (parent_or_http, path, doc, put_result=nil)
-
-      super(parent_or_http, path)
-      @payload = doc
-
-      if put_result
-        @payload['_id'] = put_result['id']
-        @payload['_rev'] = put_result['rev']
-      end
-    end
-
-    # Gets a value.
-    #
-    def [] (k)
-      @payload[k]
-    end
-
-    # Sets a value.
-    #
-    def []= (k, v)
-      @payload[k] = v
-    end
-
-    # Returns to CouchDB id of the document.
-    #
-    def _id
-      @payload['_id']
-    end
-
-    # Returns the revision string for this copy of the document.
-    #
-    def _rev
-      @payload['_rev']
-    end
-
-    # Re-gets this document (updating its _rev and content if necessary).
-    #
-    def get
-
-      opts = {}
-
-      if @payload && rev = @payload['_rev']
-        opts[:etag] = "\"#{rev}\""
-      end
-
-      h = super(@path, opts)
-
-      raise(CouchError.new(410, 'probably gone')) unless h
-
-      @payload = h
-
-      self
-    end
-
-    # Deletes this document (from Couch).
-    #
-    def delete
-
-      super(Rufus::Jig::Path.add_params(@path, :rev => _rev))
-    end
-
-    # Puts this document (assumes you have updated it).
-    #
-    def put
-
-      h = super(
-        @path, @payload,
-        :content_type => :json, :etag => "\"#{@payload['_rev']}\"")
-
-      @payload['_rev'] = h['rev']
-    end
-  end
 end
 

data/lib/rufus/jig/http.rb

@@ -290,16 +290,29 @@ if defined?(Patron) # gem install patron
 
       super(host, port, opts)
 
+      refresh
+    end
+
+    # Patron sessions tends to wear out. Have to refresh them.
+    #
+    def refresh
+
       @patron = Patron::Session.new
-      @patron.base_url = "#{host}:#{port}"
+      @patron.base_url = "#{@host}:#{@port}"
 
       @patron.headers['User-Agent'] =
-        opts[:user_agent] ||
-        "#{self.class} #{Rufus::Jig::VERSION} (patron)"
+        @options[:user_agent] || "#{self.class} #{Rufus::Jig::VERSION} (patron)"
     end
 
     protected
 
+    def request (method, path, data, opts={})
+
+      refresh
+
+      super(method, path, data, opts)
+    end
+
     def do_get (path, data, opts)
 
       @patron.get(path, opts)
@@ -339,6 +352,7 @@ elsif defined?( EventMachine::HttpRequest )
     protected
 
     def response_headers( hash )
+
       hash.inject({}) do |headers, (key, value)|
         key = key.downcase.split('_').map { |c| c.capitalize }.join('-')
         headers[ key ] = value

data/lib/rufus/jig.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-jig
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - John Mettraux
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-07 00:00:00 +09:00
+date: 2009-12-15 00:00:00 +09:00
 default_executable: 
 dependencies: []