plezi 0.12.14 → 0.12.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6b0b52b7ab1f233bf4d1e35c75df9579a0f1456
-  data.tar.gz: 1f927d686228dd20ebec6397b3977dbb68bdcf3f
+  metadata.gz: 1e2ced994d1b21af157a084e747c60c2fd113a5c
+  data.tar.gz: 6828e742abc6eb612cf70bfbe0c6f2f6da1cac1c
 SHA512:
-  metadata.gz: 54a35d6840cbfd4477e52b68552c958458f886b85204360c2e7951d76b62836737622e83c8ad915469cc0f892fa459bb99a31b5650d3d21bfd7528f997b4c273
-  data.tar.gz: c9e5d79dade6f7fd1416cd5d34fb189fd31dd6fd9b0fdf6f6ef2df823de5b5203c84b51bd95f733e23436667d5c3bc16b623068792e708849b32a1a090c1aa15
+  metadata.gz: d7f1d3f579ae87afdf56028e80e093c00ae1f9bd01f155e424c71cb2d846cf418f109c82ee559d21454836345ebe219d614a6af0f11d94e81665fee40856e203
+  data.tar.gz: 23a7279397df8ea1326bfe2da342b5c9c3ab5f85bb3970aae34bbc6c265e01b34392e292a2638e5b48596d720af2a1eb58ae588c624d63324b357c56c01b676f

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ***
 
+Change log v.0.12.15
+
+**Fix**: fixed the Redis connection, which was failing after DB selection support was added.
+
+**Fix**: Iodine update fixes an issue where unicasting might fail when connection is still very new.
+
+**Fixe**: fixed an issue with the Identity API where Redis emulation would loose the historic messages due to unicasting failure for the unregistered (super new) connection.
+
+***
+
 Change log v.0.12.14
 
 **Update**: `Controller#redirect_to` will now attempt to guess the URL using `url_for`, unless the URL given is a String. It also leverages the new `redirect_to` Iodine::Response method, allowing you to set the FUTURE response's status_code.

data/lib/plezi/common/redis.rb

@@ -11,11 +11,11 @@ module Plezi
 				@redis_locker.synchronize do
 					return @redis if (@redis_sub_thread && @redis_sub_thread.alive?) && @redis # repeat the test once syncing is done.
 					@redis.quit if @redis
-					@redis = ::Redis.new(ENV['PL_REDIS_URL'])
+					@redis = ::Redis.new(url: ENV['PL_REDIS_URL'])
 					raise "Redis connction failed for: #{ENV['PL_REDIS_URL']}" unless @redis
 					@redis_sub_thread = Thread.new do
 						begin
-							::Redis.new(ENV['PL_REDIS_URL']).subscribe(Plezi::Settings.redis_channel_name, Plezi::Settings.uuid) do |on|
+							::Redis.new(url: ENV['PL_REDIS_URL']).subscribe(Plezi::Settings.redis_channel_name, Plezi::Settings.uuid) do |on|
 								on.message do |channel, msg|
 									::Plezi::Base::WSObject.forward_message ::Plezi::Base::WSObject.translate_message(msg)
 								end

data/lib/plezi/handlers/ws_identity.rb

@@ -39,6 +39,18 @@ module Plezi
 						@cache[key].count
 					end
 				end
+				def lpop key
+					sync do
+						@cache[key] ||= []
+						@cache[key].shift
+					end
+				end
+				def lrem key, count, value
+					sync do
+						@cache[key] ||= []
+						@cache[key].delete(value)
+					end
+				end
 				def rpush key, value
 					sync do
 						@cache[key] ||= []
@@ -95,8 +107,7 @@ module Plezi
 				# @!visibility public
 				# The following method registers the connections as a unique global identity.
 				#
-				# Like {Plezi::Base::WSObject::SuperClassMethods#notify}, using this method requires an active Redis connection
-				# to be set up. See {Plezi#redis} for more information.
+				# The Identity API works best when a Redis server is used. See {Plezi#redis} for more information.
 				#
 				# By default, only one connection at a time can respond to identity events. If the same identity
 				# connects more than once, only the last connection will receive the notifications.
@@ -110,9 +121,19 @@ module Plezi
 				# lifetime:: sets how long the identity can survive. defaults to `604_800` seconds (7 days).
 				# max_connections:: sets the amount of concurrent connections an identity can have (akin to open browser tabs receiving notifications). defaults to 1 (a single connection).
 				#
+				# Lifetimes are renewed with each registration and when a connected Identoty receives a notification.
+				# Identities should have a reasonable lifetime. For example, a 10 minutes long lifetime (60*10)
+				# may prove ineffective. When using such short lifetimes, consider the possibility that `unicast` might provide be a better alternative.
+				#
+				# A lifetime cannot (by design) be shorter than 10 minutes.
+				#
 				# Calling this method will also initiate any events waiting in the identity's queue.
 				# make sure that the method is only called once all other initialization is complete.
 				#
+				# i.e.
+				#
+				#       register_as session.id, lifetime: 60*60*24, max_connections: 4
+				#
 				# Do NOT call this method asynchronously unless Plezi is set to run as in a single threaded mode - doing so
 				# will execute any pending events outside the scope of the IO's mutex lock, thus introducing race conditions.
 				def register_as identity, options = {}
@@ -120,19 +141,21 @@ module Plezi
 					options[:max_connections] ||= 1
 					options[:max_connections] = 1 if options[:max_connections].to_i < 1
 					options[:lifetime] ||= 604_800
+					options[:lifetime] = 600 if options[:lifetime].to_i < 600
 					identity = identity.to_s.freeze
-					@___identity ||= [].to_set
-					@___identity << identity
-					redis.pipelined do
+					@___identity ||= {}
+					@___identity[identity] = options
+					redis.multi do
+						redis.lpop(identity)
+						redis.lpush(identity, ''.freeze)
+						redis.lrem "#{identity}_uuid".freeze, 0, uuid
 						redis.lpush "#{identity}_uuid".freeze, uuid
 						redis.ltrim "#{identity}_uuid".freeze, 0, (options[:max_connections]-1)
-					end
-					redis.lpush(identity, ''.freeze) unless redis.llen(identity) > 0
-					___review_identity identity
-					redis.pipelined do
 						redis.expire identity, options[:lifetime]
 						redis.expire "#{identity}_uuid".freeze, options[:lifetime]
 					end
+					___review_identity identity
+					identity
 				end
 
 				# @!visibility public
@@ -153,21 +176,44 @@ module Plezi
 				def ___review_identity identity
 					redis = Plezi.redis || ::Plezi::Base::WSObject::RedisEmultaion
 					identity = identity.to_s.freeze
-					return Iodine.warn("Identity message reached wrong target (ignored).").clear unless @___identity.include?(identity)
+					return Iodine.warn("Identity message reached wrong target (ignored).").clear unless @___identity[identity]
 					messages = redis.multi do
 						redis.lrange identity, 1, -1
 						redis.ltrim identity, 0, 0
+						redis.expire identity,  @___identity[identity][:lifetime]
+						redis.expire "#{identity}_uuid".freeze,  @___identity[identity][:lifetime]
 					end[0]
 					targets = redis.lrange "#{identity}_uuid", 0, -1
+					targets.delete(uuid)
 					while msg = messages.shift
 						msg = ::Plezi::Base::WSObject.translate_message(msg)
 						next unless msg
 						Iodine.error("Notification recieved but no method can handle it - dump:\r\n #{msg.to_s}") && next unless self.class.has_super_method?(msg[:method])
-						# targets.each {|target| target == uuid ? self.method(msg[:method]).call(*msg[:data]) : unicast(target, msg[:method], *msg[:data])}
-						targets.each {|target| unicast(target, msg[:method], *msg[:data])} # this allows for async execution
-						
+						Iodine.run do
+							targets.each {|target| unicast(target, msg[:method], *msg[:data]) }
+						end
+						self.method(msg[:method]).call(*msg[:data])
 					end
+					# ___extend_lifetime identity
 				end
+
+				# # re-registers the Identity, extending it's lifetime
+				# # and making sure it's still valid.
+				# def ___extend_lifetime identity
+				# 	return unless @___identity
+				# 	redis = Plezi.redis || ::Plezi::Base::WSObject::RedisEmultaion
+				# 	options = @___identity[identity]
+				# 	return unless options
+				# 	redis.multi do
+				# 		# redis.lpop(identity)
+				# 		# redis.lpush(identity, ''.freeze)
+				# 		# redis.lrem "#{identity}_uuid".freeze, 0, uuid
+				# 		# redis.lpush "#{identity}_uuid".freeze, uuid
+				# 		# redis.ltrim "#{identity}_uuid".freeze, 0, (options[:max_connections]-1)
+				# 		redis.expire identity, options[:lifetime]
+				# 		redis.expire "#{identity}_uuid".freeze, options[:lifetime]
+				# 	end
+				# end
 			end
 
 			module SuperClassMethods
@@ -180,6 +226,7 @@ module Plezi
 					return false unless redis.llen(identity).to_i > 0
 					redis.rpush identity, ({method: event_name, data: args}).to_yaml
 					redis.lrange("#{identity}_uuid".freeze, 0, -1).each {|target| unicast target, :___review_identity, identity }
+					# puts "pushed notification #{event_name}"
 					true
 				end
 

data/lib/plezi/handlers/ws_object.rb

@@ -97,16 +97,19 @@ module Plezi
 
 				protected
 
+				# @!visibility public
 				# allows writing of data to the websocket (if opened). Otherwise appends the message to the Http response.
 				def write data
 					(@ws_io || @response) << data
 				end
 
+				# @!visibility public
 				# Performs a websocket unicast to the specified target.
 				def unicast target_uuid, method_name, *args
 					self.class.unicast target_uuid, method_name, *args
 				end
 
+				# @!visibility public
 				# Use this to brodcast an event to all 'sibling' objects (websockets that have been created using the same Controller class).
 				#
 				# Accepts:
@@ -119,6 +122,8 @@ module Plezi
 					return false unless self.class.has_method? method_name
 					self.class._inner_broadcast({ method: method_name, data: args, type: self.class}, __get_io )
 				end
+
+				# @!visibility public
 				# Use this to multicast an event to ALL websocket connections on EVERY controller, including Placebo controllers.
 				#
 				# Accepts:
@@ -238,7 +243,7 @@ module Plezi
 				# sends the broadcast
 				def _inner_broadcast data, ignore_io = nil
 					if data[:target]
-						if data[:target] && (data[:to_server] == Plezi::Settings.uuid )
+						if data[:to_server] == Plezi::Settings.uuid
 							return ( ::Iodine::Http::Websockets.unicast( data[:target], data ) || ___faild_unicast( data ) )
 						end
 						return ( data[:to_server].nil? && ::Iodine::Http::Websockets.unicast(data[:target], data) ) || ( Plezi::Base::AutoRedis.away?(data[:to_server]) && ___faild_unicast( data ) ) || __inner_redis_broadcast(data)

data/lib/plezi/helpers/http_sender.rb

@@ -1,9 +1,14 @@
 module Plezi
 	module Base
 
+
 		# Sends common basic HTTP responses.
 		module HTTPSender
-			class ErrorCtrl
+			# makes sure to methods are injected to class Class
+			class Container
+			end
+			# the Error Controller, for rendering error templates.
+			class ErrorCtrl < Container
 				include ::Plezi::Base::ControllerCore
 				include ::Plezi::ControllerMagic
 

data/lib/plezi/helpers/mime_types.rb

@@ -1,7 +1,7 @@
 module Plezi
 	# This module holds the mime dictionary. 
 	module MimeTypeHelper
-		# thank you Apache group (and many more), for compiling mime-type list for me to search through.
+		# thank you Apache group (and many more), for compiling mime-type lists for me to search through.
 		MIME_DICTIONARY = { ".123"=>"application/vnd.lotus-1-2-3".freeze,
 			".3dml"=>"text/vnd.in3d.3dml".freeze,
 			".3ds"=>"image/x-3ds".freeze,

data/lib/plezi/version.rb

@@ -1,3 +1,3 @@
 module Plezi
-    VERSION = "0.12.14"
+    VERSION = "0.12.15"
 end

data/plezi.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "iodine", "~> 0.1.14"
+  spec.add_dependency "iodine", "~> 0.1.15"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
 

data/resources/redis_config.rb

@@ -29,7 +29,7 @@ if defined? Redis
 	# ## the following is only sample code for you to change:
 	# RADIS_CHANNEL = 'appsecret'
 	# RADIS_URI = ENV['REDIS_URL'] || ENV['REDISCLOUD_URL'] || "redis://:password@my.host:6389/0"
-	# RADIS_CONNECTION = Redis.new(RADIS_URI)
+	# RADIS_CONNECTION = Redis.new(url: RADIS_URI)
 	# RADIS_THREAD = Thread.new do
 	# 	Redis.new(RADIS_URI).subscribe(RADIS_CHANNEL) do |on|
 	# 		on.message do |channel, msg|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plezi
 version: !ruby/object:Gem::Version
-  version: 0.12.14
+  version: 0.12.15
 platform: ruby
 authors:
 - Boaz Segev
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.14
+        version: 0.1.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.14
+        version: 0.1.15
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement