eodhd.rb 0.13.7 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afa9158cc3f9bb4c08a8d547cd2011ed7291e04f5e4b2ecba57bec99c0423a20
-  data.tar.gz: '0209d6df466503644d89e99bcc8c55a717707cbf466524de79e53dcb834bfacd'
+  metadata.gz: d5e7ba5c1bceffbc1bded24d8143fc41d9fe9989f59008b9da914727d1c98296
+  data.tar.gz: ee6da505ccba36b0be5a901aaae1bd142ed418d4bfbb9c7dce38f43ff46e3d7d
 SHA512:
-  metadata.gz: a4e8a34f9f8fbc6abc74abbbfa2d66efe96a3b18c9a6092ffc775484068ccf36b93168a690d04634f5723f156d3bdf87f5e2943b8ec5e4ce660de1519a50dc83
-  data.tar.gz: b87d229a34f838e524ac7d67ec9d4171087f708080700a797572a3913d859f33d8a7bab10aa5b0d9f71d77aad5814500ef66eac2f57e74a1e139f04c4065cd2b
+  metadata.gz: d1d0fab70a78b53a94213297720fef33053edd2c4922ce95b6d536989037eaf907b59886b262db33e2e4d1b4ff3a76a0ec33ee1e017059191b78ade0f9ec9043
+  data.tar.gz: f872f8c9f5b7d289a7ae6469bf6c6bfe851bc9d2c81f8aff010d2fc40984d8aae5b90de8c895d9f929cc4d42cf689138e6ccfc6ea5ea3fafa06c197527582ad5

data/eodhd.rb.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name = 'eodhd.rb'
 
-  spec.version = '0.13.7'
-  spec.date = '2025-03-19'
+  spec.version = '0.14.0'
+  spec.date = '2025-03-21'
 
   spec.summary = "Access the eodhd.com API with Ruby."
   spec.description = "Access the eodhd.com API with Ruby."

data/lib/Eodhd/Client.rb

@@ -2,25 +2,15 @@
 # Eodhd::Client
 
 require 'fileutils'
-require 'Hash/x_www_form_urlencode'
 gem 'http.rb'
 require 'http.rb'
 require 'json'
 require 'logger'
 
-class Eodhd
-  class Error < RuntimeError
-    attr_reader :code, :message, :body
-
-    private
-
-    def initialize(code:, message:, body:)
-      @code = code
-      @message = message
-      @body = body
-    end
-  end
+require_relative './Error'
+require_relative '../Hash/x_www_form_urlencode'
 
+class Eodhd
   class Client
 
     API_HOST = 'eodhd.com'
@@ -52,7 +42,7 @@ class Eodhd
 
     # This endpoint always returns json regardless of what fmt is specified.
     def exchanges_list
-      response = get(path: '/exchanges-list'))
+      response = get(path: '/exchanges-list')
       handle_response(response)
     end
 

data/lib/Eodhd/Error.rb

@@ -0,0 +1,16 @@
+# Eodhd/Error.rb
+# Eodhd::Error
+
+class Eodhd
+  class Error < RuntimeError
+    attr_reader :code, :message, :body
+
+    private
+
+    def initialize(code:, message:, body:)
+      @code = code
+      @message = message
+      @body = body
+    end
+  end
+end

data/lib/Eodhd/WebSocketClient.rb

@@ -0,0 +1,139 @@
+# Eodhd/WebSocketClient.rb
+# Eodhd::WebSocketClient
+
+# Notes:
+# 1. All 4 of 4 WebSocket endpoints which Eodhd provides (See https://eodhd.com/financial-apis/new-real-time-data-api-websockets.) are as folllows...
+#   i.   US market trade data: wss://ws.eodhistoricaldata.com/ws/us?api_token=XXX
+#   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
+
+require 'iodine'
+require 'JSON'
+require 'UnixTime'
+
+class Eodhd
+  class WebSocketClient
+    API_HOST = 'ws.eodhistoricaldata.com'
+
+    class Handler
+      class << self
+        attr_writer :log_file_path
+
+        def default_log_file_path
+          File.join(%w{~ log eodhd log.txt})
+        end
+
+        def log_file_path
+          File.expand_path(@log_file_path || default_log_file_path)
+        end
+
+        def log_file
+          FileUtils.mkdir_p(File.dirname(log_file_path))
+          File.open(log_file_path, File::WRONLY | File::APPEND | File::CREAT)
+        end
+
+        def logger
+          @logger ||= Logger.new(log_file, 'daily')
+        end
+      end # class << self
+
+      def on_open(connection)
+        connection.write({action: 'subscribe', symbols: @symbols}.to_json)
+      end
+
+      def on_message(connection, message)
+        dataframe = handle_response(message)
+        @consumer.call(dataframe)
+      end
+
+      def on_close(connection)
+        Iodine.stop
+      end
+
+      private
+
+      def initialize(symbols:, consumer:)
+        @symbols = symbols
+        @consumer = consumer
+      end
+
+      def log_error(code:, message:, body:)
+        log_string = "WebSocketError #{code}\n#{message}\n#{body}"
+        self.class.logger.error(log_string)
+      end
+
+      def handle_response(message)
+        if parsed_json = JSON.parse(message)
+          parsed_json
+        else
+          log_error(
+            message: response.message,
+          )
+          raise Eodhd::Error.new(
+            code: 'ws',
+            message: response.message,
+            body: ''
+          )
+        end
+      end
+    end
+
+    class << self
+      def path_prefix
+        '/ws'
+      end
+
+      def us_trade(api_token:, symbols:, consumer:)
+        self.class.new(api_token: api_token, asset_class: 'us', symbols: symbols, consumer: consumer)
+      end
+      alias_method :us, :us_trade
+
+      def us_quote(api_token:, symbols:, consumer:)
+        self.class.new(api_token: api_token, asset_class: 'us-quote', symbols: symbols, consumer: consumer)
+      end
+
+      def forex(api_token:, symbols:, consumer:)
+        self.class.new(api_token: api_token, asset_class: 'forex', symbols: symbols, consumer: consumer)
+      end
+
+      def crypto(api_token:, symbols:, consumer:)
+        self.class.new(api_token: api_token, asset_class: 'crypto', symbols: symbols, consumer: consumer)
+      end
+    end # class << self
+
+    def run
+      Iodine.threads = 1
+      Iodine.connect(url: url, handler: Handler.new(symbols: @symbols, consumer: @consumer))
+      Iodine.start
+    rescue SystemExit, Interrupt
+      return
+    end
+
+    private
+
+    attr_accessor\
+      :api_token,
+      :asset_class,
+      :symbols
+
+    def initialize(api_token:, asset_class:, symbols:, consumer:)
+      @api_token = api_token
+      @asset_class = asset_class # crypto, forex, us-quote, us
+      @symbols = format_symbols(symbols)
+      @consumer = consumer
+    end
+
+    def format_symbols(symbols)
+      if symbols.is_a?(Array)
+        symbols.join(',')
+      elsif symbols.is_a?(String)
+        symbols
+      end
+    end
+
+    def url
+      "wss://#{API_HOST}#{self.class.path_prefix}/#{@asset_class}?api_token=#{@api_token}"
+    end
+  end
+end

data/lib/eodhd.rb

@@ -1,58 +1,31 @@
 # Eodhd.rb
 # Eodhd
 
-# 20250319
-# 0.13.7
+# 20250321
+# 0.14.0
 
-# Changes since 0.12:
-# -/0: Add logging.
-# 1. + require 'logger'
-# 2. + Eodhd::Client.log_filename
-# 3. + Eodhd::Client.log_file
-# 4. + Eodhd::Client.logger
-# 5. + Eodhd::Client#log
-# 6. ~ Eodhd::Client#do_request: Call log().
-# 0/1: Add args to the log string.
-# 7. ~ Eodhd::Client#do_request: Add the args to the log string.
-# 1/2: Log '?' and args only if args are present.
-# 8. ~ Eodhd::Client#log: Construct the log string in the method, constructing a log string with arguments if present.
-# 9. ~ Eodhd::Client#do_request: Call the new interface for log().
-# 2/3: Fix logging '?' for when args values are nil.
-# 10. + Eodhd::Client#log_args? Only need to check for whether the values are nil, since this will still work for empty args also.
-# 11. ~ Eodhd::Client#log: Use log_args?
-# 3/4: + eodhd.rb.gemspec, + additional necessary library files
-# 12. + eodhd.rb.gemspec
-# 13. ~ Gemfile: Use gemspec.
-# 14. + lib/Hash/x_www_form_urlencode.rb
-# 15. + lib/Thoran/Hash/XWwwFormUrlEncode/x_www_form_url_encode.rb
-# 16. + lib/Thoran/String/UrlEncode/url_encode.rb
-# 4/5: Create a directory for the log file when running for the first time and also allow specification of the log file path.
-# 17. ~ Eodhd::Client#log_file: Create the log file directory if necessary.
-# 18. ~ Eodhd::Client: + attr_writer :log_file_path
-# 19. + Eodhd::Client#default_log_file_path
-# 20. ~ Eodhd::Client: /log_filename/log_file_path/
-# 5/6: Error handling for HTTP responses.
-# 21. + Eodhd::Client#handle_response
-# 22. + Eodhd::Client#get
-# 23. ~ Eodhd::Client#do_request: Accepts a verb and a path now as well as arguments, instead of a request string and arguments.
-# 23. + Eodhd::Error
-# 24. ~ Eodhd::Client#log: + verb argument
-# 25. ~ Eodhd::Client public methods: Use get() and handle_response().
-# 6/7. Logging for HTTP errors.
-# 26. ~ Eodhd::Client: /log()/log_request()/
-# 27. + Eodhd::Client#log_error
-# 28. ~ Eodhd::Client#do_request: /log/log_request/.
-# 29. ~ Eodhd::Client#handle_response: Use log_error().
+# Changes since 0.13:
+# -/0: Add WebSockets.
+# 1. + Eodhd::WebSocketClient
+# 2. + Eodhd#web_socket
+# 3. + Eodhd#stream
+# 4. + Eodhd#us_quote_stream
+# 5. + Eodhd#us_trade_stream
+# 6. + Eodhd#forex_stream
+# 7. + Eodhd#crypto_stream
+# 8. Moved Eodhd::Error from Eodhd::Client to a separate file.
 
 require_relative 'Eodhd/Client'
 require_relative 'Eodhd/EodBulkLastDay'
 require_relative 'Eodhd/EodData'
 require_relative 'Eodhd/Exchange'
 require_relative 'Eodhd/ExchangeSymbol'
+require_relative 'Eodhd/WebSocketClient'
 
 class Eodhd
-  def initialize(api_token:)
+  def initialize(api_token:, consumer: nil)
     @api_token = api_token
+    @consumer = consumer
   end
 
   def exchanges
@@ -74,4 +47,34 @@ class Eodhd
     exchange_code ||= exchange.code
     Eodhd::EodBulkLastDay.all(api_token: @api_token, exchange_code: exchange_code, date: date)
   end
+
+  def web_socket(asset_class:, symbols:)
+    Eodhd::WebSocketClient.new(
+      api_token: @api_token,
+      asset_class: asset_class,
+      symbols: symbols,
+      consumer: @consumer,
+    )
+  end
+
+  def stream(asset_class:, symbols:)
+    web_socket(asset_class: asset_class, symbols: symbols).run
+  end
+
+  def us_trade_stream(symbols)
+    stream(asset_class: 'us', symbols: symbols)
+  end
+  alias_method :us_stream, :us_trade_stream
+
+  def us_quote_stream(symbols)
+    stream(asset_class: 'us-quote', symbols: symbols)
+  end
+
+  def forex_stream(symbols)
+    stream(asset_class: 'forex', symbols: symbols)
+  end
+
+  def crypto_stream(symbols)
+    stream(asset_class: 'crypto', symbols: symbols)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: eodhd.rb
 version: !ruby/object:Gem::Version
-  version: 0.13.7
+  version: 0.14.0
 platform: ruby
 authors:
 - thoran
 bindir: bin
 cert_chain: []
-date: 2025-03-19 00:00:00.000000000 Z
+date: 2025-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http.rb
@@ -35,8 +35,10 @@ files:
 - lib/Eodhd/Client.rb
 - lib/Eodhd/EodBulkLastDay.rb
 - lib/Eodhd/EodData.rb
+- lib/Eodhd/Error.rb
 - lib/Eodhd/Exchange.rb
 - lib/Eodhd/ExchangeSymbol.rb
+- lib/Eodhd/WebSocketClient.rb
 - lib/Hash/x_www_form_urlencode.rb
 - lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb
 - lib/Thoran/String/UrlEncode/url_encode.rb