libcouchbase 0.0.1

data/lib/libcouchbase/ext/libcouchbase/valbuf.rb

@@ -0,0 +1,22 @@
+module Libcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :vtype ::
+  #   (KVBUFTYPE) Value request type. This may be one of:
+  #   - LCB_KV_COPY: Copy over the value into LCB's own buffers
+  #     Use the 'contig' field to supply the information.
+  #
+  #   - LCB_KV_CONTIG: The buffer is a contiguous chunk of value data.
+  #     Use the 'contig' field to supply the information.
+  #
+  #   - LCB_KV_IOV: The buffer is a series of IOV elements. Use the 'multi'
+  #     field to supply the information.
+  # :u_buf ::
+  #   (VALBUFUBuf)
+  class VALBUF < FFI::Struct
+    layout :vtype, KVBUFTYPE,
+           :u_buf, VALBUFUBuf.by_value
+  end
+
+end

data/lib/libcouchbase/ext/libcouchbase/valbuf_u_buf.rb

@@ -0,0 +1,14 @@
+module Libcouchbase::Ext
+  # (Not documented)
+  #
+  # ## Fields:
+  # :contig ::
+  #   (CONTIGBUF)
+  # :multi ::
+  #   (FRAGBUF)
+  class VALBUFUBuf < FFI::Union
+    layout :contig, CONTIGBUF.by_value,
+           :multi, FRAGBUF.by_value
+  end
+
+end

data/lib/libcouchbase/ext/libcouchbase/viewhandle.rb

@@ -0,0 +1,7 @@
+module Libcouchbase::Ext
+  # (Not documented)
+  class VIEWHANDLE < FFI::Struct
+    layout :dummy, :char
+  end
+
+end

data/lib/libcouchbase/ext/libcouchbase_iocp.rb

@@ -0,0 +1,26 @@
+
+# This file contains the structures required to configure libcouchbase to use
+# windows IOCP for event IO
+
+module Libcouchbase::Ext
+
+    # ref: http://docs.couchbase.com/sdk-api/couchbase-c-client-2.6.2/group__lcb-io-plugin-api.html
+
+    IOType = enum [
+        :IO_libevent, 0x02,
+        :IO_winsock, 0x03,
+        :IO_libev, 0x04,
+        :IO_select, 0x05,
+        :IO_winIOCP, 0x06,
+        :IO_libuv, 0x07
+    ]
+
+    class IOOptions < FFI::Struct
+        layout :version, :int,      # Always 0
+               :type,    IOType,    # Always IO_winIOCP
+               :cookie,  :pointer
+    end
+
+    # pointer param returns IO opts structure
+    attach_function :create_io_ops, :lcb_create_io_ops, [:pointer, IOOptions.by_ref], ErrorT
+end

data/lib/libcouchbase/ext/libcouchbase_libuv.rb

@@ -0,0 +1,18 @@
+
+# This file contains all the structures required to configure libcouchbase to use
+# Libuv as the primary event loop
+
+module Libcouchbase::Ext::Libuv
+    extend FFI::Library
+    ffi_lib ::File.expand_path("../../../../ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}", __FILE__)
+
+    # ref: http://docs.couchbase.com/sdk-api/couchbase-c-client-2.4.8/group__lcb-libuv.html
+    class UVOptions < FFI::Struct
+        layout :version,        :int,
+               :loop,           :pointer,
+               :start_stop_noop,:int
+    end
+
+    # pointer param returns IO opts structure
+    attach_function :create_libuv_io_opts, :lcb_create_libuv_io_opts, [:int, :pointer, UVOptions.by_ref], ::Libcouchbase::Ext::ErrorT
+end

data/lib/libcouchbase/ext/tasks.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+require 'fileutils'
+require 'libuv'
+
+module FFI::Platform
+    def self.ia32?
+        ARCH == "i386"
+    end
+
+    def self.x64?
+        ARCH == "x86_64"
+    end
+end
+
+if FFI::Platform.windows?
+    require 'net/http'
+
+    # Download a pre-built package
+    url = if FFI::Platform.x64?
+        "http://packages.couchbase.com/clients/c/libcouchbase-2.6.3_amd64_vc14.zip"
+    else
+        "http://packages.couchbase.com/clients/c/libcouchbase-2.6.3_x86_vc14.zip"
+    end
+    zip_file = File.expand_path("../../../../ext/libcouchbase.zip", __FILE__)
+
+    file zip_file do
+        print "downloading #{url}"
+        uri = URI(url)
+        Net::HTTP.start(uri.host, uri.port) do |http|
+            request = Net::HTTP::Get.new uri
+
+            http.request request do |response|
+                open File.expand_path("../../../../ext/libcouchbase.zip", __FILE__), 'wb' do |io|
+                    response.read_body do |chunk|
+                        io.write chunk
+                        print '.'
+                    end
+                end
+            end
+        end
+    end
+
+    # Extract the files
+    file 'ext/tmp' => zip_file do
+        begin
+            puts "\nextracting files..."
+            raise 'error extracting files' unless system(File.expand_path("../../../../ext/win-extract.bat", __FILE__))
+        ensure
+            # TODO:: remove dir
+        end
+    end
+
+    # Copy binary files to bin dir
+    file "ext/bin/libcouchbase.#{FFI::Platform::LIBSUFFIX}" => 'ext/tmp' do
+        Dir.chdir('ext/tmp') do |path|
+            dir = File.expand_path("../", Dir["**/libcouchbase.#{FFI::Platform::LIBSUFFIX}"].first)
+            FileUtils.mv dir, File.expand_path("../../../../ext/bin", __FILE__)
+        end
+        FileUtils.rm_rf(File.expand_path("../../../../ext/tmp", __FILE__))
+    end
+else
+    # -----------
+    # UNIX  BUILD
+    # -----------
+
+    # Ensure the submodule is cloned
+    file 'ext/libcouchbase/include' do
+        system 'git', 'submodule', 'update', '--init'
+    end
+
+    file 'ext/libcouchbase/build' => 'ext/libcouchbase/include' do
+        FileUtils.mkdir('ext/libcouchbase/build')
+    end
+
+    file 'ext/libcouchbase/build/makefile' => 'ext/libcouchbase/build' do
+        Dir.chdir("ext/libcouchbase") do |path|
+            system './cmake/configure', '-with-libuv', ::File.expand_path('../../', ::Libuv::Ext.path_to_internal_libuv)
+        end
+    end
+
+    file "ext/libcouchbase/build/lib/libcouchbase_libuv.#{FFI::Platform::LIBSUFFIX}" => 'ext/libcouchbase/build/makefile' do
+        Dir.chdir('ext/libcouchbase/build') do |path|
+            system 'make'
+        end
+    end
+end

data/lib/libcouchbase/n1ql.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+module Libcouchbase
+    class N1QL
+        Ordering = [:select, :insert_into, :delete_from, :update, :from, :use_keys, :unnest, :join, :where, :group_by, :order_by, :limit, :offset]
+
+        def initialize(bucket, explain: false, **options)
+            @bucket = bucket
+            @connection = bucket.connection
+            @explain = !!explain
+            options.each do |key, value|
+                if self.respond_to? key
+                    self.public_send key, value
+                end
+            end
+        end
+
+        attr_accessor *Ordering
+        attr_accessor :explain
+        attr_reader   :bucket, :connection
+
+        def explain(val = nil)
+            return @explain if val.nil?
+            @explain = !!val
+            self
+        end
+
+        Ordering.each do |helper|
+            define_method helper do |*args|
+                return instance_variable_get :"@#{helper}" if args.empty?
+                if args.length == 1
+                    instance_variable_set :"@#{helper}", args[0]
+                else
+                    instance_variable_set :"@#{helper}", args
+                end
+                self
+            end
+        end
+
+        def to_s
+            res = String.new
+            res << "EXPLAIN\n" if @explain
+            Ordering.each do |statement|
+                val = public_send statement
+                unless val.nil?
+                    res << "#{statement.to_s.gsub('_', ' ').upcase} "
+
+                    if val.is_a? Array
+                        res << val.collect { |obj| obj.to_s }.join(', ')
+                    else
+                        res << val.to_s
+                    end
+
+                    res << "\n"
+                end
+            end
+            res
+        end
+
+        def results(&row_modifier)
+            n1ql_view = @connection.n1ql_query(self)
+
+            current = ::Libuv::Reactor.current
+            if current && current.running?
+                ResultsLibuv.new(n1ql_view, current, &row_modifier)
+            elsif Object.const_defined?(:EventMachine) && EM.reactor_thread?
+                ResultsEM.new(n1ql_view, &row_modifier)
+            else
+                ResultsNative.new(n1ql_view, &row_modifier)
+            end
+        end
+    end
+end

data/lib/libcouchbase/query_full_text.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+module Libcouchbase
+    class QueryFullText
+        def initialize(connection, reactor, include_docs: true, **opts)
+            @connection = connection
+            @reactor = reactor
+
+            @options = opts
+            @include_docs = include_docs
+            @request_handle = FFI::MemoryPointer.new :pointer, 1
+        end
+
+        attr_reader :options, :connection
+        attr_accessor :include_docs
+
+        def index
+            @options[:indexName]
+        end
+
+        def get_count(metadata)
+            metadata[:total_hits]
+        end
+
+        def perform(limit: nil, **options, &blk)
+            raise 'not connected' unless @connection.handle
+            raise 'query already in progress' if @query_cstr
+            raise 'callback required' unless block_given?
+
+            # customise the size based on the request being made
+            orig_size = @options[:size] || 10 # 10 is the couchbase default
+            new_size = limit || orig_size
+            begin
+                @options[:size] = new_size if orig_size > new_size
+                @query_text = JSON.generate(@options)
+                @query_cstr = FFI::MemoryPointer.from_string(@query_text)
+            rescue
+                @query_cstr = nil
+                @query_text = nil
+                raise
+            ensure
+                @options[:size] = orig_size
+            end
+
+            @reactor.schedule {
+                @error = nil
+                @doc_count = 0
+                @callback = blk
+
+                @cmd = Ext::CMDFTS.new
+                @cmd[:query] = @query_cstr
+                @cmd[:nquery] = @query_text.bytesize
+                @cmd[:callback] = @connection.get_callback(:fts_callback)
+                @cmd[:handle] = @request_handle
+
+                pointer = @cmd.to_ptr
+                @connection.requests[pointer.address] = self
+
+                err = Ext.fts_query(@connection.handle, pointer, @cmd)
+                if err != :success
+                    error(Error.lookup(err).new('full text search not scheduled'))
+                end
+            }
+        end
+
+        # Example Row:
+        # {:index=>"default_3f230bec977a680e_b7ff6b68", :id=>"dep_1-18", :score=>1.3540229098345296,
+        #  :locations=>{:class_name=>{:toshiba=>[{:pos=>1, :start=>2, :end=>9, :array_positions=>nil}]},
+        #  :name=>{:toshiba=>[{:pos=>1, :start=>0, :end=>7, :array_positions=>nil}]}}}
+        def received(row)
+            return if @error
+
+            resp = Response.new(:fts_callback, row[:id])
+            resp.metadata = row
+
+            # TODO:: this could cause results to be returned out of order
+            if @include_docs
+                @doc_count += 1
+                doc = co @connection.get(resp.key)
+                resp.value = doc.value
+                resp.cas = doc.cas
+                resp.metadata.merge! doc.metadata
+            end
+
+            @callback.call(false, resp)
+        rescue => e
+            @error = e
+            cancel
+        ensure
+            if @include_docs
+                @doc_count -= 1
+                process_final if @metadata && @doc_count == 0
+            end
+        end
+
+        # Example metadata
+        # {:status=>{:total=>2, :failed=>0, :successful=>2}, :request=>{:query=>{:query=>"Toshiba", :boost=>1},
+        #  :size=>10, :from=>0, :highlight=>nil, :fields=>nil, :facets=>nil, :explain=>false}, :hits=>[],
+        #  :total_hits=>4, :max_score=>1.6405488681166451, :took=>10182765, :facets=>{}}
+        def received_final(metadata)
+            @metadata = metadata
+            process_final unless @doc_count > 0
+        end
+
+        def error(obj)
+            @error = obj
+            # This sets metadata to true, however it'll be ignored as error is set
+            # We set it to true as we may be fetching documents in parallel and need to wait
+            received_final(true)
+        end
+
+        def cancel
+            @error = :cancelled unless @error
+            @reactor.schedule {
+                if @connection.handle && @cmd
+                    Ext.fts_cancel(@connection.handle, @handle_ptr.get_pointer(0))
+                    received_final(true)
+                end
+            }
+        end
+
+
+        protected
+
+
+        def process_final
+            metadata = @metadata
+            @metadata = nil
+            
+            @query_cstr = nil
+            @query_text = nil
+
+            @connection.requests.delete(@cmd.to_ptr.address)
+            @cmd = nil
+
+            if @error
+                if @error == :cancelled
+                    @callback.call(:final, metadata)
+                else
+                    @callback.call(:error, @error)
+                end
+            else
+                @callback.call(:final, metadata)
+            end
+        end
+    end
+end

data/lib/libcouchbase/query_n1ql.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true, encoding: ASCII-8BIT
+
+module Libcouchbase
+    class QueryN1QL
+        N1P_QUERY_STATEMENT = 1
+
+
+        def initialize(connection, reactor, n1ql, **opts)
+            @connection = connection
+            @reactor = reactor
+
+            @n1ql = n1ql
+            @request_handle = FFI::MemoryPointer.new :pointer, 1
+        end
+
+
+        attr_reader :connection, :n1ql
+
+
+        def get_count(metadata)
+            metadata[:metrics][:resultCount]
+        end
+
+        def perform(limit: nil, **options, &blk)
+            raise 'not connected' unless @connection.handle
+            raise 'query already in progress' if @query_text
+            raise 'callback required' unless block_given?
+
+            # customise the size based on the request being made
+            orig_limit = @n1ql.limit
+            begin
+                if orig_limit && limit
+                    @n1ql.limit = limit if orig_limit > limit
+                end
+                @query_text = @n1ql.to_s
+            rescue
+                @query_text = nil
+                raise
+            ensure
+                @n1ql.limit = orig_limit
+            end
+
+            @reactor.schedule {
+                @error = nil
+                @callback = blk
+
+                @cmd = Ext::CMDN1QL.new
+                @params = Ext.n1p_new
+                err = Ext.n1p_setquery(@params, @query_text, @query_text.bytesize, N1P_QUERY_STATEMENT)
+                if err == :success
+
+                    err = Ext.n1p_mkcmd(@params, @cmd)
+                    if err == :success
+
+                        pointer = @cmd.to_ptr
+                        @connection.requests[pointer.address] = self
+
+                        @cmd[:callback] = @connection.get_callback(:n1ql_callback)
+                        @cmd[:handle] = @request_handle
+
+                        err = Ext.n1ql_query(@connection.handle, pointer, @cmd)
+                        if err != :success
+                            error(Error.lookup(err).new('full text search not scheduled'))
+                        end
+                    else
+                        error(Error.lookup(err).new('failed to build full text search command'))
+                    end
+                else
+                    error(Error.lookup(err).new('failed to build full text search query structure'))
+                end
+            }
+        end
+
+        # Row is JSON value representing the result
+        def received(row)
+            return if @error
+            @callback.call(false, row)
+        rescue => e
+            @error = e
+            cancel
+        end
+
+        # Example metadata
+        # {:requestID=>"36162fce-ef39-4821-bf03-449e4073185d", :signature=>{:*=>"*"}, :results=>[], :status=>"success",
+        #  :metrics=>{:elapsedTime=>"15.298243ms", :executionTime=>"15.256975ms", :resultCount=>12, :resultSize=>8964}}
+        def received_final(metadata)
+            @query_text = nil
+
+            @connection.requests.delete(@cmd.to_ptr.address)
+            @cmd = nil
+
+            Ext.n1p_free(@params)
+            @params = nil
+
+            if @error
+                if @error == :cancelled
+                    @callback.call(:final, metadata)
+                else
+                    @callback.call(:error, @error)
+                end
+            else
+                @callback.call(:final, metadata)
+            end
+        end
+
+        def error(obj)
+            @error = obj
+            received_final(nil)
+        end
+
+        def cancel
+            @error = :cancelled unless @error
+            @reactor.schedule {
+                if @connection.handle && @cmd
+                    Ext.n1ql_cancel(@connection.handle, @handle_ptr.get_pointer(0))
+                    received_final(nil)
+                end
+            }
+        end
+    end
+end