poloniex.rb 0.0.0 → 0.1.1

data/lib/Poloniex/V1.rb

@@ -0,0 +1,12 @@
+# Poloniex/V1.rb
+# Poloniex::V1
+
+module Poloniex
+  module V1
+    PUBLIC_PATH_PREFIXES = [
+      "/markets",
+      "/currencies",
+      "/timestamp",
+    ].freeze
+  end
+end

data/lib/Poloniex/VERSION.rb

@@ -2,5 +2,5 @@
 # Poloniex::VERSION
 
 module Poloniex
-  VERSION = '0.0.0'
+  VERSION = '0.1.1'
 end

data/lib/Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode.rb

@@ -0,0 +1,26 @@
+# Thoran/Hash/XWwwFormUrlEncode/x_www_form_urlencode.rb
+# Thoran::Hash::XWwwFormUrlEncode#x_www_form_urlencode
+
+# 20241009
+# 0.2.0
+
+# Changes since 0.1:
+# -/0: (The class name and the snake case name are consistent now.)
+# 1. /XWWWFormUrlEncode/XWwwFormUrlEncode/
+
+require 'Thoran/String/UrlEncode/url_encode'
+
+module Thoran
+  module Hash
+    module XWwwFormUrlEncode
+
+      def x_www_form_url_encode(joiner = '&')
+        inject([]){|a,e| a << "#{e.first.to_s.url_encode}=#{e.last.to_s.url_encode}" unless e.last.nil?; a}.join(joiner)
+      end
+      alias_method :x_www_form_urlencode, :x_www_form_url_encode
+
+    end
+  end
+end
+
+Hash.send(:include, Thoran::Hash::XWwwFormUrlEncode)

data/lib/Thoran/String/UrlEncode/url_encode.rb

@@ -0,0 +1,26 @@
+# Thoran/String/UrlEncode/url_encode.rb
+# Thoran::String::UrlEncode#url_encode
+
+# 20160505
+# 0.3.0
+
+# Acknowledgements: I've simply ripped off and refashioned the code from the CGI module!...
+
+# Changes since 0.2:
+# 1. + Thoran namespace.
+
+module Thoran
+  module String
+    module UrlEncode
+
+      def url_encode
+        self.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+          '%' + $1.unpack('H2' * $1.size).join('%').upcase
+        end.tr(' ', '+')
+      end
+
+    end
+  end
+end
+
+String.send(:include, Thoran::String::UrlEncode)

data/lib/poloniex.rb

@@ -3,7 +3,7 @@
 lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
-require_relative './Poloniex/Client'
-require_relative './Poloniex/VERSION'
-
 module Poloniex; end
+
+require 'Poloniex/Client'
+require 'Poloniex/VERSION'

data/poloniex.rb.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name = 'poloniex.rb'
 
   spec.version = Poloniex::VERSION
-  spec.date = '2025-07-02'
+  spec.date = '2025-08-15'
 
   spec.summary = "Access the Poloniex API with Ruby."
   spec.description = "Access the Poloniex API with Ruby."

data/test/Poloniex/Configuration_test.rb

@@ -1,16 +1,77 @@
 require_relative '../helper'
 
-describe Poloniex::Configuration do
-  subject do
-    Poloniex::Configuration.new
+require 'logger'
+
+describe "Poloniex::Configuration" do
+  describe ".configure" do
+    subject do
+      Poloniex::V1::Client.new
+    end
+
+    before do
+      Poloniex.configure do |config|
+        config.api_key = 'test_api_key'
+        config.api_secret = 'test_api_secret'
+        config.debug = false
+        config.logger = Logger.new('test_log_file')
+      end
+    end
+
+    it "uses global configuration by default" do
+      _(subject.api_key).must_equal('test_api_key')
+      _(subject.api_secret).must_equal('test_api_secret')
+      _(subject.debug).must_equal(false)
+      _(subject.logger).must_be_kind_of(Logger)
+    end
   end
 
-  describe "#new" do
-    it "sets default values" do
-      assert_nil(subject.api_key)
-      assert_nil(subject.api_secret)
-      assert_nil(subject.debug)
-      assert_nil(subject.logger)
+  describe "using a configuration object" do
+    subject do
+      Poloniex::V1::Client.new(configuration: configuration)
+    end
+
+    let(:configuration) do
+      Poloniex::Configuration.new(
+        api_key: 'test_api_key',
+        api_secret: 'test_api_secret',
+        debug: false,
+        logger: Logger.new('test_log_file')
+      )
+    end
+
+    it "accepts a configuration object as an argument" do
+      _(subject.api_key).must_equal('test_api_key')
+      _(subject.api_secret).must_equal('test_api_secret')
+      _(subject.debug).must_equal(false)
+      _(subject.logger).must_be_kind_of(Logger)
+    end
+  end
+
+  describe "overriding configuration" do
+    subject do
+      Poloniex::V1::Client.new(
+        api_key: 'test_api_key',
+        api_secret: 'test_api_secret',
+        debug: true,
+        logger: Logger.new('test_log_file')
+      )
+    end
+
+    before do
+      class FakeLogger; end
+      Poloniex.configure do |config|
+        config.api_key = 'overridden_test_api_key'
+        config.api_secret = 'overridden_test_api_secret'
+        config.debug = false
+        config.logger = FakeLogger.new
+      end
+    end
+
+    it "allows overriding configuration" do
+      _(subject.api_key).must_equal('test_api_key')
+      _(subject.api_secret).must_equal('test_api_secret')
+      _(subject.debug).must_equal(true)
+      _(subject.logger).must_be_kind_of(Logger)
     end
   end
 end

data/test/Poloniex/V1/Client/test_account_endpoints.rb

@@ -0,0 +1,69 @@
+require_relative '../../../helper'
+
+describe "Poloniex::V1::Client Account Endpoints" do
+  let(:api_key){ENV.fetch('POLONIEX_API_KEY', '<API_KEY>')}
+  let(:api_secret){ENV.fetch('POLONIEX_API_SECRET', '<API_SECRET>')}
+
+  subject do
+    Poloniex::V1::Client.new(
+      api_key: api_key,
+      api_secret: api_secret
+    )
+  end
+
+  describe "Account endpoints" do
+    it "fetches a list of accounts" do
+      VCR.use_cassette('v1/accounts') do
+        response = subject.accounts
+        _(response).must_be_kind_of(Array)
+      end
+    end
+
+    it "fetches account balances" do
+      VCR.use_cassette('v1/accounts_balances') do
+        response = subject.accounts_balances
+        _(response).must_be_kind_of(Array)
+      end
+    end
+
+    it "fetches account activity" do
+      VCR.use_cassette('v1/accounts_activity') do
+        response = subject.accounts_activity(limit: 10)
+        _(response).must_be_kind_of(Array)
+      end
+    end
+
+    it "fetches account transfers" do
+      VCR.use_cassette('v1/accounts_transfer') do
+        response = subject.accounts_transfer(
+          currency: 'USDT',
+          amount: 10.5,
+          from_account: 'SPOT',
+          to_account: 'FUTURES'
+        )
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+
+    it "fetches account transfer records" do
+      VCR.use_cassette('v1/accounts_transfer_records') do
+        response = subject.accounts_transfer_records
+        _(response).must_be_kind_of(Array)
+      end
+    end
+
+    it "fetches fee info" do
+      VCR.use_cassette('v1/fee_info') do
+        response = subject.fee_info
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+
+    it "fetches accounts interest history" do
+      VCR.use_cassette('v1/accounts_interest_history') do
+        response = subject.accounts_interest_history
+        _(response).must_be_kind_of(Array)
+      end
+    end
+  end
+end

data/test/Poloniex/V1/Client/test_margin_endpoints.rb

@@ -0,0 +1,57 @@
+require_relative '../../../helper'
+
+require 'logger'
+
+describe "Poloniex::V1::Client Margin Endpoints" do
+  let(:api_key){ENV.fetch('POLONIEX_API_KEY', '<API_KEY>')}
+  let(:api_secret){ENV.fetch('POLONIEX_API_SECRET', '<API_SECRET>')}
+
+  subject do
+    Poloniex::V1::Client.new(
+      api_key: api_key,
+      api_secret: api_secret,
+      logger: Logger.new('/Users/thoran/log/poloniex/log.txt'),
+      debug: true
+    )
+  end
+
+  describe "#account_margin" do
+    it "fetches margin account info" do
+      VCR.use_cassette('v1/margin_account_margin') do
+        response = subject.account_margin
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+
+  describe "#borrow_status" do
+    it "fetches margin positions" do
+      VCR.use_cassette('v1/margin_borrow_status') do
+        response = subject.borrow_status
+        _(response).must_be_kind_of(Array)
+      end
+    end
+
+    it "fetches margin positions for specific currency" do
+      VCR.use_cassette('v1/margin_borrow_status_btc') do
+        response = subject.borrow_status(currency: 'BTC')
+        _(response).must_be_kind_of(Array)
+      end
+    end
+  end
+
+  describe "#max_buy_sell_amount" do
+    it "creates margin borrow" do
+      VCR.use_cassette('v1/max_buy_sell_amount') do
+        response = subject.max_buy_sell_amount('BTC_USDT')
+        _(response).must_be_kind_of(Hash)
+        _(response['symbol']).must_equal('BTC_USDT')
+        assert(response['maxLeverage'])
+        assert(response['maxAvailableBuy'])
+        assert(response['maxAvailableSell'])
+        assert(response['availableBuy'])
+        assert(response['availableSell'])
+      end
+    end
+  end
+end

data/test/Poloniex/V1/{Client_test.rb → Client/test_public_endpoints.rb}

@@ -1,49 +1,14 @@
-require_relative '../../helper'
+require_relative '../../../helper'
 
-describe Poloniex::V1::Client do
-  subject do
-    Poloniex::V1::Client.new
-  end
-
-  before do
-    Poloniex.configure do |config|
-      config.api_key = "test_api_key"
-      config.api_secret = "test_api_secret"
-      config.debug = false
-    end
-    WebMock.disable_net_connect!(allow_localhost: true)
-  end
-
-  describe ".configuration" do
-    context "global configuration" do
-      it "uses global configuration by default" do
-        client = Poloniex::V1::Client.new
-        _(client).must_be_kind_of(Poloniex::V1::Client)
-      end
-    end
-
-    context "configuration object " do
-      it "accepts a configuration object as an argument" do
-        configuration = Poloniex::Configuration.new(
-          api_key: "test_api_key",
-          api_secret: "test_api_secret",
-          debug: false
-        )
-        client = Poloniex::V1::Client.new(configuration: configuration)
-        _(client).must_be_kind_of(Poloniex::V1::Client)
-      end
-    end
+describe "Poloniex::V1::Client Public Endpoints" do
+  let(:api_key){ENV.fetch('POLONIEX_API_KEY', '<API_KEY>')}
+  let(:api_secret){ENV.fetch('POLONIEX_API_SECRET', '<API_SECRET>')}
 
-    context "" do
-      it "allows overriding configuration" do
-        client = Poloniex::V1::Client.new(
-          api_key: "custom_key",
-          api_secret: "custom_secret",
-          debug: true
-        )
-        _(client).must_be_kind_of(Poloniex::V1::Client)
-      end
-    end
+  subject do
+    Poloniex::V1::Client.new(
+      api_key: api_key,
+      api_secret: api_secret
+    )
   end
 
   describe "#candles" do
@@ -57,14 +22,14 @@ describe Poloniex::V1::Client do
 
   describe "#currencies" do
     it "fetches all currencies" do
-      VCR.use_cassette("v1/currencies") do
+      VCR.use_cassette('v1/currencies') do
         response = subject.currencies
         _(response).must_be_kind_of(Array)
       end
     end
 
     it "fetches a specific currency" do
-      VCR.use_cassette("v1/currencies_btc") do
+      VCR.use_cassette('v1/currencies_btc') do
         response = subject.currencies('BTC')
         _(response).must_be_kind_of(Hash)
         _(response.count).must_equal(1)
@@ -74,17 +39,17 @@ describe Poloniex::V1::Client do
     end
   end
 
-  describe "#mark_prices" do
+  describe "#mark_price" do
     it "fetches all markets" do
-      VCR.use_cassette('v1/mark_prices') do
-        response = subject.mark_prices
+      VCR.use_cassette('v1/mark_price') do
+        response = subject.mark_price
         _(response).must_be_kind_of(Array)
       end
     end
 
     it "fetches a specific market" do
-      VCR.use_cassette('v1/mark_prices_btcusdt') do
-        response = subject.mark_prices('BTC_USDT')
+      VCR.use_cassette('v1/mark_price_btcusdt') do
+        response = subject.mark_price('BTC_USDT')
         _(response).must_be_kind_of(Hash)
         _(response.count).must_equal(3)
         _(response['symbol']).must_equal('BTC_USDT')
@@ -128,17 +93,17 @@ describe Poloniex::V1::Client do
     end
   end
 
-  describe "#prices" do
+  describe "#price" do
     it "fetches prices for all symbols" do
-      VCR.use_cassette('v1/prices') do
-        response = subject.prices
+      VCR.use_cassette('v1/price') do
+        response = subject.price
         _(response).must_be_kind_of(Array)
       end
     end
 
     it "fetches price for a specific symbol" do
-      VCR.use_cassette('v1/prices_btcusdt') do
-        response = subject.prices('BTC_USDT')
+      VCR.use_cassette('v1/price_btcusdt') do
+        response = subject.price('BTC_USDT')
         _(response).must_be_kind_of(Hash)
       end
     end
@@ -162,7 +127,7 @@ describe Poloniex::V1::Client do
 
   describe "#timestamp" do
     it "fetches server timestamp" do
-      VCR.use_cassette("v1/timestamp") do
+      VCR.use_cassette('v1/timestamp') do
         response = subject.timestamp
         _(response).must_be_kind_of(Hash)
         _(response["serverTime"]).must_be_kind_of(Integer)

data/test/Poloniex/V1/Client/test_trading_endpoints.rb

@@ -0,0 +1,139 @@
+require_relative '../../../helper'
+
+describe "Poloniex::V1::Client Trading Endpoints" do
+  let(:api_key){ENV.fetch('POLONIEX_API_KEY', '<API_KEY>')}
+  let(:api_secret){ENV.fetch('POLONIEX_API_SECRET', '<API_SECRET>')}
+
+  subject do
+    Poloniex::V1::Client.new(
+      api_key: api_key,
+      api_secret: api_secret
+    )
+  end
+
+  describe "#create_order" do
+    it "creates a new order" do
+      VCR.use_cassette('v1/create_order') do
+        response = subject.create_order(
+          symbol: 'BTC_USDT',
+          side: 'BUY',
+          type: 'LIMIT',
+          quantity: 0.001,
+          price: 20_000
+        )
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+
+  describe "create_multiple_orders" do
+    let(:order0) do
+      {
+        symbol: 'BTC_USDT',
+        side: 'BUY',
+        type: 'LIMIT',
+        quantity: 0.01,
+        price: 15_000
+      }
+    end
+
+    let(:order1) do
+      {
+        symbol: 'BTC_USDT',
+        side: 'BUY',
+        type: 'LIMIT',
+        quantity: 0.1,
+        price: 8_000
+      }
+    end
+
+    it "gets an order by ID" do
+      VCR.use_cassette('v1/create_multiple_orders') do
+        response = subject.create_multiple_orders([order0, order1])
+        _(response).must_be_kind_of(Array)
+      end
+    end
+  end
+
+  describe "#cancel_replace_order" do
+    it "" do
+      VCR.use_cassette('v1/cancel_replace_order') do
+        response = subject.cancel_replace_order(order_id: 'blue')
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+
+  describe "#open_orders" do
+    it "retrieves the open orders" do
+      VCR.use_cassette('v1/open_orders') do
+        response = subject.open_orders
+        _(response).must_be_kind_of(Array)
+      end
+    end
+
+    it "retrieves the open orders for a specific symbol" do
+      VCR.use_cassette('v1/open_orders_btc_usdt') do
+        response = subject.open_orders(symbol: 'BTC_USDT')
+        _(response).must_be_kind_of(Array)
+      end
+    end
+  end
+
+  describe "#order_details" do
+    it "" do
+      VCR.use_cassette('v1/orders_details') do
+        response = subject.order_details(order_id: '21934611974062080')
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+
+  describe "#cancel_order" do
+    it "" do
+      VCR.use_cassette('v1/cancel_order') do
+        response = subject.cancel_order(order_id: '32487004629499904')
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+
+  describe "#cancel_multiple_orders" do
+    it "" do
+      VCR.use_cassette('v1/cancel_multiple_orders') do
+        response = subject.cancel_multiple_orders(order_ids: ['12345', '67890'])
+        _(response).must_be_kind_of(Array)
+      end
+    end
+  end
+
+  describe "#cancel_all_orders" do
+    it "" do
+      VCR.use_cassette('v1/cancel_all_orders') do
+        response = subject.cancel_all_orders(
+          symbols: %w{BTC_USDT ETH_USDT},
+          account_types: %w{SPOT}
+        )
+        _(response).must_be_kind_of(Array)
+      end
+    end
+  end
+
+  describe "#kill_switch" do
+    it "" do
+      VCR.use_cassette('v1/kill_switch') do
+        response = subject.kill_switch(timeout: 10)
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+
+  describe "#kill_switch_status" do
+    it "" do
+      VCR.use_cassette('v1/kill_switch_status') do
+        response = subject.kill_switch_status
+        _(response).must_be_kind_of(Hash)
+      end
+    end
+  end
+end

data/test/Poloniex/V1/Client/test_wallet_endpoints.rb

@@ -0,0 +1,60 @@
+require_relative '../../../helper'
+
+describe "Poloniex::V1::Client Wallet Endpoints" do
+  let(:api_key){ENV.fetch('POLONIEX_API_KEY', '<API_KEY>')}
+  let(:api_secret){ENV.fetch('POLONIEX_API_SECRET', '<API_SECRET>')}
+
+  subject do
+    Poloniex::V1::Client.new(
+      api_key: api_key,
+      api_secret: api_secret
+    )
+  end
+
+  describe "#deposit_addresses" do
+    it "fetches deposit addresses" do
+      VCR.use_cassette('v1/deposit_addresses') do
+        response = subject.deposit_addresses
+        assert_kind_of Hash, response
+      end
+    end
+
+    it "fetches deposit address for specific currency" do
+      VCR.use_cassette('v1/deposit_address_btc') do
+        response = subject.deposit_addresses('BTC')
+        assert_kind_of Hash, response
+      end
+    end
+  end
+
+  describe "#wallets_activity" do
+    it "fetches deposit history" do
+      VCR.use_cassette('v1/wallets_activity') do
+        response = subject.wallets_activity(start: 1754734725, finish: 1754739175)
+        assert_kind_of Hash, response
+      end
+    end
+  end
+
+  describe "#new_currency_address" do
+    it "generates new deposit address" do
+      VCR.use_cassette('v1/new_currency_address') do
+        response = subject.new_currency_address('BTC')
+        assert_kind_of Hash, response
+      end
+    end
+  end
+
+  describe "#withdraw_currency" do
+    it "creates withdrawal" do
+      VCR.use_cassette('v1/withdraw_currency') do
+        response = subject.withdraw_currency(
+          currency: "BTC",
+          amount: "0.1",
+          address: "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa"
+        )
+        assert_kind_of Hash, response
+      end
+    end
+  end
+end

data/test/Poloniex/VERSION_test.rb

@@ -0,0 +1,16 @@
+require_relative '../helper'
+
+describe Poloniex::VERSION do
+
+  subject do
+    Poloniex::VERSION
+  end
+
+  it "has a version number string" do
+    _(subject).must_be_kind_of(String)
+  end
+
+  it "has a version number in the right format" do
+    _(subject).must_match(/^\d\.\d\.\d$/)
+  end
+end

data/test/helper.rb

@@ -4,23 +4,21 @@ require 'minitest-spec-context'
 require 'vcr'
 require 'webmock'
 
-$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
-require 'poloniex'
+require_relative '../lib/poloniex'
 
 VCR.configure do |config|
-  config.cassette_library_dir = 'test/fixtures/vcr_cassettes'
-
+  config.cassette_library_dir = File.join(__dir__, 'fixtures', 'vcr_cassettes')
   config.hook_into :webmock
 
-  config.filter_sensitive_data('<API_KEY>') { 'test_api_key' }
-  config.filter_sensitive_data('<API_SECRET>') { 'test_api_secret' }
+  config.filter_sensitive_data('<API_KEY>'){ENV['POLONIEX_API_KEY']}
+  config.filter_sensitive_data('<API_SECRET>'){ENV['POLONIEX_API_SECRET'] }
 
-  # Allow localhost connections for debugging
-  config.ignore_localhost = true
+  config.ignore_localhost = true # Allow localhost connections for debugging.
+  # config.debug_logger = $stderr # Uncomment for debug output from VCR.
 
-  config.default_cassette_options = { 
+  config.default_cassette_options = {
     record: :new_episodes,
-    match_requests_on: [:method, :uri]
+    match_requests_on: [:method, :path, :body]
   }
 end