DhanHQ 2.1.8 → 2.2.0

data/lib/DhanHQ/ws/orders/client.rb

@@ -9,12 +9,20 @@ module DhanHQ
       ##
       # Enhanced WebSocket client for real-time order updates
       # Provides comprehensive order state tracking and event handling
-      # rubocop:disable Metrics/ClassLength
       class Client
+        # Maximum number of orders to keep in tracker (default: 10,000)
+        MAX_TRACKED_ORDERS = ENV.fetch("DHAN_WS_MAX_TRACKED_ORDERS", 10_000).to_i
+
+        # Maximum age of orders in tracker in seconds (default: 7 days)
+        MAX_ORDER_AGE = ENV.fetch("DHAN_WS_MAX_ORDER_AGE", 604_800).to_i
+
         def initialize(url: nil, **options)
           @callbacks = Concurrent::Map.new { |h, k| h[k] = [] }
           @started = Concurrent::AtomicBoolean.new(false)
           @order_tracker = Concurrent::Map.new
+          @order_timestamps = Concurrent::Map.new
+          @cleanup_mutex = Mutex.new
+          @cleanup_thread = nil
           cfg = DhanHQ.configuration
           @url = url || cfg.ws_order_url
           @connection_options = options
@@ -33,6 +41,7 @@ module DhanHQ
           @conn.on(:error) { |error| emit(:error, error) }
           @conn.on(:message) { |msg| handle_message(msg) }
           @conn.start
+          start_cleanup_thread
           DhanHQ::WS::Registry.register(self) if defined?(DhanHQ::WS::Registry)
           self
         end
@@ -44,6 +53,7 @@ module DhanHQ
           return unless @started.true?
 
           @started.make_false
+          stop_cleanup_thread
           @conn&.stop
           emit(:close, true)
           DhanHQ::WS::Registry.unregister(self) if defined?(DhanHQ::WS::Registry)
@@ -147,13 +157,16 @@ module DhanHQ
         ##
         # Handle order update and track state changes
         # @param order_update [OrderUpdate] Parsed order update
-        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
         def handle_order_update(order_update)
           order_no = order_update.order_no
           previous_state = @order_tracker[order_no]
 
-          # Update order tracker
+          # Update order tracker with timestamp
           @order_tracker[order_no] = order_update
+          @order_timestamps[order_no] = Time.now
+
+          # Cleanup if tracker exceeds max size
+          cleanup_old_orders if @order_tracker.size > MAX_TRACKED_ORDERS
 
           # Emit update event
           emit(:update, order_update)
@@ -180,13 +193,12 @@ module DhanHQ
           # Emit specific status events
           emit_status_specific_events(order_update, previous_state)
         end
-        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
         ##
         # Emit status-specific events
+        #
         # @param order_update [OrderUpdate] Current order update
-        # @param previous_state [OrderUpdate, nil] Previous order state
-        # rubocop:disable Metrics/MethodLength
+        # @param _previous_state [OrderUpdate, nil] Previous order state (unused parameter)
         def emit_status_specific_events(order_update, _previous_state)
           case order_update.status
           when "TRANSIT"
@@ -203,24 +215,78 @@ module DhanHQ
             emit(:order_expired, order_update)
           end
         end
-        # rubocop:enable Metrics/MethodLength
 
         ##
         # Emit events to registered callbacks
         # @param event [Symbol] Event type
         # @param payload [Object] Event payload
         def emit(event, payload)
-          list = begin
-            @callbacks[event]
+          # Create a snapshot of callbacks to avoid modification during iteration
+          callbacks_snapshot = begin
+            @callbacks[event].dup.freeze
           rescue StandardError
-            []
+            [].freeze
           end
-          list.each { |cb| cb.call(payload) }
+
+          callbacks_snapshot.each { |cb| cb.call(payload) }
         rescue StandardError => e
           DhanHQ.logger&.error("[DhanHQ::WS::Orders] Error in event handler: #{e.class} #{e.message}")
         end
+
+        ##
+        # Start cleanup thread to periodically remove old orders
+        def start_cleanup_thread
+          return if @cleanup_thread&.alive?
+
+          @cleanup_thread = Thread.new do
+            loop do
+              break unless @started.true?
+
+              sleep(3600) # Run cleanup every hour
+              break unless @started.true?
+
+              cleanup_old_orders
+            end
+          end
+        end
+
+        ##
+        # Stop cleanup thread
+        def stop_cleanup_thread
+          return unless @cleanup_thread&.alive?
+
+          @cleanup_thread.wakeup
+          @cleanup_thread.join(5) # Wait up to 5 seconds
+          @cleanup_thread = nil
+        end
+
+        ##
+        # Clean up old orders from tracker
+        def cleanup_old_orders
+          @cleanup_mutex.synchronize do
+            now = Time.now
+            orders_to_remove = []
+
+            # Find orders to remove (too old or if tracker is too large)
+            @order_timestamps.each do |order_no, timestamp|
+              age = now - timestamp
+              if age > MAX_ORDER_AGE || (@order_tracker.size > MAX_TRACKED_ORDERS && orders_to_remove.size < @order_tracker.size - MAX_TRACKED_ORDERS)
+                orders_to_remove << order_no
+              end
+            end
+
+            # Remove old orders
+            orders_to_remove.each do |order_no|
+              @order_tracker.delete(order_no)
+              @order_timestamps.delete(order_no)
+            end
+
+            if orders_to_remove.any?
+              DhanHQ.logger&.debug("[DhanHQ::WS::Orders] Cleaned up #{orders_to_remove.size} old orders")
+            end
+          end
+        end
       end
-      # rubocop:enable Metrics/ClassLength
     end
   end
 end

data/lib/DhanHQ/ws/orders/connection.rb

@@ -86,7 +86,8 @@ module DhanHQ
               Secret: cfg.partner_secret
             }
           else
-            token = cfg.access_token or raise "DhanHQ.access_token not set"
+            token = cfg.resolved_access_token
+            raise DhanHQ::AuthenticationError, "Missing access token" if token.nil? || token.empty?
             cid = cfg.client_id or raise "DhanHQ.client_id not set"
             payload = {
               LoginReq: { MsgCode: 42, ClientId: cid, Token: token },

data/lib/DhanHQ/ws/orders.rb

@@ -10,7 +10,8 @@ module DhanHQ
     module Orders
       ##
       # Connect to order updates WebSocket with a simple callback
-      # @param block [Proc] Callback for order updates
+      #
+      # @yield [OrderUpdate] Yields order update objects when received
       # @return [Client] WebSocket client instance
       def self.connect(&)
         Client.new.start.on(:update, &)

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: DhanHQ
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: 2.2.0
 platform: ruby
 authors:
 - Shubham Taywade
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,20 +163,31 @@ files:
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CODE_REVIEW_ISSUES.md
+- FIXES_APPLIED.md
 - GUIDE.md
 - LICENSE.txt
 - README.md
 - README1.md
+- RELEASING.md
+- REVIEW_SUMMARY.md
 - Rakefile
 - TAGS
 - TODO-1.md
 - TODO.md
+- VERSION_UPDATE.md
 - app/services/live/order_update_guard_support.rb
 - app/services/live/order_update_hub.rb
 - app/services/live/order_update_persistence_support.rb
 - config/initializers/order_update_hub.rb
+- core
 - diagram.html
 - diagram.md
+- docs/AUTHENTICATION.md
+- docs/DATA_API_PARAMETERS.md
+- docs/PR_2.2.0.md
+- docs/RELEASE_GUIDE.md
+- docs/TESTING_GUIDE.md
 - docs/live_order_updates.md
 - docs/rails_integration.md
 - docs/rails_websocket_integration.md
@@ -200,7 +212,6 @@ files:
 - lib/DhanHQ/contracts/instrument_list_contract.rb
 - lib/DhanHQ/contracts/margin_calculator_contract.rb
 - lib/DhanHQ/contracts/modify_order_contract.rb
-- lib/DhanHQ/contracts/modify_order_contract_copy.rb
 - lib/DhanHQ/contracts/option_chain_contract.rb
 - lib/DhanHQ/contracts/order_contract.rb
 - lib/DhanHQ/contracts/place_order_contract.rb
@@ -312,6 +323,7 @@ metadata:
   source_code_uri: https://github.com/shubhamtaywade82/dhanhq-client
   changelog_uri: https://github.com/shubhamtaywade82/dhanhq-client/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -319,14 +331,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: DhanHQ is a simple CLI for DhanHQ API.
 test_files: []

data/lib/DhanHQ/contracts/modify_order_contract_copy.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-module DhanHQ
-  module Contracts
-    # Validation contract for modifying an existing order via Dhanhq's API.
-    #
-    # This contract validates input parameters for the Modify Order API,
-    # ensuring that all required fields are provided and optional fields follow
-    # the correct constraints. It also applies custom validation rules based on
-    # the type of order.
-    #
-    # Example usage:
-    #   contract = Dhanhq::Contracts::ModifyOrderContract.new
-    #   result = contract.call(
-    #     dhanClientId: "123456",
-    #     orderId: "1001",
-    #     orderType: "STOP_LOSS",
-    #     legName: "ENTRY_LEG",
-    #     quantity: 10,
-    #     price: 150.0,
-    #     triggerPrice: 140.0,
-    #     validity: "DAY"
-    #   )
-    #   result.success? # => true or false
-    #
-    # @see https://dhanhq.co/docs/v2/ Dhanhq API Documentation
-    class ModifyOrderContract < BaseContract
-      # Parameters and validation rules for the Modify Order request.
-      #
-      # @!attribute [r] orderId
-      #   @return [String] Required. Unique identifier for the order to be modified.
-      # @!attribute [r] orderType
-      #   @return [String] Required. Type of the order.
-      #     Must be one of: LIMIT, MARKET, STOP_LOSS, STOP_LOSS_MARKET.
-      # @!attribute [r] legName
-      #   @return [String] Optional. Leg name for complex orders.
-      #     Must be one of: ENTRY_LEG, TARGET_LEG, STOP_LOSS_LEG, NA.
-      # @!attribute [r] quantity
-      #   @return [Integer] Required. Quantity to be modified, must be greater than 0.
-      # @!attribute [r] price
-      #   @return [Float] Optional. Price to be modified, must be greater than 0 if provided.
-      # @!attribute [r] disclosedQuantity
-      #   @return [Integer] Optional. Disclosed quantity, must be >= 0 if provided.
-      # @!attribute [r] triggerPrice
-      #   @return [Float] Optional. Trigger price for stop-loss orders, must be greater than 0 if provided.
-      # @!attribute [r] validity
-      #   @return [String] Required. Validity of the order.
-      #     Must be one of: DAY, IOC, GTC, GTD.
-      params do
-        required(:orderId).filled(:string)
-        required(:orderType).filled(:string, included_in?: %w[LIMIT MARKET STOP_LOSS STOP_LOSS_MARKET])
-        optional(:legName).maybe(:string, included_in?: %w[ENTRY_LEG TARGET_LEG STOP_LOSS_LEG NA])
-        required(:quantity).filled(:integer, gt?: 0)
-        optional(:price).maybe(:float, gt?: 0)
-        optional(:disclosedQuantity).maybe(:integer, gteq?: 0)
-        optional(:triggerPrice).maybe(:float, gt?: 0)
-        required(:validity).filled(:string, included_in?: %w[DAY IOC GTC GTD])
-      end
-
-      # Custom validation to ensure a trigger price is provided for stop-loss orders.
-      #
-      # @example Invalid stop-loss order:
-      #   orderType: "STOP_LOSS", triggerPrice: nil
-      #   => Adds failure message "is required for orderType STOP_LOSS or STOP_LOSS_MARKET".
-      #
-      # @param triggerPrice [Float] The price at which the order will be triggered.
-      # @param orderType [String] The type of the order.
-      rule(:triggerPrice, :orderType) do
-        if values[:orderType].start_with?("STOP_LOSS") && !values[:triggerPrice]
-          key(:triggerPrice).failure("is required for orderType STOP_LOSS or STOP_LOSS_MARKET")
-        end
-      end
-
-      # Custom validation to ensure a leg name is provided for CO or BO order types.
-      #
-      # @example Invalid CO order:
-      #   orderType: "CO", legName: nil
-      #   => Adds failure message "is required for orderType CO or BO".
-      #
-      # @param legName [String] The leg name of the order.
-      # @param orderType [String] The type of the order.
-      rule(:legName, :orderType) do
-        if %w[CO BO].include?(values[:orderType]) && !values[:legName]
-          key(:legName).failure("is required for orderType CO or BO")
-        end
-      end
-
-      # Custom validation to ensure the price is valid if provided.
-      #
-      # @example Invalid price:
-      #   price: 0
-      #   => Adds failure message "must be greater than 0 if provided".
-      #
-      # @param price [Float] The price of the order.
-      rule(:price) do
-        key(:price).failure("must be greater than 0 if provided") if values[:price].nil? || values[:price] <= 0
-      end
-    end
-  end
-end