bitget 0.6.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e0d654613fdc8a82b59fba0720d2ab0b5537d753674aa9272526d0adf066345
+  data.tar.gz: 373b01b2e9c8687c0a34c205d0140a764cd673b78729f9a73fe0978ee7673d98
+SHA512:
+  metadata.gz: 7d46832f9acb0ff24e2604f561b63b58cac07cad9aa0d9a7ee37a46176da0a8228882ae2162f796ee44d7dd4c775d1f2a89611198bccb1d146bd68c99974ac8b
+  data.tar.gz: 7bf05bb597bd6bc24207025828bf0a86dd63a539479d137c04132ab22f555de69fda4b20ee43847086c00b0a70a3ab17f527d326f59999f0fda7b2518ff28813

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'http.rb'
+
+group :development, :test do
+  gem 'minitest'
+  gem 'minitest-spec-context'
+  gem 'vcr'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 thoran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,196 @@
+# bitget.rb
+
+## Description
+
+Access the Bitget API with Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bitget.rb'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install bitget.rb
+```
+
+## Usage
+
+### Setup
+
+```ruby
+bitget_client = Bitget::Client.new(
+  api_key: 'api_key0',
+  api_secret: 'api_secret0',
+  api_passphrase: 'api_passphrase0'
+)
+```
+
+### 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
+# =>
+#  {
+#    "code" => "00000",
+#    "msg" => "success",
+#    "requestTime" => 1743252600562,
+#    "data" => [
+#      {
+#        "coinId" => "1460",
+#        "coin" => "U2U",
+#        "transfer" => "false",
+#        "chains" => [
+#          {
+#            "chain" => "UnicornUltraSolaris",
+#            ...
+#          }
+#        ]
+#      },
+#      ...
+#      {...}
+#    ]
+#    "areaCoin" => "no"
+#  }
+```
+
+### Retrieve Info for One of the Coins Traded
+
+```ruby
+bitget_client.spot_public_coins(coin: 'BTC')
+# =>
+#  {
+#    "code" => "00000",
+#    "msg" => "success",
+#    "requestTime" => 1743252619082,
+#    "data" => [
+#      {
+#        "coinId" => "1",
+#        "coin" => "BTC",
+#        "transfer" => "true",
+#        "chains" => [
+#          {
+#            "chain" => "BTC",
+#            "needTag" => "false",
+#            "withdrawable" => "true",
+#            "rechargeable" => "true",
+#            "withdrawFee" => "0.00005",
+#            "extraWithdrawFee" => "0",
+#            "depositConfirm" => "1",
+#            "withdrawConfirm" => "1",
+#            "minDepositAmount" => "0.00001",
+#            "minWithdrawAmount" => "0.0005",
+#            "browserUrl" => "https://www.blockchain.com/explorer/transactions/btc/",
+#            "contractAddress" => nil,
+#            "withdrawStep" => "0",
+#            "withdrawMinScale" => "8",
+#            "congestion" => "normal"
+#          },
+#          ...
+#          {...}
+#        ]
+#      }
+#    ]
+#    "areaCoin" => "no"
+#  }
+```
+
+### Get Account Information
+
+```ruby
+bitget_client.spot_account_info
+```
+
+### Get Account Assets
+
+```ruby
+bitget_client.spot_account_assets
+```
+
+```ruby
+bitget_client.spot_account_assets(coin: 'BTC')
+```
+
+See https://www.bitget.com/api-doc/spot/intro for further information on endpoint arguments.
+
+## Contributing
+
+1. Fork it (https://github.com/thoran/bitget.rb/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new pull request
+
+
+## License
+
+MIT

data/bitget.gemspec

@@ -0,0 +1,29 @@
+# bitget.rb.gemspec
+
+require_relative './lib/Bitget/VERSION'
+
+Gem::Specification.new do |spec|
+  spec.name = 'bitget'
+  spec.version = Bitget::VERSION
+
+  spec.summary = "Access the Bitget API with Ruby."
+  spec.description = "Access the Bitget API with Ruby."
+
+  spec.author = 'thoran'
+  spec.email = 'code@thoran.com'
+  spec.homepage = 'http://github.com/thoran/bitget.rb'
+  spec.license = 'Ruby'
+
+  spec.required_ruby_version = '>= 2.7'
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('http.rb')
+  spec.files = [
+    'bitget.gemspec',
+    Dir['lib/**/*.rb'],
+    Dir['test/**/*.rb'],
+    'Gemfile',
+    'LICENSE',
+    'README.md',
+  ].flatten
+end

data/lib/Bitget/Client.rb

@@ -0,0 +1,8 @@
+# Bitget/Client.rb
+# Bitget::Client
+
+require_relative './V2/Client'
+
+module Bitget
+  class Client < Bitget::V2::Client; end
+end

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

@@ -0,0 +1,48 @@
+# Bitget/Error.rb
+# Bitget::Error
+
+require 'json'
+
+module Bitget
+  class Error < RuntimeError
+    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
+
+    def initialize(code:, message:, body:)
+      @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