bitget 0.6.13 → 0.7.0

data/lib/Bitget/Error.rb

@@ -3,8 +3,16 @@
 
 require 'json'
 
+require_relative './ERROR_CODES'
+
 module Bitget
   class Error < RuntimeError
+    # Codes for a market which cannot be traded at present, whether closed for
+    # maintenance, not yet open, or delisted.  Chosen by hand rather than read
+    # from ERROR_CODES, since what a code is documented to mean and what it is
+    # returned for are not certain to agree.
+    MARKET_UNAVAILABLE_CODES = %w{25101 25102 40309 45043 50027}
+
     attr_reader\
       :code,
       :message,
@@ -23,6 +31,22 @@ module Bitget
       @parsed_body['msg'] || @parsed_body['message'] || @message
     end
 
+    # The message documented for the code by the first of the lists in
+    # ERROR_CODES to document it, or nil for a code no list documents.  A code
+    # listed more than once in the one list answers with each of its messages,
+    # numbered and separated: "(1) ...; (2) ...".  The numbers delimit them, no
+    # documented message containing such a number, which bin/generate_error_codes
+    # checks, so a semicolon within a message is no matter.
+    def documented_message
+      message = ERROR_CODES.values.filter_map{|error_codes| error_codes[error_code.to_s]}.first
+      return message unless message.is_a?(Array)
+      message.each_with_index.map{|m, i| "(#{i + 1}) #{m}"}.join('; ')
+    end
+
+    def market_unavailable?
+      MARKET_UNAVAILABLE_CODES.include?(error_code.to_s)
+    end
+
     def to_s
       "Bitget::Error: #{error_code} - #{error_message}"
     end

data/lib/Bitget/VERSION.rb

@@ -2,5 +2,5 @@
 # Bitget::VERSION
 
 module Bitget
-  VERSION = '0.6.13'
+  VERSION = '0.7.0'
 end

data/test/ERROR_CODES_test.rb

@@ -0,0 +1,58 @@
+require_relative './helper'
+
+describe Bitget do
+  describe "ERROR_CODES" do
+    it "has a table for each list, in order of precedence" do
+      _(Bitget::ERROR_CODES.keys).must_equal(%i{v2_rest v2_websocket uta_rest})
+    end
+
+    it "is frozen, as is each table" do
+      _(Bitget::ERROR_CODES.frozen?).must_equal(true)
+      Bitget::ERROR_CODES.each_value{|error_codes| _(error_codes.frozen?).must_equal(true)}
+    end
+
+    it "keys each table by codes as strings of digits, leading zeros kept" do
+      Bitget::ERROR_CODES.each_value do |error_codes|
+        error_codes.each_key{|code| _(code).must_match(/\A\d+\z/)}
+      end
+      _(Bitget::ERROR_CODES[:v2_rest]).must_include('00001')
+    end
+
+    it "gives each code a message, or an array of them" do
+      Bitget::ERROR_CODES.each_value do |error_codes|
+        error_codes.each_value do |message|
+          Array(message).each do |m|
+            _(m).must_be_instance_of(String)
+            _(m).wont_be_empty
+          end
+        end
+      end
+    end
+
+    it "keeps both meanings of a code listed twice in the one list, as an array" do
+      _(Bitget::ERROR_CODES[:v2_rest]['40104'].size).must_equal(2)
+      _(Bitget::ERROR_CODES[:v2_rest]['40104'].first).must_match(/located in a country or region/)
+      _(Bitget::ERROR_CODES[:v2_rest]['40104'].last).must_match(/Unable to withdraw to this account/)
+    end
+
+    it "keeps a message Bitget itself separates with slashes as the one string" do
+      _(Bitget::ERROR_CODES[:uta_rest]['60053']).must_match(%r{\Aparam error / Order status is not unpaid})
+    end
+
+    it "has no message numbered as Bitget::Error#documented_message numbers them" do
+      Bitget::ERROR_CODES.each_value do |error_codes|
+        error_codes.each_value{|message| Array(message).each{|m| _(m).wont_match(/\(\d+\)/)}}
+      end
+    end
+
+    it "decodes HTML entities" do
+      _(Bitget::ERROR_CODES[:v2_rest]['22006']).must_equal('limit price > risk price')
+    end
+
+    it "omits Bitget's placeholder for an undescribed code" do
+      Bitget::ERROR_CODES.each_value do |error_codes|
+        _(error_codes.values).wont_include('未找到描述')
+      end
+    end
+  end
+end

data/test/Error_test.rb

@@ -0,0 +1,68 @@
+require_relative './helper'
+
+describe Bitget::Error do
+  def error(body)
+    Bitget::Error.new(code: 400, message: 'Bad Request', body: body)
+  end
+
+  let(:suspended_body){'{"code":"25102","msg":"The symbol is currently suspended. Please refer to official announcements for the specific reopening time.","requestTime":1790320628183,"data":null}'}
+
+  describe "#error_code" do
+    it "is Bitget's code from the body" do
+      _(error(suspended_body).error_code).must_equal('25102')
+    end
+
+    it "is the HTTP code where the body has none" do
+      _(error('').error_code).must_equal(400)
+    end
+  end
+
+  describe "#documented_message" do
+    it "is the message documented for the code" do
+      _(error(suspended_body).documented_message).must_equal('Trading pair temporarily closed for maintenance')
+    end
+
+    it "prefers the V2 REST list over the others" do
+      _(error('{"code":"43117","msg":""}').documented_message).must_equal(Bitget::ERROR_CODES[:v2_rest]['43117'])
+    end
+
+    it "is each message of a code listed twice in the one list, numbered" do
+      first, second = Bitget::ERROR_CODES[:v2_rest]['40104']
+      _(error('{"code":"40104","msg":""}').documented_message).must_equal("(1) #{first}; (2) #{second}")
+    end
+
+    it "is nil for a code no list documents" do
+      _(error('{"code":"99999999","msg":""}').documented_message).must_be_nil
+    end
+
+    it "is nil where the body has no code" do
+      _(error('').documented_message).must_be_nil
+    end
+  end
+
+  describe "#market_unavailable?" do
+    it "is true for each of the codes for a market which cannot be traded" do
+      Bitget::Error::MARKET_UNAVAILABLE_CODES.each do |code|
+        _(error(%Q{{"code":"#{code}","msg":""}}).market_unavailable?).must_equal(true)
+      end
+    end
+
+    it "is true for a suspended symbol" do
+      _(error(suspended_body).market_unavailable?).must_equal(true)
+    end
+
+    it "is false for any other code" do
+      _(error('{"code":"43012","msg":"Insufficient balance"}').market_unavailable?).must_equal(false)
+    end
+
+    it "is false where the body has no code" do
+      _(error('').market_unavailable?).must_equal(false)
+    end
+  end
+
+  describe "#to_s" do
+    it "gives Bitget's code and the message as returned" do
+      _(error(suspended_body).to_s).must_equal('Bitget::Error: 25102 - The symbol is currently suspended. Please refer to official announcements for the specific reopening time.')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitget
 version: !ruby/object:Gem::Version
-  version: 0.6.13
+  version: 0.7.0
 platform: ruby
 authors:
 - thoran
@@ -38,12 +38,15 @@ files:
 - lib/Bitget.rb
 - lib/Bitget/Client.rb
 - lib/Bitget/Configuration.rb
+- lib/Bitget/ERROR_CODES.rb
 - lib/Bitget/Error.rb
 - lib/Bitget/V2/Client.rb
 - lib/Bitget/VERSION.rb
 - lib/String/url_encode.rb
 - lib/Thoran/String/UrlEncode/url_encode.rb
 - test/Configuration_test.rb
+- test/ERROR_CODES_test.rb
+- test/Error_test.rb
 - test/V2/Client_test.rb
 - test/VERSION_test.rb
 - test/gemspec_test.rb