bitget.rb 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b1ea6c7d91ff48cbcd7e70f6dd5c3aaf43231bd6eac34050c6b0fc9c1c33cfd
+  data.tar.gz: d53e337eef7ed2b324ec29e64b36bcd82314c75f069761c13d5ef71f01a5abe9
+SHA512:
+  metadata.gz: a66581d1bf3312c2826055eec6e4fdfc73a49ff1bcef8950ba7fe0f9ab067811983b960eecb979619a5e907c4561498525a15f4a113caf8d76826debf7543a18
+  data.tar.gz: 1f3b6e5288b51858423b470f7139be1bc7aba01e3719c54fe170833986d5784887ceda5c6719f2c5b43da795d5f0b54a26c6b2b4c0205cd8ef4b0d230ba181e1

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/README.md

@@ -0,0 +1,106 @@
+# 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'
+)
+```
+
+### 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"
+#  }
+```
+
+## 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

data/bitget.rb.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |spec|
+  spec.name = 'bitget.rb'
+
+  spec.version = '0.3.0'
+  spec.date = '2025-03-29'
+
+  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.add_dependency('http.rb')
+  spec.files = [
+    'bitget.rb.gemspec',
+    'Gemfile',
+    Dir['lib/**/*.rb'],
+    'README.md',
+    Dir['test/**/*.rb']
+  ].flatten
+  spec.require_paths = ['lib']
+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/Error.rb

@@ -0,0 +1,16 @@
+# Bitget/Error.rb
+# Bitget::Error
+
+module Bitget
+  class Error < RuntimeError
+    attr_reader :code, :message, :body
+
+    private
+
+    def initialize(code:, message:, body:)
+      @code = code
+      @message = message
+      @body = body
+    end
+  end
+end

data/lib/Bitget/V2/Client.rb

@@ -0,0 +1,164 @@
+# Bitget/V2/Client.rb
+# Bitget::V2::Client
+
+require 'Hash/to_parameter_string'
+gem 'http.rb'; require 'http.rb'
+require 'json'
+require 'logger'
+require 'openssl'
+
+require_relative '../Error'
+require_relative '../../Hash/x_www_form_urlencode'
+
+module Bitget
+  module V2
+    class Client
+
+      API_HOST = 'api.bitget.com'
+
+      class << self
+        attr_writer :log_file_path
+
+        def path_prefix
+          '/api/v2'
+        end
+
+        def default_log_file_path
+          File.join(%w{~ log bitget log.txt})
+        end
+
+        def log_file_path
+          File.expand_path(@log_file_path || default_log_file_path)
+        end
+
+        def log_file
+          FileUtils.mkdir_p(File.dirname(log_file_path))
+          File.open(log_file_path, File::WRONLY | File::APPEND | File::CREAT)
+        end
+
+        def logger
+          @logger ||= Logger.new(log_file, 'daily')
+        end
+      end # class << self
+
+      def spot_public_coins(coin: nil)
+        response = get(
+          path: '/spot/public/coins',
+          args: {
+            coin: coin
+          }
+        )
+        handle_response(response)
+      end
+
+      private
+
+      def initialize(api_key:, api_secret:, api_passphrase:)
+        @api_key = api_key.encode('UTF-8')
+        @api_secret = api_secret.encode('UTF-8')
+        @api_passphrase = api_passphrase.encode('UTF-8')
+      end
+
+      def full_path(path)
+        self.class.path_prefix + path
+      end
+
+      def encoded_payload(args)
+        args.reject!{|k,v| v.nil?}
+        OpenSSL::Digest::SHA512.hexdigest(JSON.dump(args))
+      end
+
+      def timestamp
+        @timestamp ||= Time.now.to_i.to_s
+      end
+
+      def message(verb:, path:, args:)
+        query_string = (
+          case verb
+          when 'GET'
+            args.to_parameter_string
+          when 'POST'
+            nil
+          else
+            raise "The verb, #{verb}, is not acceptable."
+          end
+        )
+        body = JSON.dump(args)
+        if query_string.nil?
+          [timestamp, verb, full_path(path), body].join
+        else
+          [timestamp, verb, full_path(path), '?', query_string, body].join
+        end
+      end
+
+      def signature(message)
+        OpenSSL::HMAC.hexdigest('SHA512', @api_secret, message)
+      end
+
+      def request_string(path)
+        "https://#{API_HOST}#{self.class.path_prefix}#{path}"
+      end
+
+      def headers(signature)
+        {
+          'ACCESS-KEY' => @api_key,
+          'ACCESS-SIGN' => signature,
+          'ACCESS-TIMESTAMP' => timestamp,
+          'ACCESS-PASSPHRASE' => @api_passphrase,
+          'Content-type' => 'application/json',
+          'locale' =>'en-AU',
+          'Accept' => 'application/json',
+        }
+      end
+
+      def log_args?(args)
+        !args.values.all?(&:nil?)
+      end
+
+      def log_request(verb:, request_string:, args:)
+        log_string = "#{verb} #{request_string}"
+        if log_args?(args)
+          log_string << "?#{args.x_www_form_urlencode}"
+        end
+        self.class.logger.info(log_string)
+      end
+
+      def log_error(code:, message:, body:)
+        log_string = "#{code}\n#{message}\n#{body}"
+        self.class.logger.error(log_string)
+      end
+
+      def do_request(verb:, path:, args: {})
+        log_request(verb: verb, request_string: request_string(path), args: args)
+        message = message(verb: verb, path: path, args: args)
+        signature = signature(message)
+        HTTP.send(verb.to_s.downcase, request_string(path), args, headers(signature))
+      end
+
+      def get(path:, args: {})
+        do_request(verb: 'GET', path: path, args: args)
+      end
+
+      def post(path:, args: {})
+        do_request(verb: 'POST', path: path, args: args)
+      end
+
+      def handle_response(response)
+        if response.success?
+          JSON.parse(response.body)
+        else
+          log_error(
+            code: response.code,
+            message: response.message,
+            body: response.body
+          )
+          raise Bitget::Error.new(
+            code: response.code,
+            message: response.message,
+            body: response.body
+          )
+        end
+      end
+    end
+  end
+end

data/lib/Hash/to_parameter_string.rb

@@ -0,0 +1,26 @@
+# Hash#to_parameter_string
+
+# 20120610
+# 1.0.2
+
+# Changes since 0: 
+# 1. I changed it from a class method to an instance method and hence removed references to any arguments and substituted self for those arguments.  
+# 0/1
+# 2. I forget about needing String#url_encode, which for now I'll paste in here.  
+# 1/2
+# 3. - String#url_encode.  
+# 4. + require 'String/url_encode'.  
+
+require 'String/url_encode'
+
+class Hash
+  
+  def to_parameter_string
+    parameters_string_parts = []
+    self.each do |k,v|
+      parameters_string_parts << (k.to_s + '=' + v.url_encode) unless v.nil?
+    end
+    parameters_string_parts.join('&')
+  end
+  
+end

data/lib/Hash/x_www_form_urlencode.rb

@@ -0,0 +1,7 @@
+# Hash/x_www_form_urlencode.rb
+# Hash#x_www_form_urlencode
+
+# 20241009
+# 0.1.0
+
+require 'Thoran/Hash/XWwwFormUrlencode/x_www_form_urlencode'

data/lib/String/url_encode.rb

@@ -0,0 +1,24 @@
+# String/url_encode.rb
+# String#url_encode
+
+# 20130310
+# 0.2.1
+
+# Description: When I went looking for a means to url encode and decode strings, I wanted something which used extensions to the String class.  Of course there are other means to do url encoding and decoding including using the CGI class, but I liked the approach of having this 'built-in' to strings, rather than the string being passed as a parameter as does CGI.  Hence this String extender...  
+
+# Acknowledgements: I've simply ripped off and refashioned the code from the CGI module!...  
+
+# Changes since 0.1:
+# 1. The url_encode and url_decode methods now are strictly demarcated.  
+# 0/1
+# 2. A small reformat.  
+
+class String
+
+  def url_encode
+    self.gsub(/([^ a-zA-Z0-9_.-]+)/n) do
+      '%' + $1.unpack('H2' * $1.size).join('%').upcase
+    end.tr(' ', '+')
+  end
+
+end

data/lib/bitget.rb

@@ -0,0 +1,10 @@
+# bitget.rb
+# Bitget
+
+# 20250326
+# 0.1.1
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require_relative './Bitget/Client'

data/test/V2/client_test.rb

@@ -0,0 +1,53 @@
+require_relative '../helper'
+require_relative '../../lib/Bitget/V2/Client'
+
+describe Bitget::V2::Client do
+  let(:client) do
+    Bitget::V2::Client.new(
+      api_key: api_key,
+      api_secret: api_secret,
+      api_passphrase: api_passphrase
+    )
+  end
+
+  describe "#spot_public_coins" do
+    context "when a coin is NOT supplied" do
+      it "retrieves a list of all coins" do
+        VCR.use_cassette('v2/spot/public/coins-when_coin_is_not_supplied') do
+          response = client.spot_public_coins
+          _(response).must_include('data')
+          _(response['data'].first).must_include('coinId')
+          _(response['data'].first).must_include('coin')
+          assert_operator response['data'].count, :>, 1500
+        end
+      end
+    end
+
+    context "when a coin IS supplied" do
+      it "retrieves one coin" do
+        VCR.use_cassette('v2/spot/public/coins-when_coin_is_supplied') do
+          response = client.spot_public_coins(coin: 'BTC')
+          _(response).must_include('data')
+          _(response['data'].first).must_include('coinId')
+          _(response['data'].first).must_include('coin')
+          _(response['data'].count).must_equal(1)
+        end
+      end
+    end
+
+    context "when an error occurs" do
+      it "logs then raises an error" do
+        VCR.use_cassette('v2/spot/public/coins-when_an_error_occurs') do
+          assert_raises(Bitget::Error) do
+            mocked_method = Minitest::Mock.new
+            mocked_method.expect(:call, nil, [], code: '418', message: "I'm a teapot", body: '')
+            client.stub(:log_error, mocked_method) do
+              client.spot_public_coins
+            end
+            mocked_method.verify
+          end
+        end
+      end
+    end
+  end
+end

data/test/client_test.rb

@@ -0,0 +1,53 @@
+require_relative './helper'
+require_relative '../lib/Bitget/Client'
+
+describe Bitget::Client do
+  let(:client) do
+    Bitget::Client.new(
+      api_key: api_key,
+      api_secret: api_secret,
+      api_passphrase: api_passphrase
+    )
+  end
+
+  describe "#spot_public_coins" do
+    context "when a coin is NOT supplied" do
+      it "retrieves a list of all coins" do
+        VCR.use_cassette('v2/spot/public/coins-when_coin_is_not_supplied') do
+          response = client.spot_public_coins
+          _(response).must_include('data')
+          _(response['data'].first).must_include('coinId')
+          _(response['data'].first).must_include('coin')
+          assert_operator response['data'].count, :>, 1500
+        end
+      end
+    end
+
+    context "when a coin IS supplied" do
+      it "retrieves one coin" do
+        VCR.use_cassette('v2/spot/public/coins-when_coin_is_supplied') do
+          response = client.spot_public_coins(coin: 'BTC')
+          _(response).must_include('data')
+          _(response['data'].first).must_include('coinId')
+          _(response['data'].first).must_include('coin')
+          _(response['data'].count).must_equal(1)
+        end
+      end
+    end
+
+    context "when an error occurs" do
+      it "logs then raises an error" do
+        VCR.use_cassette('v2/spot/public/coins-when_an_error_occurs') do
+          assert_raises(Bitget::Error) do
+            mocked_method = Minitest::Mock.new
+            mocked_method.expect(:call, nil, [], code: '418', message: "I'm a teapot", body: '')
+            client.stub(:log_error, mocked_method) do
+              client.spot_public_coins
+            end
+            mocked_method.verify
+          end
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require 'minitest-spec-context'
+require 'minitest/spec'
+require 'ostruct'
+require 'vcr'
+
+VCR.configure do |config|
+  config.cassette_library_dir = File.expand_path('../fixtures/vcr_cassettes', __FILE__)
+  config.hook_into :webmock
+end
+
+def api_key
+  if ENV['BITGET_API_KEY']
+    ENV['BITGET_API_KEY']
+  else
+    'api_key0'
+  end
+end
+
+def api_secret
+  if ENV['BITGET_API_SECRET']
+    ENV['BITGET_API_SECRET']
+  else
+    'api_secret0'
+  end
+end
+
+def api_passphrase
+  if ENV['BITGET_API_PASSPHRASE']
+    ENV['BITGET_API_PASSPHRASE']
+  else
+    'api_passphrase0'
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: bitget.rb
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- thoran
+bindir: bin
+cert_chain: []
+date: 2025-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http.rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Access the Bitget API with Ruby.
+email: code@thoran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bitget.rb.gemspec
+- lib/Bitget/Client.rb
+- lib/Bitget/Error.rb
+- lib/Bitget/V2/Client.rb
+- lib/Hash/to_parameter_string.rb
+- lib/Hash/x_www_form_urlencode.rb
+- lib/String/url_encode.rb
+- lib/bitget.rb
+- test/V2/client_test.rb
+- test/client_test.rb
+- test/helper.rb
+homepage: http://github.com/thoran/bitget.rb
+licenses:
+- Ruby
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.6
+specification_version: 4
+summary: Access the Bitget API with Ruby.
+test_files: []