iodine 0.1.17 → 0.1.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f3c4befa23f4edb3a43a751b7b9b9a0834411b1
-  data.tar.gz: 59be563a5d91a4dbdc72b06dd282d8acf9f96ad2
+  metadata.gz: f7911b148c188d1f152a742917c38f4f0e6842cd
+  data.tar.gz: 2b1f3862c8c952d5e81e6f7ab216e048086c1bbd
 SHA512:
-  metadata.gz: ebb7e22141e7c3f96ff23c8a7923026193e14409bd00746c84acde2258951eb6ef272ad713db79d93e40541d98a07680fe5a5deab52eea2a067922d550504bd2
-  data.tar.gz: 94e92158a092f1799b74500b9500c5a22b205d21ef13cc36f8cc589e6eaac618ca13f592b6dde45cbda16a698c0d1e23e197ec9702d8e96e085b59dca4cb4991
+  metadata.gz: 61d0143b7066b7d511e628d33bd5d1f2b098238f883b2a68339ed557344f967eac671ed4f18eb7a7f81851a8c3a5ea6fbbe93bede310420fe640210de090edf4
+  data.tar.gz: 49f1992df2719f383bbe478efa4bf33be3932dbeca3b06d866a876ba94b00ada59241a08c31fb9522a4d4d361036fdc59284df60961b7095fd24a9fb4980070b

data/CHANGELOG.md

@@ -8,6 +8,12 @@ Please notice that this change log contains changes for upcoming releases as wel
 
 ***
 
+Change log v.0.1.18
+
+**Update**: The request now has the shortcut method `Request#host_name` for accessing the host's name (without the port part of the string).
+
+***
+
 Change log v.0.1.17
 
 **Credit**: thanks you @frozenfoxx for going through the readme and fixing my broken grammer.

data/README.md

@@ -262,12 +262,6 @@ For instance, in Iodine's implementation for the Websocket protocol: Websocket m
 
 The exception to the rule is the `ping` implementation. Your protocol's `ping` method will execute in parallel with other parts of your protocol's code. Pinging is a machanism that is often time sensitive and is required to maintain an open connection. For this reason, if your code is working hard on a long task, a ping will still occure automatically in the background and offset any connection timeout. 
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/boazsegev/iodine.

data/lib/iodine/http/request.rb

@@ -111,6 +111,11 @@ module Iodine
 				self[:scheme]
 			end
 
+			# the host's name (without the port)
+			def host_name
+				self[:host_name]
+			end
+
 			# @return [true, false] returns true if the requested was an SSL protocol (true also if the connection is clear-text behind an SSL Proxy, such as with some PaaS providers).
 			def ssl?
 				self[:io].ssl? || self[:scheme] == 'https'.freeze || self[:scheme] == 'wss'.freeze

data/lib/iodine/http/websocket_handler.rb

@@ -11,7 +11,18 @@ module Iodine
 			attr_reader :request 
 			# The Http response, also allowing for websocket data
 			attr_reader :response
-			# this is called while still communicating over Http (during the upgrade process).
+			# this shoulw be called while still communicating over Http,
+			# as part of the "upgrade" process. The new object should be returned by the {Iodine::Http#on_websocket} handler.
+			#
+			# i.e.:
+			#
+			#           Iodine::Http.on_websocket do |request, response|
+			#                  next if request.path =~ /refuse/
+			#                  Iodine::Http::WebsocketHandler.new request, response
+			#           end
+			#
+			#
+			# see also the {WebsocketHandler.call} method for an example.
 			def initialize request, response
 				@request = request
 				@response = response
@@ -37,7 +48,7 @@ module Iodine
 			def on_shutdown
 			end
 
-			# This method allows the class itself to act as the Websocket handler, usable with:
+			# This method allows the class itself to act as the global Websocket handler, accepting websocket connections. Example use:
 			#
 			#           # Iodine::Http::WebsocketHandler's default implementation does nothing.
 			#           Iodine::Http.on_websocket Iodine::Http::WebsocketHandler

data/lib/iodine/protocol.rb

@@ -48,7 +48,7 @@ module Iodine
 		# the value is usually `nil` unless the protocol instance was created by a different protocol while "upgrading" from one protocol to the next.
 		attr_reader :options
 		# The protocol's Mutex locker. It should be locked whenever your code is runing, unless you are
-		# writing asynchronouse code.
+		# writing asynchronous code.
 		#
 		# Use with care (or, better yet, don't use).
 		attr_reader :locker

data/lib/iodine/version.rb

@@ -1,3 +1,3 @@
 module Iodine
-  VERSION = "0.1.17"
+  VERSION = "0.1.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iodine
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.18
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler