highwatermark 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6837c0694bb9f29f4708ae5998a8368dbec1e6cb
-  data.tar.gz: ead1e5d238bc2d39297b132c1d1518d457d424a4
+  metadata.gz: 56e98393bae407005b7dfa6c128e590113541452
+  data.tar.gz: 6c3434a7e33d6abfde36230a5d04009c3e7398ef
 SHA512:
-  metadata.gz: 842a1d1b2247328656a0bbcc55c3de0f3a1ae83abe3ba54ee677dfeefd04dd851ad261a886189f316c54b896aa91820feafcc3ad4d62c80ecf7ede7dcbcbb802
-  data.tar.gz: d8eecbc421d6067f634ec8eea7fc9c4fab74a62c977945218667042d795cf6605a390e38a8f46e3b52e5b92e87b3a080b1063d1b1f12700abde2f83e52afaabd
+  metadata.gz: b40829ba57481eccdc93d0baa3e4781c95809d395befa4b2dbf639019300faa6a1be7e8b93caabb9a9bb1618a9aeddab93fa42780edcf09639b47580ddcbf2c9
+  data.tar.gz: 3ecdab6db0d313c3f3bb7aa4738b41c8b8b907501d4bfa78ec87aeb297d9658dfaf47f02ed70159eba35c786f2a2985e2ddc2335caf4e1fb62769d198e77ec90

data/README.md

@@ -27,30 +27,35 @@ In your ruby code:
 # To initilize high watermark
 require 'highwatermark'
 
-path = "/path/to/state/file/or/redis/conf"   # the file path for store state or the redis configure
-state_type = "file" # state_type: could be <redis/file/memory>
-tag = "your tag" # tag: is the tag that will be used in state file or redis
+highwatermark_parameters={
+	"state_tag" => "your tag",  # required, is the tag that will be used in state file or redis     
+	"state_type" => "file",  # required: could be <redis/file/memory>
+	"state_file" => "/path/to/state/file/or/redis/conf", # optional, the file path for store state, need state_type set to 'file'
+	"redis_host" => '127.0.0.1', #optional, to set remote redis, need state_type set to 'redis'
+	"redis_port" => '6379'  #optional, to set remote redis, need state_type set to 'redis'   
+}
 
-hwm = Highwatermark::HighWaterMark.new(path, state_type)
+hwm = Highwatermark::HighWaterMark.new(highwatermark_parameters)
 
 # To store time in high watermark
 time = "what your want to store in high watermark"
-hwm.update_records(time, tag)
+hwm.update_records(time) #use tag in the configure 'state_tag'
+
+tag = "some other specified tag"
+hwm.update_records(time, tag) # use some other specified tag
+
 
 # To get the high watermark
-hwm.last_records(tag)
+hwm.last_records() #get high watermark with tag in the configure 'state_tag'
 
-```
+tag = "some other specified tag"
+hwm.last_records(tag) #get high watermark with some other specified tag
 
-Example of redis.conf (if set state_type = 'redis'):
 
-```
-# redis configure
-host: 127.0.0.1
-port: 6379
 
 ```
 
+
 Output in the state file:
 
 ```

data/lib/highwatermark.rb

@@ -2,54 +2,84 @@ require "highwatermark/version"
 
 module Highwatermark
     class HighWaterMark
-    	# def initialize(path,state_type,tag)
-      def initialize(path,state_type)
-    		# path: is th file path for store state or the redis configure
-    		# state_type: could be <redis/file/memory>
-    		# tag: is the tag that will be used in state file or redis 
-
-
-    		require 'yaml'
-        require 'pp'
-    		@path = path
-    		@state_type = state_type
-			  # @tag = tag
-
-    		@data = {}
-    		if @state_type =='file'
-    			if File.exists?(path)
-  					@data = YAML.load_file(path)
-            pp @data
-  					if @data == false || @data == []
-  						# this happens if an users created an empty file accidentally
-  						@data = {}
-  					elsif !@data.is_a?(Hash)
-  						raise "state_file on #{@path.inspect} is invalid"
-  					end
-  				else
-  					@data = {}
-  				end
-  			elsif @state_type =='memory'
-  				@data = {}
-  			elsif @state_type =='redis'
-  				require 'redis'
-  				$redis = if File.exists?(path)
-  					redis_config = YAML.load_file(path)
-  					# Connect to Redis using the redis_config host and port
-  					if path
-  					    begin
-                  pp "In redis #{path} Host #{redis_config['host']} port #{redis_config['port']}"
-  				  			$redis = Redis.new(host: redis_config['host'], port: redis_config['port'])
-    						rescue Exception => e
-    							pp e.message
-  		            pp e.backtrace.inspect
-  					    end
-  					end
-  				else
-  			  		Redis.new
-  				end
-      		@data = {}
-      	end # end of checking @state_type
+
+      def initialize(parameters)
+
+        require 'yaml'
+       
+        @state_type = parameters["state_type"] # require
+        @state_tag = parameters["state_tag"] # require
+        @path = parameters["state_file"] # optional,  need state_type set to 'file'
+        @redis_host = parameters["redis_host"]  # optional, need state_type set to 'redis'
+        @redis_port = parameters["redis_port"]  # optional, need state_type set to 'redis'
+
+        # check the parameter configurartion
+        if @state_type == nil 
+          raise "The parameter 'state_type' is required, please provide state_type (file, redis or memory)"
+        end
+
+        if @state_tag == nil
+          raise "The paramerter 'state_tag' is required, please provide state_tag for labelling high watermark info"
+        end
+
+        if @path != nil && @state_type != 'file'
+          raise "To use 'state_file' parameter, 'state_type' need to be set to 'file'"
+        end
+
+        if ((@redis_host != nil || @redis_port != nil ) && @state_type != 'redis')
+          raise "To use 'redis_host' or 'redis_port' parameters, 'state_type' need to be set to 'redis'"
+        end
+
+
+
+        @data = {}
+        if @state_type == 'file'
+
+            if File.directory? (@path)
+              # create a new state file in the provided directory
+              # when recover from failure will also try to read from this file
+              @path = @path+"/"+@state_tag+".yaml"
+              puts "provided path is a valid derectory, created a new file on #{@path.inspect}"
+              @data = {}
+            else # not a directory, then check if it's a valid file
+              if File.exist?(@path)
+                @data = YAML.load_file(@path)
+                if @data == false || @data == []
+                  # this happens if an users created an empty file accidentally, or the file is just initialized
+                  puts "state file on #{@path.inspect} is empty "
+                  @data = {}
+                elsif !@data.is_a?(Hash)
+                  # if the file contains invalid data, that is not a hash
+                  raise "state file on #{@path.inspect} contains invalid data, please use other file"
+                end
+              else
+                raise "#{@path.inspect} is not a valid directory or file, please provide valid state file path"
+              end
+              
+            end
+
+
+
+        elsif @state_type =='memory'
+          @data = {}
+
+
+        elsif @state_type =='redis'
+          require 'redis'
+          if (@redis_host == nil || @redis_port == nil)
+            puts "No Redis host and port specified, use default local setting"
+            @redis = Redis.new
+          else # if has the redis host and port configure
+            begin
+              puts "Redis Host #{@redis_host} port #{@redis_port}"
+              @redis = Redis.new(host: @redis_host, port: @redis_port)
+            rescue Exception => e
+              puts e.message
+              puts e.backtrace.inspect
+            end
+          end
+          @data = {}
+        end # end of checking @state_type
 
         if @data['last_records']==nil
           @data['last_records'] = {}
@@ -57,52 +87,48 @@ module Highwatermark
         
       end # end of intitialize
 
-	    def last_records(tag)
+      def last_records(tag=@state_tag)
         if @state_type == 'file'
-          # return @data[@tag]
-          # pp @data['last_records'][tag]
           return @data['last_records'][tag]
 
         elsif @state_type =='memory'
           return @data['last_records'][tag]
         elsif @state_type =='redis'
           begin
-            alertStart=$redis.get(tag)
+            alertStart=@redis.get(tag)
             return alertStart
           rescue Exception => e
-            pp e.message
-            pp e.backtrace.inspect
+            puts e.message
+            puts e.backtrace.inspect
           end
-      	end
+        end
       end
 
-  		def update_records(time, tag)
+      def update_records(time, tag=@state_tag)
         if @state_type == 'file'
-          # @data[@tag] = time
-    			@data['last_records'][tag] = time
-    			# $log.info  @data
-    			File.open(@path, 'w') {|f|
-    			  f.write YAML.dump(@data)
-    			}
+          @data['last_records'][tag] = time
+          File.open(@path, 'w') {|f|
+            f.write YAML.dump(@data)
+          }
         elsif @state_type =='memory'
           @data['last_records'][tag] = time
           
         elsif @state_type =='redis'
           begin
-            alertStart=$redis.set(tag,time)
+            alertStart=@redis.set(tag,time)
           rescue Exception => e
-            pp e.message
-            pp e.backtrace.inspect
+            puts e.message
+            puts e.backtrace.inspect
           end
         end
 
-  		end
+      end
 
-  	end # end of class Highwatermark
+    end # end of class Highwatermark
 
 
 
-    		
+        
 
     
 

data/lib/highwatermark/version.rb

@@ -1,3 +1,3 @@
 module Highwatermark
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highwatermark
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Ling Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-21 00:00:00.000000000 Z
+date: 2015-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler