lightstreamer 0.2 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dd1721bffbb480dfa570531e520c727084a58d9
-  data.tar.gz: 67ee866151859546536fca838dabfe05e84a1d2d
+  metadata.gz: f96a70c42b710644985ba440779ec2d73f32ad9e
+  data.tar.gz: 4c0181a0612a67870d3333671ecbb20e0af27f8c
 SHA512:
-  metadata.gz: 0e52c034fa5c273733b97373038f1ccb9ac18959b9ab8c47b47c515ce64a954f3b397966cb02d5e924183364ec47d0402454faf117e4dbef3d3451fb5cfdaafa
-  data.tar.gz: 8a79799ea6def575bd5aed0bbbe9d514512d4db4bd32b5dd6417a320d8b929739931714403f4312b3316f326280dc049c15ca883c5af929be9ba92c62687451a
+  metadata.gz: 5048265eaf80652222323ffad4f4fa4a39343c4adbc8a52ae5b449d43a8c63e343334cab654a2f6fdc3321955b418581661e0c596e23f1f3ea83f953e9a77f02
+  data.tar.gz: 248b20766df771c73189fd3eb61f218a5b016254a2271f965c4076cfde2bd9391eef4ab6afcc1ea5a5424a3ca86c4f15728aeb12bf415bb2b03721722828bced

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Lightstreamer Changelog
 
+### 0.3 — July 24, 2016
+
+- Seamlessly rebind the stream connection when a `LOOP` message is received
+- Correctly handle UTF-16 escape sequences in stream data, including UTF-16 surrogate pairs
+- Switched to the `typhoeus` library for HTTP support
+- Improved error handling on the stream thread
+- Added `Lightstreamer::Session#connected?`
+
 ### 0.2 — July 23, 2016
 
 - Added complete test suite

data/README.md

@@ -43,9 +43,9 @@ session = Lightstreamer::Session.new server_url: 'http://push.lightstreamer.com'
 # Connect the session
 session.connect
 
-# Create a new subscription that subscribes to five items and to four fields on each item
-subscription = Lightstreamer::Subscription.new items: %w(item1 item2 item3 item4 item5),
-                                               fields: [:time, :stock_name, :bid, :ask],
+# Create a new subscription that subscribes to thirty items and to four fields on each item
+subscription = Lightstreamer::Subscription.new items: (1..30).map { |i| "item#{i}" },
+                                               fields: [:ask, :bid, :stock_name, :time],
                                                mode: :merge, adapter: 'QUOTE_ADAPTER'
 
 # Create a thread-safe queue
@@ -76,10 +76,10 @@ To print streaming data from the demo server run the following command:
 
 ```
 lightstreamer --server-url http://push.lightstreamer.com --adapter-set DEMO --adapter QUOTE_ADAPTER \
-              --items item1 item2 item3 item4 item5 --fields time stock_name bid ask bid
+              --items item1 item2 item3 item4 item5 --fields ask bid stock_name time
 ```
 
-To see a full list of available options run the following command:
+To see a full list of available options for the command-line client run the following command:
 
 ```
 lightstreamer help stream

data/lib/lightstreamer.rb

@@ -1,5 +1,6 @@
-require 'rest-client'
 require 'thor'
+require 'typhoeus'
+require 'uri'
 
 require 'lightstreamer/control_connection'
 require 'lightstreamer/line_buffer'
@@ -7,7 +8,9 @@ require 'lightstreamer/protocol_error'
 require 'lightstreamer/request_error'
 require 'lightstreamer/session'
 require 'lightstreamer/stream_connection'
+require 'lightstreamer/stream_connection_header'
 require 'lightstreamer/subscription'
+require 'lightstreamer/utf16'
 require 'lightstreamer/version'
 
 require 'lightstreamer/cli/main'

data/lib/lightstreamer/control_connection.rb

@@ -31,16 +31,14 @@ module Lightstreamer
 
     private
 
-    # Executes a POST request to the control address with the specified payload. Raises an error if the HTTP request
-    # fails. Returns the response from the server split into individual lines.
+    # Executes a POST request to the control address with the specified payload. Raises {RequestError} if the HTTP
+    # request fails. Returns the response body split into individual lines.
     def execute_post_request(payload)
-      response = RestClient::Request.execute method: :post, url: @control_url, payload: payload
+      response = Typhoeus.post @control_url, body: payload
+
+      raise RequestError.new(response.return_message, response.response_code) unless response.success?
 
       response.body.split("\n").map(&:strip)
-    rescue RestClient::Exception => exception
-      raise RequestError, exception.message
-    rescue SocketError => socket_error
-      raise RequestError, socket_error
     end
 
     # Constructs the payload for a Lightstreamer control request based on the given options hash. See {#execute} for
@@ -54,7 +52,7 @@ module Lightstreamer
 
       build_optional_payload_fields options, params
 
-      URI.encode_www_form params
+      params
     end
 
     def build_optional_payload_fields(options, params)

data/lib/lightstreamer/session.rb

@@ -36,20 +36,22 @@ module Lightstreamer
     def connect
       return if @stream_connection
 
-      @stream_connection = StreamConnection.new self
-
-      first_line = @stream_connection.read_line
+      create_stream_connection
+      create_control_connection
+      create_processing_thread
+    rescue
+      @stream_connection = nil
+      raise
+    end
 
-      if first_line == 'OK'
-        @session_id = read_session_id
-        create_control_connection
-        create_processing_thread
-      elsif first_line == 'ERROR'
-        handle_connection_error
-      end
+    # Returns whether this session is currently connected and has an active stream connection.
+    #
+    # @return [Boolean]
+    def connected?
+      !@stream_connection.nil?
     end
 
-    # Disconnects this session and shuts down its stream and processing threads.
+    # Disconnects this session and shuts down its stream connection and processing threads.
     def disconnect
       @stream_connection.disconnect if @stream_connection
 
@@ -102,25 +104,20 @@ module Lightstreamer
 
     private
 
-    # Parses the next line of data from the stream connection as the session ID and returns it.
-    def read_session_id
-      @stream_connection.read_line.match(/^SessionId:(.*)$/).captures.first
+    def create_stream_connection
+      @stream_connection = StreamConnection.new self
+      @stream_connection.connect
     end
 
-    # Attempts to parses the next line of data from the stream connection as a custom control address and then uses this
-    # address to create the control connection. Note that the control address is optional and if it is absent then
-    # {#server_url} will be used instead of a custom control address.
     def create_control_connection
-      match = @stream_connection.read_line.match(/^ControlAddress:(.*)$/)
-      control_address = (match && match.captures.first) || server_url
-
-      # The rest of the contents in the header is ignored, so read up until the blank line that marks its ending
-      loop { break if @stream_connection.read_line == '' }
+      control_address = @stream_connection.control_address || server_url
 
-      # If the control URL doesn't have a schema then use the same schema as the server URL
-      control_address = "#{URI(server_url).scheme}://#{control_address}" unless control_address.start_with? 'http'
+      # If the control address doesn't have a schema then use the same schema as the server URL
+      unless control_address.start_with? 'http'
+        control_address = "#{URI(server_url).scheme}://#{control_address}"
+      end
 
-      @control_connection = ControlConnection.new @session_id, control_address
+      @control_connection = ControlConnection.new @stream_connection.session_id, control_address
     end
 
     # Starts the processing thread that reads and processes incoming data from the stream connection.
@@ -129,8 +126,14 @@ module Lightstreamer
         loop do
           line = @stream_connection.read_line
 
+          break if line.nil?
+
           process_stream_data line unless line.empty?
         end
+
+        # The stream connection has died, so exit the processing thread
+        warn "Lightstreamer: processing thread exiting, error: #{@stream_connection.error}"
+        @processing_thread = @stream_connection = @control_connection = nil
       end
     end
 
@@ -145,17 +148,5 @@ module Lightstreamer
 
       warn "Lightstreamer: unprocessed stream data '#{line}'" unless was_processed
     end
-
-    # Handles a failure to establish a stream connection by reading off the error code and error message then raising
-    # a {ProtocolError}.
-    def handle_connection_error
-      error_code = @stream_connection.read_line
-      error_message = @stream_connection.read_line
-
-      @stream_connection = nil
-      @control_connection = nil
-
-      raise ProtocolError.new(error_message, error_code)
-    end
   end
 end

data/lib/lightstreamer/stream_connection.rb

@@ -5,6 +5,16 @@ module Lightstreamer
     # @return [Thread] The thread used to process incoming streaming data.
     attr_reader :thread
 
+    # @return [String] The session ID returned from the server when this stream connection was initiated.
+    attr_reader :session_id
+
+    # @return [String] The control address returned from the server when this stream connection was initiated.
+    attr_reader :control_address
+
+    # @return [ProtocolError, RequestError, String] If an error occurs on the stream thread that causes this stream
+    #         to disconnect then the exception or error details will be stored in this attribute.
+    attr_reader :error
+
     # Establishes a new stream connection using the authentication details from the passed session.
     #
     # @param [Session] session The session to create a stream connection for.
@@ -12,73 +22,128 @@ module Lightstreamer
       @session = session
       @queue = Queue.new
 
-      create_stream
+      @stream_create_url = URI.join(session.server_url, '/lightstreamer/create_session.txt').to_s
+      @stream_bind_url = URI.join(session.server_url, '/lightstreamer/bind_session.txt').to_s
+    end
+
+    # Establishes a new stream connection using the authentication details from the session that was passed to
+    # {#initialize}. Raises {ProtocolError} or {RequestError} on failure.
+    def connect
+      return if @thread
+      @session_id = @error = nil
+
       create_stream_thread
+
+      # Wait until the connection result is known
+      until @session_id || @error
+      end
+
+      raise @error if @error
+    end
+
+    # Returns whether or not this stream connection is connected.
+    #
+    # @return [Boolean]
+    def connected?
+      !@thread.nil?
     end
 
     # Disconnects this stream connection by shutting down the streaming thread.
     def disconnect
-      return unless @thread
+      if @thread
+        Thread.kill @thread
+        @thread.join
+      end
 
-      Thread.kill @thread
-      @thread.join
+      @session_id = @control_address = @error = @thread = nil
     end
 
-    # Reads the next line of streaming data. This method blocks the calling thread until a line of data is available.
+    # Reads the next line of streaming data. If the streaming thread is alive then this method blocks the calling thread
+    # until a line of data is available. If the streaming thread is not active then any unconsumed lines will be
+    # returned and after that the return value will be `nil`.
+    #
+    # @return [String, nil]
     def read_line
+      return nil if @queue.empty? && @thread.nil?
+
       @queue.pop
     end
 
     private
 
-    def create_stream
-      @stream = Net::HTTP.new stream_uri.host, stream_uri.port
-      @stream.use_ssl = true if stream_uri.port == 443
-    end
-
     def create_stream_thread
       @thread = Thread.new do
         begin
-          connect_stream_and_queue_data
+          stream_thread_main
         rescue StandardError => error
-          warn "Lightstreamer: exception in stream thread: #{error}"
-          exit 1
+          @error = error
         end
+
+        @thread = nil
       end
     end
 
-    def initiate_stream_post_request
-      Net::HTTP::Post.new(stream_uri.path).tap do |request|
-        request.body = stream_create_parameters
+    def stream_thread_main
+      connect_stream_and_process_data stream_create_post_request
+
+      while @loop
+        @loop = false
+        connect_stream_and_process_data stream_bind_post_request
       end
     end
 
-    def connect_stream_and_queue_data
-      @stream.request initiate_stream_post_request do |response|
-        buffer = LineBuffer.new
-        response.read_body do |data|
-          buffer.process data do |line|
-            @queue.push line unless ignore_line? line
-          end
-        end
+    def stream_create_post_request
+      params = { LS_op2: 'create', LS_cid: 'mgQkwtwdysogQz2BJ4Ji kOj2Bg', LS_user: @session.username,
+                 LS_password: @session.password }
+
+      params[:LS_adapter_set] = @session.adapter_set if @session.adapter_set
+
+      Typhoeus::Request.new @stream_create_url, method: :post, params: params
+    end
+
+    def stream_bind_post_request
+      Typhoeus::Request.new @stream_bind_url, method: :post, params: { LS_session: @session_id }
+    end
+
+    def connect_stream_and_process_data(request)
+      @header = StreamConnectionHeader.new
+
+      buffer = LineBuffer.new
+      request.on_body do |data|
+        buffer.process data, &method(:process_stream_line)
+      end
+
+      request.on_complete do |response|
+        @error = RequestError.new(response.return_message, response.response_code) unless response.success?
       end
+
+      request.run
     end
 
-    def stream_uri
-      URI.join @session.server_url, '/lightstreamer/create_session.txt'
+    def process_stream_line(line)
+      if @header
+        process_header_line line
+      else
+        process_body_line line
+      end
     end
 
-    def stream_create_parameters
-      params = {
-        LS_op2: 'create',
-        LS_cid: 'mgQkwtwdysogQz2BJ4Ji kOj2Bg',
-        LS_user: @session.username,
-        LS_password: @session.password
-      }
+    def process_header_line(line)
+      return if @header.process_header_line line
 
-      params[:LS_adapter_set] = @session.adapter_set if @session.adapter_set
+      @control_address = @header['ControlAddress']
+      @session_id = @header['SessionId']
+      @error = @header.error
+
+      @header = nil
+    end
 
-      URI.encode_www_form params
+    def process_body_line(line)
+      if line == 'LOOP'
+        @loop = true
+      elsif !ignore_line?(line)
+        @queue.push line
+      end
     end
 
     def ignore_line?(line)

data/lib/lightstreamer/stream_connection_header.rb

@@ -0,0 +1,60 @@
+module Lightstreamer
+  # Helper class that processes the contents of the header returned by the server when a new stream connection is
+  # created or an existing session is bound to.
+  class StreamConnectionHeader
+    # @return [ProtocolError, RequestError] If there was an error in the header then this value will be set to the
+    #         error instance that should be raised in response.
+    attr_reader :error
+
+    def initialize
+      @data = {}
+      @lines = []
+    end
+
+    # Processes a single line of header information. The return value indicates whether further data is required in
+    # order to complete the header.
+    #
+    # @param [String] line The line of header data to process.
+    #
+    # @return [Boolean] Whether the header is still incomplete and requires further data.
+    def process_header_line(line)
+      @lines << line
+
+      unless %w(OK ERROR).include? @lines.first
+        @error = RequestError.new line
+        return false
+      end
+
+      return true if @lines.first == 'OK' && !line.empty?
+      return true if @lines.first == 'ERROR' && @lines.size < 3
+
+      parse_header
+
+      false
+    end
+
+    # Returns the value for the item with the specified name in this header, or `nil` if no item with the specified name
+    # was part of this header
+    #
+    # @param [String] item_name The name of the item to return the header value for.
+    #
+    # @return [String, nil] The value of the item as specified in this header, or `nil` if the item name was not
+    #         specified in this header.
+    def [](item_name)
+      @data[item_name]
+    end
+
+    private
+
+    def parse_header
+      if @lines.first == 'OK'
+        @lines[1..-1].each do |line|
+          match = line.match(/^([^:]*):(.*)$/)
+          @data[match.captures[0]] = match.captures[1] if match
+        end
+      elsif @lines.first == 'ERROR'
+        @error = ProtocolError.new @lines[2], @lines[1]
+      end
+    end
+  end
+end

data/lib/lightstreamer/subscription.rb

@@ -134,12 +134,8 @@ module Lightstreamer
 
     private
 
-    # Attempts to parse an line of stream data.
-    #
-    # @param [String] line The line of stream data to parse.
-    #
-    # @return [Array] The first value is the item index, and the second is a hash of the values contained in the stream
-    #                 data. Will be nil if the stream data was not able to be parsed.
+    # Attempts to parse a line of stream data. If parsing is successful then the first return value is the item index,
+    # and the second is a hash of the values contained in the stream data.
     def parse_stream_data(line)
       match = line.match stream_data_regex
       return unless match
@@ -152,18 +148,12 @@ module Lightstreamer
 
     # Returns the regular expression that will match a single line of data in the incoming stream that is relevant to
     # this subscription. The ID at the beginning must match, as well as the number of fields.
-    #
-    # @return [Regexp]
     def stream_data_regex
       Regexp.new "^#{id},(\\d+)#{'\|(.*)' * fields.size}"
     end
 
     # Parses an array of values from an incoming line of stream data into a hash where the keys are the field names
     # defined for this subscription.
-    #
-    # @param [String] values The raw values from the incoming stream data.
-    #
-    # @return [Hash] The parsed values as a hash where the keys are the field names of this subscription.
     def parse_values(values)
       hash = {}
 
@@ -183,10 +173,7 @@ module Lightstreamer
 
       value = value[1..-1] if value =~ /^(\$|#)/
 
-      # TODO: parse any non-ASCII characters which are specified as UTF-16 escape sequences in the form '\uXXXX' or
-      # '\uXXXX\uYYYY'. They need to be transformed into native Unicode characters.
-
-      value
+      UTF16.decode_escape_sequences value
     end
 
     # Invokes all of this subscription's data callbacks with the specified arguments. Any exceptions that occur in a

data/lib/lightstreamer/utf16.rb

@@ -0,0 +1,31 @@
+module Lightstreamer
+  # This module supports the decoding of UTF-16 escape sequences
+  module UTF16
+    module_function
+
+    # Decodes any UTF-16 escape sequences in the form '\uXXXX' into a new string. Invalid escape sequences are removed.
+    def decode_escape_sequences(string)
+      string = decode_surrogate_pairs_escape_sequences string
+
+      # Match all remaining escape sequences
+      string.gsub(/\\u[A-F\d]{4}/i) do |escape_sequence|
+        codepoint = escape_sequence[2..-1].hex
+
+        # Codepoints greater than 0xD7FF are invalid
+        codepoint < 0xD800 ? [codepoint].pack('U') : ''
+      end
+    end
+
+    # Converts any UTF-16 surrogate pairs escape sequences in the form '\uXXXX\uYYYY' into UTF-8.
+    def decode_surrogate_pairs_escape_sequences(string)
+      string.gsub(/\\uD[89AB][A-F\d]{2}\\uD[C-F][A-F\d]{2}/i) do |escape_sequence|
+        high_surrogate = escape_sequence[2...6].hex
+        low_surrogate = escape_sequence[8...12].hex
+
+        codepoint = 0x10000 + ((high_surrogate - 0xD800) << 10) + (low_surrogate - 0xDC00)
+
+        [codepoint].pack 'U'
+      end
+    end
+  end
+end

data/lib/lightstreamer/version.rb

@@ -1,4 +1,4 @@
 module Lightstreamer
   # The version of this gem.
-  VERSION = '0.2'.freeze
+  VERSION = '0.3'.freeze
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: lightstreamer
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
 platform: ruby
 authors:
 - Richard Viney
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +184,9 @@ files:
 - lib/lightstreamer/request_error.rb
 - lib/lightstreamer/session.rb
 - lib/lightstreamer/stream_connection.rb
+- lib/lightstreamer/stream_connection_header.rb
 - lib/lightstreamer/subscription.rb
+- lib/lightstreamer/utf16.rb
 - lib/lightstreamer/version.rb
 homepage: https://github.com/rviney/lightstreamer
 licenses: