aerospike 0.1.6 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3befa3762779a41284c82d7d1c91071b2d808ba
-  data.tar.gz: e68d7474c1cc4f87b2b4e1ae2dc1f9cf6ce5363b
+  metadata.gz: 60bb290526217118edd3256087baf8f3b1979229
+  data.tar.gz: 3298f8ddaa97c6d93294f8dfa1610f2b0770b7da
 SHA512:
-  metadata.gz: 0670ec0132babe9a91821511c0303c866dd058d35c9e7e6dada688c20ce3d85ae44af4d29734200f8879d95530d94e8d2feff203ddce8f45f034ece463457d0f
-  data.tar.gz: 6a7ec991acdee8ae19227a33ec72f73bf11a845533032e9555cd3538c362f2398c4e09c2ff0ad5fe55cb60bfcdcbc33a3ace4ab72c93e7c43464f42174772d48
+  metadata.gz: 8f0cbc5177d8c217583531fc0408ba07f99d379a66f21e8f723326b06d99aa48d2ab315a636f7fa1ec3497fd52b8aec677b43a195420b289fd091815e80f8a50
+  data.tar.gz: 2900d08848a56766a865080a07ad09df17f23f14374eea6a92f873baddb1ee9d172b737f87934f75cfde425822a9f1d0923abc5bb7252d0252df613563a57c36

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## Jan 26 2014 (1.0.0)
+
+  Major release. With this release, Ruby client graduates to version 1.
+
+  * **Breaking Changes**:
+
+    * All `policy` initialize signatures have changed. Using policies was not documented, so it shouldn't affect most code. It will however, break any code initializing policies.
+    * Removed `Record.dups` and `GenerationPolicy::DUPLICATE`
+
+  * **New Features**:
+
+    * Added Security Features: Please consult [Security Docs](https://www.aerospike.com/docs/guide/security.html) on Aerospike website.
+      
+      * `ClientPolicy.User`, `ClientPolicy.Password`
+      * `Client.CreateUser()`, `Client.DropUser()`, `Client.ChangePassword()`
+      * `Client.GrantRoles()`, `Client.RevokeRoles()`, `Client.ReplaceRoles()`
+      * `Client.QueryUser()`, `Client.QueryUsers`
+
+  * **Fixes**:
+
+    * fixed size returned from `BytesValue.write`
+
 ## Dec 28 2014 (0.1.6)
 
   Minor features added, minor fixes and improvements.

data/lib/aerospike.rb

@@ -5,6 +5,7 @@ require "monitor"
 require "timeout"
 require 'resolv'
 require 'msgpack'
+require 'bcrypt'
 
 require 'aerospike/atomic/atomic'
 
@@ -35,6 +36,7 @@ require 'aerospike/command/touch_command'
 require 'aerospike/command/batch_command_exists'
 require 'aerospike/command/read_command'
 require 'aerospike/command/delete_command'
+require 'aerospike/command/admin_command'
 require 'aerospike/key'
 require 'aerospike/operation'
 
@@ -48,6 +50,7 @@ require 'aerospike/policy/scan_policy'
 require 'aerospike/policy/query_policy'
 require 'aerospike/policy/consistency_level'
 require 'aerospike/policy/commit_level'
+require 'aerospike/policy/admin_policy'
 
 require 'aerospike/cluster/connection'
 require 'aerospike/cluster/cluster'
@@ -65,6 +68,8 @@ require 'aerospike/info'
 require 'aerospike/udf'
 require 'aerospike/bin'
 require 'aerospike/aerospike_exception'
+require 'aerospike/user_role'
+
 require 'aerospike/task/index_task'
 require 'aerospike/task/udf_remove_task'
 require 'aerospike/task/udf_register_task'

data/lib/aerospike/atomic/atomic.rb

@@ -15,8 +15,10 @@
 
 module Aerospike
 
+  private
+
   # Container object for client policy command.
-  class Atomic
+  class Atomic # :nodoc:
 
     def initialize(value)
       @value = value

data/lib/aerospike/client.rb

@@ -36,13 +36,15 @@ module Aerospike
 
   class Client
 
-    attr_accessor :default_policy, :default_write_policy
+    attr_accessor :default_policy, :default_write_policy,
+      :default_scan_policy, :default_query_policy, :default_admin_policy
 
     def initialize(host, port, options={})
       @default_policy = Policy.new
       @default_write_policy = WritePolicy.new
       @default_scan_policy = ScanPolicy.new
       @default_query_policy = QueryPolicy.new
+      @default_admin_policy = QueryPolicy.new
 
       policy = opt_to_client_policy(options)
 
@@ -594,7 +596,7 @@ module Aerospike
             begin
               command.execute
             rescue => e
-              Aerospike.logger.error(e) unless e == Rescordset::SCAN_TERMINATED_EXCEPTION 
+              Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION 
               recordset.cancel(e)
             ensure
               recordset.thread_finished
@@ -609,7 +611,7 @@ module Aerospike
             begin
               command.execute
             rescue => e
-              Aerospike.logger.error(e) unless e == Rescordset::SCAN_TERMINATED_EXCEPTION 
+              Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION 
               recordset.cancel(e)
             ensure
               recordset.thread_finished
@@ -644,7 +646,7 @@ module Aerospike
         begin
           command.execute
         rescue => e
-          Aerospike.logger.error(e) unless e == Rescordset::SCAN_TERMINATED_EXCEPTION 
+          Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION 
           recordset.cancel(e)
         ensure
           recordset.thread_finished
@@ -684,7 +686,7 @@ module Aerospike
           begin
             command.execute
           rescue => e
-            Aerospike.logger.error(e) unless e == Rescordset::QUERY_TERMINATED_EXCEPTION 
+            Aerospike.logger.error(e.backtrace.join("\n")) unless e == QUERY_TERMINATED_EXCEPTION 
             recordset.cancel(e)
           ensure
             recordset.thread_finished
@@ -695,6 +697,82 @@ module Aerospike
       recordset
     end
 
+    #-------------------------------------------------------
+    # User administration
+    #-------------------------------------------------------
+
+    # Create user with password and roles. Clear-text password will be hashed using bcrypt
+    # before sending to server.
+    def create_user(user, password, roles, options={})
+      policy = opt_to_admin_policy(options)
+      hash = AdminCommand.hash_password(password)
+      command = AdminCommand.new
+      command.create_user(@cluster, policy, user, hash, roles)
+    end
+
+    # Remove user from cluster.
+    def drop_user(user, options={})
+      policy = opt_to_admin_policy(options)
+      command = AdminCommand.new
+      command.drop_user(@cluster, policy, user)
+    end
+
+    # Change user's password. Clear-text password will be hashed using bcrypt before sending to server.
+    def change_password(user, password, options={})
+      policy = opt_to_admin_policy(options)
+      if @cluster.user == ''
+        return NewAerospikeError(INVALID_USER)
+      end
+
+      hash = AdminCommand.hash_password(password)
+      command = AdminCommand.new
+
+      if user == @cluster.user
+        # Change own password.
+        command.change_password(@cluster, policy, user, hash)
+      else
+        # Change other user's password by user admin.
+        command.set_password(@cluster, policy, user, hash)
+      end
+
+      @cluster.change_password(user, hash)
+    end
+
+    # Add roles to user's list of roles.
+    def grant_roles(user, roles, options={})
+      policy = opt_to_admin_policy(options)
+      command = AdminCommand.new
+      command.grant_roles(@cluster, policy, user, roles)
+    end
+
+    # Remove roles from user's list of roles.
+    def revoke_roles(user, roles, options={})
+      policy = opt_to_admin_policy(options)
+      command = AdminCommand.new
+      command.revoke_roles(@cluster, policy, user, roles)
+    end
+
+    # Replace user's list of roles.
+    def replace_roles(user, roles, options={})
+      policy = opt_to_admin_policy(options)
+      command = AdminCommand.new
+      command.replace_roles(@cluster, policy, user, roles)
+    end
+
+    # Retrieve roles for a given user.
+    def query_user(user, options={})
+      policy = opt_to_admin_policy(options)
+      command = AdminCommand.new
+      command.query_user(@cluster, policy, user)
+    end
+
+    # Retrieve all users and their roles.
+    def query_users(options={})
+      policy = opt_to_admin_policy(options)
+      command = AdminCommand.new
+      command.query_users(@cluster, policy)
+    end
+
     private
 
     def send_info_command(policy, command)
@@ -720,11 +798,7 @@ module Aerospike
       elsif options.is_a?(ClientPolicy)
         options
       elsif options.is_a?(Hash)
-        ClientPolicy.new(
-          options[:timeout],
-          options[:connection_queue_size],
-          options[:fail_if_not_connected]
-        )
+        ClientPolicy.new(options)
       end
     end
 
@@ -734,13 +808,7 @@ module Aerospike
       elsif options.is_a?(Policy)
         options
       elsif options.is_a?(Hash)
-        Policy.new(
-          options[:priority],
-          options[:timeout],
-          options[:max_retiries],
-          options[:sleep_between_retries],
-          options[:consistency_level]
-        )
+        Policy.new(options)
       end
     end
 
@@ -750,14 +818,7 @@ module Aerospike
       elsif options.is_a?(WritePolicy)
         options
       elsif options.is_a?(Hash)
-        WritePolicy.new(
-          options[:record_exists_action],
-          options[:gen_policy],
-          options[:generation],
-          options[:expiration],
-          options[:send_key],
-          options[:commit_level]
-        )
+        WritePolicy.new(options)
       end
     end
 
@@ -767,12 +828,7 @@ module Aerospike
       elsif options.is_a?(ScanPolicy)
         options
       elsif options.is_a?(Hash)
-        ScanPolicy.new(
-          options[:scan_percent],
-          options[:concurrent_nodes],
-          options[:include_bin_data],
-          options[:fail_on_cluster_change]
-        )
+        ScanPolicy.new(options)
       end
     end
 
@@ -782,7 +838,17 @@ module Aerospike
       elsif options.is_a?(QueryPolicy)
         options
       elsif options.is_a?(Hash)
-        QueryPolicy.new()
+        QueryPolicy.new(options)
+      end
+    end
+
+    def opt_to_admin_policy(options)
+      if options.nil? || options == {}
+        @default_admin_policy
+      elsif options.is_a?(AdminPolicy)
+        options
+      elsif options.is_a?(Hash)
+        AdminPolicy.new(options)
       end
     end
 

data/lib/aerospike/cluster/cluster.rb

@@ -25,7 +25,7 @@ module Aerospike
 
   class Cluster
 
-    attr_reader :connection_timeout, :connection_queue_size
+    attr_reader :connection_timeout, :connection_queue_size, :user, :password
 
     def initialize(policy, *hosts)
       @cluster_seeds = hosts
@@ -38,6 +38,12 @@ module Aerospike
       @closed = Atomic.new(false)
       @mutex = Mutex.new
 
+      # setup auth info for cluster
+      if policy.requires_authentication
+        @user = policy.user
+        @password = AdminCommand.hash_password(policy.password)
+      end
+
       wait_till_stablized
 
       if policy.fail_if_not_connected && !connected?
@@ -88,7 +94,8 @@ module Aerospike
       # Must copy array reference for copy on write semantics to work.
       node_array = nodes
       length = node_array.length
-      for i in 0..length
+      i = 0
+      while i < length
         # Must handle concurrency with other non-tending threads, so node_index is consistent.
         index = (@node_index.update{|v| v+1} % node_array.length).abs
         node = node_array[index]
@@ -96,6 +103,8 @@ module Aerospike
         if node.active?
           return node
         end
+
+        i = i.succ
       end
       raise Aerospike::Exceptions::InvalidNode.new
     end
@@ -166,6 +175,11 @@ module Aerospike
       end
     end
 
+    def change_password(user, password)
+     # change password ONLY if the user is the same
+     @password = password if @user == user
+    end
+
     private
 
     def launch_tend_thread
@@ -210,7 +224,7 @@ module Aerospike
             refresh_count += 1
             friend_list.concat(friends) if friends
           rescue => e
-            Aerospike.logger.error("Node `#{node}` refresh failed: #{e.to_s}")
+            Aerospike.logger.error("Node `#{node}` refresh failed: #{e.backtrace.join("\n")}")
           end
         end
       end
@@ -283,9 +297,9 @@ module Aerospike
 
       seed_array.each do |seed|
         begin
-          seed_node_validator = NodeValidator.new(seed, @connection_timeout)
+          seed_node_validator = NodeValidator.new(self, seed, @connection_timeout)
         rescue => e
-          Aerospike.logger.error("Seed #{seed.to_s} failed: #{e}")
+          Aerospike.logger.error("Seed #{seed.to_s} failed: #{e.backtrace.join("\n")}")
           next
         end
 
@@ -297,7 +311,7 @@ module Aerospike
             nv = seed_node_validator
           else
             begin
-              nv = NodeValidator.new(aliass, @connection_timeout)
+              nv = NodeValidator.new(self, aliass, @connection_timeout)
             rescue Exection => e
               Aerospike.logger.error("Seed #{seed.to_s} failed: #{e}")
               next
@@ -345,7 +359,7 @@ module Aerospike
 
       hosts.each do |host|
         begin
-          nv = NodeValidator.new(host, @connection_timeout)
+          nv = NodeValidator.new(self, host, @connection_timeout)
 
           # if node is already in cluster's node list,
           # or already included in the list to be added, we should skip it
@@ -432,12 +446,15 @@ module Aerospike
       partitions_list.each do |node_array|
         max = node_array.length
 
-        for i in 0...max
+        i = 0
+        while i < max
           node = node_array[i]
           # Use reference equality for performance.
           if node == filter
             return true
           end
+
+          i = i.succ
         end
       end
       false

data/lib/aerospike/cluster/connection.rb

@@ -20,7 +20,7 @@ module Aerospike
 
   private
 
-  class Connection
+  class Connection # :nodoc:
 
     def initialize(host, port, timeout = 30)
 

data/lib/aerospike/cluster/node.rb

@@ -47,12 +47,25 @@ module Aerospike
       @connections =         Pool.new(@cluster.connection_queue_size)
       @connections.create_block = Proc.new do
         while conn = Connection.new(@host.name, @host.port, @cluster.connection_timeout)
+
+          # need to authenticate
+          if @cluster.user && @cluster.user != ''
+            begin
+              command = AdminCommand.new
+              command.authenticate(conn, @cluster.user, @cluster.password)
+            rescue => e
+              # Socket not authenticated. Do not put back into pool.
+              conn.close if conn
+              raise e
+            end
+          end
+
           break if conn.connected?
         end
         conn
       end
 
-      @connections.cleanup_block = Proc.new { |conn| conn.close }
+      @connections.cleanup_block = Proc.new { |conn| conn.close if conn }
     end
 
     # Request current status from server node, and update node with the result
@@ -65,7 +78,7 @@ module Aerospike
       rescue => e
         Aerospike.logger.error(e)
 
-        conn.close
+        conn.close if conn
         decrease_health
 
         raise e
@@ -179,7 +192,7 @@ module Aerospike
       # drain connections and close all of them
       # non-blocking, does not call create_block when passed false
       while conn = @connections.poll(false)
-        conn.close
+        conn.close if conn
       end
     end