iodine 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a9f87061376cb31f4e3d6b1cc7fd9dcca401151
-  data.tar.gz: 2cde195704434f6ff3af7b4a98a35c3b06f637af
+  metadata.gz: 636347aa715abdbf11841686f90c2880483e914f
+  data.tar.gz: 73264587c620ce8493c2eb5f9e3c5c229f51a21c
 SHA512:
-  metadata.gz: 0bb1203ab2d5d5ab58ec4b6dd97146b0328802db7b426031319a5e8be6936826811e43a86ae6326bbe86f0811a3013656d15a56fdfb0f29a1d0046d6bf9b485a
-  data.tar.gz: 773e868701784aca9b5a5899f0d027cafab8e586f50acf43a40f2efb51252350d689f0af6bc90caeff6f79a6a1e4a0d0bc5a683ca4b0003dde1be3182326d866
+  metadata.gz: e60f7d4a0f98caaaa8afcf1b4755af8c8e3b4a1878dc62c84071a5f5b3b0a68b5b5c8fa5432750a7c3db35b61d33f7782b0dd43e0bff7c151be8a4cbbc745d5f
+  data.tar.gz: 4d2a3b8d9f9a77b5352917bbbe4da91577e86e1bb58c580a84b74c9aaa0c1703d6dc4e6506b14026c5a975ab6794bd936ee548061d89c9f48e13949531de15fa

data/CHANGELOG.md

@@ -4,10 +4,30 @@
 
 Please notice that this change log contains changes for upcoming releases as well. Please refer to the current gem version to review the current release.
 
+**Deprecation Notice**:
+
+It is unlikely that Iodine 0.2.0 will support a blocking websocket client API.
+
 ## Changes:
 
 ***
 
+Change log v.0.1.6
+
+**Fix**: fixed an issue where a session key-value pair might not get deleted when using `session.delete key` and the `key` is not a String object. Also, now setting a key's value to `nil` should delete the key-value pair.
+
+**Fix**: fixed an issue where WebsocketClient wouldn't mask outgoing data, causing some servers to respond badly.
+
+**Performance**: minor performance improvements to the websocket parser, for unmasking messages.
+
+**Deprecation notice**:
+
+Iodine will soon add a core client protocol API and the WebsocketClient will be adjusted to take advantage of that API.
+
+This will mean that WebsocketClient will no longer block when connecting directly using the `Iodine::Http::WebsocketClient.connect` method... make sure to use `Iodine::Http.ws_connect` and to define an `:on_open` callback.
+
+***
+
 Change log v.0.1.5
 
 **Feature**: The Response#body can now be set to a File object, allowing Iodine to preserve memory when serving large static files from disc. Limited Range requests are also supported - together, these changes allow Iodine to serve media files (such as movies) while suffering a smaller memory penalty and supporting a wider variaty of players (Safari requires Range request support for it's media player).

data/lib/iodine/client.rb

@@ -1,4 +1,4 @@
-require 'iodine/http'
+Iodine.protocol = :client if require('iodine/http') && Iodine.protocol == Iodine::Http::Http1
 
 module Iodine
 	# # Connect to a remote server or network socket
@@ -8,5 +8,3 @@ module Iodine
 	# end
 end
 
-Iodine.protocol = :client
-

data/lib/iodine/http.rb

@@ -180,4 +180,4 @@ module Iodine
 		q << arr.shift until arr.empty?
 	end
 end
-Iodine.protocol = ::Iodine::Http::Http1
+Iodine.protocol = ::Iodine::Http::Http1 unless Iodine.protocol

data/lib/iodine/http/session.rb

@@ -32,6 +32,7 @@ module Iodine
 					# Due to different considirations, all keys will be converted to strings, so that `"name" == :name` and `1234 == "1234"`.
 					# If you store two keys that evaluate as the same string, they WILL override each other.
 					def []= key, value
+						return delete key if value.nil?
 						key = key.to_s
 						load
 						@data[key] = value
@@ -46,10 +47,16 @@ module Iodine
 						@data.dup
 					end
 
+					# @return [String] returns the Session data in YAML format.
+					def to_s
+						load
+						@data.to_yaml
+					end
+
 					# Removes a key from the session's data store.
 					def delete key
 						load
-						ret = @data.delete key
+						ret = @data.delete key.to_s
 						save
 						ret
 					end
@@ -57,16 +64,19 @@ module Iodine
 					# Clears the session's data.
 					def clear
 						@data.clear
-						save
 						nil
 					end
 					protected
+					# def destroy
+					# 	# save data to tmp-file
+					# 	File.delete @filename if ::File.file?(@filename) # && !::File.directory?(@filename)
+					# end
 					def save
 						# save data to tmp-file
 						IO.write @filename, @data.to_yaml
 					end
 					def load
-						@data = YAML.load IO.read(@filename) if File.exists?(@filename)
+						@data = YAML.load IO.read(@filename) if ::File.file?(@filename)
 					end
 				end
 				def self.fetch key

data/lib/iodine/http/websocket_client.rb

@@ -91,15 +91,6 @@ module Iodine
 				@renew = 0
 			end
 
-			# Sends data through the socket. a shortcut for ws_client.response <<
-			#
-			# @return [true, false] Returns the true if the data was actually sent or nil if no data was sent.
-			def << data
-				raise 'Cannot send data when the connection is closed.' if closed?
-				@io << data
-			end
-			alias :write :<<
-
 			# closes the connection, if open
 			def close
 				@io.close if @io
@@ -124,6 +115,44 @@ module Iodine
 				@request.cookies
 			end
 
+			# Sends data through the websocket, after client side masking.
+			#
+			# @return [true, false] Returns the true if the data was actually sent or nil if no data was sent.
+			def write data, op_code = nil, fin = true, ext = 0
+				return false if !data || data.empty?
+				return false if @io.closed?
+				data = data.dup # needed?
+				unless op_code # apply extenetions to the message as a whole
+					op_code = (data.encoding == ::Encoding::UTF_8 ? 1 : 2) 
+					# @ws_extentions.each { |ex| ext |= ex.edit_message data } if @ws_extentions
+				end
+				byte_size = data.bytesize
+				if byte_size > (::Iodine::Http::Websockets::FRAME_SIZE_LIMIT+2)
+					sections = byte_size/FRAME_SIZE_LIMIT + (byte_size % ::Iodine::Http::Websockets::FRAME_SIZE_LIMIT ? 1 : 0)
+					send_data( data.slice!( 0...::Iodine::Http::Websockets::FRAME_SIZE_LIMIT ), op_code, data.empty?, ext) && (ext = op_code = 0) until data.empty?
+					return true # avoid sending an empty frame.
+				end
+				# @ws_extentions.each { |ex| ext |= ex.edit_frame data } if @ws_extentions
+				header = ( (fin ? 0b10000000 : 0) | (op_code & 0b00001111) | ext).chr.force_encoding(::Encoding::ASCII_8BIT)
+
+				if byte_size < 125
+					header << (byte_size | 128).chr
+				elsif byte_size.bit_length <= 16					
+					header << 254.chr
+					header << [byte_size].pack('S>'.freeze)
+				else
+					header << 255.chr
+					header << [byte_size].pack('Q>'.freeze)
+				end
+				@@make_mask_proc ||= Proc.new {Random.rand(251) + 1}
+				mask = Array.new(4, &(@@make_mask_proc))
+				header << mask.pack('C*'.freeze)
+				@io.write header
+				i = -1;
+				@io.write(data.bytes.map! {|b| (b ^ mask[i = (i + 1)%4]) } .pack('C*'.freeze)) && true
+			end
+			alias :<< :write
+
 			# Create a simple Websocket Client(!).
 			#
 			# This method accepts two parameters:
@@ -179,6 +208,7 @@ module Iodine
 			#
 			# @return [Iodine::Http::WebsocketClient] this method returns the connected {Iodine::Http::WebsocketClient} or raises an exception if something went wrong (such as a connection timeout).
 			def self.connect url, options={}, &block
+				@message ||= Iodine.warn("Deprecation Notice:\nIt is unlikely that Iodine 0.2.0 will support a blocking websocket client API.\nMake sure to use Iodine::Http.ws_connect and define an 'on_open' callback.") && true
 				socket = nil
 				options = options.dup
 				options[:on_message] ||= block

data/lib/iodine/http/websockets.rb

@@ -262,7 +262,9 @@ module Iodine
 							parser[:body] << tmp
 						end
 						if parser[:body].bytesize >= parser[:len]
-							parser[:body].bytesize.times {|i| parser[:body][i] = (parser[:body][i].ord ^ parser[:mask_key][i % 4]).chr} if parser[:mask] == 1
+							tmp = -1
+							parser[:body] = parser[:body].bytes.map! {|b| (b ^ parser[:mask_key][tmp = (tmp + 1)%4]) } .pack('C*'.freeze) if parser[:mask] == 1
+							# parser[:body].bytesize.times {|i| parser[:body][i] = (parser[:body][i].ord ^ parser[:mask_key][i % 4]).chr} if parser[:mask] == 1
 							parser[:stage] = 99
 						end
 					end

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler