eodhd 0.19.13 → 0.20.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: debc917c46b895d48892c6fdb0d0845c980fe26e0be451230e62594329083308
-  data.tar.gz: 00a5e08410c0a4791be2b87f9392c94958e9eea54b7204c8f86ef8814280aec6
+  metadata.gz: 3af50c9ff84a7afb642fa1b4465e62cc15e4c856c6612feac2d88b36c47af1ce
+  data.tar.gz: fa1fb309d88c8e60d15b4c7d0c3cc9f2c4b4d08c292bac5afb945ca30b1834b7
 SHA512:
-  metadata.gz: c15a73dd3d5255dc193f7cd02705d5df4df606e8f016bfbccbafbc9e5a05322d23a1c08864ef0d8ca4353a8ae409db40dbed07769a37412ada78344dccb46714
-  data.tar.gz: e0ae570d9434bc3b83e2f9bbf2ff80ce8076544f0b50b93d044fde186f398b3cab85dd48193480c37e51bd6f4638960e38537b701566d5ac717532a4945b2d5f
+  metadata.gz: 6af0d9a5bca09f6472617b523065ce3038d445b1e91727a2e91ae56f7cf20eeb58c9641fdb6a480febf20e27140f4edac61faf83048130d2071af2181277fba3
+  data.tar.gz: 5e27a2e9619255f57d93681cdc6723ff9662bff40a0cb0be87837f21967e0cacc34205fc4d6e5f43a327318ca1dd84b6344ee0728a2a2a4abfdd31396180e1d9

data/CHANGELOG

@@ -1,6 +1,25 @@
 # eodhd/CHANGELOG
 
-## 20261024
+## 20261025
+
+0.20.1: ~ eodhd.gemspec, eodhd.rb.gemspec: Write a custom spec.description, rather than repeating spec.summary.
+
+1. ~ eodhd.gemspec, eodhd.rb.gemspec: ~ spec.description: It matched spec.summary, so gem build warned "description and summary are identical".
+2. + test/gemspec_test.rb: Ensure that each gemspec's description differs from its summary.
+3. ~ Eodhd::VERSION: /0.20.0/0.20.1/
+
+0.20.0: Replace iodine with websocket-driver, so as WebSocketClient sends SNI.
+
+1. ~ eodhd.gemspec and eodhd.rb.gemspec: spec.dependencies: - iodine, + websocket-driver. EODHD's WebSocket endpoints refuse a TLS handshake without SNI, which neither iodine 0.7.60 nor 0.8.2 sends, and 0.8.2 also leaves the API token's query string off the request.
+2. + Eodhd::WebSocketClient::Connection, the URL and socket for WebSocket::Driver.
+3. + Eodhd::WebSocketClient#tls_socket, #tls_context: naming the host (SNI) and verifying its certificate.
+4. + Eodhd::WebSocketClient#websocket_driver
+5. ~ Eodhd::WebSocketClient#run: reads into a WebSocket::Driver until it closes, or until EOFError, Errno::EPIPE or Errno::ECONNRESET. An exception from the consumer, or an Eodhd::Error for a frame which isn't JSON, now ends run, where iodine printed it and carried on.
+6. ~ Eodhd::WebSocketClient::Handler#on_open: subscribes with WebSocket::Driver#text.
+7. - Eodhd::WebSocketClient::Handler#on_close
+8. ~ test/Eodhd/WebSocketClient_test.rb: #run against a server on a socket pair, rather than with Iodine stubbed; + #tls_socket against a local TLS server; + Handler#on_open.
+9. ~ test/gemspec_test.rb: "declares its runtime dependencies": - iodine, + websocket-driver.
+10. ~ Eodhd::VERSION: /0.19.13/0.20.0/
 
 0.19.13: Fix WebSocketClient.us_trade, .us_quote, .forex and .crypto.
 

data/eodhd.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.version = Eodhd::VERSION
 
   spec.summary = "Access the eodhd.com API with Ruby."
-  spec.description = "Access the eodhd.com API with Ruby."
+  spec.description = "A Ruby client for the eodhd.com financial data API: exchanges, symbols, end-of-day and intraday prices, and fundamentals over HTTP, and real-time US stock trades and quotes, forex, and crypto over WebSockets."
 
   spec.author = 'thoran'
   spec.email = 'code@thoran.com'
@@ -38,8 +38,8 @@ Gem::Specification.new do |spec|
 
   spec.dependencies = [
     ['http.rb', '>= 1.7.0'],
-    'iodine',
     'logger',
+    'websocket-driver',
   ]
 
   spec.development_dependencies = %w{

data/lib/Eodhd/VERSION.rb

@@ -1,3 +1,3 @@
 class Eodhd
-  VERSION = '0.19.13'
+  VERSION = '0.20.1'
 end

data/lib/Eodhd/WebSocketClient.rb

@@ -7,9 +7,12 @@
 #   ii.  US market quote data: wss://ws.eodhistoricaldata.com/ws/us-quote?api_token=XXX
 #   iii. Forex: wss://ws.eodhistoricaldata.com/ws/forex?api_token=XXX
 #   iv.  Crypto: wss://ws.eodhistoricaldata.com/ws/crypto?api_token=XXX
+# 2. The endpoints refuse a TLS handshake which doesn't name the host (SNI).
 
-require 'iodine'
 require 'json'
+require 'openssl'
+require 'socket'
+require 'websocket/driver'
 
 require_relative './DefaultLogger'
 require_relative './Error'
@@ -17,21 +20,35 @@ require_relative './Error'
 class Eodhd
   class WebSocketClient
     API_HOST = 'ws.eodhistoricaldata.com'
+    API_PORT = 443
+    READ_SIZE = 16384
+
+    # What WebSocket::Driver writes to: the URL it asks for and the socket to write to.
+    class Connection
+      attr_reader :url
+
+      def write(data)
+        @socket.write(data)
+      end
+
+      private
+
+      def initialize(url:, socket:)
+        @url = url
+        @socket = socket
+      end
+    end
 
     class Handler
-      def on_open(connection)
-        connection.write({action: 'subscribe', symbols: @symbols}.to_json)
+      def on_open(driver)
+        driver.text({action: 'subscribe', symbols: @symbols}.to_json)
       end
 
-      def on_message(connection, message)
+      def on_message(driver, message)
         dataframe = handle_response(message)
         @consumer.call(dataframe) if @consumer
       end
 
-      def on_close(connection)
-        Iodine.stop
-      end
-
       private
 
       def initialize(symbols:, consumer:, logger: nil)
@@ -94,11 +111,14 @@ class Eodhd
     end
 
     def run
-      Iodine.threads = 1
-      Iodine.connect(url: url, handler: Handler.new(symbols: @symbols, consumer: @consumer, logger: @logger))
-      Iodine.start
-    rescue SystemExit, Interrupt
+      socket = tls_socket
+      driver = websocket_driver(socket)
+      driver.start
+      driver.parse(socket.readpartial(READ_SIZE)) until driver.state == :closed
+    rescue EOFError, Errno::EPIPE, Errno::ECONNRESET, SystemExit, Interrupt
       return
+    ensure
+      socket&.close
     end
 
     private
@@ -126,5 +146,30 @@ class Eodhd
     def url
       "wss://#{API_HOST}#{self.class.path_prefix}/#{@asset_class}?api_token=#{@api_token}"
     end
+
+    def tls_context
+      context = OpenSSL::SSL::SSLContext.new
+      context.set_params(verify_mode: OpenSSL::SSL::VERIFY_PEER)
+      context
+    end
+
+    def tls_socket(host: API_HOST, port: API_PORT)
+      socket = OpenSSL::SSL::SSLSocket.new(TCPSocket.new(host, port), tls_context)
+      socket.hostname = host
+      socket.sync_close = true
+      socket.connect
+      socket
+    rescue OpenSSL::SSL::SSLError
+      socket.close
+      raise
+    end
+
+    def websocket_driver(socket)
+      driver = WebSocket::Driver.client(Connection.new(url: url, socket: socket))
+      handler = Handler.new(symbols: @symbols, consumer: @consumer, logger: @logger)
+      driver.on(:open){handler.on_open(driver)}
+      driver.on(:message){|event| handler.on_message(driver, event.data)}
+      driver
+    end
   end
 end

data/test/Eodhd/WebSocketClient_test.rb

@@ -93,26 +93,119 @@ describe Eodhd::WebSocketClient do
   end
 
   describe "#run" do
-    it "configures Iodine and starts connection" do
-      client = Eodhd::WebSocketClient.new(api_token: api_token, asset_class: 'us', symbols: 'AAPL', consumer: consumer)
+    # The server's half of the opening handshake (RFC 6455, 4.2.2), answering with the request line.
+    def accept_handshake(socket)
+      request = []
+      request << socket.gets.chomp until request.last == ''
+      key = request.grep(/\ASec-WebSocket-Key:/i).first.split(':', 2).last.strip
+      accept = [OpenSSL::Digest.digest('SHA1', key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')].pack('m0')
+      socket.write("HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Accept: #{accept}\r\n\r\n")
+      request.first
+    end
+
+    # A masked client frame of under 126 bytes.
+    def read_client_frame(socket)
+      length = socket.read(2).bytes.last & 0x7f
+      mask = socket.read(4).bytes
+      socket.read(length).bytes.each_with_index.map{|byte, i| byte ^ mask[i % 4]}.pack('C*')
+    end
 
-      iodine_connect_called = false
-      iodine_start_called = false
+    def text_frame(text)
+      [0x81, text.bytesize].pack('CC') + text
+    end
+
+    def close_frame
+      [0x88, 2, 1000].pack('CCn')
+    end
 
-      Iodine.stub(:threads=, nil) do
-        Iodine.stub(:connect, ->(opts){iodine_connect_called = true}) do
-          Iodine.stub(:start, ->{iodine_start_called = true}) do
-            client.run
-          end
-        end
+    it "subscribes, hands each message to the consumer, and returns once the server closes" do
+      received = []
+      client = Eodhd::WebSocketClient.new(api_token: 'api_token', asset_class: 'crypto', symbols: 'BTC-USD', consumer: ->(data){received << data})
+      client_socket, server_socket = UNIXSocket.pair
+      server = Thread.new do
+        request_line = accept_handshake(server_socket)
+        subscription = read_client_frame(server_socket)
+        server_socket.write(text_frame('{"s":"BTC-USD","p":"81430.24"}'))
+        server_socket.write(close_frame)
+        [request_line, subscription]
       end
+      client.stub(:tls_socket, client_socket){client.run}
+      request_line, subscription = server.value
+      _(request_line).must_equal('GET /ws/crypto?api_token=api_token HTTP/1.1')
+      _(JSON.parse(subscription)).must_equal({'action' => 'subscribe', 'symbols' => 'BTC-USD'})
+      _(received).must_equal([{'s' => 'BTC-USD', 'p' => '81430.24'}])
+    end
 
-      _(iodine_connect_called).must_equal(true)
-      _(iodine_start_called).must_equal(true)
+    it "returns when the server drops the connection" do
+      received = []
+      client = Eodhd::WebSocketClient.new(api_token: 'api_token', asset_class: 'crypto', symbols: 'BTC-USD', consumer: ->(data){received << data})
+      client_socket, server_socket = UNIXSocket.pair
+      server = Thread.new do
+        accept_handshake(server_socket)
+        server_socket.close
+      end
+      client.stub(:tls_socket, client_socket){client.run}
+      server.join
+      _(received).must_equal([])
+    end
+  end
+
+  describe "#tls_socket" do
+    def self_signed_certificate(key)
+      certificate = OpenSSL::X509::Certificate.new
+      certificate.version = 2
+      certificate.serial = 1
+      certificate.subject = certificate.issuer = OpenSSL::X509::Name.parse('/CN=localhost')
+      certificate.public_key = key.public_key
+      certificate.not_before = Time.now - 60
+      certificate.not_after = Time.now + 3600
+      certificate.sign(key, OpenSSL::Digest.new('SHA256'))
+    end
+
+    # Yields the port of a local TLS server with a self-signed certificate, and the host names its clients sent.
+    def with_tls_server
+      key = OpenSSL::PKey::RSA.new(2048)
+      context = OpenSSL::SSL::SSLContext.new
+      context.cert, context.key = self_signed_certificate(key), key
+      server_names = []
+      context.servername_cb = ->((socket, name)){server_names << name; nil}
+      tcp_server = TCPServer.new('localhost', 0)
+      ssl_server = OpenSSL::SSL::SSLServer.new(tcp_server, context)
+      server = Thread.new{ssl_server.accept rescue nil}
+      yield tcp_server.addr[1], server_names
+    ensure
+      server&.join(5)
+      ssl_server&.close
+    end
+
+    it "names the host in the TLS handshake (SNI)" do
+      client = Eodhd::WebSocketClient.new(api_token: api_token, asset_class: 'crypto', symbols: 'BTC-USD', consumer: consumer)
+      with_tls_server do |port, server_names|
+        _{client.send(:tls_socket, host: 'localhost', port: port)}.must_raise(OpenSSL::SSL::SSLError)
+        _(server_names).must_equal(['localhost'])
+      end
+    end
+
+    it "refuses a certificate it can't verify" do
+      client = Eodhd::WebSocketClient.new(api_token: api_token, asset_class: 'crypto', symbols: 'BTC-USD', consumer: consumer)
+      with_tls_server do |port, server_names|
+        error = _{client.send(:tls_socket, host: 'localhost', port: port)}.must_raise(OpenSSL::SSL::SSLError)
+        _(error.message).must_match(/certificate verify failed/)
+      end
     end
   end
 
   describe "Handler" do
+    describe "#on_open" do
+      it "subscribes to its symbols" do
+        sent = []
+        driver = Struct.new(:sent){def text(message) = sent << message}.new(sent)
+        handler = Eodhd::WebSocketClient::Handler.new(symbols: 'AAPL,MSFT', consumer: consumer, logger: nil)
+        handler.on_open(driver)
+        _(sent.collect{|message| JSON.parse(message)}).must_equal([{'action' => 'subscribe', 'symbols' => 'AAPL,MSFT'}])
+      end
+    end
+
     describe "#on_message" do
       it "parses JSON and calls consumer" do
         received_data = nil

data/test/gemspec_test.rb

@@ -14,6 +14,10 @@ require_relative './helper'
       _(spec.name).must_equal(name)
     end
 
+    it "has a description which says more than its summary" do
+      _(spec.description).wont_equal(spec.summary)
+    end
+
     it "does not pin a date" do
       _(spec.date).must_equal(Gem::Specification.new.date)
     end
@@ -23,7 +27,7 @@ require_relative './helper'
     end
 
     it "declares its runtime dependencies" do
-      _(spec.runtime_dependencies.collect(&:name).sort).must_equal(%w{http.rb iodine logger})
+      _(spec.runtime_dependencies.collect(&:name).sort).must_equal(%w{http.rb logger websocket-driver})
     end
 
     it "requires http.rb 1.7.0 or later, whose load file is lib/http.rb" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eodhd
 version: !ruby/object:Gem::Version
-  version: 0.19.13
+  version: 0.20.1
 platform: ruby
 authors:
 - thoran
@@ -24,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.0
 - !ruby/object:Gem::Dependency
-  name: iodine
+  name: logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: logger
+  name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -149,7 +149,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Access the eodhd.com API with Ruby.
+description: 'A Ruby client for the eodhd.com financial data API: exchanges, symbols,
+  end-of-day and intraday prices, and fundamentals over HTTP, and real-time US stock
+  trades and quotes, forex, and crypto over WebSockets.'
 email: code@thoran.com
 executables: []
 extensions: []