rufus-jig 0.1.0

data/CHANGELOG.txt

@@ -0,0 +1,7 @@
+
+= rufus-jig CHANGELOG.txt
+
+== rufus-jig - 0.1.1    not yet released
+
+== rufus-jig - 0.1.0    released 2009/11/09
+

data/CREDITS.txt

@@ -0,0 +1,3 @@
+
+nothing here for now
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+Copyright (c) 2009-2009, 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.
+

data/README.rdoc

@@ -0,0 +1,176 @@
+
+= rufus-jig
+
+A HTTP client, greedy with JSON content, GETting conditionally.
+
+Uses Patron (http://github.com/toland/patron) and Yajl-ruby (http://github.com/brianmario/yajl-ruby) whenever possible.
+
+This library also contains some CouchDB helpers.
+
+
+== examples
+
+=== HTTP client
+
+Let's say we have an hypothetical document server.
+
+getting...
+
+  require 'patron'
+  require 'yajl'
+  require 'rufus/jig'
+
+  h = Rufus::Jig::Http.new('127.0.0.1', 4567)
+
+  p @h.get('/document/xyz.json')
+    #
+    # => { "type" => "letter", "title" => "four birds" }
+    #
+    # if it's JSON, decodes it immediately
+
+  r = @h.get('/document/xyz.txt')
+  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)
+    #
+    # 'Accepts' JSON
+
+posting...
+
+  r = @h.post(
+    '/documents', '<doc>four birds</doc>', :content_type => 'application/xml')
+  p [ r.status, r.body ]
+    #
+    # => [ 201, "created." ]
+
+
+=== Couch helpers
+
+For the real thing : http://github.com/couchrest/couchrest
+
+  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'
+
+  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).
+
+  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 :
+
+  db = Rufus::Jig::Couch.get_db('http://127.0.0.1:5984/test_db')
+
+  doc = db.get_doc('doc0')
+
+  doc['car'] = { 'brand' => 'BMW', 'model' => 'MarkIII' }
+
+  doc.put
+
+  # ...
+
+Get a CouchDatabase instance then play from it.
+
+
+== rdoc
+
+http://rufus.rubyforge.org/rufus-jig/
+
+
+== testing
+
+At first, make sure to start the tiny sinatra test server :
+
+  ruby test/server.rb
+
+then do
+
+  ruby test/test.rb
+
+
+To test the CouchDB helpers, make you have a running Couch on http:/127.0.0.1:5984 then do
+
+  ruby test/test.rb --couch
+
+
+== mailing list
+
+On the rufus-ruby list :
+
+http://groups.google.com/group/rufus-ruby
+
+
+== issue tracker
+
+http://github.com/jmettraux/rufus-jig/issues
+
+
+== irc
+
+  irc.freenode.net #ruote
+
+
+== the rest of Rufus
+
+http://rufus.rubyforge.org
+
+
+== authors
+
+* John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
+
+
+== license
+
+MIT
+

data/TODO.txt

@@ -0,0 +1,21 @@
+
+[o] PUT
+[o] DELETE
+[o] POST
+[o] :prefix
+[o] :raw
+[o] POST/PUT cache if etag is given back (couch)
+[o] get('/x', :cache => false)
+[o] get('x') vs get('/x') ?
+
+[ ] 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 ?
+

data/delete.txt

@@ -0,0 +1,21 @@
+$ curl -vX DELETE 'http://localhost:5984/nada/doc4?rev=1-154674290868ca95f26ead035328e2ea'
+* About to connect() to localhost port 5984 (#0)
+*   Trying 127.0.0.1... connected
+* Connected to localhost (127.0.0.1) port 5984 (#0)
+> DELETE /nada/doc4?rev=1-154674290868ca95f26ead035328e2ea HTTP/1.1
+> User-Agent: curl/7.19.6 (i386-apple-darwin10.0.0) libcurl/7.19.6 zlib/1.2.3
+> Host: localhost:5984
+> Accept: */*
+> 
+< HTTP/1.1 200 OK
+< Server: CouchDB/0.10.0 (Erlang OTP/R13B)
+< Etag: "2-575dc2a2afa69152c502f4d07cc983dc"
+< Date: Sun, 01 Nov 2009 09:39:25 GMT
+< Content-Type: text/plain;charset=utf-8
+< Content-Length: 67
+< Cache-Control: must-revalidate
+< 
+{"ok":true,"id":"doc4","rev":"2-575dc2a2afa69152c502f4d07cc983dc"}
+* Connection #0 to host localhost left intact
+* Closing connection #0
+