sr-couchy 0.0.2

data/README.textile

@@ -0,0 +1,77 @@
+h1. Couchy: There Are Many Like It but This One is Mine
+
+Couchy is a simple, no-frills, Ruby wrapper around the nice
+"CouchDB HTTP API":http://wiki.apache.org/couchdb/HttpRestApt.
+
+h2. Quick overview
+
+<pre>
+server = CouchRest.new
+database = server.database('articles')
+response = database.save(:title => 'Atom-Powered Robots Run Amok', :content => 'Some text.')
+document = database.get(response['id'])
+database.delete(document)
+puts document.inspect
+</pre>
+
+
+h2. Requirements
+
+The fellowing gems are required:
+
+* @rest-client@
+* @addressable@
+
+To run the test and generate the code coverage report, you also need :
+
+* @test/spec@
+* @mocha@
+* @rcov@
+* @rspec@ (for the legacy tests)
+
+and @yard@ to generate the documentation.
+
+h2. Genesis
+
+It started as an Hardcore Forking Action of "jchris's CouchRest":original
+I ended up:
+
+* Writing more tests. The legacy tests are rather integration tests while those
+  I wrote are unit tests.
+* DRY-ing it up
+* Writing some doc using "YARD":yard
+
+Unfortunately, jchris didn't merge the changes for some reasons.
+
+Thank a lot to him for having written CouchRest in the first place and having
+allowed me to relicense my fork under another license.
+
+h2. License
+
+(The MIT License)
+
+Copyright (c) 2008 "Simon Rozet":sr <simon@rozet.name>
+
+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.
+
+[yard]http://yard.soen.ca/
+[couchdb]http://couchdb.org
+[original]http://github.com/jchris/couchrest
+[sr]http://purl.org/net/sr/

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rcov/rcovtask'
+require 'yard'
+
+task :default => :test
+
+task :test => :"test:all"
+
+namespace :test do
+  desc 'Run all tests'
+  task :all => [:unit, :integration]
+
+  desc 'Run unit tests'
+  task :unit do
+    sh 'testrb test/*.rb'
+  end
+
+  desc "Run integration tests"
+  Spec::Rake::SpecTask.new('integration') do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+  end
+end
+
+Rcov::RcovTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.rcov_opts << '-Ilib'
+  t.rcov_opts << '-x"home"'
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new
+
+task :publish => [:"publish:doc", :"publish:coverage"]
+
+namespace :publish do
+  task :doc => :yardoc do
+    sh 'cp -r doc ~/web/atonie.org/2008/couchy'
+    sh 'cd ~/web/atonie.org && git add 2008/couchy/doc && git commit -m "update couchy doc"'
+  end
+
+  task :coverage => :rcov do
+    sh 'cp -r coverage ~/web/atonie.org/2008/couchy'
+    sh 'cd ~/web/atonie.org && git add 2008/couchy/coverage && git commit -m "update couchy coverage"'
+  end
+end

data/bin/couchy

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'thor'
+require 'fileutils'
+require 'pathname'
+
+require File.dirname(__FILE__) + '/../lib/couchy'
+
+module Couchy
+  class ViewManager < Thor
+    desc 'generate DESIGN VIEW',
+         'Generate directory structure for DESIGN/VIEW in PATH suitable for the `push` task.'
+    def generate(path, design, view='all')
+      path = File.join(Dir.pwd, path, design)
+      FileUtils.mkdir_p path
+      create_sample_view(path, view)
+    end
+
+    desc 'push PATH DATABASE', 'Push views avalaible in PATH to DATABASE.'
+    method_options :server   => :optional,
+                   :force    => :boolean
+    def push(path, database_name)
+      @database_name = database_name
+      designs   = find_designs(path)
+      documents = designs.map { |design| document_for(*design) }
+      documents.each do |document|
+        if document_exists?(document) && options[:force]
+          puts "Deleting `#{document['_id']}'"
+          database.delete database.get(document['_id'])
+        end
+        puts "Saving `#{document['_id']}' to `#{database.name}' on `#{server.uri}'"
+        database.save(document)
+      end
+    end
+
+    private
+      def find_designs(path)
+        views = Dir[File.join(path, '**/*-*.js')].inject({}) do |memo, path|
+          path   = Pathname.new(path)
+          parts  = path.split
+          design = parts.first.split.last.to_s
+          view   = parts.last.to_s
+          view_type = view[/\-(\w+)\.js/] && $1
+          view_body = File.read(path)
+          memo.tap do |memo|
+            memo[design] = {} unless memo[design]
+            memo[design][view_type] = view_body
+          end
+        end
+      end
+
+      def document_for(name, views)
+        { '_id'      => "_design/#{name}",
+          'language' => 'javascript',
+          'views'    => views }
+      end
+
+      def create_sample_view(path, view)
+        File.open(File.join(path, "#{view}-map.js"), 'w') do |file|
+          file.puts 'function(doc) {'
+          file.puts '  emit(null, doc);'
+          file.puts '}'
+        end
+      end
+
+      def document_exists?(document)
+        database.documents['rows'].collect { |row| row['id'] }.include?(document['_id'])
+      end
+
+      def database
+        @database ||= server.database(@database_name)
+      end
+
+      def server
+        @server ||= options[:server] ? Couchy::Server.new(options[:server]) : Couchy.new
+      end
+  end
+end
+
+Couchy::ViewManager.start

data/couchy.gemspec

@@ -0,0 +1,58 @@
+Gem::Specification.new do |s|
+  s.name     = 'couchy'
+  s.version  = '0.0.2'
+  s.date     = '2008-10-07'
+  s.summary  = 'Simple, no-frills, Ruby wrapper around the nice CouchDB HTTP API'
+  s.description = 'Simple, no-frills, Ruby wrapper around the nice CouchDB HTTP API'
+  s.homepage = 'http://github.com/sr/couchy'
+  s.email    = 'simon@rozet.name'
+  s.authors  = ['Simon Rozet']
+  s.has_rdoc = false
+  s.executables = ['couchy']
+
+  s.files = %w(
+    README.textile
+    Rakefile
+    bin/couchy
+    couchy.gemspec
+    lib/couchy.rb
+    lib/couchy/database.rb
+    lib/couchy/server.rb
+    spec/couchy_spec.rb
+    spec/database_spec.rb
+    spec/fixtures/attachments/test.html
+    spec/fixtures/views/lib.js
+    spec/fixtures/views/test_view/lib.js
+    spec/fixtures/views/test_view/only-map.js
+    spec/fixtures/views/test_view/test-map.js
+    spec/fixtures/views/test_view/test-reduce.js
+    spec/spec.opts
+    spec/spec_helper.rb
+    test/couchy_test.rb
+    test/database_test.rb
+    test/server_test.rb
+    test/test_helper.rb
+    vendor/addressable/.gitignore
+    vendor/addressable/CHANGELOG
+    vendor/addressable/LICENSE
+    vendor/addressable/README
+    vendor/addressable/Rakefile
+    vendor/addressable/lib/addressable/idna.rb
+    vendor/addressable/lib/addressable/uri.rb
+    vendor/addressable/lib/addressable/version.rb
+    vendor/addressable/spec/addressable/idna_spec.rb
+    vendor/addressable/spec/addressable/uri_spec.rb
+    vendor/addressable/spec/data/rfc3986.txt
+    vendor/addressable/tasks/clobber.rake
+    vendor/addressable/tasks/gem.rake
+    vendor/addressable/tasks/git.rake
+    vendor/addressable/tasks/metrics.rake
+    vendor/addressable/tasks/rdoc.rake
+    vendor/addressable/tasks/rubyforge.rake
+    vendor/addressable/tasks/spec.rake
+    vendor/addressable/website/index.html
+  )
+
+  s.test_files = s.files.select { |path| path =~ /^(test|spec)/ }
+  s.add_dependency('rest-client', ['> 0.0.0'])
+end

data/lib/couchy.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'json'
+require 'rest_client'
+
+$:.unshift File.dirname(__FILE__) + '/../vendor/addressable/lib'
+require 'addressable/uri'
+
+$:.unshift File.dirname(__FILE__) + '/couchy'
+
+module Couchy
+  autoload :Server,       'server'
+  autoload :Database,     'database'
+
+  # Shortcut for Couchy::Server.new
+  #
+  # @param [String] uri The URI of the CouchDB server. defaults to "http://localhost:5984/"
+  # @return Couchy::Server
+  def self.new(server_uri='http://localhost:5984/')
+    Server.new(server_uri)
+  end
+end

data/lib/couchy/database.rb

@@ -0,0 +1,129 @@
+require 'cgi'
+require 'base64'
+
+module Couchy
+  class Database
+    attr_accessor :server, :name
+
+    def initialize(server, database_name)
+      @name = database_name
+      @server = server
+    end
+    
+    # Gets a list of all the documents available in the database
+    #
+    # @param [Hash] params
+    #
+    # @return [Hash] Parsed server response
+    def documents(params={})
+      server.get("#{name}/_all_docs", params)
+    end
+  
+    # Creates a temporary view
+    #
+    # @param [String] function The view function
+    # @param [Hash] params
+    #
+    # @return [Hash] Parsed server response
+    def temp_view(function, params={})
+      server.post("#{name}/_temp_view", function,
+        params.merge!(:headers => {'Content-Type' => 'application/json'}))
+    end
+  
+    # Query a view
+    #
+    # @param [String] view_name The name of the view
+    # @param [Hash] params
+    #
+    # @return [Hash] Parsed server response
+    def view(view_name, params={})
+      server.get("#{name}/_view/#{view_name}", params)
+    end
+
+    # Retrieves a document by its ID
+    #
+    # @param [String] id The ID of the document
+    #
+    # @return [Hash] Parsed server response
+    def get(id)
+      server.get("#{name}/#{CGI.escape(id)}")
+    end
+    
+    # Retrieves an attachment from a document
+    #
+    # @param [String] document_id The ID of the document
+    # @param [String] attachment_name The name of the attachment
+    #
+    # @return [Hash] Parsed server response
+    def fetch_attachment(document_id, attachment_name)
+      server.get("#{name}/#{CGI.escape(document_id)}/#{CGI.escape(attachment_name)}", :no_json => true)
+    end
+    
+    # Saves or updates a document
+    #
+    # @param [Hash] doc The document
+    #
+    # @return [Hash] Parsed server response
+    def save(doc)
+      doc = encode_attachments_of(doc)
+
+      if doc['_id']
+        server.put("#{name}/#{CGI.escape(doc['_id'])}", doc)
+      else
+        server.post("#{name}", doc)
+      end
+    end
+    
+    # Saves or updates a bunch of documents
+    #
+    # @param [Array] docs The documents to save
+    #
+    # @return [Hash] Parsed server response
+    def bulk_save(docs)
+      server.post("#{name}/_bulk_docs", {:docs => docs})
+    end
+    
+    # Deletes a document
+    #
+    # @param [String, Hash] document Document ID or an Hash representing the document
+    # @param [String] revision Document's revision
+    #
+    # @raise ArgumentError When the Hash representing the document neither has
+    #                      an ID nor a revision
+    #
+    # @raise ArgumentError When document is neither an ID nor an Hash
+    #                      representing a document
+    #
+    # @return [Hash] Parsed server response
+    def delete(document, revision=nil)
+      case document
+      when String
+        raise ArgumentError, 'Document revision must be specified' unless revision
+        server.delete "#{name}/#{CGI.escape(document)}", :rev => revision
+      when Hash
+        raise ArgumentError, 'Document ID and revision must be specified' unless
+          document['_id'] && document['_rev']
+        server.delete("#{name}/#{CGI.escape(document['_id'])}", :rev => document['_rev'])
+      else
+        raise ArgumentError, 'Document must be an Hash representing the document or its ID'
+      end
+    end
+    
+    # Deletes the current database
+    #
+    # @return [Hash] Parsed server response
+    def delete!
+      server.delete(name)
+    end
+
+    private
+      def encode_attachments_of(doc)
+        return doc unless doc['_attachments']
+        doc['_attachments'].each { |_, v| v.update('data' => base64(v['data'])) } and doc
+      end
+
+      def base64(data)
+        Base64.encode64(data.to_s).gsub(/\s/,'')
+      end
+  end
+end

data/lib/couchy/server.rb

@@ -0,0 +1,89 @@
+module Couchy
+  class Server
+    attr_accessor :uri
+
+    def initialize(uri)
+      @uri = Addressable::URI.parse(uri)
+    end
+
+    # Gets information about the server
+    #
+    # @return [Hash] Parsed server response
+    def info
+      get '/'
+    end
+
+    # Restarts the server
+    #
+    # @return [Hash] Parsed server response
+    def restart!
+      post '_restart'
+    end
+
+    # Gets a list of all the databases available on the server
+    #
+    # @return [Array] Parsed server response
+    def databases
+      get '_all_dbs'
+    end
+  
+    # Gets a new [Couchy::Database] for the database
+    #
+    # @param [String] name The name of the database
+    #
+    # @return [Couchy::Database] The database
+    def database(name)
+      Database.new(self, name)
+    end
+  
+    # Creates a database
+    #
+    # @param [String] name Database's name
+    #
+    # @return [Couchy::Database] The newly created database
+    def create_db(name)
+      put(name)
+      database(name)
+    end
+
+    def get(path, params={})
+      need_json = !params.delete(:no_json)
+      response = RestClient.get(uri_for(path, params))
+      need_json ? json(response, :max_nesting => false) : response
+    end
+
+    def post(path, doc=nil, params={})
+      headers = params.delete(:headers)
+      payload = doc.to_json if doc
+      json RestClient.post(uri_for(path, params), payload, headers)
+    end
+
+    def put(path, doc=nil)
+      payload = doc.to_json if doc
+      json RestClient.put(uri_for(path), payload)
+    end
+
+    def delete(path, params={})
+      json RestClient.delete(uri_for(path, params))
+    end
+
+    private
+      def uri_for(path, params={})
+        u = uri.join(path)
+        u.query_values = stringify_keys_and_jsonify_values(params) if params.any?
+        u.to_s
+      end
+
+      def json(json_string, options={})
+        JSON.parse(json_string, options)
+      end
+
+      def stringify_keys_and_jsonify_values(hash)
+        hash.inject({}) do |memo, (key, value)|
+          value = value.to_json if %w(key startkey endkey).include?(key.to_s)
+          memo[key.to_s] = value.to_s
+          memo
+        end
+      end
+  end
+end