DhanHQ 2.5.0 → 2.6.1

data/lib/DhanHQ/resources/orders.rb

@@ -1,70 +1,70 @@
 # frozen_string_literal: true
 
 module DhanHQ
-  # REST API wrappers grouped by resource type.
   module Resources
-    # Resource client for managing equity and F&O orders.
+    # Handles order placement, modification, and cancellation
     class Orders < BaseAPI
-      # Orders are routed through the trading API tier.
       API_TYPE = :order_api
-      # Base path for order endpoints.
       HTTP_PATH = "/v2/orders"
 
-      # Retrieve all orders for the current trading day.
-      #
-      # @return [Array<Hash>]
-      def all
-        get("")
-      end
+      # --------------------------------------------------
+      # PUBLIC API
+      # --------------------------------------------------
 
-      # Places a new order using the provided payload.
-      #
-      # @param params [Hash]
-      # @return [Hash]
       def create(params)
+        validate_place_order!(params)
         post("", params: params)
       end
 
-      # Fetches a single order by broker order id.
-      #
-      # @param order_id [String]
-      # @return [Hash]
-      def find(order_id)
-        get("/#{order_id}")
-      end
-
-      # Modifies an existing order.
-      #
-      # @param order_id [String]
-      # @param params [Hash]
-      # @return [Hash]
       def update(order_id, params)
+        validate_modify_order!(params.merge(order_id: order_id))
         put("/#{order_id}", params: params)
       end
 
-      # Cancels an existing order.
-      #
-      # @param order_id [String]
-      # @return [Hash]
+      def slicing(params)
+        validate_place_order!(params)
+        post("/slicing", params: params)
+      end
+
       def cancel(order_id)
         delete("/#{order_id}")
       end
 
-      # Places a slicing order request.
-      #
-      # @param params [Hash]
-      # @return [Hash]
-      def slicing(params)
-        post("/slicing", params: params)
+      def all
+        get("")
+      end
+
+      def find(order_id)
+        get("/#{order_id}")
       end
 
-      # Retrieve an order by client-supplied correlation id.
-      #
-      # @param correlation_id [String]
-      # @return [Hash]
       def by_correlation(correlation_id)
         get("/external/#{correlation_id}")
       end
+
+      # --------------------------------------------------
+      # VALIDATION LAYER
+      # --------------------------------------------------
+
+      private
+
+      def validate_place_order!(params)
+        result = Contracts::PlaceOrderContract.new.call(normalize_keys_for_validation(params))
+        raise_validation_error!(result) unless result.success?
+      end
+
+      def validate_modify_order!(params)
+        result = Contracts::ModifyOrderContract.new.call(normalize_keys_for_validation(params))
+        raise_validation_error!(result) unless result.success?
+      end
+
+      def normalize_keys_for_validation(params)
+        snake_case(params)
+      end
+
+      def raise_validation_error!(result)
+        raise DhanHQ::Error, "Validation Error: #{result.errors.to_h}"
+      end
     end
   end
 end

data/lib/DhanHQ/version.rb

@@ -2,5 +2,5 @@
 
 module DhanHQ
   # Semantic version of the DhanHQ client gem.
-  VERSION = "2.5.0"
+  VERSION = "2.6.1"
 end

data/lib/DhanHQ/ws/cmd_bus.rb

@@ -6,7 +6,7 @@ module DhanHQ
     # connection is ready to send them.
     class CmdBus
       # Represents a subscription command queued for execution.
-      Command = Struct.new(:op, :payload, keyword_init: true)
+      Command = Struct.new(:op, :payload)
 
       def initialize
         @q = Queue.new

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

@@ -201,17 +201,17 @@ module DhanHQ
         # @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"
+          when DhanHQ::Constants::OrderStatus::TRANSIT
             emit(:order_transit, order_update)
-          when "PENDING"
+          when DhanHQ::Constants::OrderStatus::PENDING
             emit(:order_pending, order_update)
-          when "REJECTED"
+          when DhanHQ::Constants::OrderStatus::REJECTED
             emit(:order_rejected, order_update)
-          when "CANCELLED"
+          when DhanHQ::Constants::OrderStatus::CANCELLED
             emit(:order_cancelled, order_update)
-          when "TRADED"
+          when DhanHQ::Constants::OrderStatus::TRADED
             emit(:order_traded, order_update)
-          when "EXPIRED"
+          when DhanHQ::Constants::OrderStatus::EXPIRED
             emit(:order_expired, order_update)
           end
         end

data/lib/DhanHQ/ws/singleton_lock.rb

@@ -14,7 +14,8 @@ module DhanHQ
         key = Digest::SHA256.hexdigest("#{client_id}:#{token}")[0, 12]
         @path = File.expand_path("tmp/dhanhq_ws_#{key}.lock", Dir.pwd)
         FileUtils.mkdir_p(File.dirname(@path))
-        @fh = File.open(@path, File::RDWR | File::CREAT, 0o644)
+        # Lock file must stay open until release!; block form would close it and release the lock.
+        @fh = File.open(@path, File::RDWR | File::CREAT, 0o644) # rubocop:disable Style/FileOpen
       end
 
       # Attempts to acquire the lock for the current process.

data/lib/dhanhq/analysis/options_buying_advisor.rb

@@ -91,7 +91,7 @@ module DhanHQ
 
         # Use OptionChain model: pick nearest/next expiry and fetch chain
         sid = @data.dig(:meta, :security_id)
-        seg = @data.dig(:meta, :exchange_segment) || "IDX_I"
+        seg = @data.dig(:meta, :exchange_segment) || DhanHQ::Constants::ExchangeSegment::IDX_I
         return unless sid && seg
 
         expiries = DhanHQ::Models::OptionChain.fetch_expiry_list(underlying_scrip: sid.to_i, underlying_seg: seg)
@@ -128,7 +128,7 @@ module DhanHQ
       end
 
       def index_instrument?(meta)
-        meta[:instrument].to_s == "INDEX" || meta[:exchange_segment].to_s == "IDX_I"
+        meta[:instrument].to_s == DhanHQ::Constants::InstrumentType::INDEX || meta[:exchange_segment].to_s == DhanHQ::Constants::ExchangeSegment::IDX_I
       end
 
       def select_strike(side:, moneyness:)

data/lib/rubocop/cop/dhanhq/use_constants.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+module RuboCop
+  module Cop
+    module DhanHQ
+      # Enforces the use of `DhanHQ::Constants` instead of hardcoded strings.
+      #
+      # @example
+      #   # bad
+      #   transaction_type: "BUY"
+      #
+      #   # good
+      #   transaction_type: DhanHQ::Constants::TransactionType::BUY
+      class UseConstants < Base
+        extend AutoCorrector
+
+        MSG = "Use `%<constant>s` instead of hardcoded string `%<string>s`."
+
+        # Unambiguous constants — flagged in any non-key string context.
+        CONSTANTS_MAP = {
+          "SELL" => "DhanHQ::Constants::TransactionType::SELL",
+          "BUY" => "DhanHQ::Constants::TransactionType::BUY",
+          "LIMIT" => "DhanHQ::Constants::OrderType::LIMIT",
+          "MARKET" => "DhanHQ::Constants::OrderType::MARKET",
+          "STOP_LOSS" => "DhanHQ::Constants::OrderType::STOP_LOSS",
+          "STOP_LOSS_MARKET" => "DhanHQ::Constants::OrderType::STOP_LOSS_MARKET",
+          "IOC" => "DhanHQ::Constants::Validity::IOC",
+          "DAY" => "DhanHQ::Constants::Validity::DAY",
+          "TRANSIT" => "DhanHQ::Constants::OrderStatus::TRANSIT",
+          "PENDING" => "DhanHQ::Constants::OrderStatus::PENDING",
+          "CLOSED" => "DhanHQ::Constants::OrderStatus::CLOSED",
+          "TRIGGERED" => "DhanHQ::Constants::OrderStatus::TRIGGERED",
+          "REJECTED" => "DhanHQ::Constants::OrderStatus::REJECTED",
+          "CANCELLED" => "DhanHQ::Constants::OrderStatus::CANCELLED",
+          "PART_TRADED" => "DhanHQ::Constants::OrderStatus::PART_TRADED",
+          "TRADED" => "DhanHQ::Constants::OrderStatus::TRADED",
+          "EXPIRED" => "DhanHQ::Constants::OrderStatus::EXPIRED",
+          "MODIFIED" => "DhanHQ::Constants::OrderStatus::MODIFIED",
+          "PRE_OPEN" => "DhanHQ::Constants::AmoTime::PRE_OPEN",
+          "OPEN_30" => "DhanHQ::Constants::AmoTime::OPEN_30",
+          "OPEN_60" => "DhanHQ::Constants::AmoTime::OPEN_60",
+          "FUTIDX" => "DhanHQ::Constants::InstrumentType::FUTIDX",
+          "OPTIDX" => "DhanHQ::Constants::InstrumentType::OPTIDX",
+          "EQUITY" => "DhanHQ::Constants::InstrumentType::EQUITY",
+          "FUTSTK" => "DhanHQ::Constants::InstrumentType::FUTSTK",
+          "OPTSTK" => "DhanHQ::Constants::InstrumentType::OPTSTK",
+          "FUTCOM" => "DhanHQ::Constants::InstrumentType::FUTCOM",
+          "OPTFUT" => "DhanHQ::Constants::InstrumentType::OPTFUT",
+          "FUTCUR" => "DhanHQ::Constants::InstrumentType::FUTCUR",
+          "OPTCUR" => "DhanHQ::Constants::InstrumentType::OPTCUR",
+          "CALL" => "DhanHQ::Constants::OptionType::CALL",
+          "PUT" => "DhanHQ::Constants::OptionType::PUT",
+          "ENTRY_LEG" => "DhanHQ::Constants::LegName::ENTRY_LEG",
+          "TARGET_LEG" => "DhanHQ::Constants::LegName::TARGET_LEG",
+          "STOP_LOSS_LEG" => "DhanHQ::Constants::LegName::STOP_LOSS_LEG",
+          "SINGLE" => "DhanHQ::Constants::OrderFlag::SINGLE",
+          "OCO" => "DhanHQ::Constants::OrderFlag::OCO",
+          "LONG" => "DhanHQ::Constants::PositionType::LONG",
+          "SHORT" => "DhanHQ::Constants::PositionType::SHORT",
+          "TECHNICAL_WITH_VALUE" => "DhanHQ::Constants::ComparisonType::TECHNICAL_WITH_VALUE",
+          "TECHNICAL_WITH_INDICATOR" => "DhanHQ::Constants::ComparisonType::TECHNICAL_WITH_INDICATOR",
+          "TECHNICAL_WITH_CLOSE" => "DhanHQ::Constants::ComparisonType::TECHNICAL_WITH_CLOSE",
+          "PRICE_WITH_VALUE" => "DhanHQ::Constants::ComparisonType::PRICE_WITH_VALUE",
+          "EMA_200" => "DhanHQ::Constants::IndicatorName::EMA_200",
+          "BB_UPPER" => "DhanHQ::Constants::IndicatorName::BB_UPPER",
+          "BB_LOWER" => "DhanHQ::Constants::IndicatorName::BB_LOWER",
+          "RSI_14" => "DhanHQ::Constants::IndicatorName::RSI_14",
+          "ATR_14" => "DhanHQ::Constants::IndicatorName::ATR_14",
+          "STOCHASTIC" => "DhanHQ::Constants::IndicatorName::STOCHASTIC",
+          "STOCHRSI_14" => "DhanHQ::Constants::IndicatorName::STOCHRSI_14",
+          "MACD_26" => "DhanHQ::Constants::IndicatorName::MACD_26",
+          "MACD_12" => "DhanHQ::Constants::IndicatorName::MACD_12",
+          "MACD_HIST" => "DhanHQ::Constants::IndicatorName::MACD_HIST",
+          "SMA_5" => "DhanHQ::Constants::IndicatorName::SMA_5",
+          "SMA_10" => "DhanHQ::Constants::IndicatorName::SMA_10",
+          "SMA_20" => "DhanHQ::Constants::IndicatorName::SMA_20",
+          "SMA_50" => "DhanHQ::Constants::IndicatorName::SMA_50",
+          "SMA_100" => "DhanHQ::Constants::IndicatorName::SMA_100",
+          "SMA_200" => "DhanHQ::Constants::IndicatorName::SMA_200",
+          "EMA_5" => "DhanHQ::Constants::IndicatorName::EMA_5",
+          "EMA_10" => "DhanHQ::Constants::IndicatorName::EMA_10",
+          "EMA_20" => "DhanHQ::Constants::IndicatorName::EMA_20",
+          "EMA_50" => "DhanHQ::Constants::IndicatorName::EMA_50",
+          "EMA_100" => "DhanHQ::Constants::IndicatorName::EMA_100",
+          "GREATER_THAN_EQUAL" => "DhanHQ::Constants::Operator::GREATER_THAN_EQUAL",
+          "LESS_THAN_EQUAL" => "DhanHQ::Constants::Operator::LESS_THAN_EQUAL",
+          "EQUAL" => "DhanHQ::Constants::Operator::EQUAL",
+          "NOT_EQUAL" => "DhanHQ::Constants::Operator::NOT_EQUAL",
+          "CROSSING_UP" => "DhanHQ::Constants::Operator::CROSSING_UP",
+          "CROSSING_DOWN" => "DhanHQ::Constants::Operator::CROSSING_DOWN",
+          "CROSSING_ANY_SIDE" => "DhanHQ::Constants::Operator::CROSSING_ANY_SIDE",
+          "GREATER_THAN" => "DhanHQ::Constants::Operator::GREATER_THAN",
+          "LESS_THAN" => "DhanHQ::Constants::Operator::LESS_THAN",
+          "ACTIVE" => "DhanHQ::Constants::TriggerStatus::ACTIVE",
+          "IDX_I" => "DhanHQ::Constants::ExchangeSegment::IDX_I",
+          "NSE_EQ" => "DhanHQ::Constants::ExchangeSegment::NSE_EQ",
+          "NSE_FNO" => "DhanHQ::Constants::ExchangeSegment::NSE_FNO",
+          "NSE_CURRENCY" => "DhanHQ::Constants::ExchangeSegment::NSE_CURRENCY",
+          "NSE_COMM" => "DhanHQ::Constants::ExchangeSegment::NSE_COMM",
+          "BSE_EQ" => "DhanHQ::Constants::ExchangeSegment::BSE_EQ",
+          "MCX_COMM" => "DhanHQ::Constants::ExchangeSegment::MCX_COMM",
+          "BSE_CURRENCY" => "DhanHQ::Constants::ExchangeSegment::BSE_CURRENCY",
+          "BSE_FNO" => "DhanHQ::Constants::ExchangeSegment::BSE_FNO",
+          "DH-910" => "DhanHQ::Constants::TradingErrorCode::OTHERS",
+          "DH-901" => "DhanHQ::Constants::TradingErrorCode::INVALID_AUTHENTICATION",
+          "DH-902" => "DhanHQ::Constants::TradingErrorCode::INVALID_ACCESS",
+          "DH-903" => "DhanHQ::Constants::TradingErrorCode::USER_ACCOUNT",
+          "DH-904" => "DhanHQ::Constants::TradingErrorCode::RATE_LIMIT",
+          "DH-905" => "DhanHQ::Constants::TradingErrorCode::INPUT_EXCEPTION",
+          "DH-906" => "DhanHQ::Constants::TradingErrorCode::ORDER_ERROR",
+          "DH-907" => "DhanHQ::Constants::TradingErrorCode::DATA_ERROR",
+          "DH-908" => "DhanHQ::Constants::TradingErrorCode::INTERNAL_SERVER_ERROR",
+          "DH-909" => "DhanHQ::Constants::TradingErrorCode::NETWORK_ERROR",
+          "CNC" => "DhanHQ::Constants::ProductType::CNC",
+          "INTRADAY" => "DhanHQ::Constants::ProductType::INTRADAY",
+          "MARGIN" => "DhanHQ::Constants::ProductType::MARGIN",
+          "MTF" => "DhanHQ::Constants::ProductType::MTF",
+          "CO" => "DhanHQ::Constants::ProductType::CO",
+          "BO" => "DhanHQ::Constants::ProductType::BO"
+        }.freeze
+
+        # Ambiguous constants — only flagged when the string is the VALUE side of a hash pair.
+        # These strings also appear in natural language contexts (error messages, log output).
+        AMBIGUOUS_CONSTANTS = {
+          "OPEN" => "DhanHQ::Constants::AmoTime::OPEN",
+          "INDEX" => "DhanHQ::Constants::InstrumentType::INDEX"
+        }.freeze
+
+        def on_str(node)
+          value = node.value
+          return unless value.length >= 2
+          return if value.include?(" ")
+
+          parent = node.parent
+          return unless parent
+
+          # Skip hash keys
+          return if parent.pair_type? && parent.key == node
+
+          # Skip typical ignored methods
+          return if parent.send_type? && %i[require require_relative puts print warn raise fail
+                                            class_eval instance_eval].include?(parent.method_name)
+
+          # Skip %w[] / %i[] array literals
+          in_percent_array = parent.array_type? && parent.loc.begin&.source&.start_with?("%w", "%W", "%i", "%I")
+          return if in_percent_array
+
+          # Check unambiguous constants first
+          if CONSTANTS_MAP.key?(value)
+            constant_path = CONSTANTS_MAP[value]
+            add_offense(node, message: format(MSG, constant: constant_path, string: value)) do |corrector|
+              corrector.replace(node, constant_path)
+            end
+            return
+          end
+
+          # Ambiguous constants — only flag when the node is the value side of a hash pair
+          return unless AMBIGUOUS_CONSTANTS.key?(value)
+          return unless parent.pair_type? && parent.value == node
+
+          constant_path = AMBIGUOUS_CONSTANTS[value]
+          add_offense(node, message: format(MSG, constant: constant_path, string: value)) do |corrector|
+            corrector.replace(node, constant_path)
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: DhanHQ
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.1
 platform: ruby
 authors:
 - Shubham Taywade
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-21 00:00:00.000000000 Z
+date: 2026-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,7 +178,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: DhanHQ is a simple CLI for DhanHQ API.
+description: A pure-Ruby client wrapping the DhanHQ v2 REST and WebSocket API. Provides
+  typed model classes, dry-validation contracts, a token-bucket rate limiter, and
+  WebSocket streaming for live market data and order updates.
 email:
 - shubhamtaywade82@gmail.com
 executables:
@@ -200,40 +202,29 @@ files:
 - 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/API_DOCS_GAPS.md
 - docs/API_VERIFICATION.md
 - docs/ARCHIVE_README.md
 - docs/AUTHENTICATION.md
 - docs/CONFIGURATION.md
+- docs/CONSTANTS_REFERENCE.md
 - docs/DATA_API_PARAMETERS.md
-- docs/PR_2.2.0.md
+- docs/LIVE_ORDER_UPDATES.md
+- docs/RAILS_INTEGRATION.md
+- docs/RAILS_WEBSOCKET_INTEGRATION.md
 - docs/RELEASE_GUIDE.md
+- docs/STANDALONE_RUBY_WEBSOCKET_INTEGRATION.md
 - docs/SUPER_ORDERS.md
+- docs/TECHNICAL_ANALYSIS.md
 - docs/TESTING_GUIDE.md
 - docs/TROUBLESHOOTING.md
+- docs/WEBSOCKET_INTEGRATION.md
 - docs/WEBSOCKET_PROTOCOL.md
-- docs/live_order_updates.md
-- docs/rails_integration.md
-- docs/rails_websocket_integration.md
-- docs/standalone_ruby_websocket_integration.md
-- docs/technical_analysis.md
-- docs/websocket_integration.md
-- examples/comprehensive_websocket_examples.rb
-- examples/instrument_finder_test.rb
-- examples/live_order_updates.rb
-- examples/market_depth_example.rb
-- examples/market_feed_example.rb
-- examples/order_update_example.rb
-- examples/trading_fields_example.rb
 - exe/DhanHQ
 - lib/DhanHQ/auth.rb
 - lib/DhanHQ/auth/token_generator.rb
@@ -244,19 +235,23 @@ files:
 - lib/DhanHQ/constants.rb
 - lib/DhanHQ/contracts/alert_order_contract.rb
 - lib/DhanHQ/contracts/base_contract.rb
+- lib/DhanHQ/contracts/edis_contract.rb
 - lib/DhanHQ/contracts/expired_options_data_contract.rb
 - lib/DhanHQ/contracts/historical_data_contract.rb
 - lib/DhanHQ/contracts/instrument_list_contract.rb
 - lib/DhanHQ/contracts/margin_calculator_contract.rb
 - lib/DhanHQ/contracts/modify_order_contract.rb
+- lib/DhanHQ/contracts/multi_scrip_margin_calc_request_contract.rb
 - lib/DhanHQ/contracts/option_chain_contract.rb
 - lib/DhanHQ/contracts/order_contract.rb
 - lib/DhanHQ/contracts/place_order_contract.rb
+- lib/DhanHQ/contracts/pnl_based_exit_contract.rb
 - lib/DhanHQ/contracts/position_conversion_contract.rb
 - lib/DhanHQ/contracts/slice_order_contract.rb
 - lib/DhanHQ/contracts/trade_by_order_id_contract.rb
 - lib/DhanHQ/contracts/trade_contract.rb
 - lib/DhanHQ/contracts/trade_history_contract.rb
+- lib/DhanHQ/contracts/user_ip_contract.rb
 - lib/DhanHQ/core/auth_api.rb
 - lib/DhanHQ/core/base_api.rb
 - lib/DhanHQ/core/base_model.rb
@@ -272,6 +267,7 @@ files:
 - lib/DhanHQ/helpers/validation_helper.rb
 - lib/DhanHQ/json_loader.rb
 - lib/DhanHQ/models/alert_order.rb
+- lib/DhanHQ/models/concerns/api_response_handler.rb
 - lib/DhanHQ/models/edis.rb
 - lib/DhanHQ/models/expired_options_data.rb
 - lib/DhanHQ/models/forever_order.rb
@@ -354,6 +350,7 @@ files:
 - lib/dhanhq/analysis/multi_timeframe_analyzer.rb
 - lib/dhanhq/analysis/options_buying_advisor.rb
 - lib/dhanhq/contracts/options_buying_advisor_contract.rb
+- lib/rubocop/cop/dhanhq/use_constants.rb
 - lib/ta.rb
 - lib/ta/candles.rb
 - lib/ta/fetcher.rb
@@ -389,5 +386,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: DhanHQ is a simple CLI for DhanHQ API.
+summary: Ruby client for the DhanHQ v2 REST and WebSocket API (NSE/BSE).
 test_files: []

data/TODO-1.md

@@ -1,14 +0,0 @@
-# TODO List
-
-- [x] Wire `DhanHQ::Models::Order.place` to the resource’s `create` endpoint so order placement stops raising `NoMethodError` (`lib/DhanHQ/models/order.rb:73`, `lib/DhanHQ/resources/orders.rb:14`).
-- [x] Align `Order#cancel` with `DhanHQ::Resources::Orders#cancel` to restore cancellation support (`lib/DhanHQ/models/order.rb:120`, `lib/DhanHQ/resources/orders.rb:26`).
-- [x] Rework `Order#modify` to send a proper payload and capture the response instead of delegating to the broken generic update flow (`lib/DhanHQ/models/order.rb:99`, `lib/DhanHQ/core/base_model.rb:155`).
-- [x] Repair or replace the shared CRUD helpers in `BaseModel` so URL construction and response handling behave (`lib/DhanHQ/core/base_model.rb:120`, `lib/DhanHQ/core/base_model.rb:129`, `lib/DhanHQ/core/base_model.rb:155`).
-- [x] Make `BaseModel#save!` raise a real exception type (e.g. `DhanHQ::Error`) to avoid the current `TypeError` (`lib/DhanHQ/core/base_model.rb:165`).
-- [x] Strip read-only attributes before posting modify requests to pass API validation (`lib/DhanHQ/models/order.rb:166`, `lib/DhanHQ/core/base_model.rb:197`).
-- [x] Require `fileutils` in the WebSocket singleton lock so acquiring the lock no longer raises (`lib/DhanHQ/ws/singleton_lock.rb:11`).
-- [x] Implement EDIS and kill-switch endpoints surfaced in the OpenAPI spec so the client can call `/edis/bulkform`, `/edis/form`, `/edis/inquire/{isin}`, `/edis/tpin`, and `/killswitch` (`/home/nemesis/dhanhq-bundled.json:827`, `/home/nemesis/dhanhq-bundled.json:873`, `/home/nemesis/dhanhq-bundled.json:949`).
-- [x] Correct `ForeverOrders#all` to hit `/v2/forever/orders` instead of the undocumented `/v2/forever/all` path (`lib/DhanHQ/resources/forever_orders.rb:9`, `/home/nemesis/dhanhq-bundled.json:578`).
-- [x] Run the existing `MarginCalculatorContract` before posting to `/margincalculator` so required fields like `transactionType` and `productType` are enforced client-side (`lib/DhanHQ/models/margin.rb:23`, `lib/DhanHQ/contracts/margin_calculator_contract.rb:5`).
-- [ ] Validate slice-order payloads with `SliceOrderContract` to uphold STOP_LOSS requirements before calling `/orders/slicing` (`lib/DhanHQ/models/order.rb:217`, `lib/DhanHQ/contracts/slice_order_contract.rb:30`, `/home/nemesis/dhanhq-bundled.json:234`).
-- [x] Add a contract-backed validation for `Position.convert` so `PositionConversionRequest` fields like `fromProductType` and `convertQty` are checked prior to hitting `/positions/convert` (`lib/DhanHQ/models/position.rb:39`, `/home/nemesis/dhanhq-bundled.json:1391`).

data/TODO.md

@@ -1,127 +0,0 @@
-Below are several suggestions and improvements you can consider to further enhance your gem’s structure, error handling, validations, and overall design:
-
----
-
-### **1. Decouple HTTP/Resource Handling from Models**
-
-- **Inject the API instance:**
-  Instead of having your BaseModel inherit from or tightly couple to BaseAPI, you already moved to instantiating a shared API object via the `api` method. This is good for testing and future flexibility. Consider allowing dependency injection so that in tests you can supply a mock client.
-
-- **Separate Resource Objects:**
-  Create separate “Resource” classes for each endpoint (e.g. Orders, Funds, MarketFeed, etc.) that are solely responsible for forming the correct URL and HTTP call. Then, your models (Order, Funds, etc.) become thin wrappers on top of these resources.
-
----
-
-### **2. Improved Error Handling**
-
-- **Consistent Error Hierarchy:**
-  You already have a structured set of custom errors. Ensure that all API responses are wrapped in a uniform error response. For instance, for network errors, consider implementing a retry mechanism for transient errors (such as timeouts or 429 responses).
-
-- **Retry Mechanism:**
-  Enhance your Client by adding an optional retry strategy (with exponential backoff) for cases when a request fails due to rate limiting or temporary network issues.
-
-- **Detailed Logging:**
-  Enable more granular logging (perhaps controlled via configuration) to help troubleshoot errors without exposing sensitive information.
-
----
-
-### **3. Enhanced Validations**
-
-- **Centralize Contracts:**
-  Use your `BaseContract` as a foundation for all contracts so that common rules and messages are shared. Consider adding custom predicates if you need more complex business rules.
-  For example, you can write a custom predicate for “valid_order_quantity” that could check against exchange limits.
-
-- **Error Messages & Localization:**
-  Consider standardizing error messages across contracts so that errors returned by your gem are predictable. If needed, use a localization mechanism to map raw error keys to user-friendly messages.
-
-- **Use Dry-Struct (Optional):**
-  If you want stronger typing and immutability for your models, you might consider using [dry-struct](https://dry-rb.org/gems/dry-struct/) in combination with dry-validation. This can help enforce attribute types and reduce runtime errors.
-
----
-
-### **4. Model Improvements and Convenience Methods**
-
-- **Dynamic Attribute Getters/Setters:**
-  Your current approach to dynamically assign attribute getters is good. You might consider also generating setters if you want to allow updating the local object state before pushing an update to the API.
-
-- **CRUD Methods Consistency:**
-  Ensure that your instance methods like `update`, `delete`, `refresh`, etc., always return either a new instance of the model (with updated values) or a well-formed error object. This will make it easier for users to chain operations.
-
-- **Merge Updated Attributes Correctly:**
-  In your `modify` method (for orders, for instance), make sure you correctly merge the existing attributes with the new ones before issuing the PUT request. Currently, there’s a commented line and then an immediate call to `update(attributes)`—this should be updated to use the merged `updated_params`.
-
-- **Caching or Memoization:**
-  If your API endpoints don’t change frequently (e.g., for retrieving configuration or instruments), consider caching responses to minimize API calls.
-
----
-
-### **5. Testing & VCR**
-
-- **VCR Cassette Management:**
-  Ensure that your VCR cassettes capture both successful and error responses. When you need to simulate scenarios (e.g., update order, cancellation), manually edit the cassette files to reflect those states if the real API cannot produce them reliably.
-
-- **Spec Coverage:**
-  Write comprehensive specs for each model that exercises both the “happy path” and error cases. For instance, ensure that Order.create returns an order with the proper attributes, and that Order.update merges new attributes as expected.
-
----
-
-### **6. Configuration Improvements**
-
-- **Global Configuration Object:**
-  Continue iterating on the existing configuration helpers while keeping `DhanHQ.configure_with_env` as the primary entrypoint. Provide any additional toggles by reading from ENV so docs can focus on the single bootstrap path.
-
----
-
-### **7. Overall Architecture and Documentation**
-
-- **Document Model Methods:**
-  Ensure that each model (Order, Funds, OptionChain, etc.) is well documented. Explain the expected inputs/outputs and any side effects.
-
-- **Separation of Concerns:**
-  Keep your gem’s responsibilities clear:
-
-  - **Client:** Low-level HTTP calls with error handling and rate limiting.
-  - **Resources:** Form URLs and endpoint-specific logic.
-  - **Models:** Map resource data to business objects and provide CRUD operations with validation.
-  - **Contracts:** Define dry-validation contracts for input validation.
-
-- **Extensibility:**
-  Consider ways to allow users to extend models or override default behavior. For instance, provide hooks (callbacks) before or after an update or create operation.
-
----
-
-### **Example of a Revised Modify Method in Order Model**
-
-Here’s a small snippet that shows how you might update the `modify` method in the Order model to merge attributes properly:
-
-```ruby
-def modify(new_params)
-  raise "Order ID is required to modify an order" unless id
-
-  # Merge current attributes with new ones
-  updated_params = attributes.merge(new_params)
-  validate_params!(updated_params, DhanHQ::Contracts::ModifyOrderContract)
-
-  # Perform the PUT request with merged parameters
-  response = self.class.api.put("#{self.class.resource_path}/#{id}", params: updated_params)
-
-  # If the response indicates a transitional status (e.g., "TRANSIT"), re-fetch the order
-  if success_response?(response) && response[:orderStatus] == "TRANSIT"
-    return self.class.find(id)
-  end
-
-  DhanHQ::ErrorObject.new(response)
-end
-```
-
----
-
-### **Conclusion**
-
-Implementing these improvements will result in a more robust, testable, and maintainable gem. Enhancing error handling, validations, and separation of concerns not only eases future modifications but also improves the overall developer experience when using the gem.
-
-Feel free to ask if you’d like more details or examples on any of these suggestions!
-
-PROGRESS:
-
-1. OptionChain working