coindcx-client 0.1.0

data/spec/ws/socket_io_client_spec.rb

@@ -0,0 +1,229 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe CoinDCX::WS::SocketIOClient do
+  let(:configuration) do
+    CoinDCX::Configuration.new.tap do |config|
+      config.api_key = "api-key"
+      config.api_secret = "api-secret"
+      config.socket_reconnect_attempts = 2
+      config.socket_reconnect_interval = 0.01
+      config.socket_heartbeat_interval = 0.5
+      config.socket_liveness_timeout = 1.0
+    end
+  end
+
+  let(:backend) { instance_double("SocketBackend") }
+  let(:sleeper) { class_double(Kernel, sleep: nil) }
+  # Stubbed sleeper.sleep returns immediately; a real heartbeat Thread would tight-loop on the GVL and
+  # starve examples. Capture the loop body; drive liveness via ConnectionManager#check_liveness! in specs.
+  let(:captured_heartbeat_blocks) { [] }
+  let(:thread_factory_without_run) do
+    lambda do |&block|
+      captured_heartbeat_blocks << block
+      instance_double(Thread, join: nil, kill: nil)
+    end
+  end
+
+  before do
+    allow(backend).to receive(:connect)
+    allow(backend).to receive(:start_transport!)
+    allow(backend).to receive(:on)
+    allow(backend).to receive(:emit)
+    allow(backend).to receive(:disconnect)
+  end
+
+  describe "#leave_channel" do
+    it "emits leave with a validated channelName" do
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run
+      )
+      client.connect
+      client.leave_channel(channel_name: "B-BTC_USDT@prices")
+
+      expect(backend).to have_received(:emit).with(
+        "leave",
+        { "channelName" => "B-BTC_USDT@prices" }
+      )
+    end
+  end
+
+  describe "#subscribe_public" do
+    it "emits join after Engine.IO open (:connect), and resubscribes on each open" do
+      handlers = {}
+      allow(backend).to receive(:on) do |event_name, &block|
+        handlers[event_name] = block
+      end
+
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run
+      )
+      client.connect
+      client.subscribe_public(channel_name: "B-BTC_USDT@prices", event_name: "price-change")
+
+      expect(backend).not_to have_received(:emit).with("join", { "channelName" => "B-BTC_USDT@prices" })
+
+      handlers.fetch(:connect).call
+
+      expect(backend).to have_received(:emit).with("join", { "channelName" => "B-BTC_USDT@prices" }).once
+
+      handlers.fetch(:connect).call
+
+      expect(backend).to have_received(:emit).with("join", { "channelName" => "B-BTC_USDT@prices" }).twice
+    end
+  end
+
+  describe "#subscribe_private" do
+    it "renews private channel auth payloads after reconnect" do
+      handlers = {}
+      captured_join_payloads = []
+      allow(backend).to receive(:on) do |event_name, &block|
+        handlers[event_name] = block
+      end
+      allow(backend).to receive(:emit) do |op, payload|
+        captured_join_payloads << payload if op == "join"
+      end
+
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run
+      )
+      client.connect
+      handlers.fetch(:connect).call
+      client.subscribe_private(event_name: CoinDCX::WS::PrivateChannels::ORDER_UPDATE_EVENT)
+
+      expect(captured_join_payloads.size).to eq(1)
+      first_payload = captured_join_payloads.first
+
+      allow(client).to receive(:join_payload).and_call_original
+      allow(client).to receive(:join_payload)
+        .with(type: :private, channel_name: CoinDCX::WS::PrivateChannels::DEFAULT_CHANNEL_NAME)
+        .and_wrap_original do |original, *args, **kwargs|
+          payload = original.call(*args, **kwargs)
+          payload.merge("authSignature" => "#{payload.fetch('authSignature')}-renewed")
+        end
+
+      handlers.fetch(:disconnect).call("network_lost")
+      handlers[:connect]&.call
+
+      second_payload = captured_join_payloads.last
+
+      expect(second_payload).not_to eq(first_payload)
+      expect(second_payload.fetch("authSignature")).to end_with("-renewed")
+    end
+
+    it "does not reconnect a private subscription still within the liveness window" do
+      now = 100.0
+      handlers = {}
+      clock = -> { now }
+
+      allow(backend).to receive(:on) do |event_name, &block|
+        handlers[event_name] = block
+      end
+
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run,
+        monotonic_clock: clock
+      )
+      client.connect
+      handlers.fetch(:connect).call
+      client.subscribe_private(event_name: CoinDCX::WS::PrivateChannels::ORDER_UPDATE_EVENT)
+
+      # Advance clock but stay inside the liveness timeout — no reconnect expected.
+      now += 0.5
+      client.send(:connection_manager).send(:check_liveness!)
+
+      expect(backend).to have_received(:connect).once
+      expect(client.alive?).to be(true)
+    end
+  end
+
+  describe "#connect" do
+    it "retries socket connection failures with backoff" do
+      allow(backend).to receive(:connect) do
+        @connect_attempts ||= 0
+        @connect_attempts += 1
+        raise CoinDCX::Errors::SocketConnectionError, "temporary failure" if @connect_attempts == 1
+
+        self
+      end
+
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run,
+        randomizer: -> { 0.0 } # zero jitter → deterministic sleep value
+      )
+      client.connect
+
+      expect(backend).to have_received(:connect).twice
+      expect(sleeper).to have_received(:sleep).with(0.01)
+    end
+
+    it "reconnects and resubscribes after a disconnect event" do
+      handlers = {}
+      allow(backend).to receive(:on) do |event_name, &block|
+        handlers[event_name] = block
+      end
+
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run
+      )
+      client.connect
+      handlers.fetch(:connect).call
+      client.subscribe_public(channel_name: "B-BTC_USDT@prices", event_name: "price-change")
+
+      handlers.fetch(:disconnect).call("network_lost")
+      handlers[:connect]&.call
+
+      expect(backend).to have_received(:connect).twice
+      expect(backend).to have_received(:emit).with("join", { "channelName" => "B-BTC_USDT@prices" }).at_least(:twice)
+    end
+  end
+
+  describe "heartbeat liveness" do
+    it "reconnects after a stale subscription" do
+      now = 100.0
+      handlers = {}
+      clock = -> { now }
+
+      allow(backend).to receive(:on) do |event_name, &block|
+        handlers[event_name] = block
+      end
+
+      client = described_class.new(
+        configuration: configuration,
+        backend: backend,
+        sleeper: sleeper,
+        thread_factory: thread_factory_without_run,
+        monotonic_clock: clock
+      )
+      client.connect
+      handlers.fetch(:connect).call
+      client.subscribe_public(channel_name: "B-BTC_USDT@prices", event_name: "price-change")
+
+      now += 2.0
+      client.send(:connection_manager).send(:check_liveness!)
+      handlers[:connect]&.call
+
+      expect(backend).to have_received(:connect).twice
+      expect(backend).to have_received(:emit).with("join", { "channelName" => "B-BTC_USDT@prices" }).at_least(:twice)
+    end
+  end
+end

data/spec/ws/socket_io_simple_backend_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe CoinDCX::WS::SocketIOSimpleBackend do
+  let(:client_instance) { instance_double("SocketIOClientInstance", connect: true, emit: true, on: true, disconnect: true) }
+  let(:client_class) { class_double("SocketIOClientClass", new: client_instance) }
+  subject(:backend) { described_class.new(socket_client_class: client_class, connect_options: { EIO: 3 }) }
+
+  before do
+    allow(client_instance).to receive(:on)
+  end
+
+  it "creates the client, registers listeners, then opens the transport" do
+    backend.connect("wss://stream.coindcx.com")
+    backend.on("price-change") { |_payload| nil }
+    backend.start_transport!
+    backend.emit("join", { "channelName" => "coindcx" })
+
+    expect(client_class).to have_received(:new).with("wss://stream.coindcx.com", hash_including(EIO: 3))
+    expect(client_instance).to have_received(:on).with("price-change")
+    expect(client_instance).to have_received(:connect)
+    expect(client_instance).to have_received(:emit).with("join", { "channelName" => "coindcx" })
+  end
+
+  it "disconnects the underlying client when present" do
+    backend.connect("wss://stream.coindcx.com")
+    backend.start_transport!
+    backend.disconnect
+
+    expect(client_instance).to have_received(:disconnect)
+  end
+
+  it "raises a socket connection error when client construction fails" do
+    allow(client_class).to receive(:new).and_raise(StandardError, "boom")
+
+    expect do
+      backend.connect("wss://stream.coindcx.com")
+    end.to raise_error(CoinDCX::Errors::SocketConnectionError, "boom")
+  end
+end

data/spec/ws/uri_ruby3_compat_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+require_relative "../../lib/coindcx/ws/uri_ruby3_compat"
+
+RSpec.describe "CoinDCX::WS URI.encode shim (Ruby 3 + socket.io-client-simple)" do
+  it "restores URI.encode using DEFAULT_PARSER so Engine.IO query params build" do
+    # rubocop:disable Lint/UriEscapeUnescape -- intentional: shim matches legacy URI.encode for socket.io-client-simple
+    expect(URI.encode("EIO=4")).to eq(URI::DEFAULT_PARSER.escape("EIO=4"))
+    # rubocop:enable Lint/UriEscapeUnescape
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: coindcx-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cursor
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: socket.io-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: CoinDCX-specific gem with separate REST and Socket.io layers, modeled
+  after layered exchange client architecture.
+email:
+- noreply@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release.yml"
+- ".rubocop.yml"
+- AGENT.md
+- README.md
+- bin/console
+- docs/README.md
+- docs/coindcx_docs_gaps.md
+- docs/core.md
+- docs/rails_integration.md
+- docs/standalone_bot.md
+- lib/coindcx.rb
+- lib/coindcx/auth/signer.rb
+- lib/coindcx/client.rb
+- lib/coindcx/configuration.rb
+- lib/coindcx/contracts/channel_name.rb
+- lib/coindcx/contracts/identifiers.rb
+- lib/coindcx/contracts/order_request.rb
+- lib/coindcx/contracts/socket_backend.rb
+- lib/coindcx/contracts/wallet_transfer_request.rb
+- lib/coindcx/errors/base_error.rb
+- lib/coindcx/logging/null_logger.rb
+- lib/coindcx/logging/structured_logger.rb
+- lib/coindcx/models/balance.rb
+- lib/coindcx/models/base_model.rb
+- lib/coindcx/models/instrument.rb
+- lib/coindcx/models/market.rb
+- lib/coindcx/models/order.rb
+- lib/coindcx/models/trade.rb
+- lib/coindcx/rest/base_resource.rb
+- lib/coindcx/rest/funding/facade.rb
+- lib/coindcx/rest/funding/orders.rb
+- lib/coindcx/rest/futures/facade.rb
+- lib/coindcx/rest/futures/market_data.rb
+- lib/coindcx/rest/futures/orders.rb
+- lib/coindcx/rest/futures/positions.rb
+- lib/coindcx/rest/futures/wallets.rb
+- lib/coindcx/rest/margin/facade.rb
+- lib/coindcx/rest/margin/orders.rb
+- lib/coindcx/rest/public/facade.rb
+- lib/coindcx/rest/public/market_data.rb
+- lib/coindcx/rest/spot/facade.rb
+- lib/coindcx/rest/spot/orders.rb
+- lib/coindcx/rest/transfers/facade.rb
+- lib/coindcx/rest/transfers/wallets.rb
+- lib/coindcx/rest/user/accounts.rb
+- lib/coindcx/rest/user/facade.rb
+- lib/coindcx/transport/circuit_breaker.rb
+- lib/coindcx/transport/http_client.rb
+- lib/coindcx/transport/rate_limit_registry.rb
+- lib/coindcx/transport/request_policy.rb
+- lib/coindcx/transport/response_normalizer.rb
+- lib/coindcx/transport/retry_policy.rb
+- lib/coindcx/utils/payload.rb
+- lib/coindcx/version.rb
+- lib/coindcx/ws/connection_manager.rb
+- lib/coindcx/ws/connection_state.rb
+- lib/coindcx/ws/parsers/order_book_snapshot.rb
+- lib/coindcx/ws/private_channels.rb
+- lib/coindcx/ws/public_channels.rb
+- lib/coindcx/ws/socket_io_client.rb
+- lib/coindcx/ws/socket_io_simple_backend.rb
+- lib/coindcx/ws/subscription_registry.rb
+- lib/coindcx/ws/uri_ruby3_compat.rb
+- spec/auth_signer_spec.rb
+- spec/client_spec.rb
+- spec/contracts/order_request_spec.rb
+- spec/contracts/wallet_transfer_request_spec.rb
+- spec/models/base_model_spec.rb
+- spec/rest/funding/orders_spec.rb
+- spec/rest/futures/market_data_spec.rb
+- spec/rest/futures/orders_spec.rb
+- spec/rest/futures/positions_spec.rb
+- spec/rest/futures/wallets_spec.rb
+- spec/rest/margin/orders_spec.rb
+- spec/rest/public/market_data_spec.rb
+- spec/rest/spot/orders_spec.rb
+- spec/rest/transfers/wallets_spec.rb
+- spec/rest/user/accounts_spec.rb
+- spec/spec_helper.rb
+- spec/transport/http_client_spec.rb
+- spec/transport/rate_limit_registry_spec.rb
+- spec/transport/request_policy_spec.rb
+- spec/transport/response_normalizer_spec.rb
+- spec/ws/connection_manager_spec.rb
+- spec/ws/order_book_snapshot_spec.rb
+- spec/ws/private_channels_spec.rb
+- spec/ws/public_channels_spec.rb
+- spec/ws/socket_io_client_spec.rb
+- spec/ws/socket_io_simple_backend_spec.rb
+- spec/ws/uri_ruby3_compat_spec.rb
+homepage: https://github.com/shubhamtaywade82/coindcx-client
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby client for CoinDCX REST and Socket.io APIs
+test_files: []