bitget.rb 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a76dd0384385ec874d2689053e2a9af7ed9cc4167e9980691bcca9b4855005
-  data.tar.gz: 5d1f16940c82a9f072360fbecb5941be0df52d3161dab7db217814b5a5a2b00e
+  metadata.gz: b73e07027de34083f0b3733d967c45f9556436af137a9b22accb4c7ebccc4403
+  data.tar.gz: 59f22d1ae6e505a996d08e89923df0262d1dc65c9f898463d26d154370db1dce
 SHA512:
-  metadata.gz: 975b7a27c4ab2834dbcdd907b65d0fe66b17bb7d8a8c2fddee5d4cc6d3f4f2431afd670beee84312d5ff828e7d88a1dcdabb20fa1cb1a32a72a55f8da809c2b5
-  data.tar.gz: 3f030a15eaf44fd3ccba97ea216a11da4f377135c9c49127b5dbe713d4227357512950ec6ffa4e521bd2d73fed4df903b9a574cf7ea92054110eb2a366f08857
+  metadata.gz: 59530b4225ba03fa3c1d0070a4cb7595bc2ec3d679767f4287290beee42a42622a0859599d361ddae04630bbb0066f7dd642b83aec3a871af45fde1d7ea626c8
+  data.tar.gz: a6897b20c54c8d996f853d206c252d9c553fe31879d248a1dcfc6d553763b989684763f14bfbc7d87f19ae07bc63af839a57c5236b79284bc7715ee125a83191

data/README.md

@@ -30,6 +30,65 @@ bitget_client = Bitget::Client.new(
 )
 ```
 
+### Configuration
+
+Settings may be declared once, and every client built afterwards reads them as its defaults.
+
+```ruby
+Bitget.configure do |config|
+  config.api_key = 'api_key0'
+  config.api_secret = 'api_secret0'
+  config.api_passphrase = 'api_passphrase0'
+end
+
+bitget_client = Bitget::Client.new
+```
+
+The settings are `api_key`, `api_secret`, `api_passphrase`, `debug` and `logger`.
+
+Any of them may still be given per client, which wins over the configured value. The
+credentials are named arguments; the rest go under `options`.
+
+```ruby
+bitget_client = Bitget::Client.new(
+  api_key: 'api_key1',
+  options: {logger: Logger.new('bitget.log', 'daily')}
+)
+```
+
+### Logging
+
+A client logs when it has somewhere to log to, and not at all when it does not. Hand it any
+object answering to `#info` and `#error`; the standard library's `Logger` will do.
+
+```ruby
+require 'logger'
+
+Bitget.configure do |config|
+  config.logger = Logger.new($stdout)
+end
+```
+
+`Logger` rotates by itself, so a daily log file wants no more than its second argument. It
+will not create the directory, so make that first.
+
+```ruby
+require 'fileutils'
+require 'logger'
+
+log_file_path = File.expand_path(File.join(%w{~ log bitget log.txt}))
+FileUtils.mkdir_p(File.dirname(log_file_path))
+
+Bitget.configure do |config|
+  config.logger = Logger.new(log_file_path, 'daily')
+end
+```
+
+Before 0.6.0 the client chose the path, created the directory and rotated the file itself. It
+no longer does any of that: what is logged is the client's business and where it goes is
+yours, which is what lets a StringIO logger in a test, or a levelled one, or something which
+is not a Logger at all, work as well as the above.
+
 ### Retrieve Info on All the Coins Traded
 ```ruby
 bitget_client.spot_public_coins

data/bitget.rb.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |spec|
   spec.name = 'bitget.rb'
 
   spec.version = Bitget::VERSION
-  spec.date = '2025-05-16'
+  spec.date = '2025-05-26'
 
   spec.summary = "Access the Bitget API with Ruby."
   spec.description = "Access the Bitget API with Ruby."

data/lib/Bitget/Configuration.rb

@@ -0,0 +1,32 @@
+# Bitget/Configuration.rb
+# Bitget::Configuration
+
+module Bitget
+  class Configuration
+    attr_accessor :api_key, :api_secret, :api_passphrase, :debug, :logger
+
+    def initialize
+      @api_key = nil
+      @api_secret = nil
+      @api_passphrase = nil
+      @debug = false
+      @logger = nil
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/lib/Bitget/Error.rb

@@ -1,9 +1,31 @@
 # Bitget/Error.rb
 # Bitget::Error
 
+require 'json'
+
 module Bitget
   class Error < RuntimeError
-    attr_reader :code, :message, :body
+    attr_reader\
+      :code,
+      :message,
+      :body
+
+    # Bitget answers most errors with a JSON body carrying its own code and
+    # message, which are more use than the HTTP ones.  Not all of them: a 418
+    # arrives with an empty body and there is nothing to parse.  Where the body
+    # says nothing the HTTP code and message answer instead, so that an error
+    # renders as something rather than as a pair of blanks.
+    def error_code
+      @parsed_body['code'] || @code
+    end
+
+    def error_message
+      @parsed_body['msg'] || @parsed_body['message'] || @message
+    end
+
+    def to_s
+      "Bitget::Error: #{error_code} - #{error_message}"
+    end
 
     private
 
@@ -11,6 +33,16 @@ module Bitget
       @code = code
       @message = message
       @body = body
+      @parsed_body = parsed(body)
+    end
+
+    # An error is raised in answer to something already having gone wrong, so it
+    # must construct from whatever arrived.  Raising a JSON::ParserError from
+    # here loses the error being reported and replaces it with one about parsing.
+    def parsed(body)
+      JSON.parse(body)
+    rescue JSON::ParserError
+      {}
     end
   end
 end