Added 'id' param to all Ariadne 'get' methods

- 'id' param will help improving the overall performance of application
as the user will be able to fetch the required data directly by passing the
'id' i.e. previously used to store the data.
- new TCs written for modified methods

Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     ariadne (0.0.1)
       fakeredis
+      hiredis
       redis
 
 GEM
@@ -15,6 +16,7 @@ GEM
     docile (1.1.5)
     fakeredis (0.5.0)
       redis (~> 3.0)
+    hiredis (0.6.1)
     json (1.8.3)
     method_source (0.8.2)
     minitest (5.8.4)
@@ -44,6 +46,7 @@ DEPENDENCIES
   minitest (~> 5.0)
   pry-byebug
   rake
+  simplecov
 
 BUNDLED WITH
    1.11.2

ariadne.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_runtime_dependency     'redis'
+  spec.add_runtime_dependency     'hiredis'
   spec.add_runtime_dependency     'fakeredis'
 end

lib/ariadne/ariadne_util.rb

@@ -2,28 +2,35 @@
 require 'json'
 require 'time'
 require 'redis'
+require 'redis/connection/hiredis'
 
 module Ariadne
-  DataUtil.init_redis_cli(Redis.new(url: ENV['REDIS_URL']))
+  def self.get_app_name(app_name: nil)
+    app_name ||= ( ENV['APP_NAME'] || '' )
+  rescue StandardError => e
+    puts "Can't connect to the Redis databse! Object Undefined!"
+  end
+
+  DataUtil.init_redis_cli(redis_obj: Redis.new(url: ENV['REDIS_URL']))
 
-  def self.insert_data(options = {})
-    raise 'Please specify options to be passed for Ariadne.insert_data method!' if options.size <= 0
-    raise 'Please specify id and application name to be passed for Ariadne.insert_data method!' if options[:id].nil? || options[:id].size <= 0
-    DataUtil.insert_data_in_redis(options.merge!(app_name: get_app_name(options[:app_name])))
+  def self.insert_data(options: {}, app_name: nil)
+    raise 'Please specify data to be inserted for Ariadne.insert_data method!' if options.empty?
+    raise 'Please specify id to be passed for Ariadne.insert_data method!' if options['id'].nil? || options['id'].size == 0
+    DataUtil.insert_data_in_redis(options: options, app_name: get_app_name(app_name: app_name))
   rescue StandardError => e
     puts e
     e
   end
 
-  def self.get_data(app_name = '')
-    DataUtil.get_data_from_redis(get_app_name(app_name))
+  def self.get_data(id: nil, app_name: nil)
+    DataUtil.get_data_from_redis(id: id, app_name: get_app_name(app_name: app_name))
   rescue StandardError => e
     puts e
     e
   end
 
-  def self.get_data_with_time_difference(app_name = '')
-    redis_data = get_data(get_app_name(app_name))
+  def self.get_data_with_time_difference(id: nil, app_name: nil)
+    redis_data = get_data(id: id, app_name: app_name)
     default_time_diff_threshold = 30
     output_data = []
     unless redis_data.nil?
@@ -40,9 +47,4 @@ def self.get_data_with_time_difference(app_name = '')
     end
     output_data.to_json
   end
-
-  def self.get_app_name(app_name = '')
-    app_name = ENV['APP_NAME'] if app_name.nil? || app_name.size <= 0
-    app_name || ''
-  end
 end

lib/ariadne/data_util.rb

@@ -1,11 +1,15 @@
 
 module DataUtil
-  def self.init_redis_cli(obj = nil)
-    @redis_cli = obj
+  def self.init_redis_cli(redis_obj: nil)
+    raise "Redis object not found!" if redis_obj.nil?
+    @redis_cli = redis_obj
+  rescue StandardError => e
+    puts e
   end
 
-  def self.get_data_from_redis(app_name)
-    keys = @redis_cli.keys "#{app_name}*"
+  def self.get_data_from_redis(id:, app_name:)
+    key  = id.nil? ? "#{app_name}*" : "#{app_name}:#{id}"
+    keys = @redis_cli.keys key
     raise "Data not available for #{app_name}!" if keys.empty?
     keys.compact!
     redis_data = (@redis_cli.mget keys)
@@ -14,13 +18,13 @@ def self.get_data_from_redis(app_name)
     puts e
   end
 
-  def self.insert_data_in_redis(options = {})
-    key = "#{options[:app_name]}:#{options[:id]}"
+  def self.insert_data_in_redis(options:, app_name:)
+    key = "#{app_name}:#{options['id']}"
     options[:time] = Time.now
     redis_data = nil
     @redis_cli.pipelined do
       redis_data = @redis_cli.set key, options.to_json
-      @redis_cli.expireat(key, Time.now + (24 * 60 * 60)) # expire a key after 1 day
+      @redis_cli.expire(key, (24 * 60 * 60)) # expire a key after 1 day
     end
     redis_data
   end

lib/ariadne/testing.rb

@@ -1,4 +1,4 @@
 require_relative 'data_util'
 require 'fakeredis'
 
-DataUtil.init_redis_cli(Redis.new)
+DataUtil.init_redis_cli(redis_obj: Redis.new)

test/test_ariadne.rb

@@ -1,57 +1,90 @@
 require_relative 'test_helper'
-
 class AriadneTest < MiniTest::Test
   def test_insert_data
     app_name = 'test'
     data = {
-      id:        123,
-      state:    'active',
-      app_name: app_name
+      'id'    => 123,
+      'state' => 'active'
     }
 
-    out = Ariadne.insert_data(data)
+    out = Ariadne.insert_data(options: data, app_name: app_name)
     assert_equal Redis::Future, out.class
   end
 
   def test_get_data
     app_name = 'test'
     data = {
-      id:        123,
-      state:    'active',
-      app_name: app_name
+      'id'    => 123,
+      'state' => 'active'
     }
-
-    Ariadne.insert_data(data)
-    out = Ariadne.get_data(data[:app_name])
-    assert_equal JSON.parse(out[0])['id'], data[:id]
+    Ariadne.insert_data(options: data, app_name: app_name)
+    out = Ariadne.get_data(app_name: app_name)
+    assert_equal JSON.parse(out[0])['id'], data['id']
   end
 
   def test_get_data_with_time_diff_without_delay_should_be_empty
     app_name = 'test'
     data = {
-      id:        123,
-      state:    'active',
-      app_name: app_name
+      'id'    => 123,
+      'state' => 'active'
     }
 
-    Ariadne.insert_data(data)
-    out = Ariadne.get_data_with_time_difference(app_name)
+    Ariadne.insert_data(options: data, app_name: app_name)
+    out = Ariadne.get_data_with_time_difference(app_name: app_name)
     assert_empty JSON.parse(out)
   end
 
   def test_get_data_with_time_diff_with_delay_should_not_be_empty
-    app_name       = 'test'
+    app_name = 'test'
+    delay_interval = 2
+    data = {
+      'id'             => 123,
+      'state'          => 'active',
+      'delay_interval' => delay_interval
+    }
+
+    Ariadne.insert_data(options: data, app_name: app_name)
+    sleep delay_interval
+    out = Ariadne.get_data_with_time_difference(app_name: app_name)
+    assert_equal JSON.parse(out)[0]['id'], data['id']
+  end
+
+  def test_get_data_with_id
+    app_name = 'test'
+    data = {
+      'id'    => 123,
+      'state' => 'active'
+    }
+
+    Ariadne.insert_data(options: data, app_name: app_name)
+    out = Ariadne.get_data(id: data['id'], app_name: app_name)
+    assert_equal JSON.parse(out[0])['id'], data['id']
+  end
+
+  def test_get_data_with_time_diff_with_id_without_delay_should_be_empty
+    app_name = 'test'
+    data = {
+      'id'    => 123,
+      'state' => 'active'
+    }
+
+    Ariadne.insert_data(options: data, app_name: app_name)
+    out = Ariadne.get_data_with_time_difference(id: data['id'], app_name: app_name)
+    assert_empty JSON.parse(out)
+  end
+
+  def test_get_data_with_time_diff_with_id_with_delay_should_not_be_empty
+    app_name = 'test'
     delay_interval = 2
     data = {
-      id:             123,
-      state:          'active',
-      app_name:       app_name,
-      delay_interval: delay_interval
+      'id'             => 123,
+      'state'          => 'active',
+      'delay_interval' => delay_interval
     }
 
-    Ariadne.insert_data(data)
+    Ariadne.insert_data(options: data, app_name: app_name)
     sleep delay_interval
-    out = Ariadne.get_data_with_time_difference(app_name)
-    assert_equal JSON.parse(out)[0]['id'], data[:id]
+    out = Ariadne.get_data_with_time_difference(id: data['id'], app_name: app_name)
+    assert_equal JSON.parse(out)[0]['id'], data['id']
   end
-end
+end