deepstream 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2ebced820e2695da9c46c6982d8b83c16bebceb
-  data.tar.gz: 8646e0465d844e1c2a34bdcbc57b3b061a837084
+  metadata.gz: ae5c4c24417b9fee9b35deee733cb98bc8402caf
+  data.tar.gz: 4e0f4378e8b7e1c0c05ab07c4b9ff3bf22d31bfd
 SHA512:
-  metadata.gz: e2e6b15a7fadb773ab7fc399129700c9de65d76e3d0957578ef30accc3b85d0fc10b9f954223aca44f4e1aa60696e7e2dedcddd112db75c08206dae20639d267
-  data.tar.gz: c7cae785c5c2c59dd600bbb56c17b382ed323cc15622c896b0e5aee51f0d3132a81f280daf8c658ab24870e7c50b90d947540516197d0d720e604573b3e5448a
+  metadata.gz: d2a9d799f057eeeaa687cfbdc1ca5b190aa4b3951a2ab58fff3377b1daa39a35bc1c3baf1232aeeb1a574ecb77a7d96c4af210a285b49a6a9659134242c96271
+  data.tar.gz: ff29a8e5642e88ad74685a7f1fd60007e52204c50dcd8bdc38dc33006977b1254402cc456f7094bf80f8d3df52be73934c8f0b61e2f63343930f729862f501a7

data/README.md

@@ -1,65 +1,84 @@
 # deepstream-ruby
+
 deepstream.io ruby client
 
-### Install
+[![Gem Version](https://badge.fury.io/rb/deepstream.svg)](http://badge.fury.io/rb/deepstream)
+[![Gem License](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/Currency-One/deepstream-ruby/blob/master/LICENSE)
+
+## Installation
 
 ```
 gem install deepstream
 ```
 
-### Usage
+## Usage
+
+### Client initialization
 ```ruby
-ds = Deepstream::Client.new('localhost',
-  autologin: false,
-  verbose: true,
-  credentials: { username: 'John', password: 'Doe' })
+ds = Deepstream::Client.new('localhost')
 # or
 ds = Deepstream::Client.new('ws://localhost:6020')
 # or
-ds = Deepstream::Client.new('ws://localhost:6020/deepstream')
-
+ds = Deepstream::Client.new('ws://localhost:6020/deepstream',
+  ack_timeout: nil, # ACK timeout; if nil, then the client never checks ACK timeout errors
+  autologin: false, # authorise the client when a Websocket connection is initialized; you don't need to call login() then
+  credentials: { username: 'John', password: 'Doe' }, # credentials used to authorise the client
+  heartbeat_interval: nil # when two server heartbeats are missed the client considers the connection to be lost
+  max_reconnect_attempts: nil,
+  max_reconnect_interval: 30, # seconds
+  reconnect_interval: 1, # seconds, the final interval is a lower number from (reconnect_interval * failed_attempts, max_reconnect_interval)
+  emit_timeout: 0, # if 0, then events that failed to be emitted are thrown away
+                   # if nil, then events are stored in a buffer, waiting for reconnection
+                   # if another number, then events are stored in a buffer and sent if the client reconnects in emit_timeout seconds
+  verbose: false, # show verbose information about connection, incoming and outgoing messages etc.
+  debug: false # use for testing only; if true, any exception will terminate the client
+  )
 # log in to the server
 ds.login
 # you can use new credentials too
 ds.login(username: 'John', password: 'betterDoe')
-
 # check if the websocket connection is opened
 ds.connected?
-
 # check if the client is logged in
 ds.logged_in?
-
-# Emit events
-ds.emit 'my_event'
+```
+### Events
+```ruby
+# emit an event
+ds.emit('my_event')
 # or
-ds.emit 'my_event', foo: 'bar', bar: 'foo'
-
-# Subscribe to events
-ds.on('some_event') { |data| puts data }
-
-# Get a record
-foo = ds.get('foo')
-bar = ds.get('bar', list: 'bar_list') # get a record within a namespace (this one automatically adds it to a list)
-
+ds.emit('my_event', foo: 'bar', bar: 'foo')
+# or
+ds.emit('my_event', foo: 'bar', bar: 'foo', timeout: 10) # emit with a custom timeout
+# subscribe to events
+ds.on('my_event') { |data| puts data }
+```
+### Records
+```ruby
+# get a record
+# list is an optional argument; when given, the client adds the record to a list with given name
+foo = ds.get('foo', list: 'bar')
+# or
+foo = ds.get_record('foo', list: 'bar')
 # Update a record
-foo.set('bar', 'bar')
-
-# Set the whole record
-foo.set(foo: 'foo', bar: 1)
-
-# Get a list
-foo = ds.get_list('bar')
-
-# Add to the list
-foo.add('foo')
-
+foo.set('bar', 'bar') # update 'bar' attribute
+# or
+foo.bar = 'bar'
+# or set the whole record data at once
+foo.set(bar: 'bar', baz: 'baz')
+```
+### Lists
+```ruby
+# get a list
+foo = ds.get_list('foo')
+# add to the list
+foo.add('bar')
 # Remove from list
 foo.remove('foo')
-
-# Show record names on the list
+# show record names in the list
 foo.data
 # or
 foo.keys
-
-# Access records on the list
+# get records from the list
 foo.all
+```

data/deepstream.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "deepstream"
-  spec.version       = "0.2.7"
+  spec.version       = "0.2.8"
   spec.authors       = ["Currency-One S.A."]
   spec.email         = ["piotr.szczudlak@currency-one.com"]
 

data/lib/deepstream/list.rb

@@ -8,7 +8,12 @@ module Deepstream
     end
 
     def add(record_name)
-      set(@data << record_name) unless @data.include?(record_name)
+      unless @data.include?(record_name)
+        @data << record_name
+        set
+      end
+    rescue => e
+      @client.on_exception(e)
     end
 
     def read(version, data)
@@ -21,7 +26,7 @@ module Deepstream
     end
 
     def remove(record_name)
-      set(@data) if @data.delete(record_name)
+      set if @data.delete(record_name)
     end
 
     def keys
@@ -31,5 +36,11 @@ module Deepstream
     def all
       @data.map { |record_name| @client.get(record_name) }
     end
+
+    private
+
+    def set
+      @client.send_message(TOPIC::RECORD, ACTION::UPDATE, @name, (@version += 1), @data.to_json) if @version
+    end
   end
 end

data/lib/deepstream/record.rb

@@ -28,6 +28,7 @@ module Deepstream
 
     def set(*args)
       if args.one?
+        raise(ArgumentError, "Record data must be a hash") unless args.first.is_a?(Hash)
         @data = args.first
         @client.send_message(TOPIC::RECORD, ACTION::UPDATE, @name, (@version += 1), @data.to_json) if @version
       elsif args.size == 2
@@ -35,6 +36,8 @@ module Deepstream
         set_path(@data, path, value)
         @client.send_message(TOPIC::RECORD, ACTION::PATCH, @name, (@version += 1), path, Helpers.to_deepstream_type(value)) if @version
       end
+    rescue => e
+      @client.on_exception(e)
     end
 
     def read(version, data)
@@ -44,22 +47,28 @@ module Deepstream
     def patch(version, path, value)
       @version = version.to_i
       set_path(@data, path, Helpers.to_type(value))
+    rescue => e
+      @client.on_exception(e)
     end
 
     def update(version, data)
       @version = version.to_i
       @data = JSON.parse(data)
+    rescue => e
+      @client.on_exception(e)
     end
 
     def method_missing(name, *args)
-      return @data.fetch(name.to_s, nil) if args.empty?
+      name = name.to_s
+      return @data.fetch(name, nil) if args.empty?
+      return set(name[0..-2], *args) if name.end_with?('=') && !args.empty?
       raise(NoMethodError, name)
     end
 
     private
 
     def set_path(data, path, value)
-      key, subkey = path.split('.', 2)
+      key, subkey = path.to_s.split('.', 2)
       if data.is_a?(Hash)
         subkey ? set_path(data.fetch(key), subkey, value) : data[key] = value
       elsif data.is_a?(Array)

data/lib/deepstream/record_handler.rb

@@ -21,6 +21,7 @@ module Deepstream
     end
 
     def get(name, list: nil)
+      name = name.to_s
       if list
         name.prepend("#{list}/")
         @records[list] ||= List.new(@client, list)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepstream
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Currency-One S.A.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-websocket-client