libcouchbase 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2b2adec3e51e4e60b6c916abc6ec9b3ab4fabe8
-  data.tar.gz: 2ab400fc7fa882756081614ca99db819e7c04534
+  metadata.gz: 994ce5bef19d9b756a99b100151c0186c1196b1c
+  data.tar.gz: '04980977530cfe5f4c94f8eeb38c03546bcba541'
 SHA512:
-  metadata.gz: 01eedef8aeeedebdcd998a40542023d7fe50e0121f5848ca4635b38af977ff8f512e2f002fb092216787b831bc80c834dd15ed743b777c9ea2bfd4904a604eeb
-  data.tar.gz: 310f7f69fb77f03b50c9f6f626a9b76cf9ce9913e69471d9a4629e06eedd53af2b548e04740dc2ac1ce398371a077fd7a3eadf148e65539e2d97f30174c6a708
+  metadata.gz: 5f3bd4838cdb3fcbca7825fb0b0bade82b4054c72526ab82720adb1d5e536b0e0367bd65d55f012f52cd223c08d6e67a113616d4c8280d99169656362a204b25
+  data.tar.gz: 50a3ed477e3fa3e7faa06081343ab5a570e738e53d6f071a54629defa764f2a3a6aa40be9444c2e38e77470b9284a3aad40de1082e7338fa170ae441d4adb88f

data/README.md

@@ -9,6 +9,19 @@ An alternative to the official [couchbase-client](https://github.com/couchbase/c
 
 This is a low level wrapper around libcouchbase. For a more friendly ActiveModel interface see [couchbase-orm](https://github.com/acaprojects/couchbase-orm)
 
+## Couchbase 5 Changes
+
+The Couchbase 5 Admin Console blows away flags on documents if you edit them in the interface.
+Flags were being used to store document formats, however these were mainly implemented for compatibility with the defunct official client.
+
+
+To prevent this being an issue we've made the following changes from version 1.2 of this library:
+
+1. All writes will result in valid JSON being saved to the database
+   * No more `raw strings` they will be saved as `"raw strings"`
+   * Existing raw strings will still be read correctly
+2. Since there are no more raw strings, append / prepend are no longer needed (not that we ever used them)
+
 
 ## Runtime Support:
 
@@ -97,22 +110,6 @@ bucket.get("missing-key")                    #=> raise Libcouchbase::Error::KeyN
 bucket.get("missing-key", :quiet => true)    #=> nil
 ```
 
-The library supports three different formats for representing values:
-
-* `:document` (default) format supports most of ruby types which could
-  be mapped to JSON data (hashes, arrays, string, numbers).
-
-* `:plain` This format avoids any conversions to be applied to your
-  data, but your data should be passed as String. This is useful for
-  building custom algorithms or formats.
-
-* `:marshal` Use this format if you'd like to transparently serialize your
-  ruby object with standard `Marshal.dump` and `Marshal.load` methods
-
-```ruby
-bucket.put(:some_object, my_object, format: :marshal)
-```
-
 
 The library supports both synchronous and asynchronous operations.
 In asynchronous mode all operations will return control to caller
@@ -125,8 +122,8 @@ to execute in parallel.
 ```ruby
 # Perform operations in Async and then wait for the results
 results = []
-results << bucket.get(:key1)
-results << bucket.get(:key2)
+results << bucket.get(:key1, async: true)
+results << bucket.get(:key2, async: true)
 bucket.wait_results(results)          #=> ['key1_val', 'key2_val']
 
 # Is equivalent to:
@@ -153,7 +150,7 @@ result = bucket.get("foo", extended: true)
 result.key      #=> "foo"
 result.value    #=> {some: "value"}
 result.cas      #=> 123445
-result.metadata #=> {format: :document, flags: 0}
+result.metadata #=> {flags: 0}
 ```
 
 
@@ -195,7 +192,7 @@ options as set command above.
 
 ```ruby
 bucket.add("foo", "bar")
-bucket.add("foo", "bar", ttl: 30, format: :plain)
+bucket.add("foo", "bar", ttl: 30)
 ```
 
 
@@ -209,20 +206,6 @@ bucket.replace("foo", "bar")
 ```
 
 
-### Prepend/Append
-
-These commands are meaningful when you are using the `:plain` value format,
-because the concatenation is performed by server which has no idea how
-to merge to JSON values or values in ruby Marshal format.
-
-```ruby
-bucket.set(:foo, "world", format: :plain)
-bucket.append(:foo, "!")
-bucket.prepend(:foo, "Hello, ")
-bucket.get(:foo)                    #=> "Hello, world!"
-```
-
-
 ### Increment/Decrement
 
 These commands increment the value assigned to the key.
@@ -401,19 +384,21 @@ To execute view you need to fetch it from design document `_design/blog`:
 If N1QL indexes have been created, then you can query them
 
 ```ruby
-n1ql = bucket.n1ql
-n1ql.select('*').from(:default).where('port == 10001')
-res = n1ql.results
+results = bucket.n1ql
+  .select('*')
+  .from(:default)
+  .where('port == 10001')
+  .results
 
 # Results are lazily loaded by the enumerator
-# Results are stored for re-use until `res` goes out of scope
+# Results are stored for re-use until `results` goes out of scope
 # Actual database query happens here
-res.each do |row|
+results.each do |row|
     # Each row is a Hash of the data requested
 end
 
 # You can however stream results to save memory and the results are not saved
-res.stream do |row|
+results.stream do |row|
     # Row is cleaned up as soon as possible
 end
 ```
@@ -424,17 +409,17 @@ end
 If Full Text Search indexes have been created, then you can query them
 
 ```ruby
-res = bucket.full_text_search(:index_name, 'query')
+results = bucket.full_text_search(:index_name, 'query')
 
 # Results are lazily loaded by the enumerator
 # Results are stored for re-use until `res` goes out of scope
 # Actual database query happens here
-res.each do |row|
+results.each do |row|
     # Each row is a Hash of the data requested
 end
 
 # You can however stream results to save memory and the results are not saved
-res.stream do |row|
+results.stream do |row|
     # Row is cleaned up as soon as possible
 end
 ```

data/lib/libcouchbase/connection.rb

@@ -780,11 +780,7 @@ module Libcouchbase
                         headers[key] = value
                     end
                 end
-                body = if resp[:nbody] > 0
-                    resp[:body].read_string(resp[:nbody])
-                else
-                    ''
-                end
+                body = body_text(resp)
 
                 if (200...300).include? resp[:htstatus]
                     HttpResponse.new(cb, resp[:htstatus], headers, body, req.value)
@@ -835,7 +831,7 @@ module Libcouchbase
                 error_klass = Error.lookup(row_data[:rc])
                 if error_klass == Error::HttpError
                     http_resp = row_data[:htresp]
-                    view.error error_klass.new(http_resp[:body].read_string(http_resp[:nbody]))
+                    view.error error_klass.new(body_text(http_resp))
                 else
                     view.error error_klass.new
                 end
@@ -871,11 +867,20 @@ module Libcouchbase
                 error_klass = Error.lookup(row_data[:rc])
                 if error_klass == Error::HttpError
                     http_resp = row_data[:htresp]
-                    view.error error_klass.new(http_resp[:body].read_string(http_resp[:nbody]))
+                    view.error error_klass.new(body_text(http_resp))
                 else
                     view.error error_klass.new
                 end
             end
         end
+
+        # Extracts the body content of a HTTP response
+        def body_text(http_resp)
+            if http_resp[:nbody] > 0
+                http_resp[:body].read_string(http_resp[:nbody])
+            else
+                ''
+            end
+        end
     end
 end

data/lib/libcouchbase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true, encoding: ASCII-8BIT
 
 module Libcouchbase
-    VERSION = '1.2.2'
+    VERSION = '1.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libcouchbase
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Stephen von Takach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-31 00:00:00.000000000 Z
+date: 2017-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi