class Dynamini::TestClient

In-memory database client for test purposes.

Attributes

data[R]
hash_key_attr[R]
range_key_attr[R]
secondary_index[R]

Public Class Methods

new(hash_key_attr, range_key_attr = nil, secondary_index=nil) click to toggle source
# File lib/dynamini/test_client.rb, line 10
def initialize(hash_key_attr, range_key_attr = nil, secondary_index=nil)
  @data = {}
  @hash_key_attr = hash_key_attr
  @range_key_attr = range_key_attr
  @secondary_index = secondary_index
end

Public Instance Methods

apply_filter_options(parent, args, start_val, end_val) click to toggle source
# File lib/dynamini/test_client.rb, line 203
def apply_filter_options(parent, args, start_val, end_val)
  records = parent.values
  records = records.select { |record| record[@range_key_attr] >= start_val.to_f } if start_val
  records = records.select { |record| record[@range_key_attr] <= end_val.to_f } if end_val
  records = records.sort! { |a, b| b[@range_key_attr] <=> a[@range_key_attr] } if args[:scan_index_forward] == false
  records = records[0...args[:limit]] if args[:limit]
  records
end
batch_get_item(args = {}) click to toggle source

No range key support - use query instead.

# File lib/dynamini/test_client.rb, line 71
def batch_get_item(args = {})
  responses = {}

  args[:request_items].each do |table_name, get_request|
    responses[table_name] = []
    ids = get_request[:keys].flat_map(&:values)
    raise 'Aws::DynamoDB::Errors::ValidationException: Provided list of item keys contains duplicates' if ids.length != ids.uniq.length
    get_request[:keys].each do |key_hash|
      item = get_table(table_name)[key_hash.values.first]
      responses[table_name] << item unless item.nil?
    end
  end

  OpenStruct.new(responses: responses)
end
batch_write_item(request_options) click to toggle source

TODO add range key support for delete, not currently implemented batch_operations.batch_delete

# File lib/dynamini/test_client.rb, line 136
def batch_write_item(request_options)
  request_options[:request_items].each do |table_name, requests|
    table = get_table(table_name)

    requests.each do |request_hash|
      if request_hash[:put_request]
        item = request_hash[:put_request][:item].symbolize_keys
        hash_key_value = item[hash_key_attr]
        if range_key_attr.present?
          range_key_value = item[range_key_attr]
          table[hash_key_value] = {} if table[hash_key_value].nil?
          table[hash_key_value][range_key_value] = item
        else
          table[hash_key_value] = item
        end
      else
        item = request_hash[:delete_request][:key]
        id = item[hash_key_attr]
        table.delete(id)
      end
    end
  end
end
delete_item(args = {}) click to toggle source
# File lib/dynamini/test_client.rb, line 161
def delete_item(args = {})
  get_table(args[:table_name]).delete(args[:key][hash_key_attr])
end
determine_hash_and_range(args) click to toggle source
# File lib/dynamini/test_client.rb, line 185
def determine_hash_and_range(args)
  if args[:index_name]
    index = secondary_index[args[:index_name].to_s]
    [index[:hash_key_name].to_s, index[:range_key_name].to_s]
  else
    [@hash_key_attr.to_s, @range_key_attr.to_s]
  end
end
get_item(args = {}) click to toggle source
# File lib/dynamini/test_client.rb, line 58
def get_item(args = {})
  table = get_table(args[:table_name])

  hash_key_value = args[:key][hash_key_attr]
  range_key_value = args[:key][range_key_attr]

  attributes_hash = table[hash_key_value]
  attributes_hash = attributes_hash[range_key_value] if attributes_hash && range_key_value

  OpenStruct.new(item: (attributes_hash ? attributes_hash.deep_dup : nil))
end
get_last_evaluated_key(secondary_index_name, items, records) click to toggle source
# File lib/dynamini/test_client.rb, line 124
def get_last_evaluated_key(secondary_index_name, items, records)
  if records.length > 0 && items.last != records.last
    index = secondary_index[secondary_index_name]
    if index
      { get_secondary_hash_key(index).to_s => items.last[get_secondary_hash_key(index)] }
    else
      { hash_key_attr.to_s => items.last[hash_key_attr] }
    end
  end
end
get_secondary_hash_key(index) click to toggle source
# File lib/dynamini/test_client.rb, line 243
def get_secondary_hash_key(index)
  index[:hash_key_name] == @hash_key_attr ? index[:hash_key_name] : index[:hash_key_name].to_s
end
get_secondary_range_key(index) click to toggle source
# File lib/dynamini/test_client.rb, line 247
def get_secondary_range_key(index)
  index[:range_key_name] == @range_key_attr ? index[:range_key_name] : index[:range_key_name].to_s
end
get_table(table_name) click to toggle source
# File lib/dynamini/test_client.rb, line 17
def get_table(table_name)
  @data[table_name] ||= {}
end
index_of_start_key(args, records) click to toggle source
# File lib/dynamini/test_client.rb, line 103
def index_of_start_key(args, records)
  if args[:exclusive_start_key]
    sec_index = secondary_index && secondary_index[args[:secondary_index_name]]
    start_index = records.index do |r|
      if sec_index
        r[get_secondary_hash_key(sec_index)] == args[:exclusive_start_key].values[0]
      else
        r[hash_key_attr] == args[:exclusive_start_key].values[0]
      end
    end
    start_index || 0
  else
    0
  end
end
limit_scanned_records(limit, records, start_index) click to toggle source
# File lib/dynamini/test_client.rb, line 119
def limit_scanned_records(limit, records, start_index)
  end_index = limit ? start_index + limit - 1 : -1
  records[start_index..end_index]
end
primary_index_insertion(hash_key_value, range_key_value, updates, table) click to toggle source
# File lib/dynamini/test_client.rb, line 36
def primary_index_insertion(hash_key_value, range_key_value, updates, table)
  if range_key_value
    primary_with_range_insertion(hash_key_value, range_key_value, updates, table)
  else
    primary_only_hash_insertion(hash_key_value, updates, table)
  end
end
primary_only_hash_insertion(hash_key_value, updates, table) click to toggle source
# File lib/dynamini/test_client.rb, line 54
def primary_only_hash_insertion(hash_key_value, updates, table)
  table[hash_key_value] ? table[hash_key_value].merge!(updates) : table[hash_key_value] = updates
end
primary_with_range_insertion(hash_key_value, range_key_value, updates, table) click to toggle source
# File lib/dynamini/test_client.rb, line 44
def primary_with_range_insertion(hash_key_value, range_key_value, updates, table)
  updates.merge!(range_key_attr => range_key_value)
  if table[hash_key_value] && table[hash_key_value][range_key_value]
    table[hash_key_value][range_key_value].merge! updates
  else
    table[hash_key_value] ||= {}
    table[hash_key_value][range_key_value] = updates
  end
end
query(args = {}) click to toggle source
# File lib/dynamini/test_client.rb, line 165
def query(args = {})
  # Possible key condition structures:
  # "foo = val"
  # "foo = val AND bar <= val2"
  # "foo = val AND bar >= val2"
  # "foo = val AND bar BETWEEN val2 AND val3"

  attr_placeholders = args[:expression_attribute_values].merge(args[:expression_attribute_names])
  attr_placeholders.each { |symbol, value| args[:key_condition_expression].gsub!(symbol, value.to_s) }

  tokens = args[:key_condition_expression].split(/\s+/)

  hash_key_name, range_key_name = determine_hash_and_range(args)

  inspect_for_correct_keys?(tokens, hash_key_name, range_key_name)

  args[:index_name] ?  secondary_index_query(args, tokens) : range_key_query(args, tokens)

end
range_key_limits(tokens) click to toggle source
# File lib/dynamini/test_client.rb, line 194
def range_key_limits(tokens)
  case tokens[5]
    when ">=" then [tokens[6], nil]
    when "<=" then [nil, tokens[6]]
    when "BETWEEN" then [tokens[6], tokens[8]]
    else [nil, nil]
  end
end
range_key_query(args, tokens) click to toggle source
# File lib/dynamini/test_client.rb, line 212
def range_key_query(args, tokens)
  start_val, end_val = range_key_limits(tokens)
  hash_key = hash_key_value(args).is_a?(Integer) ? tokens[2].to_i : tokens[2]
  parent = get_table(args[:table_name])[hash_key]

  return OpenStruct.new(items: []) unless parent

  selected = apply_filter_options(parent, args, start_val, end_val)
  OpenStruct.new(items: selected)
end
reset() click to toggle source
# File lib/dynamini/test_client.rb, line 251
def reset
  @data = {}
end
scan(args = {}) click to toggle source
# File lib/dynamini/test_client.rb, line 87
def scan(args = {})
  records = get_table(args[:table_name]).values
  sort_scanned_records!(records, args[:secondary_index_name]) if args[:secondary_index_name]
  start_index = index_of_start_key(args, records)
  items = limit_scanned_records(args[:limit], records, start_index)
  last_evaluated_key = get_last_evaluated_key(args[:secondary_index_name], items, records)
  OpenStruct.new({items: items, last_evaluated_key: last_evaluated_key})
end
secondary_index_query(args = {}, tokens) click to toggle source
# File lib/dynamini/test_client.rb, line 223
def secondary_index_query(args = {}, tokens)
  start_val, end_val = range_key_limits(tokens)
  index = secondary_index[args[:index_name].to_s]
  table = get_table(args[:table_name])

  records = @range_key_attr ? get_values(table) : table.values
  selected = sort_records(records, index, args, start_val, end_val)
  OpenStruct.new(items: selected)
end
sort_records(records, index, args, start_val, end_val) click to toggle source
# File lib/dynamini/test_client.rb, line 233
def sort_records(records, index, args, start_val, end_val)
  records = records.select { |record| record[get_secondary_hash_key(index)] == hash_key_value(args) }
  records = records.select { |record| record[get_secondary_range_key(index)] >= start_val.to_f } if start_val
  records = records.select { |record| record[get_secondary_range_key(index)] <= end_val.to_f } if end_val
  records = records.sort { |a, b| a[get_secondary_range_key(index)] <=> b[get_secondary_range_key(index)] }
  records = records.reverse if args[:scan_index_forward] == false
  records = records[0...args[:limit]] if args[:limit]
  records
end
sort_scanned_records!(records, secondary_index_name) click to toggle source
# File lib/dynamini/test_client.rb, line 96
def sort_scanned_records!(records, secondary_index_name)
  index = secondary_index[secondary_index_name]
  records.sort! do |a, b|
    a[get_secondary_hash_key(index)] <=> b[get_secondary_hash_key(index)]
  end
end
update_item(args = {}) click to toggle source
# File lib/dynamini/test_client.rb, line 21
def update_item(args = {})
  table = get_table(args[:table_name])

  keys = args[:key]

  hash_key_value = keys[hash_key_attr]
  range_key_value = keys[range_key_attr]

  updates = flatten_attribute_updates(args).merge(
      hash_key_attr => hash_key_value
  )

  primary_index_insertion(hash_key_value, range_key_value, updates, table) if hash_key_value
end

Private Instance Methods

flatten_attribute_updates(args = {}) click to toggle source
# File lib/dynamini/test_client.rb, line 266
def flatten_attribute_updates(args = {})
  attribute_hash = {}

  hash_key_value = args[:key][hash_key_attr]
  range_key_value = args[:key][range_key_attr]

  handle_updates(args, hash_key_value, range_key_value, attribute_hash) if args[:attribute_updates]

  attribute_hash
end
get_values(table, records=[]) click to toggle source
# File lib/dynamini/test_client.rb, line 261
def get_values(table, records=[])
  table.values.each { |value| records += value.values }
  records
end
handle_updates(args, hash_key_value, range_key_value, attribute_hash) click to toggle source
# File lib/dynamini/test_client.rb, line 277
def handle_updates(args, hash_key_value, range_key_value, attribute_hash)
  table = get_table(args[:table_name])
  args[:attribute_updates].each do |k, v|
    if v[:action] == 'ADD' && table[hash_key_value] # if record has been saved, otherwise use a simple setter for add
      data = table[hash_key_value]
      data = (data[range_key_value] ||= {}) if range_key_value
      attribute_hash[k] = data[k] ? data[k] + v[:value] : v[:value]
    elsif v[:action] == 'DELETE'
      data = table[hash_key_value]
      data = (data[range_key_value] ||= {}) if range_key_value
      data.delete(k)
    else
      attribute_hash[k] = v[:value]
    end
  end
end
hash_key_value(args) click to toggle source
# File lib/dynamini/test_client.rb, line 257
def hash_key_value(args)
  args[:expression_attribute_values][":h"]
end
inspect_for_correct_keys?(tokens, hash_key_name, range_key_name) click to toggle source
# File lib/dynamini/test_client.rb, line 295
def inspect_for_correct_keys?(tokens, hash_key_name, range_key_name)
  missed_keys = []
  missed_keys << hash_key_name unless tokens[0] == hash_key_name
  missed_keys << range_key_name unless (tokens.length < 4 || tokens[4] == range_key_name)
  raise missed_key_dynamodb_error(missed_keys) if missed_keys.length > 0
end
missed_key_dynamodb_error(missed_keys) click to toggle source
# File lib/dynamini/test_client.rb, line 302
def missed_key_dynamodb_error(missed_keys)
  Aws::DynamoDB::Errors::ValidationException.new(400,"Query condition missed key schema element: #{missed_keys.join(', ')}")
end