async_cable 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51ecb6cb916b09cf5f40b62a9be1ddd360fabbb782977ec5da1f1a0babfbc361
-  data.tar.gz: 3036bbc16779cd6211e6b5f3d513028f84ccab08491395c844307fed7d4caf85
+  metadata.gz: 998abf5f3d5c77b7708cc89f7959e96240c41d1e9d03969b835dfe6feb3bd965
+  data.tar.gz: 598c96f04bd6081fbb87f4652ef5c7934e6bc0ca56f6b7fa71af3dce2413f8ea
 SHA512:
-  metadata.gz: 480548a0bcf0e13f62fccb45cdaac42223f0573d552420b2c9ea286f2b1561ff0d6d8195cb20494b689e4c5aa387d7519d47355f67d0b2c54c32b6353f3e9a35
-  data.tar.gz: 742caf72b09cee54c0b36a1014bd794b9f59bbca68c88c9bf9df387c0bfad191b1a633a2c735ae9abf2b225d5e2ee518fd469823ede76acf86f81cad8b1d2882
+  metadata.gz: 8e46330cb55642128c2dc7023b93aa2137605bb5cfa3c8fbfc19c834eab67acb8a62fa2941367235d575555e2084ad7a21e2befc907582f2c57281fc1131f6b4
+  data.tar.gz: 93bcf416e3e8a6c116d26a2a2e66cfbb440009933712aa0155f52465e03add44057080adf7f941943215fde75881c06c8d64fd0fae85be428de2de37fd6c3a4d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+### Unreleased
+
+### 0.2.1
+* fix registry
+
 ### 0.2.0
 * fix config.rb requiring
 * broadcast async connection iteration

data/README.md

@@ -94,6 +94,11 @@ example of JS code for connecting with websocket server
 
 ## Development
 
+### Building version
+
+    gem_push=false rake release
+    gem push pkg/async_cable-X.Y.Z.gem
+
 will use [Semver](https://semver.org) from version `1.0.0`
 
 ## Contributing

data/lib/async_cable.rb

@@ -6,14 +6,19 @@ require 'async_cable/connection'
 require 'async_cable/server'
 
 module AsyncCable
+
+  # @return [Async::Config]
   def config
     @config ||= Config.new
   end
 
+  # @yield [Async::Config]
   def configure
     yield config
   end
 
+  # Transmit data to all WS connections.
+  # @param data [Hash]
   def broadcast(data)
     config.logger.debug { "#{name}.broadcast data=#{data.inspect}" }
     Registry.each { |conn| conn.transmit(data) }

data/lib/async_cable/connection.rb

@@ -9,14 +9,17 @@ module AsyncCable
         subclass.identified_as subclass.name.demodulize.underscore
       end
 
+      # sets #channel_name for connection class
       def identified_as(channel)
         @channel_name = channel.to_s
       end
 
+      # @return [String]
       def channel_name
         @channel_name
       end
 
+      # @return [Logger]
       def logger
         AsyncCable.config.logger
       end
@@ -77,6 +80,8 @@ module AsyncCable
       @stream_name
     end
 
+    # @param reason [String,NilClass] exception message.
+    # @raise [AsyncCable::UnauthorizedError]
     def reject_unauthorized(reason = nil)
       raise UnauthorizedError, reason
     end
@@ -94,6 +99,7 @@ module AsyncCable
       close_code == Protocol::WebSocket::Error::NO_ERROR
     end
 
+    # Called when connection being opened.
     # @param env [Hash]
     # @raise [AsyncCable::Errors::StreamNameNotSet] if #stream_for was not called
     # @raise [AsyncCable::Errors::UnauthorizedError] if #reject_unauthorized was called
@@ -105,6 +111,8 @@ module AsyncCable
       Registry.add(channel_name, stream_name, self)
     end
 
+    # Called when connection being closed.
+    # @see #close_code #close_reason for close details.
     def handle_close
       logger.debug { "#{self.class}#handle_close clean=#{close_clean?} code=#{close_code} reason=#{close_reason}" }
       close
@@ -112,10 +120,12 @@ module AsyncCable
       on_close
     end
 
+    # @return [String]
     def channel_name
       self.class.channel_name
     end
 
+    # @return [Logger]
     def logger
       self.class.logger
     end

data/lib/async_cable/errors.rb

@@ -6,12 +6,14 @@ module AsyncCable
       end
     end
 
+    # @see AsyncCable::Connection#handle_open
     class StreamNameNotSet < Error
       def initialize(class_name)
         super("#stream_for must be called with stream name in #{class_name}#on_open")
       end
     end
 
+    # @see AsyncCable::Connection#reject_unauthorized
     class UnauthorizedError < Error
       def initialize(reason = nil)
         super(reason || 'unauthorized')

data/lib/async_cable/registry.rb

@@ -7,7 +7,7 @@ module AsyncCable
     extend SingleForwardable
     @mutex = Mutex.new
 
-    single_delegate [:add, :remove, :find, :all] => :instance
+    single_delegate [:add, :remove, :find, :each] => :instance
 
     # Adds connection to registry.
     # @param channel_name [String]

data/lib/async_cable/server.rb

@@ -41,8 +41,6 @@ module AsyncCable
       response || [400, { 'Content-Type' => 'text/plain' }, ['Not valid ws']]
     end
 
-    private
-
     def logger
       AsyncCable.config.logger
     end

data/lib/async_cable/version.rb

@@ -1,3 +1,3 @@
 module AsyncCable
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async_cable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Denis Talakevich