aerospike 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 326faeb8584bc6c84a0bb1f4e7c7427ec321cefb
-  data.tar.gz: acf465f44ff7d7fab289b6bc2935edfc67fe8740
+  metadata.gz: d3b1cf8b0aa82d7b20abe743510e5093c22289cb
+  data.tar.gz: 0e6de6aa46848b62e9e2b0797de87f53c26aa22b
 SHA512:
-  metadata.gz: c1a033227dd57f6df5b9bb289c5bce1a306eabf1c6e565b63c1afb59cfa41d8a0d2dc5c19c571e0158788c03774c8fdb6cc2920f28ca1e871863eae306c7ac7e
-  data.tar.gz: 1e3955fb7b008fc51aaff9f33edfba63f4102d2fbe2293b06fca813a89f7ccdf089905718dfa23be5f003225e01bcc20994e441cde887134d37133de12944260
+  metadata.gz: e1213afa1c9f167ed59a722cc8e947cb3f05a98cc98615d65c1e739159be9f85c31bd9e0b9316e77528388f1a6ddaa6a13a81a11a54930fd88d7724565c19056
+  data.tar.gz: a19838f475d25015dc8959cbc9e90a2d0ab3a1cb94207da4b4ab02c2c442403f19aaf7c3318758fb8ce17e1c3af0c2b8d907936d1337b76e7e709ac68778a5f7

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+v2.3.0 / 2017-01-04
+===================
+
+* **Bug Fixes**
+  * Fix BytesValue used as record key. [#42](https://github.com/aerospike/aerospike-client-ruby/issues/42)
+
+* **Changes**
+  * Deprecate unsupport key types - only integer, string and byte keys are supported. [#43](https://github.com/aerospike/aerospike-client-ruby/issues/43)
+
 v2.2.1 / 2016-11-14
 ===================
 

data/lib/aerospike.rb

@@ -1,4 +1,19 @@
 # encoding: utf-8
+# Copyright 2014-2016 Aerospike, Inc.
+#
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not
+# use this file except in compliance with the License. You may obtain a copy of
+# the License at http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
 require "logger"
 require "stringio"
 require "monitor"
@@ -13,7 +28,6 @@ require 'aerospike/client'
 require 'aerospike/utils/pool'
 require 'aerospike/utils/packer'
 require 'aerospike/utils/unpacker'
-require 'aerospike/utils/epoc'
 require 'aerospike/utils/buffer'
 require 'aerospike/host'
 require 'aerospike/loggable'

data/lib/aerospike/client.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.

data/lib/aerospike/command/batch_command_get.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -59,7 +59,7 @@ module Aerospike
         return false if (info3 & INFO3_LAST) == INFO3_LAST
 
         generation = @data_buffer.read_int32(6)
-        expiration = Aerospike.TTL(@data_buffer.read_int32(10))
+        expiration = @data_buffer.read_int32(10)
         field_count = @data_buffer.read_int16(18)
         op_count = @data_buffer.read_int16(20)
         key = parse_key(field_count)

data/lib/aerospike/command/command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -610,7 +610,7 @@ module Aerospike
       @data_buffer.write_byte(0, 12) # unused
       @data_buffer.write_byte(0, 13) # clear the result code
       @data_buffer.write_uint32(generation, 14)
-      @data_buffer.write_uint32(policy.expiration, 18)
+      @data_buffer.write_uint32(policy.ttl, 18)
 
       # Initialize timeout. It will be written later.
       @data_buffer.write_byte(0, 22)

data/lib/aerospike/command/read_command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -18,7 +18,6 @@ require 'aerospike/record'
 
 require 'aerospike/command/single_command'
 require 'aerospike/policy/operate_policy'
-require 'aerospike/utils/epoc'
 require 'aerospike/value/value'
 
 module Aerospike
@@ -57,7 +56,7 @@ module Aerospike
       header_length = @data_buffer.read(8).ord
       result_code = @data_buffer.read(13).ord & 0xFF
       generation = @data_buffer.read_int32(14)
-      expiration = Aerospike.TTL(@data_buffer.read_int32(18))
+      expiration = @data_buffer.read_int32(18)
       field_count = @data_buffer.read_int16(26) # almost certainly 0
       op_count = @data_buffer.read_int16(28)
       receive_size = (sz & 0xFFFFFFFFFFFF) - header_length

data/lib/aerospike/command/read_header_command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -45,7 +45,7 @@ module Aerospike
 
       if result_code == 0
         generation = @data_buffer.read_int32(14)
-        expiration = Aerospike.TTL(@data_buffer.read_int32(18))
+        expiration = @data_buffer.read_int32(18)
         @record = Record.new(@node, @key, nil,  generation, expiration)
       else
         if result_code == Aerospike::ResultCode::KEY_NOT_FOUND_ERROR

data/lib/aerospike/key.rb

@@ -41,23 +41,24 @@ module Aerospike
       @v1_compatibility
     end
 
+    # Keys other than integers, strings and bytes are unsupported and will trigger a warning if used.
+    # Starting with v3 the client will raise an error instead of a warning.
+    # ref. https://github.com/aerospike/aerospike-client-ruby/issues/43
+    def self.disable_unsupported_key_warning!(enable_warning = false)
+      @unsupported_key_warning = enable_warning
+    end
+    def self.warn_unsupported_key?
+      @unsupported_key_warning
+    end
+
     attr_reader :namespace, :set_name, :digest
-    attr_reader :v1_compatible
-    alias_method :v1_compatible?, :v1_compatible
 
     def initialize(ns, set, val, digest=nil, v1_compatible: self.class.v1_compatible?)
       @namespace = ns
       @set_name = set
       @user_key = Value.of(val)
-      @v1_compatible = v1_compatible
-
-      unless digest
-        compute_digest
-      else
-        @digest = digest
-      end
-
-      self
+      check_key!(@namespace, @set_name, @user_key, !digest.nil?)
+      @digest = digest || compute_digest(v1_compatible)
     end
 
 
@@ -86,7 +87,20 @@ module Aerospike
 
     private
 
-    def compute_digest
+    def valid_key?(value, has_digest)
+      value.is_a?(IntegerValue) ||
+        value.is_a?(StringValue) ||
+        value.is_a?(BytesValue) ||
+        (has_digest && value.is_a?(NullValue))
+    end
+
+    def check_key!(ns, set, value, has_digest)
+      if self.class.warn_unsupported_key? && !valid_key?(value, has_digest)
+        warn("Unsupported key type: #{value.class.name} - only Integer, String and Bytes are supported")
+      end
+    end
+
+    def compute_digest(v1_compatible = false)
       key_type = @user_key.type
       key_bytes = @user_key.to_bytes
 
@@ -95,7 +109,7 @@ module Aerospike
       end
 
       # v1.0.12 and prior computed integer key digest using little endian byte order
-      if key_type == Aerospike::ParticleType::INTEGER && v1_compatible?
+      if key_type == Aerospike::ParticleType::INTEGER && v1_compatible
         key_bytes.reverse!
       end
 
@@ -107,10 +121,12 @@ module Aerospike
       h.update(@set_name)
       h.update(key_type.chr)
       h.update(key_bytes)
-      @digest = h.digest
+      digest = h.digest
 
       # put the hash object back to the pool
       @@digest_pool.offer(h)
+
+      digest
     end
 
   end

data/lib/aerospike/policy/write_policy.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -24,9 +24,12 @@ module Aerospike
   class WritePolicy < Policy
 
     attr_accessor :record_exists_action, :generation_policy,
-      :generation, :expiration, :send_key, :commit_level,
+      :generation, :ttl, :send_key, :commit_level,
       :durable_delete
 
+    alias expiration ttl
+    alias expiration= ttl=
+
     def initialize(opt={})
       super(opt)
 
@@ -47,14 +50,19 @@ module Aerospike
       # the expected generation would be 0
       @generation = opt[:generation] || 0
 
-      # Record expiration. Also known as ttl (time to live).
+      # Record expiration; also known as time-to-live (TTL).
       # Seconds record will live before being removed by the server.
-      # Expiration values:
-      # -1: Never expire for Aerospike 2 server versions >= 2.7.2 and Aerospike 3 server
-      # versions >= 3.1.4.  Do not use -1 for older servers.
-      # 0: Default to namespace configuration variable "default-ttl" on the server.
-      # > 0: Actual expiration in seconds.
-      @expiration = opt[:expiration] || opt[:ttl] || 0
+      #
+      # Supported values:
+      # - `Aerospike::TTL::NEVER_EXPIRE`: Never expire record; requires Aerospike 2
+      #    server versions >= 2.7.2 or Aerospike 3 server versions >= 3.1.4. Do
+      #    not use for older servers.
+      # - `Aerospike::TTL::NAMESPACE_DEFAULT`: Default to namespace configuration
+      #    variable "default-ttl" on the server.
+      # - `Aerospike::TTL::DONT_UPDATE`: Do not change a record's expiration date
+      #   when updating the record. Requires Aerospike server v3.10.1 or later.
+      # - Any value > 0: Actual time-to-live in seconds.
+      @ttl = opt[:ttl] || opt[:expiration] || 0
 
       # Send user defined key in addition to hash digest on a record put.
       # The default is to send the user defined key.

data/lib/aerospike/query/stream_command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -53,7 +53,7 @@ module Aerospike
         return false if (info3 & INFO3_LAST) == INFO3_LAST
 
         generation = @data_buffer.read_int32(6)
-        expiration = Aerospike.TTL(@data_buffer.read_int32(10))
+        expiration = @data_buffer.read_int32(10)
         field_count = @data_buffer.read_int16(18)
         op_count = @data_buffer.read_int16(20)
         key = parse_key(field_count)

data/lib/aerospike/record.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
+# Copyright 2014-2016 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -20,21 +20,37 @@ module Aerospike
 
   class Record
 
-    attr_reader :key, :bins, :generation, :expiration, :node
+    attr_reader :key, :bins, :generation, :ttl, :node
+
+    alias expiration ttl # for backwards compatibility
 
     def initialize(node, rec_key, rec_bins, rec_gen, rec_exp)
       @key = rec_key
       @bins = rec_bins
       @generation = rec_gen
-      @expiration = rec_exp
+      @ttl = expiration_to_ttl(rec_exp)
       @node = node
     end
 
     def to_s
-      'key: `' + key.to_s + '` ' +
-         'bins: `' + bins.to_s + '` ' +
-         'generation: `' + generation.to_s + '` ' +
-         'expiration: `' + expiration.to_s + '` '
+      "key: `#{key}` bins: `#{bins}` generation: `#{generation}`, ttl: `#{ttl}`"
+    end
+
+    private
+
+    CITRUSLEAF_EPOCH = 1262304000
+
+    # Converts an absolute expiration time (in seconds from citrusleaf epoch)
+    # to relative time-to-live (TTL) in seconds
+    def expiration_to_ttl(secs_from_epoc)
+      if secs_from_epoc == 0
+        Aerospike::TTL::NEVER_EXPIRE
+      else
+        now = Time.now.to_i - CITRUSLEAF_EPOCH
+        # Record was not expired at server but if it looks expired at client
+        # because of delay or clock differences, present it as not-expired.
+        secs_from_epoc > now ? secs_from_epoc - now : 1
+      end
     end
 
   end

data/lib/aerospike/value/value.rb

@@ -120,7 +120,7 @@ module Aerospike
     end
 
     def to_bytes
-      @bytes.bytes
+      @bytes
     end
 
     def estimate_size

data/lib/aerospike/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Aerospike
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aerospike
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Khosrow Afroozeh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -131,7 +131,6 @@ files:
 - lib/aerospike/udf.rb
 - lib/aerospike/user_role.rb
 - lib/aerospike/utils/buffer.rb
-- lib/aerospike/utils/epoc.rb
 - lib/aerospike/utils/packer.rb
 - lib/aerospike/utils/pool.rb
 - lib/aerospike/utils/unpacker.rb

data/lib/aerospike/utils/epoc.rb

@@ -1,37 +0,0 @@
-# encoding: utf-8
-# Copyright 2014 Aerospike, Inc.
-#
-# Portions may be licensed to Aerospike, Inc. under one or more contributor
-# license agreements.
-#
-# Licensed under the Apache License, Version 2.0 (the "License"); you may not
-# use this file except in compliance with the License. You may obtain a copy of
-# the License at http:#www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations under
-# the License.
-
-require 'time'
-
-module Aerospike
-
-  private
-
-  CITRUSLEAF_EPOCH = 1262304000
-
-  # Converts an Expiration time to TTL in seconds
-  def self.TTL(secs_from_citrus_leaf_epoc) #:nodoc:
-    if secs_from_citrus_leaf_epoc == 0
-      0xFFFFFFFF
-    else
-      now = Time.now.to_i - CITRUSLEAF_EPOCH
-      # Record was not expired at server but if it looks expired at client
-      # because of delay or clock differences, present it as not-expired.
-      secs_from_citrus_leaf_epoc > now ? secs_from_citrus_leaf_epoc - now : 1
-    end
-  end
-
-end # module