couchdb-ruby-server 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa9cbfeea39a79efb59cfa9b1d278ee06ea5451c
+  data.tar.gz: 1fa6648489a455bc477d446af41b2f84c48eb215
+SHA512:
+  metadata.gz: 196f7dd41438a62fe78b9d98c3f6824b04e29639f82fc9994017ad95d3594c8476f01211bdc985405283d1a80c9674f9a443191a8b72afc2ae57a6a8fee287a9
+  data.tar.gz: 1e4608f3551c2937ce0acc9f2a7f13075e2ccb9b079b3c1935cf7e1537af679053c32649c310aa3393ec442ea5eab0d1777053dba02fa6da703bdf6a67a542b7

data/.gitignore

@@ -0,0 +1,21 @@
+*~
+~*
+.DS_Store
+._.DS_Store
+thumbs.db
+*.log
+*.pid
+*.dump
+*.prof
+*.prof.gif
+*.prof.symbols
+.svn/
+.hg/
+*.sublime-workspace
+.env
+.rbenv-version
+.ruby-version
+Gemfile.lock
+core
+*.gem
+/doc/

data/.hound.yml

@@ -0,0 +1,4 @@
+# NOTE: it works on pull requests only
+ruby:
+  config_file: .rubocop.yml
+  enabled: true

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1" # latest 2.1.x
+  - "2.2" # latest 2.2.x
+  - "jruby-18mode"
+  - "jruby-19mode"
+script:
+  CODECLIMATE_REPO_TOKEN=PLACE_TOKEN_HERE bundle exec rake test
+branches:
+  - "master"

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+gem 'codeclimate-test-reporter',  :group      => :development,
+                                  :require    => nil,
+                                  :platforms  => [:ruby_20]

data/HISTORY.md

@@ -0,0 +1,4 @@
+# 1.0.0
+2015-MM-DD
+
+* First public release

data/LICENSE.txt

@@ -0,0 +1,20 @@
+MIT License, http://opensource.org/licenses/MIT
+
+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.md

@@ -0,0 +1,38 @@
+# couchdb-ruby-server
+CouchDB query server to run ruby design docs.
+
+[![Build Status](https://travis-ci.org/sinm/couchdb-ruby-server.svg?branch=master)](https://travis-ci.org/sinm/couchdb-ruby-server) [![Gem Version](https://badge.fury.io/rb/couchdb-ruby-server.svg)](http://badge.fury.io/rb/couchdb-ruby-server) [![Dependency Status](https://gemnasium.com/sinm/couchdb-ruby-server.svg)](https://gemnasium.com/sinm/couchdb-ruby-server) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/sinm/couchdb-ruby-server/master/LICENSE.txt) [![Code Climate](https://codeclimate.com/github/sinm/couchdb-ruby-server/badges/gpa.svg)](https://codeclimate.com/github/sinm/couchdb-ruby-server) [![Test Coverage](https://codeclimate.com/github/sinm/couchdb-ruby-server/badges/coverage.svg)](https://codeclimate.com/github/sinm/couchdb-ruby-server) [![Inline docs](http://inch-ci.org/github/sinm/couchdb-ruby-server.svg?branch=master)](http://inch-ci.org/github/sinm/couchdb-ruby-server)
+
+## Installation
+`gem install couchdb-ruby-server` as usual.
+
+Edit your couchdb's local.ini and set this in the `[query_servers]` group:
+
+    ruby = couchdb-ruby-server
+
+Restart CouchDB then.
+
+## Usage
+Design functions (map, reduce, update, etc.) are well defined as `lambda` or `proc` blocks:
+
+    lambda { |doc| emit [1,2,3], doc }
+
+It looks like any object responding to `#call` will survive.
+
+[Couchapp](couchapp.org) works well with `rb` files, so use it to manage  design files. Just do `echo ruby > language` inside your app's root directory and you're in.
+
+You may load your own code into the query server context by providing path to a library as an `--require LIB` option. This way you could deserialize documents right into the instances of the library classes instead of plain hashes.
+
+Actually any tagname for the query server may be set in `local.ini` instead of `ruby` so it's possible to run several query servers e.g. per application. Just remember to copy that tagname into couchapp's `language` file.
+
+## Tests
+`bundle exec rake test`. Gem following original [tests](https://github.com/apache/couchdb/blob/master/test/view_server/query_server_spec.rb).
+
+## Documentation
+This README is all i could say in a rush. No other documentation provided at this moment, see the sources.
+
+## If you've found a bug or drawback
+Don't hesistate to leave a report.
+
+## License
+MIT for now.

data/Rakefile

@@ -0,0 +1,16 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+
+Rake::TestTask.new :test do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.libs.push 'spec'
+  # bundle exec rake test TESTOPTS='-v'
+end
+
+task :build => :test do
+  system('gem build couchdb-ruby-server.gemspec')
+  # gem install couchdb-ruby-server-1.0.0.gem
+  # gem push couchdb-ruby-server-1.0.0.gem
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO file
+
+3. Client and server libs -- see what i have to copy here
+4. Implement $SAFE=4 thread, set safe level via args

data/bin/couchdb-ruby-server

@@ -0,0 +1,18 @@
+#!/usr/bin/env RUBY_GC_MALLOC_LIMIT=24000000 ruby
+require 'couchdb-ruby-server'
+require 'argparser'
+
+args = ArgParser.new  :program  => 'couchdb-ruby-server',
+                      :version  => CouchdbRubyServer::VERSION,
+                      :info     => 'CouchDB query server to run ruby design docs.',
+                      :licence  => 'MIT',
+                      :copyright=> '2014-2015 sinmsinm@gmail.com',
+                      :options  => [{ :names    => %w[r require],
+                                      :argument => 'LIB',
+                                      :multiple => true,
+                                      :help     => 'Aux library to require.' }]
+args['require'].value.each do |r|
+  require r
+end
+
+CouchdbRubyServer.run

data/couchdb-ruby-server.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+require File.expand_path('../lib/couchdb-ruby-server/version.rb', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'couchdb-ruby-server'
+  s.version       = CouchdbRubyServer::VERSION
+  s.authors       = ['sinm']
+  s.email         = 'sinm.sinm@gmail.com'
+  s.summary       = 'CouchDB query server to run ruby design docs'
+  s.description   = '== CouchDB query server to run ruby design docs'
+  s.homepage      = 'https://github.com/sinm/couchdb-ruby-server'
+  s.license       = 'MIT'
+  s.files         = `git ls-files -z`.split("\x0")
+  s.test_files    = `git ls-files -z spec/`.split("\0")
+  s.require_paths = ['lib']
+  s.bindir        = 'bin'
+  s.executables  << 'couchdb-ruby-server'
+  # s.extra_rdoc_files = 'README.md'
+  # s.rdoc_options  << '--title'    << 'couchdb-ruby-server' <<
+  #                      '--main'   << 'README'             <<
+  #                      '--markup' << 'markdown'           <<
+  #                      '--line-numbers'
+  s.add_development_dependency 'bundler',    '~> 1'
+  s.add_development_dependency 'rake',       '~> 10'
+  s.add_development_dependency 'minitest',   '~> 4'
+  s.add_dependency 'argparser', '~> 1'
+  s.add_dependency 'oj',        '~> 2.7'
+end

data/couchdb-ruby-server.sublime-project

@@ -0,0 +1,27 @@
+{
+	"folders":
+	[
+		{
+			"path": "/Users/sinm/Projects/couchdb-ruby-server"
+		}
+	],
+  "build_systems":
+  [
+    {
+        "name": "Run tests",
+        "cmd": ["bundle", "exec", "rake", "test"],
+        "selector": "source.rb"
+    }
+  ],
+  "settings":
+  {
+    "ensure_newline_at_eof_on_save": true,
+    "rulers":
+    [
+      80
+    ],
+    "tab_size": 2,
+    "translate_tabs_to_spaces": true,
+    "trim_trailing_white_space_on_save": true
+  }
+}

data/lib/couchdb-ruby-server/server.rb

@@ -0,0 +1,330 @@
+# coding: utf-8
+
+
+$stdin.sync = true
+$stdout.sync = true
+
+module CouchdbRubyServer
+  class Error < RuntimeError
+    attr_reader :key
+    def initialize key
+      @key = key
+    end
+  end
+  class Fatal < Error
+  end
+
+  def self.update_case fn, args
+    result = fn.call(*args)
+    return ["up", result[0], maybe_wrap_response(result[1])]
+  end
+
+  MIME_TYPES = {
+    :all => "*/*",
+    :text => "text/plain; charset=utf-8",
+    :html => "text/html; charset=utf-8",
+    :xhtml => "application/xhtml+xml",
+    :xml => "application/xml",
+    :js => "text/javascript",
+    :css => "text/css",
+    :ics => "text/calendar",
+    :csv => "text/csv; charset=utf-8",
+    :rss => "application/rss+xml",
+    :atom => "application/atom+xml",
+    :yaml => "application/x-yaml",
+    :multipart_form => "multipart/form-data",
+    :url_encoded_form => "application/x-www-form-urlencoded",
+    :json => "application/json; charset=utf-8"
+  }
+
+  TYPES_MIME = Hash[MIME_TYPES.map {|k, v| [v, k] }]
+
+  def self.to_json(obj)
+    Oj.dump(obj)
+  end
+
+  def self.json_parse(str)
+    return nil if str.nil?
+    Oj.load str
+  end
+
+  def self.log message
+    respond ['log', "#{message}"]
+  end
+
+  def self.respond obj
+    puts to_json obj
+  rescue
+    log "respond error converting object to JSON: #{$!.message}\n#{$!.backtrace.join("\n")}"
+    puts 'false'
+  end
+
+  def self.respond_error error, reason
+    if reason.respond_to?(:message) && reason.respond_to?(:backtrace)
+      reason =  "#{reason.class.name}: #{reason.message}\n#{reason.backtrace.join("\n")}"
+    end
+    respond ['error', error, reason]
+  end
+
+  def self.respond_fatal error, reason
+    respond_error error, reason
+    exit(2)
+  end
+
+  COMPILED_PROCS = {}
+
+  def self.compile_proc source, binding, name
+    source_hash = source.hash
+    fn = COMPILED_PROCS[source_hash]
+    return fn if fn
+    begin
+      fn = eval source, binding, name, 1
+      raise "#{name} must respond_to #call" unless fn.respond_to?(:call)
+      COMPILED_PROCS[source_hash] = fn
+    rescue Exception
+      respond_error :compilation_error, $!
+    end
+    fn
+  end
+
+  @@map_results = []
+  @@callables = []
+  @@ddocs = {}
+  #list state
+  @@chunks = []
+  @@start_resp = {}
+  @@got_row = false
+  @@last_row = false
+  @@provides_used = []
+  @@resp_mime = nil
+  #view filter
+  @@view_emit = nil
+
+  def self.emit(key, value)
+    if @@view_emit.nil?
+      @@map_results.push [key, value]
+    else
+      @@view_emit = true
+    end
+  end
+
+  def self.provides(*args, &block)
+    @@provides_used << {:format => args[0], :block => block}.merge(
+      args.size > 1 ? {:mime => args[1]} : {}
+    )
+    nil
+  end
+
+  def self.start(resp)
+    @@start_resp = resp if resp
+    nil
+  end
+
+  def self.send(chunk)
+    @@chunks << "#{chunk}"
+    nil
+  end
+
+  def self.get_row
+    return nil if @@last_row
+    if not @@got_row
+      @@got_row = true
+      render_headers
+      respond ["start", @@chunks, @@start_resp]
+      @@start_resp = {}
+    else
+      respond ["chunks", @@chunks]
+    end
+    @@chunks = []
+    json = json_parse ARGF.gets
+    if json[0] == 'list_end'
+      @@last_row = true
+      return nil
+    elsif json[0] != 'list_row'
+      respond_fatal :list_error, "not a row: #{json[0]}"
+    end
+    json[1]
+  end
+
+
+  def self.maybe_wrap_response resp
+    {:body=>''}.merge(
+      resp.respond_to?(:to_hash) ? resp.to_hash : {:body=>"#{resp}"})
+  end
+
+  def self.run_reduce(srcs, ks, vs, rereduce, b)
+    fns = srcs.collect { |src| compile_proc(src, b, "reduce (#{src[0..100]}...)") || return }
+    reductions = fns.collect { |fn|
+      begin
+        fn.call(ks, vs, rereduce)
+      rescue
+        log "#{rereduce ? 'rereduce' : 'reduce'} raised exception", $!
+        nil
+      end
+    }
+    respond [true, reductions]
+  end
+
+  def self.reset_list
+    @@got_row = false
+    @@last_row = false
+    @@chunks = []
+    @@start_resp = {}
+  end
+
+  def self.reset_provides
+    @@provides_used = []
+    @@resp_mime = nil
+  end
+
+  def self.render_headers
+    @@start_resp[:headers] ||= {}
+    @@start_resp[:headers]["Content-Type"] ||= @@resp_mime if @@resp_mime
+  end
+
+  def self.run_provides req
+    format = :unknown
+    best_fun = if req['query'] and req['query']['format']
+      format = req['query']['format']
+      @@provides_used.find do |p|
+        p[:format].to_s == format
+      end
+    elsif req['headers'] && (format = req['headers']['Accept'])
+      f = nil
+      format.split(',').each do |a|
+        break if (f = a =~ /^\*\/\*/ ? @@provides_used.first :
+          @@provides_used.find do |p|
+            a == p[:mime] or p[:format] == TYPES_MIME[a]
+          end)
+      end
+      f
+    else
+      @@provides_used.first
+    end
+    raise "format #{format} not supported" unless best_fun
+    raise "no block in provides" unless best_fun[:block] &&
+                                        best_fun[:block].respond_to?(:call)
+    @@resp_mime = best_fun[:mime] || MIME_TYPES[best_fun[:format]]
+    best_fun[:block].call
+  end
+
+  def self.run
+    log "CouchdbRubyServer started, RUBY_VERSION: #{RUBY_VERSION}"
+    log "RUBY_GC_MALLOC_LIMIT=#{ENV['RUBY_GC_MALLOC_LIMIT']}"
+    while cmd = $stdin.gets
+      cmd = json_parse cmd
+      case cmd[0]
+      when "reset"
+        @@callables = []
+        respond(true)
+      when "add_fun"
+        fn = compile_proc cmd[1], binding, "map (#{cmd[1][0..100]}...)"
+        next unless fn
+        @@callables << fn
+        respond(true)
+      when "map_doc"
+        results = []
+        @@view_emit = nil
+        doc = cmd[1]
+        doc.freeze
+        @@callables.each do |callable|
+          @@map_results = []
+          begin
+            callable.call(doc)
+            results.push(@@map_results)
+          rescue
+            log "map raised exception with doc._id #{doc['_id']}", $!
+            results.push([])
+          end
+        end
+        respond(results)
+      when "reduce"
+        ks, vs = cmd[2].transpose
+        run_reduce(cmd[1], ks, vs, false, binding)
+      when "rereduce"
+        run_reduce(cmd[1], nil, cmd[2], true, binding)
+      when "ddoc"
+        cmd.shift
+        ddoc_id = cmd.shift
+        if ddoc_id == 'new'
+          ddoc_id = cmd.shift
+          @@ddocs[ddoc_id] = cmd.shift
+          respond true
+        else
+          ddoc = @@ddocs[ddoc_id]
+          if not ddoc
+            respond_fatal :query_protocol_error, "uncached design doc: #{ddoc_id}"
+          end
+          point = ddoc
+          path = cmd.shift
+          begin
+            path.each do |level|
+              point = (point[level] || raise("missing #{level} function in #{ddoc_id}"))
+            end
+          rescue
+            respond_error :not_found, $!
+            next
+          end
+          next unless (fn = compile_proc point, binding, "#{ddoc['_id']}/#{path.join("/")}")
+          begin
+            response = nil
+            args = cmd.shift
+            case path[0]
+            when "updates"
+              respond update_case fn, args
+            when "lists"
+              #head = args[0]
+              reset_list
+              reset_provides
+              tail = fn.call(*args)
+              begin
+                tail = run_provides(args[1]) unless @@provides_used.empty?
+              rescue
+                respond_error :not_acceptable, $!
+                next
+              end
+              get_row unless @@got_row
+              @@chunks << tail unless tail.nil?
+              respond ["end", @@chunks]
+            when "shows"
+              respond ["resp", maybe_wrap_response(fn.call(*args))]
+            when "filters"
+              res = []
+              args[0].each do |doc|
+                res.push(fn.call(doc, args[1]) ? true : false)
+              end
+              respond [true, res]
+            when "views"
+              res = []
+              args[0].each do |doc|
+                @@view_emit = false
+                fn.call doc
+                res.push(@@view_emit ? true : false)
+              end
+              respond [true, res]
+            when "validate_doc_update"
+              begin
+                fn.call(*args)
+                respond 1
+              rescue
+                respond({:forbidden => "bad doc"})
+              end
+            else
+              respond_fatal :unknown_command, "unknown ddoc command #{path[0]}"
+              next
+            end # case ddoc
+          rescue Fatal
+            respond_fatal $!.key, $!.message
+          rescue Error
+            respond_error $!.key, $!.message
+          rescue
+            respond_error :render_error, $!
+          end
+        end
+      else
+        respond_fatal :unknown_command, "unknown command #{cmd[0]}"
+      end
+    end
+  end
+
+end